2 This file is part of GNUnet.
3 (C) 2010-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_api.c
23 * @brief API to access the NAMESTORE service
24 * @author Martin Schanzenbach
25 * @author Matthias Wachs
26 * @author Christian Grothoff
30 #include "gnunet_util_lib.h"
31 #include "gnunet_crypto_lib.h"
32 #include "gnunet_constants.h"
33 #include "gnunet_dnsparser_lib.h"
34 #include "gnunet_arm_service.h"
35 #include "gnunet_signatures.h"
36 #include "gnunet_namestore_service.h"
37 #include "namestore.h"
40 #define LOG(kind,...) GNUNET_log_from (kind, "namestore-api",__VA_ARGS__)
44 * An QueueEntry used to store information for a pending
45 * NAMESTORE record operation
47 struct GNUNET_NAMESTORE_QueueEntry
53 struct GNUNET_NAMESTORE_QueueEntry *next;
58 struct GNUNET_NAMESTORE_QueueEntry *prev;
61 * Main handle to access the namestore.
63 struct GNUNET_NAMESTORE_Handle *nsh;
66 * Continuation to call
68 GNUNET_NAMESTORE_ContinuationWithStatus cont;
76 * Function to call with the records we get back; or NULL.
78 GNUNET_NAMESTORE_RecordMonitor proc;
86 * Function to call with the blocks we get back; or NULL.
88 GNUNET_NAMESTORE_BlockProcessor block_proc;
91 * Closure for 'block_proc'.
96 * The operation id this zone iteration operation has
104 * Handle for a zone iterator operation
106 struct GNUNET_NAMESTORE_ZoneIterator
112 struct GNUNET_NAMESTORE_ZoneIterator *next;
117 struct GNUNET_NAMESTORE_ZoneIterator *prev;
120 * Main handle to access the namestore.
122 struct GNUNET_NAMESTORE_Handle *h;
125 * The continuation to call with the results
127 GNUNET_NAMESTORE_RecordMonitor proc;
130 * Closure for 'proc'.
135 * Private key of the zone.
137 struct GNUNET_CRYPTO_EccPrivateKey zone;
140 * The operation id this zone iteration operation has
148 * Message in linked list we should send to the service. The
149 * actual binary message follows this struct.
151 struct PendingMessage
157 struct PendingMessage *next;
162 struct PendingMessage *prev;
165 * Size of the message.
173 * Connection to the NAMESTORE service.
175 struct GNUNET_NAMESTORE_Handle
179 * Configuration to use.
181 const struct GNUNET_CONFIGURATION_Handle *cfg;
184 * Socket (if available).
186 struct GNUNET_CLIENT_Connection *client;
189 * Currently pending transmission request (or NULL).
191 struct GNUNET_CLIENT_TransmitHandle *th;
194 * Head of linked list of pending messages to send to the service
196 struct PendingMessage * pending_head;
199 * Tail of linked list of pending messages to send to the service
201 struct PendingMessage * pending_tail;
204 * Head of pending namestore queue entries
206 struct GNUNET_NAMESTORE_QueueEntry * op_head;
209 * Tail of pending namestore queue entries
211 struct GNUNET_NAMESTORE_QueueEntry * op_tail;
214 * Head of pending namestore zone iterator entries
216 struct GNUNET_NAMESTORE_ZoneIterator * z_head;
219 * Tail of pending namestore zone iterator entries
221 struct GNUNET_NAMESTORE_ZoneIterator * z_tail;
226 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
229 * Should we reconnect to service due to some serious error?
234 * Did we start to receive yet?
239 * The last operation id used for a NAMESTORE operation
241 uint32_t last_op_id_used;
247 * Disconnect from service and then reconnect.
249 * @param h our handle
252 force_reconnect (struct GNUNET_NAMESTORE_Handle *h);
256 * Handle an incoming message of type 'GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK_RESPONSE'
258 * @param qe the respective entry in the message queue
259 * @param msg the message we received
260 * @param size the message size
261 * @return GNUNET_OK on success, GNUNET_SYSERR on error and we did NOT notify the client
264 handle_lookup_block_response (struct GNUNET_NAMESTORE_QueueEntry *qe,
265 const struct LookupBlockResponseMessage *msg,
268 struct GNUNET_NAMESTORE_Block *block;
269 char buf[size + sizeof (struct GNUNET_NAMESTORE_Block) - sizeof (struct LookupBlockResponseMessage)];
271 LOG (GNUNET_ERROR_TYPE_DEBUG,
273 "LOOKUP_BLOCK_RESPONSE");
274 block = (struct GNUNET_NAMESTORE_Block *) buf;
275 block->signature = msg->signature;
276 block->derived_key = msg->derived_key;
277 block->purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_GNS_RECORD_SIGN);
278 block->purpose.size = htonl (size - sizeof (struct LookupBlockResponseMessage) +
279 sizeof (struct GNUNET_TIME_AbsoluteNBO) +
280 sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose));
281 block->expiration_time = msg->expire;
284 size - sizeof (struct LookupBlockResponseMessage));
286 GNUNET_NAMESTORE_block_verify (block))
289 return GNUNET_SYSERR;
291 if (NULL != qe->block_proc)
292 qe->block_proc (qe->proc_cls, block);
300 * Handle an incoming message of type 'GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE_RESPONSE'
302 * @param qe the respective entry in the message queue
303 * @param msg the message we received
304 * @param size the message size
305 * @return GNUNET_OK on success, GNUNET_SYSERR on error and we did NOT notify the client
308 handle_block_cache_response (struct GNUNET_NAMESTORE_QueueEntry *qe,
309 const struct BlockCacheResponseMessage *msg,
314 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received `%s'\n",
315 "BLOCK_CACHE_RESPONSE");
316 res = ntohl (msg->op_result);
317 /* TODO: add actual error message from namestore to response... */
318 if (NULL != qe->cont)
319 qe->cont (qe->cont_cls, res, (GNUNET_OK == res) ? NULL : _("Namestore failed to cache block"));
325 * Handle an incoming message of type 'GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE'
327 * @param qe the respective entry in the message queue
328 * @param msg the message we received
329 * @param size the message size
330 * @return GNUNET_OK on success, GNUNET_SYSERR on error and we did NOT notify the client
333 handle_record_store_response (struct GNUNET_NAMESTORE_QueueEntry *qe,
334 const struct RecordStoreResponseMessage* msg,
340 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received `%s'\n",
341 "RECORD_STORE_RESPONSE");
342 /* TODO: add actual error message from namestore to response... */
343 res = ntohl (msg->op_result);
344 if (GNUNET_SYSERR == res)
345 emsg = _("Namestore failed to store record\n");
348 if (NULL != qe->cont)
349 qe->cont (qe->cont_cls, res, emsg);
355 * Handle an incoming message of type 'GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT'
357 * @param qe the respective entry in the message queue
358 * @param msg the message we received
359 * @param size the message size
360 * @return GNUNET_OK on success, GNUNET_SYSERR on error and we did NOT notify the client
363 handle_record_result (struct GNUNET_NAMESTORE_QueueEntry *qe,
364 const struct RecordResultMessage *msg,
373 unsigned int rd_count;
375 LOG (GNUNET_ERROR_TYPE_DEBUG,
378 rd_len = ntohs (msg->rd_len);
379 rd_count = ntohs (msg->rd_count);
380 msg_len = ntohs (msg->gns_header.header.size);
381 name_len = ntohs (msg->name_len);
382 GNUNET_break (0 == ntohs (msg->reserved));
383 exp_msg_len = sizeof (struct RecordResultMessage) + name_len + rd_len;
384 if (msg_len != exp_msg_len)
387 return GNUNET_SYSERR;
389 name = (const char *) &msg[1];
390 if ( (name_len > 0) &&
391 ('\0' != name[name_len -1]) )
394 return GNUNET_SYSERR;
396 rd_tmp = &name[name_len];
398 struct GNUNET_NAMESTORE_RecordData rd[rd_count];
400 if (GNUNET_OK != GNUNET_NAMESTORE_records_deserialize(rd_len, rd_tmp, rd_count, rd))
403 return GNUNET_SYSERR;
407 if (NULL != qe->proc)
408 qe->proc (qe->proc_cls,
412 (rd_count > 0) ? rd : NULL);
419 * Handle an incoming message of type 'GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE'
421 * @param qe the respective entry in the message queue
422 * @param msg the message we received
423 * @param size the message size
424 * @return GNUNET_OK on success, GNUNET_NO if we notified the client about
425 * the error, GNUNET_SYSERR on error and we did NOT notify the client
428 handle_zone_to_name_response (struct GNUNET_NAMESTORE_QueueEntry *qe,
429 const struct ZoneToNameResponseMessage *msg,
435 unsigned int rd_count;
436 const char *name_tmp;
439 LOG (GNUNET_ERROR_TYPE_DEBUG,
441 "ZONE_TO_NAME_RESPONSE");
442 res = ntohs (msg->res);
446 LOG (GNUNET_ERROR_TYPE_DEBUG, "An error occured during zone to name operation\n");
449 LOG (GNUNET_ERROR_TYPE_DEBUG, "Namestore has no result for zone to name mapping \n");
452 LOG (GNUNET_ERROR_TYPE_DEBUG, "Namestore has result for zone to name mapping \n");
453 name_len = ntohs (msg->name_len);
454 rd_count = ntohs (msg->rd_count);
455 rd_ser_len = ntohs (msg->rd_len);
456 name_tmp = (const char *) &msg[1];
457 if ( (name_len > 0) &&
458 ('\0' != name_tmp[name_len -1]) )
461 return GNUNET_SYSERR;
463 rd_tmp = &name_tmp[name_len];
465 struct GNUNET_NAMESTORE_RecordData rd[rd_count];
466 if (GNUNET_OK != GNUNET_NAMESTORE_records_deserialize(rd_ser_len, rd_tmp, rd_count, rd))
469 return GNUNET_SYSERR;
471 /* normal end, call continuation with result */
472 if (NULL != qe->proc)
473 qe->proc (qe->proc_cls,
477 /* return is important here: break would call continuation with error! */
482 return GNUNET_SYSERR;
484 /* error case, call continuation with error */
485 if (NULL != qe->proc)
486 qe->proc (qe->proc_cls, NULL, NULL, 0, NULL);
492 * Handle incoming messages for record operations
494 * @param qe the respective zone iteration handle
495 * @param msg the message we received
496 * @param type the message type in HBO
497 * @param size the message size
498 * @return GNUNET_OK on success, GNUNET_NO if we notified the client about
499 * the error, GNUNET_SYSERR on error and we did NOT notify the client
502 manage_record_operations (struct GNUNET_NAMESTORE_QueueEntry *qe,
503 const struct GNUNET_MessageHeader *msg,
507 /* handle different message type */
510 case GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK_RESPONSE:
511 if (size < sizeof (struct LookupBlockResponseMessage))
514 return GNUNET_SYSERR;
516 return handle_lookup_block_response (qe, (const struct LookupBlockResponseMessage *) msg, size);
517 case GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE_RESPONSE:
518 if (size != sizeof (struct BlockCacheResponseMessage))
521 return GNUNET_SYSERR;
523 return handle_block_cache_response (qe, (const struct BlockCacheResponseMessage *) msg, size);
524 case GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE:
525 if (size != sizeof (struct RecordStoreResponseMessage))
528 return GNUNET_SYSERR;
530 return handle_record_store_response (qe, (const struct RecordStoreResponseMessage *) msg, size);
531 case GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE:
532 if (size < sizeof (struct ZoneToNameResponseMessage))
535 return GNUNET_SYSERR;
537 return handle_zone_to_name_response (qe, (const struct ZoneToNameResponseMessage *) msg, size);
538 case GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT:
539 if (size < sizeof (struct RecordResultMessage))
542 return GNUNET_SYSERR;
544 return handle_record_result (qe, (const struct RecordResultMessage *) msg, size);
547 return GNUNET_SYSERR;
553 * Handle a response from NAMESTORE service for a zone iteration request
555 * @param ze the respective iterator for this operation
556 * @param msg the message containing the respoonse
557 * @param size the message size
558 * @return GNUNET_YES on success, 'ze' should be kept, GNUNET_NO on success if 'ze' should
559 * not be kept any longer, GNUNET_SYSERR on error (disconnect) and 'ze' should be kept
562 handle_zone_iteration_response (struct GNUNET_NAMESTORE_ZoneIterator *ze,
563 const struct RecordResultMessage *msg,
566 static struct GNUNET_CRYPTO_EccPrivateKey priv_dummy;
572 const char *name_tmp;
573 const char *rd_ser_tmp;
575 LOG (GNUNET_ERROR_TYPE_DEBUG,
577 "ZONE_ITERATION_RESPONSE");
578 msg_len = ntohs (msg->gns_header.header.size);
579 rd_len = ntohs (msg->rd_len);
580 rd_count = ntohs (msg->rd_count);
581 name_len = ntohs (msg->name_len);
582 exp_msg_len = sizeof (struct RecordResultMessage) + name_len + rd_len;
583 if (msg_len != exp_msg_len)
586 return GNUNET_SYSERR;
588 if ((0 == name_len) && (0 == (memcmp (&msg->private_key, &priv_dummy, sizeof (priv_dummy)))))
590 LOG (GNUNET_ERROR_TYPE_DEBUG, "Zone iteration is completed!\n");
591 if (NULL != ze->proc)
592 ze->proc (ze->proc_cls, NULL, NULL, 0, NULL);
595 name_tmp = (const char *) &msg[1];
596 if ((name_tmp[name_len -1] != '\0') || (name_len > MAX_NAME_LEN))
599 return GNUNET_SYSERR;
601 rd_ser_tmp = (const char *) &name_tmp[name_len];
603 struct GNUNET_NAMESTORE_RecordData rd[rd_count];
605 if (GNUNET_OK != GNUNET_NAMESTORE_records_deserialize (rd_len, rd_ser_tmp, rd_count, rd))
608 return GNUNET_SYSERR;
610 if (NULL != ze->proc)
611 ze->proc (ze->proc_cls, &msg->private_key, name_tmp, rd_count, rd);
618 * Handle incoming messages for zone iterations
620 * @param ze the respective zone iteration handle
621 * @param msg the message we received
622 * @param type the message type in HBO
623 * @param size the message size
624 * @return GNUNET_YES on success, 'ze' should be kept, GNUNET_NO on success if 'ze' should
625 * not be kept any longer, GNUNET_SYSERR on error (disconnect) and 'ze' should be kept
628 manage_zone_operations (struct GNUNET_NAMESTORE_ZoneIterator *ze,
629 const struct GNUNET_MessageHeader *msg,
630 int type, size_t size)
632 /* handle different message type */
635 case GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT:
636 if (size < sizeof (struct RecordResultMessage))
639 return GNUNET_SYSERR;
641 return handle_zone_iteration_response (ze, (const struct RecordResultMessage *) msg, size);
644 return GNUNET_SYSERR;
650 * Type of a function to call when we receive a message
653 * @param cls the 'struct GNUNET_NAMESTORE_SchedulingHandle'
654 * @param msg message received, NULL on timeout or fatal error
657 process_namestore_message (void *cls,
658 const struct GNUNET_MessageHeader *msg)
660 struct GNUNET_NAMESTORE_Handle *h = cls;
661 const struct GNUNET_NAMESTORE_Header *gm;
662 struct GNUNET_NAMESTORE_QueueEntry *qe;
663 struct GNUNET_NAMESTORE_ZoneIterator *ze;
674 size = ntohs (msg->size);
675 type = ntohs (msg->type);
676 if (size < sizeof (struct GNUNET_NAMESTORE_Header))
679 GNUNET_CLIENT_receive (h->client, &process_namestore_message, h,
680 GNUNET_TIME_UNIT_FOREVER_REL);
683 gm = (const struct GNUNET_NAMESTORE_Header *) msg;
684 r_id = ntohl (gm->r_id);
686 LOG (GNUNET_ERROR_TYPE_DEBUG,
687 "Received message type %u size %u op %u\n",
690 (unsigned int) r_id);
692 /* Is it a record related operation ? */
693 for (qe = h->op_head; qe != NULL; qe = qe->next)
694 if (qe->op_id == r_id)
698 ret = manage_record_operations (qe, msg, type, size);
699 if (GNUNET_OK != ret)
701 /* protocol error, need to reconnect */
702 h->reconnect = GNUNET_YES;
704 if (GNUNET_SYSERR != ret)
706 /* client was notified about success or failure, clean up 'qe' */
707 GNUNET_CONTAINER_DLL_remove (h->op_head,
714 /* Is it a zone iteration operation ? */
715 for (ze = h->z_head; ze != NULL; ze = ze->next)
716 if (ze->op_id == r_id)
720 ret = manage_zone_operations (ze, msg, type, size);
721 if (GNUNET_NO == ret)
723 /* end of iteration, clean up 'ze' */
724 GNUNET_CONTAINER_DLL_remove (h->z_head,
729 if (GNUNET_SYSERR == ret)
731 /* protocol error, need to reconnect */
732 h->reconnect = GNUNET_YES;
735 if (GNUNET_YES == h->reconnect)
740 GNUNET_CLIENT_receive (h->client, &process_namestore_message, h,
741 GNUNET_TIME_UNIT_FOREVER_REL);
746 * Transmit messages from the message queue to the service
747 * (if there are any, and if we are not already trying).
749 * @param h handle to use
752 do_transmit (struct GNUNET_NAMESTORE_Handle *h);
756 * We can now transmit a message to NAMESTORE. Do it.
758 * @param cls the 'struct GNUNET_NAMESTORE_Handle'
759 * @param size number of bytes we can transmit
760 * @param buf where to copy the messages
761 * @return number of bytes copied into buf
764 transmit_message_to_namestore (void *cls, size_t size, void *buf)
766 struct GNUNET_NAMESTORE_Handle *h = cls;
767 struct PendingMessage *p;
772 if ((0 == size) || (NULL == buf))
779 while ((NULL != (p = h->pending_head)) && (p->size <= size))
781 memcpy (&cbuf[ret], &p[1], p->size);
784 GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, p);
785 if (GNUNET_NO == h->is_receiving)
787 h->is_receiving = GNUNET_YES;
788 GNUNET_CLIENT_receive (h->client,
789 &process_namestore_message, h,
790 GNUNET_TIME_UNIT_FOREVER_REL);
800 * Transmit messages from the message queue to the service
801 * (if there are any, and if we are not already trying).
803 * @param h handle to use
806 do_transmit (struct GNUNET_NAMESTORE_Handle *h)
808 struct PendingMessage *p;
811 return; /* transmission request already pending */
812 if (NULL == (p = h->pending_head))
813 return; /* transmission queue empty */
814 if (NULL == h->client)
815 return; /* currently reconnecting */
816 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client, p->size,
817 GNUNET_TIME_UNIT_FOREVER_REL,
818 GNUNET_NO, &transmit_message_to_namestore,
824 * Reconnect to namestore service.
826 * @param h the handle to the NAMESTORE service
829 reconnect (struct GNUNET_NAMESTORE_Handle *h)
831 GNUNET_assert (NULL == h->client);
832 h->client = GNUNET_CLIENT_connect ("namestore", h->cfg);
833 GNUNET_assert (NULL != h->client);
839 * Re-establish the connection to the service.
841 * @param cls handle to use to re-connect.
842 * @param tc scheduler context
845 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
847 struct GNUNET_NAMESTORE_Handle *h = cls;
849 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
855 * Disconnect from service and then reconnect.
857 * @param h our handle
860 force_reconnect (struct GNUNET_NAMESTORE_Handle *h)
862 h->reconnect = GNUNET_NO;
863 GNUNET_CLIENT_disconnect (h->client);
864 h->is_receiving = GNUNET_NO;
866 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
873 * Get a fresh operation id to distinguish between namestore requests
875 * @param h the namestore handle
876 * @return next operation id to use
879 get_op_id (struct GNUNET_NAMESTORE_Handle *h)
881 return h->last_op_id_used++;
886 * Initialize the connection with the NAMESTORE service.
888 * @param cfg configuration to use
889 * @return handle to the GNS service, or NULL on error
891 struct GNUNET_NAMESTORE_Handle *
892 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
894 struct GNUNET_NAMESTORE_Handle *h;
896 h = GNUNET_new (struct GNUNET_NAMESTORE_Handle);
898 h->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect_task, h);
899 h->last_op_id_used = 0;
905 * Disconnect from the namestore service (and free associated
908 * @param h handle to the namestore
911 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h)
913 struct PendingMessage *p;
914 struct GNUNET_NAMESTORE_QueueEntry *q;
915 struct GNUNET_NAMESTORE_ZoneIterator *z;
917 LOG (GNUNET_ERROR_TYPE_DEBUG, "Cleaning up\n");
918 GNUNET_assert (NULL != h);
919 while (NULL != (p = h->pending_head))
921 GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, p);
924 GNUNET_break (NULL == h->op_head);
925 while (NULL != (q = h->op_head))
927 GNUNET_CONTAINER_DLL_remove (h->op_head, h->op_tail, q);
930 GNUNET_break (NULL == h->z_head);
931 while (NULL != (z = h->z_head))
933 GNUNET_CONTAINER_DLL_remove (h->z_head, h->z_tail, z);
936 if (NULL != h->client)
938 GNUNET_CLIENT_disconnect (h->client);
941 if (GNUNET_SCHEDULER_NO_TASK != h->reconnect_task)
943 GNUNET_SCHEDULER_cancel (h->reconnect_task);
944 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
951 * Store an item in the namestore. If the item is already present,
952 * it is replaced with the new record.
954 * @param h handle to the namestore
955 * @param block block to store
956 * @param cont continuation to call when done
957 * @param cont_cls closure for cont
958 * @return handle to abort the request
960 struct GNUNET_NAMESTORE_QueueEntry *
961 GNUNET_NAMESTORE_block_cache (struct GNUNET_NAMESTORE_Handle *h,
962 const struct GNUNET_NAMESTORE_Block *block,
963 GNUNET_NAMESTORE_ContinuationWithStatus cont,
966 struct GNUNET_NAMESTORE_QueueEntry *qe;
967 struct PendingMessage *pe;
968 struct BlockCacheMessage *msg;
973 GNUNET_assert (NULL != h);
974 blen = ntohl (block->purpose.size) - sizeof (struct GNUNET_TIME_AbsoluteNBO);
976 qe = GNUNET_new (struct GNUNET_NAMESTORE_QueueEntry);
979 qe->cont_cls = cont_cls;
981 GNUNET_CONTAINER_DLL_insert_tail (h->op_head, h->op_tail, qe);
984 msg_size = sizeof (struct BlockCacheMessage) + blen;
985 pe = GNUNET_malloc (sizeof (struct PendingMessage) + msg_size);
987 msg = (struct BlockCacheMessage *) &pe[1];
988 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE);
989 msg->gns_header.header.size = htons (msg_size);
990 msg->gns_header.r_id = htonl (rid);
991 msg->expire = block->expiration_time;
992 msg->signature = block->signature;
993 msg->derived_key = block->derived_key;
994 memcpy (&msg[1], &block[1], blen);
995 LOG (GNUNET_ERROR_TYPE_DEBUG,
996 "Sending `%s' message with size %u\n",
997 "NAMESTORE_BLOCK_CACHE",
998 (unsigned int) msg_size);
999 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1006 * Store an item in the namestore. If the item is already present,
1007 * it is replaced with the new record. Use an empty array to
1008 * remove all records under the given name.
1010 * @param h handle to the namestore
1011 * @param pkey private key of the zone
1012 * @param label name that is being mapped (at most 255 characters long)
1013 * @param rd_count number of records in the 'rd' array
1014 * @param rd array of records with data to store
1015 * @param cont continuation to call when done
1016 * @param cont_cls closure for 'cont'
1017 * @return handle to abort the request
1019 struct GNUNET_NAMESTORE_QueueEntry *
1020 GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h,
1021 const struct GNUNET_CRYPTO_EccPrivateKey *pkey,
1023 unsigned int rd_count,
1024 const struct GNUNET_NAMESTORE_RecordData *rd,
1025 GNUNET_NAMESTORE_ContinuationWithStatus cont,
1028 struct GNUNET_NAMESTORE_QueueEntry *qe;
1029 struct PendingMessage *pe;
1036 struct RecordStoreMessage *msg;
1038 GNUNET_assert (NULL != h);
1039 GNUNET_assert (NULL != pkey);
1040 GNUNET_assert (NULL != label);
1041 name_len = strlen (label) + 1;
1042 if (name_len > MAX_NAME_LEN)
1047 rid = get_op_id (h);
1048 qe = GNUNET_new (struct GNUNET_NAMESTORE_QueueEntry);
1051 qe->cont_cls = cont_cls;
1053 GNUNET_CONTAINER_DLL_insert_tail (h->op_head, h->op_tail, qe);
1056 rd_ser_len = GNUNET_NAMESTORE_records_get_size (rd_count, rd);
1057 msg_size = sizeof (struct RecordStoreMessage) + name_len + rd_ser_len;
1058 pe = GNUNET_malloc (sizeof (struct PendingMessage) + msg_size);
1059 pe->size = msg_size;
1060 msg = (struct RecordStoreMessage *) &pe[1];
1061 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE);
1062 msg->gns_header.header.size = htons (msg_size);
1063 msg->gns_header.r_id = htonl (rid);
1064 msg->name_len = htons (name_len);
1065 msg->rd_count = htons (rd_count);
1066 msg->rd_len = htons (rd_ser_len);
1067 msg->reserved = htons (0);
1068 msg->private_key = *pkey;
1070 name_tmp = (char *) &msg[1];
1071 memcpy (name_tmp, label, name_len);
1072 rd_ser = &name_tmp[name_len];
1073 GNUNET_break (rd_ser_len == GNUNET_NAMESTORE_records_serialize (rd_count, rd, rd_ser_len, rd_ser));
1075 LOG (GNUNET_ERROR_TYPE_DEBUG,
1076 "Sending `%s' message for name `%s' with size %u\n",
1077 "NAMESTORE_RECORD_STORE", label, msg_size);
1078 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1085 * Get a result for a particular key from the namestore. The processor
1086 * will only be called once.
1088 * @param h handle to the namestore
1089 * @param derived_hash hash of zone key combined with name to lookup
1090 * @param proc function to call on the matching block, or with
1091 * NULL if there is no matching block
1092 * @param proc_cls closure for proc
1093 * @return a handle that can be used to cancel
1095 struct GNUNET_NAMESTORE_QueueEntry *
1096 GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h,
1097 const struct GNUNET_HashCode *derived_hash,
1098 GNUNET_NAMESTORE_BlockProcessor proc, void *proc_cls)
1100 struct GNUNET_NAMESTORE_QueueEntry *qe;
1101 struct PendingMessage *pe;
1102 struct LookupBlockMessage *msg;
1106 GNUNET_assert (NULL != h);
1107 GNUNET_assert (NULL != derived_hash);
1108 LOG (GNUNET_ERROR_TYPE_DEBUG,
1109 "Looking for block under %s\n",
1110 GNUNET_h2s (derived_hash));
1112 qe = GNUNET_new (struct GNUNET_NAMESTORE_QueueEntry);
1114 qe->block_proc = proc;
1115 qe->block_proc_cls = proc_cls;
1117 GNUNET_CONTAINER_DLL_insert_tail (h->op_head, h->op_tail, qe);
1119 msg_size = sizeof (struct LookupBlockMessage);
1120 pe = GNUNET_malloc (sizeof (struct PendingMessage) + msg_size);
1121 pe->size = msg_size;
1122 msg = (struct LookupBlockMessage *) &pe[1];
1123 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK);
1124 msg->gns_header.header.size = htons (msg_size);
1125 msg->gns_header.r_id = htonl (rid);
1126 msg->query = *derived_hash;
1127 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1134 * Look for an existing PKEY delegation record for a given public key.
1135 * Returns at most one result to the processor.
1137 * @param h handle to the namestore
1138 * @param zone public key of the zone to look up in, never NULL
1139 * @param value_zone public key of the target zone (value), never NULL
1140 * @param proc function to call on the matching records, or with
1141 * NULL (rd_count == 0) if there are no matching records
1142 * @param proc_cls closure for proc
1143 * @return a handle that can be used to
1146 struct GNUNET_NAMESTORE_QueueEntry *
1147 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
1148 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
1149 const struct GNUNET_CRYPTO_EccPublicKey *value_zone,
1150 GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls)
1152 struct GNUNET_NAMESTORE_QueueEntry *qe;
1153 struct PendingMessage *pe;
1154 struct ZoneToNameMessage * msg;
1158 GNUNET_assert (NULL != h);
1159 GNUNET_assert (NULL != zone);
1160 GNUNET_assert (NULL != value_zone);
1162 qe = GNUNET_new (struct GNUNET_NAMESTORE_QueueEntry);
1165 qe->proc_cls = proc_cls;
1167 GNUNET_CONTAINER_DLL_insert_tail (h->op_head, h->op_tail, qe);
1169 msg_size = sizeof (struct ZoneToNameMessage);
1170 pe = GNUNET_malloc (sizeof (struct PendingMessage) + msg_size);
1171 pe->size = msg_size;
1172 msg = (struct ZoneToNameMessage *) &pe[1];
1173 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME);
1174 msg->gns_header.header.size = htons (msg_size);
1175 msg->gns_header.r_id = htonl (rid);
1177 msg->value_zone = *value_zone;
1179 /* transmit message */
1180 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1187 * Starts a new zone iteration (used to periodically PUT all of our
1188 * records into our DHT). This MUST lock the GNUNET_NAMESTORE_Handle
1189 * for any other calls than GNUNET_NAMESTORE_zone_iterator_next and
1190 * GNUNET_NAMESTORE_zone_iteration_stop. "proc" will be called once
1191 * immediately, and then again after
1192 * "GNUNET_NAMESTORE_zone_iterator_next" is invoked.
1194 * @param h handle to the namestore
1195 * @param zone zone to access
1196 * @param proc function to call on each name from the zone; it
1197 * will be called repeatedly with a value (if available)
1198 * and always once at the end with a name of NULL.
1199 * @param proc_cls closure for proc
1200 * @return an iterator handle to use for iteration
1202 struct GNUNET_NAMESTORE_ZoneIterator *
1203 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
1204 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
1205 GNUNET_NAMESTORE_RecordMonitor proc,
1208 struct GNUNET_NAMESTORE_ZoneIterator *it;
1209 struct PendingMessage *pe;
1210 struct ZoneIterationStartMessage * msg;
1214 GNUNET_assert (NULL != h);
1216 it = GNUNET_new (struct GNUNET_NAMESTORE_ZoneIterator);
1219 it->proc_cls = proc_cls;
1222 GNUNET_CONTAINER_DLL_insert_tail (h->z_head, h->z_tail, it);
1224 msg_size = sizeof (struct ZoneIterationStartMessage);
1225 pe = GNUNET_malloc (sizeof (struct PendingMessage) + msg_size);
1226 pe->size = msg_size;
1227 msg = (struct ZoneIterationStartMessage *) &pe[1];
1228 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START);
1229 msg->gns_header.header.size = htons (msg_size);
1230 msg->gns_header.r_id = htonl (rid);
1232 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1239 * Calls the record processor specified in GNUNET_NAMESTORE_zone_iteration_start
1240 * for the next record.
1242 * @param it the iterator
1245 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it)
1247 struct GNUNET_NAMESTORE_Handle *h;
1248 struct ZoneIterationNextMessage * msg;
1249 struct PendingMessage *pe;
1252 GNUNET_assert (NULL != it);
1254 msg_size = sizeof (struct ZoneIterationNextMessage);
1255 pe = GNUNET_malloc (sizeof (struct PendingMessage) + msg_size);
1256 pe->size = msg_size;
1257 msg = (struct ZoneIterationNextMessage *) &pe[1];
1258 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT);
1259 msg->gns_header.header.size = htons (msg_size);
1260 msg->gns_header.r_id = htonl (it->op_id);
1261 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message\n", "ZONE_ITERATION_NEXT");
1262 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1268 * Stops iteration and releases the namestore handle for further calls.
1270 * @param it the iterator
1273 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it)
1275 struct GNUNET_NAMESTORE_Handle *h;
1276 struct PendingMessage *pe;
1278 struct ZoneIterationStopMessage * msg;
1280 GNUNET_assert (NULL != it);
1282 GNUNET_CONTAINER_DLL_remove (h->z_head,
1285 msg_size = sizeof (struct ZoneIterationStopMessage);
1286 pe = GNUNET_malloc (sizeof (struct PendingMessage) + msg_size);
1287 pe->size = msg_size;
1288 msg = (struct ZoneIterationStopMessage *) &pe[1];
1289 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP);
1290 msg->gns_header.header.size = htons (msg_size);
1291 msg->gns_header.r_id = htonl (it->op_id);
1292 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1293 "Sending `%s' message\n",
1294 "ZONE_ITERATION_STOP");
1295 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1302 * Cancel a namestore operation. The final callback from the
1303 * operation must not have been done yet.
1305 * @param qe operation to cancel
1308 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe)
1310 struct GNUNET_NAMESTORE_Handle *h = qe->nsh;
1312 GNUNET_assert (NULL != qe);
1313 GNUNET_CONTAINER_DLL_remove(h->op_head, h->op_tail, qe);
1318 /* end of namestore_api.c */