key.cpp

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.
 */
 
#include "ndn-cxx/security/pib/key.hpp"
#include "ndn-cxx/security/pib/impl/key-impl.hpp"
 
namespace ndn::security {
namespace pib {
 
Key::Key() noexcept = default;
 
Key::Key(weak_ptr<KeyImpl> impl) noexcept
  : m_impl(std::move(impl))
{
}
 
const Name&
Key::getName() const
{
  return lock()->getName();
}
 
const Name&
Key::getIdentity() const
{
  return lock()->getIdentity();
}
 
KeyType
Key::getKeyType() const
{
  return lock()->getKeyType();
}
 
span<const uint8_t>
Key::getPublicKey() const
{
  return lock()->getPublicKey();
}
 
void
Key::addCertificate(const Certificate& certificate) const
{
  lock()->addCertificate(certificate);
}
 
void
Key::removeCertificate(const Name& certName) const
{
  lock()->removeCertificate(certName);
}
 
Certificate
Key::getCertificate(const Name& certName) const
{
  return lock()->getCertificate(certName);
}
 
const CertificateContainer&
Key::getCertificates() const
{
  return lock()->getCertificates();
}
 
const Certificate&
Key::setDefaultCertificate(const Name& certName) const
{
  return lock()->setDefaultCertificate(certName);
}
 
void
Key::setDefaultCertificate(const Certificate& certificate) const
{
  return lock()->setDefaultCertificate(certificate);
}
 
const Certificate&
Key::getDefaultCertificate() const
{
  return lock()->getDefaultCertificate();
}
 
Key::operator bool() const noexcept
{
  return !m_impl.expired();
}
 
shared_ptr<KeyImpl>
Key::lock() const
{
  auto impl = m_impl.lock();
  if (impl == nullptr) {
    NDN_THROW(std::domain_error("Invalid PIB key instance"));
  }
  return impl;
}
 
bool
Key::equals(const Key& other) const noexcept
{
  return !this->m_impl.owner_before(other.m_impl) &&
         !other.m_impl.owner_before(this->m_impl);
}
 
} // namespace pib
 
Name
constructKeyName(const Name& identity, const name::Component& keyId)
{
  return Name(identity)
         .append(Certificate::KEY_COMPONENT)
         .append(keyId);
}
 
bool
isValidKeyName(const Name& keyName)
{
  return keyName.size() >= Certificate::MIN_KEY_NAME_LENGTH &&
         keyName.get(-Certificate::MIN_KEY_NAME_LENGTH) == Certificate::KEY_COMPONENT;
}
 
Name
extractIdentityFromKeyName(const Name& keyName)
{
  if (!isValidKeyName(keyName)) {
    NDN_THROW(std::invalid_argument("Key name `" + keyName.toUri() + "` "
                                    "does not respect the naming conventions"));
  }
 
  return keyName.getPrefix(-Certificate::MIN_KEY_NAME_LENGTH); // trim everything after and including "KEY"
}
 
} // namespace ndn::security