key.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_KEY_HPP
#define NDN_CXX_SECURITY_PIB_KEY_HPP
 
#include "ndn-cxx/security/pib/certificate-container.hpp"
#include "ndn-cxx/security/security-common.hpp"
 
namespace ndn::security {
 
class KeyChain;
 
namespace pib {
 
class KeyContainer;
class KeyImpl;
 
class Key : private boost::equality_comparable<Key>
{
public:
  Key() noexcept;
 
  const Name&
  getName() const;
 
  const Name&
  getIdentity() const;
 
  KeyType
  getKeyType() const;
 
  span<const uint8_t>
  getPublicKey() const;
 
  Certificate
  getCertificate(const Name& certName) const;
 
  const CertificateContainer&
  getCertificates() const;
 
  const Certificate&
  getDefaultCertificate() const;
 
  explicit
  operator bool() const noexcept;
 
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE: // write operations are accessible only by KeyChain
  void
  addCertificate(const Certificate& certificate) const;
 
  void
  removeCertificate(const Name& certName) const;
 
  const Certificate&
  setDefaultCertificate(const Name& certName) const;
 
  void
  setDefaultCertificate(const Certificate& certificate) const;
 
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE: // private interface for KeyContainer
  explicit
  Key(weak_ptr<KeyImpl> impl) noexcept;
 
private:
  shared_ptr<KeyImpl>
  lock() const;
 
  bool
  equals(const Key& other) const noexcept;
 
  // NOTE
  // The following "hidden friend" non-member operators are available
  // via argument-dependent lookup only and must be defined inline.
  // boost::equality_comparable provides != operator.
 
  friend bool
  operator==(const Key& lhs, const Key& rhs) noexcept
  {
    return lhs.equals(rhs);
  }
 
  friend std::ostream&
  operator<<(std::ostream& os, const Key& key)
  {
    if (key)
      return os << key.getName();
    else
      return os << "(empty)";
  }
 
private:
  weak_ptr<KeyImpl> m_impl;
 
  friend KeyChain;
  friend KeyContainer;
};
 
} // namespace pib
 
using pib::Key;
 
Name
constructKeyName(const Name& identity, const name::Component& keyId);
 
bool
isValidKeyName(const Name& keyName);
 
Name
extractIdentityFromKeyName(const Name& keyName);
 
} // namespace ndn::security
 
#endif // NDN_CXX_SECURITY_PIB_KEY_HPP