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 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;
240 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Zone iteration finished\n");
241 GNUNET_NAMESTORE_zone_iteration_stop (namestore_iter);
242 zone_update_taskid = GNUNET_SCHEDULER_add_now (&update_zone_dht_start,
247 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
248 "Putting records for %s into the DHT\n", name);
250 rd_payload_length = GNUNET_NAMESTORE_records_get_size (rd_count, rd);
252 nrb = GNUNET_malloc(rd_payload_length + strlen(name) + 1
253 + sizeof(struct GNSNameRecordBlock));
255 if (signature != NULL)
256 nrb->signature = *signature;
258 nrb->public_key = *key;
260 nrb->rd_count = htonl(rd_count);
262 memset(&nrb[1], 0, strlen(name) + 1);
263 memcpy(&nrb[1], name, strlen(name));
265 nrb_data = (char*)&nrb[1];
266 nrb_data += strlen(name) + 1;
268 rd_payload_length += sizeof(struct GNSNameRecordBlock) +
271 if (-1 == GNUNET_NAMESTORE_records_serialize (rd_count,
276 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Record serialization failed!\n");
284 * calculate DHT key: H(name) xor H(pubkey)
286 GNUNET_CRYPTO_hash(name, strlen(name), &name_hash);
287 GNUNET_CRYPTO_hash_xor(&zone_hash, &name_hash, &xor_hash);
288 GNUNET_CRYPTO_hash_to_enc (&xor_hash, &xor_hash_string);
289 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
290 "putting records for %s under key: %s with size %d\n",
291 name, (char*)&xor_hash_string, rd_payload_length);
293 GNUNET_DHT_put (dht_handle, &xor_hash,
294 DHT_GNS_REPLICATION_LEVEL,
296 GNUNET_BLOCK_TYPE_GNS_NAMERECORD,
300 DHT_OPERATION_TIMEOUT,
302 NULL); //cls for cont
304 num_public_records++;
307 * Reschedule periodic put
309 zone_update_taskid = GNUNET_SCHEDULER_add_delayed (dht_update_interval,
310 &update_zone_dht_next,
318 * Periodically iterate over our zone and store everything in dht
321 * @param tc task context
324 update_zone_dht_start(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
326 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Starting DHT zone update!\n");
327 if (0 == num_public_records)
329 dht_update_interval = GNUNET_TIME_relative_multiply(
330 GNUNET_TIME_UNIT_SECONDS,
335 dht_update_interval = GNUNET_TIME_relative_multiply(
336 GNUNET_TIME_UNIT_SECONDS,
337 (3600/num_public_records));
339 num_public_records = 0; //start counting again
340 namestore_iter = GNUNET_NAMESTORE_zone_iteration_start (namestore_handle,
342 GNUNET_NAMESTORE_RF_AUTHORITY,
343 GNUNET_NAMESTORE_RF_PRIVATE,
349 /* END DHT ZONE PROPAGATION */
352 * Send shorten response back to client
354 * @param name the shortened name result or NULL if cannot be shortened
355 * @param csh the handle to the shorten request
358 send_shorten_response(void* cls, const char* name)
360 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message with %s\n",
361 "SHORTEN_RESULT", name);
362 struct GNUNET_GNS_ClientShortenResultMessage *rmsg;
363 struct ClientShortenHandle *csh = (struct ClientShortenHandle *)cls;
370 rmsg = GNUNET_malloc(sizeof(struct GNUNET_GNS_ClientShortenResultMessage)
373 rmsg->id = csh->unique_id;
374 rmsg->header.type = htons(GNUNET_MESSAGE_TYPE_GNS_SHORTEN_RESULT);
376 htons(sizeof(struct GNUNET_GNS_ClientShortenResultMessage) +
379 strcpy((char*)&rmsg[1], name);
381 GNUNET_SERVER_notification_context_unicast (nc, csh->client,
382 (const struct GNUNET_MessageHeader *) rmsg,
384 GNUNET_SERVER_receive_done (csh->client, GNUNET_OK);
387 GNUNET_free(csh->name);
393 * Handle a shorten message from the api
395 * @param cls the closure
396 * @param client the client
397 * @param message the message
399 static void handle_shorten(void *cls,
400 struct GNUNET_SERVER_Client * client,
401 const struct GNUNET_MessageHeader * message)
403 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "SHORTEN");
406 struct ClientShortenHandle *csh;
409 if (ntohs (message->size) < sizeof (struct GNUNET_GNS_ClientShortenMessage))
412 GNUNET_SERVER_receive_done (client, GNUNET_OK);
416 GNUNET_SERVER_notification_context_add (nc, client);
418 struct GNUNET_GNS_ClientShortenMessage *sh_msg =
419 (struct GNUNET_GNS_ClientShortenMessage *) message;
421 msg_size = ntohs(message->size);
423 if (msg_size > GNUNET_SERVER_MAX_MESSAGE_SIZE)
426 GNUNET_SERVER_receive_done (client, GNUNET_OK);
430 csh = GNUNET_malloc(sizeof(struct ClientShortenHandle));
431 csh->client = client;
432 csh->unique_id = sh_msg->id;
434 name = (char*)&sh_msg[1];
435 csh->name = GNUNET_malloc(strlen(name)
436 - strlen(GNUNET_GNS_TLD) + 1);
438 strlen(name)-strlen(GNUNET_GNS_TLD) + 1);
439 memcpy(csh->name, name,
440 strlen(name)-strlen(GNUNET_GNS_TLD));
442 /* Start shortening */
443 gns_resolver_shorten_name(zone_hash, name, &send_shorten_response, csh);
448 * Send get authority response back to client
450 * @param name the shortened name result or NULL if cannot be shortened
451 * @param cah the handle to the get authority request
454 send_get_auth_response(void *cls, const char* name)
456 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message with %s\n",
457 "GET_AUTH_RESULT", name);
458 struct GNUNET_GNS_ClientGetAuthResultMessage *rmsg;
459 struct ClientGetAuthHandle *cah = (struct ClientGetAuthHandle *)cls;
466 rmsg = GNUNET_malloc(sizeof(struct GNUNET_GNS_ClientGetAuthResultMessage)
469 rmsg->id = cah->unique_id;
470 rmsg->header.type = htons(GNUNET_MESSAGE_TYPE_GNS_GET_AUTH_RESULT);
472 htons(sizeof(struct GNUNET_GNS_ClientGetAuthResultMessage) +
475 strcpy((char*)&rmsg[1], name);
477 GNUNET_SERVER_notification_context_unicast (nc, cah->client,
478 (const struct GNUNET_MessageHeader *) rmsg,
480 GNUNET_SERVER_receive_done (cah->client, GNUNET_OK);
482 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Cleaning up handles...\n");
485 GNUNET_free(cah->name);
488 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "done.\n");
494 * Handle a get authority message from the api
496 * @param cls the closure
497 * @param client the client
498 * @param message the message
500 static void handle_get_authority(void *cls,
501 struct GNUNET_SERVER_Client * client,
502 const struct GNUNET_MessageHeader * message)
504 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "GET_AUTH");
507 struct ClientGetAuthHandle *cah;
510 if (ntohs (message->size) < sizeof (struct GNUNET_GNS_ClientGetAuthMessage))
513 GNUNET_SERVER_receive_done (client, GNUNET_OK);
517 GNUNET_SERVER_notification_context_add (nc, client);
519 struct GNUNET_GNS_ClientGetAuthMessage *sh_msg =
520 (struct GNUNET_GNS_ClientGetAuthMessage *) message;
522 msg_size = ntohs(message->size);
524 if (msg_size > GNUNET_SERVER_MAX_MESSAGE_SIZE)
527 GNUNET_SERVER_receive_done (client, GNUNET_OK);
531 cah = GNUNET_malloc(sizeof(struct ClientGetAuthHandle));
532 cah->client = client;
533 cah->unique_id = sh_msg->id;
535 name = (char*)&sh_msg[1];
536 cah->name = GNUNET_malloc(strlen(name)
537 - strlen(GNUNET_GNS_TLD) + 1);
539 strlen(name)-strlen(GNUNET_GNS_TLD) + 1);
540 memcpy(cah->name, name,
541 strlen(name)-strlen(GNUNET_GNS_TLD));
543 /* Start delegation resolution in our namestore */
544 gns_resolver_get_authority(zone_hash, name, &send_get_auth_response, cah);
549 * Reply to client with the result from our lookup.
551 * @param cls the closure (our client lookup handle)
552 * @param rh the request handle of the lookup
553 * @param rd_count the number of records
554 * @param rd the record data
557 send_lookup_response(void* cls,
559 const struct GNUNET_NAMESTORE_RecordData *rd)
561 struct ClientLookupHandle* clh = (struct ClientLookupHandle*)cls;
562 struct GNUNET_GNS_ClientLookupResultMessage *rmsg;
565 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending `%s' message with %d results\n",
566 "LOOKUP_RESULT", rd_count);
568 len = GNUNET_NAMESTORE_records_get_size (rd_count, rd);
569 rmsg = GNUNET_malloc(len+sizeof(struct GNUNET_GNS_ClientLookupResultMessage));
571 rmsg->id = clh->unique_id;
572 rmsg->rd_count = htonl(rd_count);
573 rmsg->header.type = htons(GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT);
575 htons(len+sizeof(struct GNUNET_GNS_ClientLookupResultMessage));
577 GNUNET_NAMESTORE_records_serialize (rd_count, rd, len, (char*)&rmsg[1]);
579 GNUNET_SERVER_notification_context_unicast (nc, clh->client,
580 (const struct GNUNET_MessageHeader *) rmsg,
582 GNUNET_SERVER_receive_done (clh->client, GNUNET_OK);
585 GNUNET_free(clh->name);
592 * Handle lookup requests from client
594 * @param cls the closure
595 * @param client the client
596 * @param message the message
599 handle_lookup(void *cls,
600 struct GNUNET_SERVER_Client * client,
601 const struct GNUNET_MessageHeader * message)
603 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "LOOKUP");
606 struct ClientLookupHandle *clh;
608 if (ntohs (message->size) < sizeof (struct GNUNET_GNS_ClientLookupMessage))
611 GNUNET_SERVER_receive_done (client, GNUNET_OK);
615 GNUNET_SERVER_notification_context_add (nc, client);
617 struct GNUNET_GNS_ClientLookupMessage *sh_msg =
618 (struct GNUNET_GNS_ClientLookupMessage *) message;
620 msg_size = ntohs(message->size);
622 if (msg_size > GNUNET_SERVER_MAX_MESSAGE_SIZE)
625 GNUNET_SERVER_receive_done (client, GNUNET_OK);
629 clh = GNUNET_malloc(sizeof(struct ClientLookupHandle));
630 clh->client = client;
631 clh->name = GNUNET_malloc(strlen((char*)&sh_msg[1]) + 1);
632 strcpy(clh->name, (char*)&sh_msg[1]);
633 clh->unique_id = sh_msg->id;
634 clh->type = ntohl(sh_msg->type);
636 gns_resolver_lookup_record(zone_hash, clh->type, (char*)&sh_msg[1],
637 &send_lookup_response, clh);
643 * Process GNS requests.
645 * @param cls closure)
646 * @param server the initialized server
647 * @param c configuration to use
650 run (void *cls, struct GNUNET_SERVER_Handle *server,
651 const struct GNUNET_CONFIGURATION_Handle *c)
654 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Initializing GNS\n");
657 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pkey;
659 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
660 {&handle_shorten, NULL, GNUNET_MESSAGE_TYPE_GNS_SHORTEN, 0},
661 {&handle_lookup, NULL, GNUNET_MESSAGE_TYPE_GNS_LOOKUP, 0},
662 {&handle_get_authority, NULL, GNUNET_MESSAGE_TYPE_GNS_GET_AUTH, 0}
665 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c, "gns",
666 "ZONEKEY", &keyfile))
668 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
669 "No private key for root zone specified!\n");
670 GNUNET_SCHEDULER_shutdown(0);
674 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
675 "Using keyfile %s for root zone.\n", keyfile);
677 zone_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
678 GNUNET_CRYPTO_rsa_key_get_public (zone_key, &pkey);
680 GNUNET_CRYPTO_hash(&pkey, sizeof(struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
682 GNUNET_free(keyfile);
686 GNUNET_CONFIGURATION_get_value_yesno (c, "gns",
689 GNUNET_log(GNUNET_ERROR_TYPE_INFO,
690 "DNS hijacking enabled... connecting to service.\n");
692 if (gns_interceptor_init(zone_hash, c) == GNUNET_SYSERR)
694 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
695 "Failed to enable the dns interceptor!\n");
702 * handle to our local namestore
704 namestore_handle = GNUNET_NAMESTORE_connect(c);
706 if (NULL == namestore_handle)
708 //FIXME do error handling;
709 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
710 "Failed to connect to the namestore!\n");
711 GNUNET_SCHEDULER_shutdown(0);
718 dht_handle = GNUNET_DHT_connect(c, 1); //FIXME get ht_len from cfg
720 if (NULL == dht_handle)
722 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Could not connect to DHT!\n");
725 //put_some_records(); //FIXME for testing
728 * Schedule periodic put
730 * We have roughly an hour for all records;
732 dht_update_interval = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
734 //zone_update_taskid = GNUNET_SCHEDULER_add_now (&update_zone_dht_start, NULL);
736 GNUNET_SERVER_add_handlers (server, handlers);
739 //GNUNET_SERVER_disconnect_notify (server,
740 // &client_disconnect_notification,
743 nc = GNUNET_SERVER_notification_context_create (server, 1);
745 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
751 * The main function for the GNS service.
753 * @param argc number of arguments from the command line
754 * @param argv command line arguments
755 * @return 0 ok, 1 on error
758 main (int argc, char *const *argv)
764 GNUNET_SERVICE_run (argc, argv, "gns", GNUNET_SERVICE_OPTION_NONE, &run,
769 /* end of gnunet-service-gns.c */