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 */
251 nsh->th = GNUNET_CLIENT_notify_transmit_ready (nsh->client, p->size,
252 GNUNET_TIME_UNIT_FOREVER_REL,
253 GNUNET_NO, &transmit_message_to_namestore,
259 * Try again to connect to namestore service.
261 * @param cls the handle to the namestore service
262 * @param tc scheduler context
265 reconnect (struct GNUNET_NAMESTORE_Handle *nsh)
267 struct PendingMessage *p;
268 struct StartMessage *init;
270 GNUNET_assert (NULL == nsh->client);
271 nsh->client = GNUNET_CLIENT_connect ("namestore", nsh->cfg);
272 GNUNET_assert (NULL != nsh->client);
274 if ((NULL == (p = nsh->pending_head)) || (GNUNET_YES != p->is_init))
276 p = GNUNET_malloc (sizeof (struct PendingMessage) +
277 sizeof (struct StartMessage));
278 p->size = sizeof (struct StartMessage);
279 p->is_init = GNUNET_YES;
280 init = (struct StartMessage *) &p[1];
281 init->header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_START);
282 init->header.size = htons (sizeof (struct StartMessage));
283 GNUNET_CONTAINER_DLL_insert (nsh->pending_head, nsh->pending_tail, p);
289 * Re-establish the connection to the service.
291 * @param cls handle to use to re-connect.
292 * @param tc scheduler context
295 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
297 struct GNUNET_NAMESTORE_Handle *nsh = cls;
299 nsh->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
305 * Disconnect from service and then reconnect.
307 * @param nsh our handle
310 force_reconnect (struct GNUNET_NAMESTORE_Handle *nsh)
312 nsh->reconnect = GNUNET_NO;
313 GNUNET_CLIENT_disconnect (nsh->client, GNUNET_NO);
315 nsh->reconnect_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
323 * Initialize the connection with the NAMESTORE service.
325 * @param cfg configuration to use
326 * @return handle to the GNS service, or NULL on error
328 struct GNUNET_NAMESTORE_Handle *
329 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
331 struct GNUNET_NAMESTORE_Handle *nsh;
333 nsh = GNUNET_malloc (sizeof (struct GNUNET_NAMESTORE_Handle));
335 nsh->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect_task, nsh);
341 * Shutdown connection with the NAMESTORE service.
343 * @param handle handle of the NAMESTORE connection to stop
346 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *nsh, int drop)
348 struct PendingMessage *p;
350 while (NULL != (p = nsh->pending_head))
352 GNUNET_CONTAINER_DLL_remove (nsh->pending_head, nsh->pending_tail, p);
355 if (NULL != nsh->client)
357 GNUNET_CLIENT_disconnect (nsh->client, GNUNET_NO);
360 if (GNUNET_SCHEDULER_NO_TASK != nsh->reconnect_task)
362 GNUNET_SCHEDULER_cancel (nsh->reconnect_task);
363 nsh->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
370 * Sign a record. This function is used by the authority of the zone
373 * @param h handle to the namestore
374 * @param zone_privkey private key of the zone
375 * @param record_hash hash of the record to be signed
376 * @param cont continuation to call when done
377 * @param cont_cls closure for cont
378 * @return handle to abort the request
380 struct GNUNET_NAMESTORE_QueueEntry *
381 GNUNET_NAMESTORE_stree_extend (struct GNUNET_NAMESTORE_Handle *h,
382 const struct GNUNET_CRYPTO_RsaPrivateKey *zone_privkey,
383 const GNUNET_HashCode *record_hash,
384 GNUNET_NAMESTORE_ContinuationWithSignature cont,
387 struct GNUNET_NAMESTORE_QueueEntry *qe;
388 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
393 * Rebalance the signature tree of our zone. This function should
394 * be called "rarely" to rebalance the tree.
396 * @param h handle to the namestore
397 * @param zone_privkey private key for the zone to rebalance
398 * @param cont continuation to call when done
399 * @param cont_cls closure for cont
400 * @return handle to abort the request
402 struct GNUNET_NAMESTORE_QueueEntry *
403 GNUNET_NAMESTORE_stree_rebalance (struct GNUNET_NAMESTORE_Handle *h,
404 const struct GNUNET_CRYPTO_RsaPrivateKey *zone_privkey,
405 GNUNET_NAMESTORE_ContinuationWithStatus cont,
408 struct GNUNET_NAMESTORE_QueueEntry *qe;
409 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
414 * Provide the root of a signature tree. This function is
415 * used by non-authorities as the first operation when
416 * adding a foreign zone.
418 * @param h handle to the namestore
419 * @param zone_key public key of the zone
420 * @param signature signature of the top-level entry of the zone
421 * @param revision revision number of the zone
422 * @param top_hash top-level hash of the zone
423 * @param cont continuation to call when done
424 * @param cont_cls closure for cont
425 * @return handle to abort the request
427 struct GNUNET_NAMESTORE_QueueEntry *
428 GNUNET_NAMESTORE_stree_start (struct GNUNET_NAMESTORE_Handle *h,
429 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
430 const struct GNUNET_CRYPTO_RsaSignature *signature,
432 const GNUNET_HashCode *top_hash,
433 GNUNET_NAMESTORE_ContinuationWithSignature cont,
436 struct GNUNET_NAMESTORE_QueueEntry *qe;
437 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
442 * Store part of a signature B-tree in the namestore. This function
443 * is used by non-authorities to cache parts of a zone's signature tree.
444 * Note that the tree must be build top-down. This function must check
445 * that the nodes being added are valid, and if not refuse the operation.
447 * @param h handle to the namestore
448 * @param zone_key public key of the zone
449 * @param loc location in the B-tree
450 * @param ploc parent's location in the B-tree (must have depth = loc.depth - 1)
451 * @param num_entries number of entries at this node in the B-tree
452 * @param entries the 'num_entries' entries to store (hashes over the
454 * @param cont continuation to call when done
455 * @param cont_cls closure for cont
456 * @return handle to abort the request
458 struct GNUNET_NAMESTORE_QueueEntry *
459 GNUNET_NAMESTORE_stree_put (struct GNUNET_NAMESTORE_Handle *h,
460 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
461 const struct GNUNET_NAMESTORE_SignatureLocation *loc,
462 const struct GNUNET_NAMESTORE_SignatureLocation *ploc,
463 unsigned int num_entries,
464 const GNUNET_HashCode *entries,
465 GNUNET_NAMESTORE_ContinuationWithStatus cont,
468 struct GNUNET_NAMESTORE_QueueEntry *qe;
469 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
474 * Store an item in the namestore. If the item is already present,
475 * the expiration time is updated to the max of the existing time and
476 * the new time. The operation must fail if there is no matching
477 * entry in the signature tree.
479 * @param h handle to the namestore
480 * @param zone hash of the public key of the zone
481 * @param name name that is being mapped (at most 255 characters long)
482 * @param record_type type of the record (A, AAAA, PKEY, etc.)
483 * @param expiration expiration time for the content
484 * @param flags flags for the content
485 * @param sig_loc where is the information about the signature for this record stored?
486 * @param data_size number of bytes in data
487 * @param data value, semantics depend on 'record_type' (see RFCs for DNS and
488 * GNS specification for GNS extensions)
489 * @param cont continuation to call when done
490 * @param cont_cls closure for cont
491 * @return handle to abort the request
493 struct GNUNET_NAMESTORE_QueueEntry *
494 GNUNET_NAMESTORE_record_put (struct GNUNET_NAMESTORE_Handle *h,
495 const GNUNET_HashCode *zone,
497 uint32_t record_type,
498 struct GNUNET_TIME_Absolute expiration,
499 enum GNUNET_NAMESTORE_RecordFlags flags,
500 const struct GNUNET_NAMESTORE_SignatureLocation *sig_loc,
503 GNUNET_NAMESTORE_ContinuationWithStatus cont,
506 struct GNUNET_NAMESTORE_QueueEntry *qe;
507 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
509 struct GNUNET_NAMESTORE_SimpleRecord *sr;
510 sr = GNUNET_malloc(sizeof(struct GNUNET_NAMESTORE_SimpleRecord));
512 sr->record_type = record_type;
513 sr->expiration = expiration;
515 sr->data_size = data_size;
517 GNUNET_CONTAINER_DLL_insert(h->records_head, h->records_tail, sr);
523 * Explicitly remove some content from the database. The
524 * "cont"inuation will be called with status "GNUNET_OK" if content
525 * was removed, "GNUNET_NO" if no matching entry was found and
526 * "GNUNET_SYSERR" on all other types of errors.
528 * @param h handle to the namestore
529 * @param zone hash of the public key of the zone
530 * @param name name that is being mapped (at most 255 characters long)
531 * @param record_type type of the record (A, AAAA, PKEY, etc.)
532 * @param size number of bytes in data
533 * @param data content stored
534 * @param cont continuation to call when done
535 * @param cont_cls closure for cont
536 * @return handle to abort the request
538 struct GNUNET_NAMESTORE_QueueEntry *
539 GNUNET_NAMESTORE_record_remove (struct GNUNET_NAMESTORE_Handle *h,
540 const GNUNET_HashCode *zone,
542 uint32_t record_type,
545 GNUNET_NAMESTORE_ContinuationWithStatus cont,
548 struct GNUNET_NAMESTORE_QueueEntry *qe;
549 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
551 struct GNUNET_NAMESTORE_SimpleRecord *iter;
552 for (iter=h->records_head; iter != NULL; iter=iter->next)
554 if (strcmp ( iter->name, name ) &&
555 iter->record_type == record_type &&
556 GNUNET_CRYPTO_hash_cmp (iter->zone, zone))
560 GNUNET_CONTAINER_DLL_remove(h->records_head,
568 * Get a result for a particular key from the namestore. The processor
569 * will only be called once.
571 * @param h handle to the namestore
572 * @param zone zone to look up a record from
573 * @param name name to look up
574 * @param record_type desired record type
575 * @param proc function to call on each matching value;
576 * will be called once with a NULL value at the end
577 * @param proc_cls closure for proc
578 * @return a handle that can be used to
581 struct GNUNET_NAMESTORE_QueueEntry *
582 GNUNET_NAMESTORE_lookup_name (struct GNUNET_NAMESTORE_Handle *h,
583 const GNUNET_HashCode *zone,
585 uint32_t record_type,
586 GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls)
588 struct GNUNET_NAMESTORE_QueueEntry *qe;
589 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
591 struct GNUNET_NAMESTORE_SimpleRecord *iter;
592 for (iter=h->records_head; iter != NULL; iter=iter->next)
594 proc(proc_cls, iter->zone, iter->name, iter->record_type,
598 iter->data_size /*size*/,
599 iter->data /* data */);
601 proc(proc_cls, zone, name, record_type,
602 GNUNET_TIME_absolute_get_forever(), 0, NULL, 0, NULL); /*TERMINATE*/
609 * Get the hash of a record (what will be signed in the Stree for
612 * @param zone hash of the public key of the zone
613 * @param name name that is being mapped (at most 255 characters long)
614 * @param record_type type of the record (A, AAAA, PKEY, etc.)
615 * @param expiration expiration time for the content
616 * @param flags flags for the content
617 * @param data_size number of bytes in data
618 * @param data value, semantics depend on 'record_type' (see RFCs for DNS and.
619 * GNS specification for GNS extensions)
620 * @param record_hash hash of the record (set)
623 GNUNET_NAMESTORE_record_hash (struct GNUNET_NAMESTORE_Handle *h,
624 const GNUNET_HashCode *zone,
626 uint32_t record_type,
627 struct GNUNET_TIME_Absolute expiration,
628 enum GNUNET_NAMESTORE_RecordFlags flags,
631 GNUNET_HashCode *record_hash)
633 char* teststring = "namestore-stub";
634 GNUNET_CRYPTO_hash(teststring, strlen(teststring), record_hash);
638 * Obtain part of a signature B-tree. The processor
639 * will only be called once.
641 * @param h handle to the namestore
642 * @param zone zone to look up a record from
643 * @param sig_loc location to look up
644 * @param proc function to call on each matching value;
645 * will be called once with a NULL value at the end
646 * @param proc_cls closure for proc
647 * @return a handle that can be used to
650 struct GNUNET_NAMESTORE_QueueEntry *
651 GNUNET_NAMESTORE_lookup_stree (struct GNUNET_NAMESTORE_Handle *h,
652 const GNUNET_HashCode *zone,
653 const struct GNUNET_NAMESTORE_SignatureLocation *sig_loc,
654 GNUNET_NAMESTORE_StreeProcessor proc, void *proc_cls)
656 struct GNUNET_NAMESTORE_QueueEntry *qe;
657 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
663 * Get all records of a zone.
665 * @param h handle to the namestore
666 * @param zone zone to access
667 * @param proc function to call on a random value; it
668 * will be called repeatedly with a value (if available)
669 * and always once at the end with a zone and name of NULL.
670 * @param proc_cls closure for proc
671 * @return a handle that can be used to
674 struct GNUNET_NAMESTORE_QueueEntry *
675 GNUNET_NAMESTORE_zone_transfer (struct GNUNET_NAMESTORE_Handle *h,
676 const GNUNET_HashCode *zone,
677 GNUNET_NAMESTORE_RecordProcessor proc,
680 struct GNUNET_NAMESTORE_QueueEntry *qe;
681 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
689 * Cancel a namestore operation. The final callback from the
690 * operation must not have been done yet.
692 * @param qe operation to cancel
695 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe)
701 /* end of namestore_api.c */