Namespaces | Classes | Typedefs | Functions
ndn::security::v2 Namespace Reference

Namespaces

 validator_config
 

Classes

class  AdditionalDescription
 Represents an AdditionalDescription TLV element. More...
 
class  CertContainerInterface
 
class  Certificate
 Represents an NDN certificate following the version 2.0 format. More...
 
class  CertificateBundleFetcher
 Fetch certificate bundle from the network. More...
 
class  CertificateCache
 Represents a container for verified certificates. More...
 
class  CertificateFetcher
 Interface used by the validator to fetch missing certificates. More...
 
class  CertificateFetcherDirectFetch
 Extends CertificateFetcherFromNetwork to fetch certificates from the incoming face of the packet. More...
 
class  CertificateFetcherFromNetwork
 Fetch missing keys from the network. More...
 
class  CertificateFetcherOffline
 Certificate fetcher realization that does not fetch keys (always offline) More...
 
class  CertificateRequest
 Request for a certificate, associated with the number of attempts. More...
 
class  CertificateStorage
 Storage for trusted anchors, verified certificate cache, and unverified certificate cache. More...
 
class  DataValidationState
 Validation state for a data packet. More...
 
class  DynamicTrustAnchorGroup
 Dynamic trust anchor group. More...
 
class  InterestValidationState
 Validation state for an interest packet. More...
 
class  KeyChain
 The interface of signing key management. More...
 
class  StaticTrustAnchorGroup
 Static trust anchor group. More...
 
class  TrustAnchorContainer
 represents a container for trust anchors. More...
 
class  TrustAnchorGroup
 A group of trust anchors. More...
 
class  ValidationError
 Validation error code and optional detailed error message. More...
 
class  ValidationPolicy
 Abstraction that implements validation policy for Data and Interest packets. More...
 
class  ValidationPolicyAcceptAll
 A validator policy that accepts any signature of data and interest packets. More...
 
class  ValidationPolicyCommandInterest
 Validation policy for stop-and-wait command Interests. More...
 
class  ValidationPolicySignedInterest
 Validation policy for signed Interests. More...
 
class  ValidationPolicySimpleHierarchy
 Validation policy for a simple hierarchical trust model. More...
 
class  ValidationState
 Validation state. More...
 
class  Validator
 Interface for validating data and interest packets. More...
 
class  ValidatorNull
 Validator with "accept-all" policy and offline certificate fetcher. More...
 

Typedefs

typedef function< void(const Data &data, const ValidationError &error)> DataValidationFailureCallback
 Callback to report a failed Data validation. More...
 
typedef function< void(const Data &data)> DataValidationSuccessCallback
 Callback to report a successful Data validation. More...
 
typedef function< void(const Interest &interest, const ValidationError &error)> InterestValidationFailureCallback
 Callback to report a failed Interest validation. More...
 
typedef function< void(const Interest &interest)> InterestValidationSuccessCallback
 Callback to report a successful Interest validation. More...
 
using SignedInterestFormatTag = SimpleTag< SignedInterestFormat, 1002 >
 

Functions

template size_t AdditionalDescription ::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t AdditionalDescription ::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 
Name constructKeyName (const Name &identity, const name::Component &keyId)
 Construct key name based on the appropriate naming conventions. More...
 
Name extractIdentityFromCertName (const Name &certName)
 Extract identity namespace from the certificate name certName. More...
 
Name extractIdentityFromKeyName (const Name &keyName)
 Extract identity namespace from the key name keyName. More...
 
Name extractIdentityNameFromKeyLocator (const Name &keyLocator)
 Extract identity name from key, version-less certificate, or certificate name. More...
 
Name extractKeyNameFromCertName (const Name &certName)
 Extract key name from the certificate name certName. More...
 
Validator & getAcceptAllValidator ()
 
Name getKeyLocatorName (const Data &data, ValidationState &state)
 extract KeyLocator.Name from a Data packet More...
 
Name getKeyLocatorName (const Interest &interest, ValidationState &state)
 extract KeyLocator.Name from signed Interest More...
 
bool isValidKeyName (const Name &keyName)
 Check if keyName follow the naming conventions for the key name. More...
 
std::ostream & operator<< (std::ostream &os, const AdditionalDescription &desc)
 
std::ostream & operator<< (std::ostream &os, const Certificate &cert)
 
std::ostream & operator<< (std::ostream &os, const ValidationError &error)
 
std::ostream & operator<< (std::ostream &os, ValidationError::Code code)
 

Typedef Documentation

◆ DataValidationFailureCallback

typedef function<void(const Data& data, const ValidationError& error)> ndn::security::v2::DataValidationFailureCallback

Callback to report a failed Data validation.

Definition at line 42 of file validation-callback.hpp.

◆ DataValidationSuccessCallback

typedef function<void(const Data& data)> ndn::security::v2::DataValidationSuccessCallback

Callback to report a successful Data validation.

Definition at line 37 of file validation-callback.hpp.

◆ InterestValidationFailureCallback

typedef function<void(const Interest& interest, const ValidationError& error)> ndn::security::v2::InterestValidationFailureCallback

Callback to report a failed Interest validation.

Definition at line 52 of file validation-callback.hpp.

◆ InterestValidationSuccessCallback

typedef function<void(const Interest& interest)> ndn::security::v2::InterestValidationSuccessCallback

Callback to report a successful Interest validation.

Definition at line 47 of file validation-callback.hpp.

◆ SignedInterestFormatTag

using ndn::security::v2::SignedInterestFormatTag = typedef SimpleTag<SignedInterestFormat, 1002>

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

Function Documentation

◆ AdditionalDescription ::wireEncode<::ndn::encoding::EncoderTag >()

template size_t ndn::security::v2::AdditionalDescription ::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const

◆ AdditionalDescription ::wireEncode<::ndn::encoding::EstimatorTag >()

template size_t ndn::security::v2::AdditionalDescription ::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const

◆ constructKeyName()

Name ndn::security::v2::constructKeyName ( const Name &  identity,
const name::Component &  keyId 
)

Construct key name based on the appropriate naming conventions.

Definition at line 143 of file key.cpp.

◆ extractIdentityFromCertName()

Name ndn::security::v2::extractIdentityFromCertName ( const Name &  certName)

Extract identity namespace from the certificate name certName.

Definition at line 186 of file certificate.cpp.

◆ extractIdentityFromKeyName()

Name ndn::security::v2::extractIdentityFromKeyName ( const Name &  keyName)

Extract identity namespace from the key name keyName.

Definition at line 160 of file key.cpp.

◆ extractIdentityNameFromKeyLocator()

Name ndn::security::v2::extractIdentityNameFromKeyLocator ( const Name &  keyLocator)

Extract identity name from key, version-less certificate, or certificate name.

Exceptions
KeyLocator::ErrorIf keyLocator does not follow the naming conventions

Definition at line 122 of file validation-policy.cpp.

◆ extractKeyNameFromCertName()

Name ndn::security::v2::extractKeyNameFromCertName ( const Name &  certName)

Extract key name from the certificate name certName.

Definition at line 197 of file certificate.cpp.

◆ getAcceptAllValidator()

Validator & ndn::security::v2::getAcceptAllValidator ( )

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

◆ getKeyLocatorName() [1/2]

Name ndn::security::v2::getKeyLocatorName ( const Data &  data,
ValidationState &  state 
)

extract KeyLocator.Name from a Data packet

The Data packet must contain a KeyLocator of Name type. Otherwise, state.fail is invoked with INVALID_KEY_LOCATOR error.

Definition at line 85 of file validation-policy.cpp.

◆ getKeyLocatorName() [2/2]

Name ndn::security::v2::getKeyLocatorName ( const Interest &  interest,
ValidationState &  state 
)

extract KeyLocator.Name from signed Interest

Signed Interests according to Packet Specification v0.3+, as identified inside the state, must have an InterestSignatureInfo element. Legacy signed Interests must contain a (Data)SignatureInfo name component. In both cases, the included KeyLocator must be of the Name type. otherwise, state.fail will be invoked with an INVALID_KEY_LOCATOR error.

Interests specified to this method must be tagged with a SignedInterestFormatTag to indicate whether they are signed according to Packet Specification v0.3+ or a previous specification.

Definition at line 91 of file validation-policy.cpp.

◆ isValidKeyName()

bool ndn::security::v2::isValidKeyName ( const Name &  keyName)

Check if keyName follow the naming conventions for the key name.

Definition at line 153 of file key.cpp.

◆ operator<<() [1/4]

std::ostream & ndn::security::v2::operator<< ( std::ostream &  os,
const AdditionalDescription &  desc 
)

Definition at line 166 of file additional-description.cpp.

◆ operator<<() [2/4]

std::ostream & ndn::security::v2::operator<< ( std::ostream &  os,
const Certificate &  cert 
)

Definition at line 142 of file certificate.cpp.

◆ operator<<() [3/4]

std::ostream & ndn::security::v2::operator<< ( std::ostream &  os,
const ValidationError &  error 
)

Definition at line 67 of file validation-error.cpp.

◆ operator<<() [4/4]

std::ostream & ndn::security::v2::operator<< ( std::ostream &  os,
ValidationError::Code  code 
)

Definition at line 30 of file validation-error.cpp.