ndn::security::Validator Class Reference

Interface for validating data and interest packets. More...

#include <ndn-cxx/security/validator.hpp>

Inheritance diagram for ndn::security::Validator:

Collaboration diagram for ndn::security::Validator:

Public Member Functions
	Validator (unique_ptr< ValidationPolicy > policy, unique_ptr< CertificateFetcher > certFetcher)
	Validator constructor. More...
	~Validator () noexcept
void	cacheUnverifiedCert (Certificate &&cert)
	Cache unverified certificate for a period of time (5 minutes). More...
void	cacheVerifiedCertificate (Certificate &&cert)
	Cache verified cert a period of time (1 hour). More...
const Certificate *	findTrustedCert (const Interest &interestForCert) const
	Find a trusted certificate in trust anchor container or in verified cache. More...
CertificateFetcher &	getFetcher () const noexcept
size_t	getMaxDepth () const noexcept
	Return the maximum depth of the certificate chain. More...
ValidationPolicy &	getPolicy () const noexcept
const TrustAnchorContainer &	getTrustAnchors () const
const CertificateCache &	getUnverifiedCertCache () const
const CertificateCache &	getVerifiedCertCache () const
bool	isCertKnown (const Name &certPrefix) const
	Check if certificate exists in the verified/unverified cache or in the set of trust anchors. More...
void	loadAnchor (const std::string &groupId, Certificate &&cert)
	Load static trust anchor. More...
void	loadAnchor (const std::string &groupId, const std::string &certfilePath, time::nanoseconds refreshPeriod, bool isDir=false)
	Load dynamic trust anchors. More...
void	resetAnchors ()
	Remove any previously loaded static or dynamic trust anchor. More...
void	resetVerifiedCertificates ()
	Remove any cached verified certificates. More...
void	setMaxDepth (size_t depth) noexcept
	Set the maximum depth of the certificate chain. More...
void	validate (const Data &data, const DataValidationSuccessCallback &successCb, const DataValidationFailureCallback &failureCb)
	Asynchronously validate data. More...
void	validate (const Interest &interest, const InterestValidationSuccessCallback &successCb, const InterestValidationFailureCallback &failureCb)
	Asynchronously validate interest. More...

Protected Member Functions
void	cacheVerifiedCert (Certificate &&cert)
	Cache verified certificate a period of time (1 hour). More...
void	resetVerifiedCerts ()
	Remove any cached verified certificates. More...

Protected Attributes
TrustAnchorContainer	m_trustAnchors
CertificateCache	m_unverifiedCertCache
CertificateCache	m_verifiedCertCache

Detailed Description

Interface for validating data and interest packets.

Every time a validation process initiated, it creates a ValidationState that exist until validation finishes with either success or failure. This state serves several purposes:

• record Interest or Data packet being validated
• record failure callback
• record certificates in the certification chain for the Interest or Data packet being validated
• record names of the requested certificates to detect loops in the certificate chain
• keep track of the validation chain size (aka validation "depth")

During validation, policy and/or key fetcher can augment validation state with policy- and fetcher-specific information using ndn::Tag's.

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 prefetched but not yet verified certificates.

Todo:

Limit the maximum time the validation process is allowed to run before declaring failure

Ability to customize maximum lifetime for trusted and untrusted certificate caches. Current implementation hard-codes them to be 1 hour and 5 minutes.

Definition at line 60 of file validator.hpp.

Constructor & Destructor Documentation

Validator()

ndn::security::Validator::Validator	(	unique_ptr< ValidationPolicy >	policy,
		unique_ptr< CertificateFetcher >	certFetcher
	)

Validator constructor.

Parameters

policy	Validation policy to be associated with the validator.
certFetcher	Certificate fetcher implementation.

Definition at line 34 of file validator.cpp.

~Validator()

ndn::security::Validator::~Validator ( )

defaultnoexcept

Member Function Documentation

cacheUnverifiedCert()

void ndn::security::CertificateStorage::cacheUnverifiedCert ( Certificate &&  cert )

inherited

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

Parameters

cert	The certificate packet

Todo:

Add ability to customize time period

Definition at line 81 of file certificate-storage.cpp.

cacheVerifiedCert()

void ndn::security::CertificateStorage::cacheVerifiedCert ( Certificate &&  cert )

protectedinherited

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

Parameters

cert	The certificate packet

Todo:

Add ability to customize time period

Definition at line 69 of file certificate-storage.cpp.

cacheVerifiedCertificate()

void ndn::security::Validator::cacheVerifiedCertificate

(

Certificate &&

cert

)

Cache verified cert a period of time (1 hour).

Todo:

Add ability to customize time period

Definition at line 188 of file validator.cpp.

findTrustedCert()

const Certificate * ndn::security::CertificateStorage::findTrustedCert ( const Interest &  interestForCert ) const

inherited

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

Parameters

interestForCert

Interest for certificate

Returns

Found certificate, nullptr if not found.

Note

The returned pointer may get invalidated after next findTrustedCert() or findCert() calls.

Definition at line 33 of file certificate-storage.cpp.

getFetcher()

CertificateFetcher& ndn::security::Validator::getFetcher ( ) const

inlinenoexcept

Definition at line 80 of file validator.hpp.

getMaxDepth()

size_t ndn::security::Validator::getMaxDepth ( ) const

inlinenoexcept

Return the maximum depth of the certificate chain.

Definition at line 89 of file validator.hpp.

getPolicy()

ValidationPolicy& ndn::security::Validator::getPolicy ( ) const

inlinenoexcept

Definition at line 74 of file validator.hpp.

getTrustAnchors()

const TrustAnchorContainer & ndn::security::CertificateStorage::getTrustAnchors ( ) const

inherited

Returns

Trust anchor container

Definition at line 87 of file certificate-storage.cpp.

getUnverifiedCertCache()

const CertificateCache & ndn::security::CertificateStorage::getUnverifiedCertCache ( ) const

inherited

Returns

Unverified certificate cache

Definition at line 99 of file certificate-storage.cpp.

getVerifiedCertCache()

const CertificateCache & ndn::security::CertificateStorage::getVerifiedCertCache ( ) const

inherited

Returns

Verified certificate cache

Definition at line 93 of file certificate-storage.cpp.

isCertKnown()

bool ndn::security::CertificateStorage::isCertKnown ( const Name &  certPrefix ) const

inherited

Check if certificate exists in the verified/unverified cache or in the set of trust anchors.

Definition at line 42 of file certificate-storage.cpp.

loadAnchor() [1/2]

void ndn::security::Validator::loadAnchor	(	const std::string &	groupId,
		Certificate &&	cert
	)

Load static trust anchor.

Static trust anchors are permanently associated with the validator and never expire.

Parameters

groupId	Certificate group id.
cert	Certificate to load as a trust anchor.

Definition at line 169 of file validator.cpp.

loadAnchor() [2/2]

void ndn::security::Validator::loadAnchor	(	const std::string &	groupId,
		const std::string &	certfilePath,
		time::nanoseconds	refreshPeriod,
		bool	isDir = false
	)

Load dynamic trust anchors.

Dynamic trust anchors are associated with the validator for as long as the underlying trust anchor file (set of files) exist(s).

Parameters

groupId	Certificate group id, must not be empty.
certfilePath	Specifies the path to load the trust anchors.
refreshPeriod	Refresh period for the trust anchors, must be positive.
isDir	Tells whether the path is a directory or a single file.

Definition at line 175 of file validator.cpp.

resetAnchors()

void ndn::security::Validator::resetAnchors

(

)

Remove any previously loaded static or dynamic trust anchor.

Definition at line 182 of file validator.cpp.

resetVerifiedCertificates()

void ndn::security::Validator::resetVerifiedCertificates

(

)

Remove any cached verified certificates.

Definition at line 194 of file validator.cpp.

resetVerifiedCerts()

void ndn::security::CertificateStorage::resetVerifiedCerts ( )

protectedinherited

Remove any cached verified certificates.

Definition at line 75 of file certificate-storage.cpp.

setMaxDepth()

void ndn::security::Validator::setMaxDepth ( size_t  depth )

inlinenoexcept

Set the maximum depth of the certificate chain.

Definition at line 98 of file validator.hpp.

validate() [1/2]

void ndn::security::Validator::validate	(	const Data &	data,
		const DataValidationSuccessCallback &	successCb,
		const DataValidationFailureCallback &	failureCb
	)

Asynchronously validate data.

Note

successCb and failureCb must not be nullptr

Definition at line 47 of file validator.cpp.

validate() [2/2]

void ndn::security::Validator::validate	(	const Interest &	interest,
		const InterestValidationSuccessCallback &	successCb,
		const InterestValidationFailureCallback &	failureCb
	)

Asynchronously validate interest.

Note

successCb and failureCb must not be nullptr

Definition at line 60 of file validator.cpp.

Member Data Documentation

m_trustAnchors

TrustAnchorContainer ndn::security::CertificateStorage::m_trustAnchors

protectedinherited

Definition at line 131 of file certificate-storage.hpp.

m_unverifiedCertCache

CertificateCache ndn::security::CertificateStorage::m_unverifiedCertCache

protectedinherited

Definition at line 133 of file certificate-storage.hpp.

m_verifiedCertCache

CertificateCache ndn::security::CertificateStorage::m_verifiedCertCache

protectedinherited

Definition at line 132 of file certificate-storage.hpp.