back-end.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2024 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_BACK_END_HPP
#define NDN_CXX_SECURITY_TPM_BACK_END_HPP
 
#include "ndn-cxx/security/tpm/tpm.hpp"
 
namespace ndn::security::tpm {
 
class BackEnd : noncopyable
{
public:
  using Error = Tpm::Error;
 
  virtual
  ~BackEnd();
 
public: // key management
  bool
  hasKey(const Name& keyName) const;
 
  unique_ptr<KeyHandle>
  getKeyHandle(const Name& keyName) const;
 
  unique_ptr<KeyHandle>
  createKey(const Name& identityName, const KeyParams& params);
 
  void
  deleteKey(const Name& keyName);
 
  ConstBufferPtr
  exportKey(const Name& keyName, const char* pw, size_t pwLen);
 
  void
  importKey(const Name& keyName, span<const uint8_t> pkcs8, const char* pw, size_t pwLen);
 
  void
  importKey(const Name& keyName, shared_ptr<transform::PrivateKey> key);
 
  [[deprecated]]
  virtual bool
  isTerminalMode() const
  {
    return true;
  }
 
  [[deprecated]]
  virtual void
  setTerminalMode(bool isTerminal) const
  {
  }
 
  [[deprecated]]
  virtual bool
  isTpmLocked() const
  {
    return false;
  }
 
  [[deprecated]]
  [[nodiscard]] virtual bool
  unlockTpm(const char* pw, size_t pwLen) const
  {
    return true;
  }
 
protected: // helper methods
  Name
  constructAsymmetricKeyName(const KeyHandle& key, const Name& identity,
                             const KeyParams& params) const;
 
  Name
  constructHmacKeyName(const transform::PrivateKey& key, const Name& identity,
                       const KeyParams& params) const;
 
private: // pure virtual methods
  virtual bool
  doHasKey(const Name& keyName) const = 0;
 
  virtual unique_ptr<KeyHandle>
  doGetKeyHandle(const Name& keyName) const = 0;
 
  virtual unique_ptr<KeyHandle>
  doCreateKey(const Name& identity, const KeyParams& params) = 0;
 
  virtual void
  doDeleteKey(const Name& keyName) = 0;
 
  virtual ConstBufferPtr
  doExportKey(const Name& keyName, const char* pw, size_t pwLen) = 0;
 
  virtual void
  doImportKey(const Name& keyName, span<const uint8_t> pkcs8, const char* pw, size_t pwLen) = 0;
 
  virtual void
  doImportKey(const Name& keyName, shared_ptr<transform::PrivateKey> key) = 0;
};
 
} // namespace ndn::security::tpm
 
#endif // NDN_CXX_SECURITY_TPM_BACK_END_HPP