v1/sec-tpm.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef NDN_SECURITY_V1_SEC_TPM_HPP
#define NDN_SECURITY_V1_SEC_TPM_HPP

#include "../../common.hpp"
#include "../security-common.hpp"
#include "../../name.hpp"
#include "../../data.hpp"
#include "../key-params.hpp"
#include "public-key.hpp"

namespace ndn {
namespace security {
namespace v1 {

class SecTpm : noncopyable
{
public:
  class Error : public std::runtime_error
  {
  public:
    explicit
    Error(const std::string& what)
      : std::runtime_error(what)
    {
    }
  };

  explicit
  SecTpm(const std::string& location);

  virtual
  ~SecTpm();

  std::string
  getTpmLocator();

  virtual void
  setTpmPassword(const uint8_t* password, size_t passwordLength) = 0;

  virtual void
  resetTpmPassword() = 0;

  virtual void
  setInTerminal(bool inTerminal) = 0;

  virtual bool
  getInTerminal() const = 0;

  virtual bool
  isLocked() = 0;

  virtual bool
  unlockTpm(const char* password, size_t passwordLength, bool usePassword) = 0;

  virtual void
  generateKeyPairInTpm(const Name& keyName, const KeyParams& params) = 0;

  virtual void
  deleteKeyPairInTpm(const Name& keyName) = 0;

  virtual shared_ptr<v1::PublicKey>
  getPublicKeyFromTpm(const Name& keyName) = 0;

  virtual Block
  signInTpm(const uint8_t* data, size_t dataLength,
            const Name& keyName,
            DigestAlgorithm digestAlgorithm) = 0;

  virtual ConstBufferPtr
  decryptInTpm(const uint8_t* data, size_t dataLength, const Name& keyName, bool isSymmetric) = 0;

  virtual ConstBufferPtr
  encryptInTpm(const uint8_t* data, size_t dataLength, const Name& keyName, bool isSymmetric) = 0;

  virtual void
  generateSymmetricKeyInTpm(const Name& keyName, const KeyParams& params) = 0;

  virtual bool
  doesKeyExistInTpm(const Name& keyName, KeyClass keyClass) = 0;

  virtual bool
  generateRandomBlock(uint8_t* res, size_t size) = 0;

  virtual void
  addAppToAcl(const Name& keyName, KeyClass keyClass, const std::string& appPath, AclType acl) = 0;

  ConstBufferPtr
  exportPrivateKeyPkcs5FromTpm(const Name& keyName, const std::string& password);

  bool
  importPrivateKeyPkcs5IntoTpm(const Name& keyName,
                               const uint8_t* buffer, size_t bufferSize,
                               const std::string& password);

protected:
  virtual std::string
  getScheme() = 0;

  virtual ConstBufferPtr
  exportPrivateKeyPkcs8FromTpm(const Name& keyName) = 0;

  virtual bool
  importPrivateKeyPkcs8IntoTpm(const Name& keyName, const uint8_t* buffer, size_t bufferSize) = 0;

  virtual bool
  importPublicKeyPkcs1IntoTpm(const Name& keyName, const uint8_t* buffer, size_t bufferSize) = 0;

  virtual bool
  getImpExpPassWord(std::string& password, const std::string& prompt);

protected:
  std::string m_location;
};

} // namespace v1

#ifdef NDN_CXX_KEEP_SECURITY_V1_ALIASES
using v1::SecTpm;
#endif // NDN_CXX_KEEP_SECURITY_V1_ALIASES

} // namespace security

#ifdef NDN_CXX_KEEP_SECURITY_V1_ALIASES
using security::v1::SecTpm;
#endif // NDN_CXX_KEEP_SECURITY_V1_ALIASES

} // namespace ndn

#endif // NDN_SECURITY_V1_SEC_TPM_HPP