pib-impl.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2021 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_IMPL_HPP
#define NDN_CXX_SECURITY_PIB_PIB_IMPL_HPP

#include "ndn-cxx/security/pib/pib.hpp"
#include "ndn-cxx/security/certificate.hpp"

#include <set>

namespace ndn {
namespace security {
namespace pib {

class PibImpl : noncopyable
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };

public:
  virtual
  ~PibImpl() = default;

public: // TpmLocator management
  virtual void
  setTpmLocator(const std::string& tpmLocator) = 0;

  virtual std::string
  getTpmLocator() const = 0;

public: // Identity management
  virtual bool
  hasIdentity(const Name& identity) const = 0;

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

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

  virtual void
  clearIdentities() = 0;

  virtual std::set<Name>
  getIdentities() const = 0;

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

  virtual Name
  getDefaultIdentity() const = 0;

public: // Key management
  virtual bool
  hasKey(const Name& keyName) const = 0;

  virtual void
  addKey(const Name& identity, const Name& keyName, span<const uint8_t> key) = 0;

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

  virtual Buffer
  getKeyBits(const Name& keyName) const = 0;

  virtual std::set<Name>
  getKeysOfIdentity(const Name& identity) const = 0;

  virtual void
  setDefaultKeyOfIdentity(const Name& identity, const Name& keyName) = 0;

  virtual Name
  getDefaultKeyOfIdentity(const Name& identity) const = 0;

public: // Certificate Management
  virtual bool
  hasCertificate(const Name& certName) const = 0;

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

  virtual void
  removeCertificate(const Name& certName) = 0;

  virtual Certificate
  getCertificate(const Name& certName) const = 0;

  virtual std::set<Name>
  getCertificatesOfKey(const Name& keyName) const = 0;

  virtual void
  setDefaultCertificateOfKey(const Name& keyName, const Name& certName) = 0;

  virtual Certificate
  getDefaultCertificateOfKey(const Name& keyName) const = 0;
};

} // namespace pib
} // namespace security
} // namespace ndn

#endif // NDN_CXX_SECURITY_PIB_PIB_IMPL_HPP