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"
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;
53 * For keeping statistics.
55 static struct GNUNET_STATISTICS_Handle *stats;
58 * Handle to the core service (NULL until we've connected to it).
60 static struct GNUNET_CORE_Handle *core;
63 * Handle to the peerinfo notify service (NULL until we've connected to it).
65 static struct GNUNET_PEERINFO_NotifyContext *notify;
68 * Our primary task for IPv4.
70 static GNUNET_SCHEDULER_TaskIdentifier hostlist_task_v4;
73 * Our primary task for IPv6.
75 static GNUNET_SCHEDULER_TaskIdentifier hostlist_task_v6;
78 * Our canonical response.
80 static struct MHD_Response *response;
83 * NULL if we are not currenlty iterating over peer information.
85 static struct GNUNET_PEERINFO_IteratorContext *pitr;
88 * Handle for accessing peerinfo service.
90 static struct GNUNET_PEERINFO_Handle *peerinfo;
93 * Context for host processor.
103 * Set if we are allowed to advertise our hostlist to others.
105 static int advertising;
108 * Buffer for the hostlist address
110 static char * hostlist_uri;
114 * Function that assembles our response.
117 finish_response (struct HostSet *results)
119 if (response != NULL)
120 MHD_destroy_response (response);
121 #if DEBUG_HOSTLIST_SERVER
122 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
123 "Creating hostlist response with %u bytes\n",
124 (unsigned int) results->size);
126 response = MHD_create_response_from_data (results->size,
127 results->data, MHD_YES, MHD_NO);
128 if ( (daemon_handle_v4 == NULL) &&
129 (daemon_handle_v6 == NULL) )
131 MHD_destroy_response (response);
134 GNUNET_STATISTICS_set (stats,
135 gettext_noop("bytes in hostlist"),
138 GNUNET_free (results);
143 * Set 'cls' to GNUNET_YES (we have an address!).
145 * @param cls closure, an 'int*'
146 * @param tname name of the transport (ignored)
147 * @param expiration expiration time (call is ignored if this is in the past)
148 * @param addr the address (ignored)
149 * @param addrlen length of the address (ignored)
150 * @return GNUNET_SYSERR to stop iterating (unless expiration has occured)
153 check_has_addr (void *cls,
155 struct GNUNET_TIME_Absolute expiration,
161 if (GNUNET_TIME_absolute_get_remaining (expiration).rel_value == 0)
163 GNUNET_STATISTICS_update (stats,
164 gettext_noop("expired addresses encountered"),
167 return GNUNET_YES; /* ignore this address */
170 return GNUNET_SYSERR;
175 * Callback that processes each of the known HELLOs for the
176 * hostlist response construction.
179 host_processor (void *cls,
180 const struct GNUNET_PeerIdentity * peer,
181 const struct GNUNET_HELLO_Message *hello)
183 struct HostSet *results = cls;
191 finish_response (results);
196 has_addr = GNUNET_NO;
197 GNUNET_HELLO_iterate_addresses (hello,
201 if (GNUNET_NO == has_addr)
203 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
204 "HELLO for peer `%4s' has no address, not suitable for hostlist!\n",
206 GNUNET_STATISTICS_update (stats,
207 gettext_noop("HELLOs without addresses encountered (ignored)"),
213 s = GNUNET_HELLO_size(hello);
214 #if DEBUG_HOSTLIST_SERVER
215 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
216 "Received %u bytes of `%s' from peer `%s' for hostlist.\n",
221 if ( (old + s >= GNUNET_MAX_MALLOC_CHECKED) || (old + s >= MAX_BYTES_PER_HOSTLISTS) )
223 GNUNET_STATISTICS_update (stats,
224 gettext_noop("bytes not included in hostlist (size limit)"),
227 return; /* too large, skip! */
229 #if DEBUG_HOSTLIST_SERVER
230 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
231 "Adding peer `%s' to hostlist (%u bytes)\n",
235 GNUNET_array_grow (results->data,
238 memcpy (&results->data[old], hello, s);
244 * Hostlist access policy (very permissive, allows everything).
247 accept_policy_callback (void *cls,
248 const struct sockaddr *addr, socklen_t addrlen)
250 if (NULL == response)
252 #if DEBUG_HOSTLIST_SERVER
253 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
254 "Received request for hostlist, but I am not yet ready; rejecting!\n");
258 return MHD_YES; /* accept all */
263 * Main request handler.
266 access_handler_callback (void *cls,
267 struct MHD_Connection *connection,
271 const char *upload_data,
272 size_t*upload_data_size, void **con_cls)
276 if (0 != strcmp (method, MHD_HTTP_METHOD_GET))
278 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
279 _("Refusing `%s' request to hostlist server\n"),
281 GNUNET_STATISTICS_update (stats,
282 gettext_noop("hostlist requests refused (not HTTP GET)"),
287 if (NULL == *con_cls)
290 #if DEBUG_HOSTLIST_SERVER
291 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
292 _("Sending 100 CONTINUE reply\n"));
294 return MHD_YES; /* send 100 continue */
296 if (*upload_data_size != 0)
298 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
299 _("Refusing `%s' request with %llu bytes of upload data\n"),
301 (unsigned long long) *upload_data_size);
302 GNUNET_STATISTICS_update (stats,
303 gettext_noop("hostlist requests refused (upload data)"),
306 return MHD_NO; /* do not support upload data */
308 if (response == NULL)
310 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
311 _("Could not handle hostlist request since I do not have a response yet\n"));
312 GNUNET_STATISTICS_update (stats,
313 gettext_noop("hostlist requests refused (not ready)"),
316 return MHD_NO; /* internal error, no response yet */
318 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
319 _("Received request for our hostlist\n"));
320 GNUNET_STATISTICS_update (stats,
321 gettext_noop("hostlist requests processed"),
324 return MHD_queue_response (connection, MHD_HTTP_OK, response);
329 * Handler called by core when core is ready to transmit message
331 * @param size size of buffer to copy message to
332 * @param buf buffer to copy message to
335 adv_transmit_ready ( void *cls, size_t size, void *buf)
337 static uint64_t hostlist_adv_count;
339 size_t transmission_size;
340 size_t uri_size; /* Including \0 termination! */
341 struct GNUNET_MessageHeader header;
346 GNUNET_log ( GNUNET_ERROR_TYPE_DEBUG,
347 "Transmission failed, buffer invalid!\n" );
350 uri_size = strlen ( hostlist_uri ) + 1;
351 transmission_size = sizeof (struct GNUNET_MessageHeader) + uri_size;
352 header.type = htons (GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT);
353 header.size = htons (transmission_size);
354 GNUNET_assert (size >= transmission_size);
355 memcpy (buf, &header, sizeof (struct GNUNET_MessageHeader));
357 memcpy (&cbuf[sizeof (struct GNUNET_MessageHeader)],
358 hostlist_uri, uri_size);
359 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
360 "Sent advertisement message: Copied %u bytes into buffer!\n",
361 (unsigned int) transmission_size);
362 hostlist_adv_count++;
363 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
364 " # Sent advertisement message: %u\n",
366 GNUNET_STATISTICS_update (stats,
367 gettext_noop("# hostlist advertisements send"),
370 return transmission_size;
375 * Method called whenever a given peer connects.
378 * @param peer peer identity this notification is about
379 * @param latency reported latency of the connection with 'other'
380 * @param distance reported distance (DV) to 'other'
383 connect_handler (void *cls,
385 GNUNET_PeerIdentity * peer,
386 struct GNUNET_TIME_Relative latency,
393 if (hostlist_uri == NULL)
395 size = strlen (hostlist_uri) + 1;
396 if (size + sizeof (struct GNUNET_MessageHeader) >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
401 size += sizeof (struct GNUNET_MessageHeader);
407 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
408 "Asked core to transmit advertisement message with a size of %u bytes to peer `%s'\n",
409 size,GNUNET_i2s(peer));
410 if (NULL == GNUNET_CORE_notify_transmit_ready (core,
415 &adv_transmit_ready, NULL))
417 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
418 _("Advertisement message could not be queued by core\n"));
424 * Method called whenever a given peer disconnects.
427 * @param peer peer identity this notification is about
430 disconnect_handler (void *cls,
432 GNUNET_PeerIdentity * peer)
438 * PEERINFO calls this function to let us know about a possible peer
439 * that we might want to connect to.
441 * @param cls closure (not used)
442 * @param peer potential peer to connect to
443 * @param hello HELLO for this peer (or NULL)
446 process_notify (void *cls,
447 const struct GNUNET_PeerIdentity *peer,
448 const struct GNUNET_HELLO_Message *hello)
450 struct HostSet *results;
451 #if DEBUG_HOSTLIST_SERVER
452 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
453 "Peerinfo is notifying us to rebuild our hostlist\n");
455 results = GNUNET_malloc(sizeof(struct HostSet));
456 GNUNET_assert (peerinfo != NULL);
457 pitr = GNUNET_PEERINFO_iterate (peerinfo,
459 GNUNET_TIME_UNIT_MINUTES,
465 * Function that queries MHD's select sets and
466 * starts the task waiting for them.
468 static GNUNET_SCHEDULER_TaskIdentifier
469 prepare_daemon (struct MHD_Daemon *daemon_handle);
473 * Call MHD to process pending requests and then go back
474 * and schedule the next run.
477 run_daemon (void *cls,
478 const struct GNUNET_SCHEDULER_TaskContext *tc)
480 struct MHD_Daemon *daemon_handle = cls;
482 if (daemon_handle == daemon_handle_v4)
483 hostlist_task_v4 = GNUNET_SCHEDULER_NO_TASK;
485 hostlist_task_v6 = GNUNET_SCHEDULER_NO_TASK;
487 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
489 GNUNET_assert (MHD_YES == MHD_run (daemon_handle));
490 if (daemon_handle == daemon_handle_v4)
491 hostlist_task_v4 = prepare_daemon (daemon_handle);
493 hostlist_task_v6 = prepare_daemon (daemon_handle);
498 * Function that queries MHD's select sets and
499 * starts the task waiting for them.
501 static GNUNET_SCHEDULER_TaskIdentifier
502 prepare_daemon (struct MHD_Daemon *daemon_handle)
504 GNUNET_SCHEDULER_TaskIdentifier ret;
508 struct GNUNET_NETWORK_FDSet *wrs;
509 struct GNUNET_NETWORK_FDSet *wws;
510 struct GNUNET_NETWORK_FDSet *wes;
512 unsigned long long timeout;
514 struct GNUNET_TIME_Relative tv;
519 wrs = GNUNET_NETWORK_fdset_create ();
520 wes = GNUNET_NETWORK_fdset_create ();
521 wws = GNUNET_NETWORK_fdset_create ();
523 GNUNET_assert (MHD_YES ==
524 MHD_get_fdset (daemon_handle,
529 haveto = MHD_get_timeout (daemon_handle, &timeout);
530 if (haveto == MHD_YES)
531 tv.rel_value = (uint64_t) timeout;
533 tv = GNUNET_TIME_UNIT_FOREVER_REL;
534 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
535 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
536 GNUNET_NETWORK_fdset_copy_native (wes, &es, max + 1);
537 ret = GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
538 GNUNET_SCHEDULER_NO_TASK,
544 GNUNET_NETWORK_fdset_destroy (wrs);
545 GNUNET_NETWORK_fdset_destroy (wws);
546 GNUNET_NETWORK_fdset_destroy (wes);
553 * Start server offering our hostlist.
555 * @return GNUNET_OK on success
558 GNUNET_HOSTLIST_server_start (const struct GNUNET_CONFIGURATION_Handle *c,
559 struct GNUNET_STATISTICS_Handle *st,
560 struct GNUNET_CORE_Handle *co,
561 GNUNET_CORE_ConnectEventHandler *server_ch,
562 GNUNET_CORE_DisconnectEventHandler *server_dh,
565 unsigned long long port;
569 advertising = advertise;
571 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
572 "Advertising not enabled on this hostlist server\n");
574 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
575 "Advertising enabled on this hostlist server\n");
578 peerinfo = GNUNET_PEERINFO_connect (cfg);
579 if (peerinfo == NULL)
581 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
582 _("Could not access PEERINFO service. Exiting.\n"));
583 return GNUNET_SYSERR;
585 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg,
589 return GNUNET_SYSERR;
591 (port > UINT16_MAX) )
593 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
594 _("Invalid port number %llu. Exiting.\n"),
596 return GNUNET_SYSERR;
599 if ( GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg,
603 hostname = GNUNET_RESOLVER_local_fqdn_get ();
605 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
606 _("Hostlist service starts on %s:%llu\n"),
608 if (NULL != hostname)
610 size = strlen (hostname);
611 if (size + 15 > MAX_URL_LEN)
617 GNUNET_asprintf (&hostlist_uri,
620 (unsigned int) port);
621 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
622 _("Address to obtain hostlist: `%s'\n"),
625 GNUNET_free ( hostname );
627 daemon_handle_v6 = MHD_start_daemon (MHD_USE_IPv6
628 #if DEBUG_HOSTLIST_SERVER
632 (unsigned short) port,
633 &accept_policy_callback,
635 &access_handler_callback,
637 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
638 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
639 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
640 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
642 daemon_handle_v4 = MHD_start_daemon (MHD_NO_FLAG
643 #if DEBUG_HOSTLIST_SERVER
647 (unsigned short) port,
648 &accept_policy_callback,
650 &access_handler_callback,
652 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
653 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
654 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
655 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
658 if ( (daemon_handle_v6 == NULL) &&
659 (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;
669 *server_ch = &connect_handler;
670 *server_dh = &disconnect_handler;
672 if (daemon_handle_v4 != NULL)
673 hostlist_task_v4 = prepare_daemon (daemon_handle_v4);
674 if (daemon_handle_v6 != NULL)
675 hostlist_task_v6 = prepare_daemon (daemon_handle_v6);
677 notify = GNUNET_PEERINFO_notify ( cfg, process_notify, NULL);
683 * Stop server offering our hostlist.
686 GNUNET_HOSTLIST_server_stop ()
688 #if DEBUG_HOSTLIST_SERVER
689 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
690 "Hostlist server shutdown\n");
694 GNUNET_PEERINFO_notify_cancel (notify);
697 if (GNUNET_SCHEDULER_NO_TASK != hostlist_task_v6)
699 GNUNET_SCHEDULER_cancel (hostlist_task_v6);
700 hostlist_task_v6 = GNUNET_SCHEDULER_NO_TASK;
702 if (GNUNET_SCHEDULER_NO_TASK != hostlist_task_v4)
704 GNUNET_SCHEDULER_cancel (hostlist_task_v4);
705 hostlist_task_v4 = GNUNET_SCHEDULER_NO_TASK;
709 GNUNET_PEERINFO_iterate_cancel (pitr);
712 if (NULL != daemon_handle_v4)
714 MHD_stop_daemon (daemon_handle_v4);
715 daemon_handle_v4 = NULL;
717 if (NULL != daemon_handle_v6)
719 MHD_stop_daemon (daemon_handle_v6);
720 daemon_handle_v6 = NULL;
722 if (response != NULL)
724 MHD_destroy_response (response);
727 if (peerinfo != NULL)
729 GNUNET_PEERINFO_disconnect (peerinfo);
737 /* end of hostlist-server.c */