ndn::security::tpm::BackEndFile Class Reference

The back-end implementation of file-based TPM. More...

#include <back-end-file.hpp>

+ Inheritance diagram for ndn::security::tpm::BackEndFile:
+ Collaboration diagram for ndn::security::tpm::BackEndFile:

Classes

class  Error
 

Public Member Functions

 BackEndFile (const std::string &location="")
 Create file-based TPM backend. More...
 
 ~BackEndFile () override
 
unique_ptr< KeyHandlecreateKey (const Name &identity, const KeyParams &params)
 Create key for identity according to params. More...
 
void deleteKey (const Name &keyName)
 Delete a key with name keyName. More...
 
ConstBufferPtr exportKey (const Name &keyName, const char *pw, size_t pwLen)
 
unique_ptr< KeyHandlegetKeyHandle (const Name &keyName) const
 
bool hasKey (const Name &keyName) const
 
void importKey (const Name &keyName, const uint8_t *pkcs8, size_t pkcs8Len, const char *pw, size_t pwLen)
 Import a private key in encrypted PKCS #8 format. More...
 
virtual bool isTerminalMode () const
 Check if TPM is in terminal mode. More...
 
virtual bool isTpmLocked () const
 
virtual void setTerminalMode (bool isTerminal) const
 Set the terminal mode of TPM. More...
 
virtual bool unlockTpm (const char *pw, size_t pwLen) const
 Unlock TPM. More...
 

Static Public Member Functions

static const std::string & getScheme ()
 

Static Protected Member Functions

static void setKeyName (KeyHandle &keyHandle, const Name &identity, const KeyParams &params)
 Set the key name in keyHandle according to identity and params. More...
 

Detailed Description

The back-end implementation of file-based TPM.

In this TPM, each private key is stored in a separate file with permission 0400, i.e., owner read-only. The key is stored in PKCS #1 format in base64 encoding.

Definition at line 41 of file back-end-file.hpp.

Constructor & Destructor Documentation

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

Create file-based TPM backend.

Parameters
locationDirectory to store private keys

Definition at line 79 of file back-end-file.cpp.

ndn::security::tpm::BackEndFile::~BackEndFile ( )
overridedefault

Member Function Documentation

unique_ptr< KeyHandle > ndn::security::tpm::BackEnd::createKey ( const Name identity,
const KeyParams params 
)
inherited

Create key for identity according to params.

The key name is set in the returned KeyHandle.

Returns
The handle of the created key.
Exceptions
Tpm::Errorparams are invalid
Errorthe key cannot be created

Definition at line 51 of file back-end.cpp.

void ndn::security::tpm::BackEnd::deleteKey ( const Name keyName)
inherited

Delete a key with name keyName.

Continuing to use existing KeyHandles on a deleted key results in undefined behavior.

Exceptions
Errorif the deletion fails.

Definition at line 86 of file back-end.cpp.

ConstBufferPtr ndn::security::tpm::BackEnd::exportKey ( const Name keyName,
const char *  pw,
size_t  pwLen 
)
inherited
Returns
A private key with name keyName in encrypted PKCS #8 format using password pw
Exceptions
Errorthe key does not exist
Errorthe key cannot be exported, e.g., insufficient privilege

Definition at line 92 of file back-end.cpp.

unique_ptr< KeyHandle > ndn::security::tpm::BackEnd::getKeyHandle ( const Name keyName) const
inherited
Returns
The handle of a key with name keyName, or nullptr if the key does not exist.

Calling getKeyHandle multiple times with the same keyName will return different KeyHandle objects that all refer to the same key.

Definition at line 45 of file back-end.cpp.

const std::string & ndn::security::tpm::BackEndFile::getScheme ( )
static

Definition at line 87 of file back-end-file.cpp.

bool ndn::security::tpm::BackEnd::hasKey ( const Name keyName) const
inherited
Returns
True if a key with name keyName exists in TPM.

Definition at line 39 of file back-end.cpp.

void ndn::security::tpm::BackEnd::importKey ( const Name keyName,
const uint8_t *  pkcs8,
size_t  pkcs8Len,
const char *  pw,
size_t  pwLen 
)
inherited

Import a private key in encrypted PKCS #8 format.

Parameters
keyNameThe name of imported private key
pkcs8Pointer to the key in encrypted PKCS #8 format
pkcs8LenThe size of the key in encrypted PKCS #8 format
pwThe password to decrypt the private key
pwLenThe length of the password
Exceptions
Errorimport failed

Definition at line 101 of file back-end.cpp.

bool ndn::security::tpm::BackEnd::isTerminalMode ( ) const
virtualinherited

Check if TPM is in terminal mode.

Default implementation always returns true.

Reimplemented in ndn::security::tpm::BackEndOsx.

Definition at line 142 of file back-end.cpp.

bool ndn::security::tpm::BackEnd::isTpmLocked ( ) const
virtualinherited
Returns
True if TPM is locked, otherwise false

Default implementation always returns false.

Reimplemented in ndn::security::tpm::BackEndOsx.

Definition at line 153 of file back-end.cpp.

void ndn::security::tpm::BackEnd::setKeyName ( KeyHandle keyHandle,
const Name identity,
const KeyParams params 
)
staticprotectedinherited

Set the key name in keyHandle according to identity and params.

Definition at line 110 of file back-end.cpp.

void ndn::security::tpm::BackEnd::setTerminalMode ( bool  isTerminal) const
virtualinherited

Set the terminal mode of TPM.

In terminal mode, TPM will not ask user permission from GUI.

Default implementation does nothing.

Reimplemented in ndn::security::tpm::BackEndOsx.

Definition at line 148 of file back-end.cpp.

bool ndn::security::tpm::BackEnd::unlockTpm ( const char *  pw,
size_t  pwLen 
) const
virtualinherited

Unlock TPM.

Parameters
pwThe password to unlock TPM
pwLenThe password size.

Default implementation always returns !isTpmLocked()

Reimplemented in ndn::security::tpm::BackEndOsx.

Definition at line 159 of file back-end.cpp.