2 This file is part of GNUnet.
3 Copyright (C) 2009-2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file gnsrecord/gnsrecord_serialization.c
23 * @brief API to serialize and deserialize GNS records
24 * @author Martin Schanzenbach
25 * @author Matthias Wachs
26 * @author Christian Grothoff
29 #include "gnunet_util_lib.h"
30 #include "gnunet_constants.h"
31 #include "gnunet_signatures.h"
32 #include "gnunet_arm_service.h"
33 #include "gnunet_gnsrecord_lib.h"
34 #include "gnunet_dnsparser_lib.h"
35 #include "gnunet_tun_lib.h"
38 #define LOG(kind, ...) GNUNET_log_from (kind, "gnsrecord", __VA_ARGS__)
41 * Set to 1 to check that all records are well-formed (can be converted
42 * to string) during serialization/deserialization.
44 #define DEBUG_GNSRECORDS 0
46 GNUNET_NETWORK_STRUCT_BEGIN
50 * Internal format of a record in the serialized form.
55 * Expiration time for the DNS record; relative or absolute depends
56 * on @e flags, network byte order.
58 uint64_t expiration_time GNUNET_PACKED;
61 * Number of bytes in 'data', network byte order.
63 uint32_t data_size GNUNET_PACKED;
66 * Type of the GNS/DNS record, network byte order.
68 uint32_t record_type GNUNET_PACKED;
71 * Flags for the record, network byte order.
73 uint32_t flags GNUNET_PACKED;
76 GNUNET_NETWORK_STRUCT_END
80 * Calculate how many bytes we will need to serialize the given
83 * @param rd_count number of records in the rd array
84 * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
85 * @return the required size to serialize, -1 on error
88 GNUNET_GNSRECORD_records_get_size (unsigned int rd_count,
89 const struct GNUNET_GNSRECORD_Data *rd)
96 ret = sizeof(struct NetworkRecord) * rd_count;
97 for (unsigned int i = 0; i < rd_count; i++)
99 if ((ret + rd[i].data_size) < ret)
104 ret += rd[i].data_size;
109 str = GNUNET_GNSRECORD_value_to_string (rd[i].record_type,
127 if (GNUNET_GNSRECORD_TYPE_PKEY == rd->record_type)
130 * Efficiently round up to the next
131 * power of 2 for padding
132 * https://graphics.stanford.edu/~seander/bithacks.html#RoundUpPowerOf2
140 return (ssize_t) ret;
145 * Serialize the given records to the given destination buffer.
147 * @param rd_count number of records in the rd array
148 * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
149 * @param dest_size size of the destination array
150 * @param dest where to write the result
151 * @return the size of serialized records, -1 if records do not fit
154 GNUNET_GNSRECORD_records_serialize (unsigned int rd_count,
155 const struct GNUNET_GNSRECORD_Data *rd,
159 struct NetworkRecord rec;
163 for (unsigned int i = 0; i < rd_count; i++)
165 LOG (GNUNET_ERROR_TYPE_DEBUG,
166 "Serializing record %u with flags %d and expiration time %llu\n",
169 (unsigned long long) rd[i].expiration_time);
170 rec.expiration_time = GNUNET_htonll (rd[i].expiration_time);
171 rec.data_size = htonl ((uint32_t) rd[i].data_size);
172 rec.record_type = htonl (rd[i].record_type);
173 rec.flags = htonl (rd[i].flags);
174 if ((off + sizeof(rec) > dest_size) ||
175 (off + sizeof(rec) < off))
180 GNUNET_memcpy (&dest[off],
184 if ((off + rd[i].data_size > dest_size) ||
185 (off + rd[i].data_size < off))
190 GNUNET_memcpy (&dest[off],
193 off += rd[i].data_size;
198 str = GNUNET_GNSRECORD_value_to_string (rd[i].record_type,
218 * Deserialize the given records to the given destination.
220 * @param len size of the serialized record data
221 * @param src the serialized record data
222 * @param rd_count number of records in the rd array
223 * @param dest where to put the data
224 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
227 GNUNET_GNSRECORD_records_deserialize (size_t len,
229 unsigned int rd_count,
230 struct GNUNET_GNSRECORD_Data *dest)
232 struct NetworkRecord rec;
236 for (unsigned int i = 0; i < rd_count; i++)
238 if ((off + sizeof(rec) > len) ||
239 (off + sizeof(rec) < off))
242 return GNUNET_SYSERR;
247 dest[i].expiration_time = GNUNET_ntohll (rec.expiration_time);
248 dest[i].data_size = ntohl ((uint32_t) rec.data_size);
249 dest[i].record_type = ntohl (rec.record_type);
250 dest[i].flags = ntohl (rec.flags);
252 if ((off + dest[i].data_size > len) ||
253 (off + dest[i].data_size < off))
256 return GNUNET_SYSERR;
258 dest[i].data = &src[off];
259 off += dest[i].data_size;
260 #if GNUNET_EXTRA_LOGGING
264 str = GNUNET_GNSRECORD_value_to_string (dest[i].record_type,
270 return GNUNET_SYSERR;
275 LOG (GNUNET_ERROR_TYPE_DEBUG,
276 "Deserialized record %u with flags %d and expiration time %llu\n",
279 (unsigned long long) dest[i].expiration_time);
285 /* end of gnsrecord_serialization.c */