signing-info.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_SIGNING_INFO_HPP
#define NDN_CXX_SECURITY_SIGNING_INFO_HPP

#include "ndn-cxx/name.hpp"
#include "ndn-cxx/signature-info.hpp"
#include "ndn-cxx/security/pib/identity.hpp"
#include "ndn-cxx/security/pib/key.hpp"
#include "ndn-cxx/security/security-common.hpp"
#include "ndn-cxx/security/transform/private-key.hpp"

namespace ndn {
namespace security {

enum class SignedInterestFormat {
  V03,
  V02,
};

class SigningInfo
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };

  enum SignerType {
    SIGNER_TYPE_NULL = 0,
    SIGNER_TYPE_ID = 1,
    SIGNER_TYPE_KEY = 2,
    SIGNER_TYPE_CERT = 3,
    SIGNER_TYPE_SHA256 = 4,
    SIGNER_TYPE_HMAC = 5,
  };

public:
  explicit
  SigningInfo(SignerType signerType = SIGNER_TYPE_NULL,
              const Name& signerName = Name(),
              const SignatureInfo& signatureInfo = SignatureInfo());

  explicit
  SigningInfo(const Identity& identity);

  explicit
  SigningInfo(const Key& key);

  explicit
  SigningInfo(const std::string& signingStr);

  SigningInfo&
  setSigningIdentity(const Name& identity);

  SigningInfo&
  setSigningKeyName(const Name& keyName);

  SigningInfo&
  setSigningCertName(const Name& certificateName);

  SigningInfo&
  setSigningHmacKey(const std::string& hmacKey);

  SigningInfo&
  setSha256Signing();

  SigningInfo&
  setPibIdentity(const Identity& identity);

  SigningInfo&
  setPibKey(const Key& key);

  SignerType
  getSignerType() const
  {
    return m_type;
  }

  const Name&
  getSignerName() const
  {
    return m_name;
  }

  const Identity&
  getPibIdentity() const
  {
    BOOST_ASSERT(m_type == SIGNER_TYPE_ID);
    return m_identity;
  }

  const Key&
  getPibKey() const
  {
    BOOST_ASSERT(m_type == SIGNER_TYPE_KEY);
    return m_key;
  }

  shared_ptr<transform::PrivateKey>
  getHmacKey() const
  {
    BOOST_ASSERT(m_type == SIGNER_TYPE_HMAC);
    return m_hmacKey;
  }

  SigningInfo&
  setDigestAlgorithm(const DigestAlgorithm& algorithm)
  {
    m_digestAlgorithm = algorithm;
    return *this;
  }

  DigestAlgorithm
  getDigestAlgorithm() const
  {
    return m_digestAlgorithm;
  }

  SigningInfo&
  setSignatureInfo(const SignatureInfo& signatureInfo);

  const SignatureInfo&
  getSignatureInfo() const
  {
    return m_info;
  }

  SigningInfo&
  setSignedInterestFormat(SignedInterestFormat signedInterestFormat)
  {
    m_signedInterestFormat = signedInterestFormat;
    return *this;
  }

  SignedInterestFormat
  getSignedInterestFormat() const
  {
    return m_signedInterestFormat;
  }

public:
  static const Name&
  getDigestSha256Identity();

  static const Name&
  getHmacIdentity();

private: // non-member operators
  // NOTE: the following "hidden friend" operators are available via
  //       argument-dependent lookup only and must be defined inline.

  friend bool
  operator==(const SigningInfo& lhs, const SigningInfo& rhs)
  {
    return !(lhs != rhs);
  }

  friend bool
  operator!=(const SigningInfo& lhs, const SigningInfo& rhs)
  {
    return lhs.m_type != rhs.m_type ||
           lhs.m_name != rhs.m_name ||
           lhs.m_digestAlgorithm != rhs.m_digestAlgorithm ||
           lhs.m_info != rhs.m_info ||
           lhs.m_signedInterestFormat != rhs.m_signedInterestFormat;
  }

private:
  SignerType m_type;
  Name m_name;
  Identity m_identity;
  Key m_key;
  shared_ptr<transform::PrivateKey> m_hmacKey;
  DigestAlgorithm m_digestAlgorithm;
  SignatureInfo m_info;
  SignedInterestFormat m_signedInterestFormat;
};

std::ostream&
operator<<(std::ostream& os, const SigningInfo& si);

std::ostream&
operator<<(std::ostream& os, const SignedInterestFormat& format);

} // namespace security
} // namespace ndn

#endif // NDN_CXX_SECURITY_SIGNING_INFO_HPP