2 This file is part of GNUnet.
3 (C) 2011-2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file namestore/namestore.h
23 * @brief common internal definitions for namestore service
24 * @author Matthias Wachs
25 * @author Christian Grothoff
31 * Maximum length of any name, including 0-termination.
33 #define MAX_NAME_LEN 256
35 GNUNET_NETWORK_STRUCT_BEGIN
38 * Generic namestore message with op id
40 struct GNUNET_NAMESTORE_Header
43 * header.type will be GNUNET_MESSAGE_TYPE_NAMESTORE_*
44 * header.size will be message size
46 struct GNUNET_MessageHeader header;
56 * Lookup a block in the namestore
58 struct LookupBlockMessage
61 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK
63 struct GNUNET_NAMESTORE_Header gns_header;
68 struct GNUNET_HashCode query;
76 struct LookupBlockResponseMessage
79 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK_RESPONSE
81 struct GNUNET_NAMESTORE_Header gns_header;
86 struct GNUNET_TIME_AbsoluteNBO expire;
91 struct GNUNET_CRYPTO_EccSignature signature;
96 struct GNUNET_CRYPTO_EccPublicSignKey derived_key;
98 /* follwed by encrypted block data */
103 * Cache a record in the namestore.
105 struct BlockCacheMessage
108 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE
110 struct GNUNET_NAMESTORE_Header gns_header;
115 struct GNUNET_TIME_AbsoluteNBO expire;
120 struct GNUNET_CRYPTO_EccSignature signature;
123 * Derived public key.
125 struct GNUNET_CRYPTO_EccPublicSignKey derived_key;
127 /* follwed by encrypted block data */
132 * Response to a request to cache a block.
134 struct BlockCacheResponseMessage
137 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE_RESPONSE
139 struct GNUNET_NAMESTORE_Header gns_header;
142 * #GNUNET_OK on success, #GNUNET_SYSERR error
149 * Store a record to the namestore (as authority).
151 struct RecordStoreMessage
154 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE
156 struct GNUNET_NAMESTORE_Header gns_header;
161 struct GNUNET_TIME_AbsoluteNBO expire;
169 * Length of serialized record data
174 * Number of records contained
179 * always zero (for alignment)
184 * The private key of the authority.
186 struct GNUNET_CRYPTO_EccPrivateKey private_key;
189 * name with length name_len
190 * serialized record data with rd_count records
196 * Response to a record storage request.
198 struct RecordStoreResponseMessage
201 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE
203 struct GNUNET_NAMESTORE_Header gns_header;
206 * #GNUNET_SYSERR on failure, #GNUNET_OK on success
214 * Lookup a name for a zone hash
216 struct ZoneToNameMessage
219 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME
221 struct GNUNET_NAMESTORE_Header gns_header;
224 * The private key of the zone to look up in
226 struct GNUNET_CRYPTO_EccPrivateKey zone;
229 * The public key of the target zone
231 struct GNUNET_CRYPTO_EccPublicSignKey value_zone;
236 * Respone for zone to name lookup
238 struct ZoneToNameResponseMessage
241 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
243 struct GNUNET_NAMESTORE_Header gns_header;
251 * Length of serialized record data
256 * Number of records contained
261 * result in NBO: #GNUNET_OK on success, #GNUNET_NO if there were no
262 * results, #GNUNET_SYSERR on error
267 * The private key of the zone that contained the name.
269 struct GNUNET_CRYPTO_EccPrivateKey zone;
272 * name with length name_len
273 * serialized record data with rd_count records
280 * Record is returned from the namestore (as authority).
282 struct RecordResultMessage
285 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT
287 struct GNUNET_NAMESTORE_Header gns_header;
295 * Length of serialized record data
300 * Number of records contained
305 * always zero (for alignment)
310 * The private key of the authority.
312 struct GNUNET_CRYPTO_EccPrivateKey private_key;
315 * name with length name_len
316 * serialized record data with rd_count records
322 * Start monitoring a zone.
324 struct ZoneMonitorStartMessage
327 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START
329 struct GNUNET_NAMESTORE_Header gns_header;
334 struct GNUNET_CRYPTO_EccPrivateKey zone;
340 * Start a zone iteration for the given zone
342 struct ZoneIterationStartMessage
345 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START
347 struct GNUNET_NAMESTORE_Header gns_header;
350 * Zone key. All zeros for "all zones".
352 struct GNUNET_CRYPTO_EccPrivateKey zone;
358 * Ask for next result of zone iteration for the given operation
360 struct ZoneIterationNextMessage
363 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT
365 struct GNUNET_NAMESTORE_Header gns_header;
370 * Stop zone iteration for the given operation
372 struct ZoneIterationStopMessage
375 * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP
377 struct GNUNET_NAMESTORE_Header gns_header;
381 GNUNET_NETWORK_STRUCT_END
384 /* end of namestore.h */