#include <sec-tpm-osx.hpp>

Inheritance diagram for ndn::security::v1::SecTpmOsx:

Collaboration diagram for ndn::security::v1::SecTpmOsx:

Data Structures
class	Error

class	Impl

Public Member Functions
	SecTpmOsx (const std::string &location="")

virtual	~SecTpmOsx ()

virtual void	setTpmPassword (const uint8_t *password, size_t passwordLength)
	set password of TPM More...

virtual void	resetTpmPassword ()
	reset password of TPM More...

virtual void	setInTerminal (bool inTerminal)
	Set inTerminal flag to `inTerminal`. More...

virtual bool	getInTerminal () const
	Get value of inTerminal flag. More...

virtual bool	isLocked ()
	Check if TPM is locked. More...

virtual bool	unlockTpm (const char *password, size_t passwordLength, bool usePassword)
	Unlock the TPM. More...

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

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

virtual shared_ptr< v1::PublicKey >	getPublicKeyFromTpm (const Name &keyName)
	Get a public key. More...

virtual Block	signInTpm (const uint8_t *data, size_t dataLength, const Name &keyName, DigestAlgorithm digestAlgorithm)
	Sign data. More...

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

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

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

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

virtual bool	generateRandomBlock (uint8_t *res, size_t size)
	Generate a random block. More...

virtual void	addAppToAcl (const Name &keyName, KeyClass keyClass, const std::string &appPath, AclType acl)
	Add the application into the ACL of a particular key. More...

std::string	getTpmLocator ()

ConstBufferPtr	exportPrivateKeyPkcs5FromTpm (const Name &keyName, const std::string &password)
	Export a private key in PKCS#5 format. More...

bool	importPrivateKeyPkcs5IntoTpm (const Name &keyName, const uint8_t *buffer, size_t bufferSize, const std::string &password)
	Import a private key in PKCS#5 formatted buffer of size `bufferSize`. More...

Static Public Attributes
static const std::string	SCHEME

Protected Member Functions
virtual std::string	getScheme ()

virtual ConstBufferPtr	exportPrivateKeyPkcs8FromTpm (const Name &keyName)
	Export a private key in PKCS#8 format. More...

virtual bool	importPrivateKeyPkcs8IntoTpm (const Name &keyName, const uint8_t *buf, size_t size)
	Import a private key from PKCS#8 formatted buffer of size `bufferSize`. More...

virtual bool	importPublicKeyPkcs1IntoTpm (const Name &keyName, const uint8_t *buf, size_t size)
	Import a public key in PKCS#1 formatted buffer of size `bufferSize`. More...

void	generateKeyPairInTpmInternal (const Name &keyName, const KeyParams &params, bool needRetry)

void	deleteKeyPairInTpmInternal (const Name &keyName, bool needRetry)

ConstBufferPtr	exportPrivateKeyPkcs8FromTpmInternal (const Name &keyName, bool needRetry)

bool	importPrivateKeyPkcs8IntoTpmInternal (const Name &keyName, const uint8_t *buf, size_t size, bool needRetry)

Block	signInTpmInternal (const uint8_t *data, size_t dataLength, const Name &keyName, DigestAlgorithm digestAlgorithm, bool needRetry)

virtual bool	getImpExpPassWord (std::string &password, const std::string &prompt)
	Get import/export password. More...

Protected Attributes
std::string	m_location

Detailed Description

Definition at line 39 of file v1/sec-tpm-osx.hpp.

Constructor & Destructor Documentation

ndn::security::v1::SecTpmOsx::SecTpmOsx ( const std::string & location = "" )

explicit

Definition at line 246 of file sec-tpm-osx.cpp.

ndn::security::v1::SecTpmOsx::~SecTpmOsx ( )

virtual

Definition at line 262 of file sec-tpm-osx.cpp.

Member Function Documentation

void ndn::security::v1::SecTpmOsx::addAppToAcl	(	const Name &	keyName,
		KeyClass	keyClass,
		const std::string &	appPath,
		AclType	acl
	)

virtual

Add the application into the ACL of a particular key.

Parameters

keyName	the name of key
keyClass	the class of key, e.g. Private Key
appPath	the absolute path to the application
acl	the new acl of the key

Implements ndn::security::v1::SecTpm.

Definition at line 915 of file sec-tpm-osx.cpp.

ConstBufferPtr ndn::security::v1::SecTpmOsx::decryptInTpm	(	const uint8_t *	data,
		size_t	dataLength,
		const Name &	keyName,
		bool	isSymmetric
	)

virtual

Decrypt data.

Parameters

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

Returns: The decrypted data.

Exceptions

SecTpm::Error if decryption fails.

Implements ndn::security::v1::SecTpm.

Definition at line 871 of file sec-tpm-osx.cpp.

virtual void ndn::security::v1::SecTpmOsx::deleteKeyPairInTpm ( const Name & keyName )

inlinevirtual

Delete a key pair of asymmetric keys.

Parameters

keyName The name of the key pair.

Implements ndn::security::v1::SecTpm.

Definition at line 84 of file v1/sec-tpm-osx.hpp.

void ndn::security::v1::SecTpmOsx::deleteKeyPairInTpmInternal	(	const Name &	keyName,
		bool	needRetry
	)

protected

Definition at line 442 of file sec-tpm-osx.cpp.

bool ndn::security::v1::SecTpmOsx::doesKeyExistInTpm	(	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. KeyClass::PUBLIC, KeyClass::PRIVATE.

Returns: True if the key exists, otherwise false.

Implements ndn::security::v1::SecTpm.

Definition at line 1001 of file sec-tpm-osx.cpp.

ConstBufferPtr ndn::security::v1::SecTpmOsx::encryptInTpm	(	const uint8_t *	data,
		size_t	dataLength,
		const Name &	keyName,
		bool	isSymmetric
	)

virtual

Encrypt data.

Parameters

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

Returns: The encrypted data.

Exceptions

SecTpm::Error if encryption fails.

Implements ndn::security::v1::SecTpm.

Definition at line 961 of file sec-tpm-osx.cpp.

ConstBufferPtr ndn::security::v1::SecTpm::exportPrivateKeyPkcs5FromTpm	(	const Name &	keyName,
		const std::string &	password
	)

inherited

Export a private key in PKCS#5 format.

Parameters

keyName	The private key name
password	The password to encrypt the private key

Returns: The private key info (in PKCS8 format) if exist

Exceptions

SecTpm::Error if private key cannot be exported

Definition at line 51 of file sec-tpm.cpp.

virtual ConstBufferPtr ndn::security::v1::SecTpmOsx::exportPrivateKeyPkcs8FromTpm ( const Name & keyName )

inlineprotectedvirtual

Export a private key in PKCS#8 format.

Parameters

keyName The private key name.

Returns: The private key info (in PKCS#8 format) if exist, otherwise a NULL pointer.

Implements ndn::security::v1::SecTpm.

Definition at line 123 of file v1/sec-tpm-osx.hpp.

ConstBufferPtr ndn::security::v1::SecTpmOsx::exportPrivateKeyPkcs8FromTpmInternal	(	const Name &	keyName,
		bool	needRetry
	)

protected

Todo:: Can this happen because of keychain is locked?

Definition at line 534 of file sec-tpm-osx.cpp.

virtual void ndn::security::v1::SecTpmOsx::generateKeyPairInTpm	(	const Name &	keyName,
		const KeyParams &	params
	)

inlinevirtual

Generate a pair of asymmetric keys.

Parameters

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

Exceptions

SecTpm::Error if fails.

Implements ndn::security::v1::SecTpm.

Definition at line 78 of file v1/sec-tpm-osx.hpp.

void ndn::security::v1::SecTpmOsx::generateKeyPairInTpmInternal	(	const Name &	keyName,
		const KeyParams &	params,
		bool	needRetry
	)

protected

Definition at line 374 of file sec-tpm-osx.cpp.

bool ndn::security::v1::SecTpmOsx::generateRandomBlock	(	uint8_t *	res,
		size_t	size
	)

virtual

Generate a random block.

Parameters

res	The pointer to the generated block
size	The random block size

Returns: true for success, otherwise false

Implements ndn::security::v1::SecTpm.

Definition at line 1032 of file sec-tpm-osx.cpp.

void ndn::security::v1::SecTpmOsx::generateSymmetricKeyInTpm	(	const Name &	keyName,
		const KeyParams &	params
	)

virtual

Generate a symmetric key.

Parameters

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

Exceptions

SecTpm::Error if key generating fails.

Implements ndn::security::v1::SecTpm.

Definition at line 469 of file sec-tpm-osx.cpp.

bool ndn::security::v1::SecTpm::getImpExpPassWord	(	std::string &	password,
		const std::string &	prompt
	)

protectedvirtualinherited

Get import/export password.

Parameters

password	On return, the password.
prompt	Prompt for password, i.e., "Password for key:"

Returns: true if password has been obtained.

Definition at line 350 of file sec-tpm.cpp.

bool ndn::security::v1::SecTpmOsx::getInTerminal ( ) const

virtual

Get value of inTerminal flag.

Implements ndn::security::v1::SecTpm.

Definition at line 294 of file sec-tpm-osx.cpp.

shared_ptr< PublicKey > ndn::security::v1::SecTpmOsx::getPublicKeyFromTpm ( const Name & keyName )

virtual

Get a public key.

Parameters

keyName The public key name.

Returns: The public key.

Exceptions

SecTpm::Error if public key does not exist in TPM.

Implements ndn::security::v1::SecTpm.

Definition at line 504 of file sec-tpm-osx.cpp.

std::string ndn::security::v1::SecTpmOsx::getScheme ( )

protectedvirtual

Implements ndn::security::v1::SecTpm.

Definition at line 528 of file sec-tpm-osx.cpp.

std::string ndn::security::v1::SecTpm::getTpmLocator ( )

inherited

Definition at line 45 of file sec-tpm.cpp.

bool ndn::security::v1::SecTpm::importPrivateKeyPkcs5IntoTpm	(	const Name &	keyName,
		const uint8_t *	buffer,
		size_t	bufferSize,
		const std::string &	password
	)

inherited

Import a private key in PKCS#5 formatted buffer of size bufferSize.

Also recover the public key and installed it in TPM.

Parameters

keyName	The private key name
buffer	Pointer to the first byte of the buffer containing PKCS#5-encoded private key info
bufferSize	Size of the buffer
password	The password to encrypt the private key

Returns: false if import fails

Definition at line 168 of file sec-tpm.cpp.

virtual bool ndn::security::v1::SecTpmOsx::importPrivateKeyPkcs8IntoTpm	(	const Name &	keyName,
		const uint8_t *	buffer,
		size_t	bufferSize
	)

inlineprotectedvirtual

Import a private key from PKCS#8 formatted buffer of size bufferSize.

Parameters

keyName	The private key name.
buffer	Pointer to the first byte of the buffer containing PKCS#8-encoded private key info
bufferSize	Size of the buffer

Returns: false if import fails

Implements ndn::security::v1::SecTpm.

Definition at line 129 of file v1/sec-tpm-osx.hpp.

bool ndn::security::v1::SecTpmOsx::importPrivateKeyPkcs8IntoTpmInternal	(	const Name &	keyName,
		const uint8_t *	buf,
		size_t	size,
		bool	needRetry
	)

protected

Definition at line 633 of file sec-tpm-osx.cpp.

bool ndn::security::v1::SecTpmOsx::importPublicKeyPkcs1IntoTpm	(	const Name &	keyName,
		const uint8_t *	buffer,
		size_t	bufferSize
	)

protectedvirtual

Import a public key in PKCS#1 formatted buffer of size bufferSize.

Parameters

keyName	The public key name
buffer	Pointer to the first byte of the buffer containing PKCS#1-encoded private key info
bufferSize	Size of the buffer

Returns: false if import fails

Implements ndn::security::v1::SecTpm.

Definition at line 744 of file sec-tpm-osx.cpp.

bool ndn::security::v1::SecTpmOsx::isLocked ( )

virtual

Check if TPM is locked.

Implements ndn::security::v1::SecTpm.

Definition at line 300 of file sec-tpm-osx.cpp.

void ndn::security::v1::SecTpmOsx::resetTpmPassword ( )

virtual

reset password of TPM

Implements ndn::security::v1::SecTpm.

Definition at line 276 of file sec-tpm-osx.cpp.

void ndn::security::v1::SecTpmOsx::setInTerminal ( bool inTerminal )

virtual

Set inTerminal flag to inTerminal.

If the inTerminal flag is set, and password is not set, TPM may ask for password via terminal. inTerminal flag is set by default.

Implements ndn::security::v1::SecTpm.

Definition at line 284 of file sec-tpm-osx.cpp.

void ndn::security::v1::SecTpmOsx::setTpmPassword	(	const uint8_t *	password,
		size_t	passwordLength
	)

virtual

set password of TPM

Password is used to unlock TPM when it is locked. You should be cautious when using this method, because remembering password is kind of dangerous.

Parameters

password	The password
passwordLength	The length of password

Implements ndn::security::v1::SecTpm.

Definition at line 267 of file sec-tpm-osx.cpp.

virtual Block ndn::security::v1::SecTpmOsx::signInTpm	(	const uint8_t *	data,
		size_t	dataLength,
		const Name &	keyName,
		DigestAlgorithm	digestAlgorithm
	)

inlinevirtual

Sign data.

Parameters

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

Returns: The signature block.

Exceptions

SecTpm::Error if signing fails.

Implements ndn::security::v1::SecTpm.

Definition at line 93 of file v1/sec-tpm-osx.hpp.

Block ndn::security::v1::SecTpmOsx::signInTpmInternal	(	const uint8_t *	data,
		size_t	dataLength,
		const Name &	keyName,
		DigestAlgorithm	digestAlgorithm,
		bool	needRetry
	)

protected

Definition at line 791 of file sec-tpm-osx.cpp.

bool ndn::security::v1::SecTpmOsx::unlockTpm	(	const char *	password,
		size_t	passwordLength,
		bool	usePassword
	)

virtual

Unlock the TPM.

Parameters

password	The password.
passwordLength	The password size. 0 indicates no password.
usePassword	True if we want to use the supplied password to unlock the TPM.

Returns: true if TPM is unlocked, otherwise false.

Implements ndn::security::v1::SecTpm.

Definition at line 312 of file sec-tpm-osx.cpp.

Field Documentation

std::string ndn::security::v1::SecTpm::m_location

protectedinherited

Definition at line 302 of file v1/sec-tpm.hpp.

const std::string ndn::security::v1::SecTpmOsx::SCHEME

static

Definition at line 158 of file v1/sec-tpm-osx.hpp.

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

Data Structures

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation