net.named_data.jndn.security.v2

Class CertificateStorage

java.lang.Object

net.named_data.jndn.security.v2.CertificateStorage

Direct Known Subclasses:

Validator

public class CertificateStorage
extends Object

The CertificateStorage class stores trusted anchors and has a verified certificate cache, and an unverified certificate cache.

Field Summary

Fields

Modifier and Type	Field and Description
protected TrustAnchorContainer	trustAnchors_
protected CertificateCacheV2	unverifiedCertificateCache_
protected CertificateCacheV2	verifiedCertificateCache_

Constructor Summary

Constructors

Constructor and Description
CertificateStorage()

Method Summary

Modifier and Type	Method and Description
void	cacheUnverifiedCertificate(CertificateV2 certificate) Cache the unverified certificate for a period of time (5 minutes).
void	cacheVerifiedCertificate(CertificateV2 certificate) Cache the verified certificate a period of time (1 hour).
CertificateV2	findTrustedCertificate(Interest interestForCertificate) Find a trusted certificate in the trust anchor container or in the verified cache.
TrustAnchorContainer	getTrustAnchors() Get the trust anchor container.
CertificateCacheV2	getUnverifiedCertificateCache() Get the unverified certificate cache.
CertificateCacheV2	getVerifiedCertificateCache() Get the verified certificate cache.
boolean	isCertificateKnown(Name certificatePrefix) Check if the certificate with the given name prefix exists in the verified cache, the unverified cache, or in the set of trust anchors.
void	loadAnchor(String groupId, CertificateV2 certificate) Load a static trust anchor.
void	loadAnchor(String groupId, String path, double refreshPeriod) Load dynamic trust anchors.
void	loadAnchor(String groupId, String path, double refreshPeriod, boolean isDirectory) Load dynamic trust anchors.
void	resetAnchors() Remove any previously loaded static or dynamic trust anchors.
void	resetVerifiedCertificates() Remove any cached verified certificates.
void	setCacheNowOffsetMilliseconds_(double nowOffsetMilliseconds) Set the offset when the cache insert() and refresh() get the current time, which should only be used for testing.

Methods inherited from class java.lang.Object

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

Field Detail

trustAnchors_

protected TrustAnchorContainer trustAnchors_

verifiedCertificateCache_

protected CertificateCacheV2 verifiedCertificateCache_

unverifiedCertificateCache_

protected CertificateCacheV2 unverifiedCertificateCache_

Constructor Detail

CertificateStorage

public CertificateStorage()

Method Detail

findTrustedCertificate

public final CertificateV2 findTrustedCertificate(Interest interestForCertificate)

Find a trusted certificate in the trust anchor container or in the verified cache.

Parameters:

interestForCertificate - The Interest for the certificate.

Returns:

The found certificate, or null if not found.

isCertificateKnown

public final boolean isCertificateKnown(Name certificatePrefix)

Check if the certificate with the given name prefix exists in the verified cache, the unverified cache, or in the set of trust anchors.

Parameters:

certificatePrefix - The certificate name prefix.

Returns:

True if the certificate is known.

cacheUnverifiedCertificate

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

Cache the unverified certificate for a period of time (5 minutes).

Parameters:

certificate - The certificate packet, which is copied.

Throws:

CertificateV2.Error

getTrustAnchors

public final TrustAnchorContainer getTrustAnchors()

Get the trust anchor container.

Returns:

The trust anchor container.

getVerifiedCertificateCache

public final CertificateCacheV2 getVerifiedCertificateCache()

Get the verified certificate cache.

Returns:

The verified certificate cache.

getUnverifiedCertificateCache

public final CertificateCacheV2 getUnverifiedCertificateCache()

Get the unverified certificate cache.

Returns:

The unverified certificate cache.

loadAnchor

public final void loadAnchor(String groupId,
                             CertificateV2 certificate)
                      throws TrustAnchorContainer.Error

Load a static trust anchor. Static trust anchors are permanently associated with the validator and never expire.

Parameters:

groupId - The certificate group id.

certificate - The certificate to load as a trust anchor, which is copied.

Throws:

TrustAnchorContainer.Error

loadAnchor

public final void loadAnchor(String groupId,
                             String path,
                             double refreshPeriod,
                             boolean isDirectory)
                      throws TrustAnchorContainer.Error

Load dynamic trust anchors. Dynamic trust anchors are associated with the validator for as long as the underlying trust anchor file (or set of files) exists.

Parameters:

groupId - The certificate group id, which must not be empty.

path - The path to load the trust anchors.

refreshPeriod - The refresh time in milliseconds for the anchors under path. This must be positive. The relevant trust anchors will only be updated when find is called.

isDirectory - If true, then path is a directory. If false, it is a single file.

Throws:

IllegalArgumentException - If refreshPeriod is not positive.

TrustAnchorContainer.Error - a group with groupId already exists

loadAnchor

public final void loadAnchor(String groupId,
                             String path,
                             double refreshPeriod)
                      throws TrustAnchorContainer.Error

Load dynamic trust anchors. Dynamic trust anchors are associated with the validator for as long as the underlying trust anchor file (or set of files) exists.

Parameters:

groupId - The certificate group id, which must not be empty.

path - The path of the single file to load the trust anchors.

refreshPeriod - The refresh time in milliseconds for the anchors under path. This must be positive. The relevant trust anchors will only be updated when find is called.

Throws:

IllegalArgumentException - If refreshPeriod is not positive.

TrustAnchorContainer.Error - a group with groupId already exists

resetAnchors

public final void resetAnchors()

Remove any previously loaded static or dynamic trust anchors.

cacheVerifiedCertificate

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

Cache the verified certificate a period of time (1 hour).

Parameters:

certificate - The certificate object, which is copied.

Throws:

CertificateV2.Error

resetVerifiedCertificates

public final void resetVerifiedCertificates()

Remove any cached verified certificates.

setCacheNowOffsetMilliseconds_

public final void setCacheNowOffsetMilliseconds_(double nowOffsetMilliseconds)

Set the offset when the cache insert() and refresh() get the current time, which should only be used for testing.

Parameters:

nowOffsetMilliseconds - The offset in milliseconds.