identity.hpp

Go to the documentation of this file.

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

#include "key-container.hpp"

namespace ndn {
namespace security {

class PibImpl;
class Pib;
class IdentityContainer;

class Identity
{
public:
  friend class Pib;
  friend class IdentityContainer;
  friend class KeyChain;

public:
  Identity();

  const Name&
  getName() const;

  Key
  getKey(const name::Component& keyId) const;

  const KeyContainer&
  getKeys() const;

  Key&
  getDefaultKey() const;

  operator bool() const;

  bool
  operator!() const;

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE: // write operations should be private

  Key
  addKey(const PublicKey& publicKey, const name::Component& keyId = EMPTY_KEY_ID);

  void
  removeKey(const name::Component& keyId);

  Key&
  setDefaultKey(const name::Component& keyId);

  Key&
  setDefaultKey(const PublicKey& publicKey, const name::Component& keyId = EMPTY_KEY_ID);

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  Identity(const Name& identityName, shared_ptr<PibImpl> impl, bool needInit = false);

  void
  validityCheck() const;

public:
  static const name::Component EMPTY_KEY_ID;

private:
  Name m_name;

  mutable bool m_hasDefaultKey;
  mutable Key m_defaultKey;

  mutable bool m_needRefreshKeys;
  mutable KeyContainer m_keys;

  shared_ptr<PibImpl> m_impl;
};

} // namespace security
} // namespace ndn

#endif // NDN_SECURITY_IDENTITY_HPP