signing-info.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/signing-info.hpp"
 
#include "ndn-cxx/encoding/buffer-stream.hpp"
#include "ndn-cxx/security/transform/base64-decode.hpp"
#include "ndn-cxx/security/transform/buffer-source.hpp"
#include "ndn-cxx/security/transform/stream-sink.hpp"
 
namespace ndn::security {
 
const Name&
SigningInfo::getDigestSha256Identity()
{
  static Name digestSha256Identity("/localhost/identity/digest-sha256");
  return digestSha256Identity;
}
 
const Name&
SigningInfo::getHmacIdentity()
{
  static Name hmacIdentity("/localhost/identity/hmac");
  return hmacIdentity;
}
 
SigningInfo::SigningInfo(SignerType signerType,
                         const Name& signerName,
                         const SignatureInfo& signatureInfo)
  : m_type(signerType)
  , m_name(signerName)
  , m_digestAlgorithm(DigestAlgorithm::SHA256)
  , m_info(signatureInfo)
  , m_signedInterestFormat(SignedInterestFormat::V02)
{
  BOOST_ASSERT(signerType >= SIGNER_TYPE_NULL && signerType <= SIGNER_TYPE_HMAC);
}
 
SigningInfo::SigningInfo(const Identity& identity)
  : SigningInfo(SIGNER_TYPE_NULL)
{
  this->setPibIdentity(identity);
}
 
SigningInfo::SigningInfo(const Key& key)
  : SigningInfo(SIGNER_TYPE_NULL)
{
  this->setPibKey(key);
}
 
SigningInfo::SigningInfo(std::string_view signingStr)
  : SigningInfo(SIGNER_TYPE_NULL)
{
  if (signingStr.empty()) {
    return;
  }
 
  auto pos = signingStr.find(':');
  if (pos == std::string_view::npos) {
    NDN_THROW(std::invalid_argument("Invalid signing string cannot represent SigningInfo"));
  }
 
  auto scheme = signingStr.substr(0, pos);
  auto nameArg = signingStr.substr(pos + 1);
 
  if (scheme == "id") {
    if (nameArg == getDigestSha256Identity().toUri()) {
      setSha256Signing();
    }
    else {
      setSigningIdentity(Name(nameArg));
    }
  }
  else if (scheme == "key") {
    setSigningKeyName(Name(nameArg));
  }
  else if (scheme == "cert") {
    setSigningCertName(Name(nameArg));
  }
  else if (scheme == "hmac-sha256") {
    setSigningHmacKey(nameArg);
    setDigestAlgorithm(DigestAlgorithm::SHA256);
  }
  else {
    NDN_THROW(std::invalid_argument("Invalid signing string scheme"));
  }
}
 
SigningInfo&
SigningInfo::setSigningIdentity(const Name& identity)
{
  m_type = SIGNER_TYPE_ID;
  m_name = identity;
  m_identity = Identity();
  return *this;
}
 
SigningInfo&
SigningInfo::setSigningKeyName(const Name& keyName)
{
  m_type = SIGNER_TYPE_KEY;
  m_name = keyName;
  m_key = Key();
  return *this;
}
 
SigningInfo&
SigningInfo::setSigningCertName(const Name& certificateName)
{
  m_type = SIGNER_TYPE_CERT;
  m_name = certificateName;
  return *this;
}
 
SigningInfo&
SigningInfo::setSigningHmacKey(std::string_view hmacKey)
{
  m_type = SIGNER_TYPE_HMAC;
 
  OBufferStream os;
  transform::bufferSource(hmacKey) >>
    transform::base64Decode(false) >>
    transform::streamSink(os);
  m_hmacKey = make_shared<transform::PrivateKey>();
  m_hmacKey->loadRaw(KeyType::HMAC, *os.buf());
 
  // generate key name
  m_name = getHmacIdentity();
  m_name.append(name::Component(m_hmacKey->getKeyDigest(DigestAlgorithm::SHA256)));
 
  return *this;
}
 
SigningInfo&
SigningInfo::setSha256Signing()
{
  m_type = SIGNER_TYPE_SHA256;
  m_name.clear();
  return *this;
}
 
SigningInfo&
SigningInfo::setPibIdentity(const Identity& identity)
{
  m_type = SIGNER_TYPE_ID;
  m_name = identity ? identity.getName() : Name();
  m_identity = identity;
  return *this;
}
 
SigningInfo&
SigningInfo::setPibKey(const Key& key)
{
  m_type = SIGNER_TYPE_KEY;
  m_name = key ? key.getName() : Name();
  m_key = key;
  return *this;
}
 
SigningInfo&
SigningInfo::setSignatureInfo(const SignatureInfo& signatureInfo)
{
  m_info = signatureInfo;
  return *this;
}
 
std::ostream&
operator<<(std::ostream& os, const SigningInfo& si)
{
  switch (si.getSignerType()) {
    case SigningInfo::SIGNER_TYPE_NULL:
      return os;
    case SigningInfo::SIGNER_TYPE_ID:
      return os << "id:" << si.getSignerName();
    case SigningInfo::SIGNER_TYPE_KEY:
      return os << "key:" << si.getSignerName();
    case SigningInfo::SIGNER_TYPE_CERT:
      return os << "cert:" << si.getSignerName();
    case SigningInfo::SIGNER_TYPE_SHA256:
      return os << "id:" << SigningInfo::getDigestSha256Identity();
    case SigningInfo::SIGNER_TYPE_HMAC:
      return os << "id:" << si.getSignerName();
  }
  return os << "Unknown signer type " << to_underlying(si.getSignerType());
}
 
std::ostream&
operator<<(std::ostream& os, const SignedInterestFormat& format)
{
  switch (format) {
    case SignedInterestFormat::V03:
      return os << "Signed Interest v0.3";
    case SignedInterestFormat::V02:
      return os << "Signed Interest v0.2";
  }
  return os << "Unknown signed Interest format " << to_underlying(format);
}
 
} // namespace ndn::security