net.named_data.jndn.security.v2

Class ValidationPolicyConfig

java.lang.Object

net.named_data.jndn.security.v2.ValidationPolicy

net.named_data.jndn.security.v2.ValidationPolicyConfig

public class ValidationPolicyConfig
extends ValidationPolicy

ValidationPolicyConfig implements a validator which can be set up via a configuration file. For command Interest validation, this policy must be combined with ValidationPolicyCommandInterest in order to guard against replay attacks.

Note:

This policy does not support inner policies (a sole policy or a terminal inner policy). See https://named-data.net/doc/ndn-cxx/current/tutorials/security-validator-config.html

Nested Class Summary

Nested classes/interfaces inherited from class net.named_data.jndn.security.v2.ValidationPolicy

ValidationPolicy.ValidationContinuation

Field Summary

Fields inherited from class net.named_data.jndn.security.v2.ValidationPolicy

innerPolicy_, validator_

Constructor Summary

Constructors

Constructor and Description
ValidationPolicyConfig() Create a default ValidationPolicyConfig.

Method Summary

Modifier and Type	Method and Description
void	checkPolicy(Data data, ValidationState state, ValidationPolicy.ValidationContinuation continueValidation) Check the Data packet against the policy.
void	checkPolicy(Interest interest, ValidationState state, ValidationPolicy.ValidationContinuation continueValidation) Check the Interest against the policy.
void	load(BoostInfoTree configSection, String inputName) Load the configuration from the given configSection.
void	load(String filePath) Load the configuration from the given config file.
void	load(String input, String inputName) Load the configuration from the given input string.

Methods inherited from class net.named_data.jndn.security.v2.ValidationPolicy

checkCertificatePolicy, getInnerPolicy, getKeyLocatorName, getKeyLocatorName, getValidator_, hasInnerPolicy, setInnerPolicy, setValidator

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationPolicyConfig

public ValidationPolicyConfig()

Create a default ValidationPolicyConfig.

Method Detail

load

public final void load(String filePath)
                throws IOException,
                       ValidatorConfigError

Load the configuration from the given config file. This replaces any existing configuration.

Parameters:

filePath - The The path of the config file.

Throws:

IOException

ValidatorConfigError

load

public final void load(String input,
                       String inputName)
                throws IOException,
                       ValidatorConfigError

Load the configuration from the given input string. This replaces any existing configuration.

Parameters:

input - The contents of the configuration rules, with lines separated by "\n" or "\r\n".

inputName - Used for log messages, etc.

Throws:

IOException

ValidatorConfigError

load

public final void load(BoostInfoTree configSection,
                       String inputName)
                throws ValidatorConfigError

Load the configuration from the given configSection. This replaces any existing configuration.

Parameters:

configSection - The configuration section loaded from the config file. It should have one "validator" section.

inputName - Used for log messages, etc.

Throws:

ValidatorConfigError

checkPolicy

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

Description copied from class: ValidationPolicy

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).

Specified by:

checkPolicy in class ValidationPolicy

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 void checkPolicy(Interest interest,
                        ValidationState state,
                        ValidationPolicy.ValidationContinuation continueValidation)
                 throws CertificateV2.Error,
                        ValidatorConfigError

Description copied from class: ValidationPolicy

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.

Specified by:

checkPolicy in class ValidationPolicy

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