represents the PIB More...

#include <pib.hpp>

Inheritance diagram for ndn::security::pib::Pib:

Collaboration diagram for ndn::security::pib::Pib:

[legend]

Classes
class	Error
	represents a semantic error More...

Public Member Functions
	~Pib ()

std::string	getScheme () const
	return the scheme of the PibLocator More...

std::string	getPibLocator () const
	Get PIB Locator. More...

void	setTpmLocator (const std::string &tpmLocator)
	Set the corresponding TPM information to `tpmLocator`. More...

std::string	getTpmLocator () const
	Get TPM Locator. More...

void	reset ()
	Reset content in PIB, including reset of the TPM locator. More...

Identity	getIdentity (const Name &identityName) const
	Get an identity with name `identityName`. More...

const IdentityContainer &	getIdentities () const
	Get all the identities. More...

const Identity &	getDefaultIdentity () const
	Get the default identity. More...

Identity	addIdentity (const Name &identity)
	Add an `identity`. More...

void	removeIdentity (const Name &identity)

const Identity &	setDefaultIdentity (const Name &identity)
	Set an `identity` as the default identity. More...

shared_ptr< PibImpl >	getImpl ()

Public Attributes
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE	__pad0__: Pib(const std::string& scheme

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const std::string &	location

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const std::string shared_ptr< PibImpl >	impl

Protected Attributes
std::string	m_scheme

std::string	m_location

bool	m_isDefaultIdentityLoaded

Identity	m_defaultIdentity

IdentityContainer	m_identities

shared_ptr< PibImpl >	m_impl

Friends
class	v2::KeyChain

Detailed Description

represents the PIB

The PIB (Public Information Base) stores the public portion of a user's cryptography keys. The format and location of stored information is indicated by the PibLocator. The PIB is designed to work with a TPM (Trusted Platform Module) which stores private keys. There is a one-to-one association between PIB and TPM, and therefore the TpmLocator is recorded by the PIB to enforce this association and prevent one from operating on mismatched PIB and TPM.

Information in the PIB is organized in a hierarchy of Identity-Key-Certificate. At the top level, the Pib class provides access to identities, and allows setting a default identity. Properties of an identity can be accessed after obtaining an Identity object.

Note: Pib instance is created and managed only by v2::KeyChain. v2::KeyChain::getPib() returns a const reference to the managed Pib instance, through which it is possible to retrieve information about identities, keys, and certificates.

Exceptions

PibImpl::Error when underlying implementation has non-semantic error.

Definition at line 52 of file pib.hpp.

Constructor & Destructor Documentation

◆ ~Pib()

ndn::security::pib::Pib::~Pib ( )

default

Member Function Documentation

◆ getScheme()

std::string ndn::security::pib::Pib::getScheme ( ) const

inline

return the scheme of the PibLocator

Definition at line 73 of file pib.hpp.

References m_scheme.

◆ getPibLocator()

std::string ndn::security::pib::Pib::getPibLocator ( ) const

Get PIB Locator.

Definition at line 45 of file pib.cpp.

References m_location, and m_scheme.

◆ setTpmLocator()

void ndn::security::pib::Pib::setTpmLocator ( const std::string & tpmLocator )

Set the corresponding TPM information to tpmLocator.

If the provided tpmLocator is different from the existing one, PIB will be reset. Otherwise, nothing will be changed.

Definition at line 51 of file pib.cpp.

References m_impl, and reset().

◆ getTpmLocator()

std::string ndn::security::pib::Pib::getTpmLocator ( ) const

Get TPM Locator.

Exceptions

Error if TPM locator is empty

Definition at line 61 of file pib.cpp.

References m_impl.

◆ reset()

void ndn::security::pib::Pib::reset ( )

Reset content in PIB, including reset of the TPM locator.

Definition at line 71 of file pib.cpp.

References m_identities, m_impl, m_isDefaultIdentityLoaded, and ndn::security::pib::IdentityContainer::reset().

Referenced by setTpmLocator().

◆ getIdentity()

Identity ndn::security::pib::Pib::getIdentity ( const Name & identityName ) const

Get an identity with name identityName.

Exceptions

Pib::Error if the identity does not exist.

Definition at line 100 of file pib.cpp.

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

◆ getIdentities()

const IdentityContainer & ndn::security::pib::Pib::getIdentities ( ) const

Get all the identities.

Definition at line 108 of file pib.cpp.

References ndn::security::pib::IdentityContainer::isConsistent(), and m_identities.

◆ getDefaultIdentity()

const Identity & ndn::security::pib::Pib::getDefaultIdentity ( ) const

Get the default identity.

Exceptions

Pib::Error if no default identity.

Definition at line 129 of file pib.cpp.

References ndn::security::pib::IdentityContainer::get(), ndn::security::pib::Identity::getName(), ndn::security::pib::IdentityContainer::isConsistent(), m_defaultIdentity, m_identities, m_impl, m_isDefaultIdentityLoaded, and NDN_LOG_DEBUG.

◆ addIdentity()

Identity ndn::security::pib::Pib::addIdentity ( const Name & identity )

Add an identity.

If no default identity is set before, the new identity will be set as the default identity

Returns: handle of the added identity.

Definition at line 80 of file pib.cpp.

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

◆ removeIdentity()

void ndn::security::pib::Pib::removeIdentity ( const Name & identity )

Definition at line 88 of file pib.cpp.

References ndn::security::pib::Identity::getName(), ndn::security::pib::IdentityContainer::isConsistent(), m_defaultIdentity, m_identities, m_isDefaultIdentityLoaded, and ndn::security::pib::IdentityContainer::remove().

◆ setDefaultIdentity()

const Identity & ndn::security::pib::Pib::setDefaultIdentity ( const Name & identity )

Set an identity as the default identity.

Create the identity if it does not exist.

Returns: handle of the default identity

Definition at line 116 of file pib.cpp.

References ndn::security::pib::IdentityContainer::add(), ndn::security::pib::IdentityContainer::isConsistent(), m_defaultIdentity, m_identities, m_impl, m_isDefaultIdentityLoaded, and NDN_LOG_DEBUG.

◆ getImpl()

shared_ptr<PibImpl> ndn::security::pib::Pib::getImpl ( )

inline

Definition at line 172 of file pib.hpp.

References m_impl.

Friends And Related Function Documentation

◆ v2::KeyChain

friend class v2::KeyChain

friend

Definition at line 188 of file pib.hpp.

Member Data Documentation

◆ pad0

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE ndn::security::pib::Pib::__pad0__

Definition at line 132 of file pib.hpp.

◆ location

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const std::string& ndn::security::pib::Pib::location

Definition at line 132 of file pib.hpp.

◆ impl

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const std::string shared_ptr<PibImpl> ndn::security::pib::Pib::impl

Definition at line 132 of file pib.hpp.

◆ m_scheme

std::string ndn::security::pib::Pib::m_scheme

protected

Definition at line 178 of file pib.hpp.

Referenced by getPibLocator(), and getScheme().

◆ m_location

std::string ndn::security::pib::Pib::m_location

protected

Definition at line 179 of file pib.hpp.

Referenced by getPibLocator().

◆ m_isDefaultIdentityLoaded

bool ndn::security::pib::Pib::m_isDefaultIdentityLoaded

mutableprotected

Definition at line 181 of file pib.hpp.

Referenced by getDefaultIdentity(), removeIdentity(), reset(), and setDefaultIdentity().

◆ m_defaultIdentity

Identity ndn::security::pib::Pib::m_defaultIdentity

mutableprotected

Definition at line 182 of file pib.hpp.

Referenced by getDefaultIdentity(), removeIdentity(), and setDefaultIdentity().

◆ m_identities

IdentityContainer ndn::security::pib::Pib::m_identities

protected

Definition at line 184 of file pib.hpp.

Referenced by addIdentity(), getDefaultIdentity(), getIdentities(), getIdentity(), removeIdentity(), reset(), and setDefaultIdentity().

◆ m_impl

shared_ptr<PibImpl> ndn::security::pib::Pib::m_impl

protected

Definition at line 186 of file pib.hpp.

Referenced by getDefaultIdentity(), getImpl(), getTpmLocator(), reset(), setDefaultIdentity(), and setTpmLocator().

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

ndnSIM/ndn-cxx/src/security/pib/pib.hpp
ndnSIM/ndn-cxx/src/security/pib/pib.cpp

Classes

Public Member Functions

Public Attributes

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~Pib()

Member Function Documentation

◆ getScheme()

◆ getPibLocator()

◆ setTpmLocator()

◆ getTpmLocator()

◆ reset()

◆ getIdentity()

◆ getIdentities()

◆ getDefaultIdentity()

◆ addIdentity()

◆ removeIdentity()

◆ setDefaultIdentity()

◆ getImpl()

Friends And Related Function Documentation

◆ v2::KeyChain

Member Data Documentation

◆ __pad0__

◆ location

◆ impl

◆ m_scheme

◆ m_location

◆ m_isDefaultIdentityLoaded

◆ m_defaultIdentity

◆ m_identities

◆ m_impl

◆ pad0