2 This file is part of GNUnet.
3 (C) 2008, 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 hostlist/hostlist-server.c
23 * @author Christian Grothoff, Matthias Wachs
24 * @brief application to provide an integrated hostlist HTTP server
28 #include <microhttpd.h>
29 #include "hostlist-server.h"
30 #include "gnunet_hello_lib.h"
31 #include "gnunet_peerinfo_service.h"
32 #include "gnunet-daemon-hostlist.h"
33 #include "gnunet_resolver_service.h"
37 * Handle to the HTTP server as provided by libmicrohttpd for IPv6.
39 static struct MHD_Daemon *daemon_handle_v6;
42 * Handle to the HTTP server as provided by libmicrohttpd for IPv4.
44 static struct MHD_Daemon *daemon_handle_v4;
49 static const struct GNUNET_CONFIGURATION_Handle *cfg;
52 * For keeping statistics.
54 static struct GNUNET_STATISTICS_Handle *stats;
57 * Handle to the core service (NULL until we've connected to it).
59 static struct GNUNET_CORE_Handle *core;
62 * Handle to the peerinfo notify service (NULL until we've connected to it).
64 static struct GNUNET_PEERINFO_NotifyContext *notify;
67 * Our primary task for IPv4.
69 static GNUNET_SCHEDULER_TaskIdentifier hostlist_task_v4;
72 * Our primary task for IPv6.
74 static GNUNET_SCHEDULER_TaskIdentifier hostlist_task_v6;
77 * Our canonical response.
79 static struct MHD_Response *response;
82 * NULL if we are not currenlty iterating over peer information.
84 static struct GNUNET_PEERINFO_IteratorContext *pitr;
87 * Handle for accessing peerinfo service.
89 static struct GNUNET_PEERINFO_Handle *peerinfo;
92 * Context for host processor.
102 * Set if we are allowed to advertise our hostlist to others.
104 static int advertising;
107 * Buffer for the hostlist address
109 static char *hostlist_uri;
113 * Function that assembles our response.
116 finish_response (struct HostSet *results)
118 if (response != NULL)
119 MHD_destroy_response (response);
120 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
121 "Creating hostlist response with %u bytes\n",
122 (unsigned int) results->size);
124 MHD_create_response_from_data (results->size, results->data, MHD_YES,
126 if ((daemon_handle_v4 == NULL) && (daemon_handle_v6 == NULL))
128 MHD_destroy_response (response);
131 GNUNET_STATISTICS_set (stats, gettext_noop ("bytes in hostlist"),
132 results->size, GNUNET_YES);
133 GNUNET_free (results);
138 * Set 'cls' to GNUNET_YES (we have an address!).
140 * @param cls closure, an 'int*'
141 * @param address the address (ignored)
142 * @param expiration expiration time (call is ignored if this is in the past)
143 * @return GNUNET_SYSERR to stop iterating (unless expiration has occured)
146 check_has_addr (void *cls, const struct GNUNET_HELLO_Address *address,
147 struct GNUNET_TIME_Absolute expiration)
151 if (GNUNET_TIME_absolute_get_remaining (expiration).rel_value == 0)
153 GNUNET_STATISTICS_update (stats,
154 gettext_noop ("expired addresses encountered"), 1,
156 return GNUNET_YES; /* ignore this address */
159 return GNUNET_SYSERR;
164 * Callback that processes each of the known HELLOs for the
165 * hostlist response construction.
168 host_processor (void *cls, const struct GNUNET_PeerIdentity *peer,
169 const struct GNUNET_HELLO_Message *hello, const char *err_msg)
171 struct HostSet *results = cls;
178 GNUNET_assert (NULL == peer);
180 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
181 _("Error in communication with PEERINFO service: %s\n"),
188 finish_response (results);
193 has_addr = GNUNET_NO;
194 GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO, &check_has_addr, &has_addr);
195 if (GNUNET_NO == has_addr)
197 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
198 "HELLO for peer `%4s' has no address, not suitable for hostlist!\n",
200 GNUNET_STATISTICS_update (stats,
202 ("HELLOs without addresses encountered (ignored)"),
207 s = GNUNET_HELLO_size (hello);
208 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
209 "Received %u bytes of `%s' from peer `%s' for hostlist.\n",
210 (unsigned int) s, "HELLO", GNUNET_i2s (peer));
211 if ((old + s >= GNUNET_MAX_MALLOC_CHECKED) ||
212 (old + s >= MAX_BYTES_PER_HOSTLISTS))
214 GNUNET_STATISTICS_update (stats,
216 ("bytes not included in hostlist (size limit)"),
218 return; /* too large, skip! */
220 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
221 "Adding peer `%s' to hostlist (%u bytes)\n", GNUNET_i2s (peer),
223 GNUNET_array_grow (results->data, results->size, old + s);
224 memcpy (&results->data[old], hello, s);
230 * Hostlist access policy (very permissive, allows everything).
233 accept_policy_callback (void *cls, const struct sockaddr *addr,
236 if (NULL == response)
238 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
239 "Received request for hostlist, but I am not yet ready; rejecting!\n");
242 return MHD_YES; /* accept all */
247 * Main request handler.
250 access_handler_callback (void *cls, struct MHD_Connection *connection,
251 const char *url, const char *method,
252 const char *version, const char *upload_data,
253 size_t * upload_data_size, void **con_cls)
257 if (0 != strcmp (method, MHD_HTTP_METHOD_GET))
259 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
260 _("Refusing `%s' request to hostlist server\n"), method);
261 GNUNET_STATISTICS_update (stats,
263 ("hostlist requests refused (not HTTP GET)"), 1,
267 if (NULL == *con_cls)
270 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, _("Sending 100 CONTINUE reply\n"));
271 return MHD_YES; /* send 100 continue */
273 if (*upload_data_size != 0)
275 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
276 _("Refusing `%s' request with %llu bytes of upload data\n"),
277 method, (unsigned long long) *upload_data_size);
278 GNUNET_STATISTICS_update (stats,
280 ("hostlist requests refused (upload data)"), 1,
282 return MHD_NO; /* do not support upload data */
284 if (response == NULL)
286 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
288 ("Could not handle hostlist request since I do not have a response yet\n"));
289 GNUNET_STATISTICS_update (stats,
291 ("hostlist requests refused (not ready)"), 1,
293 return MHD_NO; /* internal error, no response yet */
295 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Received request for our hostlist\n"));
296 GNUNET_STATISTICS_update (stats, gettext_noop ("hostlist requests processed"),
298 return MHD_queue_response (connection, MHD_HTTP_OK, response);
303 * Handler called by core when core is ready to transmit message
305 * @param size size of buffer to copy message to
306 * @param buf buffer to copy message to
309 adv_transmit_ready (void *cls, size_t size, void *buf)
311 static uint64_t hostlist_adv_count;
313 size_t transmission_size;
314 size_t uri_size; /* Including \0 termination! */
315 struct GNUNET_MessageHeader header;
320 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
321 "Transmission failed, buffer invalid!\n");
324 uri_size = strlen (hostlist_uri) + 1;
325 transmission_size = sizeof (struct GNUNET_MessageHeader) + uri_size;
326 header.type = htons (GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT);
327 header.size = htons (transmission_size);
328 GNUNET_assert (size >= transmission_size);
329 memcpy (buf, &header, sizeof (struct GNUNET_MessageHeader));
331 memcpy (&cbuf[sizeof (struct GNUNET_MessageHeader)], hostlist_uri, uri_size);
332 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
333 "Sent advertisement message: Copied %u bytes into buffer!\n",
334 (unsigned int) transmission_size);
335 hostlist_adv_count++;
336 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " # Sent advertisement message: %u\n",
338 GNUNET_STATISTICS_update (stats,
339 gettext_noop ("# hostlist advertisements send"), 1,
341 return transmission_size;
346 * Method called whenever a given peer connects.
349 * @param peer peer identity this notification is about
350 * @param atsi performance data
351 * @param atsi_count number of records in 'atsi'
354 connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer,
355 const struct GNUNET_ATS_Information *atsi,
356 unsigned int atsi_count)
362 if (hostlist_uri == NULL)
364 size = strlen (hostlist_uri) + 1;
365 if (size + sizeof (struct GNUNET_MessageHeader) >=
366 GNUNET_SERVER_MAX_MESSAGE_SIZE)
371 size += sizeof (struct GNUNET_MessageHeader);
377 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
378 "Asked core to transmit advertisement message with a size of %u bytes to peer `%s'\n",
379 size, GNUNET_i2s (peer));
381 GNUNET_CORE_notify_transmit_ready (core, GNUNET_YES, 0,
382 GNUNET_ADV_TIMEOUT, peer, size,
383 &adv_transmit_ready, NULL))
385 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
386 _("Advertisement message could not be queued by core\n"));
392 * Method called whenever a given peer disconnects.
395 * @param peer peer identity this notification is about
398 disconnect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
404 * PEERINFO calls this function to let us know about a possible peer
405 * that we might want to connect to.
407 * @param cls closure (not used)
408 * @param peer potential peer to connect to
409 * @param hello HELLO for this peer (or NULL)
410 * @param err_msg NULL if successful, otherwise contains error message
413 process_notify (void *cls, const struct GNUNET_PeerIdentity *peer,
414 const struct GNUNET_HELLO_Message *hello, const char *err_msg)
416 struct HostSet *results;
418 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
419 "Peerinfo is notifying us to rebuild our hostlist\n");
422 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
423 _("Error in communication with PEERINFO service\n"));
426 results = GNUNET_malloc (sizeof (struct HostSet));
427 GNUNET_assert (peerinfo != NULL);
429 GNUNET_PEERINFO_iterate (peerinfo, NULL, GNUNET_TIME_UNIT_MINUTES,
430 &host_processor, results);
434 * Function that queries MHD's select sets and
435 * starts the task waiting for them.
437 static GNUNET_SCHEDULER_TaskIdentifier
438 prepare_daemon (struct MHD_Daemon *daemon_handle);
442 * Call MHD to process pending requests and then go back
443 * and schedule the next run.
446 run_daemon (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
448 struct MHD_Daemon *daemon_handle = cls;
450 if (daemon_handle == daemon_handle_v4)
451 hostlist_task_v4 = GNUNET_SCHEDULER_NO_TASK;
453 hostlist_task_v6 = GNUNET_SCHEDULER_NO_TASK;
455 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
457 GNUNET_assert (MHD_YES == MHD_run (daemon_handle));
458 if (daemon_handle == daemon_handle_v4)
459 hostlist_task_v4 = prepare_daemon (daemon_handle);
461 hostlist_task_v6 = prepare_daemon (daemon_handle);
466 * Function that queries MHD's select sets and
467 * starts the task waiting for them.
469 static GNUNET_SCHEDULER_TaskIdentifier
470 prepare_daemon (struct MHD_Daemon *daemon_handle)
472 GNUNET_SCHEDULER_TaskIdentifier ret;
476 struct GNUNET_NETWORK_FDSet *wrs;
477 struct GNUNET_NETWORK_FDSet *wws;
478 struct GNUNET_NETWORK_FDSet *wes;
480 unsigned MHD_LONG_LONG timeout;
482 struct GNUNET_TIME_Relative tv;
487 wrs = GNUNET_NETWORK_fdset_create ();
488 wes = GNUNET_NETWORK_fdset_create ();
489 wws = GNUNET_NETWORK_fdset_create ();
491 GNUNET_assert (MHD_YES == MHD_get_fdset (daemon_handle, &rs, &ws, &es, &max));
492 haveto = MHD_get_timeout (daemon_handle, &timeout);
493 if (haveto == MHD_YES)
494 tv.rel_value = (uint64_t) timeout;
496 tv = GNUNET_TIME_UNIT_FOREVER_REL;
497 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
498 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
499 GNUNET_NETWORK_fdset_copy_native (wes, &es, max + 1);
501 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
503 &run_daemon, daemon_handle);
504 GNUNET_NETWORK_fdset_destroy (wrs);
505 GNUNET_NETWORK_fdset_destroy (wws);
506 GNUNET_NETWORK_fdset_destroy (wes);
512 * Start server offering our hostlist.
514 * @return GNUNET_OK on success
517 GNUNET_HOSTLIST_server_start (const struct GNUNET_CONFIGURATION_Handle *c,
518 struct GNUNET_STATISTICS_Handle *st,
519 struct GNUNET_CORE_Handle *co,
520 GNUNET_CORE_ConnectEventHandler *server_ch,
521 GNUNET_CORE_DisconnectEventHandler *server_dh,
524 unsigned long long port;
530 struct sockaddr_in v4;
531 struct sockaddr_in6 v6;
532 const struct sockaddr *sa;
534 advertising = advertise;
536 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
537 "Advertising not enabled on this hostlist server\n");
539 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
540 "Advertising enabled on this hostlist server\n");
543 peerinfo = GNUNET_PEERINFO_connect (cfg);
544 if (peerinfo == NULL)
546 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
547 _("Could not access PEERINFO service. Exiting.\n"));
548 return GNUNET_SYSERR;
551 GNUNET_CONFIGURATION_get_value_number (cfg, "HOSTLIST", "HTTPPORT",
553 return GNUNET_SYSERR;
554 if ((port == 0) || (port > UINT16_MAX))
556 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
557 _("Invalid port number %llu. Exiting.\n"), port);
558 return GNUNET_SYSERR;
562 GNUNET_CONFIGURATION_get_value_string (cfg, "HOSTLIST",
563 "EXTERNAL_DNS_NAME", &hostname))
564 hostname = GNUNET_RESOLVER_local_fqdn_get ();
566 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Hostlist service starts on %s:%llu\n"),
568 if (NULL != hostname)
570 size = strlen (hostname);
571 if (size + 15 > MAX_URL_LEN)
577 GNUNET_asprintf (&hostlist_uri, "http://%s:%u/", hostname,
578 (unsigned int) port);
579 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
580 _("Address to obtain hostlist: `%s'\n"), hostlist_uri);
582 GNUNET_free (hostname);
585 if (GNUNET_CONFIGURATION_have_value (cfg, "HOSTLIST", "BINDTOIP"))
587 GNUNET_break (GNUNET_OK ==
588 GNUNET_CONFIGURATION_get_value_string (cfg, "HOSTLIST",
595 if (1 == inet_pton (AF_INET, ip, &i4))
597 memset (&v4, 0, sizeof (v4));
598 v4.sin_family = AF_INET;
600 v4.sin_port = htons (port);
601 #if HAVE_SOCKADDR_IN_SIN_LEN
602 v4.sin_len = sizeof (v4);
604 sa = (const struct sockaddr *) &v4;
606 else if (1 == inet_pton (AF_INET6, ip, &i6))
608 memset (&v6, 0, sizeof (v6));
609 v6.sin6_family = AF_INET6;
611 v6.sin6_port = htons (port);
612 #if HAVE_SOCKADDR_IN_SIN_LEN
613 v6.sin6_len = sizeof (v6);
615 sa = (const struct sockaddr *) &v6;
619 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
620 _("`%s' is not a valid IP address! Ignoring BINDTOIP.\n"),
628 daemon_handle_v6 = MHD_start_daemon (MHD_USE_IPv6 | MHD_USE_DEBUG,
630 &accept_policy_callback, NULL,
631 &access_handler_callback, NULL,
632 MHD_OPTION_CONNECTION_LIMIT,
634 MHD_OPTION_PER_IP_CONNECTION_LIMIT,
636 MHD_OPTION_CONNECTION_TIMEOUT,
638 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
639 (size_t) (16 * 1024),
640 MHD_OPTION_SOCK_ADDR,
643 daemon_handle_v4 = MHD_start_daemon (MHD_NO_FLAG | MHD_USE_DEBUG,
645 &accept_policy_callback, NULL,
646 &access_handler_callback, NULL,
647 MHD_OPTION_CONNECTION_LIMIT,
649 MHD_OPTION_PER_IP_CONNECTION_LIMIT,
651 MHD_OPTION_CONNECTION_TIMEOUT,
653 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
654 (size_t) (16 * 1024),
655 MHD_OPTION_SOCK_ADDR,
659 if ((daemon_handle_v6 == NULL) && (daemon_handle_v4 == NULL))
661 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
662 _("Could not start hostlist HTTP server on port %u\n"),
663 (unsigned short) port);
664 return GNUNET_SYSERR;
668 *server_ch = &connect_handler;
669 *server_dh = &disconnect_handler;
670 if (daemon_handle_v4 != NULL)
671 hostlist_task_v4 = prepare_daemon (daemon_handle_v4);
672 if (daemon_handle_v6 != NULL)
673 hostlist_task_v6 = prepare_daemon (daemon_handle_v6);
675 notify = GNUNET_PEERINFO_notify (cfg, process_notify, NULL);
682 * Stop server offering our hostlist.
685 GNUNET_HOSTLIST_server_stop ()
687 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Hostlist server shutdown\n");
690 GNUNET_PEERINFO_notify_cancel (notify);
693 if (GNUNET_SCHEDULER_NO_TASK != hostlist_task_v6)
695 GNUNET_SCHEDULER_cancel (hostlist_task_v6);
696 hostlist_task_v6 = GNUNET_SCHEDULER_NO_TASK;
698 if (GNUNET_SCHEDULER_NO_TASK != hostlist_task_v4)
700 GNUNET_SCHEDULER_cancel (hostlist_task_v4);
701 hostlist_task_v4 = GNUNET_SCHEDULER_NO_TASK;
705 GNUNET_PEERINFO_iterate_cancel (pitr);
708 if (NULL != daemon_handle_v4)
710 MHD_stop_daemon (daemon_handle_v4);
711 daemon_handle_v4 = NULL;
713 if (NULL != daemon_handle_v6)
715 MHD_stop_daemon (daemon_handle_v6);
716 daemon_handle_v6 = NULL;
718 if (response != NULL)
720 MHD_destroy_response (response);
723 if (peerinfo != NULL)
725 GNUNET_PEERINFO_disconnect (peerinfo);
733 /* end of hostlist-server.c */