Pib backend implementation based on SQLite3 database. More...

#include <pib-sqlite3.hpp>

Inheritance diagram for ndn::security::pib::PibSqlite3:

Collaboration diagram for ndn::security::pib::PibSqlite3:

Public Member Functions
	PibSqlite3 (const std::string &location="")
	Create sqlite3-based PIB backed. More...

	~PibSqlite3 ()
	Destruct and cleanup internal state. More...

void	addCertificate (const v2::Certificate &certificate) final
	Add a certificate. More...

void	addIdentity (const Name &identity) final
	Add an identity. More...

void	addKey (const Name &identity, const Name &keyName, const uint8_t *key, size_t keyLen) final
	Add a key. More...

void	clearIdentities () final
	Erasing all certificates, keys, and identities. More...

v2::Certificate	getCertificate (const Name &certName) const final
	Get a certificate with name `certName`. More...

std::set< Name >	getCertificatesOfKey (const Name &keyName) const final
	Get a list of certificate names of a key with id `keyName`. More...

v2::Certificate	getDefaultCertificateOfKey (const Name &keyName) const final

Name	getDefaultIdentity () const final
	Get the default identity. More...

Name	getDefaultKeyOfIdentity (const Name &identity) const final

std::set< Name >	getIdentities () const final
	Get the name of all the identities. More...

Buffer	getKeyBits (const Name &keyName) const final
	Get the key bits of a key with name `keyName`. More...

std::set< Name >	getKeysOfIdentity (const Name &identity) const final
	Get all the key names of an identity with name `identity`. More...

std::string	getTpmLocator () const final
	Get TPM Locator. More...

bool	hasCertificate (const Name &certName) const final
	Check the existence of a certificate with name `certName`. More...

bool	hasIdentity (const Name &identity) const final
	Check the existence of an identity. More...

bool	hasKey (const Name &keyName) const final
	Check the existence of a key with `keyName`. More...

void	removeCertificate (const Name &certName) final
	Remove a certificate with name `certName`. More...

void	removeIdentity (const Name &identity) final
	Remove an identity and related keys and certificates. More...

void	removeKey (const Name &keyName) final
	Remove a key with `keyName` and related certificates. More...

void	setDefaultCertificateOfKey (const Name &keyName, const Name &certName) final
	Set a cert with name `certName` as the default of a key with `keyName`. More...

void	setDefaultIdentity (const Name &identityName) final
	Set an identity with name `identityName` as the default identity. More...

void	setDefaultKeyOfIdentity (const Name &identity, const Name &keyName) final
	Set an key with `keyName` as the default key of an identity with name `identity`. More...

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

Static Public Member Functions
static const std::string &	getScheme ()

Detailed Description

Pib backend implementation based on SQLite3 database.

All the contents in Pib are stored in a SQLite3 database file. This backend provides more persistent storage than PibMemory.

Definition at line 39 of file pib-sqlite3.hpp.

Constructor & Destructor Documentation

ndn::security::pib::PibSqlite3::PibSqlite3 ( const std::string & location = "" )

explicit

Create sqlite3-based PIB backed.

This method will create a SQLite3 database file under the directory location. If the directory does not exist, it will be created automatically. It assumes that the directory does not contain a PIB database of an older version, It is user's responsibility to update the older version database or remove the database.

Parameters

location The directory where the database file is located. By default, it points to the $HOME/.ndn directory.

Exceptions

PibImpl::Error when initialization fails.

Definition at line 194 of file pib-sqlite3.cpp.

ndn::security::pib::PibSqlite3::~PibSqlite3 ( )

Destruct and cleanup internal state.

Definition at line 240 of file pib-sqlite3.cpp.

Member Function Documentation

void ndn::security::pib::PibSqlite3::addCertificate ( const v2::Certificate & certificate )

finalvirtual

Add a certificate.

If a certificate with the same name (without implicit digest) already exists, overwrite the certificate. If the key or identity does not exist, they will be created. If no default certificate of the key has been set, set the added one as default certificate of the key. If no default key was set for the identity, it will be set as default key for the identity. If no default identity was selected, the certificate's identity becomes default.

Parameters

certificate The certificate to add.

identity	The name of the belonged identity.
keyName	The key name.
key	The public key bits.
keyLen	The length of the public key.

ndn-cxx: NDN C++ library with eXperimental eXtensions 0.6.0 documentation

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation