ndn::security::v1::SecPublicInfo Class Referenceabstract

SecPublicInfo is a base class for the storage of public information. More...

#include <sec-public-info.hpp>

+ Inheritance diagram for ndn::security::v1::SecPublicInfo:
+ Collaboration diagram for ndn::security::v1::SecPublicInfo:

Classes

class  Error
 

Public Member Functions

 SecPublicInfo (const std::string &location)
 
virtual ~SecPublicInfo ()
 The virtual Destructor. More...
 
virtual void addCertificate (const IdentityCertificate &certificate)=0
 Add a certificate to the identity storage. More...
 
void addCertificateAsIdentityDefault (const 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 addCertificateAsKeyDefault (const IdentityCertificate &certificate)
 Add a certificate and set the certificate as the default one of its corresponding key. More...
 
void addCertificateAsSystemDefault (const IdentityCertificate &certificate)
 Add a certificate into the public key identity storage and set the certificate as the default one of the default identity. More...
 
virtual void addIdentity (const Name &identityName)=0
 Add a new identity. More...
 
virtual void addKey (const Name &keyName, const PublicKey &publicKey)=0
 Add a public key to the identity storage. More...
 
void addPublicKey (const Name &keyName, KeyType keyType, const PublicKey &publicKey)
 Add a public key to the identity storage. More...
 
shared_ptr< IdentityCertificatedefaultCertificate ()
 Get cached default certificate of the default identity. More...
 
virtual void deleteCertificateInfo (const Name &certificateName)=0
 Delete a certificate. More...
 
virtual void deleteIdentityInfo (const Name &identity)=0
 Delete an identity and related public keys and certificates. More...
 
virtual void deletePublicKeyInfo (const Name &keyName)=0
 Delete a public key and related certificates. More...
 
virtual bool doesCertificateExist (const Name &certificateName)=0
 Check if the specified certificate already exists. More...
 
virtual bool doesIdentityExist (const Name &identityName)=0
 Check if the specified identity already exists. More...
 
virtual bool doesPublicKeyExist (const Name &keyName)=0
 Check if the specified key already exists. More...
 
virtual void getAllCertificateNames (std::vector< Name > &nameList, bool isDefault)=0
 Get all the certificate name in public info. More...
 
virtual void getAllCertificateNamesOfKey (const Name &keyName, std::vector< Name > &nameList, bool isDefault)=0
 Get all the certificate name of a particular key name. More...
 
virtual void getAllIdentities (std::vector< Name > &nameList, bool isDefault)=0
 Get all the identities from public info. More...
 
virtual void getAllKeyNames (std::vector< Name > &nameList, bool isDefault)=0
 Get all the key names from public info. More...
 
virtual void getAllKeyNamesOfIdentity (const Name &identity, std::vector< Name > &nameList, bool isDefault)=0
 Get all the key names of a particular identity. More...
 
virtual shared_ptr< IdentityCertificategetCertificate (const Name &certificateName)=0
 Get a shared pointer to identity certificate object from the identity storage. More...
 
shared_ptr< IdentityCertificategetDefaultCertificate ()
 Get cached default certificate of the default identity. More...
 
Name getDefaultCertificateName ()
 Get the default certificate name of the default identity. More...
 
Name getDefaultCertificateNameForIdentity (const Name &identityName)
 Get the default certificate name for the specified identity. More...
 
virtual Name getDefaultCertificateNameForKey (const Name &keyName)=0
 Get name of the default certificate name for the specified key. More...
 
virtual Name getDefaultIdentity ()=0
 Get name of the default identity. More...
 
virtual Name getDefaultKeyNameForIdentity (const Name &identityName)=0
 Get name of the default key name for the specified identity. More...
 
Name getNewKeyName (const Name &identityName, bool useKsk)
 Generate a key name for the identity. More...
 
std::string getPibLocator ()
 Get PIB Locator. More...
 
virtual shared_ptr< PublicKeygetPublicKey (const Name &keyName)=0
 Get shared pointer to PublicKey object from the identity storage. More...
 
virtual KeyType getPublicKeyType (const Name &keyName)=0
 Get the type of the queried public key. More...
 
virtual std::string getTpmLocator ()=0
 Get TPM Locator. More...
 
void refreshDefaultCertificate ()
 try to get the default certificate of the default identity from the public info More...
 
virtual bool revokeIdentity ()=0
 Revoke the identity. More...
 
void setDefaultCertificateNameForKey (const Name &certificateName)
 Set the default certificate name for the corresponding key. 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...
 
virtual void setTpmLocator (const std::string &tpmLocator)=0
 Set the corresponding TPM information to tpmLocator. More...
 

Protected Member Functions

virtual std::string getScheme ()=0
 return the scheme of the PibLocator More...
 
virtual void setDefaultCertificateNameForKeyInternal (const Name &certificateName)=0
 Set the default certificate name for the corresponding key. More...
 
virtual void setDefaultIdentityInternal (const Name &identityName)=0
 Set the default identity. More...
 
virtual void setDefaultKeyNameForIdentityInternal (const Name &keyName)=0
 Set the default key name for the corresponding identity. More...
 

Protected Attributes

shared_ptr< IdentityCertificatem_defaultCertificate
 
std::string m_location
 

Detailed Description

SecPublicInfo is a base class for the storage of public information.

It specify interfaces related to public information, such as identity, public keys and certificates.

Definition at line 40 of file v1/sec-public-info.hpp.

Constructor & Destructor Documentation

ndn::security::v1::SecPublicInfo::SecPublicInfo ( const std::string &  location)
explicit

Definition at line 28 of file sec-public-info.cpp.

ndn::security::v1::SecPublicInfo::~SecPublicInfo ( )
virtual

The virtual Destructor.

Definition at line 33 of file sec-public-info.cpp.

Member Function Documentation

virtual void ndn::security::v1::SecPublicInfo::addCertificate ( const IdentityCertificate certificate)
pure virtual

Add a certificate to the identity storage.

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

Parameters
certificateThe certificate to be added

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

void ndn::security::v1::SecPublicInfo::addCertificateAsIdentityDefault ( const IdentityCertificate certificate)

Add a certificate into the public key identity storage and set the certificate as the default one of its corresponding identity.

Parameters
certificateThe certificate to be added
Exceptions
SecPublicInfo::Errorif the certificate cannot be added (though it is really rare)

Definition at line 117 of file sec-public-info.cpp.

void ndn::security::v1::SecPublicInfo::addCertificateAsKeyDefault ( const IdentityCertificate certificate)

Add a certificate and set the certificate as the default one of its corresponding key.

Parameters
certificateThe certificate to be added
Exceptions
SecPublicInfo::Errorif the certificate cannot be added (though it is really rare)

Definition at line 109 of file sec-public-info.cpp.

void ndn::security::v1::SecPublicInfo::addCertificateAsSystemDefault ( const IdentityCertificate certificate)

Add a certificate into the public key identity storage and set the certificate as the default one of the default identity.

Parameters
certificateThe certificate to be added
Exceptions
SecPublicInfo::Errorif the certificate cannot be added (though it is really rare)

Definition at line 128 of file sec-public-info.cpp.

virtual void ndn::security::v1::SecPublicInfo::addIdentity ( const Name identityName)
pure virtual

Add a new identity.

if identity already exist, do not add it again

Parameters
identityNameThe identity name to be added

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual void ndn::security::v1::SecPublicInfo::addKey ( const Name keyName,
const PublicKey publicKey 
)
pure virtual

Add a public key to the identity storage.

Parameters
keyNameThe name of the public key to be added
publicKeyReference to the PublicKey object

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

void ndn::security::v1::SecPublicInfo::addPublicKey ( const Name keyName,
KeyType  keyType,
const PublicKey publicKey 
)

Add a public key to the identity storage.

Parameters
keyNameThe name of the public key to be added
keyTypeType of the public key to be added
publicKeyReference to the PublicKey object
Deprecated:
Use addKey instead

Definition at line 44 of file sec-public-info.cpp.

shared_ptr< IdentityCertificate > ndn::security::v1::SecPublicInfo::defaultCertificate ( )

Get cached default certificate of the default identity.

Returns
The certificate which might be empty shared_ptr<IdentityCertificate>()
Deprecated:
Use getDefaultCertificate instead

Definition at line 140 of file sec-public-info.cpp.

virtual void ndn::security::v1::SecPublicInfo::deleteCertificateInfo ( const Name certificateName)
pure virtual

Delete a certificate.

Parameters
certificateNameThe certificate name

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual void ndn::security::v1::SecPublicInfo::deleteIdentityInfo ( const Name identity)
pure virtual

Delete an identity and related public keys and certificates.

Parameters
identityThe identity name

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual void ndn::security::v1::SecPublicInfo::deletePublicKeyInfo ( const Name keyName)
pure virtual

Delete a public key and related certificates.

Parameters
keyNameThe key name

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual bool ndn::security::v1::SecPublicInfo::doesCertificateExist ( const Name certificateName)
pure virtual

Check if the specified certificate already exists.

Parameters
certificateNameThe name of the certificate

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual bool ndn::security::v1::SecPublicInfo::doesIdentityExist ( const Name identityName)
pure virtual

Check if the specified identity already exists.

Parameters
identityNameThe identity name
Returns
true if the identity exists, otherwise false

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual bool ndn::security::v1::SecPublicInfo::doesPublicKeyExist ( const Name keyName)
pure virtual

Check if the specified key already exists.

Parameters
keyNameThe name of the key
Returns
true if the key exists, otherwise false

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual void ndn::security::v1::SecPublicInfo::getAllCertificateNames ( std::vector< Name > &  nameList,
bool  isDefault 
)
pure virtual

Get all the certificate name in public info.

Parameters
[out]nameListOn return, the certificate name list
isDefaultIf specified, only the default certificates are returned

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual void ndn::security::v1::SecPublicInfo::getAllCertificateNamesOfKey ( const Name keyName,
std::vector< Name > &  nameList,
bool  isDefault 
)
pure virtual

Get all the certificate name of a particular key name.

Parameters
keyNameThe specified key name
[out]nameListOn return, the certificate name list
isDefaultIf specified, only the default certificate is returned

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual void ndn::security::v1::SecPublicInfo::getAllIdentities ( std::vector< Name > &  nameList,
bool  isDefault 
)
pure virtual

Get all the identities from public info.

Parameters
[out]nameListOn return, the identity list
isDefaultIf specified, only the default identity is returned

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual void ndn::security::v1::SecPublicInfo::getAllKeyNames ( std::vector< Name > &  nameList,
bool  isDefault 
)
pure virtual

Get all the key names from public info.

Parameters
[out]nameListOn return, the key name list.
isDefaultIf specified, only the default keys are returned

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual void ndn::security::v1::SecPublicInfo::getAllKeyNamesOfIdentity ( const Name identity,
std::vector< Name > &  nameList,
bool  isDefault 
)
pure virtual

Get all the key names of a particular identity.

Parameters
identityThe specified identity name
[out]nameListOn return, the key name list
isDefaultIf specified, only the default key is returned

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual shared_ptr<IdentityCertificate> ndn::security::v1::SecPublicInfo::getCertificate ( const Name certificateName)
pure virtual

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

Parameters
certificateNameThe name of the requested certificate
Exceptions
SecPublicInfo::Errorif the certificate does not exist

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

shared_ptr< IdentityCertificate > ndn::security::v1::SecPublicInfo::getDefaultCertificate ( )

Get cached default certificate of the default identity.

Returns
The certificate which might be empty shared_ptr<IdentityCertificate>()

Definition at line 146 of file sec-public-info.cpp.

Name ndn::security::v1::SecPublicInfo::getDefaultCertificateName ( )

Get the default certificate name of the default identity.

Returns
The requested certificate name
Exceptions
SecPublicInfo::Errorif no certificate is found

Definition at line 77 of file sec-public-info.cpp.

Name ndn::security::v1::SecPublicInfo::getDefaultCertificateNameForIdentity ( const Name identityName)

Get the default certificate name for the specified identity.

Parameters
identityNameThe identity name
Returns
The default certificate name
Exceptions
SecPublicInfo::Errorif no certificate is found

Definition at line 71 of file sec-public-info.cpp.

virtual Name ndn::security::v1::SecPublicInfo::getDefaultCertificateNameForKey ( const Name keyName)
pure virtual

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

Parameters
keyNameThe key name.
Exceptions
SecPublicInfo::Errorif there is no default.

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual Name ndn::security::v1::SecPublicInfo::getDefaultIdentity ( )
pure virtual

Get name of the default identity.

Exceptions
SecPublicInfo::Errorif there is no default.

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual Name ndn::security::v1::SecPublicInfo::getDefaultKeyNameForIdentity ( const Name identityName)
pure virtual

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

Parameters
identityNameThe identity name
Exceptions
SecPublicInfo::Errorif there is no default

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

Name ndn::security::v1::SecPublicInfo::getNewKeyName ( const Name identityName,
bool  useKsk 
)

Generate a key name for the identity.

Parameters
identityNameThe identity name
useKskIf true, generate a KSK name, otherwise a DSK name
Returns
The generated key name

Definition at line 89 of file sec-public-info.cpp.

std::string ndn::security::v1::SecPublicInfo::getPibLocator ( )

Get PIB Locator.

Definition at line 38 of file sec-public-info.cpp.

virtual shared_ptr<PublicKey> ndn::security::v1::SecPublicInfo::getPublicKey ( const Name keyName)
pure virtual

Get shared pointer to PublicKey object from the identity storage.

Parameters
keyNameThe name of the requested public key
Exceptions
SecPublicInfo::Errorif public key does not exist

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual KeyType ndn::security::v1::SecPublicInfo::getPublicKeyType ( const Name keyName)
pure 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
keyNameThe name of the requested public key
Returns
the type of the key. If the queried key does not exist, KeyType::NONE will be returned

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

virtual std::string ndn::security::v1::SecPublicInfo::getScheme ( )
protectedpure virtual

return the scheme of the PibLocator

virtual std::string ndn::security::v1::SecPublicInfo::getTpmLocator ( )
pure virtual

Get TPM Locator.

Exceptions
SecPublicInfo::Errorif the TPM info does not exist

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

void ndn::security::v1::SecPublicInfo::refreshDefaultCertificate ( )

try to get the default certificate of the default identity from the public info

Definition at line 152 of file sec-public-info.cpp.

virtual bool ndn::security::v1::SecPublicInfo::revokeIdentity ( )
pure virtual

Revoke the identity.

Returns
true if the identity was revoked, otherwise false

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

void ndn::security::v1::SecPublicInfo::setDefaultCertificateNameForKey ( const Name certificateName)

Set the default certificate name for the corresponding key.

Parameters
certificateNameThe certificate name
Exceptions
SecPublicInfo::Errorif either the certificate or key does not exist

Definition at line 64 of file sec-public-info.cpp.

virtual void ndn::security::v1::SecPublicInfo::setDefaultCertificateNameForKeyInternal ( const Name certificateName)
protectedpure virtual

Set the default certificate name for the corresponding key.

Parameters
certificateNameThe certificate name
Exceptions
SecPublicInfo::Errorif the certificate does not exist
void ndn::security::v1::SecPublicInfo::setDefaultIdentity ( const Name identityName)

Set the default identity.

Parameters
identityNameThe default identity name
Exceptions
SecPublicInfo::Errorif the identity does not exist

Definition at line 50 of file sec-public-info.cpp.

virtual void ndn::security::v1::SecPublicInfo::setDefaultIdentityInternal ( const Name identityName)
protectedpure virtual

Set the default identity.

Parameters
identityNameThe default identity name
void ndn::security::v1::SecPublicInfo::setDefaultKeyNameForIdentity ( const Name keyName)

Set the default key name for the corresponding identity.

Parameters
keyNameThe key name
Exceptions
SecPublicInfo::Errorif either the identity or key does not exist

Definition at line 57 of file sec-public-info.cpp.

virtual void ndn::security::v1::SecPublicInfo::setDefaultKeyNameForIdentityInternal ( const Name keyName)
protectedpure virtual

Set the default key name for the corresponding identity.

Parameters
keyNameThe key name
Exceptions
SecPublicInfo::Errorif the key does not exist
virtual void ndn::security::v1::SecPublicInfo::setTpmLocator ( const std::string &  tpmLocator)
pure 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.

Implemented in ndn::security::v1::SecPublicInfoSqlite3.

Member Data Documentation

shared_ptr<IdentityCertificate> ndn::security::v1::SecPublicInfo::m_defaultCertificate
protected

Definition at line 455 of file v1/sec-public-info.hpp.

std::string ndn::security::v1::SecPublicInfo::m_location
protected

Definition at line 456 of file v1/sec-public-info.hpp.