2 This file is part of GNUnet.
3 (C) 2009, 2010 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 gns/namestore_api.c
23 * @brief API to access the NAMESTORE service
24 * @author Martin Schanzenbach
25 * @author Matthias Wachs
29 #include "gnunet_util_lib.h"
30 #include "gnunet_constants.h"
31 #include "gnunet_arm_service.h"
32 #include "gnunet_namestore_service.h"
33 #include "namestore.h"
34 #define DEBUG_GNS_API GNUNET_EXTRA_LOGGING
36 #define LOG(kind,...) GNUNET_log_from (kind, "gns-api",__VA_ARGS__)
41 struct GNUNET_NAMESTORE_QueueEntry
43 char *data; /*stub data pointer*/
48 * Message in linked list we should send to the service. The
49 * actual binary message follows this struct.
57 struct PendingMessage *next;
62 struct PendingMessage *prev;
65 * Size of the message.
70 * Is this the 'START' message?
77 * Connection to the NAMESTORE service.
79 struct GNUNET_NAMESTORE_Handle
83 * Configuration to use.
85 const struct GNUNET_CONFIGURATION_Handle *cfg;
88 * Socket (if available).
90 struct GNUNET_CLIENT_Connection *client;
93 * Currently pending transmission request (or NULL).
95 struct GNUNET_CLIENT_TransmitHandle *th;
100 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
103 * Pending messages to send to the service
106 struct PendingMessage * pending_head;
107 struct PendingMessage * pending_tail;
110 * Should we reconnect to service due to some serious error?
115 struct GNUNET_NAMESTORE_SimpleRecord
120 struct GNUNET_NAMESTORE_SimpleRecord *next;
125 struct GNUNET_NAMESTORE_SimpleRecord *prev;
128 const GNUNET_HashCode *zone;
129 uint32_t record_type;
130 struct GNUNET_TIME_Absolute expiration;
131 enum GNUNET_NAMESTORE_RecordFlags flags;
137 * Disconnect from service and then reconnect.
139 * @param nsh our handle
142 force_reconnect (struct GNUNET_NAMESTORE_Handle *nsh);
146 * Type of a function to call when we receive a message
149 * @param cls the 'struct GNUNET_NAMESTORE_SchedulingHandle'
150 * @param msg message received, NULL on timeout or fatal error
153 process_namestore_message (void *cls, const struct GNUNET_MessageHeader *msg)
155 struct GNUNET_NAMESTORE_Handle *nsh = cls;
161 force_reconnect (nsh);
165 size = ntohs (msg->size);
166 type = ntohs (msg->type);
169 case GNUNET_MESSAGE_TYPE_TEST:
170 /* handle message here */
176 GNUNET_CLIENT_receive (nsh->client, &process_namestore_message, nsh,
177 GNUNET_TIME_UNIT_FOREVER_REL);
179 if (GNUNET_YES == nsh->reconnect)
180 force_reconnect (nsh);
185 * Transmit messages from the message queue to the service
186 * (if there are any, and if we are not already trying).
188 * @param nsh handle to use
191 do_transmit (struct GNUNET_NAMESTORE_Handle *nsh);
195 * We can now transmit a message to NAMESTORE. Do it.
197 * @param cls the 'struct GNUNET_NAMESTORE_Handle'
198 * @param size number of bytes we can transmit
199 * @param buf where to copy the messages
200 * @return number of bytes copied into buf
203 transmit_message_to_namestore (void *cls, size_t size, void *buf)
205 struct GNUNET_NAMESTORE_Handle *nsh = cls;
206 struct PendingMessage *p;
211 if ((size == 0) || (buf == NULL))
213 force_reconnect (nsh);
218 while ((NULL != (p = nsh->pending_head)) && (p->size <= size))
220 memcpy (&cbuf[ret], &p[1], p->size);
223 GNUNET_CONTAINER_DLL_remove (nsh->pending_head, nsh->pending_tail, p);
224 if (GNUNET_YES == p->is_init)
225 GNUNET_CLIENT_receive (nsh->client, &process_namestore_message, nsh,
226 GNUNET_TIME_UNIT_FOREVER_REL);
235 * Transmit messages from the message queue to the service
236 * (if there are any, and if we are not already trying).
238 * @param nsh handle to use
241 do_transmit (struct GNUNET_NAMESTORE_Handle *nsh)
243 struct PendingMessage *p;
247 if (NULL == (p = nsh->pending_head))
249 if (NULL == nsh->client)
250 return; /* currently reconnecting */
252 nsh->th = GNUNET_CLIENT_notify_transmit_ready (nsh->client, p->size,
253 GNUNET_TIME_UNIT_FOREVER_REL,
254 GNUNET_NO, &transmit_message_to_namestore,
260 * Try again to connect to namestore service.
262 * @param cls the handle to the namestore service
263 * @param tc scheduler context
266 reconnect (struct GNUNET_NAMESTORE_Handle *nsh)
268 struct PendingMessage *p;
269 struct StartMessage *init;
271 GNUNET_assert (NULL == nsh->client);
272 nsh->client = GNUNET_CLIENT_connect ("namestore", nsh->cfg);
273 GNUNET_assert (NULL != nsh->client);
275 if ((NULL == (p = nsh->pending_head)) || (GNUNET_YES != p->is_init))
277 p = GNUNET_malloc (sizeof (struct PendingMessage) +
278 sizeof (struct StartMessage));
279 p->size = sizeof (struct StartMessage);
280 p->is_init = GNUNET_YES;
281 init = (struct StartMessage *) &p[1];
282 init->header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_START);
283 init->header.size = htons (sizeof (struct StartMessage));
284 GNUNET_CONTAINER_DLL_insert (nsh->pending_head, nsh->pending_tail, p);
290 * Re-establish the connection to the service.
292 * @param cls handle to use to re-connect.
293 * @param tc scheduler context
296 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
298 struct GNUNET_NAMESTORE_Handle *nsh = cls;
300 nsh->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
306 * Disconnect from service and then reconnect.
308 * @param nsh our handle
311 force_reconnect (struct GNUNET_NAMESTORE_Handle *nsh)
313 nsh->reconnect = GNUNET_NO;
314 GNUNET_CLIENT_disconnect (nsh->client, GNUNET_NO);
316 nsh->reconnect_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
324 * Initialize the connection with the NAMESTORE service.
326 * @param cfg configuration to use
327 * @return handle to the GNS service, or NULL on error
329 struct GNUNET_NAMESTORE_Handle *
330 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
332 struct GNUNET_NAMESTORE_Handle *nsh;
334 nsh = GNUNET_malloc (sizeof (struct GNUNET_NAMESTORE_Handle));
336 nsh->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect_task, nsh);
342 * Shutdown connection with the NAMESTORE service.
344 * @param handle handle of the NAMESTORE connection to stop
347 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *nsh, int drop)
349 struct PendingMessage *p;
351 while (NULL != (p = nsh->pending_head))
353 GNUNET_CONTAINER_DLL_remove (nsh->pending_head, nsh->pending_tail, p);
356 if (NULL != nsh->client)
358 GNUNET_CLIENT_disconnect (nsh->client, GNUNET_NO);
361 if (GNUNET_SCHEDULER_NO_TASK != nsh->reconnect_task)
363 GNUNET_SCHEDULER_cancel (nsh->reconnect_task);
364 nsh->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
371 * Sign a record. This function is used by the authority of the zone
374 * @param h handle to the namestore
375 * @param zone_privkey private key of the zone
376 * @param record_hash hash of the record to be signed
377 * @param cont continuation to call when done
378 * @param cont_cls closure for cont
379 * @return handle to abort the request
381 struct GNUNET_NAMESTORE_QueueEntry *
382 GNUNET_NAMESTORE_stree_extend (struct GNUNET_NAMESTORE_Handle *h,
383 const struct GNUNET_CRYPTO_RsaPrivateKey *zone_privkey,
384 const GNUNET_HashCode *record_hash,
385 GNUNET_NAMESTORE_ContinuationWithSignature cont,
388 struct GNUNET_NAMESTORE_QueueEntry *qe;
389 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
394 * Rebalance the signature tree of our zone. This function should
395 * be called "rarely" to rebalance the tree.
397 * @param h handle to the namestore
398 * @param zone_privkey private key for the zone to rebalance
399 * @param cont continuation to call when done
400 * @param cont_cls closure for cont
401 * @return handle to abort the request
403 struct GNUNET_NAMESTORE_QueueEntry *
404 GNUNET_NAMESTORE_stree_rebalance (struct GNUNET_NAMESTORE_Handle *h,
405 const struct GNUNET_CRYPTO_RsaPrivateKey *zone_privkey,
406 GNUNET_NAMESTORE_ContinuationWithStatus cont,
409 struct GNUNET_NAMESTORE_QueueEntry *qe;
410 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
415 * Provide the root of a signature tree. This function is
416 * used by non-authorities as the first operation when
417 * adding a foreign zone.
419 * @param h handle to the namestore
420 * @param zone_key public key of the zone
421 * @param signature signature of the top-level entry of the zone
422 * @param revision revision number of the zone
423 * @param top_hash top-level hash of the zone
424 * @param cont continuation to call when done
425 * @param cont_cls closure for cont
426 * @return handle to abort the request
428 struct GNUNET_NAMESTORE_QueueEntry *
429 GNUNET_NAMESTORE_stree_start (struct GNUNET_NAMESTORE_Handle *h,
430 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
431 const struct GNUNET_CRYPTO_RsaSignature *signature,
433 const GNUNET_HashCode *top_hash,
434 GNUNET_NAMESTORE_ContinuationWithSignature cont,
437 struct GNUNET_NAMESTORE_QueueEntry *qe;
438 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
443 * Store part of a signature B-tree in the namestore. This function
444 * is used by non-authorities to cache parts of a zone's signature tree.
445 * Note that the tree must be build top-down. This function must check
446 * that the nodes being added are valid, and if not refuse the operation.
448 * @param h handle to the namestore
449 * @param zone_key public key of the zone
450 * @param loc location in the B-tree
451 * @param ploc parent's location in the B-tree (must have depth = loc.depth - 1)
452 * @param num_entries number of entries at this node in the B-tree
453 * @param entries the 'num_entries' entries to store (hashes over the
455 * @param cont continuation to call when done
456 * @param cont_cls closure for cont
457 * @return handle to abort the request
459 struct GNUNET_NAMESTORE_QueueEntry *
460 GNUNET_NAMESTORE_stree_put (struct GNUNET_NAMESTORE_Handle *h,
461 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
462 const struct GNUNET_NAMESTORE_SignatureLocation *loc,
463 const struct GNUNET_NAMESTORE_SignatureLocation *ploc,
464 unsigned int num_entries,
465 const GNUNET_HashCode *entries,
466 GNUNET_NAMESTORE_ContinuationWithStatus cont,
469 struct GNUNET_NAMESTORE_QueueEntry *qe;
470 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
475 * Store an item in the namestore. If the item is already present,
476 * the expiration time is updated to the max of the existing time and
477 * the new time. The operation must fail if there is no matching
478 * entry in the signature tree.
480 * @param h handle to the namestore
481 * @param zone hash of the public key of the zone
482 * @param name name that is being mapped (at most 255 characters long)
483 * @param record_type type of the record (A, AAAA, PKEY, etc.)
484 * @param expiration expiration time for the content
485 * @param flags flags for the content
486 * @param sig_loc where is the information about the signature for this record stored?
487 * @param data_size number of bytes in data
488 * @param data value, semantics depend on 'record_type' (see RFCs for DNS and
489 * GNS specification for GNS extensions)
490 * @param cont continuation to call when done
491 * @param cont_cls closure for cont
492 * @return handle to abort the request
494 struct GNUNET_NAMESTORE_QueueEntry *
495 GNUNET_NAMESTORE_record_put (struct GNUNET_NAMESTORE_Handle *h,
496 const GNUNET_HashCode *zone,
498 uint32_t record_type,
499 struct GNUNET_TIME_Absolute expiration,
500 enum GNUNET_NAMESTORE_RecordFlags flags,
501 const struct GNUNET_NAMESTORE_SignatureLocation *sig_loc,
504 GNUNET_NAMESTORE_ContinuationWithStatus cont,
507 struct GNUNET_NAMESTORE_QueueEntry *qe;
508 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
510 struct GNUNET_NAMESTORE_SimpleRecord *sr;
511 sr = GNUNET_malloc(sizeof(struct GNUNET_NAMESTORE_SimpleRecord));
513 sr->record_type = record_type;
514 sr->expiration = expiration;
516 sr->data_size = data_size;
518 GNUNET_CONTAINER_DLL_insert(h->records_head, h->records_tail, sr);
524 * Explicitly remove some content from the database. The
525 * "cont"inuation will be called with status "GNUNET_OK" if content
526 * was removed, "GNUNET_NO" if no matching entry was found and
527 * "GNUNET_SYSERR" on all other types of errors.
529 * @param h handle to the namestore
530 * @param zone hash of the public key of the zone
531 * @param name name that is being mapped (at most 255 characters long)
532 * @param record_type type of the record (A, AAAA, PKEY, etc.)
533 * @param size number of bytes in data
534 * @param data content stored
535 * @param cont continuation to call when done
536 * @param cont_cls closure for cont
537 * @return handle to abort the request
539 struct GNUNET_NAMESTORE_QueueEntry *
540 GNUNET_NAMESTORE_record_remove (struct GNUNET_NAMESTORE_Handle *h,
541 const GNUNET_HashCode *zone,
543 uint32_t record_type,
546 GNUNET_NAMESTORE_ContinuationWithStatus cont,
549 struct GNUNET_NAMESTORE_QueueEntry *qe;
550 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
552 struct GNUNET_NAMESTORE_SimpleRecord *iter;
553 for (iter=h->records_head; iter != NULL; iter=iter->next)
555 if (strcmp ( iter->name, name ) &&
556 iter->record_type == record_type &&
557 GNUNET_CRYPTO_hash_cmp (iter->zone, zone))
561 GNUNET_CONTAINER_DLL_remove(h->records_head,
569 * Get a result for a particular key from the namestore. The processor
570 * will only be called once.
572 * @param h handle to the namestore
573 * @param zone zone to look up a record from
574 * @param name name to look up
575 * @param record_type desired record type
576 * @param proc function to call on each matching value;
577 * will be called once with a NULL value at the end
578 * @param proc_cls closure for proc
579 * @return a handle that can be used to
582 struct GNUNET_NAMESTORE_QueueEntry *
583 GNUNET_NAMESTORE_lookup_name (struct GNUNET_NAMESTORE_Handle *nsh,
584 const GNUNET_HashCode *zone,
586 uint32_t record_type,
587 GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls)
589 struct GNUNET_NAMESTORE_QueueEntry *qe;
590 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
592 struct GNUNET_NAMESTORE_SimpleRecord *iter;
593 for (iter=h->records_head; iter != NULL; iter=iter->next)
595 proc(proc_cls, iter->zone, iter->name, iter->record_type,
599 iter->data_size /*size*/,
600 iter->data /* data */);
602 proc(proc_cls, zone, name, record_type,
603 GNUNET_TIME_absolute_get_forever(), 0, NULL, 0, NULL); /*TERMINATE*/
606 GNUNET_assert (NULL != nsh);
608 struct PendingMessage * p;
609 struct LookupNameMessage * msg;
610 size_t msg_len = sizeof (struct LookupNameMessage);
612 p = GNUNET_malloc (sizeof (struct PendingMessage) + msg_len);
614 p->is_init = GNUNET_NO;
615 msg = (struct LookupNameMessage *) &p[1];
616 msg->header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME);
617 msg->header.size = htons (msg_len);
618 GNUNET_CONTAINER_DLL_insert (nsh->pending_head, nsh->pending_tail, p);
626 * Get the hash of a record (what will be signed in the Stree for
629 * @param zone hash of the public key of the zone
630 * @param name name that is being mapped (at most 255 characters long)
631 * @param record_type type of the record (A, AAAA, PKEY, etc.)
632 * @param expiration expiration time for the content
633 * @param flags flags for the content
634 * @param data_size number of bytes in data
635 * @param data value, semantics depend on 'record_type' (see RFCs for DNS and.
636 * GNS specification for GNS extensions)
637 * @param record_hash hash of the record (set)
640 GNUNET_NAMESTORE_record_hash (struct GNUNET_NAMESTORE_Handle *h,
641 const GNUNET_HashCode *zone,
643 uint32_t record_type,
644 struct GNUNET_TIME_Absolute expiration,
645 enum GNUNET_NAMESTORE_RecordFlags flags,
648 GNUNET_HashCode *record_hash)
650 char* teststring = "namestore-stub";
651 GNUNET_CRYPTO_hash(teststring, strlen(teststring), record_hash);
655 * Obtain part of a signature B-tree. The processor
656 * will only be called once.
658 * @param h handle to the namestore
659 * @param zone zone to look up a record from
660 * @param sig_loc location to look up
661 * @param proc function to call on each matching value;
662 * will be called once with a NULL value at the end
663 * @param proc_cls closure for proc
664 * @return a handle that can be used to
667 struct GNUNET_NAMESTORE_QueueEntry *
668 GNUNET_NAMESTORE_lookup_stree (struct GNUNET_NAMESTORE_Handle *h,
669 const GNUNET_HashCode *zone,
670 const struct GNUNET_NAMESTORE_SignatureLocation *sig_loc,
671 GNUNET_NAMESTORE_StreeProcessor proc, void *proc_cls)
673 struct GNUNET_NAMESTORE_QueueEntry *qe;
674 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
680 * Get all records of a zone.
682 * @param h handle to the namestore
683 * @param zone zone to access
684 * @param proc function to call on a random value; it
685 * will be called repeatedly with a value (if available)
686 * and always once at the end with a zone and name of NULL.
687 * @param proc_cls closure for proc
688 * @return a handle that can be used to
691 struct GNUNET_NAMESTORE_QueueEntry *
692 GNUNET_NAMESTORE_zone_transfer (struct GNUNET_NAMESTORE_Handle *h,
693 const GNUNET_HashCode *zone,
694 GNUNET_NAMESTORE_RecordProcessor proc,
697 struct GNUNET_NAMESTORE_QueueEntry *qe;
698 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
706 * Cancel a namestore operation. The final callback from the
707 * operation must not have been done yet.
709 * @param qe operation to cancel
712 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe)
718 /* end of namestore_api.c */