net.named_data.jndn.security.v2.validator_config

Class ConfigChecker

java.lang.Object

net.named_data.jndn.security.v2.validator_config.ConfigChecker

Direct Known Subclasses:

ConfigHyperRelationChecker, ConfigNameRelationChecker, ConfigRegexChecker

public abstract class ConfigChecker
extends Object

A ConfigChecker is an abstract base class for ConfigNameRelationChecker, etc. used by ValidatorConfig to check if a packet name and KeyLocator satisfy the conditions in a configuration section.

Constructor Summary

Constructors

Constructor and Description
ConfigChecker()

Method Summary

Modifier and Type	Method and Description
boolean	check(boolean isForInterest, Name packetName, Name keyLocatorName, ValidationState state) Check if the packet name ane KeyLocator name satisfy this checker's conditions.
protected abstract boolean	checkNames(Name packetName, Name keyLocatorName, ValidationState state) Check if the packet name ane KeyLocator name satisfy this checker's conditions.
static ConfigChecker	create(BoostInfoTree configSection) Create a checker from the configuration section.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigChecker

public ConfigChecker()

Method Detail

check

public final boolean check(boolean isForInterest,
                           Name packetName,
                           Name keyLocatorName,
                           ValidationState state)
                    throws ValidatorConfigError

Check if the packet name ane KeyLocator name satisfy this checker's conditions.

Parameters:

isForInterest - True if packetName is for an Interest, false if for a Data packet.

packetName - The packet name. For a signed interest, the last two components are skipped but not removed.

keyLocatorName - The KeyLocator's name.

state - This calls state.fail() if the packet is invalid.

Returns:

True if further signature verification is needed, or false if the packet is immediately determined to be invalid in which case this calls state.fail() with the proper code and message.

Throws:

ValidatorConfigError

create

public static ConfigChecker create(BoostInfoTree configSection)
                            throws ValidatorConfigError

Create a checker from the configuration section.

Parameters:

configSection - The section containing the definition of the checker, e.g. one of "validation.rule.checker".

Returns:

A new checker created from the configuration section.

Throws:

ValidatorConfigError

checkNames

protected abstract boolean checkNames(Name packetName,
                                      Name keyLocatorName,
                                      ValidationState state)
                               throws ValidatorConfigError

Check if the packet name ane KeyLocator name satisfy this checker's conditions.

Parameters:

packetName - The packet name, which is already stripped of signature components if this is a signed Interest name.

keyLocatorName - The KeyLocator's name.

state - This calls state.fail() if the packet is invalid.

Returns:

True if further signature verification is needed, or false if the packet is immediately determined to be invalid in which case this calls state.fail() with the proper code and message.

Throws:

ValidatorConfigError