Module org.eclipse.milo.opcua.stack.core

Package org.eclipse.milo.opcua.stack.core.util.validation

Enum Class ValidationCheck

java.lang.Object

java.lang.Enum<ValidationCheck>

org.eclipse.milo.opcua.stack.core.util.validation.ValidationCheck

All Implemented Interfaces:

Serializable, Comparable<ValidationCheck>, Constable

public enum ValidationCheck
extends Enum<ValidationCheck>

Validation checks that are allowed to be suppressed (i.e. they are optional) according to the spec.

See OPC UA (v1.03) Part 4, Section 6.1.3.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLICATION_URI	Check that a remote application's end-entity certificate has a SubjectAlternativeName URI that matches the application URI in its ApplicationDescription.
EXTENDED_KEY_USAGE_END_ENTITY	The ExtendedKeyUsage extension must be present and checked for end-entity certificates.
HOSTNAME	Check that the end-entity certificate contains a particular hostname or IP address in its SANs.
KEY_USAGE_END_ENTITY	The KeyUsage extension must be present and checked for end-entity certificates.
REVOCATION	Revocation checking must happen.
REVOCATION_LISTS	CRLs for every non-end-entity CA must be found.
VALIDITY	Certificate validity and expiration is checked.

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<ValidationCheck>	ALL_OPTIONAL_CHECKS	A set the includes all ValidationChecks.
static final Set<ValidationCheck>	NO_OPTIONAL_CHECKS	A set that includes none of the optional ValidationChecks.

Method Summary

Modifier and Type	Method	Description
static ValidationCheck	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ValidationCheck[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HOSTNAME

public static final ValidationCheck HOSTNAME

Check that the end-entity certificate contains a particular hostname or IP address in its SANs.

This check is only done in clients, against the server they are connecting to.

VALIDITY

public static final ValidationCheck VALIDITY

Certificate validity and expiration is checked.

KEY_USAGE_END_ENTITY

public static final ValidationCheck KEY_USAGE_END_ENTITY

The KeyUsage extension must be present and checked for end-entity certificates.

EXTENDED_KEY_USAGE_END_ENTITY

public static final ValidationCheck EXTENDED_KEY_USAGE_END_ENTITY

The ExtendedKeyUsage extension must be present and checked for end-entity certificates.

REVOCATION

public static final ValidationCheck REVOCATION

Revocation checking must happen.

REVOCATION_LISTS

public static final ValidationCheck REVOCATION_LISTS

CRLs for every non-end-entity CA must be found.

APPLICATION_URI

public static final ValidationCheck APPLICATION_URI

Check that a remote application's end-entity certificate has a SubjectAlternativeName URI that matches the application URI in its ApplicationDescription.

This check is not technically optional or suppressible according to the spec, but because Java's certificate parsing routine turns invalid URIs into a null/empty String this check fails more often than it should, since many applications will use whitespace in their URI without properly URL-encoding it.

Field Details

NO_OPTIONAL_CHECKS

public static final Set<ValidationCheck> NO_OPTIONAL_CHECKS

A set that includes none of the optional ValidationChecks.

This set *does* still include APPLICATION_URI, which is technically not optional.

ALL_OPTIONAL_CHECKS

public static final Set<ValidationCheck> ALL_OPTIONAL_CHECKS

A set the includes all ValidationChecks.

Method Details

values

public static ValidationCheck[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ValidationCheck valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null