blob: 1fc68f9a1a7a2c8d52a23a7fab43bc9197bb8b6a [file] [log] [blame]
Yingdi Yu4a557052014-07-09 16:40:37 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Junxiao Shia9181d72017-08-13 16:47:45 +00002/*
Alexander Afanasyev41469752017-01-10 21:51:55 -08003 * Copyright (c) 2013-2017 Regents of the University of California.
Yingdi Yu4a557052014-07-09 16:40:37 -07004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6 *
7 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20 */
21
22#include "signature-info.hpp"
Alexander Afanasyev15f67312014-07-22 15:11:09 -070023#include "encoding/block-helpers.hpp"
Junxiao Shic2b8d242014-11-04 08:35:29 -070024#include "util/concepts.hpp"
Alexander Afanasyev15f67312014-07-22 15:11:09 -070025
Yingdi Yu4a557052014-07-09 16:40:37 -070026namespace ndn {
27
Junxiao Shic2b8d242014-11-04 08:35:29 -070028BOOST_CONCEPT_ASSERT((boost::EqualityComparable<SignatureInfo>));
29BOOST_CONCEPT_ASSERT((WireEncodable<SignatureInfo>));
Alexander Afanasyevd5c48e02015-06-24 11:58:14 -070030BOOST_CONCEPT_ASSERT((WireEncodableWithEncodingBuffer<SignatureInfo>));
Junxiao Shic2b8d242014-11-04 08:35:29 -070031BOOST_CONCEPT_ASSERT((WireDecodable<SignatureInfo>));
32static_assert(std::is_base_of<tlv::Error, SignatureInfo::Error>::value,
33 "SignatureInfo::Error must inherit from tlv::Error");
34
Yingdi Yu4a557052014-07-09 16:40:37 -070035SignatureInfo::SignatureInfo()
36 : m_type(-1)
37 , m_hasKeyLocator(false)
38{
39}
40
Steve DiBenedetto54ce6682014-07-22 13:22:57 -060041SignatureInfo::SignatureInfo(tlv::SignatureTypeValue type)
Yingdi Yu4a557052014-07-09 16:40:37 -070042 : m_type(type)
43 , m_hasKeyLocator(false)
44{
45}
46
Steve DiBenedetto54ce6682014-07-22 13:22:57 -060047SignatureInfo::SignatureInfo(tlv::SignatureTypeValue type, const KeyLocator& keyLocator)
Yingdi Yu4a557052014-07-09 16:40:37 -070048 : m_type(type)
49 , m_hasKeyLocator(true)
50 , m_keyLocator(keyLocator)
51{
52}
53
54SignatureInfo::SignatureInfo(const Block& block)
55{
56 wireDecode(block);
57}
58
Alexander Afanasyev74633892015-02-08 18:08:46 -080059template<encoding::Tag TAG>
Yingdi Yu4a557052014-07-09 16:40:37 -070060size_t
Alexander Afanasyevd5c48e02015-06-24 11:58:14 -070061SignatureInfo::wireEncode(EncodingImpl<TAG>& encoder) const
Yingdi Yu4a557052014-07-09 16:40:37 -070062{
Junxiao Shia9181d72017-08-13 16:47:45 +000063 // SignatureInfo ::= SIGNATURE-INFO-TLV TLV-LENGTH
64 // SignatureType
65 // KeyLocator?
66 // ValidityPeriod? (if present, stored as first item of m_otherTlvs)
67 // other SignatureType-specific sub-elements*
68
Yingdi Yu4a557052014-07-09 16:40:37 -070069 size_t totalLength = 0;
70
Junxiao Shia9181d72017-08-13 16:47:45 +000071 for (auto i = m_otherTlvs.rbegin(); i != m_otherTlvs.rend(); i++) {
Alexander Afanasyev41469752017-01-10 21:51:55 -080072 totalLength += encoder.prependBlock(*i);
Yingdi Yu4a557052014-07-09 16:40:37 -070073 }
74
75 if (m_hasKeyLocator)
Alexander Afanasyevd5c48e02015-06-24 11:58:14 -070076 totalLength += m_keyLocator.wireEncode(encoder);
Yingdi Yu4a557052014-07-09 16:40:37 -070077
Alexander Afanasyevd5c48e02015-06-24 11:58:14 -070078 totalLength += prependNonNegativeIntegerBlock(encoder, tlv::SignatureType, m_type);
Yingdi Yu4a557052014-07-09 16:40:37 -070079
Alexander Afanasyevd5c48e02015-06-24 11:58:14 -070080 totalLength += encoder.prependVarNumber(totalLength);
81 totalLength += encoder.prependVarNumber(tlv::SignatureInfo);
Yingdi Yu4a557052014-07-09 16:40:37 -070082 return totalLength;
83}
84
85template size_t
Alexander Afanasyevd5c48e02015-06-24 11:58:14 -070086SignatureInfo::wireEncode<encoding::EncoderTag>(EncodingImpl<encoding::EncoderTag>& encoder) const;
Yingdi Yu4a557052014-07-09 16:40:37 -070087
88template size_t
Alexander Afanasyevd5c48e02015-06-24 11:58:14 -070089SignatureInfo::wireEncode<encoding::EstimatorTag>(EncodingImpl<encoding::EstimatorTag>& encoder) const;
Yingdi Yu4a557052014-07-09 16:40:37 -070090
Yingdi Yu4a557052014-07-09 16:40:37 -070091const Block&
92SignatureInfo::wireEncode() const
93{
94 if (m_wire.hasWire())
95 return m_wire;
96
97 EncodingEstimator estimator;
98 size_t estimatedSize = wireEncode(estimator);
99
100 EncodingBuffer buffer(estimatedSize, 0);
101 wireEncode(buffer);
102
103 m_wire = buffer.block();
104 return m_wire;
105}
106
107void
108SignatureInfo::wireDecode(const Block& wire)
109{
Yingdi Yu4a557052014-07-09 16:40:37 -0700110 m_hasKeyLocator = false;
Junxiao Shia9181d72017-08-13 16:47:45 +0000111 m_otherTlvs.clear();
Yingdi Yu4a557052014-07-09 16:40:37 -0700112
113 m_wire = wire;
114 m_wire.parse();
115
Steve DiBenedetto54ce6682014-07-22 13:22:57 -0600116 if (m_wire.type() != tlv::SignatureInfo)
Junxiao Shia9181d72017-08-13 16:47:45 +0000117 BOOST_THROW_EXCEPTION(Error("Decoding SignatureInfo, but TLV-TYPE is " + to_string(m_wire.type())));
Yingdi Yu4a557052014-07-09 16:40:37 -0700118
119 Block::element_const_iterator it = m_wire.elements_begin();
120
121 // the first block must be SignatureType
Steve DiBenedetto54ce6682014-07-22 13:22:57 -0600122 if (it != m_wire.elements_end() && it->type() == tlv::SignatureType) {
Yingdi Yu4a557052014-07-09 16:40:37 -0700123 m_type = readNonNegativeInteger(*it);
Junxiao Shia9181d72017-08-13 16:47:45 +0000124 ++it;
Yingdi Yu4a557052014-07-09 16:40:37 -0700125 }
126 else
Junxiao Shia9181d72017-08-13 16:47:45 +0000127 BOOST_THROW_EXCEPTION(Error("Missing SignatureType in SignatureInfo"));
Yingdi Yu4a557052014-07-09 16:40:37 -0700128
129 // the second block could be KeyLocator
Steve DiBenedetto54ce6682014-07-22 13:22:57 -0600130 if (it != m_wire.elements_end() && it->type() == tlv::KeyLocator) {
Yingdi Yu4a557052014-07-09 16:40:37 -0700131 m_keyLocator.wireDecode(*it);
132 m_hasKeyLocator = true;
Junxiao Shia9181d72017-08-13 16:47:45 +0000133 ++it;
Yingdi Yu4a557052014-07-09 16:40:37 -0700134 }
135
Junxiao Shia9181d72017-08-13 16:47:45 +0000136 // store SignatureType-specific sub-elements, if any
Yingdi Yu4a557052014-07-09 16:40:37 -0700137 while (it != m_wire.elements_end()) {
Zhiyi Zhang387e57b2016-08-01 18:50:00 -0700138 m_otherTlvs.push_back(*it);
Junxiao Shia9181d72017-08-13 16:47:45 +0000139 ++it;
Yingdi Yu4a557052014-07-09 16:40:37 -0700140 }
141}
142
Junxiao Shia9181d72017-08-13 16:47:45 +0000143void
144SignatureInfo::setSignatureType(tlv::SignatureTypeValue type)
Yingdi Yu4a557052014-07-09 16:40:37 -0700145{
Junxiao Shia9181d72017-08-13 16:47:45 +0000146 m_wire.reset();
147 m_type = type;
148}
149
150const KeyLocator&
151SignatureInfo::getKeyLocator() const
152{
153 if (m_hasKeyLocator)
154 return m_keyLocator;
155 else
156 BOOST_THROW_EXCEPTION(Error("KeyLocator does not exist in SignatureInfo"));
157}
158
159void
160SignatureInfo::setKeyLocator(const KeyLocator& keyLocator)
161{
162 m_wire.reset();
163 m_keyLocator = keyLocator;
164 m_hasKeyLocator = true;
165}
166
167void
168SignatureInfo::unsetKeyLocator()
169{
170 m_wire.reset();
171 m_keyLocator = KeyLocator();
172 m_hasKeyLocator = false;
173}
174
175security::ValidityPeriod
176SignatureInfo::getValidityPeriod() const
177{
178 if (m_otherTlvs.empty() || m_otherTlvs.front().type() != tlv::ValidityPeriod) {
179 BOOST_THROW_EXCEPTION(Error("ValidityPeriod does not exist in SignatureInfo"));
180 }
181
182 return security::ValidityPeriod(m_otherTlvs.front());
183}
184
185void
186SignatureInfo::setValidityPeriod(const security::ValidityPeriod& validityPeriod)
187{
188 unsetValidityPeriod();
189 m_otherTlvs.push_front(validityPeriod.wireEncode());
190}
191
192void
193SignatureInfo::unsetValidityPeriod()
194{
195 if (!m_otherTlvs.empty() && m_otherTlvs.front().type() == tlv::ValidityPeriod) {
196 m_otherTlvs.pop_front();
197 m_wire.reset();
198 }
199}
200
201const Block&
202SignatureInfo::getTypeSpecificTlv(uint32_t type) const
203{
204 for (const Block& block : m_otherTlvs) {
205 if (block.type() == type)
206 return block;
207 }
208
209 BOOST_THROW_EXCEPTION(Error("TLV-TYPE " + to_string(type) + " sub-element does not exist in SignatureInfo"));
210}
211
212void
213SignatureInfo::appendTypeSpecificTlv(const Block& block)
214{
215 m_wire.reset();
216 m_otherTlvs.push_back(block);
217}
218
219bool
220operator==(const SignatureInfo& lhs, const SignatureInfo& rhs)
221{
222 return lhs.m_type == rhs.m_type &&
223 lhs.m_hasKeyLocator == rhs.m_hasKeyLocator &&
224 lhs.m_keyLocator == rhs.m_keyLocator &&
225 lhs.m_otherTlvs == rhs.m_otherTlvs;
Yingdi Yu4a557052014-07-09 16:40:37 -0700226}
227
Alexander Afanasyev41469752017-01-10 21:51:55 -0800228std::ostream&
229operator<<(std::ostream& os, const SignatureInfo& info)
230{
231 os << static_cast<tlv::SignatureTypeValue>(info.getSignatureType());
232 if (info.hasKeyLocator()) {
233 os << " " << info.getKeyLocator();
234 }
235 if (!info.m_otherTlvs.empty()) {
236 os << " { ";
237 for (const auto& block : info.m_otherTlvs) {
238 os << block.type() << " ";
239 }
240 os << "}";
241 }
242 return os;
243}
244
Yingdi Yu4a557052014-07-09 16:40:37 -0700245} // namespace ndn