key.hpp

Go to the documentation of this file.

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

#include "v1/identity-certificate.hpp"
#include "certificate-container.hpp"

namespace ndn {
namespace security {

class PibImpl;
class Identity;
class KeyContainer;

class Key
{
public:
  friend class Identity;
  friend class KeyContainer;
  friend class KeyChain;

public:
  Key();

  const Name&
  getName() const;

  const Name&
  getIdentity() const;

  const name::Component&
  getKeyId() const;

  const v1::PublicKey&
  getPublicKey() const;

  v1::IdentityCertificate
  getCertificate(const Name& certName) const;

  const CertificateContainer&
  getCertificates() const;

  const v1::IdentityCertificate&
  getDefaultCertificate() const;

  operator bool() const;

  bool
  operator!() const;

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE: // write operations should be private

  void
  addCertificate(const v1::IdentityCertificate& certificate);

  void
  removeCertificate(const Name& certName);

  const v1::IdentityCertificate&
  setDefaultCertificate(const Name& certName);

  const v1::IdentityCertificate&
  setDefaultCertificate(const v1::IdentityCertificate& certificate);

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  Key(const Name& identityName, const name::Component& keyId,
      const v1::PublicKey& publicKey, shared_ptr<PibImpl> impl);

  Key(const Name& identityName, const name::Component& keyId, shared_ptr<PibImpl> impl);

  void
  validityCheck() const;

private:
  Name m_id;
  name::Component m_keyId;
  Name m_keyName;
  v1::PublicKey m_key;

  mutable bool m_hasDefaultCertificate;
  mutable v1::IdentityCertificate m_defaultCertificate;

  mutable bool m_needRefreshCerts;
  mutable CertificateContainer m_certificates;

  shared_ptr<PibImpl> m_impl;
};

} // namespace security
} // namespace ndn

#endif // NDN_SECURITY_PIB_HPP