net.named_data.jndn.security.v2

Class ValidationPolicy

java.lang.Object

net.named_data.jndn.security.v2.ValidationPolicy

Direct Known Subclasses:

ValidationPolicyAcceptAll, ValidationPolicyCommandInterest, ValidationPolicyConfig, ValidationPolicyFromPib, ValidationPolicySimpleHierarchy

public abstract class ValidationPolicy
extends Object

ValidationPolicy is an abstract base class that implements a validation policy for Data and Interest packets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ValidationPolicy.ValidationContinuation

Field Summary

Fields

Modifier and Type	Field and Description
protected ValidationPolicy	innerPolicy_
protected Validator	validator_

Constructor Summary

Constructors

Constructor and Description
ValidationPolicy()

Method Summary

Modifier and Type	Method and Description
void	checkCertificatePolicy(CertificateV2 certificate, ValidationState state, ValidationPolicy.ValidationContinuation continueValidation) Check the certificate against the policy.
abstract void	checkPolicy(Data data, ValidationState state, ValidationPolicy.ValidationContinuation continueValidation) Check the Data packet against the policy.
abstract void	checkPolicy(Interest interest, ValidationState state, ValidationPolicy.ValidationContinuation continueValidation) Check the Interest against the policy.
ValidationPolicy	getInnerPolicy() Get the inner policy.
static Name	getKeyLocatorName(Data data, ValidationState state) Extract the KeyLocator Name from a Data packet.
static Name	getKeyLocatorName(Interest interest, ValidationState state) Extract the KeyLocator Name from a signed Interest.
Validator	getValidator_() Get the validator_ field, used only for testing.
boolean	hasInnerPolicy() Check if the inner policy is set.
void	setInnerPolicy(ValidationPolicy innerPolicy) Set the inner policy.
void	setValidator(Validator validator) Set the validator to which this policy is associated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

validator_

protected Validator validator_

innerPolicy_

protected ValidationPolicy innerPolicy_

Constructor Detail

ValidationPolicy

public ValidationPolicy()

Method Detail

setInnerPolicy

public final void setInnerPolicy(ValidationPolicy innerPolicy)

Set the inner policy. Multiple assignments of the inner policy will create a "chain" of linked policies. The inner policy from the latest invocation of setInnerPolicy will be at the bottom of the policy list. For example, the sequence `this.setInnerPolicy(policy1)` and `this.setInnerPolicy(policy2)`, will result in `this.innerPolicy_ == policy1`, this.innerPolicy_.innerPolicy_ == policy2', and `this.innerPolicy_.innerPolicy_.innerPolicy_ == null`.

Throws:

IllegalArgumentException - if the innerPolicy is null.

hasInnerPolicy

public final boolean hasInnerPolicy()

Check if the inner policy is set.

Returns:

True if the inner policy is set.

getInnerPolicy

public final ValidationPolicy getInnerPolicy()

Get the inner policy. If the inner policy was not set, the behavior is undefined.

Returns:

The inner policy.

setValidator

public final void setValidator(Validator validator)

Set the validator to which this policy is associated. This replaces any previous validator.

Parameters:

validator - The validator.

checkPolicy

public abstract void checkPolicy(Data data,
                                 ValidationState state,
                                 ValidationPolicy.ValidationContinuation continueValidation)
                          throws CertificateV2.Error,
                                 ValidatorConfigError

Check the Data packet against the policy. Your derived class must implement this. Depending on the implementation of the policy, this check can be done synchronously or asynchronously. The semantics of checkPolicy are as follows: If the packet violates the policy, then the policy should call state.fail() with an appropriate error code and error description. If the packet conforms to the policy and no further key retrievals are necessary, then the policy should call continueValidation.continueValidation(null, state). If the packet conforms to the policy and a key needs to be fetched, then the policy should call continueValidation.continueValidation({appropriate-key-request-instance}, state).

Parameters:

data - The Data packet to check.

state - The ValidationState of this validation.

continueValidation - The policy should call continueValidation.continueValidation() as described above.

Throws:

CertificateV2.Error

ValidatorConfigError

checkPolicy

public abstract void checkPolicy(Interest interest,
                                 ValidationState state,
                                 ValidationPolicy.ValidationContinuation continueValidation)
                          throws CertificateV2.Error,
                                 ValidatorConfigError

Check the Interest against the policy. Your derived class must implement this. Depending on implementation of the policy, this check can be done synchronously or asynchronously. See the checkPolicy(Data) documentation for the semantics.

Parameters:

interest - The Interest packet to check.

state - The ValidationState of this validation.

continueValidation - The policy should call continueValidation.continueValidation() as described above.

Throws:

CertificateV2.Error

ValidatorConfigError

checkCertificatePolicy

public void checkCertificatePolicy(CertificateV2 certificate,
                                   ValidationState state,
                                   ValidationPolicy.ValidationContinuation continueValidation)
                            throws CertificateV2.Error,
                                   ValidatorConfigError

Check the certificate against the policy. This base class implementation just calls checkPolicy(Data, ...). Your derived class may override. Depending on implementation of the policy, this check can be done synchronously or asynchronously. See the checkPolicy(Data) documentation for the semantics.

Parameters:

certificate - The certificate to check.

state - The ValidationState of this validation.

continueValidation - The policy should call continueValidation() as described above.

Throws:

CertificateV2.Error

ValidatorConfigError

getKeyLocatorName

public static Name getKeyLocatorName(Data data,
                                     ValidationState state)

Extract the KeyLocator Name from a Data packet. The Data packet must contain a KeyLocator of type KEYNAME. Otherwise, state.fail is invoked with INVALID_KEY_LOCATOR.

Parameters:

data - The Data packet with the KeyLocator.

state - On error, this calls state.fail and returns an empty Name.

Returns:

The KeyLocator name, or an empty Name for failure.

getKeyLocatorName

public static Name getKeyLocatorName(Interest interest,
                                     ValidationState state)

Extract the KeyLocator Name from a signed Interest. The Interest must have SignatureInfo and contain a KeyLocator of type KEYNAME. Otherwise, state.fail is invoked with INVALID_KEY_LOCATOR.

Parameters:

interest - The signed Interest with the KeyLocator.

state - On error, this calls state.fail and returns an empty Name.

Returns:

The KeyLocator name, or an empty Name for failure.

getValidator_

public final Validator getValidator_()

Get the validator_ field, used only for testing.