ndn::PibIdentity Class Reference

PibIdentity is at the top level in PIB's Identity-Key-Certificate hierarchy. More...

#include <pib-identity.hpp>

Public Member Functions
const Name &	getName ()
ptr_lib::shared_ptr< PibKey >	getKey (const Name &keyName)
	Get the key with name keyName. More...
ptr_lib::shared_ptr< PibKey > &	getDefaultKey ()
	Get the default key of this Identity. More...

Friends
class	PibIdentityContainer
class	KeyChain

Detailed Description

PibIdentity is at the top level in PIB's Identity-Key-Certificate hierarchy.

An identity has a Name, and contains zero or more keys, at most one of which is set as the default key of this identity. Properties of a key can be accessed after obtaining a PibKey object.

Member Function Documentation

ptr_lib::shared_ptr< PibKey > & ndn::PibIdentity::getDefaultKey

(

)

Get the default key of this Identity.

Returns

The default PibKey.

Exceptions

std::domain_error	if the backend implementation instance is invalid.
Pib::Error	if the default key has not been set.

ptr_lib::shared_ptr< PibKey > ndn::PibIdentity::getKey

(

const Name &

keyName

)

Get the key with name keyName.

Parameters

keyName

The name of the key.

Returns

The PibKey object.

Exceptions

std::domain_error	if the backend implementation instance is invalid.
std::invalid_argument	if keyName does not match the identity name.
Pib::Error	if the key does not exist.

---

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

• include/ndn-cpp/security/pib/pib-identity.hpp
• src/security/pib/pib-identity.cpp