ndn::security::Validator Class Referenceabstract

provides the interfaces for packet validation. More...

#include <validator.hpp>

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

Classes

class  Error
 

Public Member Functions

 Validator (Face *face=nullptr)
 Validator constructor. More...
 
 Validator (Face &face)
 
virtual ~Validator ()
 
void setDirectCertFetchEnabled (bool isEnabled)
 Enable or disable the direct certificate fetch feature. More...
 
void validate (const Data &data, const OnDataValidated &onValidated, const OnDataValidationFailed &onValidationFailed)
 Validate Data and call either onValidated or onValidationFailed. More...
 
void validate (const Interest &interest, const OnInterestValidated &onValidated, const OnInterestValidationFailed &onValidationFailed)
 Validate Interest and call either onValidated or onValidationFailed. More...
 

Static Public Member Functions

static bool verifySignature (const Data &data, const v1::PublicKey &publicKey)
 Verify the data using the publicKey. More...
 
static bool verifySignature (const Interest &interest, const v1::PublicKey &publicKey)
 Verify the signed Interest using the publicKey. More...
 
static bool verifySignature (const Buffer &blob, const Signature &sig, const v1::PublicKey &publicKey)
 Verify the blob using the publicKey against the signature. More...
 
static bool verifySignature (const Data &data, const Signature &sig, const v1::PublicKey &publicKey)
 Verify the data using the publicKey against the SHA256-RSA signature. More...
 
static bool verifySignature (const Interest &interest, const Signature &sig, const v1::PublicKey &publicKey)
 Verify the interest using the publicKey against the SHA256-RSA signature. More...
 
static bool verifySignature (const uint8_t *buf, const size_t size, const Signature &sig, const v1::PublicKey &publicKey)
 Verify the blob using the publicKey against the SHA256-RSA signature. More...
 
static bool verifySignature (const Data &data, const DigestSha256 &sig)
 Verify the data against the SHA256 signature. More...
 
static bool verifySignature (const Interest &interest, const DigestSha256 &sig)
 Verify the interest against the SHA256 signature. More...
 
static bool verifySignature (const Buffer &blob, const DigestSha256 &sig)
 Verify the blob against the SHA256 signature. More...
 
static bool verifySignature (const uint8_t *buf, const size_t size, const DigestSha256 &sig)
 Verify the blob against the SHA256 signature. More...
 

Protected Types

typedef function< void(const std::string &)> OnFailure
 

Protected Member Functions

virtual void afterCheckPolicy (const std::vector< shared_ptr< ValidationRequest >> &nextSteps, const OnFailure &onFailure)
 trigger after checkPolicy is done. More...
 
virtual void checkPolicy (const Data &data, int nSteps, const OnDataValidated &onValidated, const OnDataValidationFailed &onValidationFailed, std::vector< shared_ptr< ValidationRequest >> &nextSteps)=0
 Check the Data against policy and return the next validation step if necessary. More...
 
virtual void checkPolicy (const Interest &interest, int nSteps, const OnInterestValidated &onValidated, const OnInterestValidationFailed &onValidationFailed, std::vector< shared_ptr< ValidationRequest >> &nextSteps)=0
 Check the Interest against validation policy and return the next validation step if necessary. More...
 
void onData (const Interest &interest, const Data &data, const shared_ptr< ValidationRequest > &nextStep)
 Process the received certificate. More...
 
virtual void onNack (const Interest &interest, const lp::Nack &nack, int nRemainingRetries, const OnFailure &onFailure, const shared_ptr< ValidationRequest > &validationRequest)
 trigger when interest retrieves a Nack. More...
 
virtual void onTimeout (const Interest &interest, int nRemainingRetries, const OnFailure &onFailure, const shared_ptr< ValidationRequest > &validationRequest)
 trigger when interest for certificate times out. More...
 
virtual shared_ptr< const DatapreCertificateValidation (const Data &data)
 Hooks. More...
 
void validate (const Data &data, const OnDataValidated &onValidated, const OnDataValidationFailed &onValidationFailed, int nSteps)
 
void validate (const Interest &interest, const OnInterestValidated &onValidated, const OnInterestValidationFailed &onValidationFailed, int nSteps)
 

Protected Attributes

Facem_face
 
bool m_wantDirectCertFetch
 

Detailed Description

provides the interfaces for packet validation.

Definition at line 39 of file validator.hpp.

Member Typedef Documentation

typedef function<void(const std::string&)> ndn::security::Validator::OnFailure
protected

Definition at line 260 of file validator.hpp.

Constructor & Destructor Documentation

ndn::security::Validator::Validator ( Face face = nullptr)
explicit

Validator constructor.

Parameters
facePointer to face through which validator may retrieve certificates. Passing a null pointer implies the validator is in offline mode.
Note
Make sure the lifetime of the passed Face is longer than validator.

Definition at line 34 of file validator.cpp.

ndn::security::Validator::Validator ( Face face)
explicit
Deprecated:
Use the constructor taking Face* as parameter.

Definition at line 40 of file validator.cpp.

ndn::security::Validator::~Validator ( )
virtualdefault

Member Function Documentation

void ndn::security::Validator::afterCheckPolicy ( const std::vector< shared_ptr< ValidationRequest >> &  nextSteps,
const OnFailure onFailure 
)
protectedvirtual

trigger after checkPolicy is done.

Validator can decide how to handle the set of validation requests according to the trust model.

Parameters
nextStepsA set of validation request made by checkPolicy.
onFailureFailure callback when errors happen in processing nextSteps.

Definition at line 303 of file validator.cpp.

virtual void ndn::security::Validator::checkPolicy ( const Data data,
int  nSteps,
const OnDataValidated onValidated,
const OnDataValidationFailed onValidationFailed,
std::vector< shared_ptr< ValidationRequest >> &  nextSteps 
)
protectedpure virtual

Check the Data against policy and return the next validation step if necessary.

If there is no next validation step, that validation MUST have been done. i.e., either onValidated or onValidationFailed callback is invoked.

Parameters
dataThe Data to check.
nStepsThe number of validation steps that have been done.
onValidatedIf the Data is validated, this calls onValidated(data)
onValidationFailedIf validation fails, this calls onValidationFailed(data)
nextStepsOn return, contains the next validation step

Implemented in ndn::security::CommandInterestValidator, and ndn::security::ValidatorConfig.

virtual void ndn::security::Validator::checkPolicy ( const Interest interest,
int  nSteps,
const OnInterestValidated onValidated,
const OnInterestValidationFailed onValidationFailed,
std::vector< shared_ptr< ValidationRequest >> &  nextSteps 
)
protectedpure virtual

Check the Interest against validation policy and return the next validation step if necessary.

If there is no next validation step, that validation MUST have been done. i.e., either onValidated or onValidationFailed callback is invoked.

Parameters
interestThe Interest to check.
nStepsThe number of validation steps that have been done.
onValidatedIf the Interest is validated, this calls onValidated(data)
onValidationFailedIf validation fails, this calls onValidationFailed(data)
nextStepsOn return, contains the next validation step

Implemented in ndn::security::CommandInterestValidator, and ndn::security::ValidatorConfig.

void ndn::security::Validator::onData ( const Interest interest,
const Data data,
const shared_ptr< ValidationRequest > &  nextStep 
)
protected

Process the received certificate.

Definition at line 88 of file validator.cpp.

void ndn::security::Validator::onNack ( const Interest interest,
const lp::Nack nack,
int  nRemainingRetries,
const OnFailure onFailure,
const shared_ptr< ValidationRequest > &  validationRequest 
)
protectedvirtual

trigger when interest retrieves a Nack.

Validator can decide how to handle a Nack, either call onFailure, or retry.

Parameters
interestThe interest that retrieves a Nack.
nackThe Nack that is retrieved.
nRemainingRetriesThe number of retries left.
onFailureFailure callback when there is no more retries remaining.
validationRequestThe validationRequest containing the context of the interest.

Definition at line 256 of file validator.cpp.

void ndn::security::Validator::onTimeout ( const Interest interest,
int  nRemainingRetries,
const OnFailure onFailure,
const shared_ptr< ValidationRequest > &  validationRequest 
)
protectedvirtual

trigger when interest for certificate times out.

Validator can decide how to handle the timeout, either call onFailure, or retry.

Parameters
interestThe interest that times out.
nRemainingRetriesThe number of retries left.
onFailureFailure callback when there is no more retries remaining.
validationRequestThe validationRequest containing the context of the interest.

Definition at line 280 of file validator.cpp.

virtual shared_ptr<const Data> ndn::security::Validator::preCertificateValidation ( const Data data)
inlineprotectedvirtual

Hooks.

trigger before validating requested certificate.

The Data:

  • matches the interest in the validation-request.
  • may be certificate or a data encapsulating certificate.

This method returns a data (actually certificate) that is will be passed as Data into: Validator::validate(const Data& data, const OnDataValidated& onValidated, const OnDataValidationFailed& onValidationFailed, int nSteps);

Definition at line 296 of file validator.hpp.

void ndn::security::Validator::setDirectCertFetchEnabled ( bool  isEnabled)

Enable or disable the direct certificate fetch feature.

When enabled, the validator will attempt to fetch the certificate that signs an Interest from the sender of that Interest, as identified by IncomingFaceId field, in addition to fetching from the infrastructure.

Prior to enabling this feature, the application must enable NextHopFaceId privilege on the face used by this validator.

Note
Current implementation can only fetch the Interest signer certificate from the Interest sender; the issuer certificate of that certificate is only fetched from the infrastructure.
Currently, this feature can only be used with ValidatorConfig.
Parameters
isEnabledSet true to enable the feature or false to disable.

Definition at line 330 of file validator.cpp.

void ndn::security::Validator::validate ( const Data data,
const OnDataValidated onValidated,
const OnDataValidationFailed onValidationFailed 
)
inline

Validate Data and call either onValidated or onValidationFailed.

Parameters
dataThe Data with the signature to check.
onValidatedIf the Data is validated, this calls onValidated(data).
onValidationFailedIf validation fails, this calls onValidationFailed(data).

Definition at line 78 of file validator.hpp.

void ndn::security::Validator::validate ( const Interest interest,
const OnInterestValidated onValidated,
const OnInterestValidationFailed onValidationFailed 
)
inline

Validate Interest and call either onValidated or onValidationFailed.

Parameters
interestThe Interest with the signature to check.
onValidatedIf the Interest is validated, this calls onValidated(interest).
onValidationFailedIf validation fails, this calls onValidationFailed(interest).

Definition at line 93 of file validator.hpp.

void ndn::security::Validator::validate ( const Data data,
const OnDataValidated onValidated,
const OnDataValidationFailed onValidationFailed,
int  nSteps 
)
protected

Definition at line 68 of file validator.cpp.

void ndn::security::Validator::validate ( const Interest interest,
const OnInterestValidated onValidated,
const OnInterestValidationFailed onValidationFailed,
int  nSteps 
)
protected

Definition at line 48 of file validator.cpp.

bool ndn::security::Validator::verifySignature ( const Data data,
const v1::PublicKey publicKey 
)
static

Verify the data using the publicKey.

Definition at line 104 of file validator.cpp.

bool ndn::security::Validator::verifySignature ( const Interest interest,
const v1::PublicKey publicKey 
)
static

Verify the signed Interest using the publicKey.

(Note the signature covers the first n-2 name components).

Definition at line 116 of file validator.cpp.

static bool ndn::security::Validator::verifySignature ( const Buffer blob,
const Signature sig,
const v1::PublicKey publicKey 
)
inlinestatic

Verify the blob using the publicKey against the signature.

Definition at line 139 of file validator.hpp.

static bool ndn::security::Validator::verifySignature ( const Data data,
const Signature sig,
const v1::PublicKey publicKey 
)
inlinestatic

Verify the data using the publicKey against the SHA256-RSA signature.

Definition at line 146 of file validator.hpp.

static bool ndn::security::Validator::verifySignature ( const Interest interest,
const Signature sig,
const v1::PublicKey publicKey 
)
inlinestatic

Verify the interest using the publicKey against the SHA256-RSA signature.

(Note the signature covers the first n-2 name components).

Definition at line 160 of file validator.hpp.

bool ndn::security::Validator::verifySignature ( const uint8_t *  buf,
const size_t  size,
const Signature sig,
const v1::PublicKey publicKey 
)
static

Verify the blob using the publicKey against the SHA256-RSA signature.

Definition at line 142 of file validator.cpp.

static bool ndn::security::Validator::verifySignature ( const Data data,
const DigestSha256 sig 
)
inlinestatic

Verify the data against the SHA256 signature.

Definition at line 184 of file validator.hpp.

static bool ndn::security::Validator::verifySignature ( const Interest interest,
const DigestSha256 sig 
)
inlinestatic

Verify the interest against the SHA256 signature.

(Note the signature covers the first n-2 name components).

Definition at line 197 of file validator.hpp.

static bool ndn::security::Validator::verifySignature ( const Buffer blob,
const DigestSha256 sig 
)
inlinestatic

Verify the blob against the SHA256 signature.

Definition at line 211 of file validator.hpp.

bool ndn::security::Validator::verifySignature ( const uint8_t *  buf,
const size_t  size,
const DigestSha256 sig 
)
static

Verify the blob against the SHA256 signature.

Definition at line 234 of file validator.cpp.

Member Data Documentation

Face* ndn::security::Validator::m_face
protected

Definition at line 349 of file validator.hpp.

bool ndn::security::Validator::m_wantDirectCertFetch
protected

Definition at line 350 of file validator.hpp.