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 * Handle for accessing peerinfo service.
84 static struct GNUNET_PEERINFO_Handle *peerinfo;
87 * Set if we are allowed to advertise our hostlist to others.
89 static int advertising;
92 * Buffer for the hostlist address
94 static char *hostlist_uri;
98 * Context for host processor.
106 struct GNUNET_PEERINFO_IteratorContext *pitr;
111 * NULL if we are not currenlty iterating over peer information.
113 static struct HostSet *builder;
119 * Function that assembles our response.
124 if (NULL != response)
125 MHD_destroy_response (response);
126 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
127 "Creating hostlist response with %u bytes\n",
128 (unsigned int) builder->size);
130 MHD_create_response_from_data (builder->size, builder->data, MHD_YES,
132 if ((NULL == daemon_handle_v4) && (NULL == daemon_handle_v6))
134 MHD_destroy_response (response);
137 GNUNET_STATISTICS_set (stats, gettext_noop ("bytes in hostlist"),
138 builder->size, GNUNET_YES);
139 GNUNET_free (builder);
145 * Set 'cls' to GNUNET_YES (we have an address!).
147 * @param cls closure, an 'int*'
148 * @param address the address (ignored)
149 * @param expiration expiration time (call is ignored if this is in the past)
150 * @return GNUNET_SYSERR to stop iterating (unless expiration has occured)
153 check_has_addr (void *cls, const struct GNUNET_HELLO_Address *address,
154 struct GNUNET_TIME_Absolute expiration)
158 if (GNUNET_TIME_absolute_get_remaining (expiration).rel_value == 0)
160 GNUNET_STATISTICS_update (stats,
161 gettext_noop ("expired addresses encountered"), 1,
163 return GNUNET_YES; /* ignore this address */
166 return GNUNET_SYSERR;
171 * Callback that processes each of the known HELLOs for the
172 * hostlist response construction.
175 host_processor (void *cls, const struct GNUNET_PeerIdentity *peer,
176 const struct GNUNET_HELLO_Message *hello, const char *err_msg)
184 GNUNET_assert (NULL == peer);
185 builder->pitr = NULL;
186 GNUNET_free_non_null (builder->data);
187 GNUNET_free (builder);
188 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
189 _("Error in communication with PEERINFO service: %s\n"),
195 builder->pitr = NULL;
201 has_addr = GNUNET_NO;
202 GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO, &check_has_addr, &has_addr);
203 if (GNUNET_NO == has_addr)
205 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
206 "HELLO for peer `%4s' has no address, not suitable for hostlist!\n",
208 GNUNET_STATISTICS_update (stats,
210 ("HELLOs without addresses encountered (ignored)"),
215 s = GNUNET_HELLO_size (hello);
216 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
217 "Received %u bytes of `%s' from peer `%s' for hostlist.\n",
218 (unsigned int) s, "HELLO", GNUNET_i2s (peer));
219 if ((old + s >= GNUNET_MAX_MALLOC_CHECKED) ||
220 (old + s >= MAX_BYTES_PER_HOSTLISTS))
222 GNUNET_STATISTICS_update (stats,
224 ("bytes not included in hostlist (size limit)"),
226 return; /* too large, skip! */
228 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
229 "Adding peer `%s' to hostlist (%u bytes)\n", GNUNET_i2s (peer),
231 GNUNET_array_grow (builder->data, builder->size, old + s);
232 memcpy (&builder->data[old], hello, s);
238 * Hostlist access policy (very permissive, allows everything).
241 accept_policy_callback (void *cls, const struct sockaddr *addr,
244 if (NULL == response)
246 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
247 "Received request for hostlist, but I am not yet ready; rejecting!\n");
250 return MHD_YES; /* accept all */
255 * Main request handler.
258 access_handler_callback (void *cls, struct MHD_Connection *connection,
259 const char *url, const char *method,
260 const char *version, const char *upload_data,
261 size_t * upload_data_size, void **con_cls)
265 if (0 != strcmp (method, MHD_HTTP_METHOD_GET))
267 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
268 _("Refusing `%s' request to hostlist server\n"), method);
269 GNUNET_STATISTICS_update (stats,
271 ("hostlist requests refused (not HTTP GET)"), 1,
275 if (NULL == *con_cls)
278 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending 100 CONTINUE reply\n");
279 return MHD_YES; /* send 100 continue */
281 if (0 != *upload_data_size)
283 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
284 _("Refusing `%s' request with %llu bytes of upload data\n"),
285 method, (unsigned long long) *upload_data_size);
286 GNUNET_STATISTICS_update (stats,
288 ("hostlist requests refused (upload data)"), 1,
290 return MHD_NO; /* do not support upload data */
292 if (NULL == response)
294 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
296 ("Could not handle hostlist request since I do not have a response yet\n"));
297 GNUNET_STATISTICS_update (stats,
299 ("hostlist requests refused (not ready)"), 1,
301 return MHD_NO; /* internal error, no response yet */
303 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Received request for our hostlist\n"));
304 GNUNET_STATISTICS_update (stats, gettext_noop ("hostlist requests processed"),
306 return MHD_queue_response (connection, MHD_HTTP_OK, response);
311 * Handler called by core when core is ready to transmit message
313 * @param size size of buffer to copy message to
314 * @param buf buffer to copy message to
317 adv_transmit_ready (void *cls, size_t size, void *buf)
319 static uint64_t hostlist_adv_count;
320 size_t transmission_size;
321 size_t uri_size; /* Including \0 termination! */
322 struct GNUNET_MessageHeader header;
327 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
328 "Transmission failed, buffer invalid!\n");
331 uri_size = strlen (hostlist_uri) + 1;
332 transmission_size = sizeof (struct GNUNET_MessageHeader) + uri_size;
333 header.type = htons (GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT);
334 header.size = htons (transmission_size);
335 GNUNET_assert (size >= transmission_size);
336 memcpy (buf, &header, sizeof (struct GNUNET_MessageHeader));
338 memcpy (&cbuf[sizeof (struct GNUNET_MessageHeader)], hostlist_uri, uri_size);
339 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
340 "Sent advertisement message: Copied %u bytes into buffer!\n",
341 (unsigned int) transmission_size);
342 hostlist_adv_count++;
343 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " # Sent advertisement message: %u\n",
345 GNUNET_STATISTICS_update (stats,
346 gettext_noop ("# hostlist advertisements send"), 1,
348 return transmission_size;
353 * Method called whenever a given peer connects.
356 * @param peer peer identity this notification is about
359 connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
365 if (NULL == hostlist_uri)
367 size = strlen (hostlist_uri) + 1;
368 if (size + sizeof (struct GNUNET_MessageHeader) >=
369 GNUNET_SERVER_MAX_MESSAGE_SIZE)
374 size += sizeof (struct GNUNET_MessageHeader);
380 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
381 "Asked core to transmit advertisement message with a size of %u bytes to peer `%s'\n",
382 size, GNUNET_i2s (peer));
384 GNUNET_CORE_notify_transmit_ready (core, GNUNET_YES, 0,
385 GNUNET_ADV_TIMEOUT, peer, size,
386 &adv_transmit_ready, NULL))
388 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
389 _("Advertisement message could not be queued by core\n"));
395 * Method called whenever a given peer disconnects.
398 * @param peer peer identity this notification is about
401 disconnect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
408 * PEERINFO calls this function to let us know about a possible peer
409 * that we might want to connect to.
411 * @param cls closure (not used)
412 * @param peer potential peer to connect to
413 * @param hello HELLO for this peer (or NULL)
414 * @param err_msg NULL if successful, otherwise contains error message
417 process_notify (void *cls, const struct GNUNET_PeerIdentity *peer,
418 const struct GNUNET_HELLO_Message *hello, const char *err_msg)
420 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
421 "Peerinfo is notifying us to rebuild our hostlist\n");
423 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
424 _("Error in communication with PEERINFO service: %s\n"),
428 /* restart re-build already in progress ... */
429 GNUNET_PEERINFO_iterate_cancel (builder->pitr);
430 GNUNET_free_non_null (builder->data);
432 builder->data = NULL;
436 builder = GNUNET_malloc (sizeof (struct HostSet));
438 GNUNET_assert (NULL != peerinfo);
440 GNUNET_PEERINFO_iterate (peerinfo, GNUNET_NO, NULL, GNUNET_TIME_UNIT_MINUTES,
441 &host_processor, NULL);
446 * Function that queries MHD's select sets and
447 * starts the task waiting for them.
449 static GNUNET_SCHEDULER_TaskIdentifier
450 prepare_daemon (struct MHD_Daemon *daemon_handle);
454 * Call MHD to process pending requests and then go back
455 * and schedule the next run.
458 run_daemon (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
460 struct MHD_Daemon *daemon_handle = cls;
462 if (daemon_handle == daemon_handle_v4)
463 hostlist_task_v4 = GNUNET_SCHEDULER_NO_TASK;
465 hostlist_task_v6 = GNUNET_SCHEDULER_NO_TASK;
467 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
469 GNUNET_assert (MHD_YES == MHD_run (daemon_handle));
470 if (daemon_handle == daemon_handle_v4)
471 hostlist_task_v4 = prepare_daemon (daemon_handle);
473 hostlist_task_v6 = prepare_daemon (daemon_handle);
476 #define UNSIGNED_MHD_LONG_LONG unsigned MHD_LONG_LONG
479 * Function that queries MHD's select sets and
480 * starts the task waiting for them.
482 static GNUNET_SCHEDULER_TaskIdentifier
483 prepare_daemon (struct MHD_Daemon *daemon_handle)
485 GNUNET_SCHEDULER_TaskIdentifier ret;
489 struct GNUNET_NETWORK_FDSet *wrs;
490 struct GNUNET_NETWORK_FDSet *wws;
491 struct GNUNET_NETWORK_FDSet *wes;
493 UNSIGNED_MHD_LONG_LONG timeout;
495 struct GNUNET_TIME_Relative tv;
500 wrs = GNUNET_NETWORK_fdset_create ();
501 wes = GNUNET_NETWORK_fdset_create ();
502 wws = GNUNET_NETWORK_fdset_create ();
504 GNUNET_assert (MHD_YES == MHD_get_fdset (daemon_handle, &rs, &ws, &es, &max));
505 haveto = MHD_get_timeout (daemon_handle, &timeout);
506 if (haveto == MHD_YES)
507 tv.rel_value = (uint64_t) timeout;
509 tv = GNUNET_TIME_UNIT_FOREVER_REL;
510 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
511 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
512 GNUNET_NETWORK_fdset_copy_native (wes, &es, max + 1);
514 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
516 &run_daemon, daemon_handle);
517 GNUNET_NETWORK_fdset_destroy (wrs);
518 GNUNET_NETWORK_fdset_destroy (wws);
519 GNUNET_NETWORK_fdset_destroy (wes);
525 * Start server offering our hostlist.
527 * @return GNUNET_OK on success
530 GNUNET_HOSTLIST_server_start (const struct GNUNET_CONFIGURATION_Handle *c,
531 struct GNUNET_STATISTICS_Handle *st,
532 struct GNUNET_CORE_Handle *co,
533 GNUNET_CORE_ConnectEventHandler *server_ch,
534 GNUNET_CORE_DisconnectEventHandler *server_dh,
537 unsigned long long port;
543 struct sockaddr_in v4;
544 struct sockaddr_in6 v6;
545 const struct sockaddr *sa;
547 advertising = advertise;
549 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
550 "Advertising not enabled on this hostlist server\n");
552 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
553 "Advertising enabled on this hostlist server\n");
556 peerinfo = GNUNET_PEERINFO_connect (cfg);
557 if (NULL == peerinfo)
559 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
560 _("Could not access PEERINFO service. Exiting.\n"));
561 return GNUNET_SYSERR;
564 GNUNET_CONFIGURATION_get_value_number (cfg, "HOSTLIST", "HTTPPORT",
566 return GNUNET_SYSERR;
567 if ((0 == port) || (port > UINT16_MAX))
569 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
570 _("Invalid port number %llu. Exiting.\n"), port);
571 return GNUNET_SYSERR;
575 GNUNET_CONFIGURATION_get_value_string (cfg, "HOSTLIST",
576 "EXTERNAL_DNS_NAME", &hostname))
577 hostname = GNUNET_RESOLVER_local_fqdn_get ();
579 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Hostlist service starts on %s:%llu\n"),
581 if (NULL != hostname)
583 size = strlen (hostname);
584 if (size + 15 > MAX_URL_LEN)
590 GNUNET_asprintf (&hostlist_uri, "http://%s:%u/", hostname,
591 (unsigned int) port);
592 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
593 _("Address to obtain hostlist: `%s'\n"), hostlist_uri);
595 GNUNET_free (hostname);
598 if (GNUNET_CONFIGURATION_have_value (cfg, "HOSTLIST", "BINDTOIP"))
600 GNUNET_break (GNUNET_OK ==
601 GNUNET_CONFIGURATION_get_value_string (cfg, "HOSTLIST",
608 if (1 == inet_pton (AF_INET, ip, &i4))
610 memset (&v4, 0, sizeof (v4));
611 v4.sin_family = AF_INET;
613 v4.sin_port = htons (port);
614 #if HAVE_SOCKADDR_IN_SIN_LEN
615 v4.sin_len = sizeof (v4);
617 sa = (const struct sockaddr *) &v4;
619 else if (1 == inet_pton (AF_INET6, ip, &i6))
621 memset (&v6, 0, sizeof (v6));
622 v6.sin6_family = AF_INET6;
624 v6.sin6_port = htons (port);
625 #if HAVE_SOCKADDR_IN_SIN_LEN
626 v6.sin6_len = sizeof (v6);
628 sa = (const struct sockaddr *) &v6;
632 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
633 _("`%s' is not a valid IP address! Ignoring BINDTOIP.\n"),
641 daemon_handle_v6 = MHD_start_daemon (MHD_USE_IPv6 | MHD_USE_DEBUG,
643 &accept_policy_callback, NULL,
644 &access_handler_callback, NULL,
645 MHD_OPTION_CONNECTION_LIMIT,
647 MHD_OPTION_PER_IP_CONNECTION_LIMIT,
649 MHD_OPTION_CONNECTION_TIMEOUT,
651 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
652 (size_t) (16 * 1024),
653 MHD_OPTION_SOCK_ADDR,
656 daemon_handle_v4 = MHD_start_daemon (MHD_NO_FLAG | MHD_USE_DEBUG,
658 &accept_policy_callback, NULL,
659 &access_handler_callback, NULL,
660 MHD_OPTION_CONNECTION_LIMIT,
662 MHD_OPTION_PER_IP_CONNECTION_LIMIT,
664 MHD_OPTION_CONNECTION_TIMEOUT,
666 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
667 (size_t) (16 * 1024),
668 MHD_OPTION_SOCK_ADDR,
672 if ((NULL == daemon_handle_v6) && (NULL == daemon_handle_v4))
674 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
675 _("Could not start hostlist HTTP server on port %u\n"),
676 (unsigned short) port);
677 return GNUNET_SYSERR;
681 *server_ch = &connect_handler;
682 *server_dh = &disconnect_handler;
683 if (daemon_handle_v4 != NULL)
684 hostlist_task_v4 = prepare_daemon (daemon_handle_v4);
685 if (daemon_handle_v6 != NULL)
686 hostlist_task_v6 = prepare_daemon (daemon_handle_v6);
688 notify = GNUNET_PEERINFO_notify (cfg, GNUNET_NO, &process_notify, NULL);
695 * Stop server offering our hostlist.
698 GNUNET_HOSTLIST_server_stop ()
700 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Hostlist server shutdown\n");
701 if (GNUNET_SCHEDULER_NO_TASK != hostlist_task_v6)
703 GNUNET_SCHEDULER_cancel (hostlist_task_v6);
704 hostlist_task_v6 = GNUNET_SCHEDULER_NO_TASK;
706 if (GNUNET_SCHEDULER_NO_TASK != hostlist_task_v4)
708 GNUNET_SCHEDULER_cancel (hostlist_task_v4);
709 hostlist_task_v4 = GNUNET_SCHEDULER_NO_TASK;
711 if (NULL != daemon_handle_v4)
713 MHD_stop_daemon (daemon_handle_v4);
714 daemon_handle_v4 = NULL;
716 if (NULL != daemon_handle_v6)
718 MHD_stop_daemon (daemon_handle_v6);
719 daemon_handle_v6 = NULL;
721 if (NULL != response)
723 MHD_destroy_response (response);
728 GNUNET_PEERINFO_notify_cancel (notify);
733 GNUNET_PEERINFO_iterate_cancel (builder->pitr);
734 builder->pitr = NULL;
735 GNUNET_free_non_null (builder->data);
736 GNUNET_free (builder);
738 if (NULL != peerinfo)
740 GNUNET_PEERINFO_disconnect (peerinfo);
748 /* end of hostlist-server.c */