ndn::security Namespace Reference

Namespaces
	conf

Classes
class	AdditionalDescription
	Abstraction of AdditionalDescription. More...
class	CertificateContainer
	A handler to search or enumerate certificates of a key. More...
class	DummyPublicInfo
class	DummyTpm
struct	Factory
class	Identity
	represents an identity More...
class	IdentityContainer
	A handler to search or enumerate identities in PIB. More...
class	Key
	represents a key More...
class	KeyChain
	The packet signing interface. More...
class	KeyContainer
	A handler to search or enumerate keys of an identity. More...
class	Pib
	represents the PIB More...
class	PibImpl
	Abstract class of PIB implementation. More...
class	PibMemory
	An in-memory implementation of Pib. More...
class	PibSqlite3
	Pib backend implementation based on SQLite3 database. More...
class	SigningInfo
	Signing parameters passed to KeyChain. More...
class	ValidityPeriod
	Abstraction of validity period. More...

Typedefs
typedef Factory< KeyChain::PibCreateFunc >	PibFactory
typedef Factory< KeyChain::TpmCreateFunc >	TpmFactory

Functions
template size_t	AdditionalDescription::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &encoder) const
template size_t	AdditionalDescription::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &encoder) const
std::ostream &	operator<< (std::ostream &os, const AdditionalDescription &other)
static std::map< std::string, PibFactory > &	getPibFactories ()
static std::map< std::string, TpmFactory > &	getTpmFactories ()
static std::tuple< std::string, std::string >	parseUri (const std::string &uri)
static std::tuple< std::string, std::string >	getCanonicalPibLocator (const std::string &pibLocator)
static std::tuple< std::string, std::string >	getCanonicalTpmLocator (const std::string &tpmLocator)
static Name	getKeyName (const Name &identity, const name::Component &keyId)
SigningInfo	signingByIdentity (const Name &identity)
SigningInfo	signingByKey (const Name &keyName)
SigningInfo	signingByCertificate (const Name &certName)
SigningInfo	signingWithSha256 ()
std::ostream &	operator<< (std::ostream &os, const SigningInfo &si)
template size_t	ValidityPeriod::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &encoder) const
template size_t	ValidityPeriod::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &encoder) const
std::ostream &	operator<< (std::ostream &os, const ValidityPeriod &period)

Variables
static const uint8_t	DUMMY_CERT []
static const uint8_t	DUMMY_SIGNATURE []
	DummyPublicInfo
pib	dummy
	DummyTpm
	WireEncodable< AdditionalDescription >
	WireEncodableWithEncodingBuffer< AdditionalDescription >
	WireDecodable< AdditionalDescription >
static const size_t	KEY_OFFSET = 0
static const size_t	VALUE_OFFSET = 1
const std::string	DEFAULT_PIB_SCHEME = "pib-sqlite3"
const std::string	DEFAULT_TPM_SCHEME = "tpm-file"
	SecPublicInfoSqlite3
pib	sqlite3
	SecTpmFile
tpm	file
static const string	INITIALIZATION
	WireEncodable< ValidityPeriod >
	WireEncodableWithEncodingBuffer< ValidityPeriod >
	WireDecodable< ValidityPeriod >
static const size_t	ISO_DATETIME_SIZE = 15
static const size_t	NOT_BEFORE_OFFSET = 0
static const size_t	NOT_AFTER_OFFSET = 1

Typedef Documentation

PibFactory

typedef Factory<KeyChain::PibCreateFunc> ndn::security::PibFactory

Definition at line 84 of file key-chain.cpp.

TpmFactory

typedef Factory<KeyChain::TpmCreateFunc> ndn::security::TpmFactory

Definition at line 85 of file key-chain.cpp.

Function Documentation

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

template size_t ndn::security::AdditionalDescription::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

encoder

)

const

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

template size_t ndn::security::AdditionalDescription::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

encoder

)

const

operator<<() [1/3]

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

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

Referenced by ndn::security::ValidityPeriod::Error::Error(), and ndn::security::AdditionalDescription::size().

getPibFactories()

static std::map<std::string, PibFactory>& ndn::security::getPibFactories ( )

static

Definition at line 88 of file key-chain.cpp.

Referenced by ndn::security::KeyChain::createPib(), getCanonicalPibLocator(), and getTpmFactories().

getTpmFactories()

static std::map<std::string, TpmFactory>& ndn::security::getTpmFactories ( )

static

Definition at line 95 of file key-chain.cpp.

References ndn::security::Factory< T >::canonicalName, and getPibFactories().

Referenced by ndn::security::KeyChain::createTpm(), and getCanonicalTpmLocator().

parseUri()

static std::tuple<std::string, std::string> ndn::security::parseUri ( const std::string &  uri )

inlinestatic

Definition at line 150 of file key-chain.cpp.

Referenced by getCanonicalPibLocator(), and getCanonicalTpmLocator().

getCanonicalPibLocator()

static std::tuple<std::string, std::string> ndn::security::getCanonicalPibLocator ( const std::string &  pibLocator )

inlinestatic

Definition at line 170 of file key-chain.cpp.

References DEFAULT_PIB_SCHEME, getPibFactories(), and parseUri().

Referenced by ndn::security::KeyChain::createPib(), and ndn::security::KeyChain::createTpm().

getCanonicalTpmLocator()

static std::tuple<std::string, std::string> ndn::security::getCanonicalTpmLocator ( const std::string &  tpmLocator )

inlinestatic

Definition at line 208 of file key-chain.cpp.

References DEFAULT_TPM_SCHEME, getTpmFactories(), and parseUri().

Referenced by ndn::security::KeyChain::createTpm().

getKeyName()

static Name ndn::security::getKeyName ( const Name &  identity, const name::Component &  keyId  )

static

Definition at line 207 of file pib-sqlite3.cpp.

References ndn::Name::append().

Referenced by ndn::security::PibSqlite3::addKey(), ndn::security::PibSqlite3::getCertificatesOfKey(), ndn::security::PibSqlite3::getDefaultCertificateOfKey(), ndn::security::PibSqlite3::getKeyBits(), ndn::security::PibSqlite3::hasKey(), ndn::security::PibSqlite3::removeKey(), and ndn::security::PibSqlite3::setDefaultKeyOfIdentity().

signingByIdentity()

SigningInfo ndn::security::signingByIdentity

(

const Name &

identity

)

Returns

a SigningInfo for signing with an identity

Definition at line 28 of file signing-helpers.cpp.

References ndn::security::SigningInfo::SIGNER_TYPE_ID.

Referenced by nfd::rib::AutoPrefixPropagator::disable(), ndn::Face::registerPrefix(), ndn::Face::setInterestFilter(), ndn::nfd::CommandOptions::setSigningInfo(), and ndn::security::KeyChain::signByIdentity().

signingByKey()

SigningInfo ndn::security::signingByKey

(

const Name &

keyName

)

Returns

a SigningInfo for signing with a key

Definition at line 34 of file signing-helpers.cpp.

References ndn::security::SigningInfo::SIGNER_TYPE_KEY.

signingByCertificate()

SigningInfo ndn::security::signingByCertificate

(

const Name &

certName

)

Returns

a SigningInfo for signing with a certificate

Definition at line 40 of file signing-helpers.cpp.

References ndn::security::SigningInfo::SIGNER_TYPE_CERT.

Referenced by ndn::nfd::makeSigningInfoFromIdentityCertificate(), ndn::Face::registerPrefix(), and ndn::Face::setInterestFilter().

signingWithSha256()

SigningInfo ndn::security::signingWithSha256

(

)

Returns

a SigningInfo for signing with Sha256

Definition at line 46 of file signing-helpers.cpp.

References ndn::security::SigningInfo::SIGNER_TYPE_SHA256.

Referenced by ndn::security::KeyChain::signWithSha256().

operator<<() [2/3]

std::ostream & ndn::security::operator<<	(	std::ostream &	os,
		const SigningInfo &	si
	)

Definition at line 111 of file signing-info.cpp.

References ndn::security::KeyChain::DIGEST_SHA256_IDENTITY, ndn::security::SigningInfo::getSignerName(), ndn::security::SigningInfo::getSignerType(), ndn::security::SigningInfo::SIGNER_TYPE_CERT, ndn::security::SigningInfo::SIGNER_TYPE_ID, ndn::security::SigningInfo::SIGNER_TYPE_KEY, ndn::security::SigningInfo::SIGNER_TYPE_NULL, and ndn::security::SigningInfo::SIGNER_TYPE_SHA256.

ValidityPeriod::wireEncode< encoding::EncoderTag >()

template size_t ndn::security::ValidityPeriod::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

encoder

)

const

ValidityPeriod::wireEncode< encoding::EstimatorTag >()

template size_t ndn::security::ValidityPeriod::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

encoder

)

const

operator<<() [3/3]

std::ostream & ndn::security::operator<<	(	std::ostream &	os,
		const ValidityPeriod &	period
	)

Definition at line 164 of file validity-period.cpp.

References ndn::security::ValidityPeriod::getPeriod(), and ndn::time::toIsoString().

Variable Documentation

DUMMY_CERT

const uint8_t ndn::security::DUMMY_CERT[]

static

Initial value:

=
  "Bv0C8Ac4CAVkdW1teQgDa2V5CANLRVkIEWtzay0xNDE4NjAwMzkxMDUwCAdJRC1D"
  "RVJUCAn9AAABSkssIl4UAxgBAhX9AXMwggFvMCIYDzIwMTQxMjE0MjMzOTUxWhgP"
  "MjAzNDEyMDkyMzM5NTFaMCUwIwYDVQQpExwvZHVtbXkva2V5L2tzay0xNDE4NjAw"
  "MzkxMDUwMIIBIDANBgkqhkiG9w0BAQEFAAOCAQ0AMIIBCAKCAQEAxUfhv54Jdgeq"
  "0wmQ/ru9ew/ByCKcQawaZT9Xm9o/sMahwQ9IbNx2Dz4Jkelaxra7+DI0QP3pYctv"
  "Ykn/jwq5y3cO0LJQB+kf/7FtSKG9qBEv8aqq5hDVteBUKiyUXqDmQzbe+mTcJ9Yd"
  "D7siF1dhrjnM3KL1xpcXu3QaV5m/I6cKVwYrJxp3JKr6k5pHhxJlPIyUu7oU3kFW"
  "7bHq2uq4ec9gBXCKwA64IVYVQm1GVDk+V0wr7pw9qD6QNa7eMzrCME6vfM0deSiU"
  "a4TovUJDQFDsM287kYm3tZu7iuJzmOC63tl4YZdyqyOgnqSrUGE1soNHfLokI13H"
  "hSwxok7nuQIBERY0GwEBHC8HLQgFZHVtbXkIA2tleQgDS0VZCBFrc2stMTQxODYw"
  "MDM5MTA1MAgHSUQtQ0VSVBf9AQBLLJoQt9HE93NI3Mv1JCb3ezBCWMwTDnZA+XQV"
  "UgVSvISJfU/lo2sne0SfGp4KsUhj206CDpuh3q0Th5gKSJeysy/bv66V2m2G8aDn"
  "OkJ7Ut+2o/QnFpIMJz+oZf2f9Z0Pchocmkv8y4Fj02t8HCuFO1ekEvOcocZvWbKy"
  "HX+P0OdefPzSC535/rsNHXTzgPsoV+yb13vrm4wPeqPPBs+scQYneIFKkRkGE5PU"
  "pkncAMBN6iWgmSA2RcjcbmT6utCjJTqWviX1XPQtHoF/hBGC0D/TtQDgwVGGibXB"
  "zb+klRHvCC/uUIfjU2HrE705kaw8btPhTP5/PMe8YKkk+hjh"

Definition at line 28 of file dummy-keychain.cpp.

DUMMY_SIGNATURE

const uint8_t ndn::security::DUMMY_SIGNATURE[]

static

Initial value:

=
  {0x17, 0xfd, 0x01, 0x00, 0x93, 0x15, 0x09, 0x49, 0x79, 0x9e, 0xb7, 0x9c, 0xd3, 0xc1, 0xbf, 0x61,
   0x89, 0xd5, 0xd9, 0xca, 0xf2, 0xb0, 0x14, 0xae, 0x72, 0x7c, 0x1f, 0x8f, 0xf5, 0xb1, 0x70, 0xd6,
   0x9b, 0x8f, 0xf8, 0xd7, 0x2d, 0xbc, 0x92, 0x6f, 0x7d, 0x77, 0x96, 0x46, 0xea, 0xd4, 0x7d, 0x90,
   0xbc, 0x7a, 0xeb, 0xe2, 0x03, 0x93, 0xb1, 0xd2, 0x62, 0xec, 0x9d, 0xff, 0x9c, 0x9c, 0x2a, 0x14,
   0x7d, 0x23, 0xca, 0x29, 0x3d, 0x15, 0x1a, 0x40, 0x42, 0x2c, 0x59, 0x33, 0x8a, 0xf7, 0xc0, 0x6b,
   0xc4, 0x9c, 0xf3, 0xc4, 0x99, 0xa4, 0x1a, 0x60, 0xf5, 0x28, 0x7d, 0x4c, 0xef, 0x43, 0x7d, 0xbd,
   0x7d, 0x00, 0x51, 0xee, 0x41, 0xf5, 0x25, 0x80, 0xce, 0xe6, 0x64, 0x4f, 0x75, 0x54, 0xf3, 0xb2,
   0x99, 0x9a, 0x0f, 0x93, 0x9a, 0x28, 0x1d, 0xfe, 0x12, 0x8a, 0xe0, 0xc1, 0x02, 0xeb, 0xa4, 0x35,
   0x52, 0x88, 0xac, 0x44, 0x1a, 0x44, 0x82, 0x97, 0x4f, 0x5f, 0xa8, 0xd8, 0x9f, 0x67, 0x38, 0xa8,
   0x64, 0xb6, 0x62, 0x99, 0xbd, 0x96, 0x3c, 0xf5, 0x86, 0x09, 0x5c, 0x97, 0x6b, 0x8f, 0xae, 0xe0,
   0x60, 0xe7, 0x23, 0x98, 0x6a, 0xee, 0xc1, 0xb0, 0x14, 0xbe, 0x46, 0x2c, 0xfb, 0xa7, 0x27, 0x73,
   0xe4, 0xf3, 0x26, 0x33, 0xba, 0x99, 0xd4, 0x01, 0x38, 0xa8, 0xf2, 0x9e, 0x87, 0xe0, 0x71, 0x0b,
   0x25, 0x44, 0x07, 0x35, 0x88, 0xab, 0x67, 0x27, 0x56, 0x0e, 0xb5, 0xb5, 0xe8, 0x27, 0xb4, 0x49,
   0xdc, 0xb8, 0x48, 0x31, 0xff, 0x99, 0x48, 0xab, 0x11, 0xb4, 0xa0, 0xdf, 0x8a, 0x6d, 0xff, 0x43,
   0x69, 0x32, 0xa7, 0xbc, 0x63, 0x9d, 0x0f, 0xe0, 0x95, 0x34, 0x36, 0x25, 0x4b, 0x3e, 0x36, 0xbd,
   0x81, 0x91, 0x0b, 0x91, 0x9f, 0x3a, 0x04, 0xa2, 0x44, 0x28, 0x19, 0xa1, 0x38, 0x21, 0x4f, 0x25,
   0x59, 0x8a, 0x48, 0xc2}

Definition at line 46 of file dummy-keychain.cpp.

DummyPublicInfo

ndn::security::DummyPublicInfo

Definition at line 68 of file dummy-keychain.cpp.

dummy

tpm ndn::security::dummy

Definition at line 68 of file dummy-keychain.cpp.

DummyTpm

ndn::security::DummyTpm

Definition at line 69 of file dummy-keychain.cpp.

WireEncodable< AdditionalDescription >

ndn::security::WireEncodable< AdditionalDescription >

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

WireEncodableWithEncodingBuffer< AdditionalDescription >

ndn::security::WireEncodableWithEncodingBuffer< AdditionalDescription >

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

WireDecodable< AdditionalDescription >

ndn::security::WireDecodable< AdditionalDescription >

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

KEY_OFFSET

const size_t ndn::security::KEY_OFFSET = 0

static

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

Referenced by ndn::security::AdditionalDescription::wireDecode().

VALUE_OFFSET

const size_t ndn::security::VALUE_OFFSET = 1

static

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

Referenced by ndn::security::AdditionalDescription::wireDecode().

DEFAULT_PIB_SCHEME

const std::string ndn::security::DEFAULT_PIB_SCHEME = "pib-sqlite3"

Definition at line 51 of file key-chain.cpp.

Referenced by getCanonicalPibLocator().

DEFAULT_TPM_SCHEME

const std::string ndn::security::DEFAULT_TPM_SCHEME = "tpm-file"

Definition at line 56 of file key-chain.cpp.

Referenced by getCanonicalTpmLocator().

SecPublicInfoSqlite3

ndn::security::SecPublicInfoSqlite3

Definition at line 64 of file key-chain.cpp.

sqlite3

pib ndn::security::sqlite3

Definition at line 64 of file key-chain.cpp.

SecTpmFile

ndn::security::SecTpmFile

Definition at line 70 of file key-chain.cpp.

file

tpm ndn::security::file

Definition at line 70 of file key-chain.cpp.

Referenced by nfd::getExtendedErrorMessage(), ndn::ValidatorConfig::load(), and ndn::SecTpmFile::signInTpm().

INITIALIZATION

const string ndn::security::INITIALIZATION

static

Definition at line 38 of file pib-sqlite3.cpp.

WireEncodable< ValidityPeriod >

ndn::security::WireEncodable< ValidityPeriod >

Definition at line 30 of file validity-period.cpp.

WireEncodableWithEncodingBuffer< ValidityPeriod >

ndn::security::WireEncodableWithEncodingBuffer< ValidityPeriod >

Definition at line 31 of file validity-period.cpp.

WireDecodable< ValidityPeriod >

ndn::security::WireDecodable< ValidityPeriod >

Definition at line 32 of file validity-period.cpp.

ISO_DATETIME_SIZE

const size_t ndn::security::ISO_DATETIME_SIZE = 15

static

Definition at line 36 of file validity-period.cpp.

Referenced by ndn::security::ValidityPeriod::wireDecode().

NOT_BEFORE_OFFSET

const size_t ndn::security::NOT_BEFORE_OFFSET = 0

static

Definition at line 37 of file validity-period.cpp.

Referenced by ndn::security::ValidityPeriod::wireDecode().

NOT_AFTER_OFFSET

const size_t ndn::security::NOT_AFTER_OFFSET = 1

static

Definition at line 38 of file validity-period.cpp.

Referenced by ndn::security::ValidityPeriod::wireDecode().