NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
tpm.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
25 
26 namespace ndn {
27 namespace security {
28 namespace tpm {
29 
30 Tpm::Tpm(const std::string& scheme, const std::string& location, unique_ptr<BackEnd> backEnd)
31  : m_scheme(scheme)
32  , m_location(location)
33  , m_backEnd(std::move(backEnd))
34 {
35 }
36 
37 Tpm::~Tpm() = default;
38 
39 std::string
41 {
42  return m_scheme + ":" + m_location;
43 }
44 
45 bool
46 Tpm::hasKey(const Name& keyName) const
47 {
48  return m_backEnd->hasKey(keyName);
49 }
50 
51 Name
52 Tpm::createKey(const Name& identityName, const KeyParams& params)
53 {
54  switch (params.getKeyType()) {
55  case KeyType::RSA:
56  case KeyType::EC: {
57  unique_ptr<KeyHandle> keyHandle = m_backEnd->createKey(identityName, params);
58  Name keyName = keyHandle->getKeyName();
59  m_keys[keyName] = std::move(keyHandle);
60  return keyName;
61  }
62  default: {
63  BOOST_THROW_EXCEPTION(Error("Fail to create a key pair: Unsupported key type"));
64  }
65  }
66 }
67 
68 void
69 Tpm::deleteKey(const Name& keyName)
70 {
71  auto it = m_keys.find(keyName);
72  if (it != m_keys.end())
73  m_keys.erase(it);
74 
75  m_backEnd->deleteKey(keyName);
76 }
77 
79 Tpm::getPublicKey(const Name& keyName) const
80 {
81  const KeyHandle* key = findKey(keyName);
82 
83  if (key == nullptr)
84  return nullptr;
85  else
86  return key->derivePublicKey();
87 }
88 
90 Tpm::sign(const uint8_t* buf, size_t size, const Name& keyName, DigestAlgorithm digestAlgorithm) const
91 {
92  const KeyHandle* key = findKey(keyName);
93 
94  if (key == nullptr)
95  return nullptr;
96  else
97  return key->sign(digestAlgorithm, buf, size);
98 }
99 
101 Tpm::decrypt(const uint8_t* buf, size_t size, const Name& keyName) const
102 {
103  const KeyHandle* key = findKey(keyName);
104 
105  if (key == nullptr)
106  return nullptr;
107  else
108  return key->decrypt(buf, size);
109 }
110 
111 bool
113 {
114  return m_backEnd->isTerminalMode();
115 }
116 
117 void
118 Tpm::setTerminalMode(bool isTerminal) const
119 {
120  m_backEnd->setTerminalMode(isTerminal);
121 }
122 
123 bool
125 {
126  return m_backEnd->isTpmLocked();
127 }
128 
129 bool
130 Tpm::unlockTpm(const char* password, size_t passwordLength) const
131 {
132  return m_backEnd->unlockTpm(password, passwordLength);
133 }
134 
136 Tpm::exportPrivateKey(const Name& keyName, const char* pw, size_t pwLen) const
137 {
138  return m_backEnd->exportKey(keyName, pw, pwLen);
139 }
140 
141 void
142 Tpm::importPrivateKey(const Name& keyName, const uint8_t* pkcs8, size_t pkcs8Len,
143  const char* pw, size_t pwLen)
144 {
145  m_backEnd->importKey(keyName, pkcs8, pkcs8Len, pw, pwLen);
146 }
147 
148 const KeyHandle*
149 Tpm::findKey(const Name& keyName) const
150 {
151  auto it = m_keys.find(keyName);
152  if (it != m_keys.end())
153  return it->second.get();
154 
155  auto handle = m_backEnd->getKeyHandle(keyName);
156  if (handle == nullptr)
157  return nullptr;
158 
159  const KeyHandle* key = handle.get();
160  m_keys[keyName] = std::move(handle);
161  return key;
162 }
163 
164 } // namespace tpm
165 } // namespace security
166 } // namespace ndn
ConstBufferPtr sign(const uint8_t *buf, size_t size, const Name &keyName, DigestAlgorithm digestAlgorithm) const
Sign blob using the key with name keyName and using the digest digestAlgorithm.
Definition: tpm.cpp:90
ConstBufferPtr sign(DigestAlgorithm digestAlgorithm, const uint8_t *buf, size_t size) const
Definition: key-handle.cpp:31
Copyright (c) 2011-2015 Regents of the University of California.
ConstBufferPtr derivePublicKey() const
Definition: key-handle.cpp:43
ConstBufferPtr decrypt(const uint8_t *cipherText, size_t cipherTextLen) const
Definition: key-handle.cpp:37
RSA key, supports sign/verify and encrypt/decrypt operations.
bool hasKey(const Name &keyName) const
Check if a private key exists.
Definition: tpm.cpp:46
Abstraction of TPM key handle.
Definition: key-handle.hpp:37
Name createKey(const Name &identityName, const KeyParams &params)
Create key for identityName according to params.
Definition: tpm.cpp:52
ConstBufferPtr getPublicKey(const Name &keyName) const
Definition: tpm.cpp:79
bool isTpmLocked() const
Definition: tpm.cpp:124
ConstBufferPtr exportPrivateKey(const Name &keyName, const char *pw, size_t pwLen) const
Export a private key.
Definition: tpm.cpp:136
Elliptic Curve key (e.g. for ECDSA), supports sign/verify operations.
bool unlockTpm(const char *password, size_t passwordLength) const
Unlock the TPM.
Definition: tpm.cpp:130
void setTerminalMode(bool isTerminal) const
Set the terminal mode of the TPM.
Definition: tpm.cpp:118
Represents an absolute name.
Definition: name.hpp:43
KeyType getKeyType() const
Definition: key-params.hpp:48
void deleteKey(const Name &keyName)
Delete a key pair with name keyName.
Definition: tpm.cpp:69
std::string getTpmLocator() const
Definition: tpm.cpp:40
void importPrivateKey(const Name &keyName, const uint8_t *pkcs8, size_t pkcs8Len, const char *pw, size_t pwLen)
Import a private key.
Definition: tpm.cpp:142
Base class of key parameters.
Definition: key-params.hpp:35
ConstBufferPtr decrypt(const uint8_t *buf, size_t size, const Name &keyName) const
Decrypt blob using the key with name keyName.
Definition: tpm.cpp:101
bool isTerminalMode() const
Check if the TPM is in terminal mode.
Definition: tpm.cpp:112
shared_ptr< const Buffer > ConstBufferPtr
Definition: buffer.hpp:126