ndn::security::CertificateFetcher Class Referenceabstract

Interface used by the validator to fetch missing certificates. More...

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

+ Inheritance diagram for ndn::security::CertificateFetcher:
+ Collaboration diagram for ndn::security::CertificateFetcher:

Public Types

using ValidationContinuation = std::function< void(const Certificate &cert, const shared_ptr< ValidationState > &state)>
 

Public Member Functions

 CertificateFetcher ()
 
virtual ~CertificateFetcher ()
 
void fetch (const shared_ptr< CertificateRequest > &certRequest, const shared_ptr< ValidationState > &state, const ValidationContinuation &continueValidation)
 Asynchronously fetch certificate. More...
 
virtual void setCertificateStorage (CertificateStorage &certStorage)
 Assign certificate storage to check known certificate and to cache unverified ones. More...
 

Protected Attributes

CertificateStoragem_certStorage
 

Detailed Description

Interface used by the validator to fetch missing certificates.

Definition at line 37 of file certificate-fetcher.hpp.

Member Typedef Documentation

◆ ValidationContinuation

using ndn::security::CertificateFetcher::ValidationContinuation = std::function<void(const Certificate& cert, const shared_ptr<ValidationState>& state)>

Definition at line 40 of file certificate-fetcher.hpp.

Constructor & Destructor Documentation

◆ CertificateFetcher()

ndn::security::CertificateFetcher::CertificateFetcher ( )

Definition at line 34 of file certificate-fetcher.cpp.

◆ ~CertificateFetcher()

ndn::security::CertificateFetcher::~CertificateFetcher ( )
virtualdefault

Member Function Documentation

◆ fetch()

void ndn::security::CertificateFetcher::fetch ( const shared_ptr< CertificateRequest > &  certRequest,
const shared_ptr< ValidationState > &  state,
const ValidationContinuation continueValidation 
)

Asynchronously fetch certificate.

Precondition
m_certStorage != nullptr

If the requested certificate exists in the storage, then this method will immediately call continueValidation with the certification. If certificate is not available, the implementation-specific doFetch will be called to asynchronously fetch certificate. The successfully retrieved certificate will be automatically added to the unverified cache of the certificate storage.

When the requested certificate is retrieved, continueValidation is called. Otherwise, the fetcher implementation call state->failed() with the appropriate error code and diagnostic message.

Definition at line 48 of file certificate-fetcher.cpp.

◆ setCertificateStorage()

void ndn::security::CertificateFetcher::setCertificateStorage ( CertificateStorage certStorage)
virtual

Assign certificate storage to check known certificate and to cache unverified ones.

Note
The supplied certStorage should be valid for the lifetime of CertificateFetcher

Reimplemented in ndn::security::CertificateBundleFetcher.

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

Member Data Documentation

◆ m_certStorage

CertificateStorage* ndn::security::CertificateFetcher::m_certStorage
protected

Definition at line 82 of file certificate-fetcher.hpp.