MemoryPrivateKeyStorage extends PrivateKeyStorage to implement a simple in-memory private key store. More...

#include <memory-private-key-storage.hpp>

Inheritance diagram for ndn::MemoryPrivateKeyStorage:

Public Member Functions
virtual	~MemoryPrivateKeyStorage ()
	The virtual destructor.

void	setPublicKeyForKeyName (const Name &keyName, KeyType keyType, const uint8_t *publicKeyDer, size_t publicKeyDerLength)
	Set the public key for the keyName. More...

void DEPRECATED_IN_NDN_CPP	setPublicKeyForKeyName (const Name &keyName, const uint8_t *publicKeyDer, size_t publicKeyDerLength)

void	setPrivateKeyForKeyName (const Name &keyName, KeyType keyType, const uint8_t *privateKeyDer, size_t privateKeyDerLength)
	Set the private key for the keyName. More...

void DEPRECATED_IN_NDN_CPP	setPrivateKeyForKeyName (const Name &keyName, const uint8_t *privateKeyDer, size_t privateKeyDerLength)

void	setKeyPairForKeyName (const Name &keyName, KeyType keyType, const uint8_t publicKeyDer, size_t publicKeyDerLength, const uint8_t privateKeyDer, size_t privateKeyDerLength)
	Set the public and private key for the keyName. More...

void DEPRECATED_IN_NDN_CPP	setKeyPairForKeyName (const Name &keyName, const uint8_t publicKeyDer, size_t publicKeyDerLength, const uint8_t privateKeyDer, size_t privateKeyDerLength)

virtual void	generateKeyPair (const Name &keyName, const KeyParams &params)
	Generate a pair of asymmetric keys. More...

virtual void	deleteKeyPair (const Name &keyName)
	Delete a pair of asymmetric keys. More...

virtual ptr_lib::shared_ptr < PublicKey >	getPublicKey (const Name &keyName)
	Get the public key. More...

virtual Blob	sign (const uint8_t *data, size_t dataLength, const Name &keyName, DigestAlgorithm digestAlgorithm)
	Fetch the private key for keyName and sign the data, returning a signature Blob. More...

virtual Blob	decrypt (const Name &keyName, const uint8_t *data, size_t dataLength, bool isSymmetric)
	Decrypt data. More...

virtual Blob	encrypt (const Name &keyName, const uint8_t *data, size_t dataLength, bool isSymmetric)
	Encrypt data. More...

virtual void	generateKey (const Name &keyName, const KeyParams &params)
	Generate a symmetric key. More...

virtual bool	doesKeyExist (const Name &keyName, KeyClass keyClass)
	Check if a particular key exists. More...

Public Member Functions inherited from ndn::PrivateKeyStorage
virtual	~PrivateKeyStorage ()
	The virtual destructor.

Blob	sign (const Blob &data, const Name &keyName, DigestAlgorithm digestAlgorithm=DIGEST_ALGORITHM_SHA256)

Blob	decrypt (const Name &keyName, const Blob &data, bool isSymmetric=false)

Blob	encrypt (const Name &keyName, const Blob &data, bool isSymmetric=false)

Detailed Description

MemoryPrivateKeyStorage extends PrivateKeyStorage to implement a simple in-memory private key store.

You should initialize by calling setKeyPairForKeyName.

Member Function Documentation

Blob ndn::MemoryPrivateKeyStorage::decrypt	(	const Name &	keyName,
		const uint8_t *	data,
		size_t	dataLength,
		bool	isSymmetric
	)

virtual

Decrypt data.

Parameters

keyName	The name of the decrypting key.
data	The byte to be decrypted.
dataLength	the length of data.
isSymmetric	If true symmetric encryption is used, otherwise asymmetric decryption is used.

Returns: The decrypted data.

Implements ndn::PrivateKeyStorage.

void ndn::MemoryPrivateKeyStorage::deleteKeyPair ( const Name & keyName )

virtual

Delete a pair of asymmetric keys.

If the key doesn't exist, do nothing.

Parameters

keyName The name of the key pair.

Implements ndn::PrivateKeyStorage.

bool ndn::MemoryPrivateKeyStorage::doesKeyExist	(	const Name &	keyName,
		KeyClass	keyClass
	)

virtual

Check if a particular key exists.

Parameters

keyName	The name of the key.
keyClass	The class of the key, e.g. KEY_CLASS_PUBLIC, KEY_CLASS_PRIVATE, or KEY_CLASS_SYMMETRIC.

Returns: True if the key exists, otherwise false.

Implements ndn::PrivateKeyStorage.

Blob ndn::MemoryPrivateKeyStorage::encrypt	(	const Name &	keyName,
		const uint8_t *	data,
		size_t	dataLength,
		bool	isSymmetric
	)

virtual

Encrypt data.

Parameters

keyName	The name of the encrypting key.
data	The byte to be encrypted.
dataLength	the length of data.
isSymmetric	If true symmetric encryption is used, otherwise asymmetric decryption is used.

Returns: The encrypted data.

Implements ndn::PrivateKeyStorage.

void ndn::MemoryPrivateKeyStorage::generateKey	(	const Name &	keyName,
		const KeyParams &	params
	)

virtual

Generate a symmetric key.

Parameters

keyName	The name of the key.
params	The parameters of the key.

Implements ndn::PrivateKeyStorage.

void ndn::MemoryPrivateKeyStorage::generateKeyPair	(	const Name &	keyName,
		const KeyParams &	params
	)

virtual

Generate a pair of asymmetric keys.

Parameters

keyName	The name of the key pair.
params	The parameters of the key.

Implements ndn::PrivateKeyStorage.

ptr_lib::shared_ptr< PublicKey > ndn::MemoryPrivateKeyStorage::getPublicKey ( const Name & keyName )

virtual

Get the public key.

Parameters

keyName The name of public key.

Returns: The public key.

Implements ndn::PrivateKeyStorage.

void ndn::MemoryPrivateKeyStorage::setKeyPairForKeyName	(	const Name &	keyName,
		KeyType	keyType,
		const uint8_t *	publicKeyDer,
		size_t	publicKeyDerLength,
		const uint8_t *	privateKeyDer,
		size_t	privateKeyDerLength
	)

inline

Set the public and private key for the keyName.

Parameters

keyName	The key name.
keyType	The KeyType, such as KEY_TYPE_RSA.
publicKeyDer	The public key DER byte array.
publicKeyDerLength	The length of publicKeyDer.
privateKeyDer	The private key DER byte array.
privateKeyDerLength	The length of privateKeyDer.

void DEPRECATED_IN_NDN_CPP ndn::MemoryPrivateKeyStorage::setKeyPairForKeyName	(	const Name &	keyName,
		const uint8_t *	publicKeyDer,
		size_t	publicKeyDerLength,
		const uint8_t *	privateKeyDer,
		size_t	privateKeyDerLength
	)

inline

Deprecated:: Use setKeyPairForKeyName(keyName, KEY_TYPE_RSA, publicKeyDer, publicKeyDerLength, privateKeyDer, privateKeyDerLength).

void ndn::MemoryPrivateKeyStorage::setPrivateKeyForKeyName	(	const Name &	keyName,
		KeyType	keyType,
		const uint8_t *	privateKeyDer,
		size_t	privateKeyDerLength
	)

Set the private key for the keyName.

Parameters

keyName	The key name.
keyType	The KeyType, such as KEY_TYPE_RSA.
privateKeyDer	The private key DER byte array.
privateKeyDerLength	The length of privateKeyDer.

void DEPRECATED_IN_NDN_CPP ndn::MemoryPrivateKeyStorage::setPrivateKeyForKeyName	(	const Name &	keyName,
		const uint8_t *	privateKeyDer,
		size_t	privateKeyDerLength
	)

inline

Deprecated:: Use setPrivateKeyForKeyName(keyName, KEY_TYPE_RSA, privateKeyDer, privateKeyDerLength).

void ndn::MemoryPrivateKeyStorage::setPublicKeyForKeyName	(	const Name &	keyName,
		KeyType	keyType,
		const uint8_t *	publicKeyDer,
		size_t	publicKeyDerLength
	)

Set the public key for the keyName.

Parameters

keyName	The key name.
keyType	The KeyType, such as KEY_TYPE_RSA.
publicKeyDer	The public key DER byte array.
publicKeyDerLength	The length of publicKeyDer.

void DEPRECATED_IN_NDN_CPP ndn::MemoryPrivateKeyStorage::setPublicKeyForKeyName	(	const Name &	keyName,
		const uint8_t *	publicKeyDer,
		size_t	publicKeyDerLength
	)

inline

Deprecated:: Use setPublicKeyForKeyName(keyName, KEY_TYPE_RSA, publicKeyDer, publicKeyDerLength).

Blob ndn::MemoryPrivateKeyStorage::sign	(	const uint8_t *	data,
		size_t	dataLength,
		const Name &	keyName,
		DigestAlgorithm	digestAlgorithm
	)

virtual

Fetch the private key for keyName and sign the data, returning a signature Blob.

Parameters

data	Pointer to the input byte array.
dataLength	The length of data.
keyName	The name of the signing key.
digestAlgorithm	the digest algorithm.

Returns: The signature Blob.

Implements ndn::PrivateKeyStorage.

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

include/ndn-cpp/security/identity/memory-private-key-storage.hpp
src/security/identity/memory-private-key-storage.cpp

Public Member Functions

Detailed Description

Member Function Documentation