back-end.hpp

Go to the documentation of this file.

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

#include "../../common.hpp"
#include "../../name.hpp"
#include "../../encoding/buffer.hpp"
#include "../key-params.hpp"

namespace ndn {
namespace security {
namespace tpm {

class KeyHandle;

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

public:
  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& identity, const KeyParams& params);

  void
  deleteKey(const Name& keyName);

  ConstBufferPtr
  exportKey(const Name& keyName, const char* pw, size_t pwLen);

  void
  importKey(const Name& keyName, const uint8_t* pkcs8, size_t pkcs8Len, const char* pw, size_t pwLen);

  virtual bool
  isTerminalMode() const;

  virtual void
  setTerminalMode(bool isTerminal) const;

  virtual bool
  isTpmLocked() const;

  virtual bool
  unlockTpm(const char* pw, size_t pwLen) const;

protected: // static helper method
  static void
  setKeyName(KeyHandle& keyHandle, const Name& identity, const KeyParams& params);

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, const uint8_t* pkcs8, size_t pkcs8Len, const char* pw, size_t pwLen) = 0;
};

} // namespace tpm
} // namespace security
} // namespace ndn

#endif // NDN_SECURITY_TPM_BACK_END_HPP