pib-key.hpp

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

#include <ndn-cpp/security/security-common.hpp>
#include "pib-certificate-container.hpp"

// Give friend access to the tests.
class TestKeyChain_Management_Test;

namespace ndn {

class PibKeyImpl;

class PibKey {
public:
  /*
   * Get the key name.
   * @return The key name.
   * @throws std::domain_error if the backend implementation instance is invalid.
   */
  const Name&
  getName();

  const Name&
  getIdentityName();

  KeyType
  getKeyType();

  const Blob&
  getPublicKey();

  ptr_lib::shared_ptr<CertificateV2>
  getCertificate(const Name& certificateName);

  ptr_lib::shared_ptr<CertificateV2>&
  getDefaultCertificate();

  static Name
  constructKeyName(const Name& identityName, const Name::Component& keyId);

  static bool
  isValidKeyName(const Name& keyName);

  static Name
  extractIdentityFromKeyName(const Name& keyName);

private:
  friend class PibKeyContainer;
  friend class KeyChain;
  // Give friend access to the tests.
  friend TestKeyChain_Management_Test;

  PibKey(ptr_lib::weak_ptr<PibKeyImpl> impl);

  void
  addCertificate(const CertificateV2& certificate);

  void
  removeCertificate(const Name& certificateName);

  const ptr_lib::shared_ptr<CertificateV2>&
  setDefaultCertificate(const Name& certificateName);

  const ptr_lib::shared_ptr<CertificateV2>&
  setDefaultCertificate(const CertificateV2& certificate);

  PibCertificateContainer&
  getCertificates();

  const PibCertificateContainer&
  getCertificates() const { return const_cast<PibKey*>(this)->getCertificates(); }

  ptr_lib::shared_ptr<PibKeyImpl>
  lock() const;

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

  ptr_lib::weak_ptr<PibKeyImpl> impl_;
};

}

#endif