KeyLocatorChecker is one of the classes used by ValidatorConfig. More...

#include <key-locator-checker.hpp>

Inheritance diagram for ndn::security::conf::KeyLocatorChecker:

Public Types
enum	Relation { RELATION_EQUAL, RELATION_IS_PREFIX_OF, RELATION_IS_STRICT_PREFIX_OF }

Public Member Functions
virtual	~KeyLocatorChecker ()

bool	check (const Data &data, const KeyLocator &keyLocator, std::string &failInfo)

bool	check (const Interest &interest, const KeyLocator &keyLocator, std::string &failInfo)

Protected Member Functions
virtual bool	check (const Name &packetName, const KeyLocator &keyLocator, std::string &failInfo)=0

bool	checkRelation (const Relation &relation, const Name &name1, const Name &name2)

Detailed Description

KeyLocatorChecker is one of the classes used by ValidatorConfig.

The ValidatorConfig class consists of a set of rules. The KeyLocatorChecker class is part of a rule and is used to check if the KeyLocator field of a packet satisfy the requirements.

Definition at line 51 of file key-locator-checker.hpp.

Member Enumeration Documentation

◆ Relation

enum ndn::security::conf::KeyLocatorChecker::Relation

Enumerator
RELATION_EQUAL
RELATION_IS_PREFIX_OF
RELATION_IS_STRICT_PREFIX_OF

Definition at line 54 of file key-locator-checker.hpp.

Constructor & Destructor Documentation

◆ ~KeyLocatorChecker()

virtual ndn::security::conf::KeyLocatorChecker::~KeyLocatorChecker ( )

inlinevirtual

Definition at line 61 of file key-locator-checker.hpp.

Member Function Documentation

◆ check() [1/3]

bool ndn::security::conf::KeyLocatorChecker::check	(	const Data &	data,
		const KeyLocator &	keyLocator,
		std::string &	failInfo
	)

inline

Definition at line 66 of file key-locator-checker.hpp.

References ndn::Data::getName().

Referenced by check().

◆ check() [2/3]

bool ndn::security::conf::KeyLocatorChecker::check	(	const Interest &	interest,
		const KeyLocator &	keyLocator,
		std::string &	failInfo
	)

inline

Definition at line 74 of file key-locator-checker.hpp.

References check(), ndn::Interest::getName(), ndn::Name::getPrefix(), ndn::signed_interest::MIN_LENGTH, and ndn::Name::size().

◆ check() [3/3]

virtual bool ndn::security::conf::KeyLocatorChecker::check	(	const Name &	packetName,
		const KeyLocator &	keyLocator,
		std::string &	failInfo
	)

protectedpure virtual

Implemented in ndn::security::conf::HyperKeyLocatorNameChecker, ndn::security::conf::RegexKeyLocatorNameChecker, and ndn::security::conf::RelationKeyLocatorNameChecker.

◆ checkRelation()

bool ndn::security::conf::KeyLocatorChecker::checkRelation	(	const Relation &	relation,
		const Name &	name1,
		const Name &	name2
	)

inlineprotected

Definition at line 96 of file key-locator-checker.hpp.

References ndn::Name::isPrefixOf(), RELATION_EQUAL, RELATION_IS_PREFIX_OF, and RELATION_IS_STRICT_PREFIX_OF.

Referenced by ndn::security::conf::RelationKeyLocatorNameChecker::check(), and ndn::security::conf::HyperKeyLocatorNameChecker::check().

The documentation for this class was generated from the following file:

ndnSIM/ndn-cxx/src/security/conf/key-locator-checker.hpp

Public Types

Public Member Functions

Protected Member Functions