2 This file is part of GNUnet
3 Copyright (C) 2002-2014, 2017 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file transport/plugin_transport_http_server.c
23 * @brief HTTP/S server transport plugin
24 * @author Matthias Wachs
25 * @author David Barksdale
26 * @author Christian Grothoff
29 #include "gnunet_util_lib.h"
30 #include "gnunet_statistics_service.h"
31 #include "gnunet_transport_plugin.h"
32 #include "gnunet_nat_service.h"
33 #include "plugin_transport_http_common.h"
34 #include <microhttpd.h>
40 #define PLUGIN_NAME "https_server"
41 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_https_server_init
42 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_https_server_done
44 #define PLUGIN_NAME "http_server"
45 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_http_server_init
46 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_http_server_done
49 #define HTTP_ERROR_RESPONSE "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\"><HTML><HEAD><TITLE>404 Not Found</TITLE></HEAD><BODY><H1>Not Found</H1>The requested URL was not found on this server.<P><HR><ADDRESS></ADDRESS></BODY></HTML>"
54 #define LOG(kind,...) GNUNET_log_from (kind, "transport-" PLUGIN_NAME,__VA_ARGS__)
58 * Information we keep with MHD for an HTTP request.
63 * The session this server request belongs to
64 * Can be NULL, when session was disconnected and freed
66 struct GNUNET_ATS_Session *session;
71 struct MHD_Connection *mhd_conn;
76 struct MHD_Daemon *mhd_daemon;
79 * Options requested by peer
82 #define OPTION_LONG_POLL 1 /* GET request wants long-poll semantics */
90 * For PUT requests: Is this the first or last callback with size 0
91 * For GET requests: Have we sent a message
104 * Wrapper to manage addresses
106 struct HttpAddressWrapper
111 struct HttpAddressWrapper *next;
114 * Linked list previous
116 struct HttpAddressWrapper *prev;
119 * An address we are using.
121 struct HttpAddress *address;
124 * Length of the address.
131 * Message to send using http
136 * next pointer for double linked list
138 struct HTTP_Message *next;
141 * previous pointer for double linked list
143 struct HTTP_Message *prev;
146 * buffer containing data to send
151 * amount of data already sent
161 * HTTP/S specific overhead
166 * Continuation function to call once the transmission buffer
167 * has again space available. NULL if there is no
168 * continuation to call.
170 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
173 * Closure for transmit_cont.
175 void *transmit_cont_cls;
180 * Session handle for connections.
182 struct GNUNET_ATS_Session
186 * To whom are we talking to (set to our identity
187 * if we are still waiting for the welcome message)
189 struct GNUNET_PeerIdentity target;
192 * Pointer to the global plugin struct.
194 struct HTTP_Server_Plugin *plugin;
197 * next pointer for double linked list
199 struct HTTP_Message *msg_head;
202 * previous pointer for double linked list
204 struct HTTP_Message *msg_tail;
207 * Message stream tokenizer for incoming data
209 struct GNUNET_MessageStreamTokenizer *msg_tk;
214 struct ServerRequest *server_recv;
219 struct ServerRequest *server_send;
224 struct GNUNET_HELLO_Address *address;
227 * Absolute time when to receive data again
228 * Used for receive throttling
230 struct GNUNET_TIME_Absolute next_receive;
233 * Absolute time when this connection will time out.
235 struct GNUNET_TIME_Absolute timeout;
238 * Session timeout task
240 struct GNUNET_SCHEDULER_Task * timeout_task;
243 * Task to resume MHD handling when receiving is allowed again
245 struct GNUNET_SCHEDULER_Task * recv_wakeup_task;
248 * Number of bytes waiting for transmission to this peer.
250 unsigned long long bytes_in_queue;
253 * Number of messages waiting for transmission to this peer.
255 unsigned int msgs_in_queue;
258 * Unique HTTP/S connection tag for this connection
265 enum GNUNET_ATS_Network_Type scope;
268 * #GNUNET_YES if this session is known to the service.
270 int known_to_service;
276 * Encapsulation of all of the state of the plugin.
278 struct HTTP_Server_Plugin
283 struct GNUNET_TRANSPORT_PluginEnvironment *env;
286 * Hash map of open sessions.
288 struct GNUNET_CONTAINER_MultiPeerMap *sessions;
291 * Function to call about session status changes.
293 GNUNET_TRANSPORT_SessionInfoCallback sic;
296 * Closure for @e sic.
313 char *external_hostname;
316 * External hostname the plugin can be connected to, can be different to
317 * the host's FQDN, used e.g. for reverse proxying
319 struct GNUNET_HELLO_Address *ext_addr;
322 * NAT handle & address management
324 struct GNUNET_NAT_Handle *nat;
327 * IPv4 addresses DLL head
329 struct HttpAddressWrapper *addr_head;
332 * IPv4 addresses DLL tail
334 struct HttpAddressWrapper *addr_tail;
337 * IPv4 server socket to bind to
339 struct sockaddr_in *server_addr_v4;
342 * IPv6 server socket to bind to
344 struct sockaddr_in6 *server_addr_v6;
349 struct MHD_Daemon *server_v4;
354 struct MHD_Daemon *server_v6;
362 * Use RC4-128 instead of AES:
363 * NONE:+VERS-TLS1.0:+ARCFOUR-128:+SHA1:+RSA:+COMP-NULL
382 struct GNUNET_SCHEDULER_Task *server_v4_task;
387 struct GNUNET_SCHEDULER_Task *server_v6_task;
390 * Task calling transport service about external address
392 struct GNUNET_SCHEDULER_Task *notify_ext_task;
395 * Notify transport only about external address
397 unsigned int external_only;
400 * The IPv4 server is scheduled to run asap
402 int server_v4_immediately;
405 * The IPv6 server is scheduled to run asap
407 int server_v6_immediately;
410 * Verify external address
412 int verify_external_hostname;
415 * Maximum number of sockets the plugin can use
416 * Each http request /request connections are two connections
418 unsigned int max_request;
421 * Current number of sockets the plugin can use
422 * Each http connection are two requests
424 unsigned int cur_request;
427 * Did we immediately end the session in disconnect_cb
437 * My options to be included in the address
457 * Regex for parsing URLs. FIXME: this seems overkill.
465 * If a session monitor is attached, notify it about the new
468 * @param plugin our plugin
469 * @param session session that changed state
470 * @param state new state of the session
473 notify_session_monitor (struct HTTP_Server_Plugin *plugin,
474 struct GNUNET_ATS_Session *session,
475 enum GNUNET_TRANSPORT_SessionState state)
477 struct GNUNET_TRANSPORT_SessionInfo info;
479 if (NULL == plugin->sic)
481 memset (&info, 0, sizeof (info));
483 info.is_inbound = GNUNET_YES;
484 info.num_msg_pending = session->msgs_in_queue;
485 info.num_bytes_pending = session->bytes_in_queue;
486 info.receive_delay = session->next_receive;
487 info.session_timeout = session->timeout;
488 info.address = session->address;
489 plugin->sic (plugin->sic_cls,
496 * Wake up an MHD connection which was suspended
498 * @param cls the session
501 server_wake_up (void *cls)
503 struct GNUNET_ATS_Session *s = cls;
505 s->recv_wakeup_task = NULL;
506 LOG (GNUNET_ERROR_TYPE_DEBUG,
507 "Session %p: Waking up PUT handle\n",
509 GNUNET_assert (s->server_recv->suspended);
510 MHD_resume_connection (s->server_recv->mhd_conn);
511 s->server_recv->suspended = false;
516 * Reschedule the execution of both IPv4 and IPv6 server.
518 * @param plugin the plugin
519 * @param server which server to schedule v4 or v6?
520 * @param now #GNUNET_YES to schedule execution immediately, #GNUNET_NO to wait
524 server_reschedule (struct HTTP_Server_Plugin *plugin,
525 struct MHD_Daemon *server,
530 * Deletes the session. Must not be used afterwards.
532 * @param s the session to delete
535 server_delete_session (struct GNUNET_ATS_Session *s)
537 struct HTTP_Server_Plugin *plugin = s->plugin;
538 struct HTTP_Message *msg;
540 if (NULL != s->timeout_task)
542 GNUNET_SCHEDULER_cancel (s->timeout_task);
543 s->timeout_task = NULL;
544 s->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
546 if (NULL != s->recv_wakeup_task)
548 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
549 s->recv_wakeup_task = NULL;
550 if (NULL != s->server_recv)
552 GNUNET_assert (s->server_recv->suspended);
553 s->server_recv->suspended = false;
554 MHD_resume_connection (s->server_recv->mhd_conn);
557 GNUNET_assert (GNUNET_OK ==
558 GNUNET_CONTAINER_multipeermap_remove (plugin->sessions,
561 while (NULL != (msg = s->msg_head))
563 GNUNET_CONTAINER_DLL_remove (s->msg_head,
566 if (NULL != msg->transmit_cont)
567 msg->transmit_cont (msg->transmit_cont_cls,
571 msg->pos + msg->overhead);
572 GNUNET_assert (s->msgs_in_queue > 0);
574 GNUNET_assert (s->bytes_in_queue >= msg->size);
575 s->bytes_in_queue -= msg->size;
579 GNUNET_assert (0 == s->msgs_in_queue);
580 GNUNET_assert (0 == s->bytes_in_queue);
582 if (NULL != s->server_send)
584 LOG (GNUNET_ERROR_TYPE_DEBUG,
585 "Server: %p / %p Terminating inbound PUT session to peer `%s'\n",
587 GNUNET_i2s (&s->target));
588 s->server_send->session = NULL;
589 MHD_set_connection_option (s->server_send->mhd_conn,
590 MHD_CONNECTION_OPTION_TIMEOUT,
591 1 /* 0 = no timeout, so this is MIN */);
592 if (s->server_send->suspended)
594 s->server_send->suspended = false;
595 MHD_resume_connection (s->server_send->mhd_conn);
597 server_reschedule (plugin,
598 s->server_send->mhd_daemon,
602 if (NULL != s->server_recv)
604 LOG (GNUNET_ERROR_TYPE_DEBUG,
605 "Server: %p / %p Terminating inbound GET session to peer `%s'\n",
606 s, s->server_recv, GNUNET_i2s (&s->target));
607 s->server_recv->session = NULL;
608 MHD_set_connection_option (s->server_recv->mhd_conn,
609 MHD_CONNECTION_OPTION_TIMEOUT,
610 1 /* 0 = no timeout, so this is MIN */);
611 server_reschedule (plugin,
612 s->server_recv->mhd_daemon,
615 notify_session_monitor (plugin,
617 GNUNET_TRANSPORT_SS_DONE);
618 if (GNUNET_YES == s->known_to_service)
620 plugin->env->session_end (plugin->env->cls,
623 s->known_to_service = GNUNET_NO;
625 if (NULL != s->msg_tk)
627 GNUNET_MST_destroy (s->msg_tk);
630 GNUNET_HELLO_address_free (s->address);
631 LOG (GNUNET_ERROR_TYPE_DEBUG,
632 "Session %p destroyed\n",
639 * Disconnect session @a s by telling MHD to close the
640 * connections (reducing timeout, etc.).
642 * @param cls closure with the `struct HTTP_Server_Plugin`
643 * @param s the session
644 * @return #GNUNET_OK on success
647 http_server_plugin_disconnect_session (void *cls,
648 struct GNUNET_ATS_Session *s)
650 server_delete_session (s);
656 * Session was idle, so disconnect it
658 * @param cls the session
661 server_session_timeout (void *cls)
663 struct GNUNET_ATS_Session *s = cls;
664 struct GNUNET_TIME_Relative left;
666 s->timeout_task = NULL;
667 left = GNUNET_TIME_absolute_get_remaining (s->timeout);
668 if (0 != left.rel_value_us)
670 /* not actually our turn yet, but let's at least update
671 the monitor, it may think we're about to die ... */
672 notify_session_monitor (s->plugin,
674 GNUNET_TRANSPORT_SS_UP);
675 s->timeout_task = GNUNET_SCHEDULER_add_delayed (left,
676 &server_session_timeout,
680 GNUNET_log (TIMEOUT_LOG,
681 "Session %p was idle for %s, disconnecting\n",
683 GNUNET_STRINGS_relative_time_to_string (HTTP_SERVER_SESSION_TIMEOUT,
685 server_delete_session (s);
690 * Increment session timeout due to activity session @a s
692 * @param s the session
695 server_reschedule_session_timeout (struct GNUNET_ATS_Session *s)
697 GNUNET_assert (NULL != s->timeout_task);
698 s->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
703 * Function that can be used by the transport service to transmit
704 * a message using the plugin. Note that in the case of a
705 * peer disconnecting, the continuation MUST be called
706 * prior to the disconnect notification itself. This function
707 * will be called with this peer's HELLO message to initiate
708 * a fresh connection to another peer.
711 * @param session which session must be used
712 * @param msgbuf the message to transmit
713 * @param msgbuf_size number of bytes in @a msgbuf
714 * @param priority how important is the message (most plugins will
715 * ignore message priority and just FIFO)
716 * @param to how long to wait at most for the transmission (does not
717 * require plugins to discard the message after the timeout,
718 * just advisory for the desired delay; most plugins will ignore
720 * @param cont continuation to call once the message has
721 * been transmitted (or if the transport is ready
722 * for the next transmission call; or if the
723 * peer disconnected...); can be NULL
724 * @param cont_cls closure for @a cont
725 * @return number of bytes used (on the physical network, with overheads);
726 * -1 on hard errors (i.e. address invalid); 0 is a legal value
727 * and does NOT mean that the message was not transmitted (DV)
730 http_server_plugin_send (void *cls,
731 struct GNUNET_ATS_Session *session,
734 unsigned int priority,
735 struct GNUNET_TIME_Relative to,
736 GNUNET_TRANSPORT_TransmitContinuation cont,
739 struct HTTP_Server_Plugin *plugin = cls;
740 struct HTTP_Message *msg;
741 ssize_t bytes_sent = 0;
744 LOG (GNUNET_ERROR_TYPE_DEBUG,
745 "Session %p/request %p: Sending message with %u to peer `%s'\n",
747 session->server_send,
749 GNUNET_i2s (&session->target));
751 /* create new message and schedule */
752 bytes_sent = sizeof (struct HTTP_Message) + msgbuf_size;
753 msg = GNUNET_malloc (bytes_sent);
755 msg->size = msgbuf_size;
757 msg->buf = (char *) &msg[1];
758 msg->transmit_cont = cont;
759 msg->transmit_cont_cls = cont_cls;
760 GNUNET_memcpy (msg->buf,
763 GNUNET_CONTAINER_DLL_insert_tail (session->msg_head,
766 session->msgs_in_queue++;
767 session->bytes_in_queue += msg->size;
768 notify_session_monitor (plugin,
770 GNUNET_TRANSPORT_SS_UP);
771 GNUNET_asprintf (&stat_txt,
772 "# bytes currently in %s_server buffers",
774 GNUNET_STATISTICS_update (plugin->env->stats,
775 stat_txt, msgbuf_size, GNUNET_NO);
776 GNUNET_free (stat_txt);
778 if (NULL != session->server_send)
780 if (session->server_send->suspended)
782 MHD_resume_connection (session->server_send->mhd_conn);
783 session->server_send->suspended = false;
785 server_reschedule (session->plugin,
786 session->server_send->mhd_daemon,
794 * Terminate session during shutdown.
796 * @param cls the `struct HTTP_Server_Plugin *`
797 * @param peer for which this is a session
798 * @param value the `struct GNUNET_ATS_Session` to clean up
799 * @return #GNUNET_OK (continue to iterate)
802 destroy_session_shutdown_cb (void *cls,
803 const struct GNUNET_PeerIdentity *peer,
806 struct GNUNET_ATS_Session *s = value;
807 struct ServerRequest *sc_send;
808 struct ServerRequest *sc_recv;
810 sc_send = s->server_send;
811 sc_recv = s->server_recv;
812 server_delete_session (s);
814 sc_send->session = NULL;
816 sc_recv->session = NULL;
825 * @param cls the `struct HTTP_Server_Plugin *`
826 * @param peer for which this is a session
827 * @param value the `struct GNUNET_ATS_Session` to clean up
828 * @return #GNUNET_OK (continue to iterate)
831 destroy_session_cb (void *cls,
832 const struct GNUNET_PeerIdentity *peer,
835 struct GNUNET_ATS_Session *s = value;
837 server_delete_session (s);
843 * Function that can be used to force the plugin to disconnect
844 * from the given peer and cancel all previous transmissions
845 * (and their continuationc).
848 * @param target peer from which to disconnect
851 http_server_plugin_disconnect_peer (void *cls,
852 const struct GNUNET_PeerIdentity *target)
854 struct HTTP_Server_Plugin *plugin = cls;
856 LOG (GNUNET_ERROR_TYPE_DEBUG,
857 "Transport tells me to disconnect `%s'\n",
858 GNUNET_i2s (target));
859 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
867 * Another peer has suggested an address for this
868 * peer and transport plugin. Check that this could be a valid
869 * address. If so, consider adding it to the list
873 * @param addr pointer to the address
874 * @param addrlen length of @a addr
875 * @return #GNUNET_OK if this is a plausible address for this peer
879 http_server_plugin_address_suggested (void *cls,
883 struct HTTP_Server_Plugin *plugin = cls;
884 struct HttpAddressWrapper *next;
885 struct HttpAddressWrapper *pos;
886 const struct HttpAddress *haddr = addr;
888 if ((NULL != plugin->ext_addr) &&
889 GNUNET_YES == (http_common_cmp_addresses (addr, addrlen,
890 plugin->ext_addr->address,
891 plugin->ext_addr->address_length)))
893 /* Checking HTTP_OPTIONS_VERIFY_CERTIFICATE option for external hostname */
894 if ((ntohl (haddr->options) & HTTP_OPTIONS_VERIFY_CERTIFICATE) !=
895 (plugin->options & HTTP_OPTIONS_VERIFY_CERTIFICATE))
896 return GNUNET_NO; /* VERIFY option not set as required! */
899 next = plugin->addr_head;
900 while (NULL != (pos = next))
903 if (GNUNET_YES == (http_common_cmp_addresses(addr,
914 * Creates a new outbound session the transport
915 * service will use to send data to the peer.
917 * Since HTTP/S server cannot create sessions, always returns NULL.
919 * @param cls the plugin
920 * @param address the address
921 * @return always NULL
923 static struct GNUNET_ATS_Session *
924 http_server_plugin_get_session (void *cls,
925 const struct GNUNET_HELLO_Address *address)
932 * Call MHD IPv4 to process pending requests and then go back
933 * and schedule the next run.
935 * @param cls plugin as closure
938 server_v4_run (void *cls)
940 struct HTTP_Server_Plugin *plugin = cls;
942 plugin->server_v4_task = NULL;
943 plugin->server_v4_immediately = GNUNET_NO;
944 GNUNET_assert (MHD_YES == MHD_run (plugin->server_v4));
945 server_reschedule (plugin, plugin->server_v4, GNUNET_NO);
950 * Call MHD IPv6 to process pending requests and then go back
951 * and schedule the next run.
953 * @param cls plugin as closure
956 server_v6_run (void *cls)
958 struct HTTP_Server_Plugin *plugin = cls;
960 plugin->server_v6_task = NULL;
961 plugin->server_v6_immediately = GNUNET_NO;
962 GNUNET_assert (MHD_YES == MHD_run (plugin->server_v6));
963 server_reschedule (plugin, plugin->server_v6, GNUNET_NO);
968 * Function that queries MHD's select sets and
969 * starts the task waiting for them.
971 * @param plugin plugin
972 * @param daemon_handle the MHD daemon handle
973 * @param now schedule now
974 * @return gnunet task identifier
976 static struct GNUNET_SCHEDULER_Task *
977 server_schedule (struct HTTP_Server_Plugin *plugin,
978 struct MHD_Daemon *daemon_handle,
981 struct GNUNET_SCHEDULER_Task * ret;
985 struct GNUNET_NETWORK_FDSet *wrs;
986 struct GNUNET_NETWORK_FDSet *wws;
988 MHD_UNSIGNED_LONG_LONG timeout;
989 static unsigned long long last_timeout = 0;
991 struct GNUNET_TIME_Relative tv;
993 if (GNUNET_YES == plugin->in_shutdown)
1000 wrs = GNUNET_NETWORK_fdset_create ();
1001 wws = GNUNET_NETWORK_fdset_create ();
1003 GNUNET_assert (MHD_YES ==
1004 MHD_get_fdset (daemon_handle,
1009 haveto = MHD_get_timeout (daemon_handle, &timeout);
1010 if (haveto == MHD_YES)
1012 if (timeout != last_timeout)
1014 LOG (GNUNET_ERROR_TYPE_DEBUG,
1015 "SELECT Timeout changed from %llu to %llu (ms)\n",
1016 last_timeout, timeout);
1017 last_timeout = timeout;
1019 if (timeout <= GNUNET_TIME_UNIT_SECONDS.rel_value_us / 1000LL)
1020 tv.rel_value_us = (uint64_t) timeout * 1000LL;
1022 tv = GNUNET_TIME_UNIT_SECONDS;
1025 tv = GNUNET_TIME_UNIT_SECONDS;
1026 /* Force immediate run, since we have outbound data to send */
1027 if (now == GNUNET_YES)
1028 tv = GNUNET_TIME_UNIT_MILLISECONDS;
1029 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
1030 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
1032 if (daemon_handle == plugin->server_v4)
1034 if (plugin->server_v4_task != NULL)
1036 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
1037 plugin->server_v4_task = NULL;
1040 LOG (GNUNET_ERROR_TYPE_DEBUG,
1041 "Scheduling IPv4 server task in %llu ms\n",
1045 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1047 &server_v4_run, plugin);
1049 if (daemon_handle == plugin->server_v6)
1051 if (plugin->server_v6_task != NULL)
1053 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
1054 plugin->server_v6_task = NULL;
1057 LOG (GNUNET_ERROR_TYPE_DEBUG,
1058 "Scheduling IPv6 server task in %llu ms\n", tv);
1061 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1063 &server_v6_run, plugin);
1065 GNUNET_NETWORK_fdset_destroy (wrs);
1066 GNUNET_NETWORK_fdset_destroy (wws);
1072 * Reschedule the execution of both IPv4 and IPv6 server
1074 * @param plugin the plugin
1075 * @param server which server to schedule v4 or v6?
1076 * @param now #GNUNET_YES to schedule execution immediately, #GNUNET_NO to wait
1080 server_reschedule (struct HTTP_Server_Plugin *plugin,
1081 struct MHD_Daemon *server,
1084 if ((server == plugin->server_v4) && (plugin->server_v4 != NULL))
1086 if (GNUNET_YES == plugin->server_v4_immediately)
1087 return; /* No rescheduling, server will run asap */
1089 if (GNUNET_YES == now)
1090 plugin->server_v4_immediately = GNUNET_YES;
1092 if (plugin->server_v4_task != NULL)
1094 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
1095 plugin->server_v4_task = NULL;
1097 plugin->server_v4_task = server_schedule (plugin, plugin->server_v4, now);
1100 if ((server == plugin->server_v6) && (plugin->server_v6 != NULL))
1102 if (GNUNET_YES == plugin->server_v6_immediately)
1103 return; /* No rescheduling, server will run asap */
1105 if (GNUNET_YES == now)
1106 plugin->server_v6_immediately = GNUNET_YES;
1108 if (plugin->server_v6_task != NULL)
1110 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
1111 plugin->server_v6_task = NULL;
1113 plugin->server_v6_task = server_schedule (plugin, plugin->server_v6, now);
1119 * Function that is called to get the keepalive factor.
1120 * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
1121 * calculate the interval between keepalive packets.
1123 * @param cls closure with the `struct HTTP_Server_Plugin`
1124 * @return keepalive factor
1127 http_server_query_keepalive_factor (void *cls)
1134 * Function that will be called whenever the transport service wants to
1135 * notify the plugin that a session is still active and in use and
1136 * therefore the session timeout for this session has to be updated
1138 * @param cls closure
1139 * @param peer which peer was the session for
1140 * @param session which session is being updated
1143 http_server_plugin_update_session_timeout (void *cls,
1144 const struct GNUNET_PeerIdentity *peer,
1145 struct GNUNET_ATS_Session *session)
1147 server_reschedule_session_timeout (session);
1152 * Tell MHD that the connection should timeout after @a to seconds.
1154 * @param plugin our plugin
1155 * @param s session for which the timeout changes
1156 * @param to timeout in seconds
1159 server_mhd_connection_timeout (struct HTTP_Server_Plugin *plugin,
1160 struct GNUNET_ATS_Session *s,
1163 /* Setting timeouts for other connections */
1164 if (NULL != s->server_recv)
1166 LOG (GNUNET_ERROR_TYPE_DEBUG,
1167 "Setting timeout for %p to %u sec.\n",
1168 s->server_recv, to);
1169 MHD_set_connection_option (s->server_recv->mhd_conn,
1170 MHD_CONNECTION_OPTION_TIMEOUT,
1172 server_reschedule (plugin, s->server_recv->mhd_daemon, GNUNET_NO);
1174 if (NULL != s->server_send)
1176 LOG (GNUNET_ERROR_TYPE_DEBUG,
1177 "Setting timeout for %p to %u sec.\n",
1178 s->server_send, to);
1179 MHD_set_connection_option (s->server_send->mhd_conn,
1180 MHD_CONNECTION_OPTION_TIMEOUT,
1182 server_reschedule (plugin, s->server_send->mhd_daemon, GNUNET_NO);
1188 * Parse incoming URL for tag and target
1190 * @param plugin plugin
1191 * @param url incoming url
1192 * @param target where to store the target
1193 * @param tag where to store the tag
1194 * @param options where to store the options
1195 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1198 server_parse_url (struct HTTP_Server_Plugin *plugin,
1200 struct GNUNET_PeerIdentity *target,
1204 regmatch_t matches[4];
1205 const char *tag_start;
1206 const char *target_start;
1210 unsigned long int rc;
1214 ("^.*/([0-9A-Z]+);([0-9]+)(,[0-9]+)?$")
1219 return GNUNET_SYSERR;
1222 if (regexec(&plugin->url_regex, url, 4, matches, 0))
1224 LOG (GNUNET_ERROR_TYPE_DEBUG,
1225 "URL `%s' did not match regex\n", url);
1226 return GNUNET_SYSERR;
1229 target_start = &url[matches[1].rm_so];
1230 tag_start = &url[matches[2].rm_so];
1233 rc = strtoul (tag_start, &tag_end, 10);
1234 if (&url[matches[2].rm_eo] != tag_end)
1236 LOG (GNUNET_ERROR_TYPE_DEBUG,
1237 "URL tag did not line up with submatch\n");
1238 return GNUNET_SYSERR;
1242 LOG (GNUNET_ERROR_TYPE_DEBUG,
1243 "URL tag is zero\n");
1244 return GNUNET_SYSERR;
1246 if ((rc == ULONG_MAX) && (ERANGE == errno))
1248 LOG (GNUNET_ERROR_TYPE_DEBUG,
1249 "URL tag > ULONG_MAX\n");
1250 return GNUNET_SYSERR;
1252 if (rc > UINT32_MAX)
1254 LOG (GNUNET_ERROR_TYPE_DEBUG,
1255 "URL tag > UINT32_MAX\n");
1256 return GNUNET_SYSERR;
1258 (*tag) = (uint32_t)rc;
1259 LOG (GNUNET_ERROR_TYPE_DEBUG,
1260 "Found tag `%u' in url\n",
1263 /* convert peer id */
1264 hash_length = matches[1].rm_eo - matches[1].rm_so;
1265 if (hash_length != plugin->peer_id_length)
1267 LOG (GNUNET_ERROR_TYPE_DEBUG,
1268 "URL target is %u bytes, expecting %u\n",
1269 hash_length, plugin->peer_id_length);
1270 return GNUNET_SYSERR;
1273 GNUNET_CRYPTO_eddsa_public_key_from_string (target_start,
1275 &target->public_key))
1277 LOG (GNUNET_ERROR_TYPE_DEBUG,
1278 "URL target conversion failed\n");
1279 return GNUNET_SYSERR;
1281 LOG (GNUNET_ERROR_TYPE_DEBUG,
1282 "Found target `%s' in URL\n",
1283 GNUNET_i2s_full (target));
1285 /* convert options */
1286 if (-1 == matches[3].rm_so)
1292 rc = strtoul (&url[matches[3].rm_so + 1], &options_end, 10);
1293 if (&url[matches[3].rm_eo] != options_end)
1295 LOG (GNUNET_ERROR_TYPE_DEBUG,
1296 "URL options did not line up with submatch\n");
1297 return GNUNET_SYSERR;
1299 if ((rc == ULONG_MAX) && (ERANGE == errno))
1301 LOG (GNUNET_ERROR_TYPE_DEBUG,
1302 "URL options > ULONG_MAX\n");
1303 return GNUNET_SYSERR;
1305 if (rc > UINT32_MAX)
1307 LOG (GNUNET_ERROR_TYPE_DEBUG,
1308 "URL options > UINT32_MAX\n");
1309 return GNUNET_SYSERR;
1311 (*options) = (uint32_t) rc;
1312 LOG (GNUNET_ERROR_TYPE_DEBUG,
1313 "Found options `%u' in url\n",
1321 * Closure for #session_tag_it().
1323 struct GNUNET_ATS_SessionTagContext
1326 * Set to session matching the tag.
1328 struct GNUNET_ATS_Session *res;
1331 * Tag we are looking for.
1338 * Find a session with a matching tag.
1340 * @param cls the `struct GNUNET_ATS_SessionTagContext *`
1341 * @param key peer identity (unused)
1342 * @param value the `struct GNUNET_ATS_Session *`
1343 * @return #GNUNET_NO if we found the session, #GNUNET_OK if not
1346 session_tag_it (void *cls,
1347 const struct GNUNET_PeerIdentity *key,
1350 struct GNUNET_ATS_SessionTagContext *stc = cls;
1351 struct GNUNET_ATS_Session *s = value;
1353 if (s->tag == stc->tag)
1363 * Lookup a mhd connection and create one if none is found
1365 * @param plugin the plugin handle
1366 * @param mhd_connection the incoming mhd_connection
1367 * @param url incoming requested URL
1368 * @param method PUT or GET
1369 * @return the server connecetion
1371 static struct ServerRequest *
1372 server_lookup_connection (struct HTTP_Server_Plugin *plugin,
1373 struct MHD_Connection *mhd_connection,
1377 struct GNUNET_ATS_Session *s = NULL;
1378 struct ServerRequest *sc = NULL;
1379 const union MHD_ConnectionInfo *conn_info;
1380 struct HttpAddress *addr;
1381 struct GNUNET_PeerIdentity target;
1383 struct GNUNET_ATS_SessionTagContext stc;
1385 int direction = GNUNET_SYSERR;
1387 enum GNUNET_ATS_Network_Type scope;
1389 conn_info = MHD_get_connection_info (mhd_connection,
1390 MHD_CONNECTION_INFO_CLIENT_ADDRESS);
1391 if ((conn_info->client_addr->sa_family != AF_INET) &&
1392 (conn_info->client_addr->sa_family != AF_INET6))
1394 LOG (GNUNET_ERROR_TYPE_DEBUG,
1395 "New %s request from %s\n",
1399 options = 0; /* make gcc happy */
1400 if (GNUNET_SYSERR ==
1401 server_parse_url (plugin, url, &target, &stc.tag, &options))
1403 LOG (GNUNET_ERROR_TYPE_DEBUG,
1404 "Invalid url %s\n", url);
1407 if (0 == strcmp (MHD_HTTP_METHOD_PUT, method))
1408 direction = _RECEIVE;
1409 else if (0 == strcmp (MHD_HTTP_METHOD_GET, method))
1413 LOG (GNUNET_ERROR_TYPE_DEBUG,
1414 "Invalid method %s for request from %s\n",
1419 plugin->cur_request++;
1420 LOG (GNUNET_ERROR_TYPE_DEBUG,
1421 "New %s request from %s with tag %u (%u of %u)\n",
1423 GNUNET_i2s (&target),
1425 plugin->cur_request, plugin->max_request);
1426 /* find existing session */
1428 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
1432 if (NULL == (s = stc.res))
1434 /* create new session */
1436 switch (conn_info->client_addr->sa_family)
1439 addr = http_common_address_from_socket (plugin->protocol,
1440 conn_info->client_addr,
1441 sizeof (struct sockaddr_in));
1442 addr_len = http_common_address_get_size (addr);
1443 scope = plugin->env->get_address_type (plugin->env->cls,
1444 conn_info->client_addr,
1445 sizeof (struct sockaddr_in));
1448 addr = http_common_address_from_socket (plugin->protocol,
1449 conn_info->client_addr,
1450 sizeof (struct sockaddr_in6));
1451 addr_len = http_common_address_get_size (addr);
1452 scope = plugin->env->get_address_type (plugin->env->cls,
1453 conn_info->client_addr,
1454 sizeof (struct sockaddr_in6));
1457 /* external host name */
1460 s = GNUNET_new (struct GNUNET_ATS_Session);
1464 s->address = GNUNET_HELLO_address_allocate (&s->target,
1468 GNUNET_HELLO_ADDRESS_INFO_INBOUND);
1469 s->next_receive = GNUNET_TIME_UNIT_ZERO_ABS;
1471 s->timeout = GNUNET_TIME_relative_to_absolute (HTTP_SERVER_SESSION_TIMEOUT);
1472 s->timeout_task = GNUNET_SCHEDULER_add_delayed (HTTP_SERVER_SESSION_TIMEOUT,
1473 &server_session_timeout,
1475 (void) GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
1478 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1479 notify_session_monitor (plugin,
1481 GNUNET_TRANSPORT_SS_INIT);
1482 notify_session_monitor (plugin,
1484 GNUNET_TRANSPORT_SS_HANDSHAKE);
1485 LOG (GNUNET_ERROR_TYPE_DEBUG,
1486 "Creating new session %p for peer `%s' connecting from `%s'\n",
1487 s, GNUNET_i2s (&target),
1488 http_common_plugin_address_to_string (plugin->protocol,
1491 GNUNET_free_non_null (addr);
1494 if ( (_RECEIVE == direction) &&
1495 (NULL != s->server_recv) )
1497 LOG (GNUNET_ERROR_TYPE_DEBUG,
1498 "Duplicate PUT request from `%s' tag %u, dismissing new request\n",
1499 GNUNET_i2s (&target),
1503 if ((_SEND == direction) && (NULL != s->server_send))
1505 LOG (GNUNET_ERROR_TYPE_DEBUG,
1506 "Duplicate GET request from `%s' tag %u, dismissing new request\n",
1507 GNUNET_i2s (&target),
1511 sc = GNUNET_new (struct ServerRequest);
1512 if (conn_info->client_addr->sa_family == AF_INET)
1513 sc->mhd_daemon = plugin->server_v4;
1514 if (conn_info->client_addr->sa_family == AF_INET6)
1515 sc->mhd_daemon = plugin->server_v6;
1516 sc->mhd_conn = mhd_connection;
1517 sc->direction = direction;
1518 sc->connected = GNUNET_NO;
1520 sc->options = options;
1521 if (direction == _SEND)
1523 s->server_send = sc;
1525 if (direction == _RECEIVE)
1527 s->server_recv = sc;
1530 if ((GNUNET_NO == s->known_to_service) &&
1531 (NULL != s->server_send) &&
1532 (NULL != s->server_recv) )
1534 s->known_to_service = GNUNET_YES;
1535 notify_session_monitor (plugin,
1537 GNUNET_TRANSPORT_SS_UP);
1538 plugin->env->session_start (plugin->env->cls,
1544 to = (HTTP_SERVER_SESSION_TIMEOUT.rel_value_us / 1000LL / 1000LL);
1545 server_mhd_connection_timeout (plugin, s, to);
1551 * Callback called by MHD when it needs data to send
1553 * @param cls current session
1554 * @param pos position in buffer
1555 * @param buf the buffer to write data to
1556 * @param max max number of bytes available in @a buf
1557 * @return bytes written to @a buf
1560 server_send_callback (void *cls,
1565 struct ServerRequest *sc = cls;
1566 struct GNUNET_ATS_Session *s = sc->session;
1567 ssize_t bytes_read = 0;
1568 struct HTTP_Message *msg;
1573 /* session is disconnecting */
1577 sc = s->server_send;
1584 bytes_read = GNUNET_MIN (msg->size - msg->pos,
1586 GNUNET_memcpy (buf, &msg->buf[msg->pos], bytes_read);
1587 msg->pos += bytes_read;
1589 /* removing message */
1590 if (msg->pos == msg->size)
1592 GNUNET_CONTAINER_DLL_remove (s->msg_head,
1595 if (NULL != msg->transmit_cont)
1596 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK,
1597 msg->size, msg->size + msg->overhead);
1598 GNUNET_assert (s->msgs_in_queue > 0);
1600 GNUNET_assert (s->bytes_in_queue >= msg->size);
1601 s->bytes_in_queue -= msg->size;
1603 notify_session_monitor (s->plugin,
1605 GNUNET_TRANSPORT_SS_UPDATE);
1610 sc->connected = GNUNET_YES;
1611 LOG (GNUNET_ERROR_TYPE_DEBUG,
1612 "Sent %u bytes to peer `%s' with session %p \n",
1614 GNUNET_i2s (&s->target),
1616 GNUNET_asprintf (&stat_txt,
1617 "# bytes currently in %s_server buffers",
1618 s->plugin->protocol);
1619 GNUNET_STATISTICS_update (s->plugin->env->stats,
1623 GNUNET_free (stat_txt);
1624 GNUNET_asprintf (&stat_txt,
1625 "# bytes transmitted via %s_server",
1626 s->plugin->protocol);
1627 GNUNET_STATISTICS_update (s->plugin->env->stats,
1628 stat_txt, bytes_read, GNUNET_NO);
1629 GNUNET_free (stat_txt);
1631 else if ((sc->options & OPTION_LONG_POLL) && sc->connected)
1633 LOG (GNUNET_ERROR_TYPE_DEBUG,
1634 "Completing GET response to peer `%s' with session %p\n",
1635 GNUNET_i2s (&s->target),
1637 return MHD_CONTENT_READER_END_OF_STREAM;
1641 MHD_suspend_connection (s->server_send->mhd_conn);
1642 s->server_send->suspended = true;
1650 * Callback called by MessageStreamTokenizer when a message has arrived
1652 * @param cls current session as closure
1653 * @param message the message to be forwarded to transport service
1654 * @return #GNUNET_OK (all OK)
1657 server_receive_mst_cb (void *cls,
1658 const struct GNUNET_MessageHeader *message)
1660 struct GNUNET_ATS_Session *s = cls;
1661 struct HTTP_Server_Plugin *plugin = s->plugin;
1662 struct GNUNET_TIME_Relative delay;
1665 if (GNUNET_NO == s->known_to_service)
1667 s->known_to_service = GNUNET_YES;
1668 plugin->env->session_start (plugin->env->cls,
1672 notify_session_monitor (plugin,
1674 GNUNET_TRANSPORT_SS_UP);
1676 delay = plugin->env->receive (plugin->env->cls,
1680 GNUNET_asprintf (&stat_txt,
1681 "# bytes received via %s_server",
1683 GNUNET_STATISTICS_update (plugin->env->stats,
1685 ntohs (message->size),
1687 GNUNET_free (stat_txt);
1688 s->next_receive = GNUNET_TIME_relative_to_absolute (delay);
1689 if (delay.rel_value_us > 0)
1691 LOG (GNUNET_ERROR_TYPE_DEBUG,
1692 "Peer `%s' address `%s' next read delayed for %s\n",
1693 GNUNET_i2s (&s->target),
1694 http_common_plugin_address_to_string (plugin->protocol,
1695 s->address->address,
1696 s->address->address_length),
1697 GNUNET_STRINGS_relative_time_to_string (delay,
1700 server_reschedule_session_timeout (s);
1706 * Add headers to a request indicating that we allow Cross-Origin Resource
1709 * @param response response object to modify
1712 add_cors_headers(struct MHD_Response *response)
1714 MHD_add_response_header (response,
1715 "Access-Control-Allow-Origin",
1717 MHD_add_response_header (response,
1718 "Access-Control-Allow-Methods",
1719 "GET, PUT, OPTIONS");
1720 MHD_add_response_header (response,
1721 "Access-Control-Max-Age",
1727 * MHD callback for a new incoming connection
1729 * @param cls the plugin handle
1730 * @param mhd_connection the mhd connection
1731 * @param url the requested URL
1732 * @param method GET or PUT
1733 * @param version HTTP version
1734 * @param upload_data upload data
1735 * @param upload_data_size size of @a upload_data
1736 * @param httpSessionCache the session cache to remember the connection
1737 * @return MHD_YES if connection is accepted, MHD_NO on reject
1740 server_access_cb (void *cls,
1741 struct MHD_Connection *mhd_connection,
1744 const char *version,
1745 const char *upload_data,
1746 size_t *upload_data_size,
1747 void **httpSessionCache)
1749 struct HTTP_Server_Plugin *plugin = cls;
1750 struct ServerRequest *sc = *httpSessionCache;
1751 struct GNUNET_ATS_Session *s;
1752 struct MHD_Response *response;
1755 LOG (GNUNET_ERROR_TYPE_DEBUG,
1756 _("Access from connection %p (%u of %u) for `%s' `%s' url `%s' with upload data size %u\n"),
1758 plugin->cur_request,
1759 plugin->max_request,
1763 (*upload_data_size));
1766 /* CORS pre-flight request */
1767 if (0 == strcmp (MHD_HTTP_METHOD_OPTIONS, method))
1769 response = MHD_create_response_from_buffer (0, NULL,
1770 MHD_RESPMEM_PERSISTENT);
1771 add_cors_headers(response);
1772 res = MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1773 MHD_destroy_response (response);
1776 /* new connection */
1777 sc = server_lookup_connection (plugin, mhd_connection, url, method);
1780 /* attach to new / existing session */
1781 (*httpSessionCache) = sc;
1785 /* existing session already has matching connection, refuse */
1786 response = MHD_create_response_from_buffer (strlen (HTTP_ERROR_RESPONSE),
1787 HTTP_ERROR_RESPONSE,
1788 MHD_RESPMEM_PERSISTENT);
1789 MHD_add_response_header (response,
1790 MHD_HTTP_HEADER_CONTENT_TYPE,
1792 add_cors_headers(response);
1793 res = MHD_queue_response (mhd_connection, MHD_HTTP_NOT_FOUND, response);
1794 MHD_destroy_response (response);
1798 /* 'old' connection */
1799 if (NULL == (s = sc->session))
1801 /* Session was already disconnected;
1802 sent HTTP/1.1: 200 OK as response */
1803 response = MHD_create_response_from_buffer (strlen ("Thank you!"),
1805 MHD_RESPMEM_PERSISTENT);
1806 add_cors_headers(response);
1807 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1808 MHD_destroy_response (response);
1812 if (sc->direction == _SEND)
1814 response = MHD_create_response_from_callback (MHD_SIZE_UNKNOWN, 32 * 1024,
1815 &server_send_callback, sc, NULL);
1816 add_cors_headers(response);
1817 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1818 MHD_destroy_response (response);
1821 if (sc->direction == _RECEIVE)
1823 if ((*upload_data_size == 0) && (sc->connected == GNUNET_NO))
1825 /* (*upload_data_size == 0) first callback when header are passed */
1826 LOG (GNUNET_ERROR_TYPE_DEBUG,
1827 "Session %p / Connection %p: Peer `%s' PUT on address `%s' connected\n",
1829 GNUNET_i2s (&s->target),
1830 http_common_plugin_address_to_string (plugin->protocol,
1831 s->address->address,
1832 s->address->address_length));
1833 sc->connected = GNUNET_YES;
1836 else if ((*upload_data_size == 0) && (sc->connected == GNUNET_YES))
1838 /* (*upload_data_size == 0) when upload is complete */
1839 LOG (GNUNET_ERROR_TYPE_DEBUG,
1840 "Session %p / Connection %p: Peer `%s' PUT on address `%s' finished upload\n",
1842 GNUNET_i2s (&s->target),
1843 http_common_plugin_address_to_string (plugin->protocol,
1844 s->address->address,
1845 s->address->address_length));
1846 sc->connected = GNUNET_NO;
1847 /* Sent HTTP/1.1: 200 OK as PUT Response\ */
1848 response = MHD_create_response_from_buffer (strlen ("Thank you!"),
1850 MHD_RESPMEM_PERSISTENT);
1851 add_cors_headers(response);
1852 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1853 MHD_destroy_response (response);
1856 else if ((*upload_data_size > 0) && (sc->connected == GNUNET_YES))
1858 struct GNUNET_TIME_Relative delay;
1860 /* (*upload_data_size > 0) for every segment received */
1861 LOG (GNUNET_ERROR_TYPE_DEBUG,
1862 "Session %p / Connection %p: Peer `%s' PUT on address `%s' received %u bytes\n",
1864 GNUNET_i2s (&s->target),
1865 http_common_plugin_address_to_string (plugin->protocol,
1866 s->address->address,
1867 s->address->address_length),
1869 delay = GNUNET_TIME_absolute_get_remaining (s->next_receive);
1870 if (0 == delay.rel_value_us)
1872 LOG (GNUNET_ERROR_TYPE_DEBUG,
1873 "PUT with %u bytes forwarded to MST\n",
1875 if (s->msg_tk == NULL)
1877 s->msg_tk = GNUNET_MST_create (&server_receive_mst_cb,
1880 GNUNET_MST_from_buffer (s->msg_tk,
1883 GNUNET_NO, GNUNET_NO);
1884 server_mhd_connection_timeout (plugin, s,
1885 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value_us / 1000LL
1887 (*upload_data_size) = 0;
1891 /* delay processing */
1892 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1893 "Session %p / Connection %p: no inbound bandwidth available! Next read was delayed by %s\n",
1896 GNUNET_STRINGS_relative_time_to_string (delay,
1898 GNUNET_assert(s->server_recv->mhd_conn == mhd_connection);
1899 MHD_suspend_connection (s->server_recv->mhd_conn);
1900 s->server_recv->suspended = true;
1901 if (NULL == s->recv_wakeup_task)
1903 = GNUNET_SCHEDULER_add_delayed (delay,
1920 * Callback from MHD when a connection disconnects
1922 * @param cls closure with the `struct HTTP_Server_Plugin *`
1923 * @param connection the disconnected MHD connection
1924 * @param httpSessionCache the pointer to distinguish
1927 server_disconnect_cb (void *cls,
1928 struct MHD_Connection *connection,
1929 void **httpSessionCache)
1931 struct HTTP_Server_Plugin *plugin = cls;
1932 struct ServerRequest *sc = *httpSessionCache;
1934 LOG (GNUNET_ERROR_TYPE_DEBUG,
1935 "Disconnect for connection %p\n",
1939 /* CORS pre-flight request finished */
1943 if (NULL != sc->session)
1945 if (sc->direction == _SEND)
1947 LOG (GNUNET_ERROR_TYPE_DEBUG,
1948 "Peer `%s' connection %p, GET on address `%s' disconnected\n",
1949 GNUNET_i2s (&sc->session->target),
1950 sc->session->server_send,
1951 http_common_plugin_address_to_string (plugin->protocol,
1952 sc->session->address->address,
1953 sc->session->address->address_length));
1955 sc->session->server_send = NULL;
1957 else if (sc->direction == _RECEIVE)
1959 LOG (GNUNET_ERROR_TYPE_DEBUG,
1960 "Peer `%s' connection %p PUT on address `%s' disconnected\n",
1961 GNUNET_i2s (&sc->session->target),
1962 sc->session->server_recv,
1963 http_common_plugin_address_to_string (plugin->protocol,
1964 sc->session->address->address,
1965 sc->session->address->address_length));
1966 sc->session->server_recv = NULL;
1967 if (NULL != sc->session->msg_tk)
1969 GNUNET_MST_destroy (sc->session->msg_tk);
1970 sc->session->msg_tk = NULL;
1975 plugin->cur_request--;
1980 * Callback from MHD when a connection starts/stops
1982 * @param cls closure with the `struct HTTP_Server_Plugin *`
1983 * @param connection connection handle
1984 * @param socket_context socket-specific pointer
1985 * @param toe reason for connection notification
1986 * @see #MHD_OPTION_NOTIFY_CONNECTION
1989 server_connection_cb (void *cls,
1990 struct MHD_Connection *connection,
1991 void **socket_context,
1992 enum MHD_ConnectionNotificationCode toe)
1994 struct HTTP_Server_Plugin *plugin = cls;
1995 const union MHD_ConnectionInfo *info;
1997 if (MHD_CONNECTION_NOTIFY_STARTED == toe)
2000 /* Reschedule to remove closed socket from our select set */
2001 info = MHD_get_connection_info (connection,
2002 MHD_CONNECTION_INFO_DAEMON);
2003 GNUNET_assert (NULL != info);
2004 server_reschedule (plugin,
2011 * Check if incoming connection is accepted.
2013 * @param cls plugin as closure
2014 * @param addr address of incoming connection
2015 * @param addr_len number of bytes in @a addr
2016 * @return MHD_YES if connection is accepted, MHD_NO if connection is rejected
2019 server_accept_cb (void *cls,
2020 const struct sockaddr *addr,
2023 struct HTTP_Server_Plugin *plugin = cls;
2025 if (plugin->cur_request <= plugin->max_request)
2027 LOG (GNUNET_ERROR_TYPE_DEBUG,
2028 _("Accepting connection (%u of %u) from `%s'\n"),
2029 plugin->cur_request, plugin->max_request,
2030 GNUNET_a2s (addr, addr_len));
2035 LOG (GNUNET_ERROR_TYPE_WARNING,
2036 _("Server reached maximum number connections (%u), rejecting new connection\n"),
2037 plugin->max_request);
2044 * Log function called by MHD.
2047 * @param fmt format string
2048 * @param ap arguments for the format string (va_start() and va_end()
2049 * will be called by MHD)
2052 server_log (void *arg,
2062 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2070 * Load ssl certificate from file
2072 * @param file filename
2073 * @return content of the file
2076 server_load_file (const char *file)
2078 struct GNUNET_DISK_FileHandle *gn_file;
2082 if (GNUNET_OK != GNUNET_DISK_file_size (file,
2083 &fsize, GNUNET_NO, GNUNET_YES))
2085 text = GNUNET_malloc (fsize + 1);
2087 GNUNET_DISK_file_open (file, GNUNET_DISK_OPEN_READ,
2088 GNUNET_DISK_PERM_USER_READ);
2089 if (NULL == gn_file)
2094 if (GNUNET_SYSERR == GNUNET_DISK_file_read (gn_file, text, fsize))
2097 GNUNET_DISK_file_close (gn_file);
2101 GNUNET_DISK_file_close (gn_file);
2109 * Load ssl certificate
2111 * @param plugin the plugin
2112 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2115 server_load_certificate (struct HTTP_Server_Plugin *plugin)
2117 int res = GNUNET_OK;
2123 GNUNET_CONFIGURATION_get_value_filename (plugin->env->cfg,
2125 "KEY_FILE", &key_file))
2127 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2128 plugin->name, "CERT_FILE");
2129 return GNUNET_SYSERR;
2132 GNUNET_CONFIGURATION_get_value_filename (plugin->env->cfg,
2134 "CERT_FILE", &cert_file))
2136 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2137 plugin->name, "CERT_FILE");
2138 GNUNET_free (key_file);
2139 return GNUNET_SYSERR;
2141 /* Get crypto init string from config. If not present, use
2144 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2147 &plugin->crypto_init))
2148 LOG (GNUNET_ERROR_TYPE_DEBUG,
2149 "Using crypto init string `%s'\n",
2150 plugin->crypto_init);
2152 LOG (GNUNET_ERROR_TYPE_DEBUG,
2153 "Using default crypto init string \n");
2155 /* read key & certificates from file */
2156 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2157 "Trying to loading TLS certificate from key-file `%s' cert-file`%s'\n",
2158 key_file, cert_file);
2160 plugin->key = server_load_file (key_file);
2161 plugin->cert = server_load_file (cert_file);
2163 if ((plugin->key == NULL) || (plugin->cert == NULL))
2165 struct GNUNET_OS_Process *cert_creation;
2167 GNUNET_free_non_null (plugin->key);
2169 GNUNET_free_non_null (plugin->cert);
2170 plugin->cert = NULL;
2172 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2173 "No usable TLS certificate found, creating certificate\n");
2176 GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
2178 "gnunet-transport-certificate-creation",
2179 "gnunet-transport-certificate-creation",
2183 if (NULL == cert_creation)
2185 LOG (GNUNET_ERROR_TYPE_ERROR,
2186 _("Could not create a new TLS certificate, program `gnunet-transport-certificate-creation' could not be started!\n"));
2187 GNUNET_free (key_file);
2188 GNUNET_free (cert_file);
2190 GNUNET_free_non_null (plugin->key);
2192 GNUNET_free_non_null (plugin->cert);
2193 plugin->cert = NULL;
2194 GNUNET_free_non_null (plugin->crypto_init);
2195 plugin->crypto_init = NULL;
2197 return GNUNET_SYSERR;
2199 GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (cert_creation));
2200 GNUNET_OS_process_destroy (cert_creation);
2202 plugin->key = server_load_file (key_file);
2203 plugin->cert = server_load_file (cert_file);
2206 if ((plugin->key == NULL) || (plugin->cert == NULL))
2208 LOG (GNUNET_ERROR_TYPE_ERROR,
2209 _("No usable TLS certificate found and creating one at `%s/%s' failed!\n"),
2210 key_file, cert_file);
2211 GNUNET_free (key_file);
2212 GNUNET_free (cert_file);
2214 GNUNET_free_non_null (plugin->key);
2216 GNUNET_free_non_null (plugin->cert);
2217 plugin->cert = NULL;
2218 GNUNET_free_non_null (plugin->crypto_init);
2219 plugin->crypto_init = NULL;
2221 return GNUNET_SYSERR;
2223 GNUNET_free (key_file);
2224 GNUNET_free (cert_file);
2225 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2226 "TLS certificate loaded\n");
2233 * Invoke `MHD_start_daemon` with the various options we need to
2234 * setup the HTTP server with the given listen address.
2236 * @param plugin our plugin
2237 * @param addr listen address to use
2238 * @param v6 MHD_NO_FLAG or MHD_USE_IPv6, depending on context
2239 * @return NULL on error
2241 static struct MHD_Daemon *
2242 run_mhd_start_daemon (struct HTTP_Server_Plugin *plugin,
2243 const struct sockaddr_in *addr,
2246 struct MHD_Daemon *server;
2247 unsigned int timeout;
2249 #if MHD_VERSION >= 0x00090E00
2250 timeout = HTTP_SERVER_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL / 1000LL;
2251 LOG (GNUNET_ERROR_TYPE_DEBUG,
2252 "MHD can set timeout per connection! Default time out %u sec.\n",
2255 timeout = HTTP_SERVER_SESSION_TIMEOUT.rel_value_us / 1000LL / 1000LL;
2256 LOG (GNUNET_ERROR_TYPE_WARNING,
2257 "MHD cannot set timeout per connection! Default time out %u sec.\n",
2260 server = MHD_start_daemon (
2267 MHD_USE_SUSPEND_RESUME |
2270 &server_accept_cb, plugin,
2271 &server_access_cb, plugin,
2272 MHD_OPTION_SOCK_ADDR,
2274 MHD_OPTION_CONNECTION_LIMIT,
2275 (unsigned int) plugin->max_request,
2277 MHD_OPTION_HTTPS_PRIORITIES,
2278 plugin->crypto_init,
2279 MHD_OPTION_HTTPS_MEM_KEY,
2281 MHD_OPTION_HTTPS_MEM_CERT,
2284 MHD_OPTION_CONNECTION_TIMEOUT,
2286 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
2288 GNUNET_MAX_MESSAGE_SIZE),
2289 MHD_OPTION_NOTIFY_COMPLETED,
2290 &server_disconnect_cb, plugin,
2291 MHD_OPTION_NOTIFY_CONNECTION,
2292 &server_connection_cb, plugin,
2293 MHD_OPTION_EXTERNAL_LOGGER,
2297 if ( (NULL != server) &&
2298 (0 != (plugin->options & HTTP_OPTIONS_TCP_STEALTH)) )
2300 const union MHD_DaemonInfo *di;
2302 di = MHD_get_daemon_info (server,
2303 MHD_DAEMON_INFO_LISTEN_FD,
2305 if ( (0 != setsockopt ((int) di->listen_fd,
2308 plugin->env->my_identity,
2309 sizeof (struct GNUNET_PeerIdentity))) )
2311 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2312 _("TCP_STEALTH not supported on this platform.\n"));
2313 MHD_stop_daemon (server);
2323 * Start the HTTP server
2325 * @param plugin the plugin handle
2326 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2329 server_start (struct HTTP_Server_Plugin *plugin)
2333 GNUNET_assert (NULL != plugin);
2335 if (GNUNET_SYSERR == server_load_certificate (plugin))
2337 LOG (GNUNET_ERROR_TYPE_ERROR,
2338 _("Could not load or create server certificate! Loading plugin failed!\n"));
2339 return GNUNET_SYSERR;
2345 plugin->server_v4 = NULL;
2346 if (GNUNET_YES == plugin->use_ipv4)
2349 = run_mhd_start_daemon (plugin,
2350 (const struct sockaddr_in *) plugin->server_addr_v4,
2353 if (NULL == plugin->server_v4)
2355 LOG (GNUNET_ERROR_TYPE_ERROR,
2356 "Failed to start %s IPv4 server component on port %u\n",
2361 server_reschedule (plugin,
2367 plugin->server_v6 = NULL;
2368 if (GNUNET_YES == plugin->use_ipv6)
2371 = run_mhd_start_daemon (plugin,
2372 (const struct sockaddr_in *) plugin->server_addr_v6,
2374 if (NULL == plugin->server_v6)
2376 LOG (GNUNET_ERROR_TYPE_ERROR,
2377 "Failed to start %s IPv6 server component on port %u\n",
2383 server_reschedule (plugin,
2389 if ( (NULL == plugin->server_v6) &&
2390 (NULL == plugin->server_v4) )
2392 LOG (GNUNET_ERROR_TYPE_ERROR,
2393 "%s %s server component started on port %u\n",
2397 return GNUNET_SYSERR;
2399 if ((NULL != plugin->server_v6) &&
2400 (NULL != plugin->server_v4))
2401 msg = "IPv4 and IPv6";
2402 else if (NULL != plugin->server_v6)
2404 else if (NULL != plugin->server_v4)
2406 LOG (GNUNET_ERROR_TYPE_DEBUG,
2407 "%s %s server component started on port %u\n",
2416 * Add an address to the server's set of addresses and notify transport
2418 * @param cls the plugin handle
2419 * @param add_remove #GNUNET_YES on add, #GNUNET_NO on remove
2420 * @param addr the address
2421 * @param addrlen address length
2424 server_add_address (void *cls,
2426 const struct sockaddr *addr,
2429 struct HTTP_Server_Plugin *plugin = cls;
2430 struct GNUNET_HELLO_Address *address;
2431 struct HttpAddressWrapper *w = NULL;
2433 w = GNUNET_new (struct HttpAddressWrapper);
2434 w->address = http_common_address_from_socket (plugin->protocol,
2437 if (NULL == w->address)
2442 w->addrlen = http_common_address_get_size (w->address);
2444 GNUNET_CONTAINER_DLL_insert (plugin->addr_head,
2447 LOG (GNUNET_ERROR_TYPE_DEBUG,
2448 "Notifying transport to add address `%s'\n",
2449 http_common_plugin_address_to_string (plugin->protocol,
2452 /* modify our published address list */
2454 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2455 "https_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2457 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2458 "http_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2461 plugin->env->notify_address (plugin->env->cls,
2464 GNUNET_HELLO_address_free (address);
2469 * Remove an address from the server's set of addresses and notify transport
2471 * @param cls the plugin handle
2472 * @param add_remove #GNUNET_YES on add, #GNUNET_NO on remove
2473 * @param addr the address
2474 * @param addrlen address length
2477 server_remove_address (void *cls,
2479 const struct sockaddr *addr,
2482 struct HTTP_Server_Plugin *plugin = cls;
2483 struct GNUNET_HELLO_Address *address;
2484 struct HttpAddressWrapper *w = plugin->addr_head;
2488 saddr = http_common_address_from_socket (plugin->protocol,
2493 saddr_len = http_common_address_get_size (saddr);
2498 http_common_cmp_addresses (w->address,
2505 GNUNET_free (saddr);
2510 LOG (GNUNET_ERROR_TYPE_DEBUG,
2511 "Notifying transport to remove address `%s'\n",
2512 http_common_plugin_address_to_string (plugin->protocol,
2515 GNUNET_CONTAINER_DLL_remove (plugin->addr_head,
2518 /* modify our published address list */
2520 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2521 "https_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2523 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2524 "http_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2526 plugin->env->notify_address (plugin->env->cls, add_remove, address);
2527 GNUNET_HELLO_address_free (address);
2528 GNUNET_free (w->address);
2535 * Our external IP address/port mapping has changed.
2537 * @param cls closure, the 'struct LocalAddrList'
2538 * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
2539 * the previous (now invalid) one
2540 * @param ac address class the address belongs to
2541 * @param addr either the previous or the new public IP address
2542 * @param addrlen actual lenght of the address
2545 server_nat_port_map_callback (void *cls,
2547 enum GNUNET_NAT_AddressClass ac,
2548 const struct sockaddr *addr,
2551 struct HTTP_Server_Plugin *plugin = cls;
2553 LOG (GNUNET_ERROR_TYPE_DEBUG,
2554 "NAT called to %s address `%s'\n",
2555 (add_remove == GNUNET_NO) ? "remove" : "add",
2556 GNUNET_a2s (addr, addrlen));
2558 if (AF_INET == addr->sa_family)
2560 struct sockaddr_in *s4 = (struct sockaddr_in *) addr;
2562 if (GNUNET_NO == plugin->use_ipv4)
2565 if ((NULL != plugin->server_addr_v4) &&
2566 (0 != memcmp (&plugin->server_addr_v4->sin_addr,
2568 sizeof (struct in_addr))))
2570 LOG (GNUNET_ERROR_TYPE_DEBUG,
2571 "Skipping address `%s' (not bindto address)\n",
2572 GNUNET_a2s (addr, addrlen));
2577 if (AF_INET6 == addr->sa_family)
2579 struct sockaddr_in6 *s6 = (struct sockaddr_in6 *) addr;
2580 if (GNUNET_NO == plugin->use_ipv6)
2583 if ((NULL != plugin->server_addr_v6) &&
2584 (0 != memcmp (&plugin->server_addr_v6->sin6_addr,
2585 &s6->sin6_addr, sizeof (struct in6_addr))))
2587 LOG (GNUNET_ERROR_TYPE_DEBUG,
2588 "Skipping address `%s' (not bindto address)\n",
2589 GNUNET_a2s (addr, addrlen));
2597 server_add_address (cls, add_remove, addr, addrlen);
2600 server_remove_address (cls, add_remove, addr, addrlen);
2607 * Get valid server addresses
2609 * @param plugin the plugin handle
2610 * @param service_name the servicename
2611 * @param cfg configuration handle
2612 * @param addrs addresses
2613 * @param addr_lens address length
2614 * @return number of addresses
2617 server_get_addresses (struct HTTP_Server_Plugin *plugin,
2618 const char *service_name,
2619 const struct GNUNET_CONFIGURATION_Handle *cfg,
2620 struct sockaddr ***addrs,
2621 socklen_t ** addr_lens)
2624 unsigned long long port;
2625 struct addrinfo hints;
2626 struct addrinfo *res;
2627 struct addrinfo *pos;
2628 struct addrinfo *next;
2632 struct sockaddr **saddrs;
2633 socklen_t *saddrlens;
2639 disablev6 = !plugin->use_ipv6;
2642 if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT"))
2644 GNUNET_break (GNUNET_OK ==
2645 GNUNET_CONFIGURATION_get_value_number (cfg, service_name,
2649 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2650 _("Require valid port number for service in configuration!\n"));
2651 return GNUNET_SYSERR;
2656 LOG (GNUNET_ERROR_TYPE_INFO,
2657 "Starting in listen only mode\n");
2658 return -1; /* listen only */
2662 if (GNUNET_CONFIGURATION_have_value (cfg, service_name,
2665 GNUNET_break (GNUNET_OK ==
2666 GNUNET_CONFIGURATION_get_value_string (cfg, service_name,
2667 "BINDTO", &hostname));
2672 if (NULL != hostname)
2674 LOG (GNUNET_ERROR_TYPE_DEBUG,
2675 "Resolving `%s' since that is where `%s' will bind to.\n",
2676 hostname, service_name);
2677 memset (&hints, 0, sizeof (struct addrinfo));
2679 hints.ai_family = AF_INET;
2680 if ((0 != (ret = getaddrinfo (hostname, NULL, &hints, &res))) ||
2683 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2684 _("Failed to resolve `%s': %s\n"),
2686 gai_strerror (ret));
2687 GNUNET_free (hostname);
2688 return GNUNET_SYSERR;
2692 while (NULL != (pos = next))
2694 next = pos->ai_next;
2695 if ((disablev6) && (pos->ai_family == AF_INET6))
2701 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2702 _("Failed to find %saddress for `%s'.\n"),
2703 disablev6 ? "IPv4 " : "", hostname);
2705 GNUNET_free (hostname);
2706 return GNUNET_SYSERR;
2709 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2710 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2713 while (NULL != (pos = next))
2715 next = pos->ai_next;
2716 if ((disablev6) && (pos->ai_family == AF_INET6))
2718 if ((pos->ai_protocol != IPPROTO_TCP) && (0 != pos->ai_protocol))
2719 continue; /* not TCP */
2720 if ((pos->ai_socktype != SOCK_STREAM) && (0 != pos->ai_socktype))
2721 continue; /* huh? */
2722 LOG (GNUNET_ERROR_TYPE_DEBUG,
2723 "Service will bind to `%s'\n",
2724 GNUNET_a2s (pos->ai_addr,
2726 if (pos->ai_family == AF_INET)
2728 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
2729 saddrlens[i] = pos->ai_addrlen;
2730 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2731 GNUNET_memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
2732 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2736 GNUNET_assert (pos->ai_family == AF_INET6);
2737 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
2738 saddrlens[i] = pos->ai_addrlen;
2739 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2740 GNUNET_memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
2741 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
2745 GNUNET_free (hostname);
2751 /* will bind against everything, just set port */
2757 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2758 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2760 saddrlens[i] = sizeof (struct sockaddr_in);
2761 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2762 #if HAVE_SOCKADDR_IN_SIN_LEN
2763 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
2765 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
2766 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2772 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2773 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2775 saddrlens[i] = sizeof (struct sockaddr_in6);
2776 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2777 #if HAVE_SOCKADDR_IN_SIN_LEN
2778 ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
2780 ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
2781 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
2783 saddrlens[i] = sizeof (struct sockaddr_in);
2784 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2785 #if HAVE_SOCKADDR_IN_SIN_LEN
2786 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
2788 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
2789 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2793 *addr_lens = saddrlens;
2799 * Ask NAT for addresses
2801 * @param plugin the plugin handle
2804 server_start_report_addresses (struct HTTP_Server_Plugin *plugin)
2806 int res = GNUNET_OK;
2807 struct sockaddr **addrs;
2808 socklen_t *addrlens;
2810 res = server_get_addresses (plugin,
2814 LOG (GNUNET_ERROR_TYPE_DEBUG,
2815 _("Found %u addresses to report to NAT service\n"),
2818 if (GNUNET_SYSERR == res)
2825 = GNUNET_NAT_register (plugin->env->cfg,
2826 "transport-http_server",
2829 (const struct sockaddr **) addrs,
2831 &server_nat_port_map_callback,
2837 GNUNET_assert (NULL != addrs[res]);
2838 GNUNET_free (addrs[res]);
2840 GNUNET_free_non_null (addrs);
2841 GNUNET_free_non_null (addrlens);
2846 * Stop NAT for addresses
2848 * @param plugin the plugin handle
2851 server_stop_report_addresses (struct HTTP_Server_Plugin *plugin)
2853 struct HttpAddressWrapper *w;
2855 /* Stop NAT handle */
2856 if (NULL != plugin->nat)
2858 GNUNET_NAT_unregister (plugin->nat);
2861 /* Clean up addresses */
2862 while (NULL != plugin->addr_head)
2864 w = plugin->addr_head;
2865 GNUNET_CONTAINER_DLL_remove (plugin->addr_head,
2868 GNUNET_free (w->address);
2875 * Check if IPv6 supported on this system
2877 * @param plugin the plugin handle
2878 * @return #GNUNET_YES on success, else #GNUNET_NO
2881 server_check_ipv6_support (struct HTTP_Server_Plugin *plugin)
2883 struct GNUNET_NETWORK_Handle *desc = NULL;
2884 int res = GNUNET_NO;
2886 /* Probe IPv6 support */
2887 desc = GNUNET_NETWORK_socket_create (PF_INET6,
2892 if ( (errno == ENOBUFS) ||
2893 (errno == ENOMEM) ||
2894 (errno == ENFILE) ||
2897 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
2900 LOG (GNUNET_ERROR_TYPE_WARNING,
2901 _("Disabling IPv6 since it is not supported on this system!\n"));
2906 GNUNET_break (GNUNET_OK ==
2907 GNUNET_NETWORK_socket_close (desc));
2911 LOG (GNUNET_ERROR_TYPE_DEBUG,
2912 "Testing IPv6 on this system: %s\n",
2913 (res == GNUNET_YES) ? "successful" : "failed");
2919 * Notify server about our external hostname
2924 server_notify_external_hostname (void *cls)
2926 struct HTTP_Server_Plugin *plugin = cls;
2927 struct HttpAddress *ext_addr;
2928 size_t ext_addr_len;
2932 plugin->notify_ext_task = NULL;
2933 GNUNET_asprintf (&url,
2936 plugin->external_hostname);
2937 urlen = strlen (url) + 1;
2938 ext_addr = GNUNET_malloc (sizeof (struct HttpAddress) + urlen);
2939 ext_addr->options = htonl (plugin->options);
2940 ext_addr->urlen = htonl (urlen);
2941 ext_addr_len = sizeof (struct HttpAddress) + urlen;
2942 GNUNET_memcpy (&ext_addr[1], url, urlen);
2945 LOG (GNUNET_ERROR_TYPE_DEBUG,
2946 "Notifying transport about external hostname address `%s'\n",
2947 plugin->external_hostname);
2950 if (GNUNET_YES == plugin->verify_external_hostname)
2951 LOG (GNUNET_ERROR_TYPE_INFO,
2952 "Enabling SSL verification for external hostname address `%s'\n",
2953 plugin->external_hostname);
2955 = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2959 GNUNET_HELLO_ADDRESS_INFO_NONE);
2960 plugin->env->notify_address (plugin->env->cls,
2963 GNUNET_free (ext_addr);
2966 = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2970 GNUNET_HELLO_ADDRESS_INFO_NONE);
2971 plugin->env->notify_address (plugin->env->cls,
2974 GNUNET_free (ext_addr);
2980 * Configure the plugin
2982 * @param plugin plugin handle
2983 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2986 server_configure_plugin (struct HTTP_Server_Plugin *plugin)
2988 unsigned long long port;
2989 unsigned long long max_connections;
2990 char *bind4_address = NULL;
2991 char *bind6_address = NULL;
2992 char *eh_tmp = NULL;
2993 int external_hostname_use_port;
2996 if (GNUNET_CONFIGURATION_have_value
2997 (plugin->env->cfg, plugin->name, "USE_IPv4"))
3000 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3005 plugin->use_ipv4 = GNUNET_YES;
3006 LOG (GNUNET_ERROR_TYPE_DEBUG,
3007 _("IPv4 support is %s\n"),
3008 (plugin->use_ipv4 == GNUNET_YES) ? "enabled" : "disabled");
3011 if (GNUNET_CONFIGURATION_have_value
3012 (plugin->env->cfg, plugin->name, "USE_IPv6"))
3015 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3020 plugin->use_ipv6 = GNUNET_YES;
3021 LOG (GNUNET_ERROR_TYPE_DEBUG,
3022 _("IPv6 support is %s\n"),
3023 (plugin->use_ipv6 == GNUNET_YES) ? "enabled" : "disabled");
3025 if ((plugin->use_ipv4 == GNUNET_NO) && (plugin->use_ipv6 == GNUNET_NO))
3027 LOG (GNUNET_ERROR_TYPE_ERROR,
3028 _("Neither IPv4 nor IPv6 are enabled! Fix in configuration\n"));
3029 return GNUNET_SYSERR;
3032 /* Reading port number from config file */
3034 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
3036 "PORT", &port)) || (port > 65535))
3038 LOG (GNUNET_ERROR_TYPE_ERROR,
3039 _("Port is required! Fix in configuration\n"));
3040 return GNUNET_SYSERR;
3042 plugin->port = port;
3044 LOG (GNUNET_ERROR_TYPE_INFO,
3045 _("Using port %u\n"), plugin->port);
3047 if ( (plugin->use_ipv4 == GNUNET_YES) &&
3049 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
3054 LOG (GNUNET_ERROR_TYPE_DEBUG,
3055 "Binding %s plugin to specific IPv4 address: `%s'\n",
3058 plugin->server_addr_v4 = GNUNET_new (struct sockaddr_in);
3059 if (1 != inet_pton (AF_INET,
3061 &plugin->server_addr_v4->sin_addr))
3063 LOG (GNUNET_ERROR_TYPE_ERROR,
3064 _("Specific IPv4 address `%s' in configuration file is invalid!\n"),
3066 GNUNET_free (bind4_address);
3067 GNUNET_free (plugin->server_addr_v4);
3068 plugin->server_addr_v4 = NULL;
3069 return GNUNET_SYSERR;
3073 LOG (GNUNET_ERROR_TYPE_DEBUG,
3074 "Binding to IPv4 address %s\n",
3076 plugin->server_addr_v4->sin_family = AF_INET;
3077 plugin->server_addr_v4->sin_port = htons (plugin->port);
3079 GNUNET_free (bind4_address);
3082 if ((plugin->use_ipv6 == GNUNET_YES) &&
3084 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
3089 LOG (GNUNET_ERROR_TYPE_DEBUG,
3090 "Binding %s plugin to specific IPv6 address: `%s'\n",
3091 plugin->protocol, bind6_address);
3092 plugin->server_addr_v6 = GNUNET_new (struct sockaddr_in6);
3094 inet_pton (AF_INET6,
3096 &plugin->server_addr_v6->sin6_addr))
3098 LOG (GNUNET_ERROR_TYPE_ERROR,
3099 _("Specific IPv6 address `%s' in configuration file is invalid!\n"),
3101 GNUNET_free (bind6_address);
3102 GNUNET_free (plugin->server_addr_v6);
3103 plugin->server_addr_v6 = NULL;
3104 return GNUNET_SYSERR;
3108 LOG (GNUNET_ERROR_TYPE_DEBUG,
3109 "Binding to IPv6 address %s\n",
3111 plugin->server_addr_v6->sin6_family = AF_INET6;
3112 plugin->server_addr_v6->sin6_port = htons (plugin->port);
3114 GNUNET_free (bind6_address);
3117 plugin->verify_external_hostname = GNUNET_NO;
3119 plugin->verify_external_hostname
3120 = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3122 "VERIFY_EXTERNAL_HOSTNAME");
3123 if (GNUNET_SYSERR == plugin->verify_external_hostname)
3124 plugin->verify_external_hostname = GNUNET_NO;
3125 if (GNUNET_YES == plugin->verify_external_hostname)
3126 plugin->options |= HTTP_OPTIONS_VERIFY_CERTIFICATE;
3128 external_hostname_use_port
3129 = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3131 "EXTERNAL_HOSTNAME_USE_PORT");
3132 if (GNUNET_SYSERR == external_hostname_use_port)
3133 external_hostname_use_port = GNUNET_NO;
3137 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
3139 "EXTERNAL_HOSTNAME",
3144 char *pos_url = NULL;
3146 if (NULL != strstr(eh_tmp, "://"))
3147 tmp = &strstr(eh_tmp, "://")[3];
3151 if (GNUNET_YES == external_hostname_use_port)
3153 if ( (strlen (tmp) > 1) && (NULL != (pos = strchr(tmp, '/'))) )
3157 GNUNET_asprintf (&plugin->external_hostname,
3164 GNUNET_asprintf (&plugin->external_hostname,
3170 plugin->external_hostname = GNUNET_strdup (tmp);
3171 GNUNET_free (eh_tmp);
3173 LOG (GNUNET_ERROR_TYPE_INFO,
3174 _("Using external hostname `%s'\n"),
3175 plugin->external_hostname);
3176 plugin->notify_ext_task = GNUNET_SCHEDULER_add_now (&server_notify_external_hostname,
3179 /* Use only configured external hostname */
3180 if (GNUNET_CONFIGURATION_have_value
3183 "EXTERNAL_HOSTNAME_ONLY"))
3185 plugin->external_only =
3186 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3188 "EXTERNAL_HOSTNAME_ONLY");
3191 plugin->external_only = GNUNET_NO;
3193 if (GNUNET_YES == plugin->external_only)
3194 LOG (GNUNET_ERROR_TYPE_DEBUG,
3195 _("Notifying transport only about hostname `%s'\n"),
3196 plugin->external_hostname);
3199 LOG (GNUNET_ERROR_TYPE_DEBUG,
3200 "No external hostname configured\n");
3202 /* Optional parameters */
3204 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
3208 max_connections = 128;
3209 plugin->max_request = max_connections;
3211 LOG (GNUNET_ERROR_TYPE_DEBUG,
3212 _("Maximum number of connections is %u\n"),
3213 plugin->max_request);
3215 plugin->peer_id_length = strlen (GNUNET_i2s_full (plugin->env->my_identity));
3222 * Exit point from the plugin.
3228 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
3230 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
3231 struct HTTP_Server_Plugin *plugin = api->cls;
3233 if (NULL == api->cls)
3235 /* Free for stub mode */
3239 plugin->in_shutdown = GNUNET_YES;
3240 LOG (GNUNET_ERROR_TYPE_INFO,
3241 _("Shutting down plugin `%s'\n"),
3244 if (NULL != plugin->notify_ext_task)
3246 GNUNET_SCHEDULER_cancel (plugin->notify_ext_task);
3247 plugin->notify_ext_task = NULL;
3250 if (NULL != plugin->ext_addr)
3252 LOG (GNUNET_ERROR_TYPE_DEBUG,
3253 "Notifying transport to remove address `%s'\n",
3254 http_common_plugin_address_to_string (plugin->protocol,
3255 plugin->ext_addr->address,
3256 plugin->ext_addr->address_length));
3258 plugin->env->notify_address (plugin->env->cls,
3262 plugin->env->notify_address (plugin->env->cls,
3266 GNUNET_HELLO_address_free (plugin->ext_addr);
3267 plugin->ext_addr = NULL;
3270 /* Stop to report addresses to transport service */
3271 server_stop_report_addresses (plugin);
3272 if (NULL != plugin->server_v4_task)
3274 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
3275 plugin->server_v4_task = NULL;
3278 if (NULL != plugin->server_v6_task)
3280 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
3281 plugin->server_v6_task = NULL;
3284 GNUNET_free_non_null (plugin->crypto_init);
3285 GNUNET_free_non_null (plugin->cert);
3286 GNUNET_free_non_null (plugin->key);
3288 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
3289 &destroy_session_shutdown_cb,
3291 GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
3292 plugin->sessions = NULL;
3293 if (NULL != plugin->server_v4)
3295 MHD_stop_daemon (plugin->server_v4);
3296 plugin->server_v4 = NULL;
3298 if (NULL != plugin->server_v6)
3300 MHD_stop_daemon (plugin->server_v6);
3301 plugin->server_v6 = NULL;
3304 GNUNET_free_non_null (plugin->external_hostname);
3305 GNUNET_free_non_null (plugin->ext_addr);
3306 GNUNET_free_non_null (plugin->server_addr_v4);
3307 GNUNET_free_non_null (plugin->server_addr_v6);
3308 regfree (&plugin->url_regex);
3310 LOG (GNUNET_ERROR_TYPE_DEBUG,
3311 _("Shutdown for plugin `%s' complete\n"),
3314 GNUNET_free (plugin);
3321 * Function called for a quick conversion of the binary address to
3322 * a numeric address. Note that the caller must not free the
3323 * address and that the next call to this function is allowed
3324 * to override the address again.
3327 * @param addr binary address
3328 * @param addrlen length of the address
3329 * @return string representing the same address
3332 http_server_plugin_address_to_string (void *cls,
3336 return http_common_plugin_address_to_string (PLUGIN_NAME,
3343 * Function obtain the network type for a session
3345 * @param cls closure (`struct HTTP_Server_Plugin *`)
3346 * @param session the session
3347 * @return the network type in HBO or #GNUNET_SYSERR
3349 static enum GNUNET_ATS_Network_Type
3350 http_server_plugin_get_network (void *cls,
3351 struct GNUNET_ATS_Session *session)
3353 return session->scope;
3358 * Function obtain the network type for an address.
3360 * @param cls closure (`struct Plugin *`)
3361 * @param address the address
3362 * @return the network type
3364 static enum GNUNET_ATS_Network_Type
3365 http_server_plugin_get_network_for_address (void *cls,
3366 const struct GNUNET_HELLO_Address *address)
3368 struct HTTP_Server_Plugin *plugin = cls;
3370 return http_common_get_network_for_address (plugin->env,
3376 * Function that will be called whenever the transport service wants to
3377 * notify the plugin that the inbound quota changed and that the plugin
3378 * should update it's delay for the next receive value
3380 * @param cls closure
3381 * @param peer which peer was the session for
3382 * @param session which session is being updated
3383 * @param delay new delay to use for receiving
3386 http_server_plugin_update_inbound_delay (void *cls,
3387 const struct GNUNET_PeerIdentity *peer,
3388 struct GNUNET_ATS_Session *session,
3389 struct GNUNET_TIME_Relative delay)
3391 session->next_receive = GNUNET_TIME_relative_to_absolute (delay);
3392 LOG (GNUNET_ERROR_TYPE_DEBUG,
3393 "New inbound delay %s\n",
3394 GNUNET_STRINGS_relative_time_to_string (delay,
3396 if (NULL != session->recv_wakeup_task)
3398 GNUNET_SCHEDULER_cancel (session->recv_wakeup_task);
3399 session->recv_wakeup_task
3400 = GNUNET_SCHEDULER_add_delayed (delay,
3408 * Return information about the given session to the
3411 * @param cls the `struct Plugin` with the monitor callback (`sic`)
3412 * @param peer peer we send information about
3413 * @param value our `struct GNUNET_ATS_Session` to send information about
3414 * @return #GNUNET_OK (continue to iterate)
3417 send_session_info_iter (void *cls,
3418 const struct GNUNET_PeerIdentity *peer,
3421 struct HTTP_Server_Plugin *plugin = cls;
3422 struct GNUNET_ATS_Session *session = value;
3424 notify_session_monitor (plugin,
3426 GNUNET_TRANSPORT_SS_INIT);
3432 * Begin monitoring sessions of a plugin. There can only
3433 * be one active monitor per plugin (i.e. if there are
3434 * multiple monitors, the transport service needs to
3435 * multiplex the generated events over all of them).
3437 * @param cls closure of the plugin
3438 * @param sic callback to invoke, NULL to disable monitor;
3439 * plugin will being by iterating over all active
3440 * sessions immediately and then enter monitor mode
3441 * @param sic_cls closure for @a sic
3444 http_server_plugin_setup_monitor (void *cls,
3445 GNUNET_TRANSPORT_SessionInfoCallback sic,
3448 struct HTTP_Server_Plugin *plugin = cls;
3451 plugin->sic_cls = sic_cls;
3454 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
3455 &send_session_info_iter,
3457 /* signal end of first iteration */
3458 sic (sic_cls, NULL, NULL);
3464 * Entry point for the plugin.
3470 LIBGNUNET_PLUGIN_TRANSPORT_INIT (void *cls)
3472 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
3473 struct GNUNET_TRANSPORT_PluginFunctions *api;
3474 struct HTTP_Server_Plugin *plugin;
3476 if (NULL == env->receive)
3478 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
3479 initialze the plugin or the API */
3480 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3482 api->address_to_string = &http_server_plugin_address_to_string;
3483 api->string_to_address = &http_common_plugin_string_to_address;
3484 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
3487 plugin = GNUNET_new (struct HTTP_Server_Plugin);
3489 plugin->sessions = GNUNET_CONTAINER_multipeermap_create (128,
3492 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3494 api->send = &http_server_plugin_send;
3495 api->disconnect_peer = &http_server_plugin_disconnect_peer;
3496 api->disconnect_session = &http_server_plugin_disconnect_session;
3497 api->query_keepalive_factor = &http_server_query_keepalive_factor;
3498 api->check_address = &http_server_plugin_address_suggested;
3499 api->get_session = &http_server_plugin_get_session;
3501 api->address_to_string = &http_server_plugin_address_to_string;
3502 api->string_to_address = &http_common_plugin_string_to_address;
3503 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
3504 api->get_network = &http_server_plugin_get_network;
3505 api->get_network_for_address = &http_server_plugin_get_network_for_address;
3506 api->update_session_timeout = &http_server_plugin_update_session_timeout;
3507 api->update_inbound_delay = &http_server_plugin_update_inbound_delay;
3508 api->setup_monitor = &http_server_plugin_setup_monitor;
3510 plugin->name = "transport-https_server";
3511 plugin->protocol = "https";
3513 plugin->name = "transport-http_server";
3514 plugin->protocol = "http";
3518 GNUNET_CONFIGURATION_get_value_yesno (env->cfg,
3523 plugin->options |= HTTP_OPTIONS_TCP_STEALTH;
3525 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3526 _("TCP_STEALTH not supported on this platform.\n"));
3527 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3532 /* Compile URL regex */
3533 if (regcomp (&plugin->url_regex,
3537 LOG (GNUNET_ERROR_TYPE_ERROR,
3538 _("Unable to compile URL regex\n"));
3539 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3543 /* Configure plugin */
3544 if (GNUNET_SYSERR == server_configure_plugin (plugin))
3546 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3550 /* Check IPv6 support */
3551 if (GNUNET_YES == plugin->use_ipv6)
3552 plugin->use_ipv6 = server_check_ipv6_support (plugin);
3554 /* Report addresses to transport service */
3555 if (GNUNET_NO == plugin->external_only)
3556 server_start_report_addresses (plugin);
3558 if (GNUNET_SYSERR == server_start (plugin))
3560 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3566 /* end of plugin_transport_http_server.c */