NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2019 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_SECURITY_TPM_KEY_HANDLE_HPP
23 #define NDN_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 uint8_t* buf, size_t size) const;
55 
59  bool
60  verify(DigestAlgorithm digestAlgorithm, const uint8_t* buf, size_t bufLen,
61  const uint8_t* sig, size_t sigLen) const;
62 
67  decrypt(const uint8_t* cipherText, size_t cipherTextLen) const;
68 
73  derivePublicKey() const;
74 
75  Name
76  getKeyName() const
77  {
78  return m_keyName;
79  }
80 
81  void
82  setKeyName(const Name& keyName)
83  {
84  m_keyName = keyName;
85  }
86 
87 private:
88  virtual ConstBufferPtr
89  doSign(DigestAlgorithm digestAlgorithm, const uint8_t* buf, size_t size) const = 0;
90 
91  virtual bool
92  doVerify(DigestAlgorithm digestAlgorithm, const uint8_t* buf, size_t bufLen,
93  const uint8_t* sig, size_t sigLen) const = 0;
94 
95  virtual ConstBufferPtr
96  doDecrypt(const uint8_t* cipherText, size_t cipherTextLen) const = 0;
97 
98  virtual ConstBufferPtr
99  doDerivePublicKey() const = 0;
100 
101 private:
102  Name m_keyName;
103 };
104 
105 } // namespace tpm
106 } // namespace security
107 } // namespace ndn
108 
109 #endif // NDN_SECURITY_TPM_KEY_HANDLE_HPP
buf
const uint8_t * buf
Definition: verification-helpers.cpp:47
ndn::security::tpm::KeyHandle::~KeyHandle
virtual ~KeyHandle()
ndn::security::tpm::KeyHandle::verify
bool verify(DigestAlgorithm digestAlgorithm, const uint8_t *buf, size_t bufLen, const uint8_t *sig, size_t sigLen) const
Verify the signature sig created on buf using this key and digestAlgorithm.
Definition: key-handle.cpp:37
ndn::security::tpm::KeyHandle::derivePublicKey
ConstBufferPtr derivePublicKey() const
Definition: key-handle.cpp:50
bufLen
size_t bufLen
Definition: verification-helpers.cpp:48
sigLen
size_t sigLen
Definition: verification-helpers.cpp:50
security-common.hpp
ndn::security::tpm::KeyHandle::decrypt
ConstBufferPtr decrypt(const uint8_t *cipherText, size_t cipherTextLen) const
Definition: key-handle.cpp:44
ndn::security::tpm::KeyHandle::setKeyName
void setKeyName(const Name &keyName)
Definition: key-handle.hpp:82
name.hpp
ndn::DigestAlgorithm
DigestAlgorithm
Definition: security-common.hpp:96
ndn::security::tpm::KeyHandle
Abstraction of TPM key handle.
Definition: key-handle.hpp:38
ndn::security::tpm::KeyHandle::Error
Definition: key-handle.hpp:41
ndn::Name
Represents an absolute name.
Definition: name.hpp:44
ndn::security::tpm::KeyHandle::getKeyName
Name getKeyName() const
Definition: key-handle.hpp:76
sig
const uint8_t * sig
Definition: verification-helpers.cpp:49
ndn::security::tpm::KeyHandle::sign
ConstBufferPtr sign(DigestAlgorithm digestAlgorithm, const uint8_t *buf, size_t size) const
Definition: key-handle.cpp:31
ndn::ConstBufferPtr
shared_ptr< const Buffer > ConstBufferPtr
Definition: buffer.hpp:126
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-strategy-choice-helper.hpp:34