key-handle.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_KEY_HANDLE_HPP
23 #define NDN_CXX_SECURITY_TPM_KEY_HANDLE_HPP
24 
25 #include "ndn-cxx/name.hpp"
27 
28 namespace ndn {
29 namespace security {
30 namespace tpm {
31 
37 class KeyHandle : noncopyable
38 {
39 public:
40  class Error : public std::runtime_error
41  {
42  public:
43  using std::runtime_error::runtime_error;
44  };
45 
46 public:
47  virtual
49 
54  sign(DigestAlgorithm digestAlgorithm, const InputBuffers& bufs) const;
55 
59  bool
60  verify(DigestAlgorithm digestAlgorithm, const InputBuffers& bufs, span<const uint8_t> sig) const;
61 
66  decrypt(span<const uint8_t> cipherText) const;
67 
72  derivePublicKey() const;
73 
74  Name
75  getKeyName() const
76  {
77  return m_keyName;
78  }
79 
80  void
81  setKeyName(const Name& keyName)
82  {
83  m_keyName = keyName;
84  }
85 
86 private:
87  virtual ConstBufferPtr
88  doSign(DigestAlgorithm digestAlgo, const InputBuffers& bufs) const = 0;
89 
90  virtual bool
91  doVerify(DigestAlgorithm digestAlgo, const InputBuffers& bufs, span<const uint8_t> sig) const = 0;
92 
93  virtual ConstBufferPtr
94  doDecrypt(span<const uint8_t> cipherText) const = 0;
95 
96  virtual ConstBufferPtr
97  doDerivePublicKey() const = 0;
98 
99 private:
100  Name m_keyName;
101 };
102 
103 } // namespace tpm
104 } // namespace security
105 } // namespace ndn
106 
107 #endif // NDN_CXX_SECURITY_TPM_KEY_HANDLE_HPP
Represents an absolute name.
Definition: name.hpp:44
Abstraction of TPM key handle.
Definition: key-handle.hpp:38
void setKeyName(const Name &keyName)
Definition: key-handle.hpp:81
ConstBufferPtr derivePublicKey() const
Definition: key-handle.cpp:50
ConstBufferPtr decrypt(span< const uint8_t > cipherText) const
Return plain text content decrypted from cipherText using this key.
Definition: key-handle.cpp:44
bool verify(DigestAlgorithm digestAlgorithm, const InputBuffers &bufs, span< const uint8_t > sig) const
Verify the signature sig over bufs using this key and digestAlgorithm.
Definition: key-handle.cpp:37
ConstBufferPtr sign(DigestAlgorithm digestAlgorithm, const InputBuffers &bufs) const
Generate a digital signature for bufs using this key with digestAlgorithm.
Definition: key-handle.cpp:31
Definition: data.cpp:25
shared_ptr< const Buffer > ConstBufferPtr
Definition: buffer.hpp:139
InputBuffers bufs
span< const uint8_t > sig