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 2, 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"
35 #define DEBUG_HOSTLIST_SERVER GNUNET_NO
38 * Handle to the HTTP server as provided by libmicrohttpd for IPv6.
40 static struct MHD_Daemon *daemon_handle_v6;
43 * Handle to the HTTP server as provided by libmicrohttpd for IPv4.
45 static struct MHD_Daemon *daemon_handle_v4;
50 static const struct GNUNET_CONFIGURATION_Handle *cfg;
55 static struct GNUNET_SCHEDULER_Handle *sched;
58 * For keeping statistics.
60 static struct GNUNET_STATISTICS_Handle *stats;
63 * Handle to the core service (NULL until we've connected to it).
65 struct GNUNET_CORE_Handle *core;
68 * Handle to the peerinfo notify service (NULL until we've connected to it).
70 struct GNUNET_PEERINFO_NotifyContext *notify;
73 * Our primary task for IPv4.
75 static GNUNET_SCHEDULER_TaskIdentifier hostlist_task_v4;
78 * Our primary task for IPv6.
80 static GNUNET_SCHEDULER_TaskIdentifier hostlist_task_v6;
83 * Our canonical response.
85 static struct MHD_Response *response;
88 * NULL if we are not currenlty iterating over peer information.
90 static struct GNUNET_PEERINFO_IteratorContext *pitr;
93 * Handle for accessing peerinfo service.
95 static struct GNUNET_PEERINFO_Handle *peerinfo;
98 * Context for host processor.
108 * Set if we are allowed to advertise our hostlist to others.
110 static int advertising;
113 * How many times was the hostlist advertised?
115 static uint64_t hostlist_adv_count;
118 * Buffer for the hostlist address
120 static char * hostlist_uri;
124 * Function that assembles our response.
127 finish_response (struct HostSet *results)
129 if (response != NULL)
130 MHD_destroy_response (response);
131 #if DEBUG_HOSTLIST_SERVER
132 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
133 "Creating hostlist response with %u bytes\n",
134 (unsigned int) results->size);
136 response = MHD_create_response_from_data (results->size,
137 results->data, MHD_YES, MHD_NO);
138 if ( (daemon_handle_v4 == NULL) &&
139 (daemon_handle_v6 == NULL) )
141 MHD_destroy_response (response);
144 GNUNET_STATISTICS_set (stats,
145 gettext_noop("bytes in hostlist"),
148 GNUNET_free (results);
153 * Set 'cls' to GNUNET_YES (we have an address!).
155 * @param cls closure, an 'int*'
156 * @param tname name of the transport (ignored)
157 * @param expiration expiration time (call is ignored if this is in the past)
158 * @param addr the address (ignored)
159 * @param addrlen length of the address (ignored)
160 * @return GNUNET_SYSERR to stop iterating (unless expiration has occured)
163 check_has_addr (void *cls,
165 struct GNUNET_TIME_Absolute expiration,
171 if (GNUNET_TIME_absolute_get_remaining (expiration).value == 0)
173 GNUNET_STATISTICS_update (stats,
174 gettext_noop("expired addresses encountered"),
177 return GNUNET_YES; /* ignore this address */
180 return GNUNET_SYSERR;
185 * Callback that processes each of the known HELLOs for the
186 * hostlist response construction.
189 host_processor (void *cls,
190 const struct GNUNET_PeerIdentity * peer,
191 const struct GNUNET_HELLO_Message *hello,
194 struct HostSet *results = cls;
202 finish_response (results);
207 has_addr = GNUNET_NO;
208 GNUNET_HELLO_iterate_addresses (hello,
212 if (GNUNET_NO == has_addr)
214 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
215 "HELLO for peer `%4s' has no address, not suitable for hostlist!\n",
217 GNUNET_STATISTICS_update (stats,
218 gettext_noop("HELLOs without addresses encountered (ignored)"),
224 s = GNUNET_HELLO_size(hello);
225 #if DEBUG_HOSTLIST_SERVER
226 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
227 "Received %u bytes of `%s' from peer `%s' for hostlist.\n",
232 if ( (old + s >= GNUNET_MAX_MALLOC_CHECKED) || (old + s >= MAX_BYTES_PER_HOSTLISTS) )
234 GNUNET_STATISTICS_update (stats,
235 gettext_noop("bytes not included in hostlist (size limit)"),
238 return; /* too large, skip! */
240 #if DEBUG_HOSTLIST_SERVER
241 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
242 "Adding peer `%s' to hostlist (%u bytes)\n",
246 GNUNET_array_grow (results->data,
249 memcpy (&results->data[old], hello, s);
255 * Hostlist access policy (very permissive, allows everything).
258 accept_policy_callback (void *cls,
259 const struct sockaddr *addr, socklen_t addrlen)
261 if (NULL == response)
263 #if DEBUG_HOSTLIST_SERVER
264 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
265 "Received request for hostlist, but I am not yet ready; rejecting!\n");
269 return MHD_YES; /* accept all */
274 * Main request handler.
277 access_handler_callback (void *cls,
278 struct MHD_Connection *connection,
282 const char *upload_data,
283 size_t*upload_data_size, void **con_cls)
287 if (0 != strcmp (method, MHD_HTTP_METHOD_GET))
289 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
290 _("Refusing `%s' request to hostlist server\n"),
292 GNUNET_STATISTICS_update (stats,
293 gettext_noop("hostlist requests refused (not HTTP GET)"),
298 if (NULL == *con_cls)
301 #if DEBUG_HOSTLIST_SERVER
302 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
303 _("Sending 100 CONTINUE reply\n"));
305 return MHD_YES; /* send 100 continue */
307 if (*upload_data_size != 0)
309 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
310 _("Refusing `%s' request with %llu bytes of upload data\n"),
312 (unsigned long long) *upload_data_size);
313 GNUNET_STATISTICS_update (stats,
314 gettext_noop("hostlist requests refused (upload data)"),
317 return MHD_NO; /* do not support upload data */
319 if (response == NULL)
321 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
322 _("Could not handle hostlist request since I do not have a response yet\n"));
323 GNUNET_STATISTICS_update (stats,
324 gettext_noop("hostlist requests refused (not ready)"),
327 return MHD_NO; /* internal error, no response yet */
329 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
330 _("Received request for our hostlist\n"));
331 GNUNET_STATISTICS_update (stats,
332 gettext_noop("hostlist requests processed"),
335 return MHD_queue_response (connection, MHD_HTTP_OK, response);
340 * Handler called by core when core is ready to transmit message
342 * @param size size of buffer to copy message to
343 * @param buf buffer to copy message to
346 adv_transmit_ready ( void *cls, size_t size, void *buf)
348 size_t transmission_size;
349 size_t uri_size; /* Including \0 termination! */
350 struct GNUNET_MessageHeader header;
355 GNUNET_log ( GNUNET_ERROR_TYPE_DEBUG,
356 "Transmission failed, buffer invalid!\n" );
359 uri_size = strlen ( hostlist_uri ) + 1;
360 transmission_size = sizeof (struct GNUNET_MessageHeader) + uri_size;
361 header.type = htons (GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT);
362 header.size = htons (transmission_size);
363 GNUNET_assert (size >= transmission_size);
364 memcpy (buf, &header, sizeof (struct GNUNET_MessageHeader));
366 memcpy (&cbuf[sizeof (struct GNUNET_MessageHeader)],
367 hostlist_uri, uri_size);
368 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
369 "Sent advertisement message: Copied %u bytes into buffer!\n",
370 (unsigned int) transmission_size);
371 hostlist_adv_count++;
372 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
373 " # Sent advertisement message: %u\n",
375 GNUNET_STATISTICS_set (stats,
376 gettext_noop("# hostlist advertisements send"),
379 return transmission_size;
384 * Method called whenever a given peer connects.
387 * @param peer peer identity this notification is about
388 * @param latency reported latency of the connection with 'other'
389 * @param distance reported distance (DV) to 'other'
392 connect_handler (void *cls,
394 GNUNET_PeerIdentity * peer,
395 struct GNUNET_TIME_Relative latency,
402 if (hostlist_uri == NULL)
404 size = strlen (hostlist_uri) + 1;
405 if (size + sizeof (struct GNUNET_MessageHeader) > GNUNET_SERVER_MAX_MESSAGE_SIZE)
410 size += sizeof (struct GNUNET_MessageHeader);
416 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
417 "Asked core to transmit advertisement message with a size of %u bytes to peer `%s'\n",
418 size,GNUNET_i2s(peer));
419 if (NULL == GNUNET_CORE_notify_transmit_ready (core,
424 &adv_transmit_ready, NULL))
426 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
427 _("Advertisement message could not be queued by core\n"));
433 * Method called whenever a given peer disconnects.
436 * @param peer peer identity this notification is about
439 disconnect_handler (void *cls,
441 GNUNET_PeerIdentity * peer)
447 * PEERINFO calls this function to let us know about a possible peer
448 * that we might want to connect to.
450 * @param cls closure (not used)
451 * @param peer potential peer to connect to
452 * @param hello HELLO for this peer (or NULL)
453 * @param trust how much we trust the peer (not used)
456 process_notify (void *cls,
457 const struct GNUNET_PeerIdentity *peer,
458 const struct GNUNET_HELLO_Message *hello,
461 struct HostSet *results;
462 #if DEBUG_HOSTLIST_SERVER
463 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
464 "Peerinfo is notifying us to rebuild our hostlist\n");
466 results = GNUNET_malloc(sizeof(struct HostSet));
467 GNUNET_assert (peerinfo != NULL);
468 pitr = GNUNET_PEERINFO_iterate (peerinfo,
471 GNUNET_TIME_UNIT_MINUTES,
477 * Function that queries MHD's select sets and
478 * starts the task waiting for them.
480 static GNUNET_SCHEDULER_TaskIdentifier
481 prepare_daemon (struct MHD_Daemon *daemon_handle);
485 * Call MHD to process pending requests and then go back
486 * and schedule the next run.
489 run_daemon (void *cls,
490 const struct GNUNET_SCHEDULER_TaskContext *tc)
492 struct MHD_Daemon *daemon_handle = cls;
494 if (daemon_handle == daemon_handle_v4)
495 hostlist_task_v4 = GNUNET_SCHEDULER_NO_TASK;
497 hostlist_task_v6 = GNUNET_SCHEDULER_NO_TASK;
499 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
501 GNUNET_assert (MHD_YES == MHD_run (daemon_handle));
502 if (daemon_handle == daemon_handle_v4)
503 hostlist_task_v4 = prepare_daemon (daemon_handle);
505 hostlist_task_v6 = prepare_daemon (daemon_handle);
510 * Function that queries MHD's select sets and
511 * starts the task waiting for them.
513 static GNUNET_SCHEDULER_TaskIdentifier
514 prepare_daemon (struct MHD_Daemon *daemon_handle)
516 GNUNET_SCHEDULER_TaskIdentifier ret;
520 struct GNUNET_NETWORK_FDSet *wrs;
521 struct GNUNET_NETWORK_FDSet *wws;
522 struct GNUNET_NETWORK_FDSet *wes;
524 unsigned long long timeout;
526 struct GNUNET_TIME_Relative tv;
531 wrs = GNUNET_NETWORK_fdset_create ();
532 wes = GNUNET_NETWORK_fdset_create ();
533 wws = GNUNET_NETWORK_fdset_create ();
535 GNUNET_assert (MHD_YES ==
536 MHD_get_fdset (daemon_handle,
541 haveto = MHD_get_timeout (daemon_handle, &timeout);
542 if (haveto == MHD_YES)
543 tv.value = (uint64_t) timeout;
545 tv = GNUNET_TIME_UNIT_FOREVER_REL;
546 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max);
547 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max);
548 GNUNET_NETWORK_fdset_copy_native (wes, &es, max);
549 ret = GNUNET_SCHEDULER_add_select (sched,
550 GNUNET_SCHEDULER_PRIORITY_HIGH,
551 GNUNET_SCHEDULER_NO_TASK,
557 GNUNET_NETWORK_fdset_destroy (wrs);
558 GNUNET_NETWORK_fdset_destroy (wws);
559 GNUNET_NETWORK_fdset_destroy (wes);
566 * Start server offering our hostlist.
568 * @return GNUNET_OK on success
571 GNUNET_HOSTLIST_server_start (const struct GNUNET_CONFIGURATION_Handle *c,
572 struct GNUNET_SCHEDULER_Handle *s,
573 struct GNUNET_STATISTICS_Handle *st,
574 struct GNUNET_CORE_Handle *co,
575 GNUNET_CORE_ConnectEventHandler *server_ch,
576 GNUNET_CORE_DisconnectEventHandler *server_dh,
579 unsigned long long port;
583 advertising = advertise;
585 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
586 "Advertising not enabled on this hostlist server\n");
588 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
589 "Advertising enabled on this hostlist server\n");
593 peerinfo = GNUNET_PEERINFO_connect (sched, cfg);
594 if (peerinfo == NULL)
596 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
597 _("Could not access PEERINFO service. Exiting.\n"));
598 return GNUNET_SYSERR;
600 if (-1 == GNUNET_CONFIGURATION_get_value_number (cfg,
604 return GNUNET_SYSERR;
606 if ( GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg,
610 hostname = GNUNET_RESOLVER_local_fqdn_get ();
612 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
613 _("Hostlist service starts on %s:%llu\n"),
615 if (NULL != hostname)
617 size = strlen (hostname);
618 if (size + 15 > MAX_URL_LEN)
624 GNUNET_asprintf (&hostlist_uri,
627 (unsigned int) port);
628 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
629 _("Address to obtain hostlist: `%s'\n"),
632 GNUNET_free ( hostname );
634 daemon_handle_v6 = MHD_start_daemon (MHD_USE_IPv6
635 #if DEBUG_HOSTLIST_SERVER
639 (unsigned short) port,
640 &accept_policy_callback,
642 &access_handler_callback,
644 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
645 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
646 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
647 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
649 daemon_handle_v4 = MHD_start_daemon (MHD_NO_FLAG
650 #if DEBUG_HOSTLIST_SERVER
654 (unsigned short) port,
655 &accept_policy_callback,
657 &access_handler_callback,
659 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
660 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
661 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
662 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
665 if ( (daemon_handle_v6 == NULL) &&
666 (daemon_handle_v4 == NULL) )
668 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
669 _("Could not start hostlist HTTP server on port %u\n"),
670 (unsigned short) port);
671 return GNUNET_SYSERR;
676 *server_ch = &connect_handler;
677 *server_dh = &disconnect_handler;
679 if (daemon_handle_v4 != NULL)
680 hostlist_task_v4 = prepare_daemon (daemon_handle_v4);
681 if (daemon_handle_v6 != NULL)
682 hostlist_task_v6 = prepare_daemon (daemon_handle_v6);
684 notify = GNUNET_PEERINFO_notify ( cfg, sched, process_notify, NULL);
690 * Stop server offering our hostlist.
693 GNUNET_HOSTLIST_server_stop ()
695 #if DEBUG_HOSTLIST_SERVER
696 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
697 "Hostlist server shutdown\n");
701 GNUNET_PEERINFO_notify_cancel (notify);
704 if (GNUNET_SCHEDULER_NO_TASK != hostlist_task_v6)
706 GNUNET_SCHEDULER_cancel (sched, hostlist_task_v6);
707 hostlist_task_v6 = GNUNET_SCHEDULER_NO_TASK;
709 if (GNUNET_SCHEDULER_NO_TASK != hostlist_task_v4)
711 GNUNET_SCHEDULER_cancel (sched, hostlist_task_v4);
712 hostlist_task_v4 = GNUNET_SCHEDULER_NO_TASK;
716 GNUNET_PEERINFO_iterate_cancel (pitr);
719 if (NULL != daemon_handle_v4)
721 MHD_stop_daemon (daemon_handle_v4);
722 daemon_handle_v4 = NULL;
724 if (NULL != daemon_handle_v6)
726 MHD_stop_daemon (daemon_handle_v6);
727 daemon_handle_v6 = NULL;
729 if (response != NULL)
731 MHD_destroy_response (response);
734 if (peerinfo != NULL)
736 GNUNET_PEERINFO_disconnect (peerinfo);
741 /* end of hostlist-server.c */