tpm.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2022 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */
 
#ifndef NDN_CXX_SECURITY_TPM_TPM_HPP
#define NDN_CXX_SECURITY_TPM_TPM_HPP
 
#include "ndn-cxx/name.hpp"
#include "ndn-cxx/security/key-params.hpp"
#include "ndn-cxx/security/tpm/key-handle.hpp"
 
#include <unordered_map>
#include <boost/logic/tribool.hpp>
 
namespace ndn {
namespace security {
 
namespace transform {
class PrivateKey;
} // namespace transform
 
inline namespace v2 {
class KeyChain;
} // inline namespace v2
 
namespace tpm {
 
class BackEnd;
 
class Tpm : noncopyable
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };
 
  ~Tpm();
 
  std::string
  getTpmLocator() const;
 
  bool
  hasKey(const Name& keyName) const;
 
  ConstBufferPtr
  getPublicKey(const Name& keyName) const;
 
  ConstBufferPtr
  sign(const InputBuffers& bufs, const Name& keyName, DigestAlgorithm digestAlgorithm) const;
 
  [[deprecated("use the overload that takes InputBuffers")]]
  ConstBufferPtr
  sign(const uint8_t* buf, size_t size, const Name& keyName, DigestAlgorithm digestAlgorithm) const
  {
    return sign({{buf, size}}, keyName, digestAlgorithm);
  }
 
  NDN_CXX_NODISCARD boost::logic::tribool
  verify(const InputBuffers& bufs, span<const uint8_t> sig, const Name& keyName,
         DigestAlgorithm digestAlgorithm) const;
 
  [[deprecated("use the overload that takes InputBuffers and span")]]
  boost::logic::tribool
  verify(const uint8_t* buf, size_t bufLen, const uint8_t* sig, size_t sigLen,
         const Name& keyName, DigestAlgorithm digestAlgorithm) const
  {
    return verify({{buf, bufLen}}, {sig, sigLen}, keyName, digestAlgorithm);
  }
 
  ConstBufferPtr
  decrypt(span<const uint8_t> buf, const Name& keyName) const;
 
  [[deprecated("use the overload that takes a span<>")]]
  ConstBufferPtr
  decrypt(const uint8_t* buf, size_t size, const Name& keyName) const
  {
    return decrypt({buf, size}, keyName);
  }
 
public: // Management
  bool
  isTerminalMode() const;
 
  void
  setTerminalMode(bool isTerminal) const;
 
  bool
  isTpmLocked() const;
 
  NDN_CXX_NODISCARD bool
  unlockTpm(const char* password, size_t passwordLength) const;
 
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  Tpm(const std::string& scheme, const std::string& location, unique_ptr<BackEnd> impl);
 
  Name
  createKey(const Name& identityName, const KeyParams& params);
 
  void
  deleteKey(const Name& keyName);
 
  ConstBufferPtr
  exportPrivateKey(const Name& keyName, const char* pw, size_t pwLen) const;
 
  void
  importPrivateKey(const Name& keyName, span<const uint8_t> pkcs8, const char* pw, size_t pwLen);
 
  void
  importPrivateKey(const Name& keyName, shared_ptr<transform::PrivateKey> key);
 
  void
  clearKeyCache()
  {
    m_keys.clear();
  }
 
private:
  const KeyHandle*
  findKey(const Name& keyName) const;
 
private:
  std::string m_scheme;
  std::string m_location;
 
  mutable std::unordered_map<Name, unique_ptr<KeyHandle>> m_keys;
 
  const unique_ptr<BackEnd> m_backEnd;
 
  friend KeyChain;
};
 
} // namespace tpm
 
using tpm::Tpm;
 
} // namespace security
} // namespace ndn
 
#endif // NDN_CXX_SECURITY_TPM_TPM_HPP