signature-info.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2020 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_SIGNATURE_INFO_HPP
#define NDN_SIGNATURE_INFO_HPP

#include "ndn-cxx/key-locator.hpp"
#include "ndn-cxx/security/validity-period.hpp"

namespace ndn {

class SignatureInfo
{
public:
  class Error : public tlv::Error
  {
  public:
    using tlv::Error::Error;
  };

  enum class Type : uint32_t {
    Data = tlv::SignatureInfo,
    Interest = tlv::InterestSignatureInfo
  };

public:
  SignatureInfo();

  explicit
  SignatureInfo(tlv::SignatureTypeValue type, optional<KeyLocator> keyLocator = nullopt);

  explicit
  SignatureInfo(const Block& wire, Type type = Type::Data);

  explicit
  operator bool() const noexcept
  {
    return m_type != -1;
  }

  template<encoding::Tag TAG>
  size_t
  wireEncode(EncodingImpl<TAG>& encoder, Type type = Type::Data) const;

  const Block&
  wireEncode(Type type = Type::Data) const;

  void
  wireDecode(const Block& wire, Type type = Type::Data);

  bool
  hasWire() const noexcept
  {
    return m_wire.hasWire();
  }

public: // field access
  int32_t
  getSignatureType() const noexcept
  {
    return m_type;
  }

  SignatureInfo&
  setSignatureType(tlv::SignatureTypeValue type);

  bool
  hasKeyLocator() const noexcept
  {
    return m_keyLocator.has_value();
  }

  const KeyLocator&
  getKeyLocator() const;

  SignatureInfo&
  setKeyLocator(optional<KeyLocator> keyLocator);

  [[deprecated("use setKeyLocator(nullopt)")]]
  void
  unsetKeyLocator();

  security::ValidityPeriod
  getValidityPeriod() const;

  SignatureInfo&
  setValidityPeriod(optional<security::ValidityPeriod> validityPeriod);

  [[deprecated("use setValidityPeriod(nullopt)")]]
  void
  unsetValidityPeriod();

  optional<std::vector<uint8_t>>
  getNonce() const;

  SignatureInfo&
  setNonce(optional<std::vector<uint8_t>> nonce);

  optional<time::system_clock::time_point>
  getTime() const;

  SignatureInfo&
  setTime(optional<time::system_clock::time_point> time = time::system_clock::now());

  optional<uint64_t>
  getSeqNum() const;

  SignatureInfo&
  setSeqNum(optional<uint64_t> seqNum);

  optional<Block>
  getCustomTlv(uint32_t type) const;

  void
  addCustomTlv(Block block);

  void
  removeCustomTlv(uint32_t type);

  [[deprecated("use getCustomTlv")]]
  const Block&
  getTypeSpecificTlv(uint32_t type) const;

  [[deprecated("use addCustomTlv")]]
  void
  appendTypeSpecificTlv(const Block& block);

private:
  std::vector<Block>::const_iterator
  findOtherTlv(uint32_t type) const;

private:
  int32_t m_type = -1;
  optional<KeyLocator> m_keyLocator;
  std::vector<Block> m_otherTlvs;

  mutable Block m_wire;

  friend bool
  operator==(const SignatureInfo& lhs, const SignatureInfo& rhs);

  friend std::ostream&
  operator<<(std::ostream& os, const SignatureInfo& info);
};

extern template size_t
SignatureInfo::wireEncode<encoding::EncoderTag>(EncodingBuffer&, SignatureInfo::Type) const;

extern template size_t
SignatureInfo::wireEncode<encoding::EstimatorTag>(EncodingEstimator&, SignatureInfo::Type) const;

bool
operator==(const SignatureInfo& lhs, const SignatureInfo& rhs);

inline bool
operator!=(const SignatureInfo& lhs, const SignatureInfo& rhs)
{
  return !(lhs == rhs);
}

std::ostream&
operator<<(std::ostream& os, const SignatureInfo& info);

} // namespace ndn

#endif // NDN_SIGNATURE_INFO_HPP