blob: 7ac8404a8c64fedef49797ea69c424758eeb2610 [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2013-2017 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 "key-locator.hpp"
#include "security/validity-period.hpp"
#include <list>
namespace ndn {
/** @brief Represents a SignatureInfo TLV element
*/
class SignatureInfo
{
public:
class Error : public tlv::Error
{
public:
explicit
Error(const std::string& what)
: tlv::Error(what)
{
}
};
/** @brief Create an invalid SignatureInfo
*/
SignatureInfo();
/** @brief Create with specified type
*/
explicit
SignatureInfo(tlv::SignatureTypeValue type);
/** @brief Create with specified type and KeyLocator
*/
SignatureInfo(tlv::SignatureTypeValue type, const KeyLocator& keyLocator);
/** @brief Create from wire encoding
* @throw tlv::Error decode error
*/
explicit
SignatureInfo(const Block& wire);
/** @brief Fast encoding or block size estimation
* @param encoder EncodingEstimator or EncodingBuffer instance
*/
template<encoding::Tag TAG>
size_t
wireEncode(EncodingImpl<TAG>& encoder) const;
/** @brief Encode to wire format
*/
const Block&
wireEncode() const;
/** @brief Decode from wire format
* @throw tlv::Error decode error
*/
void
wireDecode(const Block& wire);
public: // field access
/** @brief Get SignatureType
* @return tlv::SignatureTypeValue, or -1 to indicate invalid SignatureInfo
*/
int32_t
getSignatureType() const
{
return m_type;
}
/** @brief Set SignatureType
*/
void
setSignatureType(tlv::SignatureTypeValue type);
/** @brief Check if KeyLocator exists
*/
bool
hasKeyLocator() const
{
return m_hasKeyLocator;
}
/** @brief Get KeyLocator
* @throw Error KeyLocator does not exist
*/
const KeyLocator&
getKeyLocator() const;
/** @brief Set KeyLocator
*/
void
setKeyLocator(const KeyLocator& keyLocator);
/** @brief Unset KeyLocator
*/
void
unsetKeyLocator();
/** @brief Get ValidityPeriod
* @throw Error ValidityPeriod does not exist
*/
security::ValidityPeriod
getValidityPeriod() const;
/** @brief Set ValidityPeriod
*/
void
setValidityPeriod(const security::ValidityPeriod& validityPeriod);
/** @brief Unset ValidityPeriod
*/
void
unsetValidityPeriod();
/** @brief Get SignatureType-specific sub-element
* @param type TLV-TYPE of sub-element
* @throw Error sub-element of specified type does not exist
*/
const Block&
getTypeSpecificTlv(uint32_t type) const;
/** @brief Append SignatureType-specific sub-element
*/
void
appendTypeSpecificTlv(const Block& element);
private:
int32_t m_type;
bool m_hasKeyLocator;
KeyLocator m_keyLocator;
std::list<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);
};
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