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

#include <sec-tpm-file.hpp>

Inheritance diagram for ndn::SecTpmFile:
Collaboration diagram for ndn::SecTpmFile:

Classes

class  Error
 
class  Impl
 

Public Member Functions

 SecTpmFile (const std::string &dir="")
 
virtual ~SecTpmFile ()
 
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. 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< 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::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. 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. More...
 
virtual bool importPublicKeyPkcs1IntoTpm (const Name &keyName, const uint8_t *buf, size_t size)
 Import a public key in PKCS#1 formatted. More...
 
- Protected Member Functions inherited from ndn::SecTpm
virtual bool getImpExpPassWord (std::string &password, const std::string &prompt)
 Get import/export password. More...
 

Additional Inherited Members

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

Detailed Description

Definition at line 35 of file sec-tpm-file.hpp.

Constructor & Destructor Documentation

◆ SecTpmFile()

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

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

◆ ~SecTpmFile()

ndn::SecTpmFile::~SecTpmFile ( )
virtual

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

Member Function Documentation

◆ setTpmPassword()

virtual void ndn::SecTpmFile::setTpmPassword ( const uint8_t *  password,
size_t  passwordLength 
)
inlinevirtual

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::SecTpm.

Definition at line 55 of file sec-tpm-file.hpp.

◆ resetTpmPassword()

virtual void ndn::SecTpmFile::resetTpmPassword ( )
inlinevirtual

reset password of TPM

Implements ndn::SecTpm.

Definition at line 60 of file sec-tpm-file.hpp.

◆ setInTerminal()

virtual void ndn::SecTpmFile::setInTerminal ( bool  inTerminal)
inlinevirtual

Set inTerminal flag to.

Parameters
inTerminalIf 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::SecTpm.

Definition at line 65 of file sec-tpm-file.hpp.

◆ getInTerminal()

virtual bool ndn::SecTpmFile::getInTerminal ( ) const
inlinevirtual

Get value of inTerminal flag.

Implements ndn::SecTpm.

Definition at line 71 of file sec-tpm-file.hpp.

◆ isLocked()

virtual bool ndn::SecTpmFile::isLocked ( )
inlinevirtual

Check if TPM is locked.

Implements ndn::SecTpm.

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

Referenced by unlockTpm().

◆ unlockTpm()

virtual bool ndn::SecTpmFile::unlockTpm ( const char *  password,
size_t  passwordLength,
bool  usePassword 
)
inlinevirtual

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::SecTpm.

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

References isLocked().

◆ generateKeyPairInTpm()

void ndn::SecTpmFile::generateKeyPairInTpm ( const Name keyName,
const KeyParams params 
)
virtual

Generate a pair of asymmetric keys.

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

Implements ndn::SecTpm.

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

References doesKeyExistInTpm(), ndn::SimplePublicKeyParams< KeyParamsInfo >::getKeySize(), ndn::KeyParams::getKeyType(), ndn::KEY_CLASS_PRIVATE, ndn::KEY_CLASS_PUBLIC, ndn::KEY_TYPE_ECDSA, ndn::KEY_TYPE_RSA, and ndn::Name::toUri().

◆ deleteKeyPairInTpm()

void ndn::SecTpmFile::deleteKeyPairInTpm ( const Name keyName)
virtual

Delete a key pair of asymmetric keys.

Parameters
keyNameThe name of the key pair.

Implements ndn::SecTpm.

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

References ndn::Name::toUri().

◆ getPublicKeyFromTpm()

shared_ptr< PublicKey > ndn::SecTpmFile::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::SecTpm.

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

References doesKeyExistInTpm(), ndn::KEY_CLASS_PUBLIC, and ndn::Name::toUri().

Referenced by signInTpm().

◆ signInTpm()

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

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::SecTpm.

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

References ndn::OBufferStream::buf(), ndn::DIGEST_ALGORITHM_SHA256, doesKeyExistInTpm(), ndn::security::file, getPublicKeyFromTpm(), ndn::KEY_CLASS_PRIVATE, ndn::KEY_TYPE_ECDSA, ndn::KEY_TYPE_RSA, ndn::tlv::SignatureValue, and ndn::Name::toUri().

◆ decryptInTpm()

ConstBufferPtr ndn::SecTpmFile::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::SecTpm.

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

◆ encryptInTpm()

ConstBufferPtr ndn::SecTpmFile::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::SecTpm.

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

◆ generateSymmetricKeyInTpm()

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

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

◆ doesKeyExistInTpm()

bool ndn::SecTpmFile::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. KEY_CLASS_PUBLIC, KEY_CLASS_PRIVATE.
Returns
True if the key exists, otherwise false.

Implements ndn::SecTpm.

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

References ndn::KEY_CLASS_PRIVATE, ndn::KEY_CLASS_PUBLIC, ndn::KEY_CLASS_SYMMETRIC, and ndn::Name::toUri().

Referenced by generateKeyPairInTpm(), getPublicKeyFromTpm(), and signInTpm().

◆ generateRandomBlock()

bool ndn::SecTpmFile::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::SecTpm.

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

◆ addAppToAcl()

virtual void ndn::SecTpmFile::addAppToAcl ( const Name keyName,
KeyClass  keyClass,
const std::string &  appPath,
AclType  acl 
)
inlinevirtual

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::SecTpm.

Definition at line 117 of file sec-tpm-file.hpp.

◆ getScheme()

std::string ndn::SecTpmFile::getScheme ( )
protectedvirtual

Implements ndn::SecTpm.

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

References SCHEME.

◆ exportPrivateKeyPkcs8FromTpm()

ConstBufferPtr ndn::SecTpmFile::exportPrivateKeyPkcs8FromTpm ( const Name keyName)
protectedvirtual

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::SecTpm.

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

References ndn::OBufferStream::buf(), and ndn::Name::toUri().

◆ importPrivateKeyPkcs8IntoTpm()

bool ndn::SecTpmFile::importPrivateKeyPkcs8IntoTpm ( const Name keyName,
const uint8_t *  buffer,
size_t  bufferSize 
)
protectedvirtual

Import a private key from PKCS#8 formatted.

Parameters
bufferof size
bufferSize
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::SecTpm.

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

References ndn::Name::toUri().

◆ importPublicKeyPkcs1IntoTpm()

bool ndn::SecTpmFile::importPublicKeyPkcs1IntoTpm ( const Name keyName,
const uint8_t *  buffer,
size_t  bufferSize 
)
protectedvirtual

Import a public key in PKCS#1 formatted.

Parameters
bufferof size
bufferSize
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::SecTpm.

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

References ndn::Name::toUri().

Member Data Documentation

◆ SCHEME

const std::string ndn::SecTpmFile::SCHEME
static

Definition at line 138 of file sec-tpm-file.hpp.

Referenced by getScheme().


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