ndn::security::v2::ValidatorNull Class Reference

Validator with "accept-all" policy and offline certificate fetcher. More...

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

+ Inheritance diagram for ndn::security::v2::ValidatorNull:
+ Collaboration diagram for ndn::security::v2::ValidatorNull:

Public Member Functions

 ValidatorNull ()
 
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 CertificatefindTrustedCert (const Interest &interestForCert) const
 Find a trusted certificate in trust anchor container or in verified cache. More...
 
CertificateFetchergetFetcher ()
 
size_t getMaxDepth () const
 
ValidationPolicygetPolicy ()
 
const TrustAnchorContainergetTrustAnchors () const
 
const CertificateCachegetUnverifiedCertCache () const
 
const CertificateCachegetVerifiedCertCache () const
 
bool isCertKnown (const Name &certPrefix) const
 Check if certificate exists in 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)
 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

Validator with "accept-all" policy and offline certificate fetcher.

Definition at line 34 of file validator-null.hpp.

Constructor & Destructor Documentation

ndn::security::v2::ValidatorNull::ValidatorNull ( )

Definition at line 30 of file validator-null.cpp.

Member Function Documentation

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

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

Parameters
certThe certificate packet
Todo:
Add ability to customize time period

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

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

Cache verified certificate a period of time (1 hour)

Parameters
certThe certificate packet
Todo:
Add ability to customize time period

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

void ndn::security::v2::Validator::cacheVerifiedCertificate ( Certificate &&  cert)
inherited

Cache verified cert a period of time (1 hour)

Todo:
Add ability to customize time period

Definition at line 204 of file validator.cpp.

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

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

Parameters
interestForCertInterest 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.

CertificateFetcher & ndn::security::v2::Validator::getFetcher ( )
inherited

Definition at line 57 of file validator.cpp.

size_t ndn::security::v2::Validator::getMaxDepth ( ) const
inherited
Returns
The maximum depth of the certificate chain

Definition at line 69 of file validator.cpp.

ValidationPolicy & ndn::security::v2::Validator::getPolicy ( )
inherited

Definition at line 51 of file validator.cpp.

const TrustAnchorContainer & ndn::security::v2::CertificateStorage::getTrustAnchors ( ) const
inherited
Returns
Trust anchor container

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

const CertificateCache & ndn::security::v2::CertificateStorage::getUnverifiedCertCache ( ) const
inherited
Returns
Unverified certificate cache

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

const CertificateCache & ndn::security::v2::CertificateStorage::getVerifiedCertCache ( ) const
inherited
Returns
Verified certificate cache

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

bool ndn::security::v2::CertificateStorage::isCertKnown ( const Name certPrefix) const
inherited

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

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

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

load static trust anchor.

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

Parameters
groupIdCertificate group id.
certCertificate to load as a trust anchor.

Definition at line 185 of file validator.cpp.

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

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
groupIdCertificate group id, must not be empty.
certfilePathSpecifies the path to load the trust anchors.
refreshPeriodRefresh period for the trust anchors, must be positive.
isDirTells whether the path is a directory or a single file.

Definition at line 191 of file validator.cpp.

void ndn::security::v2::Validator::resetAnchors ( )
inherited

remove any previously loaded static or dynamic trust anchor

Definition at line 198 of file validator.cpp.

void ndn::security::v2::Validator::resetVerifiedCertificates ( )
inherited

Remove any cached verified certificates.

Definition at line 210 of file validator.cpp.

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

Remove any cached verified certificates.

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

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

Set the maximum depth of the certificate chain.

Definition at line 63 of file validator.cpp.

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

Asynchronously validate data.

Note
successCb and failureCb must not be nullptr

Definition at line 75 of file validator.cpp.

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

Asynchronously validate interest.

Note
successCb and failureCb must not be nullptr

Definition at line 95 of file validator.cpp.

Member Data Documentation

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

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

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

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

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

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