ndn::security::Pib Class Reference

represents the PIB More...

#include <pib.hpp>

Inheritance diagram for ndn::security::Pib:

Collaboration diagram for ndn::security::Pib:

Data Structures
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...
Identity	getIdentity (const Name &identityName) const
	Get an identity with name identityName. More...
const IdentityContainer &	getIdentities () const
	Get all the identities. More...
Identity &	getDefaultIdentity () const
	Get the default identity. More...

Protected Attributes
std::string	m_scheme
std::string	m_location
bool	m_hasDefaultIdentity
Identity	m_defaultIdentity
bool	m_needRefreshIdentities
IdentityContainer	m_identities
shared_ptr< PibImpl >	m_impl

Friends
class	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.

Exceptions

PibImpl::Error

when underlying implementation has non-semantic error.

Definition at line 48 of file pib.hpp.

Constructor & Destructor Documentation

ndn::security::Pib::~Pib

(

)

Definition at line 37 of file pib.cpp.

Member Function Documentation

Identity & ndn::security::Pib::getDefaultIdentity

(

)

const

Get the default identity.

Returns

the default identity.

Exceptions

Pib::Error

if no default identity.

Definition at line 108 of file pib.cpp.

const IdentityContainer & ndn::security::Pib::getIdentities

(

)

const

Get all the identities.

Definition at line 87 of file pib.cpp.

Identity ndn::security::Pib::getIdentity

(

const Name &

identityName

)

const

Get an identity with name identityName.

Parameters

identityName

The name for the identity to get.

Exceptions

Pib::Error

if the identity does not exist.

Definition at line 81 of file pib.cpp.

std::string ndn::security::Pib::getPibLocator

(

)

const

Get PIB Locator.

Definition at line 42 of file pib.cpp.

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

inline

return the scheme of the PibLocator

Definition at line 73 of file pib.hpp.

std::string ndn::security::Pib::getTpmLocator

(

)

const

Get TPM Locator.

Definition at line 54 of file pib.cpp.

void ndn::security::Pib::setTpmLocator

(

const std::string &

tpmLocator

)

Set the corresponding TPM information to tpmLocator.

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

Parameters

tpmLocator

The name for the new TPM locator

Definition at line 48 of file pib.cpp.

Friends And Related Function Documentation

friend class KeyChain

friend

Definition at line 51 of file pib.hpp.

Field Documentation

Identity ndn::security::Pib::m_defaultIdentity

mutableprotected

Definition at line 176 of file pib.hpp.

bool ndn::security::Pib::m_hasDefaultIdentity

mutableprotected

Definition at line 175 of file pib.hpp.

IdentityContainer ndn::security::Pib::m_identities

mutableprotected

Definition at line 179 of file pib.hpp.

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

protected

Definition at line 181 of file pib.hpp.

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

protected

Definition at line 173 of file pib.hpp.

bool ndn::security::Pib::m_needRefreshIdentities

mutableprotected

Definition at line 178 of file pib.hpp.

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

protected

Definition at line 172 of file pib.hpp.