ndn::security::v2::InterestValidationState Class Referencefinal

Validation state for an interest packet. More...

#include <ndn-cxx/security/validation-state.hpp>

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

Public Member Functions

 InterestValidationState (const Interest &interest, const InterestValidationSuccessCallback &successCb, const InterestValidationFailureCallback &failureCb)
 Create validation state for interest. More...
 
 ~InterestValidationState () final
 Destructor. More...
 
void addCertificate (const Certificate &cert)
 Add cert to the top of the certificate chain. More...
 
void fail (const ValidationError &error) final
 Call the failure callback. More...
 
size_t getDepth () const
 
const InterestgetOriginalInterest () const
 
boost::logic::tribool getOutcome () const
 
template<typename T >
shared_ptr< T > getTag () const
 get a tag item More...
 
bool hasSeenCertificateName (const Name &certName)
 Check if certName has been previously seen and record the supplied name. More...
 
template<typename T >
void removeTag () const
 remove tag item More...
 
template<typename T >
void setTag (shared_ptr< T > tag) const
 set a tag item More...
 

Public Attributes

util::Signal< InterestValidationState, InterestafterSuccess
 

Protected Attributes

boost::logic::tribool m_outcome
 

Detailed Description

Validation state for an interest packet.

Definition at line 205 of file validation-state.hpp.

Constructor & Destructor Documentation

◆ InterestValidationState()

ndn::security::v2::InterestValidationState::InterestValidationState ( const Interest interest,
const InterestValidationSuccessCallback successCb,
const InterestValidationFailureCallback failureCb 
)

Create validation state for interest.

The caller must ensure that state instance is valid until validation finishes (i.e., until after validateCertificateChain() and validateOriginalPacket() are called)

Definition at line 148 of file validation-state.cpp.

◆ ~InterestValidationState()

ndn::security::v2::InterestValidationState::~InterestValidationState ( )
final

Destructor.

If neither success callback nor failure callback was called, the destructor will call failure callback with IMPLEMENTATION_ERROR error code.

Definition at line 159 of file validation-state.cpp.

Member Function Documentation

◆ addCertificate()

void ndn::security::v2::ValidationState::addCertificate ( const Certificate cert)
inherited

Add cert to the top of the certificate chain.

If m_certificateChain is empty, cert should be the signer of the original packet. If m_certificateChain is not empty, cert should be the signer of m_certificateChain.front().

Postcondition
m_certificateChain.front() == cert
Note
This function does not verify the signature bits.

Definition at line 60 of file validation-state.cpp.

◆ fail()

void ndn::security::v2::InterestValidationState::fail ( const ValidationError error)
finalvirtual

Call the failure callback.

Implements ndn::security::v2::ValidationState.

Definition at line 192 of file validation-state.cpp.

◆ getDepth()

size_t ndn::security::v2::ValidationState::getDepth ( ) const
inherited
Returns
Depth of certificate chain

Definition at line 48 of file validation-state.cpp.

◆ getOriginalInterest()

const Interest & ndn::security::v2::InterestValidationState::getOriginalInterest ( ) const
Returns
Original interest being validated

Definition at line 201 of file validation-state.cpp.

◆ getOutcome()

boost::logic::tribool ndn::security::v2::ValidationState::getOutcome ( ) const
inlineinherited

Definition at line 71 of file validation-state.hpp.

◆ getTag()

template<typename T >
shared_ptr< T > ndn::TagHost::getTag ( ) const
inherited

get a tag item

Template Parameters
Ttype of the tag, which must be a subclass of ndn::Tag
Return values
nullptrif no Tag of type T is stored

Definition at line 66 of file tag-host.hpp.

◆ hasSeenCertificateName()

bool ndn::security::v2::ValidationState::hasSeenCertificateName ( const Name certName)
inherited

Check if certName has been previously seen and record the supplied name.

Definition at line 54 of file validation-state.cpp.

◆ removeTag()

template<typename T >
void ndn::TagHost::removeTag ( ) const
inherited

remove tag item

Note
Tag can be removed even on a const tag host instance

Definition at line 93 of file tag-host.hpp.

◆ setTag()

template<typename T >
void ndn::TagHost::setTag ( shared_ptr< T >  tag) const
inherited

set a tag item

Template Parameters
Ttype of the tag, which must be a subclass of ndn::Tag
Note
Tag can be set even on a const tag host instance

Definition at line 79 of file tag-host.hpp.

Member Data Documentation

◆ afterSuccess

util::Signal<InterestValidationState, Interest> ndn::security::v2::InterestValidationState::afterSuccess

Definition at line 236 of file validation-state.hpp.

◆ m_outcome

boost::logic::tribool ndn::security::v2::ValidationState::m_outcome
protectedinherited

Definition at line 140 of file validation-state.hpp.