ndn::security::pib::detail::IdentityImpl Class Reference

Backend instance of Identity. More...

#include <identity-impl.hpp>

Inheritance diagram for ndn::security::pib::detail::IdentityImpl:

Collaboration diagram for ndn::security::pib::detail::IdentityImpl:

Public Member Functions
	IdentityImpl (const Name &identityName, shared_ptr< PibImpl > pibImpl, bool needInit=false)
	Create an Identity with identityName. More...
const Name &	getName () const
	Get the name of the identity. More...
Key	addKey (span< const uint8_t > key, const Name &keyName)
	Add key with name keyName (in PKCS #8 format). More...
void	removeKey (const Name &keyName)
	Remove a key with keyName. More...
Key	getKey (const Name &keyName) const
	Get a key with id keyName. More...
const KeyContainer &	getKeys () const
	Get all keys for this Identity. More...
const Key &	setDefaultKey (const Name &keyName)
	Set the key with id keyName. More...
const Key &	setDefaultKey (span< const uint8_t > key, const Name &keyName)
	Add key with name keyName and set it as the default key. More...
const Key &	getDefaultKey () const
	Get the default key for this Identity. More...

Detailed Description

Backend instance of Identity.

An Identity has only one backend instance, but may have multiple frontend handles. Each frontend handle is associated with the only one backend IdentityImpl.

Exceptions

PibImpl::Error

when underlying implementation has non-semantic error.

Definition at line 43 of file identity-impl.hpp.

Constructor & Destructor Documentation

IdentityImpl()

ndn::security::pib::detail::IdentityImpl::IdentityImpl	(	const Name &	identityName,
		shared_ptr< PibImpl >	pibImpl,
		bool	needInit = false
	)

Create an Identity with identityName.

Parameters

identityName	The name of the Identity.
pibImpl	The PIB backend implementation.
needInit	If true, create the identity in backend when the identity does not exist. Otherwise, throw Pib::Error when the identity does not exist.

Definition at line 31 of file identity-impl.cpp.

References NDN_THROW, and ndn::Name::toUri().

Member Function Documentation

getName()

const Name& ndn::security::pib::detail::IdentityImpl::getName ( ) const

inline

Get the name of the identity.

Definition at line 60 of file identity-impl.hpp.

References addKey(), getDefaultKey(), getKey(), getKeys(), removeKey(), and setDefaultKey().

addKey()

Key ndn::security::pib::detail::IdentityImpl::addKey	(	span< const uint8_t >	key,
		const Name &	keyName
	)

Add key with name keyName (in PKCS #8 format).

If no default key is set before, the new key will be set as the default key of the identity. If a key with the same name already exists, it will be overwritten.

Returns

the added key.

Exceptions

std::invalid_argument

key name does not match identity

Definition at line 48 of file identity-impl.cpp.

References ndn::security::pib::KeyContainer::add(), and ndn::security::pib::KeyContainer::isConsistent().

Referenced by getName(), and setDefaultKey().

removeKey()

void ndn::security::pib::detail::IdentityImpl::removeKey

(

const Name &

keyName

)

Remove a key with keyName.

Exceptions

std::invalid_argument

keyName does not match identity

Definition at line 55 of file identity-impl.cpp.

References ndn::security::pib::Key::getName(), ndn::security::pib::KeyContainer::isConsistent(), and ndn::security::pib::KeyContainer::remove().

Referenced by getName().

getKey()

Key ndn::security::pib::detail::IdentityImpl::getKey

(

const Name &

keyName

)

const

Get a key with id keyName.

Exceptions

std::invalid_argument	keyName does not match identity
Pib::Error	the key does not exist.

Definition at line 66 of file identity-impl.cpp.

References ndn::security::pib::KeyContainer::get(), and ndn::security::pib::KeyContainer::isConsistent().

Referenced by getName().

getKeys()

const KeyContainer & ndn::security::pib::detail::IdentityImpl::getKeys

(

)

const

Get all keys for this Identity.

Definition at line 73 of file identity-impl.cpp.

References ndn::security::pib::KeyContainer::isConsistent().

Referenced by getName().

setDefaultKey() [1/2]

const Key & ndn::security::pib::detail::IdentityImpl::setDefaultKey

(

const Name &

keyName

)

Set the key with id keyName.

Exceptions

std::invalid_argument	keyName does not match identity
Pib::Error	the key does not exist.

Returns

The default key

Definition at line 80 of file identity-impl.cpp.

References ndn::security::pib::KeyContainer::get(), and ndn::security::pib::KeyContainer::isConsistent().

Referenced by getName(), and setDefaultKey().

setDefaultKey() [2/2]

const Key & ndn::security::pib::detail::IdentityImpl::setDefaultKey	(	span< const uint8_t >	key,
		const Name &	keyName
	)

Add key with name keyName and set it as the default key.

Exceptions

std::invalid_argument	keyName does not match identity
Pib::Error	the key with the same name already exists

Returns

the default key

Definition at line 91 of file identity-impl.cpp.

References addKey(), and setDefaultKey().

getDefaultKey()

const Key & ndn::security::pib::detail::IdentityImpl::getDefaultKey

(

)

const

Get the default key for this Identity.

Exceptions

Pib::Error

the default key does not exist.

Definition at line 98 of file identity-impl.cpp.

References ndn::security::pib::KeyContainer::get(), ndn::security::pib::Key::getName(), and ndn::security::pib::KeyContainer::isConsistent().

Referenced by getName().

---

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

• ndnSIM/ndn-cxx/ndn-cxx/security/pib/impl/identity-impl.hpp
• ndnSIM/ndn-cxx/ndn-cxx/security/pib/impl/identity-impl.cpp