net.named_data.jndn.security.v2

Class Validator

java.lang.Object

net.named_data.jndn.security.v2.CertificateStorage

net.named_data.jndn.security.v2.Validator

Direct Known Subclasses:

ValidatorConfig, ValidatorNull

public class Validator
extends CertificateStorage

The Validator class provides an interface for validating data and interest packets. Every time a validation process is initiated, it creates a ValidationState that exists until the validation finishes with either success or failure. This state serves several purposes: to record the Interest or Data packet being validated, to record the failure callback, to record certificates in the certification chain for the Interest or Data packet being validated, to record the names of the requested certificates in order to detect loops in the certificate chain, and to keep track of the validation chain size (also known as the validation "depth"). During validation, the policy and/or key fetcher can augment the validation state with policy- and fetcher-specific information using tags. A Validator has a trust anchor cache to save static and dynamic trust anchors, a verified certificate cache for saving certificates that are already verified, and an unverified certificate cache for saving pre-fetched but not yet verified certificates.

Field Summary

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

trustAnchors_, unverifiedCertificateCache_, verifiedCertificateCache_

Constructor Summary

Constructors

Constructor and Description
Validator(ValidationPolicy policy) Create a Validator with the policy.
Validator(ValidationPolicy policy, CertificateFetcher certificateFetcher) Create a Validator with the policy and fetcher.

Method Summary

Modifier and Type	Method and Description
CertificateFetcher	getFetcher() Get the CertificateFetcher given to (or created in) the constructor.
int	getMaxDepth() Get the maximum depth of the certificate chain.
ValidationPolicy	getPolicy() Get the ValidationPolicy given to the constructor.
void	setMaxDepth(int maxDepth) Set the maximum depth of the certificate chain.
void	validate(Data data, DataValidationSuccessCallback successCallback, DataValidationFailureCallback failureCallback) Asynchronously validate the Data packet.
void	validate(Interest interest, InterestValidationSuccessCallback successCallback, InterestValidationFailureCallback failureCallback) Asynchronously validate the Interest.

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

cacheUnverifiedCertificate, cacheVerifiedCertificate, findTrustedCertificate, getTrustAnchors, getUnverifiedCertificateCache, getVerifiedCertificateCache, isCertificateKnown, loadAnchor, loadAnchor, loadAnchor, resetAnchors, resetVerifiedCertificates, setCacheNowOffsetMilliseconds_

Methods inherited from class java.lang.Object

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

Constructor Detail

Validator

public Validator(ValidationPolicy policy,
                 CertificateFetcher certificateFetcher)

Create a Validator with the policy and fetcher.

Parameters:

policy - The validation policy to be associated with this validator.

certificateFetcher - The certificate fetcher implementation.

Validator

public Validator(ValidationPolicy policy)

Create a Validator with the policy. Use a CertificateFetcherOffline (assuming that the validation policy doesn't need to fetch certificates).

Parameters:

policy - The validation policy to be associated with this validator.

Method Detail

getPolicy

public final ValidationPolicy getPolicy()

Get the ValidationPolicy given to the constructor.

Returns:

The ValidationPolicy.

getFetcher

public final CertificateFetcher getFetcher()

Get the CertificateFetcher given to (or created in) the constructor.

Returns:

The CertificateFetcher.

setMaxDepth

public final void setMaxDepth(int maxDepth)

Set the maximum depth of the certificate chain.

Parameters:

maxDepth - The maximum depth.

getMaxDepth

public final int getMaxDepth()

Get the maximum depth of the certificate chain.

Returns:

The maximum depth.

validate

public final void validate(Data data,
                           DataValidationSuccessCallback successCallback,
                           DataValidationFailureCallback failureCallback)
                    throws CertificateV2.Error,
                           ValidatorConfigError

Asynchronously validate the Data packet.

Parameters:

data - The Data packet to validate, which is copied.

successCallback - On validation success, this calls successCallback.successCallback(data).

failureCallback - On validation failure, this calls failureCallback.failureCallback(data, error) where error is a ValidationError.

Throws:

CertificateV2.Error

ValidatorConfigError

validate

public final void validate(Interest interest,
                           InterestValidationSuccessCallback successCallback,
                           InterestValidationFailureCallback failureCallback)
                    throws CertificateV2.Error,
                           ValidatorConfigError

Asynchronously validate the Interest.

Parameters:

interest - The Interest to validate, which is copied.

successCallback - On validation success, this calls successCallback.successCallback(interest).

failureCallback - On validation failure, this calls failureCallback.failureCallback(interest, error) where error is a ValidationError.

Throws:

CertificateV2.Error

ValidatorConfigError