pib.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2023 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */
 
#ifndef NDN_CXX_SECURITY_PIB_PIB_HPP
#define NDN_CXX_SECURITY_PIB_PIB_HPP
 
#include "ndn-cxx/security/pib/identity-container.hpp"
 
namespace ndn::security {
namespace pib {
 
class PibImpl;
 
class Pib : noncopyable
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };
 
  ~Pib();
 
  const std::string&
  getPibLocator() const
  {
    return m_locator;
  }
 
  std::string
  getTpmLocator() const;
 
  void
  setTpmLocator(const std::string& tpmLocator);
 
  void
  reset();
 
  Identity
  getIdentity(const Name& identityName) const;
 
  const IdentityContainer&
  getIdentities() const;
 
  Identity
  getDefaultIdentity() const;
 
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE: // write operations are accessible only by KeyChain
  Pib(const std::string& locator, shared_ptr<PibImpl> impl);
 
  Identity
  addIdentity(const Name& identity);
 
  void
  removeIdentity(const Name& identity);
 
  Identity
  setDefaultIdentity(const Name& identity);
 
private:
  const std::string m_locator;
  const shared_ptr<PibImpl> m_impl;
 
  IdentityContainer m_identities;
  mutable Identity m_defaultIdentity;
 
  friend KeyChain;
};
 
} // namespace pib
 
using pib::Pib;
 
} // namespace ndn::security
 
#endif // NDN_CXX_SECURITY_PIB_PIB_HPP