tpm-back-end.hpp

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

#include "../../name.hpp"
#include "../key-params.hpp"

namespace ndn {

class TpmKeyHandle;

class TpmBackEnd {
public:
  class Error : public std::runtime_error
  {
  public:
    Error(const std::string& what)
    : std::runtime_error(what)
    {
    }
  };

  virtual
  ~TpmBackEnd();

  bool
  hasKey(const Name& keyName) const { return doHasKey(keyName); }

  ptr_lib::shared_ptr<TpmKeyHandle>
  getKeyHandle(const Name& keyName) const { return doGetKeyHandle(keyName); }

  ptr_lib::shared_ptr<TpmKeyHandle>
  createKey(const Name& identityName, const KeyParams& params);

  void
  deleteKey(const Name& keyName) { doDeleteKey(keyName); }

  Blob
  exportKey(const Name& keyName, const uint8_t* password, size_t passwordLength);

  void
  importKey
    (const Name& keyName, const uint8_t* pkcs8, size_t pkcs8Length,
     const uint8_t* password, size_t passwordLength);

  virtual bool
  isTerminalMode() const;

  virtual void
  setTerminalMode(bool isTerminal) const;

  virtual bool
  isTpmLocked() const;

  virtual bool
  unlockTpm(const uint8_t* password, size_t passwordLength) const;

protected:
  TpmBackEnd() {}

  static void
  setKeyName
    (TpmKeyHandle& keyHandle, const Name& identityName, const KeyParams& params);

private:
  virtual bool
  doHasKey(const Name& keyName) const = 0;

  virtual ptr_lib::shared_ptr<TpmKeyHandle>
  doGetKeyHandle(const Name& keyName) const = 0;

  virtual ptr_lib::shared_ptr<TpmKeyHandle>
  doCreateKey(const Name& identityName, const KeyParams& params) = 0;

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

  virtual Blob
  doExportKey(const Name& keyName, const uint8_t* password, size_t passwordLength);

  virtual void
  doImportKey
    (const Name& keyName, const uint8_t* pkcs8, size_t pkcs8Length,
     const uint8_t* password, size_t passwordLength);

  // Disable the copy constructor and assignment operator.
  TpmBackEnd(const TpmBackEnd& other);
  TpmBackEnd& operator=(const TpmBackEnd& other);
};

}

#endif