NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::SecPublicInfoSqlite3 Class Reference

#include <sec-public-info-sqlite3.hpp>

Inheritance diagram for ndn::SecPublicInfoSqlite3:
Collaboration diagram for ndn::SecPublicInfoSqlite3:

Classes

class  Error
 

Public Member Functions

 SecPublicInfoSqlite3 (const std::string &dir="")
 
virtual ~SecPublicInfoSqlite3 ()
 
virtual void setTpmLocator (const std::string &tpmLocator)
 Set the corresponding TPM information to tpmLocator. More...
 
virtual std::string getTpmLocator ()
 Get TPM Locator. More...
 
virtual std::string getPibLocator ()
 
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 &publicKeyDer)
 Add a public key to the identity storage. More...
 
virtual shared_ptr< PublicKeygetPublicKey (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< IdentityCertificategetCertificate (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...
 
- Public Member Functions inherited from ndn::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 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 IdentityCertificate &certificate)
 Add a certificate and set the certificate as the default one of its corresponding key. 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 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...
 
 DEPRECATED (shared_ptr< IdentityCertificate > defaultCertificate())
 Get cached default certificate of the default identity. More...
 
shared_ptr< IdentityCertificategetDefaultCertificate ()
 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
 

Additional Inherited Members

- Protected Attributes inherited from ndn::SecPublicInfo
shared_ptr< IdentityCertificatem_defaultCertificate
 
std::string m_location
 

Detailed Description

Definition at line 35 of file sec-public-info-sqlite3.hpp.

Constructor & Destructor Documentation

◆ SecPublicInfoSqlite3()

ndn::SecPublicInfoSqlite3::SecPublicInfoSqlite3 ( const std::string &  dir = "")
explicit

◆ ~SecPublicInfoSqlite3()

ndn::SecPublicInfoSqlite3::~SecPublicInfoSqlite3 ( )
virtual

Definition at line 144 of file sec-public-info-sqlite3.cpp.

Member Function Documentation

◆ setTpmLocator()

void ndn::SecPublicInfoSqlite3::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::SecPublicInfo.

Definition at line 199 of file sec-public-info-sqlite3.cpp.

References getTpmLocator().

◆ getTpmLocator()

string ndn::SecPublicInfoSqlite3::getTpmLocator ( )
virtual

Get TPM Locator.

Exceptions
SecPublicInfo::Errorif the TPM info does not exist

Implements ndn::SecPublicInfo.

Definition at line 217 of file sec-public-info-sqlite3.cpp.

References ndn::sqlite3_column_string().

Referenced by setTpmLocator().

◆ getPibLocator()

std::string ndn::SecPublicInfoSqlite3::getPibLocator ( )
virtual

Definition at line 265 of file sec-public-info-sqlite3.cpp.

References ndn::SecPublicInfo::m_location.

◆ doesIdentityExist()

bool ndn::SecPublicInfoSqlite3::doesIdentityExist ( const Name identityName)
virtual

Check if the specified identity already exists.

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

Implements ndn::SecPublicInfo.

Definition at line 271 of file sec-public-info-sqlite3.cpp.

References ndn::sqlite3_bind_string(), and ndn::Name::toUri().

Referenced by addIdentity().

◆ addIdentity()

void ndn::SecPublicInfoSqlite3::addIdentity ( const Name identityName)
virtual

Add a new identity.

if identity already exist, do not add it again

Parameters
identityNameThe identity name to be added

Implements ndn::SecPublicInfo.

Definition at line 295 of file sec-public-info-sqlite3.cpp.

References doesIdentityExist(), ndn::sqlite3_bind_string(), and ndn::Name::toUri().

Referenced by addKey().

◆ revokeIdentity()

bool ndn::SecPublicInfoSqlite3::revokeIdentity ( )
virtual

Revoke the identity.

Returns
true if the identity was revoked, otherwise false

Implements ndn::SecPublicInfo.

Definition at line 314 of file sec-public-info-sqlite3.cpp.

◆ doesPublicKeyExist()

bool ndn::SecPublicInfoSqlite3::doesPublicKeyExist ( const Name keyName)
virtual

Check if the specified key already exists.

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

Implements ndn::SecPublicInfo.

Definition at line 321 of file sec-public-info-sqlite3.cpp.

References ndn::Name::empty(), ndn::Name::get(), ndn::Name::getPrefix(), ndn::sqlite3_bind_string(), ndn::name::Component::toUri(), and ndn::Name::toUri().

Referenced by addKey().

◆ addKey()

void ndn::SecPublicInfoSqlite3::addKey ( const Name keyName,
const PublicKey publicKey 
)
virtual

Add a public key to the identity storage.

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

Implements ndn::SecPublicInfo.

Definition at line 352 of file sec-public-info-sqlite3.cpp.

References addIdentity(), ndn::Buffer::buf(), doesPublicKeyExist(), ndn::Name::empty(), ndn::PublicKey::get(), ndn::Name::get(), ndn::PublicKey::getKeyType(), ndn::Name::getPrefix(), ndn::sqlite3_bind_string(), ndn::name::Component::toUri(), and ndn::Name::toUri().

Referenced by addCertificate().

◆ getPublicKey()

shared_ptr< PublicKey > ndn::SecPublicInfoSqlite3::getPublicKey ( const Name keyName)
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

Implements ndn::SecPublicInfo.

Definition at line 387 of file sec-public-info-sqlite3.cpp.

References ndn::Name::empty(), ndn::Name::get(), ndn::Name::getPrefix(), ndn::sqlite3_bind_string(), ndn::name::Component::toUri(), and ndn::Name::toUri().

◆ getPublicKeyType()

KeyType ndn::SecPublicInfoSqlite3::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
keyNameThe name of the requested public key
Returns
the type of the key. If the queried key does not exist, KEY_TYPE_NULL will be returned

Implements ndn::SecPublicInfo.

Definition at line 419 of file sec-public-info-sqlite3.cpp.

References ndn::Name::empty(), ndn::Name::get(), ndn::Name::getPrefix(), ndn::KEY_TYPE_NULL, ndn::sqlite3_bind_string(), ndn::name::Component::toUri(), and ndn::Name::toUri().

◆ doesCertificateExist()

bool ndn::SecPublicInfoSqlite3::doesCertificateExist ( const Name certificateName)
virtual

Check if the specified certificate already exists.

Parameters
certificateNameThe name of the certificate

Implements ndn::SecPublicInfo.

Definition at line 449 of file sec-public-info-sqlite3.cpp.

References ndn::sqlite3_bind_string(), and ndn::Name::toUri().

Referenced by addCertificate().

◆ addCertificate()

◆ getCertificate()

shared_ptr< IdentityCertificate > ndn::SecPublicInfoSqlite3::getCertificate ( const Name certificateName)
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

Implements ndn::SecPublicInfo.

Definition at line 528 of file sec-public-info-sqlite3.cpp.

References ndn::sqlite3_bind_string(), and ndn::Name::toUri().

◆ getDefaultIdentity()

Name ndn::SecPublicInfoSqlite3::getDefaultIdentity ( )
virtual

Get name of the default identity.

Exceptions
SecPublicInfo::Errorif there is no default.

Implements ndn::SecPublicInfo.

Definition at line 564 of file sec-public-info-sqlite3.cpp.

References ndn::sqlite3_column_string().

◆ getDefaultKeyNameForIdentity()

Name ndn::SecPublicInfoSqlite3::getDefaultKeyNameForIdentity ( const Name identityName)
virtual

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

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

Implements ndn::SecPublicInfo.

Definition at line 614 of file sec-public-info-sqlite3.cpp.

References ndn::Name::append(), ndn::sqlite3_bind_string(), and ndn::Name::toUri().

◆ getDefaultCertificateNameForKey()

Name ndn::SecPublicInfoSqlite3::getDefaultCertificateNameForKey ( const Name keyName)
virtual

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

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

Implements ndn::SecPublicInfo.

Definition at line 676 of file sec-public-info-sqlite3.cpp.

References ndn::Name::empty(), ndn::Name::get(), ndn::Name::getPrefix(), ndn::sqlite3_bind_string(), ndn::name::Component::toUri(), and ndn::Name::toUri().

◆ getAllIdentities()

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

Get all the identities from public info.

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

Implements ndn::SecPublicInfo.

Definition at line 749 of file sec-public-info-sqlite3.cpp.

References ns3::ndn::Name.

◆ getAllKeyNames()

void ndn::SecPublicInfoSqlite3::getAllKeyNames ( std::vector< Name > &  nameList,
bool  isDefault 
)
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

Implements ndn::SecPublicInfo.

Definition at line 769 of file sec-public-info-sqlite3.cpp.

References ndn::Name::append().

◆ getAllKeyNamesOfIdentity()

void ndn::SecPublicInfoSqlite3::getAllKeyNamesOfIdentity ( const Name identity,
std::vector< Name > &  nameList,
bool  isDefault 
)
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

Implements ndn::SecPublicInfo.

Definition at line 793 of file sec-public-info-sqlite3.cpp.

References ndn::Name::append(), ndn::sqlite3_bind_string(), and ndn::Name::toUri().

◆ getAllCertificateNames()

void ndn::SecPublicInfoSqlite3::getAllCertificateNames ( std::vector< Name > &  nameList,
bool  isDefault 
)
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

Implements ndn::SecPublicInfo.

Definition at line 820 of file sec-public-info-sqlite3.cpp.

◆ getAllCertificateNamesOfKey()

void ndn::SecPublicInfoSqlite3::getAllCertificateNamesOfKey ( const Name keyName,
std::vector< Name > &  nameList,
bool  isDefault 
)
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

Implements ndn::SecPublicInfo.

Definition at line 841 of file sec-public-info-sqlite3.cpp.

References ndn::Name::empty(), ndn::Name::get(), ndn::Name::getPrefix(), ndn::sqlite3_bind_string(), ndn::name::Component::toUri(), and ndn::Name::toUri().

◆ deleteCertificateInfo()

void ndn::SecPublicInfoSqlite3::deleteCertificateInfo ( const Name certificateName)
virtual

Delete a certificate.

Parameters
certificateNameThe certificate name

Implements ndn::SecPublicInfo.

Definition at line 874 of file sec-public-info-sqlite3.cpp.

References ndn::Name::empty(), ndn::sqlite3_bind_string(), and ndn::Name::toUri().

◆ deletePublicKeyInfo()

void ndn::SecPublicInfoSqlite3::deletePublicKeyInfo ( const Name keyName)
virtual

Delete a public key and related certificates.

Parameters
keyNameThe key name

Implements ndn::SecPublicInfo.

Definition at line 887 of file sec-public-info-sqlite3.cpp.

References ndn::Name::empty(), ndn::Name::get(), ndn::Name::getPrefix(), ndn::sqlite3_bind_string(), ndn::name::Component::toUri(), and ndn::Name::toUri().

◆ deleteIdentityInfo()

void ndn::SecPublicInfoSqlite3::deleteIdentityInfo ( const Name identity)
virtual

Delete an identity and related public keys and certificates.

Parameters
identityThe identity name

Implements ndn::SecPublicInfo.

Definition at line 914 of file sec-public-info-sqlite3.cpp.

References ndn::sqlite3_bind_string(), and ndn::Name::toUri().

Member Data Documentation

◆ SCHEME

const std::string ndn::SecPublicInfoSqlite3::SCHEME
static

Definition at line 159 of file sec-public-info-sqlite3.hpp.


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