2 This file is part of GNUnet.
3 (C) 2011-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.
21 * @file gns/gnunet-service-gns.c
22 * @brief GNUnet GNS service
23 * @author Martin Schanzenbach
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_transport_service.h"
29 #include "gnunet_dns_service.h"
30 #include "gnunet_dnsparser_lib.h"
31 #include "gnunet_dht_service.h"
32 #include "gnunet_namestore_service.h"
33 #include "gnunet_gns_service.h"
34 #include "gnunet_statistics_service.h"
36 #include "gns_common.h"
37 #include "gnunet-service-gns_resolver.h"
38 #include "gnunet-service-gns_interceptor.h"
39 #include "gnunet_protocols.h"
42 * The initial interval in milliseconds btween puts in
45 #define INITIAL_PUT_INTERVAL GNUNET_TIME_UNIT_MILLISECONDS
48 * The upper bound for the zone iteration interval in milliseconds
50 #define MINIMUM_ZONE_ITERATION_INTERVAL GNUNET_TIME_UNIT_SECONDS
53 * The default put interval for the zone iteration. In case
56 #define DEFAULT_ZONE_PUBLISH_TIME_WINDOW GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 4)
59 * The factor the current zone iteration interval is divided by for each
60 * additional new record
62 #define LATE_ITERATION_SPEEDUP_FACTOR 2
65 * How long until a DHT PUT attempt should time out?
67 #define DHT_OPERATION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
70 * What replication level do we use for DHT PUT operations?
72 #define DHT_GNS_REPLICATION_LEVEL 5
76 * Handle to a lookup operation from api
78 struct ClientLookupHandle
82 * We keep these in a DLL.
84 struct ClientLookupHandle *next;
87 * We keep these in a DLL.
89 struct ClientLookupHandle *prev;
92 * Handle to the requesting client
94 struct GNUNET_SERVER_Client *client;
97 * Active handle for the lookup.
99 struct GNS_ResolverHandle *lookup;
110 * Our handle to the DHT
112 static struct GNUNET_DHT_Handle *dht_handle;
115 * Active DHT put operation (or NULL)
117 static struct GNUNET_DHT_PutHandle *active_put;
120 * Our handle to the namestore service
122 static struct GNUNET_NAMESTORE_Handle *namestore_handle;
125 * Handle to iterate over our authoritative zone in namestore
127 static struct GNUNET_NAMESTORE_ZoneIterator *namestore_iter;
130 * Our notification context.
132 static struct GNUNET_SERVER_NotificationContext *nc;
137 static struct ClientLookupHandle *clh_head;
142 static struct ClientLookupHandle *clh_tail;
145 * Useful for zone update for DHT put
147 static unsigned long long num_public_records;
150 * Last seen record count
152 static unsigned long long last_num_public_records;
155 * Zone iteration PUT interval.
157 static struct GNUNET_TIME_Relative put_interval;
160 * Time window for zone iteration
162 static struct GNUNET_TIME_Relative zone_publish_time_window;
167 static GNUNET_SCHEDULER_TaskIdentifier zone_publish_task;
170 * #GNUNET_YES if zone has never been published before
172 static int first_zone_iteration;
177 static struct GNUNET_TIME_Relative default_lookup_timeout;
180 * #GNUNET_YES if ipv6 is supported
182 static int v6_enabled;
185 * #GNUNET_YES if ipv4 is supported
187 static int v4_enabled;
190 * Handle to the statistics service
192 static struct GNUNET_STATISTICS_Handle *statistics;
196 * Task run during shutdown.
202 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
204 struct ClientLookupHandle *clh;
206 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
208 GNUNET_SERVER_notification_context_destroy (nc);
209 while (NULL != (clh = clh_head))
211 GNS_resolver_lookup_cancel (clh->lookup);
212 GNUNET_CONTAINER_DLL_remove (clh_head, clh_tail, clh);
216 GNS_interceptor_done ();
217 GNS_resolver_done ();
218 if (NULL != statistics)
220 GNUNET_STATISTICS_destroy (statistics, GNUNET_NO);
223 if (GNUNET_SCHEDULER_NO_TASK != zone_publish_task)
225 GNUNET_SCHEDULER_cancel (zone_publish_task);
226 zone_publish_task = GNUNET_SCHEDULER_NO_TASK;
228 if (NULL != namestore_iter)
230 GNUNET_NAMESTORE_zone_iteration_stop (namestore_iter);
231 namestore_iter = NULL;
233 if (NULL != namestore_handle)
235 GNUNET_NAMESTORE_disconnect (namestore_handle);
236 namestore_handle = NULL;
238 if (NULL != active_put)
240 GNUNET_DHT_put_cancel (active_put);
243 if (NULL != dht_handle)
245 GNUNET_DHT_disconnect (dht_handle);
252 * Method called periodically that triggers iteration over authoritative records
255 * @param tc task context
258 publish_zone_dht_next (void *cls,
259 const struct GNUNET_SCHEDULER_TaskContext *tc)
261 zone_publish_task = GNUNET_SCHEDULER_NO_TASK;
262 GNUNET_NAMESTORE_zone_iterator_next (namestore_iter);
267 * Periodically iterate over our zone and store everything in dht
270 * @param tc task context
273 publish_zone_dht_start (void *cls,
274 const struct GNUNET_SCHEDULER_TaskContext *tc);
278 * Continuation called from DHT once the PUT operation is done.
280 * @param cls closure, NULL
281 * @param success #GNUNET_OK on success
284 dht_put_continuation (void *cls,
287 struct GNUNET_TIME_Relative next_put_interval;
289 num_public_records++;
290 if ( (num_public_records > last_num_public_records) &&
291 (GNUNET_NO == first_zone_iteration) )
293 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
294 "Last record count was lower than current record count. Reducing interval.\n");
295 put_interval = GNUNET_TIME_relative_divide (zone_publish_time_window,
297 next_put_interval = GNUNET_TIME_relative_divide (put_interval,
298 LATE_ITERATION_SPEEDUP_FACTOR);
301 next_put_interval = put_interval;
303 GNUNET_STATISTICS_set (statistics,
304 "Current zone iteration interval (ms)",
305 next_put_interval.rel_value_us / 1000LL,
307 zone_publish_task = GNUNET_SCHEDULER_add_delayed (next_put_interval,
308 &publish_zone_dht_next,
314 * Function used to put all records successively into the DHT.
316 * @param cls the closure (NULL)
317 * @param key the private key of the authority (ours)
318 * @param name the name of the records, NULL once the iteration is done
319 * @param rd_count the number of records in @a rd
320 * @param rd the record data
323 put_gns_record (void *cls,
324 const struct GNUNET_CRYPTO_EccPrivateKey *key,
326 unsigned int rd_count,
327 const struct GNUNET_NAMESTORE_RecordData *rd)
329 struct GNUNET_NAMESTORE_Block *block;
330 struct GNUNET_HashCode query;
331 struct GNUNET_TIME_Absolute expire;
333 struct GNUNET_NAMESTORE_RecordData rd_public[rd_count];
334 unsigned int rd_public_count;
339 /* we're done with one iteration, calculate when to do the next one */
340 namestore_iter = NULL;
341 last_num_public_records = num_public_records;
342 first_zone_iteration = GNUNET_NO;
343 if (0 == num_public_records)
346 * If no records are known (startup) or none present
347 * we can safely set the interval to the value for a single
350 put_interval = zone_publish_time_window;
351 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
352 "No records in namestore database.\n");
356 put_interval = GNUNET_TIME_relative_divide (zone_publish_time_window,
359 put_interval = GNUNET_TIME_relative_max (MINIMUM_ZONE_ITERATION_INTERVAL,
362 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
363 "Zone iteration finished. Adjusted zone iteration interval to %s\n",
364 GNUNET_STRINGS_relative_time_to_string (put_interval, GNUNET_YES));
365 GNUNET_STATISTICS_set (statistics,
366 "Current zone iteration interval (in ms)",
367 put_interval.rel_value_us / 1000LL,
369 GNUNET_STATISTICS_update (statistics,
370 "Number of zone iterations",
373 GNUNET_STATISTICS_set (statistics,
374 "Number of public records in DHT",
375 last_num_public_records,
377 if (0 == num_public_records)
378 zone_publish_task = GNUNET_SCHEDULER_add_delayed (put_interval,
379 &publish_zone_dht_start,
382 zone_publish_task = GNUNET_SCHEDULER_add_now (&publish_zone_dht_start,
387 /* filter out records that are not public! */
389 for (i=0;i<rd_count;i++)
390 if (0 == (rd[i].flags & (GNUNET_NAMESTORE_RF_PRIVATE |
391 GNUNET_NAMESTORE_RF_PENDING)))
392 rd_public[rd_public_count++] = rd[i];
395 /* We got a set of records to publish */
396 if (0 == rd_public_count)
398 zone_publish_task = GNUNET_SCHEDULER_add_now (&publish_zone_dht_next,
402 expire = GNUNET_NAMESTORE_record_get_expiration_time (rd_public_count,
404 block = GNUNET_NAMESTORE_block_create (key,
409 block_size = ntohl (block->purpose.size)
410 + sizeof (struct GNUNET_CRYPTO_EccSignature)
411 + sizeof (struct GNUNET_CRYPTO_EccPublicKey);
412 GNUNET_NAMESTORE_query_from_private_key (key,
416 active_put = GNUNET_DHT_put (dht_handle, &query,
417 DHT_GNS_REPLICATION_LEVEL,
418 GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
419 GNUNET_BLOCK_TYPE_GNS_NAMERECORD,
423 DHT_OPERATION_TIMEOUT,
424 &dht_put_continuation,
426 if (NULL == active_put)
429 dht_put_continuation (NULL, GNUNET_NO);
436 * Periodically iterate over our zone and store everything in dht
439 * @param tc task context
442 publish_zone_dht_start (void *cls,
443 const struct GNUNET_SCHEDULER_TaskContext *tc)
445 zone_publish_task = GNUNET_SCHEDULER_NO_TASK;
447 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
448 "Scheduling DHT zone update!\n");
449 /* start counting again */
450 num_public_records = 0;
451 namestore_iter = GNUNET_NAMESTORE_zone_iteration_start (namestore_handle,
452 NULL, /* All zones */
458 /* END DHT ZONE PROPAGATION */
462 * Reply to client with the result from our lookup.
464 * @param cls the closure (our client lookup handle)
465 * @param rd_count the number of records
466 * @param rd the record data
469 send_lookup_response (void* cls,
471 const struct GNUNET_NAMESTORE_RecordData *rd)
473 struct ClientLookupHandle *clh = cls;
474 struct GNUNET_GNS_ClientLookupResultMessage *rmsg;
477 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
478 "Sending `%s' message with %d results\n",
482 len = GNUNET_NAMESTORE_records_get_size (rd_count, rd);
483 rmsg = GNUNET_malloc (len + sizeof (struct GNUNET_GNS_ClientLookupResultMessage));
484 rmsg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT);
485 rmsg->header.size = htons (len + sizeof(struct GNUNET_GNS_ClientLookupResultMessage));
486 rmsg->id = clh->request_id;
487 rmsg->rd_count = htonl (rd_count);
488 GNUNET_NAMESTORE_records_serialize (rd_count, rd, len,
490 GNUNET_SERVER_notification_context_unicast (nc,
495 GNUNET_SERVER_receive_done (clh->client,
497 GNUNET_CONTAINER_DLL_remove (clh_head, clh_tail, clh);
499 GNUNET_STATISTICS_update (statistics,
500 "Completed lookups", 1,
502 GNUNET_STATISTICS_update (statistics,
510 * Handle lookup requests from client
512 * @param cls the closure
513 * @param client the client
514 * @param message the message
517 handle_lookup (void *cls,
518 struct GNUNET_SERVER_Client *client,
519 const struct GNUNET_MessageHeader *message)
521 char name[GNUNET_DNSPARSER_MAX_NAME_LENGTH + 1];
522 struct ClientLookupHandle *clh;
523 char *nameptr = name;
525 const struct GNUNET_CRYPTO_EccPrivateKey *key;
527 const struct GNUNET_GNS_ClientLookupMessage *sh_msg;
529 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
530 "Received `%s' message\n",
532 msg_size = ntohs (message->size);
533 if (msg_size < sizeof (struct GNUNET_GNS_ClientLookupMessage))
536 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
539 sh_msg = (const struct GNUNET_GNS_ClientLookupMessage *) message;
540 GNUNET_SERVER_notification_context_add (nc, client);
541 if (GNUNET_YES == ntohl (sh_msg->have_key))
542 key = &sh_msg->shorten_key;
545 utf_in = (const char *) &sh_msg[1];
546 if ( ('\0' != utf_in[msg_size - sizeof (struct GNUNET_GNS_ClientLookupMessage) - 1]) ||
547 (strlen (utf_in) > GNUNET_DNSPARSER_MAX_NAME_LENGTH) )
550 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
553 GNUNET_STRINGS_utf8_tolower (utf_in, &nameptr);
555 clh = GNUNET_new (struct ClientLookupHandle);
556 GNUNET_SERVER_client_set_user_context (client, clh);
557 GNUNET_CONTAINER_DLL_insert (clh_head, clh_tail, clh);
558 clh->client = client;
559 clh->request_id = sh_msg->id;
560 if ( (GNUNET_DNSPARSER_TYPE_A == ntohl (sh_msg->type)) &&
561 (GNUNET_OK != v4_enabled) )
563 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
564 "LOOKUP: Query for A record but AF_INET not supported!");
565 send_lookup_response (clh, 0, NULL);
568 if ( (GNUNET_DNSPARSER_TYPE_AAAA == ntohl (sh_msg->type)) &&
569 (GNUNET_OK != v6_enabled) )
571 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
572 "LOOKUP: Query for AAAA record but AF_INET6 not supported!");
573 send_lookup_response (clh, 0, NULL);
576 clh->lookup = GNS_resolver_lookup (&sh_msg->zone,
577 ntohl (sh_msg->type),
580 ntohl (sh_msg->only_cached),
581 &send_lookup_response, clh);
582 GNUNET_STATISTICS_update (statistics,
589 * One of our clients disconnected, clean up after it.
592 * @param client the client that disconnected
595 notify_client_disconnect (void *cls,
596 struct GNUNET_SERVER_Client *client)
598 struct ClientLookupHandle *clh;
602 clh = GNUNET_SERVER_client_get_user_context (client, struct ClientLookupHandle);
605 GNS_resolver_lookup_cancel (clh->lookup);
606 GNUNET_CONTAINER_DLL_remove (clh_head, clh_tail, clh);
612 * Process GNS requests.
615 * @param server the initialized server
616 * @param c configuration to use
619 run (void *cls, struct GNUNET_SERVER_Handle *server,
620 const struct GNUNET_CONFIGURATION_Handle *c)
622 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
623 { &handle_lookup, NULL, GNUNET_MESSAGE_TYPE_GNS_LOOKUP, 0},
626 struct GNUNET_CRYPTO_EccPublicKey dns_root;
627 unsigned long long max_parallel_bg_queries = 0;
630 v6_enabled = GNUNET_NETWORK_test_pf (PF_INET6);
631 v4_enabled = GNUNET_NETWORK_test_pf (PF_INET);
633 namestore_handle = GNUNET_NAMESTORE_connect (c);
634 if (NULL == namestore_handle)
636 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
637 _("Failed to connect to the namestore!\n"));
638 GNUNET_SCHEDULER_shutdown ();
642 put_interval = INITIAL_PUT_INTERVAL;
643 zone_publish_time_window = DEFAULT_ZONE_PUBLISH_TIME_WINDOW;
646 GNUNET_CONFIGURATION_get_value_time (c, "gns",
647 "ZONE_PUBLISH_TIME_WINDOW",
648 &zone_publish_time_window))
650 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
651 "Time window for zone iteration: %s\n",
652 GNUNET_STRINGS_relative_time_to_string (zone_publish_time_window, GNUNET_YES));
655 GNUNET_CONFIGURATION_get_value_number (c, "gns",
656 "MAX_PARALLEL_BACKGROUND_QUERIES",
657 &max_parallel_bg_queries))
659 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
660 "Number of allowed parallel background queries: %llu\n",
661 max_parallel_bg_queries);
665 GNUNET_CONFIGURATION_get_value_time (c, "gns",
666 "DEFAULT_LOOKUP_TIMEOUT",
667 &default_lookup_timeout))
669 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
670 "Default lookup timeout: %s\n",
671 GNUNET_STRINGS_relative_time_to_string (default_lookup_timeout,
675 dht_handle = GNUNET_DHT_connect (c,
676 (unsigned int) max_parallel_bg_queries);
677 if (NULL == dht_handle)
679 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
680 _("Could not connect to DHT!\n"));
681 GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
686 GNUNET_CONFIGURATION_get_value_string (c, "gns", "DNS_ROOT",
690 GNUNET_CRYPTO_ecc_public_key_from_string (dns_root_name,
691 strlen (dns_root_name),
694 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
696 _("valid public key required"));
697 GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
698 GNUNET_free (dns_root_name);
701 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
702 "DNS hijacking with root `%s' enabled. Connecting to DNS service.\n",
704 GNUNET_free (dns_root_name);
706 GNS_interceptor_init (&dns_root, c))
708 GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
712 /* FIXME: install client disconnect handle to clean up pending
713 lookups on client disconnect! */
714 GNS_resolver_init (namestore_handle, dht_handle,
716 max_parallel_bg_queries);
717 GNUNET_SERVER_disconnect_notify (server,
718 ¬ify_client_disconnect,
720 /* Schedule periodic put for our records. */
721 first_zone_iteration = GNUNET_YES;
722 GNUNET_SERVER_add_handlers (server, handlers);
723 statistics = GNUNET_STATISTICS_create ("gns", c);
724 nc = GNUNET_SERVER_notification_context_create (server, 1);
725 zone_publish_task = GNUNET_SCHEDULER_add_now (&publish_zone_dht_start,
727 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
728 &shutdown_task, NULL);
733 * The main function for the GNS service.
735 * @param argc number of arguments from the command line
736 * @param argv command line arguments
737 * @return 0 ok, 1 on error
740 main (int argc, char *const *argv)
746 GNUNET_SERVICE_run (argc, argv, "gns", GNUNET_SERVICE_OPTION_NONE, &run,
751 /* end of gnunet-service-gns.c */