identity-storage.hpp

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

#include "../../name.hpp"
#include "../security-common.hpp"

namespace ndn {

class IdentityCertificate;
class Data;

class IdentityStorage {
public:
  IdentityStorage();

  virtual
  ~IdentityStorage();

  virtual bool
  doesIdentityExist(const Name& identityName) = 0;

  virtual void
  addIdentity(const Name& identityName) = 0;

  virtual bool
  revokeIdentity() = 0;

  Name
  getNewKeyName(const Name& identityName, bool useKsk);

  virtual bool
  doesKeyExist(const Name& keyName) = 0;

  virtual void
  addKey(const Name& keyName, KeyType keyType, const Blob& publicKeyDer) = 0;

  virtual Blob
  getKey(const Name& keyName) = 0;

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

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

  virtual bool
  doesCertificateExist(const Name& certificateName) = 0;

  virtual void
  addCertificate(const IdentityCertificate& certificate) = 0;

  virtual ptr_lib::shared_ptr<IdentityCertificate>
  getCertificate(const Name &certificateName) = 0;

  virtual std::string
  getTpmLocator() = 0;

  /*****************************************
   *           Get/Set Default             *
   *****************************************/

  virtual Name
  getDefaultIdentity() = 0;

  virtual Name
  getDefaultKeyNameForIdentity(const Name& identityName) = 0;

  Name
  getDefaultCertificateNameForIdentity(const Name& identityName);

  virtual Name
  getDefaultCertificateNameForKey(const Name& keyName) = 0;

  virtual void
  getAllIdentities(std::vector<Name>& nameList, bool isDefault) = 0;

  virtual void
  getAllKeyNamesOfIdentity
    (const Name& identityName, std::vector<Name>& nameList, bool isDefault) = 0;

  virtual void
  getAllCertificateNamesOfKey
    (const Name& keyName, std::vector<Name>& nameList, bool isDefault) = 0;

  virtual void
  setDefaultIdentity(const Name& identityName) = 0;

  virtual void
  setDefaultKeyNameForIdentity(const Name& keyName, const Name& identityNameCheck = Name()) = 0;

  virtual void
  setDefaultCertificateNameForKey(const Name& keyName, const Name& certificateName) = 0;

  virtual ptr_lib::shared_ptr<IdentityCertificate>
  getDefaultCertificate();

  /*****************************************
   *            Delete Methods             *
   *****************************************/

  virtual void
  deleteCertificateInfo(const Name& certificateName) = 0;

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

  virtual void
  deleteIdentityInfo(const Name& identity) = 0;

private:
  static bool lastTimestampIsInitialized_;
  static uint64_t lastTimestamp_;
};

}

#endif