NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
back-end-osx.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2021 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 
22 #ifndef NDN_CXX_SECURITY_TPM_IMPL_BACK_END_OSX_HPP
23 #define NDN_CXX_SECURITY_TPM_IMPL_BACK_END_OSX_HPP
24 
26 
27 #ifndef NDN_CXX_HAVE_OSX_FRAMEWORKS
28 #error "This file should not be compiled ..."
29 #endif
30 
32 
33 namespace ndn {
34 namespace security {
35 namespace tpm {
36 
40 class BackEndOsx final : public BackEnd
41 {
42 public:
48  explicit
49  BackEndOsx(const std::string& location = "");
50 
51  ~BackEndOsx() final;
52 
53  static const std::string&
54  getScheme();
55 
56 public: // management
57  bool
58  isTerminalMode() const final;
59 
60  void
61  setTerminalMode(bool isTerminal) const final;
62 
63  bool
64  isTpmLocked() const final;
65 
66  bool
67  unlockTpm(const char* pw, size_t pwLen) const final;
68 
69 public: // crypto transformation
73  static ConstBufferPtr
74  sign(const KeyRefOsx& key, DigestAlgorithm digestAlgorithm, const InputBuffers& bufs);
75 
79  static ConstBufferPtr
80  decrypt(const KeyRefOsx& key, span<const uint8_t> cipherText);
81 
82  static ConstBufferPtr
83  derivePublicKey(const KeyRefOsx& key);
84 
85 private: // inherited from tpm::BackEnd
86  bool
87  doHasKey(const Name& keyName) const final;
88 
89  unique_ptr<KeyHandle>
90  doGetKeyHandle(const Name& keyName) const final;
91 
92  unique_ptr<KeyHandle>
93  doCreateKey(const Name& identityName, const KeyParams& params) final;
94 
95  void
96  doDeleteKey(const Name& keyName) final;
97 
99  doExportKey(const Name& keyName, const char* pw, size_t pwLen) final;
100 
101  void
102  doImportKey(const Name& keyName, span<const uint8_t> pkcs8, const char* pw, size_t pwLen) final;
103 
104  void
105  doImportKey(const Name& keyName, shared_ptr<transform::PrivateKey> key) final;
106 
107 private:
108  class Impl;
109  const unique_ptr<Impl> m_impl;
110 };
111 
112 } // namespace tpm
113 } // namespace security
114 } // namespace ndn
115 
116 #endif // NDN_CXX_SECURITY_TPM_IMPL_BACK_END_OSX_HPP
bool isTpmLocked() const final
Check if the TPM is locked.
Copyright (c) 2011-2015 Regents of the University of California.
The back-end implementation of TPM based on macOS Keychain Services.
Abstract interface for a TPM backend implementation.
Definition: back-end.hpp:36
static const std::string & getScheme()
bool isTerminalMode() const final
Check if the TPM is in terminal mode.
void setTerminalMode(bool isTerminal) const final
Set the terminal mode of the TPM.
static ConstBufferPtr derivePublicKey(const KeyRefOsx &key)
BackEndOsx(const std::string &location="")
Create TPM backed based on macOS Keychain Services.
bool unlockTpm(const char *pw, size_t pwLen) const final
Unlock the TPM.
Represents an absolute name.
Definition: name.hpp:41
Base class for key parameters.
Definition: key-params.hpp:35
InputBuffers bufs
static ConstBufferPtr decrypt(const KeyRefOsx &key, span< const uint8_t > cipherText)
Decrypt cipherText with key.
static ConstBufferPtr sign(const KeyRefOsx &key, DigestAlgorithm digestAlgorithm, const InputBuffers &bufs)
Sign bufs with key using digestAlgorithm.
shared_ptr< const Buffer > ConstBufferPtr
Definition: buffer.hpp:139