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_EccPublicKey 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_EccPublicKey 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 * name length: GNUNET_NO already exists, GNUNET_YES 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_LOOKUP_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;
207 * GNUNET_SYSERR on failure
208 * GNUNET_OK on success
216 * Lookup a name for a zone hash
218 struct ZoneToNameMessage
221 * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME
223 struct GNUNET_NAMESTORE_Header gns_header;
226 * The private key of the zone to look up in
228 struct GNUNET_CRYPTO_EccPrivateKey zone;
231 * The public key of the target zone
233 struct GNUNET_CRYPTO_EccPublicKey value_zone;
238 * Respone for zone to name lookup
240 struct ZoneToNameResponseMessage
243 * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
245 struct GNUNET_NAMESTORE_Header gns_header;
253 * Length of serialized record data
258 * Number of records contained
263 * result in NBO: GNUNET_OK on success, GNUNET_NO if there were no
264 * results, GNUNET_SYSERR on error
269 * The private key of the zone that contained the name.
271 struct GNUNET_CRYPTO_EccPrivateKey zone;
274 * name with length name_len
275 * serialized record data with rd_count records
282 * Record is returned from the namestore (as authority).
284 struct RecordResultMessage
287 * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT
289 struct GNUNET_NAMESTORE_Header gns_header;
297 * Length of serialized record data
302 * Number of records contained
307 * always zero (for alignment)
312 * The private key of the authority.
314 struct GNUNET_CRYPTO_EccPrivateKey private_key;
317 * name with length name_len
318 * serialized record data with rd_count records
324 * Start monitoring a zone.
326 struct ZoneMonitorStartMessage
329 * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START
331 struct GNUNET_NAMESTORE_Header gns_header;
336 struct GNUNET_CRYPTO_EccPrivateKey zone;
342 * Start a zone iteration for the given zone
344 struct ZoneIterationStartMessage
347 * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START
349 struct GNUNET_NAMESTORE_Header gns_header;
354 struct GNUNET_CRYPTO_EccPrivateKey zone;
360 * Ask for next result of zone iteration for the given operation
362 struct ZoneIterationNextMessage
365 * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT
367 struct GNUNET_NAMESTORE_Header gns_header;
372 * Stop zone iteration for the given operation
374 struct ZoneIterationStopMessage
377 * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP
379 struct GNUNET_NAMESTORE_Header gns_header;
383 GNUNET_NETWORK_STRUCT_END
386 /* end of namestore.h */