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 namestore/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_crypto_lib.h"
31 #include "gnunet_constants.h"
32 #include "gnunet_dnsparser_lib.h"
33 #include "gnunet_arm_service.h"
34 #include "gnunet_signatures.h"
35 #include "gnunet_namestore_service.h"
36 #include "namestore.h"
38 #define DEBUG_GNS_API GNUNET_EXTRA_LOGGING
40 #define LOG(kind,...) GNUNET_log_from (kind, "gns-api",__VA_ARGS__)
45 struct GNUNET_NAMESTORE_QueueEntry
51 struct GNUNET_NAMESTORE_QueueEntry *next;
56 struct GNUNET_NAMESTORE_QueueEntry *prev;
58 struct GNUNET_NAMESTORE_Handle *nsh;
62 GNUNET_NAMESTORE_ContinuationWithStatus cont;
65 GNUNET_NAMESTORE_RecordProcessor proc;
68 char *data; /*stub data pointer*/
75 struct GNUNET_NAMESTORE_ZoneIterator
81 struct GNUNET_NAMESTORE_ZoneIterator *next;
86 struct GNUNET_NAMESTORE_ZoneIterator *prev;
90 struct GNUNET_NAMESTORE_Handle *h;
91 GNUNET_NAMESTORE_RecordProcessor proc;
100 * Message in linked list we should send to the service. The
101 * actual binary message follows this struct.
103 struct PendingMessage
109 struct PendingMessage *next;
114 struct PendingMessage *prev;
117 * Size of the message.
122 * Is this the 'START' message?
129 * Connection to the NAMESTORE service.
131 struct GNUNET_NAMESTORE_Handle
135 * Configuration to use.
137 const struct GNUNET_CONFIGURATION_Handle *cfg;
140 * Socket (if available).
142 struct GNUNET_CLIENT_Connection *client;
145 * Currently pending transmission request (or NULL).
147 struct GNUNET_CLIENT_TransmitHandle *th;
152 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
155 * Pending messages to send to the service
158 struct PendingMessage * pending_head;
159 struct PendingMessage * pending_tail;
162 * Should we reconnect to service due to some serious error?
168 * Pending namestore queue entries
170 struct GNUNET_NAMESTORE_QueueEntry * op_head;
171 struct GNUNET_NAMESTORE_QueueEntry * op_tail;
176 * Pending namestore zone iterator entries
178 struct GNUNET_NAMESTORE_ZoneIterator * z_head;
179 struct GNUNET_NAMESTORE_ZoneIterator * z_tail;
182 struct GNUNET_NAMESTORE_SimpleRecord
187 struct GNUNET_NAMESTORE_SimpleRecord *next;
192 struct GNUNET_NAMESTORE_SimpleRecord *prev;
195 const GNUNET_HashCode *zone;
196 uint32_t record_type;
197 struct GNUNET_TIME_Absolute expiration;
198 enum GNUNET_NAMESTORE_RecordFlags flags;
206 * Convert a type name (i.e. "AAAA") to the corresponding number.
208 * @param typename name to convert
209 * @return corresponding number, UINT32_MAX on error
212 GNUNET_NAMESTORE_typename_to_number (const char *typename)
218 { "A", GNUNET_DNSPARSER_TYPE_A },
219 { "NS", GNUNET_DNSPARSER_TYPE_NS },
220 { "CNAME", GNUNET_DNSPARSER_TYPE_CNAME },
221 { "SOA", GNUNET_DNSPARSER_TYPE_SOA },
222 { "PTR", GNUNET_DNSPARSER_TYPE_PTR },
223 { "MX", GNUNET_DNSPARSER_TYPE_MX },
224 { "TXT", GNUNET_DNSPARSER_TYPE_TXT },
225 { "AAAA", GNUNET_DNSPARSER_TYPE_AAAA },
226 { "PKEY", GNUNET_NAMESTORE_TYPE_PKEY },
227 { "PSEU", GNUNET_NAMESTORE_TYPE_PSEU },
233 while ( (map[i].name != NULL) &&
234 (0 != strcasecmp (typename, map[i].name)) )
236 return map[i].number;
241 * Disconnect from service and then reconnect.
243 * @param h our handle
246 force_reconnect (struct GNUNET_NAMESTORE_Handle *h);
249 handle_lookup_name_response (struct GNUNET_NAMESTORE_QueueEntry *qe,
250 struct LookupNameResponseMessage * msg,
253 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' \n",
254 "LOOKUP_NAME_RESPONSE");
256 struct GNUNET_NAMESTORE_Handle *h = qe->nsh;
260 struct GNUNET_CRYPTO_RsaSignature *signature = NULL;
261 struct GNUNET_TIME_Absolute expire;
262 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *public_key_tmp;
267 int contains_sig = GNUNET_NO;
270 rd_len = ntohs (msg->rd_len);
271 rd_count = ntohs (msg->rd_count);
272 msg_len = ntohs (msg->gns_header.header.size);
273 name_len = ntohs (msg->name_len);
274 contains_sig = ntohs (msg->contains_sig);
275 expire = GNUNET_TIME_absolute_ntoh(msg->expire);
277 exp_msg_len = sizeof (struct LookupNameResponseMessage) +
278 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
281 if (msg_len != exp_msg_len)
283 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Message size describes with `%u' bytes but calculated size is %u bytes \n",
284 msg_len, exp_msg_len);
289 name = (char *) &msg[1];
290 rd_tmp = &name[name_len];
292 /* deserialize records */
293 struct GNUNET_NAMESTORE_RecordData rd[rd_count];
294 GNUNET_NAMESTORE_records_deserialize(rd_len, rd_tmp, rd_count, rd);
296 /* reset values if values not contained */
297 if (contains_sig == GNUNET_NO)
300 signature = &msg->signature;
305 public_key_tmp = &msg->public_key;
307 public_key_tmp = NULL;
309 if (qe->proc != NULL)
311 qe->proc (qe->proc_cls, public_key_tmp, expire, name, rd_count, (rd_count > 0) ? rd : NULL, signature);
314 /* Operation done, remove */
315 GNUNET_CONTAINER_DLL_remove(h->op_head, h->op_tail, qe);
321 handle_record_put_response (struct GNUNET_NAMESTORE_QueueEntry *qe,
322 struct RecordPutResponseMessage* msg,
325 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' \n",
326 "RECORD_PUT_RESPONSE");
328 struct GNUNET_NAMESTORE_Handle *h = qe->nsh;
330 if (ntohs (msg->op_result) == GNUNET_OK)
332 if (qe->cont != NULL)
334 qe->cont (qe->cont_cls, GNUNET_OK, _("Namestore added record successfully"));
338 else if (ntohs (msg->op_result) == GNUNET_SYSERR)
340 if (qe->cont != NULL)
342 qe->cont (qe->cont_cls, GNUNET_SYSERR, _("Namestore failed to add record"));
351 /* Operation done, remove */
352 GNUNET_CONTAINER_DLL_remove(h->op_head, h->op_tail, qe);
359 handle_record_create_response (struct GNUNET_NAMESTORE_QueueEntry *qe,
360 struct RecordCreateResponseMessage* msg,
363 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' \n",
364 "RECORD_CREATE_RESPONSE");
366 struct GNUNET_NAMESTORE_Handle *h = qe->nsh;
368 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' %i\n",
369 "RECORD_CREATE_RESPONSE", ntohs (msg->op_result));
370 if (ntohs (msg->op_result) == GNUNET_YES)
372 if (qe->cont != NULL)
374 qe->cont (qe->cont_cls, GNUNET_YES, _("Namestore added record successfully"));
378 else if (ntohs (msg->op_result) == GNUNET_NO)
380 if (qe->cont != NULL)
382 qe->cont (qe->cont_cls, GNUNET_NO, _("Namestore record already existed"));
387 if (qe->cont != NULL)
389 qe->cont (qe->cont_cls, GNUNET_SYSERR, _("Namestore failed to add record\n"));
393 /* Operation done, remove */
394 GNUNET_CONTAINER_DLL_remove(h->op_head, h->op_tail, qe);
401 handle_record_remove_response (struct GNUNET_NAMESTORE_QueueEntry *qe,
402 struct RecordRemoveResponseMessage* msg,
405 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' \n",
406 "RECORD_REMOVE_RESPONSE");
408 struct GNUNET_NAMESTORE_Handle *h = qe->nsh;
409 int res = ntohs (msg->op_result);
414 * 1 : No records for entry
415 * 2 : Could not find record to remove
416 * 3 : Failed to create new signature
417 * 4 : Failed to put new set of records in database
421 if (qe->cont != NULL)
423 qe->cont (qe->cont_cls, GNUNET_YES, _("Namestore removed record successfully"));
428 if (qe->cont != NULL)
430 qe->cont (qe->cont_cls, GNUNET_NO, _("No records for entry"));
435 if (qe->cont != NULL)
437 qe->cont (qe->cont_cls, GNUNET_NO, _("Could not find record to remove"));
442 if (qe->cont != NULL)
444 qe->cont (qe->cont_cls, GNUNET_SYSERR, _("Failed to create new signature"));
449 if (qe->cont != NULL)
451 qe->cont (qe->cont_cls, GNUNET_SYSERR, _("Failed to put new set of records in database"));
459 /* Operation done, remove */
460 GNUNET_CONTAINER_DLL_remove(h->op_head, h->op_tail, qe);
466 handle_zone_to_name_response (struct GNUNET_NAMESTORE_QueueEntry *qe,
467 struct ZoneToNameResponseMessage* msg,
470 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' \n",
471 "ZONE_TO_NAME_RESPONSE");
473 struct GNUNET_NAMESTORE_Handle *h = qe->nsh;
474 int res = ntohs (msg->res);
476 struct GNUNET_TIME_Absolute expire;
479 unsigned int rd_count;
484 if (res == GNUNET_SYSERR)
486 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "An error occured during zone to name operation\n");
487 if (qe->proc != NULL)
488 qe->proc (qe->proc_cls, NULL, GNUNET_TIME_absolute_get_zero(), NULL, 0, NULL, NULL);
490 else if (res == GNUNET_NO)
492 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Namestore has no result for zone to name mapping \n");
493 if (qe->proc != NULL)
494 qe->proc (qe->proc_cls, NULL, GNUNET_TIME_absolute_get_zero(), NULL, 0, NULL, NULL);
496 else if (res == GNUNET_YES)
498 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Namestore has result for zone to name mapping \n");
500 name_len = ntohs (msg->name_len);
501 rd_count = ntohs (msg->rd_count);
502 rd_ser_len = ntohs (msg->rd_len);
503 expire = GNUNET_TIME_absolute_ntoh(msg->expire);
505 name_tmp = (char *) &msg[1];
506 rd_tmp = &name_tmp[name_len];
508 struct GNUNET_NAMESTORE_RecordData rd[rd_count];
509 GNUNET_NAMESTORE_records_deserialize(rd_ser_len, rd_tmp, rd_count, rd);
511 if (qe->proc != NULL)
512 qe->proc (qe->proc_cls, &msg->zone_key, expire, name_tmp, rd_count, rd, &msg->signature);
517 /* Operation done, remove */
518 GNUNET_CONTAINER_DLL_remove(h->op_head, h->op_tail, qe);
524 manage_record_operations (struct GNUNET_NAMESTORE_QueueEntry *qe,
525 const struct GNUNET_MessageHeader *msg,
526 int type, size_t size)
529 /* handle different message type */
531 case GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME_RESPONSE:
532 if (size < sizeof (struct LookupNameResponseMessage))
537 handle_lookup_name_response (qe, (struct LookupNameResponseMessage *) msg, size);
539 case GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT_RESPONSE:
540 if (size != sizeof (struct RecordPutResponseMessage))
545 handle_record_put_response (qe, (struct RecordPutResponseMessage *) msg, size);
547 case GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE_RESPONSE:
548 if (size != sizeof (struct RecordCreateResponseMessage))
553 handle_record_create_response (qe, (struct RecordCreateResponseMessage *) msg, size);
555 case GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE_RESPONSE:
556 if (size != sizeof (struct RecordRemoveResponseMessage))
561 handle_record_remove_response (qe, (struct RecordRemoveResponseMessage *) msg, size);
563 case GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE:
564 if (size < sizeof (struct ZoneToNameResponseMessage))
569 handle_zone_to_name_response (qe, (struct ZoneToNameResponseMessage *) msg, size);
578 handle_zone_iteration_response (struct GNUNET_NAMESTORE_ZoneIterator *ze,
579 struct ZoneIterationResponseMessage *msg,
582 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' \n",
583 "ZONE_ITERATION_RESPONSE");
586 if (ze->proc != NULL)
589 ze->proc(ze->proc_cls, NULL, GNUNET_TIME_absolute_get_forever(), "dummy", 0, NULL, NULL);
595 manage_zone_operations (struct GNUNET_NAMESTORE_ZoneIterator *ze,
596 const struct GNUNET_MessageHeader *msg,
597 int type, size_t size)
600 /* handle different message type */
602 case GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_RESPONSE:
603 if (size < sizeof (struct ZoneIterationResponseMessage))
608 handle_zone_iteration_response (ze, (struct ZoneIterationResponseMessage *) msg, size);
617 * Type of a function to call when we receive a message
620 * @param cls the 'struct GNUNET_NAMESTORE_SchedulingHandle'
621 * @param msg message received, NULL on timeout or fatal error
624 process_namestore_message (void *cls, const struct GNUNET_MessageHeader *msg)
626 struct GNUNET_NAMESTORE_Handle *h = cls;
627 struct GNUNET_NAMESTORE_Header * gm;
628 struct GNUNET_NAMESTORE_QueueEntry *qe;
629 struct GNUNET_NAMESTORE_ZoneIterator *ze;
632 uint32_t r_id = UINT32_MAX;
640 size = ntohs (msg->size);
641 type = ntohs (msg->type);
643 if (size < sizeof (struct GNUNET_NAMESTORE_Header))
646 GNUNET_CLIENT_receive (h->client, &process_namestore_message, h,
647 GNUNET_TIME_UNIT_FOREVER_REL);
651 gm = (struct GNUNET_NAMESTORE_Header *) msg;
652 r_id = ntohl (gm->r_id);
654 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received message type %i size %i op %u\n", type, size, r_id);
656 /* Find matching operation */
659 /* No matching pending operation found */
661 GNUNET_CLIENT_receive (h->client, &process_namestore_message, h,
662 GNUNET_TIME_UNIT_FOREVER_REL);
666 /* Is it a record related operation ? */
667 for (qe = h->op_head; qe != NULL; qe = qe->next)
669 if (qe->op_id == r_id)
674 manage_record_operations (qe, msg, type, size);
677 /* Is it a zone iteration operation ? */
678 for (ze = h->z_head; ze != NULL; ze = ze->next)
680 if (ze->op_id == r_id)
685 manage_zone_operations (ze, msg, type, size);
688 GNUNET_CLIENT_receive (h->client, &process_namestore_message, h,
689 GNUNET_TIME_UNIT_FOREVER_REL);
691 if (GNUNET_YES == h->reconnect)
698 * Transmit messages from the message queue to the service
699 * (if there are any, and if we are not already trying).
701 * @param h handle to use
704 do_transmit (struct GNUNET_NAMESTORE_Handle *h);
708 * We can now transmit a message to NAMESTORE. Do it.
710 * @param cls the 'struct GNUNET_NAMESTORE_Handle'
711 * @param size number of bytes we can transmit
712 * @param buf where to copy the messages
713 * @return number of bytes copied into buf
716 transmit_message_to_namestore (void *cls, size_t size, void *buf)
718 struct GNUNET_NAMESTORE_Handle *h = cls;
719 struct PendingMessage *p;
724 if ((size == 0) || (buf == NULL))
731 while ((NULL != (p = h->pending_head)) && (p->size <= size))
733 memcpy (&cbuf[ret], &p[1], p->size);
736 GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, p);
737 if (GNUNET_YES == p->is_init)
738 GNUNET_CLIENT_receive (h->client, &process_namestore_message, h,
739 GNUNET_TIME_UNIT_FOREVER_REL);
748 * Transmit messages from the message queue to the service
749 * (if there are any, and if we are not already trying).
751 * @param h handle to use
754 do_transmit (struct GNUNET_NAMESTORE_Handle *h)
756 struct PendingMessage *p;
760 if (NULL == (p = h->pending_head))
762 if (NULL == h->client)
763 return; /* currently reconnecting */
765 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client, p->size,
766 GNUNET_TIME_UNIT_FOREVER_REL,
767 GNUNET_NO, &transmit_message_to_namestore,
773 * Reconnect to namestore service.
775 * @param h the handle to the namestore service
778 reconnect (struct GNUNET_NAMESTORE_Handle *h)
780 struct PendingMessage *p;
781 struct StartMessage *init;
783 GNUNET_assert (NULL == h->client);
784 h->client = GNUNET_CLIENT_connect ("namestore", h->cfg);
785 GNUNET_assert (NULL != h->client);
787 if ((NULL == (p = h->pending_head)) || (GNUNET_YES != p->is_init))
789 p = GNUNET_malloc (sizeof (struct PendingMessage) +
790 sizeof (struct StartMessage));
791 p->size = sizeof (struct StartMessage);
792 p->is_init = GNUNET_YES;
793 init = (struct StartMessage *) &p[1];
794 init->header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_START);
795 init->header.size = htons (sizeof (struct StartMessage));
796 GNUNET_CONTAINER_DLL_insert (h->pending_head, h->pending_tail, p);
802 * Re-establish the connection to the service.
804 * @param cls handle to use to re-connect.
805 * @param tc scheduler context
808 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
810 struct GNUNET_NAMESTORE_Handle *h = cls;
812 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
818 * Disconnect from service and then reconnect.
820 * @param h our handle
823 force_reconnect (struct GNUNET_NAMESTORE_Handle *h)
825 h->reconnect = GNUNET_NO;
826 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
828 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
834 get_op_id (struct GNUNET_NAMESTORE_Handle *h)
836 uint32_t op_id = h->op_id;
842 * Initialize the connection with the NAMESTORE service.
844 * @param cfg configuration to use
845 * @return handle to the GNS service, or NULL on error
847 struct GNUNET_NAMESTORE_Handle *
848 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
850 struct GNUNET_NAMESTORE_Handle *h;
852 h = GNUNET_malloc (sizeof (struct GNUNET_NAMESTORE_Handle));
854 h->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect_task, h);
860 clean_up_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
862 struct PendingMessage *p;
863 struct GNUNET_NAMESTORE_QueueEntry *q;
864 struct GNUNET_NAMESTORE_ZoneIterator *z;
865 struct GNUNET_NAMESTORE_Handle *h = cls;
866 GNUNET_assert (h != NULL);
867 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Cleaning up\n");
868 while (NULL != (p = h->pending_head))
870 GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, p);
874 while (NULL != (q = h->op_head))
877 GNUNET_CONTAINER_DLL_remove (h->op_head, h->op_tail, q);
881 while (NULL != (z = h->z_head))
883 GNUNET_CONTAINER_DLL_remove (h->z_head, h->z_tail, z);
887 if (NULL != h->client)
889 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
892 if (GNUNET_SCHEDULER_NO_TASK != h->reconnect_task)
894 GNUNET_SCHEDULER_cancel (h->reconnect_task);
895 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
902 * Disconnect from the namestore service (and free associated
905 * @param h handle to the namestore
906 * @param drop set to GNUNET_YES to delete all data in namestore (!)
909 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h, int drop)
911 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Disconnecting from namestore service\n");
912 GNUNET_SCHEDULER_add_now (&clean_up_task, h);
917 * Store an item in the namestore. If the item is already present,
918 * the expiration time is updated to the max of the existing time and
919 * the new time. This API is used when we cache signatures from other
922 * @param h handle to the namestore
923 * @param zone_key public key of the zone
924 * @param name name that is being mapped (at most 255 characters long)
925 * @param expire when does the corresponding block in the DHT expire (until
926 * when should we never do a DHT lookup for the same name again)?
927 * @param rd_count number of entries in 'rd' array
928 * @param rd array of records with data to store
929 * @param signature signature for all the records in the zone under the given name
930 * @param cont continuation to call when done
931 * @param cont_cls closure for cont
932 * @return handle to abort the request
934 struct GNUNET_NAMESTORE_QueueEntry *
935 GNUNET_NAMESTORE_record_put (struct GNUNET_NAMESTORE_Handle *h,
936 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
938 struct GNUNET_TIME_Absolute expire,
939 unsigned int rd_count,
940 const struct GNUNET_NAMESTORE_RecordData *rd,
941 const struct GNUNET_CRYPTO_RsaSignature *signature,
942 GNUNET_NAMESTORE_ContinuationWithStatus cont,
945 struct GNUNET_NAMESTORE_QueueEntry *qe;
946 struct PendingMessage *pe;
948 /* pointer to elements */
954 size_t rd_ser_len = 0;
957 GNUNET_assert (NULL != h);
958 GNUNET_assert (NULL != zone_key);
959 GNUNET_assert (NULL != name);
960 GNUNET_assert (NULL != rd);
961 GNUNET_assert (NULL != signature);
963 name_len = strlen(name) + 1;
971 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
974 qe->cont_cls = cont_cls;
976 GNUNET_CONTAINER_DLL_insert_tail(h->op_head, h->op_tail, qe);
979 rd_ser_len = GNUNET_NAMESTORE_records_get_size(rd_count, rd);
980 char rd_ser[rd_ser_len];
981 GNUNET_NAMESTORE_records_serialize(rd_count, rd, rd_ser_len, rd_ser);
983 struct RecordPutMessage * msg;
984 msg_size = sizeof (struct RecordPutMessage) + name_len + rd_ser_len;
986 /* create msg here */
987 pe = GNUNET_malloc(sizeof (struct PendingMessage) + msg_size);
989 pe->is_init = GNUNET_NO;
990 msg = (struct RecordPutMessage *) &pe[1];
991 name_tmp = (char *) &msg[1];
992 rd_tmp = &name_tmp[name_len];
994 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT);
995 msg->gns_header.header.size = htons (msg_size);
996 msg->gns_header.r_id = htonl (rid);
997 msg->signature = *signature;
998 msg->name_len = htons (name_len);
999 msg->expire = GNUNET_TIME_absolute_hton (expire);
1000 msg->rd_len = htons (rd_ser_len);
1001 msg->rd_count = htons (rd_count);
1003 msg->public_key = *zone_key;
1004 memcpy (name_tmp, name, name_len);
1005 memcpy (rd_tmp, rd_ser, rd_ser_len);
1007 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message for name `%s' with size %u\n", "NAMESTORE_RECORD_PUT", name, msg_size);
1009 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1017 * Check if a signature is valid. This API is used by the GNS Block
1018 * to validate signatures received from the network.
1020 * @param public_key public key of the zone
1021 * @param name name that is being mapped (at most 255 characters long)
1022 * @param rd_count number of entries in 'rd' array
1023 * @param rd array of records with data to store
1024 * @param signature signature for all the records in the zone under the given name
1025 * @return GNUNET_OK if the signature is valid
1028 GNUNET_NAMESTORE_verify_signature (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *public_key,
1030 unsigned int rd_count,
1031 const struct GNUNET_NAMESTORE_RecordData *rd,
1032 const struct GNUNET_CRYPTO_RsaSignature *signature)
1034 int res = GNUNET_SYSERR;
1035 size_t rd_ser_len = 0;
1036 size_t name_len = 0;
1039 struct GNUNET_CRYPTO_RsaSignaturePurpose *sig_purpose;
1041 GNUNET_assert (public_key != NULL);
1042 GNUNET_assert (name != NULL);
1043 GNUNET_assert (rd != NULL);
1044 GNUNET_assert (signature != NULL);
1047 rd_ser_len = GNUNET_NAMESTORE_records_get_size(rd_count, rd);
1048 char rd_ser[rd_ser_len];
1049 GNUNET_NAMESTORE_records_serialize(rd_count, rd, rd_ser_len, rd_ser);
1051 name_len = strlen (name) + 1;
1055 return GNUNET_SYSERR;
1058 sig_purpose = GNUNET_malloc(sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) + rd_ser_len + name_len);
1059 sig_purpose->size = htonl (sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose)+ rd_ser_len + name_len);
1060 sig_purpose->purpose = htonl (GNUNET_SIGNATURE_PURPOSE_GNS_RECORD_SIGN);
1061 name_tmp = (char *) &sig_purpose[1];
1062 rd_tmp = &name_tmp[name_len];
1063 memcpy (name_tmp, name, name_len);
1064 memcpy (rd_tmp, rd_ser, rd_ser_len);
1066 res = GNUNET_CRYPTO_rsa_verify(GNUNET_SIGNATURE_PURPOSE_GNS_RECORD_SIGN, sig_purpose, signature, public_key);
1068 GNUNET_free (sig_purpose);
1074 * Store an item in the namestore. If the item is already present,
1075 * the expiration time is updated to the max of the existing time and
1076 * the new time. This API is used by the authority of a zone.
1078 * @param h handle to the namestore
1079 * @param pkey private key of the zone
1080 * @param name name that is being mapped (at most 255 characters long)
1081 * @param rd record data to store
1082 * @param cont continuation to call when done
1083 * @param cont_cls closure for cont
1084 * @return handle to abort the request
1086 struct GNUNET_NAMESTORE_QueueEntry *
1087 GNUNET_NAMESTORE_record_create (struct GNUNET_NAMESTORE_Handle *h,
1088 const struct GNUNET_CRYPTO_RsaPrivateKey *pkey,
1090 const struct GNUNET_NAMESTORE_RecordData *rd,
1091 GNUNET_NAMESTORE_ContinuationWithStatus cont,
1094 struct GNUNET_NAMESTORE_QueueEntry *qe;
1095 struct PendingMessage *pe;
1099 size_t rd_ser_len = 0;
1100 size_t msg_size = 0;
1101 size_t name_len = 0;
1105 GNUNET_assert (NULL != h);
1106 GNUNET_assert (NULL != pkey);
1107 GNUNET_assert (NULL != name);
1108 GNUNET_assert (NULL != rd);
1110 name_len = strlen(name) + 1;
1118 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
1121 qe->cont_cls = cont_cls;
1123 GNUNET_CONTAINER_DLL_insert_tail(h->op_head, h->op_tail, qe);
1126 struct GNUNET_CRYPTO_RsaPrivateKeyBinaryEncoded * pkey_enc = GNUNET_CRYPTO_rsa_encode_key (pkey);
1127 GNUNET_assert (pkey_enc != NULL);
1128 key_len = ntohs (pkey_enc->len);
1130 rd_ser_len = GNUNET_NAMESTORE_records_get_size(1, rd);
1131 char rd_ser[rd_ser_len];
1132 GNUNET_NAMESTORE_records_serialize(1, rd, rd_ser_len, rd_ser);
1134 struct RecordCreateMessage * msg;
1135 msg_size = sizeof (struct RecordCreateMessage) + key_len + name_len + rd_ser_len;
1137 /* create msg here */
1138 pe = GNUNET_malloc(sizeof (struct PendingMessage) + msg_size);
1139 pe->size = msg_size;
1140 pe->is_init = GNUNET_NO;
1141 msg = (struct RecordCreateMessage *) &pe[1];
1143 pkey_tmp = (char *) &msg[1];
1144 name_tmp = &pkey_tmp[key_len];
1145 rd_tmp = &name_tmp[name_len];
1147 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE);
1148 msg->gns_header.header.size = htons (msg_size);
1149 msg->gns_header.r_id = htonl (rid);
1150 msg->name_len = htons (name_len);
1151 msg->rd_count = htons (1);
1152 msg->rd_len = htons (rd_ser_len);
1153 msg->pkey_len = htons (key_len);
1154 memcpy (pkey_tmp, pkey_enc, key_len);
1155 memcpy (name_tmp, name, name_len);
1156 memcpy (rd_tmp, rd_ser, rd_ser_len);
1157 GNUNET_free (pkey_enc);
1159 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message for name `%s' with size %u\n", "NAMESTORE_RECORD_CREATE", name, msg_size);
1161 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1168 * Explicitly remove some content from the database. The
1169 * "cont"inuation will be called with status "GNUNET_OK" if content
1170 * was removed, "GNUNET_NO" if no matching entry was found and
1171 * "GNUNET_SYSERR" on all other types of errors.
1172 * This API is used by the authority of a zone.
1174 * @param h handle to the namestore
1175 * @param pkey private key of the zone
1176 * @param name name that is being mapped (at most 255 characters long)
1177 * @param rd record data
1178 * @param cont continuation to call when done
1179 * @param cont_cls closure for cont
1180 * @return handle to abort the request
1182 struct GNUNET_NAMESTORE_QueueEntry *
1183 GNUNET_NAMESTORE_record_remove (struct GNUNET_NAMESTORE_Handle *h,
1184 const struct GNUNET_CRYPTO_RsaPrivateKey *pkey,
1186 const struct GNUNET_NAMESTORE_RecordData *rd,
1187 GNUNET_NAMESTORE_ContinuationWithStatus cont,
1190 struct GNUNET_NAMESTORE_QueueEntry *qe;
1191 struct PendingMessage *pe;
1195 size_t rd_ser_len = 0;
1196 size_t msg_size = 0;
1197 size_t name_len = 0;
1201 GNUNET_assert (NULL != h);
1204 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
1207 qe->cont_cls = cont_cls;
1209 GNUNET_CONTAINER_DLL_insert_tail(h->op_head, h->op_tail, qe);
1212 struct GNUNET_CRYPTO_RsaPrivateKeyBinaryEncoded * pkey_enc = GNUNET_CRYPTO_rsa_encode_key (pkey);
1213 GNUNET_assert (pkey_enc != NULL);
1214 key_len = ntohs (pkey_enc->len);
1216 rd_ser_len = GNUNET_NAMESTORE_records_get_size(1, rd);
1217 char rd_ser[rd_ser_len];
1218 GNUNET_NAMESTORE_records_serialize(1, rd, rd_ser_len, rd_ser);
1220 name_len = strlen (name) + 1;
1222 struct RecordRemoveMessage * msg;
1223 msg_size = sizeof (struct RecordRemoveMessage) + key_len + name_len + rd_ser_len;
1225 /* create msg here */
1226 pe = GNUNET_malloc(sizeof (struct PendingMessage) + msg_size);
1227 pe->size = msg_size;
1228 pe->is_init = GNUNET_NO;
1229 msg = (struct RecordRemoveMessage *) &pe[1];
1231 pkey_tmp = (char *) &msg[1];
1232 name_tmp = &pkey_tmp[key_len];
1233 rd_tmp = &name_tmp[name_len];
1235 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE);
1236 msg->gns_header.header.size = htons (msg_size);
1237 msg->gns_header.r_id = htonl (rid);
1238 msg->name_len = htons (name_len);
1239 msg->rd_len = htons (rd_ser_len);
1240 msg->rd_count = htons (1);
1241 msg->pkey_len = htons (key_len);
1242 memcpy (pkey_tmp, pkey_enc, key_len);
1243 memcpy (name_tmp, name, name_len);
1244 memcpy (rd_tmp, rd_ser, rd_ser_len);
1246 GNUNET_free (pkey_enc);
1248 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message for name `%s' with size %u\n", "NAMESTORE_RECORD_REMOVE", name, msg_size);
1250 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1257 * Get a result for a particular key from the namestore. The processor
1258 * will only be called once.
1260 * @param h handle to the namestore
1261 * @param zone zone to look up a record from
1262 * @param name name to look up
1263 * @param record_type desired record type, 0 for all
1264 * @param proc function to call on the matching records, or with
1265 * NULL (rd_count == 0) if there are no matching records
1266 * @param proc_cls closure for proc
1267 * @return a handle that can be used to
1270 struct GNUNET_NAMESTORE_QueueEntry *
1271 GNUNET_NAMESTORE_lookup_record (struct GNUNET_NAMESTORE_Handle *h,
1272 const GNUNET_HashCode *zone,
1274 uint32_t record_type,
1275 GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls)
1277 struct GNUNET_NAMESTORE_QueueEntry *qe;
1278 struct PendingMessage *pe;
1279 size_t msg_size = 0;
1280 size_t name_len = 0;
1283 GNUNET_assert (NULL != h);
1284 GNUNET_assert (NULL != zone);
1285 GNUNET_assert (NULL != name);
1287 name_len = strlen (name) + 1;
1288 if ((name_len == 0) || (name_len > 256))
1295 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
1298 qe->proc_cls = proc_cls;
1300 GNUNET_CONTAINER_DLL_insert_tail(h->op_head, h->op_tail, qe);
1303 msg_size = sizeof (struct LookupNameMessage) + name_len;
1304 pe = GNUNET_malloc(sizeof (struct PendingMessage) + msg_size);
1306 /* create msg here */
1307 struct LookupNameMessage * msg;
1308 pe->size = msg_size;
1309 pe->is_init = GNUNET_NO;
1310 msg = (struct LookupNameMessage *) &pe[1];
1311 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME);
1312 msg->gns_header.header.size = htons (msg_size);
1313 msg->gns_header.r_id = htonl (rid);
1314 msg->record_type = htonl (record_type);
1316 msg->name_len = htonl (name_len);
1317 memcpy (&msg[1], name, name_len);
1319 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message for name `%s'\n", "NAMESTORE_LOOKUP_NAME", name);
1321 /* transmit message */
1322 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1330 * Look for an existing PKEY delegation record for a given public key.
1331 * Returns at most one result to the processor.
1333 * @param h handle to the namestore
1334 * @param zone hash of public key of the zone to look up in, never NULL
1335 * @param value_zone hash of the public key of the target zone (value), never NULL
1336 * @param proc function to call on the matching records, or with
1337 * NULL (rd_count == 0) if there are no matching records
1338 * @param proc_cls closure for proc
1339 * @return a handle that can be used to
1342 struct GNUNET_NAMESTORE_QueueEntry *
1343 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
1344 const GNUNET_HashCode *zone,
1345 const GNUNET_HashCode *value_zone,
1346 GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls)
1348 struct GNUNET_NAMESTORE_QueueEntry *qe;
1349 struct PendingMessage *pe;
1350 size_t msg_size = 0;
1353 GNUNET_assert (NULL != h);
1354 GNUNET_assert (NULL != zone);
1355 GNUNET_assert (NULL != value_zone);
1358 qe = GNUNET_malloc(sizeof (struct GNUNET_NAMESTORE_QueueEntry));
1361 qe->proc_cls = proc_cls;
1363 GNUNET_CONTAINER_DLL_insert_tail(h->op_head, h->op_tail, qe);
1366 msg_size = sizeof (struct ZoneToNameMessage);
1367 pe = GNUNET_malloc(sizeof (struct PendingMessage) + msg_size);
1369 /* create msg here */
1370 struct ZoneToNameMessage * msg;
1371 pe->size = msg_size;
1372 pe->is_init = GNUNET_NO;
1373 msg = (struct ZoneToNameMessage *) &pe[1];
1374 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME);
1375 msg->gns_header.header.size = htons (msg_size);
1376 msg->gns_header.r_id = htonl (rid);
1378 msg->value_zone = *value_zone;
1380 char * z_tmp = strdup (GNUNET_h2s (zone));
1381 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message for zone `%s' in zone `%s'\n",
1382 "NAMESTORE_ZONE_TO_NAME",
1384 GNUNET_h2s (value_zone));
1385 GNUNET_free (z_tmp);
1387 /* transmit message */
1388 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1397 * Starts a new zone iteration (used to periodically PUT all of our
1398 * records into our DHT). This MUST lock the GNUNET_NAMESTORE_Handle
1399 * for any other calls than GNUNET_NAMESTORE_zone_iterator_next and
1400 * GNUNET_NAMESTORE_zone_iteration_stop. "proc" will be called once
1401 * immediately, and then again after
1402 * "GNUNET_NAMESTORE_zone_iterator_next" is invoked.
1404 * @param h handle to the namestore
1405 * @param zone zone to access, NULL for all zones
1406 * @param must_have_flags flags that must be set for the record to be returned
1407 * @param must_not_have_flags flags that must NOT be set for the record to be returned
1408 * @param proc function to call on each name from the zone; it
1409 * will be called repeatedly with a value (if available)
1410 * and always once at the end with a name of NULL.
1411 * @param proc_cls closure for proc
1412 * @return an iterator handle to use for iteration
1414 struct GNUNET_NAMESTORE_ZoneIterator *
1415 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
1416 const GNUNET_HashCode *zone,
1417 enum GNUNET_NAMESTORE_RecordFlags must_have_flags,
1418 enum GNUNET_NAMESTORE_RecordFlags must_not_have_flags,
1419 GNUNET_NAMESTORE_RecordProcessor proc,
1422 struct GNUNET_NAMESTORE_ZoneIterator *it;
1423 struct PendingMessage *pe;
1424 size_t msg_size = 0;
1427 GNUNET_assert (NULL != h);
1428 GNUNET_assert (NULL != zone);
1431 it = GNUNET_malloc (sizeof (struct GNUNET_NAMESTORE_ZoneIterator));
1434 it->proc_cls = proc;
1437 GNUNET_CONTAINER_DLL_insert_tail(h->z_head, h->z_tail, it);
1440 msg_size = sizeof (struct ZoneIterationStartMessage);
1441 pe = GNUNET_malloc(sizeof (struct PendingMessage) + msg_size);
1443 /* create msg here */
1444 struct ZoneIterationStartMessage * msg;
1445 pe->size = msg_size;
1446 pe->is_init = GNUNET_NO;
1447 msg = (struct ZoneIterationStartMessage *) &pe[1];
1448 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START);
1449 msg->gns_header.header.size = htons (msg_size);
1450 msg->gns_header.r_id = htonl (rid);
1452 msg->must_have_flags = ntohs (must_have_flags);
1453 msg->must_not_have_flags = ntohs (must_not_have_flags);
1455 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message for zone `%s'\n", "ZONE_ITERATION_START", GNUNET_h2s(zone));
1457 /* transmit message */
1458 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1466 * Calls the record processor specified in GNUNET_NAMESTORE_zone_iteration_start
1467 * for the next record.
1469 * @param it the iterator
1472 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it)
1474 struct GNUNET_NAMESTORE_Handle *h;
1475 struct PendingMessage *pe;
1476 size_t msg_size = 0;
1478 GNUNET_assert (NULL != it);
1482 msg_size = sizeof (struct ZoneIterationNextMessage);
1483 pe = GNUNET_malloc(sizeof (struct PendingMessage) + msg_size);
1485 /* create msg here */
1486 struct ZoneIterationNextMessage * msg;
1487 pe->size = msg_size;
1488 pe->is_init = GNUNET_NO;
1489 msg = (struct ZoneIterationNextMessage *) &pe[1];
1490 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT);
1491 msg->gns_header.header.size = htons (msg_size);
1492 msg->gns_header.r_id = htonl (it->op_id);
1494 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message for name `%s'\n", "ZONE_ITERATION_NEXT", GNUNET_h2s(&it->zone));
1496 /* transmit message */
1497 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1503 * Stops iteration and releases the namestore handle for further calls.
1505 * @param it the iterator
1508 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it)
1510 GNUNET_assert (NULL != it);
1511 struct PendingMessage *pe;
1512 size_t msg_size = 0;
1513 struct GNUNET_NAMESTORE_Handle *h = it->h;
1516 msg_size = sizeof (struct ZoneIterationStopMessage);
1517 pe = GNUNET_malloc(sizeof (struct PendingMessage) + msg_size);
1519 /* create msg here */
1520 struct ZoneIterationStopMessage * msg;
1521 pe->size = msg_size;
1522 pe->is_init = GNUNET_NO;
1523 msg = (struct ZoneIterationStopMessage *) &pe[1];
1524 msg->gns_header.header.type = htons (GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP);
1525 msg->gns_header.header.size = htons (msg_size);
1526 msg->gns_header.r_id = htonl (it->op_id);
1528 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message for name `%s'\n", "ZONE_ITERATION_STOP", GNUNET_h2s(&it->zone));
1530 /* transmit message */
1531 GNUNET_CONTAINER_DLL_insert_tail (h->pending_head, h->pending_tail, pe);
1537 * Cancel a namestore operation. The final callback from the
1538 * operation must not have been done yet.
1540 * @param qe operation to cancel
1543 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe)
1545 struct GNUNET_NAMESTORE_Handle *h = qe->nsh;
1547 GNUNET_assert (qe != NULL);
1549 GNUNET_CONTAINER_DLL_remove(h->op_head, h->op_tail, qe);
1554 /* end of namestore_api.c */