#include <dummy-keychain.hpp>

Inheritance diagram for ndn::security::DummyPublicInfo:

Collaboration diagram for ndn::security::DummyPublicInfo:

Public Member Functions
	DummyPublicInfo (const std::string &locator)

virtual bool	doesIdentityExist (const Name &identityName)
	Check if the specified identity already exists. More...

virtual void	addIdentity (const Name &identityName)
	Add a new identity. More...

virtual bool	revokeIdentity ()
	Revoke the identity. More...

virtual bool	doesPublicKeyExist (const Name &keyName)
	Check if the specified key already exists. More...

virtual void	addKey (const Name &keyName, const PublicKey &publicKey)
	Add a public key to the identity storage. More...

virtual shared_ptr< PublicKey >	getPublicKey (const Name &keyName)
	Get shared pointer to PublicKey object from the identity storage. More...

virtual KeyType	getPublicKeyType (const Name &keyName)
	Get the type of the queried public key. More...

virtual bool	doesCertificateExist (const Name &certificateName)
	Check if the specified certificate already exists. More...

virtual void	addCertificate (const IdentityCertificate &certificate)
	Add a certificate to the identity storage. More...

virtual shared_ptr< IdentityCertificate >	getCertificate (const Name &certificateName)
	Get a shared pointer to identity certificate object from the identity storage. More...

virtual Name	getDefaultIdentity ()
	Get name of the default identity. More...

virtual Name	getDefaultKeyNameForIdentity (const Name &identityName)
	Get name of the default key name for the specified identity. More...

virtual Name	getDefaultCertificateNameForKey (const Name &keyName)
	Get name of the default certificate name for the specified key. More...

virtual void	getAllIdentities (std::vector< Name > &nameList, bool isDefault)
	Get all the identities from public info. More...

virtual void	getAllKeyNames (std::vector< Name > &nameList, bool isDefault)
	Get all the key names from public info. More...

virtual void	getAllKeyNamesOfIdentity (const Name &identity, std::vector< Name > &nameList, bool isDefault)
	Get all the key names of a particular identity. More...

virtual void	getAllCertificateNames (std::vector< Name > &nameList, bool isDefault)
	Get all the certificate name in public info. More...

virtual void	getAllCertificateNamesOfKey (const Name &keyName, std::vector< Name > &nameList, bool isDefault)
	Get all the certificate name of a particular key name. More...

virtual void	deleteCertificateInfo (const Name &certificateName)
	Delete a certificate. More...

virtual void	deletePublicKeyInfo (const Name &keyName)
	Delete a public key and related certificates. More...

virtual void	deleteIdentityInfo (const Name &identity)
	Delete an identity and related public keys and certificates. More...

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

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

Public Member Functions inherited from ndn::security::SecPublicInfo
	SecPublicInfo (const std::string &location)

virtual	~SecPublicInfo ()
	The virtual Destructor. More...

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

	DEPRECATED (void addPublicKey(const Name &keyName, KeyType keyType, const v1::PublicKey &publicKey))
	Add a public key to the identity storage. More...

void	setDefaultIdentity (const Name &identityName)
	Set the default identity. More...

void	setDefaultKeyNameForIdentity (const Name &keyName)
	Set the default key name for the corresponding identity. More...

void	setDefaultCertificateNameForKey (const Name &certificateName)
	Set the default certificate name for the corresponding key. More...

Name	getNewKeyName (const Name &identityName, bool useKsk)
	Generate a key name for the identity. More...

Name	getDefaultCertificateNameForIdentity (const Name &identityName)
	Get the default certificate name for the specified identity. More...

Name	getDefaultCertificateName ()
	Get the default certificate name of the default identity. More...

void	addCertificateAsKeyDefault (const v1::IdentityCertificate &certificate)
	Add a certificate and set the certificate as the default one of its corresponding key. More...

void	addCertificateAsIdentityDefault (const v1::IdentityCertificate &certificate)
	Add a certificate into the public key identity storage and set the certificate as the default one of its corresponding identity. More...

void	addCertificateAsSystemDefault (const v1::IdentityCertificate &certificate)
	Add a certificate into the public key identity storage and set the certificate as the default one of the default identity. More...

	DEPRECATED (shared_ptr< v1::IdentityCertificate > defaultCertificate())
	Get cached default certificate of the default identity. More...

shared_ptr< v1::IdentityCertificate >	getDefaultCertificate ()
	Get cached default certificate of the default identity. More...

void	refreshDefaultCertificate ()
	try to get the default certificate of the default identity from the public info More...

Static Public Attributes
static const std::string	SCHEME = "pib-dummy"

Protected Member Functions
virtual void	setDefaultIdentityInternal (const Name &identityName)
	Set the default identity. More...

virtual void	setDefaultKeyNameForIdentityInternal (const Name &keyName)
	Set the default key name for the corresponding identity. More...

virtual void	setDefaultCertificateNameForKeyInternal (const Name &certificateName)
	Set the default certificate name for the corresponding key. More...

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

Additional Inherited Members
Protected Attributes inherited from ndn::security::SecPublicInfo
shared_ptr< v1::IdentityCertificate >	m_defaultCertificate

std::string	m_location

Detailed Description

Definition at line 29 of file dummy-keychain.hpp.

Constructor & Destructor Documentation

◆ DummyPublicInfo()

ndn::security::DummyPublicInfo::DummyPublicInfo ( const std::string & locator )

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

Member Function Documentation

◆ doesIdentityExist()

bool ndn::security::DummyPublicInfo::doesIdentityExist ( const Name & identityName )

virtual

Check if the specified identity already exists.

Parameters

identityName The identity name

Returns: true if the identity exists, otherwise false

Implements ndn::security::SecPublicInfo.

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

◆ addIdentity()

void ndn::security::DummyPublicInfo::addIdentity ( const Name & identityName )

virtual

Add a new identity.

if identity already exist, do not add it again

Parameters

identityName The identity name to be added

Implements ndn::security::SecPublicInfo.

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

◆ revokeIdentity()

bool ndn::security::DummyPublicInfo::revokeIdentity ( )

virtual

Revoke the identity.

Returns: true if the identity was revoked, otherwise false

Implements ndn::security::SecPublicInfo.

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

◆ doesPublicKeyExist()

bool ndn::security::DummyPublicInfo::doesPublicKeyExist ( const Name & keyName )

virtual

Check if the specified key already exists.

Parameters

keyName The name of the key

Returns: true if the key exists, otherwise false

Implements ndn::security::SecPublicInfo.

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

◆ addKey()

void ndn::security::DummyPublicInfo::addKey	(	const Name &	keyName,
		const PublicKey &	publicKey
	)

virtual

Add a public key to the identity storage.

Parameters

keyName	The name of the public key to be added
publicKey	Reference to the PublicKey object

Implements ndn::security::SecPublicInfo.

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

◆ getPublicKey()

shared_ptr< PublicKey > ndn::security::DummyPublicInfo::getPublicKey ( const Name & keyName )

virtual

Get shared pointer to PublicKey object from the identity storage.

Parameters

keyName The name of the requested public key

Exceptions

SecPublicInfo::Error if public key does not exist

Implements ndn::security::SecPublicInfo.

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

References ndn::io::NO_ENCODING.

◆ getPublicKeyType()

KeyType ndn::security::DummyPublicInfo::getPublicKeyType ( const Name & keyName )

virtual

Get the type of the queried public key.

Note: KeyType is also available from PublicKey instance. This method is more efficient if only KeyType is needed.

Parameters

keyName The name of the requested public key

Returns: the type of the key. If the queried key does not exist, KeyType::NONE will be returned

Implements ndn::security::SecPublicInfo.

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

References ndn::RSA.

◆ doesCertificateExist()

bool ndn::security::DummyPublicInfo::doesCertificateExist ( const Name & certificateName )

virtual

Check if the specified certificate already exists.

Parameters

certificateName The name of the certificate

Implements ndn::security::SecPublicInfo.

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

◆ addCertificate()

void ndn::security::DummyPublicInfo::addCertificate ( const IdentityCertificate & certificate )

virtual

Add a certificate to the identity storage.

It will add the corresponding public key and identity if they do not exist

Parameters

certificate The certificate to be added

Implements ndn::security::SecPublicInfo.

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

◆ getCertificate()

shared_ptr< IdentityCertificate > ndn::security::DummyPublicInfo::getCertificate ( const Name & certificateName )

virtual

Get a shared pointer to identity certificate object from the identity storage.

Parameters

certificateName The name of the requested certificate

Exceptions

SecPublicInfo::Error if the certificate does not exist

Implements ndn::security::SecPublicInfo.

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

References ndn::io::BASE64.

◆ getDefaultIdentity()

Name ndn::security::DummyPublicInfo::getDefaultIdentity ( )

virtual

Get name of the default identity.

Exceptions

SecPublicInfo::Error if there is no default.

Implements ndn::security::SecPublicInfo.

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

◆ getDefaultKeyNameForIdentity()

Name ndn::security::DummyPublicInfo::getDefaultKeyNameForIdentity ( const Name & identityName )

virtual

Get name of the default key name for the specified identity.

Parameters

identityName The identity name

Exceptions

SecPublicInfo::Error if there is no default

Implements ndn::security::SecPublicInfo.

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

◆ getDefaultCertificateNameForKey()

Name ndn::security::DummyPublicInfo::getDefaultCertificateNameForKey ( const Name & keyName )

virtual

Get name of the default certificate name for the specified key.

Parameters

keyName The key name.

Exceptions

SecPublicInfo::Error if there is no default.

Implements ndn::security::SecPublicInfo.

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

◆ getAllIdentities()

void ndn::security::DummyPublicInfo::getAllIdentities	(	std::vector< Name > &	nameList,
		bool	isDefault
	)

virtual

Get all the identities from public info.

Parameters

[out]	nameList	On return, the identity list
	isDefault	If specified, only the default identity is returned

Implements ndn::security::SecPublicInfo.

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

◆ getAllKeyNames()

void ndn::security::DummyPublicInfo::getAllKeyNames	(	std::vector< Name > &	nameList,
		bool	isDefault
	)

virtual

Get all the key names from public info.

Parameters

[out]	nameList	On return, the key name list.
	isDefault	If specified, only the default keys are returned

Implements ndn::security::SecPublicInfo.

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

◆ getAllKeyNamesOfIdentity()

void ndn::security::DummyPublicInfo::getAllKeyNamesOfIdentity	(	const Name &	identity,
		std::vector< Name > &	nameList,
		bool	isDefault
	)

virtual

Get all the key names of a particular identity.

Parameters

	identity	The specified identity name
[out]	nameList	On return, the key name list
	isDefault	If specified, only the default key is returned

Implements ndn::security::SecPublicInfo.

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

◆ getAllCertificateNames()

void ndn::security::DummyPublicInfo::getAllCertificateNames	(	std::vector< Name > &	nameList,
		bool	isDefault
	)

virtual

Get all the certificate name in public info.

Parameters

[out]	nameList	On return, the certificate name list
	isDefault	If specified, only the default certificates are returned

Implements ndn::security::SecPublicInfo.

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

◆ getAllCertificateNamesOfKey()

void ndn::security::DummyPublicInfo::getAllCertificateNamesOfKey	(	const Name &	keyName,
		std::vector< Name > &	nameList,
		bool	isDefault
	)

virtual

Get all the certificate name of a particular key name.

Parameters

	keyName	The specified key name
[out]	nameList	On return, the certificate name list
	isDefault	If specified, only the default certificate is returned

Implements ndn::security::SecPublicInfo.

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

◆ deleteCertificateInfo()

void ndn::security::DummyPublicInfo::deleteCertificateInfo ( const Name & certificateName )

virtual

Delete a certificate.

Parameters

certificateName The certificate name

Implements ndn::security::SecPublicInfo.

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

◆ deletePublicKeyInfo()

void ndn::security::DummyPublicInfo::deletePublicKeyInfo ( const Name & keyName )

virtual

Delete a public key and related certificates.

Parameters

keyName The key name

Implements ndn::security::SecPublicInfo.

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

◆ deleteIdentityInfo()

void ndn::security::DummyPublicInfo::deleteIdentityInfo ( const Name & identity )

virtual

Delete an identity and related public keys and certificates.

Parameters

identity The identity name

Implements ndn::security::SecPublicInfo.

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

◆ setTpmLocator()

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

virtual

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.

For legacy issue, the TPM info may not exist (some old PIB content may not have this info), this method will simply set the TPM info as provided without changing anything else. Thus an ideal process of handling old PIB is to check if TPM info exists. If it does not exist, then set it to the default value according to configuration.

Implements ndn::security::SecPublicInfo.

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

◆ getTpmLocator()

std::string ndn::security::DummyPublicInfo::getTpmLocator ( )

virtual

Get TPM Locator.

Exceptions

SecPublicInfo::Error if the TPM info does not exist

Implements ndn::security::SecPublicInfo.

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

◆ setDefaultIdentityInternal()

void ndn::security::DummyPublicInfo::setDefaultIdentityInternal ( const Name & identityName )

protectedvirtual

Set the default identity.

Parameters

identityName The default identity name

Implements ndn::security::SecPublicInfo.

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

◆ setDefaultKeyNameForIdentityInternal()

void ndn::security::DummyPublicInfo::setDefaultKeyNameForIdentityInternal ( const Name & keyName )

protectedvirtual

Set the default key name for the corresponding identity.

Parameters

keyName The key name

Exceptions

SecPublicInfo::Error if the key does not exist

Implements ndn::security::SecPublicInfo.

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

◆ setDefaultCertificateNameForKeyInternal()

void ndn::security::DummyPublicInfo::setDefaultCertificateNameForKeyInternal ( const Name & certificateName )

protectedvirtual

Set the default certificate name for the corresponding key.

Parameters

certificateName The certificate name

Exceptions

SecPublicInfo::Error if the certificate does not exist

Implements ndn::security::SecPublicInfo.

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

◆ getScheme()

std::string ndn::security::DummyPublicInfo::getScheme ( )

protectedvirtual

return the scheme of the PibLocator

Implements ndn::security::SecPublicInfo.

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

References SCHEME.

Member Data Documentation

◆ SCHEME

const std::string ndn::security::DummyPublicInfo::SCHEME = "pib-dummy"

static

Definition at line 116 of file dummy-keychain.hpp.

Referenced by getScheme().

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

ndnSIM/utils/dummy-keychain.hpp
ndnSIM/utils/dummy-keychain.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DummyPublicInfo()

Member Function Documentation

◆ doesIdentityExist()

◆ addIdentity()

◆ revokeIdentity()

◆ doesPublicKeyExist()

◆ addKey()

◆ getPublicKey()

◆ getPublicKeyType()

◆ doesCertificateExist()

◆ addCertificate()

◆ getCertificate()

◆ getDefaultIdentity()

◆ getDefaultKeyNameForIdentity()

◆ getDefaultCertificateNameForKey()

◆ getAllIdentities()

◆ getAllKeyNames()

◆ getAllKeyNamesOfIdentity()

◆ getAllCertificateNames()

◆ getAllCertificateNamesOfKey()

◆ deleteCertificateInfo()

◆ deletePublicKeyInfo()

◆ deleteIdentityInfo()

◆ setTpmLocator()

◆ getTpmLocator()

◆ setDefaultIdentityInternal()

◆ setDefaultKeyNameForIdentityInternal()

◆ setDefaultCertificateNameForKeyInternal()

◆ getScheme()

Member Data Documentation

◆ SCHEME