certificate.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.
 *
 * @author Zhiyi Zhang <dreamerbarrychang@gmail.com>
 * @author Yingdi Yu <http://irl.cs.ucla.edu/~yingdi/>
 */
 
#ifndef NDN_CXX_SECURITY_CERTIFICATE_HPP
#define NDN_CXX_SECURITY_CERTIFICATE_HPP
 
#include "ndn-cxx/data.hpp"
 
namespace ndn::security {
 
class Certificate : public Data
{
public:
  class Error : public Data::Error
  {
  public:
    using Data::Error::Error;
  };
 
  Certificate();
 
  explicit
  Certificate(Data&& data);
 
  explicit
  Certificate(const Data& data);
 
  explicit
  Certificate(const Block& block);
 
  Name
  getIdentity() const;
 
  Name
  getKeyName() const;
 
  name::Component
  getKeyId() const;
 
  name::Component
  getIssuerId() const;
 
  span<const uint8_t>
  getPublicKey() const noexcept
  {
    return getContent().value_bytes();
  }
 
  ValidityPeriod
  getValidityPeriod() const;
 
  bool
  isValid(const time::system_clock::time_point& ts = time::system_clock::now()) const;
 
  Block
  getExtension(uint32_t type) const;
 
  // TODO: Implement extension enumeration (Issue #3907)
 
  static bool
  isValidName(const Name& certName);
 
public:
  // Certificate name structure: /<IdentityName>/KEY/<KeyId>/<IssuerId>/<Version>
  static constexpr ssize_t VERSION_OFFSET = -1;
  static constexpr ssize_t ISSUER_ID_OFFSET = -2;
  static constexpr ssize_t KEY_ID_OFFSET = -3;
  static constexpr ssize_t KEY_COMPONENT_OFFSET = -4;
  static constexpr size_t MIN_CERT_NAME_LENGTH = 4;
  static constexpr size_t MIN_KEY_NAME_LENGTH = 2;
  static inline const name::Component KEY_COMPONENT{"KEY"};
  static inline const name::Component DEFAULT_ISSUER_ID{"NA"};
};
 
std::ostream&
operator<<(std::ostream& os, const Certificate& cert);
 
Name
extractIdentityFromCertName(const Name& certName);
 
Name
extractKeyNameFromCertName(const Name& certName);
 
} // namespace ndn::security
 
#endif // NDN_CXX_SECURITY_CERTIFICATE_HPP