net.named_data.jndn.security.v2

Class ValidationState

java.lang.Object

net.named_data.jndn.security.v2.ValidationState

Direct Known Subclasses:

DataValidationState, InterestValidationState

public abstract class ValidationState
extends Object

ValidationState is an abstract base class for DataValidationState and InterestValidationState. One instance of the validation state is kept for the validation of the whole certificate chain. The state collects the certificate chain that adheres to the selected validation policy to validate data or interest packets. Certificate, data, and interest packet signatures are verified only after the validator determines that the chain terminates with a trusted certificate (a trusted anchor or a previously validated certificate). This model allows filtering out invalid certificate chains without incurring (costly) cryptographic signature verification overhead and mitigates some forms of denial-of-service attacks. A validation policy and/or key fetcher may add custom information associated with the validation state using tags.

Constructor Summary

Constructors

Constructor and Description
ValidationState()

Method Summary

Modifier and Type	Method and Description
void	addCertificate(CertificateV2 certificate) Add the certificate to the top of the certificate chain.
abstract void	bypassValidation_() Call the success callback of the original packet without signature validation.
abstract void	fail(ValidationError error) Call the failure callback.
ArrayList<CertificateV2>	getCertificateChain_() Get the internal certificateChain_.
int	getDepth() Get the depth of the certificate chain.
boolean	hasOutcome() Check if validation failed or success has been called.
boolean	hasSeenCertificateName(Name certificateName) Check if certificateName has been previously seen, and record the supplied name.
boolean	isOutcomeFailed() Check if validation failed has been called.
boolean	isOutcomeSuccess() Check if validation success has been called.
protected void	setOutcome(boolean outcome) Set the outcome to the given value, and set hasOutcome_ true.
CertificateV2	verifyCertificateChain_(CertificateV2 trustedCertificate) Verify signatures of certificates in the certificate chain.
abstract void	verifyOriginalPacket_(CertificateV2 trustedCertificate) Verify the signature of the original packet.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationState

public ValidationState()

Method Detail

hasOutcome

public final boolean hasOutcome()

Check if validation failed or success has been called.

Returns:

True if validation failed or success has been called.

isOutcomeFailed

public final boolean isOutcomeFailed()

Check if validation failed has been called.

Returns:

True if validation failed has been called, false if no validation callbacks have been called or validation success was called.

isOutcomeSuccess

public final boolean isOutcomeSuccess()

Check if validation success has been called.

Returns:

True if validation success has been called, false if no validation callbacks have been called or validation failed was called.

fail

public abstract void fail(ValidationError error)

Call the failure callback.

getDepth

public final int getDepth()

Get the depth of the certificate chain.

Returns:

The depth of the certificate chain.

hasSeenCertificateName

public final boolean hasSeenCertificateName(Name certificateName)

Check if certificateName has been previously seen, and record the supplied name.

Parameters:

certificateName - The certificate name, which is copied.

Returns:

True if certificateName has been previously seen.

addCertificate

public final void addCertificate(CertificateV2 certificate)
                          throws CertificateV2.Error

Add the certificate to the top of the certificate chain. If the certificate chain is empty, then the certificate should be the signer of the original packet. If the certificate chain is not empty, then the certificate should be the signer of the front of the certificate chain.

Parameters:

certificate - The certificate to add, which is copied.

Throws:

CertificateV2.Error

Note:

This function does not verify the signature bits.

setOutcome

protected final void setOutcome(boolean outcome)

Set the outcome to the given value, and set hasOutcome_ true.

Parameters:

outcome - The outcome.

Throws:

IllegalArgumentException - If this ValidationState already has an outcome.

verifyOriginalPacket_

public abstract void verifyOriginalPacket_(CertificateV2 trustedCertificate)

Verify the signature of the original packet. This is only called by the Validator class.

Parameters:

trustedCertificate - The certificate that signs the original packet.

bypassValidation_

public abstract void bypassValidation_()

Call the success callback of the original packet without signature validation. This is only called by the Validator class.

verifyCertificateChain_

public final CertificateV2 verifyCertificateChain_(CertificateV2 trustedCertificate)

Verify signatures of certificates in the certificate chain. On return, the certificate chain contains a list of certificates successfully verified by trustedCertificate. When the certificate chain cannot be verified, this method will call fail() with the INVALID_SIGNATURE error code and the appropriate message. This is only called by the Validator class.

Returns:

The certificate to validate the original data packet, either the last entry in the certificate chain or trustedCertificate if the certificate chain is empty. However, return null if the signature of at least one certificate in the chain is invalid, in which case all unverified certificates have been removed from the certificate chain.

getCertificateChain_

public final ArrayList<CertificateV2> getCertificateChain_()

Get the internal certificateChain_. This is only called by the Validator class.

Returns:

The internal certificateChain_.