ndn::security::v2::CertificateStorage Class Reference

Storage for trusted anchors, verified certificate cache, and unverified certificate cache. More...

#include <ndn-cxx/security/certificate-storage.hpp>

Inheritance diagram for ndn::security::v2::CertificateStorage:

Collaboration diagram for ndn::security::v2::CertificateStorage:

Public Member Functions
	CertificateStorage ()
void	cacheUnverifiedCert (Certificate &&cert)
	Cache unverified certificate for a period of time (5 minutes) More...
const Certificate *	findTrustedCert (const Interest &interestForCert) const
	Find a trusted certificate in trust anchor container or in verified cache. More...
const TrustAnchorContainer &	getTrustAnchors () const
const CertificateCache &	getUnverifiedCertCache () const
const CertificateCache &	getVerifiedCertCache () const
bool	isCertKnown (const Name &certPrefix) const
	Check if certificate exists in verified, unverified cache, or in the set of trust anchors. More...

Protected Member Functions
void	cacheVerifiedCert (Certificate &&cert)
	Cache verified certificate a period of time (1 hour) 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	resetVerifiedCerts ()
	Remove any cached verified certificates. More...

Protected Attributes
TrustAnchorContainer	m_trustAnchors
CertificateCache	m_unverifiedCertCache
CertificateCache	m_verifiedCertCache

Detailed Description

Storage for trusted anchors, verified certificate cache, and unverified certificate cache.

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

Constructor & Destructor Documentation

CertificateStorage()

ndn::security::v2::CertificateStorage::CertificateStorage

(

)

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

Member Function Documentation

cacheUnverifiedCert()

void ndn::security::v2::CertificateStorage::cacheUnverifiedCert

(

Certificate &&

cert

)

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 86 of file certificate-storage.cpp.

cacheVerifiedCert()

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

protected

Cache verified certificate a period of time (1 hour)

Parameters

cert	The certificate packet

Todo:

Add ability to customize time period

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

findTrustedCert()

const Certificate * ndn::security::v2::CertificateStorage::findTrustedCert

(

const Interest &

interestForCert

)

const

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 35 of file certificate-storage.cpp.

getTrustAnchors()

const TrustAnchorContainer & ndn::security::v2::CertificateStorage::getTrustAnchors

(

)

const

Returns

Trust anchor container

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

getUnverifiedCertCache()

const CertificateCache & ndn::security::v2::CertificateStorage::getUnverifiedCertCache

(

)

const

Returns

Unverified certificate cache

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

getVerifiedCertCache()

const CertificateCache & ndn::security::v2::CertificateStorage::getVerifiedCertCache

(

)

const

Returns

Verified certificate cache

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

isCertKnown()

bool ndn::security::v2::CertificateStorage::isCertKnown

(

const Name &

certPrefix

)

const

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

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

loadAnchor() [1/2]

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

protected

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 55 of file certificate-storage.cpp.

loadAnchor() [2/2]

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

protected

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 61 of file certificate-storage.cpp.

resetAnchors()

void ndn::security::v2::CertificateStorage::resetAnchors ( )

protected

remove any previously loaded static or dynamic trust anchor

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

resetVerifiedCerts()

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

protected

Remove any cached verified certificates.

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

Member Data Documentation

m_trustAnchors

TrustAnchorContainer ndn::security::v2::CertificateStorage::m_trustAnchors

protected

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

m_unverifiedCertCache

CertificateCache ndn::security::v2::CertificateStorage::m_unverifiedCertCache

protected

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

m_verifiedCertCache

CertificateCache ndn::security::v2::CertificateStorage::m_verifiedCertCache

protected

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