2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 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.
24 * - Write xquery and block plugin
25 * - The smaller FIXME issues all around
27 * @file gns/gnunet-service-gns.c
28 * @brief GNUnet GNS service
29 * @author Martin Schanzenbach
32 #include "gnunet_util_lib.h"
33 #include "gnunet_transport_service.h"
34 #include "gnunet_dns_service.h"
35 #include "gnunet_dnsparser_lib.h"
36 #include "gnunet_dht_service.h"
37 #include "gnunet_namestore_service.h"
38 #include "gnunet_gns_service.h"
39 #include "block_gns.h"
41 #include "gnunet-service-gns_resolver.h"
42 #include "gnunet-service-gns_interceptor.h"
44 /* FIXME move to proper header in include */
45 #define GNUNET_MESSAGE_TYPE_GNS_LOOKUP 23
46 #define GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT 24
47 #define GNUNET_MESSAGE_TYPE_GNS_SHORTEN 25
48 #define GNUNET_MESSAGE_TYPE_GNS_SHORTEN_RESULT 26
49 #define GNUNET_MESSAGE_TYPE_GNS_GET_AUTH 27
50 #define GNUNET_MESSAGE_TYPE_GNS_GET_AUTH_RESULT 28
54 * Handle to a shorten operation from api
56 struct ClientShortenHandle
58 /* the requesting client that */
59 struct GNUNET_SERVER_Client *client;
65 enum GNUNET_GNS_RecordType type;
74 * Handle to a get auhtority operation from api
76 struct ClientGetAuthHandle
78 /* the requesting client that */
79 struct GNUNET_SERVER_Client *client;
84 /* name to lookup authority */
91 * Handle to a lookup operation from api
93 struct ClientLookupHandle
95 /* the requesting client that */
96 struct GNUNET_SERVER_Client *client;
102 enum GNUNET_GNS_RecordType type;
104 /* the name to look up */
105 char* name; //Needed?
109 * Our handle to the DHT
111 static struct GNUNET_DHT_Handle *dht_handle;
114 * Our zone's private key
116 struct GNUNET_CRYPTO_RsaPrivateKey *zone_key;
119 * Our handle to the namestore service
120 * FIXME maybe need a second handle for iteration
122 struct GNUNET_NAMESTORE_Handle *namestore_handle;
125 * Handle to iterate over our authoritative zone in namestore
127 struct GNUNET_NAMESTORE_ZoneIterator *namestore_iter;
130 * The configuration the GNS service is running with
132 const struct GNUNET_CONFIGURATION_Handle *GNS_cfg;
135 * Our notification context.
137 static struct GNUNET_SERVER_NotificationContext *nc;
142 GNUNET_HashCode zone_hash;
145 * Useful for zone update for DHT put
147 static int num_public_records = 3600;
149 /* dht update interval FIXME define? */
150 static struct GNUNET_TIME_Relative dht_update_interval;
152 /* zone update task */
153 GNUNET_SCHEDULER_TaskIdentifier zone_update_taskid = GNUNET_SCHEDULER_NO_TASK;
156 * Task run during shutdown.
162 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
165 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
167 /* Kill zone task for it may make the scheduler hang */
168 if (zone_update_taskid)
169 GNUNET_SCHEDULER_cancel(zone_update_taskid);
171 GNUNET_SERVER_notification_context_destroy (nc);
173 gns_interceptor_stop();
175 GNUNET_NAMESTORE_disconnect(namestore_handle, 1);
176 GNUNET_DHT_disconnect(dht_handle);
181 * Method called periodicattluy that triggers
182 * iteration over root zone
185 * @param tc task context
188 update_zone_dht_next(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
190 GNUNET_NAMESTORE_zone_iterator_next(namestore_iter);
194 * Continuation for DHT put
197 * @param tc task context
200 record_dht_put(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
202 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "put request transmitted\n");
207 update_zone_dht_start(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
210 * Function used to put all records successively into the DHT.
212 * @param cls the closure (NULL)
213 * @param key the public key of the authority (ours)
214 * @param expiration lifetime of the namestore entry
215 * @param name the name of the records
216 * @param rd_count the number of records in data
217 * @param rd the record data
218 * @param signature the signature for the record data
221 put_gns_record(void *cls,
222 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *key,
223 struct GNUNET_TIME_Absolute expiration,
225 unsigned int rd_count,
226 const struct GNUNET_NAMESTORE_RecordData *rd,
227 const struct GNUNET_CRYPTO_RsaSignature *signature)
230 struct GNSNameRecordBlock *nrb;
231 GNUNET_HashCode name_hash;
232 GNUNET_HashCode xor_hash;
233 struct GNUNET_CRYPTO_HashAsciiEncoded xor_hash_string;
234 uint32_t rd_payload_length;
235 char* nrb_data = NULL;
241 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
242 "Zone iteration finished. Rescheduling put in %ds\n",
243 GNUNET_GNS_DHT_MAX_UPDATE_INTERVAL);
244 zone_update_taskid = GNUNET_SCHEDULER_add_delayed (
245 GNUNET_TIME_relative_multiply(
246 GNUNET_TIME_UNIT_SECONDS,
247 GNUNET_GNS_DHT_MAX_UPDATE_INTERVAL
249 &update_zone_dht_start,
254 namelen = strlen(name) + 1;
256 if (signature == NULL)
258 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
259 "No signature for %s record data provided! Skipping...\n",
261 zone_update_taskid = GNUNET_SCHEDULER_add_now (&update_zone_dht_next,
267 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
268 "Putting records for %s into the DHT\n", name);
270 rd_payload_length = GNUNET_NAMESTORE_records_get_size (rd_count, rd);
272 nrb = GNUNET_malloc(rd_payload_length + namelen
273 + sizeof(struct GNSNameRecordBlock));
275 nrb->signature = *signature;
277 nrb->public_key = *key;
279 nrb->rd_count = htonl(rd_count);
281 memcpy(&nrb[1], name, namelen);
283 nrb_data = (char*)&nrb[1];
286 rd_payload_length += sizeof(struct GNSNameRecordBlock) + namelen;
288 if (-1 == GNUNET_NAMESTORE_records_serialize (rd_count,
293 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
294 "Record serialization failed! Skipping...\n");
296 zone_update_taskid = GNUNET_SCHEDULER_add_now (&update_zone_dht_next,
303 * calculate DHT key: H(name) xor H(pubkey)
305 GNUNET_CRYPTO_hash(name, strlen(name), &name_hash);
306 GNUNET_CRYPTO_hash_xor(&zone_hash, &name_hash, &xor_hash);
307 GNUNET_CRYPTO_hash_to_enc (&xor_hash, &xor_hash_string);
309 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
310 "putting records for %s under key: %s with size %d\n",
311 name, (char*)&xor_hash_string, rd_payload_length);
313 GNUNET_DHT_put (dht_handle, &xor_hash,
314 DHT_GNS_REPLICATION_LEVEL,
316 GNUNET_BLOCK_TYPE_GNS_NAMERECORD,
320 DHT_OPERATION_TIMEOUT,
322 NULL); //cls for cont
324 num_public_records++;
327 * Reschedule periodic put
329 zone_update_taskid = GNUNET_SCHEDULER_add_delayed (dht_update_interval,
330 &update_zone_dht_next,
338 * Periodically iterate over our zone and store everything in dht
341 * @param tc task context
344 update_zone_dht_start(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
346 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Scheduling DHT zone update!\n");
347 if (0 == num_public_records)
349 dht_update_interval = GNUNET_TIME_relative_multiply(
350 GNUNET_TIME_UNIT_SECONDS,
351 GNUNET_GNS_DHT_MAX_UPDATE_INTERVAL);
352 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
353 "No records in db. Adjusted DHT update interval to %ds\n",
354 GNUNET_GNS_DHT_MAX_UPDATE_INTERVAL);
359 dht_update_interval = GNUNET_TIME_relative_multiply(
360 GNUNET_TIME_UNIT_SECONDS,
361 (3600/num_public_records));
362 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
363 "Adjusted DHT update interval to %ds!\n",
364 (3600/num_public_records));
367 /* start counting again */
368 num_public_records = 0;
369 namestore_iter = GNUNET_NAMESTORE_zone_iteration_start (namestore_handle,
371 GNUNET_NAMESTORE_RF_AUTHORITY,
372 GNUNET_NAMESTORE_RF_PRIVATE,
378 /* END DHT ZONE PROPAGATION */
381 * Send shorten response back to client
383 * @param name the shortened name result or NULL if cannot be shortened
384 * @param csh the handle to the shorten request
387 send_shorten_response(void* cls, const char* name)
389 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message with %s\n",
390 "SHORTEN_RESULT", name);
391 struct GNUNET_GNS_ClientShortenResultMessage *rmsg;
392 struct ClientShortenHandle *csh = (struct ClientShortenHandle *)cls;
399 rmsg = GNUNET_malloc(sizeof(struct GNUNET_GNS_ClientShortenResultMessage)
402 rmsg->id = csh->unique_id;
403 rmsg->header.type = htons(GNUNET_MESSAGE_TYPE_GNS_SHORTEN_RESULT);
405 htons(sizeof(struct GNUNET_GNS_ClientShortenResultMessage) +
408 strcpy((char*)&rmsg[1], name);
410 GNUNET_SERVER_notification_context_unicast (nc, csh->client,
411 (const struct GNUNET_MessageHeader *) rmsg,
413 GNUNET_SERVER_receive_done (csh->client, GNUNET_OK);
416 GNUNET_free_non_null(csh->name);
422 * Handle a shorten message from the api
424 * @param cls the closure
425 * @param client the client
426 * @param message the message
428 static void handle_shorten(void *cls,
429 struct GNUNET_SERVER_Client * client,
430 const struct GNUNET_MessageHeader * message)
432 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "SHORTEN");
435 struct ClientShortenHandle *csh;
438 if (ntohs (message->size) < sizeof (struct GNUNET_GNS_ClientShortenMessage))
441 GNUNET_SERVER_receive_done (client, GNUNET_OK);
445 GNUNET_SERVER_notification_context_add (nc, client);
447 struct GNUNET_GNS_ClientShortenMessage *sh_msg =
448 (struct GNUNET_GNS_ClientShortenMessage *) message;
450 msg_size = ntohs(message->size);
452 if (msg_size > GNUNET_SERVER_MAX_MESSAGE_SIZE)
455 GNUNET_SERVER_receive_done (client, GNUNET_OK);
459 csh = GNUNET_malloc(sizeof(struct ClientShortenHandle));
460 csh->client = client;
461 csh->unique_id = sh_msg->id;
463 name = (char*)&sh_msg[1];
465 if (strlen (name) < strlen(GNUNET_GNS_TLD)) {
467 send_shorten_response(csh, name);
471 if (strcmp(name+strlen(name)-strlen(GNUNET_GNS_TLD),
472 GNUNET_GNS_TLD) != 0)
474 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
475 "%s is not our domain. Returning\n", name);
477 send_shorten_response(csh, name);
481 csh->name = GNUNET_malloc(strlen(name)
482 - strlen(GNUNET_GNS_TLD) + 1);
484 strlen(name)-strlen(GNUNET_GNS_TLD) + 1);
485 memcpy(csh->name, name,
486 strlen(name)-strlen(GNUNET_GNS_TLD));
488 /* Start shortening */
489 gns_resolver_shorten_name(zone_hash, name, &send_shorten_response, csh);
494 * Send get authority response back to client
496 * @param name the shortened name result or NULL if cannot be shortened
497 * @param cah the handle to the get authority request
500 send_get_auth_response(void *cls, const char* name)
502 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message with %s\n",
503 "GET_AUTH_RESULT", name);
504 struct GNUNET_GNS_ClientGetAuthResultMessage *rmsg;
505 struct ClientGetAuthHandle *cah = (struct ClientGetAuthHandle *)cls;
512 rmsg = GNUNET_malloc(sizeof(struct GNUNET_GNS_ClientGetAuthResultMessage)
515 rmsg->id = cah->unique_id;
516 rmsg->header.type = htons(GNUNET_MESSAGE_TYPE_GNS_GET_AUTH_RESULT);
518 htons(sizeof(struct GNUNET_GNS_ClientGetAuthResultMessage) +
521 strcpy((char*)&rmsg[1], name);
523 GNUNET_SERVER_notification_context_unicast (nc, cah->client,
524 (const struct GNUNET_MessageHeader *) rmsg,
526 GNUNET_SERVER_receive_done (cah->client, GNUNET_OK);
528 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Cleaning up handles...\n");
531 GNUNET_free_non_null(cah->name);
534 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "done.\n");
540 * Handle a get authority message from the api
542 * @param cls the closure
543 * @param client the client
544 * @param message the message
546 static void handle_get_authority(void *cls,
547 struct GNUNET_SERVER_Client * client,
548 const struct GNUNET_MessageHeader * message)
550 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "GET_AUTH");
553 struct ClientGetAuthHandle *cah;
556 if (ntohs (message->size) < sizeof (struct GNUNET_GNS_ClientGetAuthMessage))
559 GNUNET_SERVER_receive_done (client, GNUNET_OK);
563 GNUNET_SERVER_notification_context_add (nc, client);
565 struct GNUNET_GNS_ClientGetAuthMessage *sh_msg =
566 (struct GNUNET_GNS_ClientGetAuthMessage *) message;
568 msg_size = ntohs(message->size);
570 if (msg_size > GNUNET_SERVER_MAX_MESSAGE_SIZE)
573 GNUNET_SERVER_receive_done (client, GNUNET_OK);
577 name = (char*)&sh_msg[1];
579 cah = GNUNET_malloc(sizeof(struct ClientGetAuthHandle));
580 cah->client = client;
581 cah->unique_id = sh_msg->id;
583 if (strlen(name) < strlen(GNUNET_GNS_TLD))
585 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
586 "%s is too short. Returning\n", name);
588 send_get_auth_response(cah, name);
592 if (strcmp(name+strlen(name)-strlen(GNUNET_GNS_TLD),
593 GNUNET_GNS_TLD) != 0)
595 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
596 "%s is not our domain. Returning\n", name);
598 send_get_auth_response(cah, name);
602 if (strcmp(name, GNUNET_GNS_TLD) == 0)
604 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
605 "%s is us. Returning\n", name);
607 send_get_auth_response(cah, name);
611 cah->name = GNUNET_malloc(strlen(name)
612 - strlen(GNUNET_GNS_TLD) + 1);
614 strlen(name)-strlen(GNUNET_GNS_TLD) + 1);
615 memcpy(cah->name, name,
616 strlen(name)-strlen(GNUNET_GNS_TLD));
618 /* Start delegation resolution in our namestore */
619 gns_resolver_get_authority(zone_hash, name, &send_get_auth_response, cah);
624 * Reply to client with the result from our lookup.
626 * @param cls the closure (our client lookup handle)
627 * @param rh the request handle of the lookup
628 * @param rd_count the number of records
629 * @param rd the record data
632 send_lookup_response(void* cls,
634 const struct GNUNET_NAMESTORE_RecordData *rd)
636 struct ClientLookupHandle* clh = (struct ClientLookupHandle*)cls;
637 struct GNUNET_GNS_ClientLookupResultMessage *rmsg;
640 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message with %d results\n",
641 "LOOKUP_RESULT", rd_count);
643 len = GNUNET_NAMESTORE_records_get_size (rd_count, rd);
644 rmsg = GNUNET_malloc(len+sizeof(struct GNUNET_GNS_ClientLookupResultMessage));
646 rmsg->id = clh->unique_id;
647 rmsg->rd_count = htonl(rd_count);
648 rmsg->header.type = htons(GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT);
650 htons(len+sizeof(struct GNUNET_GNS_ClientLookupResultMessage));
652 GNUNET_NAMESTORE_records_serialize (rd_count, rd, len, (char*)&rmsg[1]);
654 GNUNET_SERVER_notification_context_unicast (nc, clh->client,
655 (const struct GNUNET_MessageHeader *) rmsg,
657 GNUNET_SERVER_receive_done (clh->client, GNUNET_OK);
660 GNUNET_free(clh->name);
667 * Handle lookup requests from client
669 * @param cls the closure
670 * @param client the client
671 * @param message the message
674 handle_lookup(void *cls,
675 struct GNUNET_SERVER_Client * client,
676 const struct GNUNET_MessageHeader * message)
678 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "LOOKUP");
683 struct ClientLookupHandle *clh;
685 if (ntohs (message->size) < sizeof (struct GNUNET_GNS_ClientLookupMessage))
688 GNUNET_SERVER_receive_done (client, GNUNET_OK);
692 GNUNET_SERVER_notification_context_add (nc, client);
694 struct GNUNET_GNS_ClientLookupMessage *sh_msg =
695 (struct GNUNET_GNS_ClientLookupMessage *) message;
697 msg_size = ntohs(message->size);
699 if (msg_size > GNUNET_SERVER_MAX_MESSAGE_SIZE)
702 GNUNET_SERVER_receive_done (client, GNUNET_OK);
706 name = (char*)&sh_msg[1];
707 namelen = strlen(name)+1;
708 clh = GNUNET_malloc(sizeof(struct ClientLookupHandle));
709 clh->client = client;
710 clh->name = GNUNET_malloc(namelen);
711 strcpy(clh->name, name);
712 clh->unique_id = sh_msg->id;
713 clh->type = ntohl(sh_msg->type);
715 gns_resolver_lookup_record(zone_hash, clh->type, name,
716 &send_lookup_response, clh);
722 * Process GNS requests.
724 * @param cls closure)
725 * @param server the initialized server
726 * @param c configuration to use
729 run (void *cls, struct GNUNET_SERVER_Handle *server,
730 const struct GNUNET_CONFIGURATION_Handle *c)
733 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Initializing GNS\n");
736 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pkey;
738 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
739 {&handle_shorten, NULL, GNUNET_MESSAGE_TYPE_GNS_SHORTEN, 0},
740 {&handle_lookup, NULL, GNUNET_MESSAGE_TYPE_GNS_LOOKUP, 0},
741 {&handle_get_authority, NULL, GNUNET_MESSAGE_TYPE_GNS_GET_AUTH, 0}
744 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c, "gns",
745 "ZONEKEY", &keyfile))
747 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
748 "No private key for root zone specified!\n");
749 GNUNET_SCHEDULER_shutdown(0);
753 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
754 "Using keyfile %s for root zone.\n", keyfile);
756 zone_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
757 GNUNET_CRYPTO_rsa_key_get_public (zone_key, &pkey);
759 GNUNET_CRYPTO_hash(&pkey, sizeof(struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
761 GNUNET_free(keyfile);
764 * handle to our local namestore
766 namestore_handle = GNUNET_NAMESTORE_connect(c);
768 if (NULL == namestore_handle)
770 //FIXME do error handling;
771 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
772 "Failed to connect to the namestore!\n");
773 GNUNET_SCHEDULER_shutdown(0);
780 dht_handle = GNUNET_DHT_connect(c, 1); //FIXME get ht_len from cfg
782 if (NULL == dht_handle)
784 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Could not connect to DHT!\n");
787 if (gns_resolver_init(namestore_handle, dht_handle) == GNUNET_SYSERR)
789 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
790 "Unable to initialize resolver!\n");
791 GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
796 GNUNET_CONFIGURATION_get_value_yesno (c, "gns",
799 GNUNET_log(GNUNET_ERROR_TYPE_INFO,
800 "DNS hijacking enabled... connecting to service.\n");
802 if (gns_interceptor_init(zone_hash, c) == GNUNET_SYSERR)
804 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
805 "Failed to enable the dns interceptor!\n");
809 //put_some_records(); //FIXME for testing
812 * Schedule periodic put
814 * We have roughly an hour for all records;
816 dht_update_interval = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
818 zone_update_taskid = GNUNET_SCHEDULER_add_now (&update_zone_dht_start, NULL);
820 GNUNET_SERVER_add_handlers (server, handlers);
823 //GNUNET_SERVER_disconnect_notify (server,
824 // &client_disconnect_notification,
827 nc = GNUNET_SERVER_notification_context_create (server, 1);
829 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
835 * The main function for the GNS service.
837 * @param argc number of arguments from the command line
838 * @param argv command line arguments
839 * @return 0 ok, 1 on error
842 main (int argc, char *const *argv)
848 GNUNET_SERVICE_run (argc, argv, "gns", GNUNET_SERVICE_OPTION_NONE, &run,
853 /* end of gnunet-service-gns.c */