Alexander Afanasyev | c169a81 | 2014-05-20 20:37:29 -0400 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 2 | /* |
Davide Pesavento | fcd3e44 | 2023-03-10 18:44:11 -0500 | [diff] [blame] | 3 | * Copyright (c) 2013-2023 Regents of the University of California. |
Alexander Afanasyev | dfa52c4 | 2014-04-24 21:10:11 -0700 | [diff] [blame] | 4 | * |
| 5 | * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions). |
Alexander Afanasyev | dfa52c4 | 2014-04-24 21:10:11 -0700 | [diff] [blame] | 6 | * |
Alexander Afanasyev | c169a81 | 2014-05-20 20:37:29 -0400 | [diff] [blame] | 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. |
Jeff Thompson | b7f9556 | 2013-07-03 18:36:42 -0700 | [diff] [blame] | 20 | */ |
| 21 | |
Davide Pesavento | 7e78064 | 2018-11-24 15:51:34 -0500 | [diff] [blame] | 22 | #include "ndn-cxx/interest.hpp" |
| 23 | #include "ndn-cxx/data.hpp" |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 24 | #include "ndn-cxx/encoding/buffer-stream.hpp" |
| 25 | #include "ndn-cxx/security/transform/digest-filter.hpp" |
| 26 | #include "ndn-cxx/security/transform/step-source.hpp" |
| 27 | #include "ndn-cxx/security/transform/stream-sink.hpp" |
Davide Pesavento | 7e78064 | 2018-11-24 15:51:34 -0500 | [diff] [blame] | 28 | #include "ndn-cxx/util/random.hpp" |
Alexander Afanasyev | 840139f | 2013-12-28 15:02:50 -0800 | [diff] [blame] | 29 | |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 30 | #include <boost/range/adaptor/reversed.hpp> |
| 31 | |
Davide Pesavento | e178989 | 2017-02-26 15:50:52 -0500 | [diff] [blame] | 32 | #include <cstring> |
Davide Pesavento | a84f464 | 2017-08-23 16:14:51 -0400 | [diff] [blame] | 33 | #include <sstream> |
Davide Pesavento | e178989 | 2017-02-26 15:50:52 -0500 | [diff] [blame] | 34 | |
Jeff Thompson | b7f9556 | 2013-07-03 18:36:42 -0700 | [diff] [blame] | 35 | namespace ndn { |
Alexander Afanasyev | 8468198 | 2014-01-03 13:26:09 -0800 | [diff] [blame] | 36 | |
Junxiao Shi | c2b8d24 | 2014-11-04 08:35:29 -0700 | [diff] [blame] | 37 | BOOST_CONCEPT_ASSERT((WireEncodable<Interest>)); |
Alexander Afanasyev | d5c48e0 | 2015-06-24 11:58:14 -0700 | [diff] [blame] | 38 | BOOST_CONCEPT_ASSERT((WireEncodableWithEncodingBuffer<Interest>)); |
Junxiao Shi | c2b8d24 | 2014-11-04 08:35:29 -0700 | [diff] [blame] | 39 | BOOST_CONCEPT_ASSERT((WireDecodable<Interest>)); |
| 40 | static_assert(std::is_base_of<tlv::Error, Interest::Error>::value, |
| 41 | "Interest::Error must inherit from tlv::Error"); |
| 42 | |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 43 | bool Interest::s_autoCheckParametersDigest = true; |
Junxiao Shi | b55e5d3 | 2018-07-18 13:32:00 -0600 | [diff] [blame] | 44 | |
Junxiao Shi | 8d3f834 | 2018-04-04 12:46:37 +0000 | [diff] [blame] | 45 | Interest::Interest(const Name& name, time::milliseconds lifetime) |
Junxiao Shi | 2af905b | 2014-11-27 13:10:54 -0700 | [diff] [blame] | 46 | { |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 47 | setName(name); |
| 48 | setInterestLifetime(lifetime); |
Junxiao Shi | 2af905b | 2014-11-27 13:10:54 -0700 | [diff] [blame] | 49 | } |
| 50 | |
Junxiao Shi | 2af905b | 2014-11-27 13:10:54 -0700 | [diff] [blame] | 51 | Interest::Interest(const Block& wire) |
| 52 | { |
| 53 | wireDecode(wire); |
| 54 | } |
| 55 | |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 56 | // ---- encode and decode ---- |
Alexander Afanasyev | 840139f | 2013-12-28 15:02:50 -0800 | [diff] [blame] | 57 | |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 58 | template<encoding::Tag TAG> |
| 59 | size_t |
| 60 | Interest::wireEncode(EncodingImpl<TAG>& encoder) const |
| 61 | { |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 62 | // Interest = INTEREST-TYPE TLV-LENGTH |
| 63 | // Name |
| 64 | // [CanBePrefix] |
| 65 | // [MustBeFresh] |
| 66 | // [ForwardingHint] |
| 67 | // [Nonce] |
| 68 | // [InterestLifetime] |
| 69 | // [HopLimit] |
| 70 | // [ApplicationParameters [InterestSignature]] |
| 71 | // (elements are encoded in reverse order) |
| 72 | |
| 73 | // sanity check of ApplicationParameters and ParametersSha256DigestComponent |
| 74 | ssize_t digestIndex = findParametersDigestComponent(getName()); |
| 75 | BOOST_ASSERT(digestIndex != -2); // guaranteed by the checks in setName() and wireDecode() |
| 76 | if (digestIndex == -1) { |
| 77 | if (hasApplicationParameters()) |
| 78 | NDN_THROW(Error("Interest with parameters must have a ParametersSha256DigestComponent")); |
| 79 | } |
| 80 | else if (!hasApplicationParameters()) { |
| 81 | NDN_THROW(Error("Interest without parameters must not have a ParametersSha256DigestComponent")); |
| 82 | } |
| 83 | |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 84 | size_t totalLength = 0; |
| 85 | |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 86 | // ApplicationParameters and following elements (in reverse order) |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 87 | for (const auto& block : m_parameters | boost::adaptors::reversed) { |
Davide Pesavento | fbea4fc | 2022-02-08 07:26:04 -0500 | [diff] [blame] | 88 | totalLength += prependBlock(encoder, block); |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 89 | } |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 90 | |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 91 | // HopLimit |
| 92 | if (getHopLimit()) { |
Davide Pesavento | fbea4fc | 2022-02-08 07:26:04 -0500 | [diff] [blame] | 93 | totalLength += prependBinaryBlock(encoder, tlv::HopLimit, {*m_hopLimit}); |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 94 | } |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 95 | |
| 96 | // InterestLifetime |
| 97 | if (getInterestLifetime() != DEFAULT_INTEREST_LIFETIME) { |
Davide Pesavento | 9c19a39 | 2019-04-06 15:07:54 -0400 | [diff] [blame] | 98 | totalLength += prependNonNegativeIntegerBlock(encoder, tlv::InterestLifetime, |
| 99 | static_cast<uint64_t>(getInterestLifetime().count())); |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | // Nonce |
Davide Pesavento | 5353394 | 2020-03-04 23:10:06 -0500 | [diff] [blame] | 103 | getNonce(); // if nonce was unset, this generates a fresh nonce |
| 104 | BOOST_ASSERT(hasNonce()); |
Davide Pesavento | fbea4fc | 2022-02-08 07:26:04 -0500 | [diff] [blame] | 105 | totalLength += prependBinaryBlock(encoder, tlv::Nonce, *m_nonce); |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 106 | |
| 107 | // ForwardingHint |
Junxiao Shi | e4603e1 | 2022-01-05 19:12:25 +0000 | [diff] [blame] | 108 | if (!m_forwardingHint.empty()) { |
| 109 | totalLength += prependNestedBlock(encoder, tlv::ForwardingHint, |
| 110 | m_forwardingHint.begin(), m_forwardingHint.end()); |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | // MustBeFresh |
| 114 | if (getMustBeFresh()) { |
| 115 | totalLength += prependEmptyBlock(encoder, tlv::MustBeFresh); |
| 116 | } |
| 117 | |
| 118 | // CanBePrefix |
| 119 | if (getCanBePrefix()) { |
| 120 | totalLength += prependEmptyBlock(encoder, tlv::CanBePrefix); |
| 121 | } |
| 122 | |
| 123 | // Name |
| 124 | totalLength += getName().wireEncode(encoder); |
| 125 | |
| 126 | totalLength += encoder.prependVarNumber(totalLength); |
| 127 | totalLength += encoder.prependVarNumber(tlv::Interest); |
| 128 | return totalLength; |
| 129 | } |
| 130 | |
Davide Pesavento | 88a0d81 | 2017-08-19 21:31:42 -0400 | [diff] [blame] | 131 | NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(Interest); |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 132 | |
| 133 | const Block& |
| 134 | Interest::wireEncode() const |
Alexander Afanasyev | e881e93 | 2014-06-08 14:47:03 +0300 | [diff] [blame] | 135 | { |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 136 | if (m_wire.hasWire()) |
| 137 | return m_wire; |
| 138 | |
| 139 | EncodingEstimator estimator; |
| 140 | size_t estimatedSize = wireEncode(estimator); |
| 141 | |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 142 | EncodingBuffer encoder(estimatedSize, 0); |
| 143 | wireEncode(encoder); |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 144 | |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 145 | const_cast<Interest*>(this)->wireDecode(encoder.block()); |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 146 | return m_wire; |
Alexander Afanasyev | e881e93 | 2014-06-08 14:47:03 +0300 | [diff] [blame] | 147 | } |
Alexander Afanasyev | 840139f | 2013-12-28 15:02:50 -0800 | [diff] [blame] | 148 | |
Alexander Afanasyev | c393217 | 2014-07-10 18:53:56 -0700 | [diff] [blame] | 149 | void |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 150 | Interest::wireDecode(const Block& wire) |
Alexander Afanasyev | c393217 | 2014-07-10 18:53:56 -0700 | [diff] [blame] | 151 | { |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 152 | if (wire.type() != tlv::Interest) { |
| 153 | NDN_THROW(Error("Interest", wire.type())); |
| 154 | } |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 155 | m_wire = wire; |
| 156 | m_wire.parse(); |
Alexander Afanasyev | c393217 | 2014-07-10 18:53:56 -0700 | [diff] [blame] | 157 | |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 158 | // Interest = INTEREST-TYPE TLV-LENGTH |
| 159 | // Name |
| 160 | // [CanBePrefix] |
| 161 | // [MustBeFresh] |
| 162 | // [ForwardingHint] |
| 163 | // [Nonce] |
| 164 | // [InterestLifetime] |
| 165 | // [HopLimit] |
| 166 | // [ApplicationParameters [InterestSignature]] |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 167 | |
Junxiao Shi | 8b753a2 | 2018-10-24 01:51:40 +0000 | [diff] [blame] | 168 | auto element = m_wire.elements_begin(); |
| 169 | if (element == m_wire.elements_end() || element->type() != tlv::Name) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 170 | NDN_THROW(Error("Name element is missing or out of order")); |
Junxiao Shi | 8b753a2 | 2018-10-24 01:51:40 +0000 | [diff] [blame] | 171 | } |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 172 | // decode into a temporary object until we determine that the name is valid, in order |
| 173 | // to maintain class invariants and thus provide a basic form of exception safety |
| 174 | Name tempName(*element); |
| 175 | if (tempName.empty()) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 176 | NDN_THROW(Error("Name has zero name components")); |
Junxiao Shi | 8b753a2 | 2018-10-24 01:51:40 +0000 | [diff] [blame] | 177 | } |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 178 | ssize_t digestIndex = findParametersDigestComponent(tempName); |
| 179 | if (digestIndex == -2) { |
| 180 | NDN_THROW(Error("Name has more than one ParametersSha256DigestComponent")); |
| 181 | } |
| 182 | m_name = std::move(tempName); |
Junxiao Shi | 8b753a2 | 2018-10-24 01:51:40 +0000 | [diff] [blame] | 183 | |
Davide Pesavento | 0e0b389 | 2019-07-30 21:05:05 -0400 | [diff] [blame] | 184 | m_canBePrefix = m_mustBeFresh = false; |
Junxiao Shi | e4603e1 | 2022-01-05 19:12:25 +0000 | [diff] [blame] | 185 | m_forwardingHint.clear(); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 186 | m_nonce.reset(); |
| 187 | m_interestLifetime = DEFAULT_INTEREST_LIFETIME; |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 188 | m_hopLimit.reset(); |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 189 | m_parameters.clear(); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 190 | |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 191 | int lastElement = 1; // last recognized element index, in spec order |
Junxiao Shi | 8b753a2 | 2018-10-24 01:51:40 +0000 | [diff] [blame] | 192 | for (++element; element != m_wire.elements_end(); ++element) { |
| 193 | switch (element->type()) { |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 194 | case tlv::CanBePrefix: { |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 195 | if (lastElement >= 2) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 196 | NDN_THROW(Error("CanBePrefix element is out of order")); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 197 | } |
Junxiao Shi | 8b753a2 | 2018-10-24 01:51:40 +0000 | [diff] [blame] | 198 | if (element->value_size() != 0) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 199 | NDN_THROW(Error("CanBePrefix element has non-zero TLV-LENGTH")); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 200 | } |
Davide Pesavento | 0e0b389 | 2019-07-30 21:05:05 -0400 | [diff] [blame] | 201 | m_canBePrefix = true; |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 202 | lastElement = 2; |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 203 | break; |
| 204 | } |
| 205 | case tlv::MustBeFresh: { |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 206 | if (lastElement >= 3) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 207 | NDN_THROW(Error("MustBeFresh element is out of order")); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 208 | } |
Junxiao Shi | 8b753a2 | 2018-10-24 01:51:40 +0000 | [diff] [blame] | 209 | if (element->value_size() != 0) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 210 | NDN_THROW(Error("MustBeFresh element has non-zero TLV-LENGTH")); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 211 | } |
Davide Pesavento | 0e0b389 | 2019-07-30 21:05:05 -0400 | [diff] [blame] | 212 | m_mustBeFresh = true; |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 213 | lastElement = 3; |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 214 | break; |
| 215 | } |
| 216 | case tlv::ForwardingHint: { |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 217 | if (lastElement >= 4) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 218 | NDN_THROW(Error("ForwardingHint element is out of order")); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 219 | } |
Davide Pesavento | 90795be | 2022-11-30 16:26:52 -0500 | [diff] [blame] | 220 | // Current format: |
| 221 | // ForwardingHint = FORWARDING-HINT-TYPE TLV-LENGTH 1*Name |
| 222 | // Previous format, partially supported for backward compatibility: |
| 223 | // ForwardingHint = FORWARDING-HINT-TYPE TLV-LENGTH 1*Delegation |
| 224 | // Delegation = DELEGATION-TYPE TLV-LENGTH Preference Name |
Junxiao Shi | e4603e1 | 2022-01-05 19:12:25 +0000 | [diff] [blame] | 225 | element->parse(); |
| 226 | for (const auto& del : element->elements()) { |
| 227 | switch (del.type()) { |
| 228 | case tlv::Name: |
| 229 | try { |
| 230 | m_forwardingHint.emplace_back(del); |
| 231 | } |
| 232 | catch (const tlv::Error&) { |
| 233 | NDN_THROW_NESTED(Error("Invalid Name in ForwardingHint")); |
| 234 | } |
| 235 | break; |
Davide Pesavento | 90795be | 2022-11-30 16:26:52 -0500 | [diff] [blame] | 236 | case 31: // Delegation |
| 237 | // old ForwardingHint format, try to parse the nested Name for compatibility |
Junxiao Shi | e4603e1 | 2022-01-05 19:12:25 +0000 | [diff] [blame] | 238 | try { |
| 239 | del.parse(); |
| 240 | m_forwardingHint.emplace_back(del.get(tlv::Name)); |
| 241 | } |
| 242 | catch (const tlv::Error&) { |
| 243 | NDN_THROW_NESTED(Error("Invalid Name in ForwardingHint.Delegation")); |
| 244 | } |
| 245 | break; |
| 246 | default: |
| 247 | if (tlv::isCriticalType(del.type())) { |
| 248 | NDN_THROW(Error("Unexpected TLV-TYPE " + to_string(del.type()) + " while decoding ForwardingHint")); |
| 249 | } |
| 250 | break; |
| 251 | } |
| 252 | } |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 253 | lastElement = 4; |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 254 | break; |
| 255 | } |
| 256 | case tlv::Nonce: { |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 257 | if (lastElement >= 5) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 258 | NDN_THROW(Error("Nonce element is out of order")); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 259 | } |
Davide Pesavento | 5353394 | 2020-03-04 23:10:06 -0500 | [diff] [blame] | 260 | if (element->value_size() != Nonce().size()) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 261 | NDN_THROW(Error("Nonce element is malformed")); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 262 | } |
Davide Pesavento | 5353394 | 2020-03-04 23:10:06 -0500 | [diff] [blame] | 263 | m_nonce.emplace(); |
| 264 | std::memcpy(m_nonce->data(), element->value(), m_nonce->size()); |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 265 | lastElement = 5; |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 266 | break; |
| 267 | } |
| 268 | case tlv::InterestLifetime: { |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 269 | if (lastElement >= 6) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 270 | NDN_THROW(Error("InterestLifetime element is out of order")); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 271 | } |
Junxiao Shi | 8b753a2 | 2018-10-24 01:51:40 +0000 | [diff] [blame] | 272 | m_interestLifetime = time::milliseconds(readNonNegativeInteger(*element)); |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 273 | lastElement = 6; |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 274 | break; |
| 275 | } |
| 276 | case tlv::HopLimit: { |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 277 | if (lastElement >= 7) { |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 278 | break; // HopLimit is non-critical, ignore out-of-order appearance |
| 279 | } |
Junxiao Shi | 8b753a2 | 2018-10-24 01:51:40 +0000 | [diff] [blame] | 280 | if (element->value_size() != 1) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 281 | NDN_THROW(Error("HopLimit element is malformed")); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 282 | } |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 283 | m_hopLimit = *element->value(); |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 284 | lastElement = 7; |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 285 | break; |
| 286 | } |
Davide Pesavento | 9c19a39 | 2019-04-06 15:07:54 -0400 | [diff] [blame] | 287 | case tlv::ApplicationParameters: { |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 288 | if (lastElement >= 8) { |
Davide Pesavento | 9c19a39 | 2019-04-06 15:07:54 -0400 | [diff] [blame] | 289 | break; // ApplicationParameters is non-critical, ignore out-of-order appearance |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 290 | } |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 291 | BOOST_ASSERT(!hasApplicationParameters()); |
| 292 | m_parameters.push_back(*element); |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 293 | lastElement = 8; |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 294 | break; |
| 295 | } |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 296 | default: { // unrecognized element |
| 297 | // if the TLV-TYPE is critical, abort decoding |
Junxiao Shi | 8b753a2 | 2018-10-24 01:51:40 +0000 | [diff] [blame] | 298 | if (tlv::isCriticalType(element->type())) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 299 | NDN_THROW(Error("Unrecognized element of critical type " + to_string(element->type()))); |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 300 | } |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 301 | // if we already encountered ApplicationParameters, store this element as parameter |
| 302 | if (hasApplicationParameters()) { |
| 303 | m_parameters.push_back(*element); |
| 304 | } |
| 305 | // otherwise, ignore it |
Junxiao Shi | 6efa3b7 | 2018-04-14 15:54:08 +0000 | [diff] [blame] | 306 | break; |
| 307 | } |
| 308 | } |
| 309 | } |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 310 | |
| 311 | if (s_autoCheckParametersDigest && !isParametersDigestValid()) { |
| 312 | NDN_THROW(Error("ParametersSha256DigestComponent does not match the SHA-256 of Interest parameters")); |
| 313 | } |
Alexander Afanasyev | c393217 | 2014-07-10 18:53:56 -0700 | [diff] [blame] | 314 | } |
| 315 | |
Davide Pesavento | a84f464 | 2017-08-23 16:14:51 -0400 | [diff] [blame] | 316 | std::string |
| 317 | Interest::toUri() const |
| 318 | { |
| 319 | std::ostringstream os; |
| 320 | os << *this; |
| 321 | return os.str(); |
| 322 | } |
| 323 | |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 324 | // ---- matching ---- |
| 325 | |
Alexander Afanasyev | 8468198 | 2014-01-03 13:26:09 -0800 | [diff] [blame] | 326 | bool |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 327 | Interest::matchesData(const Data& data) const |
| 328 | { |
Junxiao Shi | 42c2362 | 2014-07-03 00:55:11 -0700 | [diff] [blame] | 329 | size_t interestNameLength = m_name.size(); |
| 330 | const Name& dataName = data.getName(); |
| 331 | size_t fullNameLength = dataName.size() + 1; |
| 332 | |
Junxiao Shi | 2ad2fbe | 2019-05-24 03:11:05 +0000 | [diff] [blame] | 333 | // check Name and CanBePrefix |
Junxiao Shi | 42c2362 | 2014-07-03 00:55:11 -0700 | [diff] [blame] | 334 | if (interestNameLength == fullNameLength) { |
Alexander Afanasyev | 56860f5 | 2014-11-07 11:51:17 -0800 | [diff] [blame] | 335 | if (m_name.get(-1).isImplicitSha256Digest()) { |
Junxiao Shi | 2ad2fbe | 2019-05-24 03:11:05 +0000 | [diff] [blame] | 336 | if (m_name != data.getFullName()) { |
Junxiao Shi | 42c2362 | 2014-07-03 00:55:11 -0700 | [diff] [blame] | 337 | return false; |
Junxiao Shi | 2ad2fbe | 2019-05-24 03:11:05 +0000 | [diff] [blame] | 338 | } |
Junxiao Shi | 42c2362 | 2014-07-03 00:55:11 -0700 | [diff] [blame] | 339 | } |
| 340 | else { |
| 341 | // Interest Name is same length as Data full Name, but last component isn't digest |
| 342 | // so there's no possibility of matching |
| 343 | return false; |
| 344 | } |
| 345 | } |
Junxiao Shi | 2ad2fbe | 2019-05-24 03:11:05 +0000 | [diff] [blame] | 346 | else if (getCanBePrefix() ? !m_name.isPrefixOf(dataName) : (m_name != dataName)) { |
| 347 | return false; |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 348 | } |
| 349 | |
Junxiao Shi | 2ad2fbe | 2019-05-24 03:11:05 +0000 | [diff] [blame] | 350 | // check MustBeFresh |
| 351 | if (getMustBeFresh() && data.getFreshnessPeriod() <= 0_ms) { |
| 352 | return false; |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 353 | } |
| 354 | |
| 355 | return true; |
| 356 | } |
| 357 | |
Alexander Afanasyev | 1013fd0 | 2017-01-03 13:19:03 -0800 | [diff] [blame] | 358 | bool |
| 359 | Interest::matchesInterest(const Interest& other) const |
| 360 | { |
Junxiao Shi | 2ad2fbe | 2019-05-24 03:11:05 +0000 | [diff] [blame] | 361 | return getName() == other.getName() && |
| 362 | getCanBePrefix() == other.getCanBePrefix() && |
| 363 | getMustBeFresh() == other.getMustBeFresh(); |
Alexander Afanasyev | 1013fd0 | 2017-01-03 13:19:03 -0800 | [diff] [blame] | 364 | } |
| 365 | |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 366 | // ---- field accessors and modifiers ---- |
| 367 | |
| 368 | Interest& |
| 369 | Interest::setName(const Name& name) |
| 370 | { |
| 371 | ssize_t digestIndex = findParametersDigestComponent(name); |
| 372 | if (digestIndex == -2) { |
| 373 | NDN_THROW(std::invalid_argument("Name cannot have more than one ParametersSha256DigestComponent")); |
| 374 | } |
Davide Pesavento | 81bd696 | 2020-06-17 16:03:23 -0400 | [diff] [blame] | 375 | |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 376 | if (name != m_name) { |
| 377 | m_name = name; |
| 378 | if (hasApplicationParameters()) { |
| 379 | addOrReplaceParametersDigestComponent(); |
| 380 | } |
| 381 | m_wire.reset(); |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 382 | } |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 383 | return *this; |
| 384 | } |
| 385 | |
| 386 | Interest& |
Junxiao Shi | e4603e1 | 2022-01-05 19:12:25 +0000 | [diff] [blame] | 387 | Interest::setForwardingHint(std::vector<Name> value) |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 388 | { |
Junxiao Shi | e4603e1 | 2022-01-05 19:12:25 +0000 | [diff] [blame] | 389 | m_forwardingHint = std::move(value); |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 390 | m_wire.reset(); |
| 391 | return *this; |
| 392 | } |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 393 | |
Davide Pesavento | 5353394 | 2020-03-04 23:10:06 -0500 | [diff] [blame] | 394 | static auto |
| 395 | generateNonce() |
| 396 | { |
| 397 | uint32_t r = random::generateWord32(); |
| 398 | Interest::Nonce n; |
| 399 | std::memcpy(n.data(), &r, sizeof(r)); |
| 400 | return n; |
| 401 | } |
| 402 | |
| 403 | Interest::Nonce |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 404 | Interest::getNonce() const |
| 405 | { |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 406 | if (!hasNonce()) { |
Davide Pesavento | 5353394 | 2020-03-04 23:10:06 -0500 | [diff] [blame] | 407 | m_nonce = generateNonce(); |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 408 | m_wire.reset(); |
Junxiao Shi | c2ac5d2 | 2017-07-17 22:18:31 +0000 | [diff] [blame] | 409 | } |
Junxiao Shi | 2dd711d | 2017-07-21 13:40:52 +0000 | [diff] [blame] | 410 | return *m_nonce; |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 411 | } |
| 412 | |
| 413 | Interest& |
Davide Pesavento | f6b4589 | 2023-03-13 15:00:51 -0400 | [diff] [blame^] | 414 | Interest::setNonce(std::optional<Interest::Nonce> nonce) |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 415 | { |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 416 | if (nonce != m_nonce) { |
| 417 | m_nonce = nonce; |
| 418 | m_wire.reset(); |
| 419 | } |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 420 | return *this; |
| 421 | } |
| 422 | |
| 423 | void |
| 424 | Interest::refreshNonce() |
| 425 | { |
| 426 | if (!hasNonce()) |
| 427 | return; |
| 428 | |
Davide Pesavento | 5353394 | 2020-03-04 23:10:06 -0500 | [diff] [blame] | 429 | auto oldNonce = *m_nonce; |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 430 | while (m_nonce == oldNonce) |
Davide Pesavento | 5353394 | 2020-03-04 23:10:06 -0500 | [diff] [blame] | 431 | m_nonce = generateNonce(); |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 432 | |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 433 | m_wire.reset(); |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 434 | } |
| 435 | |
Eric Newberry | b555b00 | 2017-05-17 00:30:44 -0700 | [diff] [blame] | 436 | Interest& |
Junxiao Shi | 8d3f834 | 2018-04-04 12:46:37 +0000 | [diff] [blame] | 437 | Interest::setInterestLifetime(time::milliseconds lifetime) |
Eric Newberry | b555b00 | 2017-05-17 00:30:44 -0700 | [diff] [blame] | 438 | { |
Davide Pesavento | fccb2dc | 2019-02-09 01:02:35 -0500 | [diff] [blame] | 439 | if (lifetime < 0_ms) { |
Davide Pesavento | 923ba44 | 2019-02-12 22:00:38 -0500 | [diff] [blame] | 440 | NDN_THROW(std::invalid_argument("InterestLifetime must be >= 0")); |
Eric Newberry | b555b00 | 2017-05-17 00:30:44 -0700 | [diff] [blame] | 441 | } |
Davide Pesavento | 81bd696 | 2020-06-17 16:03:23 -0400 | [diff] [blame] | 442 | |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 443 | if (lifetime != m_interestLifetime) { |
| 444 | m_interestLifetime = lifetime; |
| 445 | m_wire.reset(); |
| 446 | } |
Eric Newberry | b555b00 | 2017-05-17 00:30:44 -0700 | [diff] [blame] | 447 | return *this; |
| 448 | } |
| 449 | |
Junxiao Shi | 9c154cb | 2017-07-07 22:14:54 +0000 | [diff] [blame] | 450 | Interest& |
Davide Pesavento | f6b4589 | 2023-03-13 15:00:51 -0400 | [diff] [blame^] | 451 | Interest::setHopLimit(std::optional<uint8_t> hopLimit) |
Junxiao Shi | 9c154cb | 2017-07-07 22:14:54 +0000 | [diff] [blame] | 452 | { |
Davide Pesavento | 2b0cc7b | 2019-07-14 16:50:04 -0400 | [diff] [blame] | 453 | if (hopLimit != m_hopLimit) { |
| 454 | m_hopLimit = hopLimit; |
| 455 | m_wire.reset(); |
| 456 | } |
Junxiao Shi | 9c154cb | 2017-07-07 22:14:54 +0000 | [diff] [blame] | 457 | return *this; |
| 458 | } |
| 459 | |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 460 | Interest& |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 461 | Interest::setApplicationParametersInternal(Block parameters) |
| 462 | { |
| 463 | parameters.encode(); // ensure we have wire encoding needed by computeParametersDigest() |
| 464 | if (m_parameters.empty()) { |
| 465 | m_parameters.push_back(std::move(parameters)); |
| 466 | } |
| 467 | else { |
| 468 | BOOST_ASSERT(m_parameters[0].type() == tlv::ApplicationParameters); |
| 469 | m_parameters[0] = std::move(parameters); |
| 470 | } |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 471 | |
| 472 | addOrReplaceParametersDigestComponent(); |
| 473 | m_wire.reset(); |
| 474 | return *this; |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 475 | } |
| 476 | |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 477 | Interest& |
Davide Pesavento | 9c19a39 | 2019-04-06 15:07:54 -0400 | [diff] [blame] | 478 | Interest::setApplicationParameters(const Block& parameters) |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 479 | { |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 480 | if (!parameters.isValid()) { |
Davide Pesavento | 81bd696 | 2020-06-17 16:03:23 -0400 | [diff] [blame] | 481 | NDN_THROW(std::invalid_argument("ApplicationParameters block must be valid")); |
Davide Pesavento | 3891244 | 2019-04-06 22:03:39 -0400 | [diff] [blame] | 482 | } |
Davide Pesavento | 81bd696 | 2020-06-17 16:03:23 -0400 | [diff] [blame] | 483 | |
| 484 | if (parameters.type() == tlv::ApplicationParameters) { |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 485 | return setApplicationParametersInternal(parameters); |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 486 | } |
| 487 | else { |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 488 | return setApplicationParametersInternal({tlv::ApplicationParameters, parameters}); |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 489 | } |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 490 | } |
| 491 | |
| 492 | Interest& |
Davide Pesavento | a3d809e | 2022-02-06 11:55:02 -0500 | [diff] [blame] | 493 | Interest::setApplicationParameters(span<const uint8_t> value) |
| 494 | { |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 495 | return setApplicationParametersInternal(makeBinaryBlock(tlv::ApplicationParameters, value)); |
Davide Pesavento | a3d809e | 2022-02-06 11:55:02 -0500 | [diff] [blame] | 496 | } |
| 497 | |
| 498 | Interest& |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 499 | Interest::setApplicationParameters(ConstBufferPtr value) |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 500 | { |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 501 | if (value == nullptr) { |
Davide Pesavento | 3891244 | 2019-04-06 22:03:39 -0400 | [diff] [blame] | 502 | NDN_THROW(std::invalid_argument("ApplicationParameters buffer cannot be nullptr")); |
| 503 | } |
Davide Pesavento | 81bd696 | 2020-06-17 16:03:23 -0400 | [diff] [blame] | 504 | |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 505 | return setApplicationParametersInternal({tlv::ApplicationParameters, std::move(value)}); |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 506 | } |
| 507 | |
| 508 | Interest& |
Davide Pesavento | 9c19a39 | 2019-04-06 15:07:54 -0400 | [diff] [blame] | 509 | Interest::unsetApplicationParameters() |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 510 | { |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 511 | m_parameters.clear(); |
| 512 | ssize_t digestIndex = findParametersDigestComponent(getName()); |
| 513 | if (digestIndex >= 0) { |
| 514 | m_name.erase(digestIndex); |
| 515 | } |
Arthi Padmanabhan | b38664e | 2018-07-18 11:13:12 -0700 | [diff] [blame] | 516 | m_wire.reset(); |
| 517 | return *this; |
| 518 | } |
| 519 | |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 520 | bool |
| 521 | Interest::isSigned() const noexcept |
| 522 | { |
| 523 | return m_parameters.size() >= 3 && |
| 524 | getSignatureInfo().has_value() && |
| 525 | getSignatureValue().isValid() && |
| 526 | !m_name.empty() && |
| 527 | m_name[-1].type() == tlv::ParametersSha256DigestComponent; |
| 528 | } |
| 529 | |
Davide Pesavento | f6b4589 | 2023-03-13 15:00:51 -0400 | [diff] [blame^] | 530 | std::optional<SignatureInfo> |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 531 | Interest::getSignatureInfo() const |
| 532 | { |
| 533 | auto blockIt = findFirstParameter(tlv::InterestSignatureInfo); |
| 534 | if (blockIt != m_parameters.end()) { |
Davide Pesavento | f6b4589 | 2023-03-13 15:00:51 -0400 | [diff] [blame^] | 535 | return std::make_optional<SignatureInfo>(*blockIt, SignatureInfo::Type::Interest); |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 536 | } |
Davide Pesavento | f6b4589 | 2023-03-13 15:00:51 -0400 | [diff] [blame^] | 537 | return std::nullopt; |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 538 | } |
| 539 | |
| 540 | Interest& |
| 541 | Interest::setSignatureInfo(const SignatureInfo& info) |
| 542 | { |
| 543 | // Prepend empty ApplicationParameters element if none present |
| 544 | if (m_parameters.empty()) { |
| 545 | m_parameters.push_back(makeEmptyBlock(tlv::ApplicationParameters)); |
| 546 | } |
| 547 | |
| 548 | // Find first existing InterestSignatureInfo (if any) |
| 549 | auto infoIt = std::find_if(m_parameters.begin(), m_parameters.end(), [] (const Block& block) { |
| 550 | return block.type() == tlv::InterestSignatureInfo; |
| 551 | }); |
| 552 | |
| 553 | Block encodedInfo = info.wireEncode(SignatureInfo::Type::Interest); |
| 554 | if (infoIt != m_parameters.end()) { |
| 555 | if (*infoIt == encodedInfo) { |
| 556 | // New InterestSignatureInfo is the same as the old InterestSignatureInfo |
| 557 | return *this; |
| 558 | } |
| 559 | |
| 560 | // Replace existing InterestSignatureInfo |
| 561 | *infoIt = std::move(encodedInfo); |
| 562 | } |
| 563 | else { |
| 564 | // Place before first InterestSignatureValue element (if any), else at end |
| 565 | auto valueIt = findFirstParameter(tlv::InterestSignatureValue); |
| 566 | m_parameters.insert(valueIt, std::move(encodedInfo)); |
| 567 | } |
| 568 | |
| 569 | addOrReplaceParametersDigestComponent(); |
| 570 | m_wire.reset(); |
| 571 | return *this; |
| 572 | } |
| 573 | |
| 574 | Block |
| 575 | Interest::getSignatureValue() const |
| 576 | { |
| 577 | auto blockIt = findFirstParameter(tlv::InterestSignatureValue); |
| 578 | if (blockIt != m_parameters.end()) { |
| 579 | return *blockIt; |
| 580 | } |
| 581 | return {}; |
| 582 | } |
| 583 | |
| 584 | Interest& |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 585 | Interest::setSignatureValueInternal(Block sigValue) |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 586 | { |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 587 | // Ensure presence of InterestSignatureInfo |
| 588 | auto infoIt = findFirstParameter(tlv::InterestSignatureInfo); |
| 589 | if (infoIt == m_parameters.end()) { |
| 590 | NDN_THROW(Error("InterestSignatureInfo must be present to set InterestSignatureValue")); |
| 591 | } |
| 592 | |
| 593 | auto valueIt = std::find_if(m_parameters.begin(), m_parameters.end(), [] (const Block& block) { |
| 594 | return block.type() == tlv::InterestSignatureValue; |
| 595 | }); |
| 596 | |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 597 | if (valueIt != m_parameters.end()) { |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 598 | if (*valueIt == sigValue) { |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 599 | // New InterestSignatureValue is the same as the old InterestSignatureValue |
| 600 | return *this; |
| 601 | } |
| 602 | |
| 603 | // Replace existing InterestSignatureValue |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 604 | *valueIt = std::move(sigValue); |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 605 | } |
| 606 | else { |
| 607 | // Place after first InterestSignatureInfo element |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 608 | valueIt = m_parameters.insert(std::next(infoIt), std::move(sigValue)); |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 609 | } |
| 610 | |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 611 | // computeParametersDigest needs encoded InterestSignatureValue |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 612 | valueIt->encode(); |
| 613 | |
| 614 | addOrReplaceParametersDigestComponent(); |
| 615 | m_wire.reset(); |
| 616 | return *this; |
| 617 | } |
| 618 | |
Davide Pesavento | 487e3d3 | 2022-05-05 18:06:23 -0400 | [diff] [blame] | 619 | Interest& |
| 620 | Interest::setSignatureValue(span<const uint8_t> value) |
| 621 | { |
| 622 | return setSignatureValueInternal(makeBinaryBlock(tlv::InterestSignatureValue, value)); |
| 623 | } |
| 624 | |
| 625 | Interest& |
| 626 | Interest::setSignatureValue(ConstBufferPtr value) |
| 627 | { |
| 628 | if (value == nullptr) { |
| 629 | NDN_THROW(std::invalid_argument("InterestSignatureValue buffer cannot be nullptr")); |
| 630 | } |
| 631 | |
| 632 | return setSignatureValueInternal({tlv::InterestSignatureValue, std::move(value)}); |
| 633 | } |
| 634 | |
Eric Newberry | b74bbda | 2020-06-18 19:33:58 -0700 | [diff] [blame] | 635 | InputBuffers |
| 636 | Interest::extractSignedRanges() const |
| 637 | { |
| 638 | InputBuffers bufs; |
| 639 | bufs.reserve(2); // For Name range and parameters range |
| 640 | |
| 641 | wireEncode(); |
| 642 | |
| 643 | // Get Interest name minus any ParametersSha256DigestComponent |
Davide Pesavento | 765abc9 | 2021-12-27 00:44:04 -0500 | [diff] [blame] | 644 | // Name is guaranteed to be non-empty if wireEncode() does not throw |
Eric Newberry | b74bbda | 2020-06-18 19:33:58 -0700 | [diff] [blame] | 645 | BOOST_ASSERT(!m_name.empty()); |
| 646 | if (m_name[-1].type() != tlv::ParametersSha256DigestComponent) { |
| 647 | NDN_THROW(Error("Interest Name must end with a ParametersSha256DigestComponent")); |
| 648 | } |
| 649 | |
Davide Pesavento | 258d51a | 2022-02-27 21:26:28 -0500 | [diff] [blame] | 650 | bufs.emplace_back(m_name[0].data(), m_name[-1].data()); |
Eric Newberry | b74bbda | 2020-06-18 19:33:58 -0700 | [diff] [blame] | 651 | |
Davide Pesavento | 765abc9 | 2021-12-27 00:44:04 -0500 | [diff] [blame] | 652 | // Ensure InterestSignatureInfo element is present |
Eric Newberry | b74bbda | 2020-06-18 19:33:58 -0700 | [diff] [blame] | 653 | auto sigInfoIt = findFirstParameter(tlv::InterestSignatureInfo); |
| 654 | if (sigInfoIt == m_parameters.end()) { |
| 655 | NDN_THROW(Error("Interest missing InterestSignatureInfo")); |
| 656 | } |
| 657 | |
| 658 | // Get range from ApplicationParameters to InterestSignatureValue |
| 659 | // or end of parameters (whichever is first) |
| 660 | BOOST_ASSERT(!m_parameters.empty() && m_parameters.begin()->type() == tlv::ApplicationParameters); |
Davide Pesavento | 765abc9 | 2021-12-27 00:44:04 -0500 | [diff] [blame] | 661 | auto lastSignedIt = std::prev(findFirstParameter(tlv::InterestSignatureValue)); |
| 662 | // Note: we assume that both iterators point to the same underlying buffer |
| 663 | bufs.emplace_back(m_parameters.front().begin(), lastSignedIt->end()); |
| 664 | |
Eric Newberry | b74bbda | 2020-06-18 19:33:58 -0700 | [diff] [blame] | 665 | return bufs; |
| 666 | } |
| 667 | |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 668 | // ---- ParametersSha256DigestComponent support ---- |
| 669 | |
| 670 | bool |
| 671 | Interest::isParametersDigestValid() const |
| 672 | { |
| 673 | ssize_t digestIndex = findParametersDigestComponent(getName()); |
| 674 | if (digestIndex == -1) { |
| 675 | return !hasApplicationParameters(); |
| 676 | } |
| 677 | // cannot be -2 because of the checks in setName() and wireDecode() |
| 678 | BOOST_ASSERT(digestIndex >= 0); |
| 679 | |
| 680 | if (!hasApplicationParameters()) { |
| 681 | return false; |
| 682 | } |
| 683 | |
| 684 | const auto& digestComponent = getName()[digestIndex]; |
| 685 | auto digest = computeParametersDigest(); |
| 686 | |
| 687 | return std::equal(digestComponent.value_begin(), digestComponent.value_end(), |
| 688 | digest->begin(), digest->end()); |
| 689 | } |
| 690 | |
| 691 | shared_ptr<Buffer> |
| 692 | Interest::computeParametersDigest() const |
| 693 | { |
| 694 | using namespace security::transform; |
| 695 | |
| 696 | StepSource in; |
| 697 | OBufferStream out; |
| 698 | in >> digestFilter(DigestAlgorithm::SHA256) >> streamSink(out); |
| 699 | |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 700 | for (const auto& block : m_parameters) { |
Davide Pesavento | 258d51a | 2022-02-27 21:26:28 -0500 | [diff] [blame] | 701 | in.write(block); |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 702 | } |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 703 | in.end(); |
| 704 | |
| 705 | return out.buf(); |
| 706 | } |
| 707 | |
| 708 | void |
| 709 | Interest::addOrReplaceParametersDigestComponent() |
| 710 | { |
| 711 | BOOST_ASSERT(hasApplicationParameters()); |
| 712 | |
| 713 | ssize_t digestIndex = findParametersDigestComponent(getName()); |
Davide Pesavento | 21ee899 | 2022-02-25 20:46:04 -0500 | [diff] [blame] | 714 | name::Component digestComponent(tlv::ParametersSha256DigestComponent, computeParametersDigest()); |
Davide Pesavento | adc9aa2 | 2019-06-30 19:00:20 -0400 | [diff] [blame] | 715 | |
| 716 | if (digestIndex == -1) { |
| 717 | // no existing digest components, append one |
| 718 | m_name.append(std::move(digestComponent)); |
| 719 | } |
| 720 | else { |
| 721 | // cannot be -2 because of the checks in setName() and wireDecode() |
| 722 | BOOST_ASSERT(digestIndex >= 0); |
| 723 | // replace the existing digest component |
| 724 | m_name.set(digestIndex, std::move(digestComponent)); |
| 725 | } |
| 726 | } |
| 727 | |
| 728 | ssize_t |
| 729 | Interest::findParametersDigestComponent(const Name& name) |
| 730 | { |
| 731 | ssize_t pos = -1; |
| 732 | for (ssize_t i = 0; i < static_cast<ssize_t>(name.size()); i++) { |
| 733 | if (name[i].isParametersSha256Digest()) { |
| 734 | if (pos != -1) |
| 735 | return -2; |
| 736 | pos = i; |
| 737 | } |
| 738 | } |
| 739 | return pos; |
| 740 | } |
| 741 | |
Eric Newberry | 6e262f0 | 2020-05-29 23:11:25 -0700 | [diff] [blame] | 742 | std::vector<Block>::const_iterator |
| 743 | Interest::findFirstParameter(uint32_t type) const |
| 744 | { |
| 745 | return std::find_if(m_parameters.begin(), m_parameters.end(), [type] (const Block& block) { |
| 746 | return block.type() == type; |
| 747 | }); |
| 748 | } |
| 749 | |
Junxiao Shi | 899277a | 2017-07-07 22:12:12 +0000 | [diff] [blame] | 750 | // ---- operators ---- |
| 751 | |
Alexander Afanasyev | ff2d08f | 2014-04-07 18:28:25 -0700 | [diff] [blame] | 752 | std::ostream& |
| 753 | operator<<(std::ostream& os, const Interest& interest) |
Jeff Thompson | fe55686 | 2013-07-09 13:52:55 -0700 | [diff] [blame] | 754 | { |
Alexander Afanasyev | 8468198 | 2014-01-03 13:26:09 -0800 | [diff] [blame] | 755 | os << interest.getName(); |
Jeff Thompson | fe55686 | 2013-07-09 13:52:55 -0700 | [diff] [blame] | 756 | |
Alexander Afanasyev | 8468198 | 2014-01-03 13:26:09 -0800 | [diff] [blame] | 757 | char delim = '?'; |
Davide Pesavento | 2fdb274 | 2019-07-31 23:03:35 -0400 | [diff] [blame] | 758 | auto printOne = [&] (const auto&... args) { |
| 759 | os << delim; |
Alexander Afanasyev | 8468198 | 2014-01-03 13:26:09 -0800 | [diff] [blame] | 760 | delim = '&'; |
Davide Pesavento | fcd3e44 | 2023-03-10 18:44:11 -0500 | [diff] [blame] | 761 | (os << ... << args); |
Davide Pesavento | 2fdb274 | 2019-07-31 23:03:35 -0400 | [diff] [blame] | 762 | }; |
| 763 | |
| 764 | if (interest.getCanBePrefix()) { |
| 765 | printOne("CanBePrefix"); |
Jeff Thompson | 13e280b | 2013-12-03 13:12:23 -0800 | [diff] [blame] | 766 | } |
Davide Pesavento | 2fdb274 | 2019-07-31 23:03:35 -0400 | [diff] [blame] | 767 | if (interest.getMustBeFresh()) { |
| 768 | printOne("MustBeFresh"); |
Alexander Afanasyev | 8468198 | 2014-01-03 13:26:09 -0800 | [diff] [blame] | 769 | } |
Alexander Afanasyev | e881e93 | 2014-06-08 14:47:03 +0300 | [diff] [blame] | 770 | if (interest.hasNonce()) { |
Davide Pesavento | 2fdb274 | 2019-07-31 23:03:35 -0400 | [diff] [blame] | 771 | printOne("Nonce=", interest.getNonce()); |
| 772 | } |
| 773 | if (interest.getInterestLifetime() != DEFAULT_INTEREST_LIFETIME) { |
| 774 | printOne("Lifetime=", interest.getInterestLifetime().count()); |
| 775 | } |
| 776 | if (interest.getHopLimit()) { |
| 777 | printOne("HopLimit=", static_cast<unsigned>(*interest.getHopLimit())); |
Alexander Afanasyev | 8468198 | 2014-01-03 13:26:09 -0800 | [diff] [blame] | 778 | } |
Alexander Afanasyev | 8468198 | 2014-01-03 13:26:09 -0800 | [diff] [blame] | 779 | |
| 780 | return os; |
Jeff Thompson | 13e280b | 2013-12-03 13:12:23 -0800 | [diff] [blame] | 781 | } |
| 782 | |
Junxiao Shi | 08d0708 | 2014-12-03 11:31:44 -0700 | [diff] [blame] | 783 | } // namespace ndn |