blob: 0b40c743e96a9d8a688af53aba41139ee4c2afaa [file] [log] [blame]
Jeff Thompson25b4e612013-10-10 16:03:24 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
Jeff Thompson5cae5e52013-07-10 19:41:20 -07002/**
Jeff Thompson7687dc02013-09-13 11:54:07 -07003 * Copyright (C) 2013 Regents of the University of California.
4 * @author: Jeff Thompson <jefft0@remap.ucla.edu>
Jeff Thompson5cae5e52013-07-10 19:41:20 -07005 * See COPYING for copyright and distribution information.
6 */
7
Jeff Thompson56ec9e22013-08-02 11:34:07 -07008#ifndef NDN_DATA_HPP
Jeff Thompsona0d18c92013-08-06 13:55:32 -07009#define NDN_DATA_HPP
Jeff Thompson5cae5e52013-07-10 19:41:20 -070010
Jeff Thompson46bd45f2013-08-08 16:46:41 -070011#include "common.hpp"
Jeff Thompson53412192013-08-06 13:35:50 -070012#include "name.hpp"
Jeff Thompsonb7aefa002013-09-16 18:22:00 -070013#include "util/signed-blob.hpp"
Jeff Thompson25b4e612013-10-10 16:03:24 -070014#include "c/data-types.h"
15#include "encoding/wire-format.hpp"
16
17struct ndn_MetaInfo;
18struct ndn_Signature;
19struct ndn_Data;
Jeff Thompson5cae5e52013-07-10 19:41:20 -070020
21namespace ndn {
22
Jeff Thompsonf4585af2013-09-11 14:56:59 -070023/**
Jeff Thompson1fe62d42013-09-27 16:49:45 -070024 * A Signature is an abstract base class providing methods to work with the signature information in a Data packet.
Jeff Thompsonfd2a7ef2013-09-27 16:50:54 -070025 * You must create an object of a subclass, for example Sha256WithRsaSignature.
Jeff Thompsonf4585af2013-09-11 14:56:59 -070026 */
Jeff Thompson5cae5e52013-07-10 19:41:20 -070027class Signature {
28public:
29 /**
Jeff Thompson20af0732013-09-12 17:01:45 -070030 * Return a pointer to a new Signature which is a copy of this signature.
31 * This is pure virtual, the subclass must implement it.
32 */
Jeff Thompson0050abe2013-09-17 12:50:25 -070033 virtual ptr_lib::shared_ptr<Signature>
34 clone() const = 0;
Jeff Thompson20af0732013-09-12 17:01:45 -070035
36 /**
37 * The virtual destructor.
38 */
Jeff Thompson0050abe2013-09-17 12:50:25 -070039 virtual
40 ~Signature();
Jeff Thompson20af0732013-09-12 17:01:45 -070041
42 /**
Jeff Thompson5cae5e52013-07-10 19:41:20 -070043 * Set the signatureStruct to point to the values in this signature object, without copying any memory.
44 * WARNING: The resulting pointers in signatureStruct are invalid after a further use of this object which could reallocate memory.
Jeff Thompson20af0732013-09-12 17:01:45 -070045 * This is pure virtual, the subclass must implement it.
Jeff Thompson5cae5e52013-07-10 19:41:20 -070046 * @param signatureStruct a C ndn_Signature struct where the name components array is already allocated.
47 */
Jeff Thompson0050abe2013-09-17 12:50:25 -070048 virtual void
49 get(struct ndn_Signature& signatureStruct) const = 0;
Jeff Thompson5cae5e52013-07-10 19:41:20 -070050
51 /**
52 * Clear this signature, and set the values by copying from the ndn_Signature struct.
Jeff Thompson20af0732013-09-12 17:01:45 -070053 * This is pure virtual, the subclass must implement it.
Jeff Thompson5cae5e52013-07-10 19:41:20 -070054 * @param signatureStruct a C ndn_Signature struct
55 */
Jeff Thompson0050abe2013-09-17 12:50:25 -070056 virtual void
57 set(const struct ndn_Signature& signatureStruct) = 0;
Jeff Thompson5cae5e52013-07-10 19:41:20 -070058};
59
Jeff Thompsonf4585af2013-09-11 14:56:59 -070060/**
61 * An MetaInfo holds the meta info which is signed inside the data packet.
62 */
Jeff Thompsonfec716d2013-09-11 13:54:36 -070063class MetaInfo {
Jeff Thompson5cae5e52013-07-10 19:41:20 -070064public:
Jeff Thompsonfec716d2013-09-11 13:54:36 -070065 MetaInfo()
Jeff Thompson5cae5e52013-07-10 19:41:20 -070066 {
67 type_ = ndn_ContentType_DATA;
68 freshnessSeconds_ = -1;
69 }
70
71 /**
Jeff Thompsonfec716d2013-09-11 13:54:36 -070072 * Set the metaInfoStruct to point to the values in this meta info object, without copying any memory.
73 * WARNING: The resulting pointers in metaInfoStruct are invalid after a further use of this object which could reallocate memory.
74 * @param metaInfoStruct a C ndn_MetaInfo struct where the name components array is already allocated.
Jeff Thompson5cae5e52013-07-10 19:41:20 -070075 */
Jeff Thompson0050abe2013-09-17 12:50:25 -070076 void
77 get(struct ndn_MetaInfo& metaInfoStruct) const;
Jeff Thompson5cae5e52013-07-10 19:41:20 -070078
79 /**
Jeff Thompsonfec716d2013-09-11 13:54:36 -070080 * Clear this meta info, and set the values by copying from the ndn_MetaInfo struct.
81 * @param metaInfoStruct a C ndn_MetaInfo struct
Jeff Thompson5cae5e52013-07-10 19:41:20 -070082 */
Jeff Thompson0050abe2013-09-17 12:50:25 -070083 void
84 set(const struct ndn_MetaInfo& metaInfoStruct);
Jeff Thompson5cae5e52013-07-10 19:41:20 -070085
Jeff Thompson0050abe2013-09-17 12:50:25 -070086 double
87 getTimestampMilliseconds() const { return timestampMilliseconds_; }
Jeff Thompson5cae5e52013-07-10 19:41:20 -070088
Jeff Thompson0050abe2013-09-17 12:50:25 -070089 ndn_ContentType
90 getType() const { return type_; }
Jeff Thompson5cae5e52013-07-10 19:41:20 -070091
Jeff Thompson0050abe2013-09-17 12:50:25 -070092 int
93 getFreshnessSeconds() const { return freshnessSeconds_; }
Jeff Thompson5cae5e52013-07-10 19:41:20 -070094
Jeff Thompson0050abe2013-09-17 12:50:25 -070095 const Name::Component&
96 getFinalBlockID() const { return finalBlockID_; }
Jeff Thompson5cae5e52013-07-10 19:41:20 -070097
Jeff Thompson0050abe2013-09-17 12:50:25 -070098 void
99 setTimestampMilliseconds(double timestampMilliseconds) { timestampMilliseconds_ = timestampMilliseconds; }
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700100
Jeff Thompson0050abe2013-09-17 12:50:25 -0700101 void
102 setType(ndn_ContentType type) { type_ = type; }
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700103
Jeff Thompson0050abe2013-09-17 12:50:25 -0700104 void
105 setFreshnessSeconds(int freshnessSeconds) { freshnessSeconds_ = freshnessSeconds; }
Jeff Thompson70d0e462013-10-14 13:44:32 -0700106
107 void
108 setFinalBlockID(const Blob& finalBlockID) { finalBlockID_ = Name::Component(finalBlockID); }
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700109
Jeff Thompson0050abe2013-09-17 12:50:25 -0700110 void
Jeff Thompson10ad12a2013-09-24 16:19:11 -0700111 setFinalBlockID(const std::vector<uint8_t>& finalBlockID) { finalBlockID_ = Name::Component(finalBlockID); }
Jeff Thompson0050abe2013-09-17 12:50:25 -0700112
113 void
Jeff Thompson97223af2013-09-24 17:01:27 -0700114 setFinalBlockID(const uint8_t* finalBlockID, size_t finalBlockIdLength)
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700115 {
Jeff Thompson85db6d72013-09-12 12:41:18 -0700116 finalBlockID_ = Name::Component(finalBlockID, finalBlockIdLength);
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700117 }
118
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700119private:
Jeff Thompson210b92f2013-07-11 15:16:03 -0700120 double timestampMilliseconds_; /**< milliseconds since 1/1/1970. -1 for none */
Jeff Thompsond8776352013-08-16 18:09:30 -0700121 ndn_ContentType type_; /**< default is ndn_ContentType_DATA. -1 for none */
Jeff Thompson210b92f2013-07-11 15:16:03 -0700122 int freshnessSeconds_; /**< -1 for none */
Jeff Thompson85db6d72013-09-12 12:41:18 -0700123 Name::Component finalBlockID_; /** size 0 for none */
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700124};
125
Jeff Thompson56ec9e22013-08-02 11:34:07 -0700126class Data {
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700127public:
Jeff Thompson20af0732013-09-12 17:01:45 -0700128 /**
129 * Create a new Data object with default values and where the signature is a blank Sha256WithRsaSignature.
130 */
131 Data();
132
133 /**
134 * Create a new Data object with the given name and default values and where the signature is a blank Sha256WithRsaSignature.
135 * @param name A reference to the name which is copied.
136 */
137 Data(const Name& name);
Jeff Thompsonf5dbd272013-08-08 16:49:55 -0700138
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700139 /**
Jeff Thompsonc69163b2013-10-12 13:49:50 -0700140 * The virtual destructor.
141 */
142 virtual ~Data() {}
143
144 /**
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700145 * Encode this Data for a particular wire format. Also, set the wireEncoding field to the encoded result.
146 * This is not const because it updates the wireEncoding.
147 * @param wireFormat A WireFormat object used to encode the input. If omitted, use WireFormat getDefaultWireFormat().
148 * @return The encoded byte array.
149 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700150 SignedBlob
151 wireEncode(WireFormat& wireFormat = *WireFormat::getDefaultWireFormat());
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700152
153 /**
154 * Decode the input using a particular wire format and update this Data. Also, set the wireEncoding field to the input.
155 * @param input The input byte array to be decoded.
156 * @param inputLength The length of input.
157 * @param wireFormat A WireFormat object used to decode the input. If omitted, use WireFormat getDefaultWireFormat().
158 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700159 void
Jeff Thompson97223af2013-09-24 17:01:27 -0700160 wireDecode(const uint8_t* input, size_t inputLength, WireFormat& wireFormat = *WireFormat::getDefaultWireFormat());
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700161
162 /**
163 * Decode the input using a particular wire format and update this Data. Also, set the wireEncoding field to the input.
164 * @param input The input byte array to be decoded.
165 * @param wireFormat A WireFormat object used to decode the input. If omitted, use WireFormat getDefaultWireFormat().
166 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700167 void
Jeff Thompson10ad12a2013-09-24 16:19:11 -0700168 wireDecode(const std::vector<uint8_t>& input, WireFormat& wireFormat = *WireFormat::getDefaultWireFormat())
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700169 {
Jeff Thompson67e9e0a2013-08-02 19:16:19 -0700170 wireDecode(&input[0], input.size(), wireFormat);
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700171 }
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700172
173 /**
Jeff Thompson56ec9e22013-08-02 11:34:07 -0700174 * Set the dataStruct to point to the values in this interest, without copying any memory.
175 * WARNING: The resulting pointers in dataStruct are invalid after a further use of this object which could reallocate memory.
176 * @param dataStruct a C ndn_Data struct where the name components array is already allocated.
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700177 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700178 void
179 get(struct ndn_Data& dataStruct) const;
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700180
181 /**
Jeff Thompson56ec9e22013-08-02 11:34:07 -0700182 * Clear this data object, and set the values by copying from the ndn_Data struct.
183 * @param dataStruct a C ndn_Data struct
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700184 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700185 void
186 set(const struct ndn_Data& dataStruct);
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700187
Jeff Thompson0050abe2013-09-17 12:50:25 -0700188 const Signature*
189 getSignature() const { return signature_.get(); }
190
191 Signature*
192 getSignature()
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700193 {
Jeff Thompson3352fc22013-09-17 12:07:14 -0700194 // TODO: Should add an OnChanged listener instead of always calling onChanged.
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700195 onChanged();
196 return signature_.get();
197 }
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700198
Jeff Thompson0050abe2013-09-17 12:50:25 -0700199 const Name&
200 getName() const { return name_; }
201
202 Name&
203 getName()
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700204 {
Jeff Thompson3352fc22013-09-17 12:07:14 -0700205 // TODO: Should add an OnChanged listener instead of always calling onChanged.
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700206 onChanged();
207 return name_;
208 }
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700209
Jeff Thompson0050abe2013-09-17 12:50:25 -0700210 const MetaInfo&
211 getMetaInfo() const { return metaInfo_; }
212
213 MetaInfo&
214 getMetaInfo()
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700215 {
Jeff Thompson3352fc22013-09-17 12:07:14 -0700216 // TODO: Should add an OnChanged listener instead of always calling onChanged.
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700217 onChanged();
218 return metaInfo_;
219 }
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700220
Jeff Thompson0050abe2013-09-17 12:50:25 -0700221 const Blob&
222 getContent() const { return content_; }
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700223
Jeff Thompson20af0732013-09-12 17:01:45 -0700224 /**
Jeff Thompsonb697c5d2013-09-17 17:58:37 -0700225 * Return a pointer to the wireEncoding. It may be null.
226 */
227 const SignedBlob&
228 getWireEncoding() const { return wireEncoding_; }
229
230 /**
Jeff Thompson20af0732013-09-12 17:01:45 -0700231 * Set the signature to a copy of the given signature.
232 * @param signature The signature object which is cloned.
233 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700234 void
235 setSignature(const Signature& signature)
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700236 {
237 signature_ = signature.clone();
238 onChanged();
239 }
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700240
Jeff Thompson0cd8c4a2013-09-13 17:46:40 -0700241 /**
242 * Set name to a copy of the given Name.
243 * @param name The Name which is copied.
244 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700245 void
246 setName(const Name& name)
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700247 {
248 name_ = name;
249 onChanged();
250 }
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700251
Jeff Thompson0cd8c4a2013-09-13 17:46:40 -0700252 /**
253 * Set metaInfo to a copy of the given MetaInfo.
254 * @param metaInfo The MetaInfo which is copied.
255 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700256 void
257 setMetainfo(const MetaInfo& metaInfo)
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700258 {
259 metaInfo_ = metaInfo;
260 onChanged();
261 }
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700262
Jeff Thompson0899c0f2013-09-12 12:15:31 -0700263 /**
264 * Set the content to a copy of the data in the vector.
265 * @param content A vector whose contents are copied.
266 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700267 void
Jeff Thompson10ad12a2013-09-24 16:19:11 -0700268 setContent(const std::vector<uint8_t>& content)
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700269 {
270 content_ = content;
271 onChanged();
272 }
Jeff Thompson3776d1c2013-09-17 14:22:51 -0700273
Jeff Thompson0050abe2013-09-17 12:50:25 -0700274 void
Jeff Thompson97223af2013-09-24 17:01:27 -0700275 setContent(const uint8_t* content, size_t contentLength)
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700276 {
Jeff Thompson0899c0f2013-09-12 12:15:31 -0700277 content_ = Blob(content, contentLength);
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700278 onChanged();
Jeff Thompson46bd45f2013-08-08 16:46:41 -0700279 }
Jeff Thompsonc2b7b142013-09-12 15:29:04 -0700280
Jeff Thompson0050abe2013-09-17 12:50:25 -0700281 void
Jeff Thompson63631b72013-10-14 14:00:58 -0700282 setContent(const Blob& content)
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700283 {
284 content_ = content;
285 onChanged();
286 }
Jeff Thompsonc2b7b142013-09-12 15:29:04 -0700287
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700288private:
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700289 /**
290 * Clear the wire encoding.
291 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700292 void
293 onChanged();
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700294
Jeff Thompson20af0732013-09-12 17:01:45 -0700295 ptr_lib::shared_ptr<Signature> signature_;
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700296 Name name_;
Jeff Thompsonfec716d2013-09-11 13:54:36 -0700297 MetaInfo metaInfo_;
Jeff Thompson0899c0f2013-09-12 12:15:31 -0700298 Blob content_;
Jeff Thompsonb7aefa002013-09-16 18:22:00 -0700299 SignedBlob wireEncoding_;
Jeff Thompson5cae5e52013-07-10 19:41:20 -0700300};
301
302}
303
304#endif