3 This file is part of GNUnet
4 (C) 2012, 2013 Christian Grothoff (and other contributing authors)
6 GNUnet is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published
8 by the Free Software Foundation; either version 3, or (at your
9 option) any later version.
11 GNUnet is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNUnet; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.
23 * @file include/gnunet_namestore_service.h
24 * @brief API that can be used to store naming information on a GNUnet node;
25 * Naming information can either be records for which this peer/user
26 * is authoritative, or blocks which are cached, encrypted naming
27 * data from other peers.
28 * @author Christian Grothoff
30 #ifndef GNUNET_NAMESTORE_SERVICE_H
31 #define GNUNET_NAMESTORE_SERVICE_H
33 #include "gnunet_util_lib.h"
34 #include "gnunet_block_lib.h"
39 #if 0 /* keep Emacsens' auto-indent happy */
45 * Record type indicating any record/'*'
47 #define GNUNET_NAMESTORE_TYPE_ANY 0
50 * Record type for GNS zone transfer ("PKEY").
52 #define GNUNET_NAMESTORE_TYPE_PKEY 65536
55 * Record type for GNS zone transfer ("PSEU").
57 #define GNUNET_NAMESTORE_TYPE_PSEU 65537
60 * Record type for GNS legacy hostnames ("LEHO").
62 #define GNUNET_NAMESTORE_TYPE_LEHO 65538
65 * Record type for VPN resolution
67 #define GNUNET_NAMESTORE_TYPE_VPN 65539
70 * Record type for zone revocation
72 #define GNUNET_NAMESTORE_TYPE_REV 65540
75 * Record type for a social place.
77 #define GNUNET_NAMESTORE_TYPE_PLACE 65541
82 struct GNUNET_NAMESTORE_QueueEntry;
85 * Handle to the namestore service.
87 struct GNUNET_NAMESTORE_Handle;
90 * Handle to the namestore zone iterator.
92 struct GNUNET_NAMESTORE_ZoneIterator;
95 * Maximum size of a value that can be stored in the namestore.
97 #define GNUNET_NAMESTORE_MAX_VALUE_SIZE (63 * 1024)
101 * Connect to the namestore service.
103 * @param cfg configuration to use
104 * @return handle to use to access the service
106 struct GNUNET_NAMESTORE_Handle *
107 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
111 * Disconnect from the namestore service (and free associated
114 * @param h handle to the namestore
117 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h);
121 * Continuation called to notify client about result of the
125 * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
126 * GNUNET_NO if content was already there or not found
127 * GNUNET_YES (or other positive value) on success
128 * @param emsg NULL on success, otherwise an error message
130 typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
136 * Flags that can be set for a record.
138 enum GNUNET_NAMESTORE_RecordFlags
142 * No special options.
144 GNUNET_NAMESTORE_RF_NONE = 0,
147 * This peer is the authority for this record; it must thus
148 * not be deleted (other records can be deleted if we run
152 GNUNET_NAMESTORE_RF_AUTHORITY = 1,
155 * This is a private record of this peer and it should
156 * thus not be handed out to other peers.
158 GNUNET_NAMESTORE_RF_PRIVATE = 2,
161 * This record was added automatically by the system
162 * and is pending user confimation.
164 GNUNET_NAMESTORE_RF_PENDING = 4,
167 * This expiration time of the record is a relative
168 * time (not an absolute time).
170 GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION = 8,
173 * This record should not be used unless all (other) records with an absolute
174 * expiration time have expired.
176 GNUNET_NAMESTORE_RF_SHADOW_RECORD = 16
179 * When comparing flags for record equality for removal,
180 * which flags should must match (in addition to the type,
181 * name, expiration value and data of the record)? All flags
182 * that are not listed here will be ignored for this purpose.
183 * (for example, we don't expect that users will remember to
184 * pass the '--private' option when removing a record from
185 * the namestore, hence we don't require this particular option
186 * to match upon removal). See also
187 * 'GNUNET_NAMESTORE_records_cmp'.
189 #define GNUNET_NAMESTORE_RF_RCMP_FLAGS (GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION)
196 struct GNUNET_NAMESTORE_RecordData
200 * Binary value stored in the DNS record. Note: "data" must never
201 * be individually 'malloc'ed, but instead always points into some
202 * existing data area.
207 * Expiration time for the DNS record. Can be relative
208 * or absolute, depending on 'flags'. Measured in the same
209 * unit as GNUnet time (microseconds).
211 uint64_t expiration_time;
214 * Number of bytes in 'data'.
219 * Type of the GNS/DNS record.
221 uint32_t record_type;
224 * Flags for the record.
226 enum GNUNET_NAMESTORE_RecordFlags flags;
231 GNUNET_NETWORK_STRUCT_BEGIN
235 * Information we have in an encrypted block with record data (i.e. in the DHT).
237 struct GNUNET_NAMESTORE_Block
241 * Signature of the block.
243 struct GNUNET_CRYPTO_EccSignature signature;
246 * Derived key used for signing; hash of this is the query.
248 struct GNUNET_CRYPTO_EccPublicKey derived_key;
251 * Number of bytes signed; also specifies the number of bytes
252 * of encrypted data that follow.
254 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
257 * Expiration time of the block.
259 struct GNUNET_TIME_AbsoluteNBO expiration_time;
261 /* followed by encrypted data */
264 GNUNET_NETWORK_STRUCT_END
267 * Store an item in the namestore. If the item is already present,
268 * it is replaced with the new record.
270 * @param h handle to the namestore
271 * @param block block to store
272 * @param cont continuation to call when done
273 * @param cont_cls closure for @a cont
274 * @return handle to abort the request
276 struct GNUNET_NAMESTORE_QueueEntry *
277 GNUNET_NAMESTORE_block_cache (struct GNUNET_NAMESTORE_Handle *h,
278 const struct GNUNET_NAMESTORE_Block *block,
279 GNUNET_NAMESTORE_ContinuationWithStatus cont,
284 * Store an item in the namestore. If the item is already present,
285 * it is replaced with the new record. Use an empty array to
286 * remove all records under the given name.
288 * @param h handle to the namestore
289 * @param pkey private key of the zone
290 * @param label name that is being mapped (at most 255 characters long)
291 * @param rd_count number of records in the 'rd' array
292 * @param rd array of records with data to store
293 * @param cont continuation to call when done
294 * @param cont_cls closure for @a cont
295 * @return handle to abort the request
297 struct GNUNET_NAMESTORE_QueueEntry *
298 GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h,
299 const struct GNUNET_CRYPTO_EccPrivateKey *pkey,
301 unsigned int rd_count,
302 const struct GNUNET_NAMESTORE_RecordData *rd,
303 GNUNET_NAMESTORE_ContinuationWithStatus cont,
308 * Process a record that was stored in the namestore.
311 * @param block block that was stored in the namestore
313 typedef void (*GNUNET_NAMESTORE_BlockProcessor) (void *cls,
314 const struct GNUNET_NAMESTORE_Block *block);
318 * Get a result for a particular key from the namestore. The processor
319 * will only be called once.
321 * @param h handle to the namestore
322 * @param derived_hash hash of zone key combined with name to lookup
323 * @param proc function to call on the matching block, or with
324 * NULL if there is no matching block
325 * @param proc_cls closure for proc
326 * @return a handle that can be used to cancel
328 struct GNUNET_NAMESTORE_QueueEntry *
329 GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h,
330 const struct GNUNET_HashCode *derived_hash,
331 GNUNET_NAMESTORE_BlockProcessor proc, void *proc_cls);
335 * Process a record that was stored in the namestore.
338 * @param zone private key of the zone
339 * @param label label of the records
340 * @param rd_count number of entries in @a rd array
341 * @param rd array of records with data to store
343 typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
344 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
346 unsigned int rd_count,
347 const struct GNUNET_NAMESTORE_RecordData *rd);
351 * Look for an existing PKEY delegation record for a given public key.
352 * Returns at most one result to the processor.
354 * @param h handle to the namestore
355 * @param zone public key of the zone to look up in, never NULL
356 * @param value_zone public key of the target zone (value), never NULL
357 * @param proc function to call on the matching records, or with
358 * NULL (rd_count == 0) if there are no matching records
359 * @param proc_cls closure for proc
360 * @return a handle that can be used to
363 struct GNUNET_NAMESTORE_QueueEntry *
364 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
365 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
366 const struct GNUNET_CRYPTO_EccPublicKey *value_zone,
367 GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls);
371 * Process a records that were decrypted from a block.
374 * @param rd_count number of entries in @a rd array
375 * @param rd array of records with data to store
377 typedef void (*GNUNET_NAMESTORE_RecordCallback) (void *cls,
378 unsigned int rd_count,
379 const struct GNUNET_NAMESTORE_RecordData *rd);
383 * Cancel a namestore operation. The final callback from the
384 * operation must not have been done yet. Must be called on any
385 * namestore operation that has not yet completed prior to calling
386 * #GNUNET_NAMESTORE_disconnect.
388 * @param qe operation to cancel
391 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
395 * Starts a new zone iteration (used to periodically PUT all of our
396 * records into our DHT). @a proc will be called once immediately, and
397 * then again after #GNUNET_NAMESTORE_zone_iterator_next is invoked.
399 * @param h handle to the namestore
400 * @param zone zone to access
401 * @param proc function to call on each name from the zone; it
402 * will be called repeatedly with a value (if available)
403 * and always once at the end with a name of NULL.
404 * @param proc_cls closure for proc
405 * @return an iterator handle to use for iteration
407 struct GNUNET_NAMESTORE_ZoneIterator *
408 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
409 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
410 GNUNET_NAMESTORE_RecordMonitor proc,
415 * Calls the record processor specified in #GNUNET_NAMESTORE_zone_iteration_start
416 * for the next record.
418 * @param it the iterator
421 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it);
425 * Stops iteration and releases the namestore handle for further calls. Must
426 * be called on any iteration that has not yet completed prior to calling
427 * #GNUNET_NAMESTORE_disconnect.
429 * @param it the iterator
432 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
436 * Handle for a monitoring activity.
438 struct GNUNET_NAMESTORE_ZoneMonitor;
442 * Function called once the monitor has caught up with the current
443 * state of the database. Will be called AGAIN after each disconnect
444 * (record monitor called with 'NULL' for zone_key) once we're again
449 typedef void (*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls);
453 * Begin monitoring a zone for changes. Will first call the @a monitor function
454 * on all existing records in the selected zone(s), then calls @a sync_cb,
455 * and then calls the @a monitor whenever a record changes. If the namestore
456 * disconnects, the @a monitor function is called with a disconnect event; if
457 * the connection is re-established, the process begins from the start (all
458 * existing records, sync, then updates).
460 * @param cfg configuration to use to connect to namestore
461 * @param zone zone to monitor
462 * @param monitor function to call on zone changes
463 * @param sync_cb function called when we're in sync with the namestore
464 * @param cls closure for @a monitor' and @a sync_cb
465 * @return handle to stop monitoring
467 struct GNUNET_NAMESTORE_ZoneMonitor *
468 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
469 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
470 GNUNET_NAMESTORE_RecordMonitor monitor,
471 GNUNET_NAMESTORE_RecordsSynchronizedCallback sync_cb,
476 * Stop monitoring a zone for changes.
478 * @param zm handle to the monitor activity to stop
481 GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
484 /* convenience APIs for serializing / deserializing GNS records */
487 * Calculate how many bytes we will need to serialize the given
490 * @param rd_count number of records in the @a rd array
491 * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
492 * @return the required size to serialize
495 GNUNET_NAMESTORE_records_get_size (unsigned int rd_count,
496 const struct GNUNET_NAMESTORE_RecordData *rd);
500 * Serialize the given records to the given destination buffer.
502 * @param rd_count number of records in the @a rd array
503 * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
504 * @param dest_size size of the destination array @a dst
505 * @param dest where to write the result
506 * @return the size of serialized records, -1 if records do not fit
509 GNUNET_NAMESTORE_records_serialize (unsigned int rd_count,
510 const struct GNUNET_NAMESTORE_RecordData *rd,
516 * Deserialize the given records to the given destination.
518 * @param len size of the serialized record data
519 * @param src the serialized record data
520 * @param rd_count number of records in the @a dest array
521 * @param dest where to put the data
522 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
525 GNUNET_NAMESTORE_records_deserialize (size_t len,
527 unsigned int rd_count,
528 struct GNUNET_NAMESTORE_RecordData *dest);
532 * Convert the binary value @a data of a record of
533 * type @a type to a human-readable string.
535 * @param type type of the record
536 * @param data value in binary encoding
537 * @param data_size number of bytes in @a data
538 * @return NULL on error, otherwise human-readable representation of the value
541 GNUNET_NAMESTORE_value_to_string (uint32_t type,
547 * Convert human-readable version of the value @a s of a record
548 * of type @a type to the respective binary representation.
550 * @param type type of the record
551 * @param s human-readable string
552 * @param data set to value in binary encoding (will be allocated)
553 * @param data_size set to number of bytes in @a data
554 * @return #GNUNET_OK on success
557 GNUNET_NAMESTORE_string_to_value (uint32_t type,
564 * Convert a type name (i.e. "AAAA") to the corresponding number.
566 * @param typename name to convert
567 * @return corresponding number, UINT32_MAX on error
570 GNUNET_NAMESTORE_typename_to_number (const char *typename);
574 * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
576 * @param type number of a type to convert
577 * @return corresponding typestring, NULL on error
580 GNUNET_NAMESTORE_number_to_typename (uint32_t type);
584 * Test if a given record is expired.
586 * @param rd record to test
587 * @return #GNUNET_YES if the record is expired,
591 GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd);
595 * Convert a UTF-8 string to UTF-8 lowercase
596 * @param src source string
597 * @return converted result
600 GNUNET_NAMESTORE_normalize_string (const char *src);
604 * Convert a zone to a string (for printing debug messages).
605 * This is one of the very few calls in the entire API that is
608 * @param z public key of a zone
609 * @return string form; will be overwritten by next call to #GNUNET_NAMESTORE_z2s.
612 GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicKey *z);
616 * Convert public key to the respective absolute domain name in the
618 * This is one of the very few calls in the entire API that is
621 * @param pkey a public key with (x,y) on the eliptic curve
622 * @return string "Y.X.zkey" where X and Y are the coordinates of the public
623 * key in an encoding suitable for DNS labels.
626 GNUNET_NAMESTORE_pkey_to_zkey (const struct GNUNET_CRYPTO_EccPublicKey *pkey);
630 * Convert an absolute domain name in the ".zkey" pTLD to the
631 * respective public key.
633 * @param zkey string "Y.X.zkey" where X and Y are the coordinates of the public
634 * key in an encoding suitable for DNS labels.
635 * @param pkey set to a public key with (x,y) on the eliptic curve
636 * @return #GNUNET_SYSERR if @a zkey has the wrong syntax
639 GNUNET_NAMESTORE_zkey_to_pkey (const char *zkey,
640 struct GNUNET_CRYPTO_EccPublicKey *pkey);
644 * Calculate the DHT query for a given @a label in a given @a zone.
646 * @param zone private key of the zone
647 * @param label label of the record
648 * @param query hash to use for the query
651 GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EccPrivateKey *zone,
653 struct GNUNET_HashCode *query);
657 * Calculate the DHT query for a given @a label in a given @a zone.
659 * @param pub public key of the zone
660 * @param label label of the record
661 * @param query hash to use for the query
664 GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EccPublicKey *pub,
666 struct GNUNET_HashCode *query);
670 * Sign name and records
672 * @param key the private key
673 * @param expire block expiration
674 * @param label the name for the records
675 * @param rd record data
676 * @param rd_count number of records in @a rd
678 struct GNUNET_NAMESTORE_Block *
679 GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key,
680 struct GNUNET_TIME_Absolute expire,
682 const struct GNUNET_NAMESTORE_RecordData *rd,
683 unsigned int rd_count);
687 * Check if a signature is valid. This API is used by the GNS Block
688 * to validate signatures received from the network.
690 * @param block block to verify
691 * @return #GNUNET_OK if the signature is valid
694 GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block);
700 * @param block block to decrypt
701 * @param zone_key public key of the zone
702 * @param label the name for the records
703 * @param proc function to call with the result
704 * @param proc_cls closure for @a proc
705 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
709 GNUNET_NAMESTORE_block_decrypt (const struct GNUNET_NAMESTORE_Block *block,
710 const struct GNUNET_CRYPTO_EccPublicKey *zone_key,
712 GNUNET_NAMESTORE_RecordCallback proc,
717 * Compares if two records are equal
720 * @param b another record
721 * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not.
724 GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a,
725 const struct GNUNET_NAMESTORE_RecordData *b);
729 * Returns the expiration time of the given block of records. The block
730 * expiration time is the expiration time of the block with smallest
733 * @param rd_count number of records given in @a rd
734 * @param rd array of records
735 * @return absolute expiration time
737 struct GNUNET_TIME_Absolute
738 GNUNET_NAMESTORE_record_get_expiration_time (unsigned int rd_count,
739 const struct GNUNET_NAMESTORE_RecordData *rd);
742 #if 0 /* keep Emacsens' auto-indent happy */
749 /* end of gnunet_namestore_service.h */