2 This file is part of GNUnet
3 (C) 2012, 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 include/gnunet_namestore_service.h
23 * @brief API that can be used to store naming information on a GNUnet node;
24 * Naming information can either be records for which this peer/user
25 * is authoritative, or blocks which are cached, encrypted naming
26 * data from other peers.
27 * @author Christian Grothoff
29 #ifndef GNUNET_NAMESTORE_SERVICE_H
30 #define GNUNET_NAMESTORE_SERVICE_H
32 #include "gnunet_util_lib.h"
33 #include "gnunet_block_lib.h"
38 #if 0 /* keep Emacsens' auto-indent happy */
44 * Record type indicating any record/'*'
46 #define GNUNET_NAMESTORE_TYPE_ANY 0
49 * Record type for GNS zone transfer ("PKEY").
51 #define GNUNET_NAMESTORE_TYPE_PKEY 65536
54 * Record type for GNS zone transfer ("PSEU").
56 #define GNUNET_NAMESTORE_TYPE_PSEU 65537
59 * Record type for GNS legacy hostnames ("LEHO").
61 #define GNUNET_NAMESTORE_TYPE_LEHO 65538
64 * Record type for VPN resolution
66 #define GNUNET_NAMESTORE_TYPE_VPN 65539
69 * Record type for zone revocation
71 #define GNUNET_NAMESTORE_TYPE_REV 65540
74 * Record type for a social place.
76 #define GNUNET_NAMESTORE_TYPE_PLACE 65541
81 struct GNUNET_NAMESTORE_QueueEntry;
84 * Handle to the namestore service.
86 struct GNUNET_NAMESTORE_Handle;
89 * Handle to the namestore zone iterator.
91 struct GNUNET_NAMESTORE_ZoneIterator;
94 * Maximum size of a value that can be stored in the namestore.
96 #define GNUNET_NAMESTORE_MAX_VALUE_SIZE (63 * 1024)
100 * Connect to the namestore service.
102 * @param cfg configuration to use
103 * @return handle to use to access the service
105 struct GNUNET_NAMESTORE_Handle *
106 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
110 * Disconnect from the namestore service (and free associated
113 * @param h handle to the namestore
116 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h);
120 * Continuation called to notify client about result of the
124 * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
125 * GNUNET_NO if content was already there or not found
126 * GNUNET_YES (or other positive value) on success
127 * @param emsg NULL on success, otherwise an error message
129 typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
135 * Flags that can be set for a record.
137 enum GNUNET_NAMESTORE_RecordFlags
141 * No special options.
143 GNUNET_NAMESTORE_RF_NONE = 0,
146 * This peer is the authority for this record; it must thus
147 * not be deleted (other records can be deleted if we run
150 GNUNET_NAMESTORE_RF_AUTHORITY = 1,
153 * This is a private record of this peer and it should
154 * thus not be handed out to other peers.
156 GNUNET_NAMESTORE_RF_PRIVATE = 2,
159 * This record was added by the system
160 * and is pending user confimation
162 GNUNET_NAMESTORE_RF_PENDING = 4,
165 * This expiration time of the record is a relative
166 * time (not an absolute time).
168 GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION = 8,
171 * This record should not be used unless all (other) records with an absolute
172 * expiration time have expired.
174 GNUNET_NAMESTORE_RF_SHADOW_RECORD = 16
177 * When comparing flags for record equality for removal,
178 * which flags should must match (in addition to the type,
179 * name, expiration value and data of the record)? All flags
180 * that are not listed here will be ignored for this purpose.
181 * (for example, we don't expect that users will remember to
182 * pass the '--private' option when removing a record from
183 * the namestore, hence we don't require this particular option
184 * to match upon removal). See also
185 * 'GNUNET_NAMESTORE_records_cmp'.
187 #define GNUNET_NAMESTORE_RF_RCMP_FLAGS (GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION)
194 struct GNUNET_NAMESTORE_RecordData
198 * Binary value stored in the DNS record.
199 * FIXME: goofy API: sometimes 'data' is individually
200 * 'malloc'ed, sometimes it points into some existing
201 * data area (so sometimes this should be a 'void *',
202 * sometimes a 'const void *'). This is unclean.
207 * Expiration time for the DNS record. Can be relative
208 * or absolute, depending on 'flags'.
210 uint64_t expiration_time;
213 * Number of bytes in 'data'.
218 * Type of the GNS/DNS record.
220 uint32_t record_type;
223 * Flags for the record.
225 enum GNUNET_NAMESTORE_RecordFlags flags;
230 GNUNET_NETWORK_STRUCT_BEGIN
234 * Information we have in an encrypted block with record data (i.e. in the DHT).
236 struct GNUNET_NAMESTORE_Block
240 * Signature of the block.
242 struct GNUNET_CRYPTO_EccSignature signature;
245 * Derived key used for signing; hash of this is the query.
247 struct GNUNET_CRYPTO_EccPublicKey derived_key;
250 * Number of bytes signed; also specifies the number of bytes
251 * of encrypted data that follow.
253 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
256 * Expiration time of the block.
258 struct GNUNET_TIME_AbsoluteNBO expiration_time;
260 /* followed by encrypted data */
263 GNUNET_NETWORK_STRUCT_END
266 * Store an item in the namestore. If the item is already present,
267 * it is replaced with the new record.
269 * @param h handle to the namestore
270 * @param block block to store
271 * @param cont continuation to call when done
272 * @param cont_cls closure for cont
273 * @return handle to abort the request
275 struct GNUNET_NAMESTORE_QueueEntry *
276 GNUNET_NAMESTORE_block_cache (struct GNUNET_NAMESTORE_Handle *h,
277 const struct GNUNET_NAMESTORE_Block *block,
278 GNUNET_NAMESTORE_ContinuationWithStatus cont,
283 * Store an item in the namestore. If the item is already present,
284 * it is replaced with the new record. Use an empty array to
285 * remove all records under the given name.
287 * @param h handle to the namestore
288 * @param pkey private key of the zone
289 * @param label name that is being mapped (at most 255 characters long)
290 * @param rd_count number of records in the 'rd' array
291 * @param rd array of records with data to store
292 * @param cont continuation to call when done
293 * @param cont_cls closure for 'cont'
294 * @return handle to abort the request
296 struct GNUNET_NAMESTORE_QueueEntry *
297 GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h,
298 const struct GNUNET_CRYPTO_EccPrivateKey *pkey,
300 unsigned int rd_count,
301 const struct GNUNET_NAMESTORE_RecordData *rd,
302 GNUNET_NAMESTORE_ContinuationWithStatus cont,
307 * Process a record that was stored in the namestore.
310 * @param block block that was stored in the namestore
312 typedef void (*GNUNET_NAMESTORE_BlockProcessor) (void *cls,
313 const struct GNUNET_NAMESTORE_Block *block);
317 * Get a result for a particular key from the namestore. The processor
318 * will only be called once.
320 * @param h handle to the namestore
321 * @param derived_hash hash of zone key combined with name to lookup
322 * @param proc function to call on the matching block, or with
323 * NULL if there is no matching block
324 * @param proc_cls closure for proc
325 * @return a handle that can be used to cancel
327 struct GNUNET_NAMESTORE_QueueEntry *
328 GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h,
329 const struct GNUNET_HashCode *derived_hash,
330 GNUNET_NAMESTORE_BlockProcessor proc, void *proc_cls);
334 * Process a record that was stored in the namestore.
337 * @param zone private key of the zone
338 * @param label label of the records
339 * @param rd_count number of entries in 'rd' array
340 * @param rd array of records with data to store
342 typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
343 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
345 unsigned int rd_count,
346 const struct GNUNET_NAMESTORE_RecordData *rd);
350 * Look for an existing PKEY delegation record for a given public key.
351 * Returns at most one result to the processor.
353 * @param h handle to the namestore
354 * @param zone public key of the zone to look up in, never NULL
355 * @param value_zone public key of the target zone (value), never NULL
356 * @param proc function to call on the matching records, or with
357 * NULL (rd_count == 0) if there are no matching records
358 * @param proc_cls closure for proc
359 * @return a handle that can be used to
362 struct GNUNET_NAMESTORE_QueueEntry *
363 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
364 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
365 const struct GNUNET_CRYPTO_EccPublicKey *value_zone,
366 GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls);
370 * Cancel a namestore operation. The final callback from the
371 * operation must not have been done yet. Must be called on any
372 * namestore operation that has not yet completed prior to calling
373 * #GNUNET_NAMESTORE_disconnect.
375 * @param qe operation to cancel
378 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
382 * Starts a new zone iteration (used to periodically PUT all of our
383 * records into our DHT). @a proc will be called once immediately, and
384 * then again after #GNUNET_NAMESTORE_zone_iterator_next is invoked.
386 * @param h handle to the namestore
387 * @param zone zone to access
388 * @param proc function to call on each name from the zone; it
389 * will be called repeatedly with a value (if available)
390 * and always once at the end with a name of NULL.
391 * @param proc_cls closure for proc
392 * @return an iterator handle to use for iteration
394 struct GNUNET_NAMESTORE_ZoneIterator *
395 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
396 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
397 GNUNET_NAMESTORE_RecordMonitor proc,
402 * Calls the record processor specified in GNUNET_NAMESTORE_zone_iteration_start
403 * for the next record.
405 * @param it the iterator
408 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it);
412 * Stops iteration and releases the namestore handle for further calls. Must
413 * be called on any iteration that has not yet completed prior to calling
414 * #GNUNET_NAMESTORE_disconnect.
416 * @param it the iterator
419 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
423 * Handle for a monitoring activity.
425 struct GNUNET_NAMESTORE_ZoneMonitor;
429 * Function called once the monitor has caught up with the current
430 * state of the database. Will be called AGAIN after each disconnect
431 * (record monitor called with 'NULL' for zone_key) once we're again
436 typedef void (*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls);
440 * Begin monitoring a zone for changes. Will first call the 'monitor' function
441 * on all existing records in the selected zone(s), then calls 'sync_cb',
442 * and then calls the 'monitor' whenever a record changes. If the namestore
443 * disconnects, the 'monitor' function is called with a disconnect event; if
444 * the connection is re-established, the process begins from the start (all
445 * existing records, sync, then updates).
447 * @param cfg configuration to use to connect to namestore
448 * @param zone zone to monitor
449 * @param monitor function to call on zone changes
450 * @param sync_cb function called when we're in sync with the namestore
451 * @param cls closure for 'monitor' and 'sync_cb'
452 * @return handle to stop monitoring
454 struct GNUNET_NAMESTORE_ZoneMonitor *
455 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
456 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
457 GNUNET_NAMESTORE_RecordMonitor monitor,
458 GNUNET_NAMESTORE_RecordsSynchronizedCallback sync_cb,
463 * Stop monitoring a zone for changes.
465 * @param zm handle to the monitor activity to stop
468 GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
471 /* convenience APIs for serializing / deserializing GNS records */
474 * Calculate how many bytes we will need to serialize the given
477 * @param rd_count number of records in the rd array
478 * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
480 * @return the required size to serialize
484 GNUNET_NAMESTORE_records_get_size (unsigned int rd_count,
485 const struct GNUNET_NAMESTORE_RecordData *rd);
489 * Serialize the given records to the given destination buffer.
491 * @param rd_count number of records in the rd array
492 * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
493 * @param dest_size size of the destination array
494 * @param dest where to write the result
495 * @return the size of serialized records, -1 if records do not fit
498 GNUNET_NAMESTORE_records_serialize (unsigned int rd_count,
499 const struct GNUNET_NAMESTORE_RecordData *rd,
505 * Deserialize the given records to the given destination.
507 * @param len size of the serialized record data
508 * @param src the serialized record data
509 * @param rd_count number of records in the rd array
510 * @param dest where to put the data
512 * @return GNUNET_OK on success, GNUNET_SYSERR on error
515 GNUNET_NAMESTORE_records_deserialize (size_t len,
517 unsigned int rd_count,
518 struct GNUNET_NAMESTORE_RecordData *dest);
522 * Convert the 'value' of a record to a string.
524 * @param type type of the record
525 * @param data value in binary encoding
526 * @param data_size number of bytes in data
527 * @return NULL on error, otherwise human-readable representation of the value
530 GNUNET_NAMESTORE_value_to_string (uint32_t type,
536 * Convert human-readable version of a 'value' of a record to the binary
539 * @param type type of the record
540 * @param s human-readable string
541 * @param data set to value in binary encoding (will be allocated)
542 * @param data_size set to number of bytes in data
543 * @return GNUNET_OK on success
546 GNUNET_NAMESTORE_string_to_value (uint32_t type,
553 * Convert a type name (i.e. "AAAA") to the corresponding number.
555 * @param typename name to convert
556 * @return corresponding number, UINT32_MAX on error
559 GNUNET_NAMESTORE_typename_to_number (const char *typename);
563 * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
565 * @param type number of a type to convert
566 * @return corresponding typestring, NULL on error
569 GNUNET_NAMESTORE_number_to_typename (uint32_t type);
573 * Test if a given record is expired.
575 * @param rd record to test
576 * @return #GNUNET_YES if the record is expired,
580 GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd);
584 * Convert a UTF-8 string to UTF-8 lowercase
585 * @param src source string
586 * @return converted result
589 GNUNET_NAMESTORE_normalize_string (const char *src);
593 * Convert a zone to a string (for printing debug messages).
594 * This is one of the very few calls in the entire API that is
597 * @param z public key of a zone
598 * @return string form; will be overwritten by next call to #GNUNET_NAMESTORE_z2s.
601 GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicKey *z);
605 * Calculate the DHT query for a given @a label in a given @a zone.
607 * @param zone private key of the zone
608 * @param label label of the record
609 * @param query hash to use for the query
612 GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EccPrivateKey *zone,
614 struct GNUNET_HashCode *query);
618 * Calculate the DHT query for a given @a label in a given @a zone.
620 * @param pub public key of the zone
621 * @param label label of the record
622 * @param query hash to use for the query
625 GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EccPublicKey *pub,
627 struct GNUNET_HashCode *query);
631 * Sign name and records
633 * @param key the private key
634 * @param expire block expiration
635 * @param label the name for the records
636 * @param rd record data
637 * @param rd_count number of records
639 struct GNUNET_NAMESTORE_Block *
640 GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key,
641 struct GNUNET_TIME_Absolute expire,
643 const struct GNUNET_NAMESTORE_RecordData *rd,
644 unsigned int rd_count);
648 * Check if a signature is valid. This API is used by the GNS Block
649 * to validate signatures received from the network.
651 * @param block block to verify
652 * @return #GNUNET_OK if the signature is valid
655 GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block);
661 * @param block block to decrypt
662 * @param zone_key public key of the zone
663 * @param label the name for the records
664 * @param proc function to call with the result
665 * @param proc_cls closure for proc
666 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
670 GNUNET_NAMESTORE_block_decrypt (const struct GNUNET_NAMESTORE_Block *block,
671 const struct GNUNET_CRYPTO_EccPublicKey *zone_key,
673 GNUNET_NAMESTORE_RecordMonitor proc,
678 * Compares if two records are equal
681 * @param b another record
682 * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not.
685 GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a,
686 const struct GNUNET_NAMESTORE_RecordData *b);
690 * Returns the expiration time of the given block of records. The block
691 * expiration time is the expiration time of the block with smallest
694 * @param rd_count number of records given in 'rd'
695 * @param rd array of records
696 * @return absolute expiration time
698 struct GNUNET_TIME_Absolute
699 GNUNET_NAMESTORE_record_get_expiration_time (unsigned int rd_count,
700 const struct GNUNET_NAMESTORE_RecordData *rd);
703 #if 0 /* keep Emacsens' auto-indent happy */
710 /* end of gnunet_namestore_service.h */