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

#include <sec-tpm-osx.hpp>

Inheritance diagram for ndn::security::SecTpmOsx:
Collaboration diagram for ndn::security::SecTpmOsx:

Classes

class  Error
 

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::PublicKeygetPublicKeyFromTpm (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...
 
- Public Member Functions inherited from ndn::security::SecTpm
 SecTpm (const std::string &location)
 
virtual ~SecTpm ()
 
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)
 
- Protected Member Functions inherited from ndn::security::SecTpm
virtual bool getImpExpPassWord (std::string &password, const std::string &prompt)
 Get import/export password. More...
 

Additional Inherited Members

- Protected Attributes inherited from ndn::security::SecTpm
std::string m_location
 

Detailed Description

Definition at line 38 of file sec-tpm-osx.hpp.

Constructor & Destructor Documentation

◆ SecTpmOsx()

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

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

Referenced by ndn::security::SecTpmOsx::Error::Error().

◆ ~SecTpmOsx()

ndn::security::SecTpmOsx::~SecTpmOsx ( )
virtual

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

Referenced by ndn::security::SecTpmOsx::Error::Error().

Member Function Documentation

◆ setTpmPassword()

void ndn::security::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
passwordThe password
passwordLengthThe length of password

Implements ndn::security::SecTpm.

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

Referenced by ndn::security::SecTpmOsx::Error::Error().

◆ resetTpmPassword()

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

reset password of TPM

Implements ndn::security::SecTpm.

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

Referenced by ndn::security::SecTpmOsx::Error::Error().

◆ setInTerminal()

void ndn::security::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::SecTpm.

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

Referenced by ndn::security::SecTpmOsx::Error::Error().

◆ getInTerminal()

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

Get value of inTerminal flag.

Implements ndn::security::SecTpm.

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

Referenced by ndn::security::SecTpmOsx::Error::Error().

◆ isLocked()

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

Check if TPM is locked.

Implements ndn::security::SecTpm.

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

Referenced by ndn::security::SecTpmOsx::Error::Error(), and unlockTpm().

◆ unlockTpm()

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

Unlock the TPM.

Parameters
passwordThe password.
passwordLengthThe password size. 0 indicates no password.
usePasswordTrue if we want to use the supplied password to unlock the TPM.
Returns
true if TPM is unlocked, otherwise false.

Implements ndn::security::SecTpm.

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

References isLocked().

Referenced by deleteKeyPairInTpmInternal(), ndn::security::SecTpmOsx::Error::Error(), exportPrivateKeyPkcs8FromTpmInternal(), generateKeyPairInTpmInternal(), importPrivateKeyPkcs8IntoTpmInternal(), and signInTpmInternal().

◆ generateKeyPairInTpm()

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

Generate a pair of asymmetric keys.

Parameters
keyNameThe name of the key pair.
paramsThe parameters of key.
Exceptions
SecTpm::Errorif fails.

Implements ndn::security::SecTpm.

Definition at line 77 of file sec-tpm-osx.hpp.

References generateKeyPairInTpmInternal().

◆ deleteKeyPairInTpm()

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

Delete a key pair of asymmetric keys.

Parameters
keyNameThe name of the key pair.

Implements ndn::security::SecTpm.

Definition at line 83 of file sec-tpm-osx.hpp.

References deleteKeyPairInTpmInternal(), and getPublicKeyFromTpm().

◆ getPublicKeyFromTpm()

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

Get a public key.

Parameters
keyNameThe public key name.
Returns
The public key.
Exceptions
SecTpm::Errorif public key does not exist in TPM.

Implements ndn::security::SecTpm.

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

References ndn::security::CFReleaser< T >::get(), ndn::PUBLIC, and ndn::Name::toUri().

Referenced by deleteKeyPairInTpm(), and exportPrivateKeyPkcs8FromTpmInternal().

◆ signInTpm()

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

Sign data.

Parameters
dataPointer to the byte array to be signed.
dataLengthThe length of data.
keyNameThe name of the signing key.
digestAlgorithmthe digest algorithm.
Returns
The signature block.
Exceptions
SecTpm::Errorif signing fails.

Implements ndn::security::SecTpm.

Definition at line 92 of file sec-tpm-osx.hpp.

References addAppToAcl(), decryptInTpm(), doesKeyExistInTpm(), encryptInTpm(), generateRandomBlock(), generateSymmetricKeyInTpm(), getScheme(), and signInTpmInternal().

◆ decryptInTpm()

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

Decrypt data.

Parameters
dataPointer to the byte arry to be decrypted.
dataLengthThe length of data.
keyNameThe name of the decrypting key.
isSymmetricIf true symmetric encryption is used, otherwise asymmetric encryption.
Returns
The decrypted data.
Exceptions
SecTpm::Errorif decryption fails.

Implements ndn::security::SecTpm.

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

Referenced by signInTpm().

◆ encryptInTpm()

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

Encrypt data.

Parameters
dataPointer to the byte arry to be decrypted.
dataLengthThe length of data.
keyNameThe name of the encrypting key.
isSymmetricIf true symmetric encryption is used, otherwise asymmetric encryption.
Returns
The encrypted data.
Exceptions
SecTpm::Errorif encryption fails.

Implements ndn::security::SecTpm.

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

Referenced by signInTpm().

◆ generateSymmetricKeyInTpm()

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

Generate a symmetric key.

Parameters
keyNameThe name of the key.
paramsThe parameter of the key.
Exceptions
SecTpm::Errorif key generating fails.

Implements ndn::security::SecTpm.

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

Referenced by signInTpm().

◆ doesKeyExistInTpm()

bool ndn::security::SecTpmOsx::doesKeyExistInTpm ( const Name keyName,
KeyClass  keyClass 
)
virtual

Check if a particular key exists.

Parameters
keyNameThe name of the key.
keyClassThe class of the key, e.g. KeyClass::PUBLIC, KeyClass::PRIVATE.
Returns
True if the key exists, otherwise false.

Implements ndn::security::SecTpm.

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

References ndn::security::CFReleaser< T >::get().

Referenced by generateKeyPairInTpmInternal(), and signInTpm().

◆ generateRandomBlock()

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

Generate a random block.

Parameters
resThe pointer to the generated block
sizeThe random block size
Returns
true for success, otherwise false

Implements ndn::security::SecTpm.

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

Referenced by signInTpm().

◆ addAppToAcl()

void ndn::security::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
keyNamethe name of key
keyClassthe class of key, e.g. Private Key
appPaththe absolute path to the application
aclthe new acl of the key

Implements ndn::security::SecTpm.

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

References ndn::security::CFReleaser< T >::get(), ndn::PRIVATE, and ndn::Name::toUri().

Referenced by signInTpm().

◆ getScheme()

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

Implements ndn::security::SecTpm.

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

References SCHEME.

Referenced by signInTpm().

◆ exportPrivateKeyPkcs8FromTpm()

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

Export a private key in PKCS#8 format.

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

Implements ndn::security::SecTpm.

Definition at line 122 of file sec-tpm-osx.hpp.

References exportPrivateKeyPkcs8FromTpmInternal().

◆ importPrivateKeyPkcs8IntoTpm()

virtual bool ndn::security::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
keyNameThe private key name.
bufferPointer to the first byte of the buffer containing PKCS#8-encoded private key info
bufferSizeSize of the buffer
Returns
false if import fails

Implements ndn::security::SecTpm.

Definition at line 128 of file sec-tpm-osx.hpp.

References deleteKeyPairInTpmInternal(), exportPrivateKeyPkcs8FromTpmInternal(), generateKeyPairInTpmInternal(), importPrivateKeyPkcs8IntoTpmInternal(), importPublicKeyPkcs1IntoTpm(), and signInTpmInternal().

◆ importPublicKeyPkcs1IntoTpm()

bool ndn::security::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
keyNameThe public key name
bufferPointer to the first byte of the buffer containing PKCS#1-encoded private key info
bufferSizeSize of the buffer
Returns
false if import fails

Implements ndn::security::SecTpm.

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

References ndn::security::CFReleaser< T >::get(), and ndn::Name::toUri().

Referenced by importPrivateKeyPkcs8IntoTpm().

◆ generateKeyPairInTpmInternal()

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

◆ deleteKeyPairInTpmInternal()

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

◆ exportPrivateKeyPkcs8FromTpmInternal()

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

◆ importPrivateKeyPkcs8IntoTpmInternal()

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

◆ signInTpmInternal()

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

Member Data Documentation

◆ SCHEME

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

Definition at line 157 of file sec-tpm-osx.hpp.

Referenced by getScheme().


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