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
99 * Wrapper to manage addresses
101 struct HttpAddressWrapper
106 struct HttpAddressWrapper *next;
109 * Linked list previous
111 struct HttpAddressWrapper *prev;
114 * An address we are using.
116 struct HttpAddress *address;
119 * Length of the address.
126 * Message to send using http
131 * next pointer for double linked list
133 struct HTTP_Message *next;
136 * previous pointer for double linked list
138 struct HTTP_Message *prev;
141 * buffer containing data to send
146 * amount of data already sent
156 * HTTP/S specific overhead
161 * Continuation function to call once the transmission buffer
162 * has again space available. NULL if there is no
163 * continuation to call.
165 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
168 * Closure for transmit_cont.
170 void *transmit_cont_cls;
175 * Session handle for connections.
177 struct GNUNET_ATS_Session
181 * To whom are we talking to (set to our identity
182 * if we are still waiting for the welcome message)
184 struct GNUNET_PeerIdentity target;
187 * Pointer to the global plugin struct.
189 struct HTTP_Server_Plugin *plugin;
192 * next pointer for double linked list
194 struct HTTP_Message *msg_head;
197 * previous pointer for double linked list
199 struct HTTP_Message *msg_tail;
202 * Message stream tokenizer for incoming data
204 struct GNUNET_SERVER_MessageStreamTokenizer *msg_tk;
209 struct ServerRequest *server_recv;
214 struct ServerRequest *server_send;
219 struct GNUNET_HELLO_Address *address;
222 * Absolute time when to receive data again
223 * Used for receive throttling
225 struct GNUNET_TIME_Absolute next_receive;
228 * Absolute time when this connection will time out.
230 struct GNUNET_TIME_Absolute timeout;
233 * Session timeout task
235 struct GNUNET_SCHEDULER_Task * timeout_task;
238 * Task to resume MHD handling when receiving is allowed again
240 struct GNUNET_SCHEDULER_Task * recv_wakeup_task;
243 * Number of bytes waiting for transmission to this peer.
245 unsigned long long bytes_in_queue;
248 * Number of messages waiting for transmission to this peer.
250 unsigned int msgs_in_queue;
253 * Unique HTTP/S connection tag for this connection
260 enum GNUNET_ATS_Network_Type scope;
263 * #GNUNET_YES if this session is known to the service.
265 int known_to_service;
271 * Encapsulation of all of the state of the plugin.
273 struct HTTP_Server_Plugin
278 struct GNUNET_TRANSPORT_PluginEnvironment *env;
281 * Hash map of open sessions.
283 struct GNUNET_CONTAINER_MultiPeerMap *sessions;
286 * Function to call about session status changes.
288 GNUNET_TRANSPORT_SessionInfoCallback sic;
291 * Closure for @e sic.
308 char *external_hostname;
311 * External hostname the plugin can be connected to, can be different to
312 * the host's FQDN, used e.g. for reverse proxying
314 struct GNUNET_HELLO_Address *ext_addr;
317 * NAT handle & address management
319 struct GNUNET_NAT_Handle *nat;
322 * IPv4 addresses DLL head
324 struct HttpAddressWrapper *addr_head;
327 * IPv4 addresses DLL tail
329 struct HttpAddressWrapper *addr_tail;
332 * IPv4 server socket to bind to
334 struct sockaddr_in *server_addr_v4;
337 * IPv6 server socket to bind to
339 struct sockaddr_in6 *server_addr_v6;
344 struct MHD_Daemon *server_v4;
349 struct MHD_Daemon *server_v6;
357 * Use RC4-128 instead of AES:
358 * NONE:+VERS-TLS1.0:+ARCFOUR-128:+SHA1:+RSA:+COMP-NULL
377 struct GNUNET_SCHEDULER_Task *server_v4_task;
382 struct GNUNET_SCHEDULER_Task *server_v6_task;
385 * Task calling transport service about external address
387 struct GNUNET_SCHEDULER_Task *notify_ext_task;
390 * Notify transport only about external address
392 unsigned int external_only;
395 * The IPv4 server is scheduled to run asap
397 int server_v4_immediately;
400 * The IPv6 server is scheduled to run asap
402 int server_v6_immediately;
405 * Verify external address
407 int verify_external_hostname;
410 * Maximum number of sockets the plugin can use
411 * Each http request /request connections are two connections
413 unsigned int max_request;
416 * Current number of sockets the plugin can use
417 * Each http connection are two requests
419 unsigned int cur_request;
422 * Did we immediately end the session in disconnect_cb
432 * My options to be included in the address
452 * Regex for parsing URLs. FIXME: this seems overkill.
460 * If a session monitor is attached, notify it about the new
463 * @param plugin our plugin
464 * @param session session that changed state
465 * @param state new state of the session
468 notify_session_monitor (struct HTTP_Server_Plugin *plugin,
469 struct GNUNET_ATS_Session *session,
470 enum GNUNET_TRANSPORT_SessionState state)
472 struct GNUNET_TRANSPORT_SessionInfo info;
474 if (NULL == plugin->sic)
476 memset (&info, 0, sizeof (info));
478 info.is_inbound = GNUNET_YES;
479 info.num_msg_pending = session->msgs_in_queue;
480 info.num_bytes_pending = session->bytes_in_queue;
481 info.receive_delay = session->next_receive;
482 info.session_timeout = session->timeout;
483 info.address = session->address;
484 plugin->sic (plugin->sic_cls,
491 * Wake up an MHD connection which was suspended
493 * @param cls the session
496 server_wake_up (void *cls)
498 struct GNUNET_ATS_Session *s = cls;
500 s->recv_wakeup_task = NULL;
501 LOG (GNUNET_ERROR_TYPE_DEBUG,
502 "Session %p: Waking up PUT handle\n",
504 MHD_resume_connection (s->server_recv->mhd_conn);
509 * Reschedule the execution of both IPv4 and IPv6 server.
511 * @param plugin the plugin
512 * @param server which server to schedule v4 or v6?
513 * @param now #GNUNET_YES to schedule execution immediately, #GNUNET_NO to wait
517 server_reschedule (struct HTTP_Server_Plugin *plugin,
518 struct MHD_Daemon *server,
523 * Deletes the session. Must not be used afterwards.
525 * @param s the session to delete
528 server_delete_session (struct GNUNET_ATS_Session *s)
530 struct HTTP_Server_Plugin *plugin = s->plugin;
531 struct HTTP_Message *msg;
533 if (NULL != s->timeout_task)
535 GNUNET_SCHEDULER_cancel (s->timeout_task);
536 s->timeout_task = NULL;
537 s->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
539 if (NULL != s->recv_wakeup_task)
541 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
542 s->recv_wakeup_task = NULL;
543 if (NULL != s->server_recv)
544 MHD_resume_connection (s->server_recv->mhd_conn);
546 GNUNET_assert (GNUNET_OK ==
547 GNUNET_CONTAINER_multipeermap_remove (plugin->sessions,
550 while (NULL != (msg = s->msg_head))
552 GNUNET_CONTAINER_DLL_remove (s->msg_head,
555 if (NULL != msg->transmit_cont)
556 msg->transmit_cont (msg->transmit_cont_cls,
560 msg->pos + msg->overhead);
561 GNUNET_assert (s->msgs_in_queue > 0);
563 GNUNET_assert (s->bytes_in_queue >= msg->size);
564 s->bytes_in_queue -= msg->size;
568 GNUNET_assert (0 == s->msgs_in_queue);
569 GNUNET_assert (0 == s->bytes_in_queue);
571 if (NULL != s->server_send)
573 LOG (GNUNET_ERROR_TYPE_DEBUG,
574 "Server: %p / %p Terminating inbound PUT session to peer `%s'\n",
576 GNUNET_i2s (&s->target));
577 s->server_send->session = NULL;
578 MHD_set_connection_option (s->server_send->mhd_conn,
579 MHD_CONNECTION_OPTION_TIMEOUT,
580 1 /* 0 = no timeout, so this is MIN */);
581 server_reschedule (plugin,
582 s->server_send->mhd_daemon,
586 if (NULL != s->server_recv)
588 LOG (GNUNET_ERROR_TYPE_DEBUG,
589 "Server: %p / %p Terminating inbound GET session to peer `%s'\n",
590 s, s->server_recv, GNUNET_i2s (&s->target));
591 s->server_recv->session = NULL;
592 MHD_set_connection_option (s->server_recv->mhd_conn,
593 MHD_CONNECTION_OPTION_TIMEOUT,
594 1 /* 0 = no timeout, so this is MIN */);
595 server_reschedule (plugin,
596 s->server_recv->mhd_daemon,
599 notify_session_monitor (plugin,
601 GNUNET_TRANSPORT_SS_DONE);
602 if (GNUNET_YES == s->known_to_service)
604 plugin->env->session_end (plugin->env->cls,
607 s->known_to_service = GNUNET_NO;
609 if (NULL != s->msg_tk)
611 GNUNET_SERVER_mst_destroy (s->msg_tk);
614 GNUNET_HELLO_address_free (s->address);
615 LOG (GNUNET_ERROR_TYPE_DEBUG,
616 "Session %p destroyed\n",
623 * Disconnect session @a s by telling MHD to close the
624 * connections (reducing timeout, etc.).
626 * @param cls closure with the `struct HTTP_Server_Plugin`
627 * @param s the session
628 * @return #GNUNET_OK on success
631 http_server_plugin_disconnect_session (void *cls,
632 struct GNUNET_ATS_Session *s)
634 server_delete_session (s);
640 * Session was idle, so disconnect it
642 * @param cls the session
645 server_session_timeout (void *cls)
647 struct GNUNET_ATS_Session *s = cls;
648 struct GNUNET_TIME_Relative left;
650 s->timeout_task = NULL;
651 left = GNUNET_TIME_absolute_get_remaining (s->timeout);
652 if (0 != left.rel_value_us)
654 /* not actually our turn yet, but let's at least update
655 the monitor, it may think we're about to die ... */
656 notify_session_monitor (s->plugin,
658 GNUNET_TRANSPORT_SS_UP);
659 s->timeout_task = GNUNET_SCHEDULER_add_delayed (left,
660 &server_session_timeout,
664 GNUNET_log (TIMEOUT_LOG,
665 "Session %p was idle for %s, disconnecting\n",
667 GNUNET_STRINGS_relative_time_to_string (HTTP_SERVER_SESSION_TIMEOUT,
669 server_delete_session (s);
674 * Increment session timeout due to activity session @a s
676 * @param s the session
679 server_reschedule_session_timeout (struct GNUNET_ATS_Session *s)
681 GNUNET_assert (NULL != s->timeout_task);
682 s->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
687 * Function that can be used by the transport service to transmit
688 * a message using the plugin. Note that in the case of a
689 * peer disconnecting, the continuation MUST be called
690 * prior to the disconnect notification itself. This function
691 * will be called with this peer's HELLO message to initiate
692 * a fresh connection to another peer.
695 * @param session which session must be used
696 * @param msgbuf the message to transmit
697 * @param msgbuf_size number of bytes in @a msgbuf
698 * @param priority how important is the message (most plugins will
699 * ignore message priority and just FIFO)
700 * @param to how long to wait at most for the transmission (does not
701 * require plugins to discard the message after the timeout,
702 * just advisory for the desired delay; most plugins will ignore
704 * @param cont continuation to call once the message has
705 * been transmitted (or if the transport is ready
706 * for the next transmission call; or if the
707 * peer disconnected...); can be NULL
708 * @param cont_cls closure for @a cont
709 * @return number of bytes used (on the physical network, with overheads);
710 * -1 on hard errors (i.e. address invalid); 0 is a legal value
711 * and does NOT mean that the message was not transmitted (DV)
714 http_server_plugin_send (void *cls,
715 struct GNUNET_ATS_Session *session,
718 unsigned int priority,
719 struct GNUNET_TIME_Relative to,
720 GNUNET_TRANSPORT_TransmitContinuation cont,
723 struct HTTP_Server_Plugin *plugin = cls;
724 struct HTTP_Message *msg;
725 ssize_t bytes_sent = 0;
728 LOG (GNUNET_ERROR_TYPE_DEBUG,
729 "Session %p/request %p: Sending message with %u to peer `%s'\n",
731 session->server_send,
733 GNUNET_i2s (&session->target));
735 /* create new message and schedule */
736 bytes_sent = sizeof (struct HTTP_Message) + msgbuf_size;
737 msg = GNUNET_malloc (bytes_sent);
739 msg->size = msgbuf_size;
741 msg->buf = (char *) &msg[1];
742 msg->transmit_cont = cont;
743 msg->transmit_cont_cls = cont_cls;
744 GNUNET_memcpy (msg->buf,
747 GNUNET_CONTAINER_DLL_insert_tail (session->msg_head,
750 session->msgs_in_queue++;
751 session->bytes_in_queue += msg->size;
752 notify_session_monitor (plugin,
754 GNUNET_TRANSPORT_SS_UP);
755 GNUNET_asprintf (&stat_txt,
756 "# bytes currently in %s_server buffers",
758 GNUNET_STATISTICS_update (plugin->env->stats,
759 stat_txt, msgbuf_size, GNUNET_NO);
760 GNUNET_free (stat_txt);
762 if (NULL != session->server_send)
763 server_reschedule (session->plugin,
764 session->server_send->mhd_daemon,
771 * Terminate session during shutdown.
773 * @param cls the `struct HTTP_Server_Plugin *`
774 * @param peer for which this is a session
775 * @param value the `struct GNUNET_ATS_Session` to clean up
776 * @return #GNUNET_OK (continue to iterate)
779 destroy_session_shutdown_cb (void *cls,
780 const struct GNUNET_PeerIdentity *peer,
783 struct GNUNET_ATS_Session *s = value;
784 struct ServerRequest *sc_send;
785 struct ServerRequest *sc_recv;
787 sc_send = s->server_send;
788 sc_recv = s->server_recv;
789 server_delete_session (s);
791 sc_send->session = NULL;
793 sc_recv->session = NULL;
802 * @param cls the `struct HTTP_Server_Plugin *`
803 * @param peer for which this is a session
804 * @param value the `struct GNUNET_ATS_Session` to clean up
805 * @return #GNUNET_OK (continue to iterate)
808 destroy_session_cb (void *cls,
809 const struct GNUNET_PeerIdentity *peer,
812 struct GNUNET_ATS_Session *s = value;
814 server_delete_session (s);
820 * Function that can be used to force the plugin to disconnect
821 * from the given peer and cancel all previous transmissions
822 * (and their continuationc).
825 * @param target peer from which to disconnect
828 http_server_plugin_disconnect_peer (void *cls,
829 const struct GNUNET_PeerIdentity *target)
831 struct HTTP_Server_Plugin *plugin = cls;
833 LOG (GNUNET_ERROR_TYPE_DEBUG,
834 "Transport tells me to disconnect `%s'\n",
835 GNUNET_i2s (target));
836 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
844 * Another peer has suggested an address for this
845 * peer and transport plugin. Check that this could be a valid
846 * address. If so, consider adding it to the list
850 * @param addr pointer to the address
851 * @param addrlen length of @a addr
852 * @return #GNUNET_OK if this is a plausible address for this peer
856 http_server_plugin_address_suggested (void *cls,
860 struct HTTP_Server_Plugin *plugin = cls;
861 struct HttpAddressWrapper *next;
862 struct HttpAddressWrapper *pos;
863 const struct HttpAddress *haddr = addr;
865 if ((NULL != plugin->ext_addr) &&
866 GNUNET_YES == (http_common_cmp_addresses (addr, addrlen,
867 plugin->ext_addr->address,
868 plugin->ext_addr->address_length)))
870 /* Checking HTTP_OPTIONS_VERIFY_CERTIFICATE option for external hostname */
871 if ((ntohl (haddr->options) & HTTP_OPTIONS_VERIFY_CERTIFICATE) !=
872 (plugin->options & HTTP_OPTIONS_VERIFY_CERTIFICATE))
873 return GNUNET_NO; /* VERIFY option not set as required! */
876 next = plugin->addr_head;
877 while (NULL != (pos = next))
880 if (GNUNET_YES == (http_common_cmp_addresses(addr,
891 * Creates a new outbound session the transport
892 * service will use to send data to the peer.
894 * Since HTTP/S server cannot create sessions, always returns NULL.
896 * @param cls the plugin
897 * @param address the address
898 * @return always NULL
900 static struct GNUNET_ATS_Session *
901 http_server_plugin_get_session (void *cls,
902 const struct GNUNET_HELLO_Address *address)
909 * Call MHD IPv4 to process pending requests and then go back
910 * and schedule the next run.
912 * @param cls plugin as closure
915 server_v4_run (void *cls)
917 struct HTTP_Server_Plugin *plugin = cls;
919 plugin->server_v4_task = NULL;
920 plugin->server_v4_immediately = GNUNET_NO;
921 GNUNET_assert (MHD_YES == MHD_run (plugin->server_v4));
922 server_reschedule (plugin, plugin->server_v4, GNUNET_NO);
927 * Call MHD IPv6 to process pending requests and then go back
928 * and schedule the next run.
930 * @param cls plugin as closure
933 server_v6_run (void *cls)
935 struct HTTP_Server_Plugin *plugin = cls;
937 plugin->server_v6_task = NULL;
938 plugin->server_v6_immediately = GNUNET_NO;
939 GNUNET_assert (MHD_YES == MHD_run (plugin->server_v6));
940 server_reschedule (plugin, plugin->server_v6, GNUNET_NO);
945 * Function that queries MHD's select sets and
946 * starts the task waiting for them.
948 * @param plugin plugin
949 * @param daemon_handle the MHD daemon handle
950 * @param now schedule now
951 * @return gnunet task identifier
953 static struct GNUNET_SCHEDULER_Task *
954 server_schedule (struct HTTP_Server_Plugin *plugin,
955 struct MHD_Daemon *daemon_handle,
958 struct GNUNET_SCHEDULER_Task * ret;
962 struct GNUNET_NETWORK_FDSet *wrs;
963 struct GNUNET_NETWORK_FDSet *wws;
965 MHD_UNSIGNED_LONG_LONG timeout;
966 static unsigned long long last_timeout = 0;
968 struct GNUNET_TIME_Relative tv;
970 if (GNUNET_YES == plugin->in_shutdown)
977 wrs = GNUNET_NETWORK_fdset_create ();
978 wws = GNUNET_NETWORK_fdset_create ();
980 GNUNET_assert (MHD_YES ==
981 MHD_get_fdset (daemon_handle,
986 haveto = MHD_get_timeout (daemon_handle, &timeout);
987 if (haveto == MHD_YES)
989 if (timeout != last_timeout)
991 LOG (GNUNET_ERROR_TYPE_DEBUG,
992 "SELECT Timeout changed from %llu to %llu (ms)\n",
993 last_timeout, timeout);
994 last_timeout = timeout;
996 if (timeout <= GNUNET_TIME_UNIT_SECONDS.rel_value_us / 1000LL)
997 tv.rel_value_us = (uint64_t) timeout * 1000LL;
999 tv = GNUNET_TIME_UNIT_SECONDS;
1002 tv = GNUNET_TIME_UNIT_SECONDS;
1003 /* Force immediate run, since we have outbound data to send */
1004 if (now == GNUNET_YES)
1005 tv = GNUNET_TIME_UNIT_MILLISECONDS;
1006 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
1007 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
1009 if (daemon_handle == plugin->server_v4)
1011 if (plugin->server_v4_task != NULL)
1013 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
1014 plugin->server_v4_task = NULL;
1017 LOG (GNUNET_ERROR_TYPE_DEBUG,
1018 "Scheduling IPv4 server task in %llu ms\n",
1022 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1024 &server_v4_run, plugin);
1026 if (daemon_handle == plugin->server_v6)
1028 if (plugin->server_v6_task != NULL)
1030 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
1031 plugin->server_v6_task = NULL;
1034 LOG (GNUNET_ERROR_TYPE_DEBUG,
1035 "Scheduling IPv6 server task in %llu ms\n", tv);
1038 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1040 &server_v6_run, plugin);
1042 GNUNET_NETWORK_fdset_destroy (wrs);
1043 GNUNET_NETWORK_fdset_destroy (wws);
1049 * Reschedule the execution of both IPv4 and IPv6 server
1051 * @param plugin the plugin
1052 * @param server which server to schedule v4 or v6?
1053 * @param now #GNUNET_YES to schedule execution immediately, #GNUNET_NO to wait
1057 server_reschedule (struct HTTP_Server_Plugin *plugin,
1058 struct MHD_Daemon *server,
1061 if ((server == plugin->server_v4) && (plugin->server_v4 != NULL))
1063 if (GNUNET_YES == plugin->server_v4_immediately)
1064 return; /* No rescheduling, server will run asap */
1066 if (GNUNET_YES == now)
1067 plugin->server_v4_immediately = GNUNET_YES;
1069 if (plugin->server_v4_task != NULL)
1071 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
1072 plugin->server_v4_task = NULL;
1074 plugin->server_v4_task = server_schedule (plugin, plugin->server_v4, now);
1077 if ((server == plugin->server_v6) && (plugin->server_v6 != NULL))
1079 if (GNUNET_YES == plugin->server_v6_immediately)
1080 return; /* No rescheduling, server will run asap */
1082 if (GNUNET_YES == now)
1083 plugin->server_v6_immediately = GNUNET_YES;
1085 if (plugin->server_v6_task != NULL)
1087 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
1088 plugin->server_v6_task = NULL;
1090 plugin->server_v6_task = server_schedule (plugin, plugin->server_v6, now);
1096 * Function that is called to get the keepalive factor.
1097 * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
1098 * calculate the interval between keepalive packets.
1100 * @param cls closure with the `struct HTTP_Server_Plugin`
1101 * @return keepalive factor
1104 http_server_query_keepalive_factor (void *cls)
1111 * Function that will be called whenever the transport service wants to
1112 * notify the plugin that a session is still active and in use and
1113 * therefore the session timeout for this session has to be updated
1115 * @param cls closure
1116 * @param peer which peer was the session for
1117 * @param session which session is being updated
1120 http_server_plugin_update_session_timeout (void *cls,
1121 const struct GNUNET_PeerIdentity *peer,
1122 struct GNUNET_ATS_Session *session)
1124 server_reschedule_session_timeout (session);
1129 * Tell MHD that the connection should timeout after @a to seconds.
1131 * @param plugin our plugin
1132 * @param s session for which the timeout changes
1133 * @param to timeout in seconds
1136 server_mhd_connection_timeout (struct HTTP_Server_Plugin *plugin,
1137 struct GNUNET_ATS_Session *s,
1140 /* Setting timeouts for other connections */
1141 if (NULL != s->server_recv)
1143 LOG (GNUNET_ERROR_TYPE_DEBUG,
1144 "Setting timeout for %p to %u sec.\n",
1145 s->server_recv, to);
1146 MHD_set_connection_option (s->server_recv->mhd_conn,
1147 MHD_CONNECTION_OPTION_TIMEOUT,
1149 server_reschedule (plugin, s->server_recv->mhd_daemon, GNUNET_NO);
1151 if (NULL != s->server_send)
1153 LOG (GNUNET_ERROR_TYPE_DEBUG,
1154 "Setting timeout for %p to %u sec.\n",
1155 s->server_send, to);
1156 MHD_set_connection_option (s->server_send->mhd_conn,
1157 MHD_CONNECTION_OPTION_TIMEOUT,
1159 server_reschedule (plugin, s->server_send->mhd_daemon, GNUNET_NO);
1165 * Parse incoming URL for tag and target
1167 * @param plugin plugin
1168 * @param url incoming url
1169 * @param target where to store the target
1170 * @param tag where to store the tag
1171 * @param options where to store the options
1172 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1175 server_parse_url (struct HTTP_Server_Plugin *plugin,
1177 struct GNUNET_PeerIdentity *target,
1181 regmatch_t matches[4];
1182 const char *tag_start;
1183 const char *target_start;
1187 unsigned long int rc;
1191 ("^.*/([0-9A-Z]+);([0-9]+)(,[0-9]+)?$")
1196 return GNUNET_SYSERR;
1199 if (regexec(&plugin->url_regex, url, 4, matches, 0))
1201 LOG (GNUNET_ERROR_TYPE_DEBUG,
1202 "URL `%s' did not match regex\n", url);
1203 return GNUNET_SYSERR;
1206 target_start = &url[matches[1].rm_so];
1207 tag_start = &url[matches[2].rm_so];
1210 rc = strtoul (tag_start, &tag_end, 10);
1211 if (&url[matches[2].rm_eo] != tag_end)
1213 LOG (GNUNET_ERROR_TYPE_DEBUG,
1214 "URL tag did not line up with submatch\n");
1215 return GNUNET_SYSERR;
1219 LOG (GNUNET_ERROR_TYPE_DEBUG,
1220 "URL tag is zero\n");
1221 return GNUNET_SYSERR;
1223 if ((rc == ULONG_MAX) && (ERANGE == errno))
1225 LOG (GNUNET_ERROR_TYPE_DEBUG,
1226 "URL tag > ULONG_MAX\n");
1227 return GNUNET_SYSERR;
1229 if (rc > UINT32_MAX)
1231 LOG (GNUNET_ERROR_TYPE_DEBUG,
1232 "URL tag > UINT32_MAX\n");
1233 return GNUNET_SYSERR;
1235 (*tag) = (uint32_t)rc;
1236 LOG (GNUNET_ERROR_TYPE_DEBUG,
1237 "Found tag `%u' in url\n",
1240 /* convert peer id */
1241 hash_length = matches[1].rm_eo - matches[1].rm_so;
1242 if (hash_length != plugin->peer_id_length)
1244 LOG (GNUNET_ERROR_TYPE_DEBUG,
1245 "URL target is %u bytes, expecting %u\n",
1246 hash_length, plugin->peer_id_length);
1247 return GNUNET_SYSERR;
1250 GNUNET_CRYPTO_eddsa_public_key_from_string (target_start,
1252 &target->public_key))
1254 LOG (GNUNET_ERROR_TYPE_DEBUG,
1255 "URL target conversion failed\n");
1256 return GNUNET_SYSERR;
1258 LOG (GNUNET_ERROR_TYPE_DEBUG,
1259 "Found target `%s' in URL\n",
1260 GNUNET_i2s_full (target));
1262 /* convert options */
1263 if (-1 == matches[3].rm_so)
1269 rc = strtoul (&url[matches[3].rm_so + 1], &options_end, 10);
1270 if (&url[matches[3].rm_eo] != options_end)
1272 LOG (GNUNET_ERROR_TYPE_DEBUG,
1273 "URL options did not line up with submatch\n");
1274 return GNUNET_SYSERR;
1276 if ((rc == ULONG_MAX) && (ERANGE == errno))
1278 LOG (GNUNET_ERROR_TYPE_DEBUG,
1279 "URL options > ULONG_MAX\n");
1280 return GNUNET_SYSERR;
1282 if (rc > UINT32_MAX)
1284 LOG (GNUNET_ERROR_TYPE_DEBUG,
1285 "URL options > UINT32_MAX\n");
1286 return GNUNET_SYSERR;
1288 (*options) = (uint32_t) rc;
1289 LOG (GNUNET_ERROR_TYPE_DEBUG,
1290 "Found options `%u' in url\n",
1298 * Closure for #session_tag_it().
1300 struct GNUNET_ATS_SessionTagContext
1303 * Set to session matching the tag.
1305 struct GNUNET_ATS_Session *res;
1308 * Tag we are looking for.
1315 * Find a session with a matching tag.
1317 * @param cls the `struct GNUNET_ATS_SessionTagContext *`
1318 * @param key peer identity (unused)
1319 * @param value the `struct GNUNET_ATS_Session *`
1320 * @return #GNUNET_NO if we found the session, #GNUNET_OK if not
1323 session_tag_it (void *cls,
1324 const struct GNUNET_PeerIdentity *key,
1327 struct GNUNET_ATS_SessionTagContext *stc = cls;
1328 struct GNUNET_ATS_Session *s = value;
1330 if (s->tag == stc->tag)
1340 * Lookup a mhd connection and create one if none is found
1342 * @param plugin the plugin handle
1343 * @param mhd_connection the incoming mhd_connection
1344 * @param url incoming requested URL
1345 * @param method PUT or GET
1346 * @return the server connecetion
1348 static struct ServerRequest *
1349 server_lookup_connection (struct HTTP_Server_Plugin *plugin,
1350 struct MHD_Connection *mhd_connection,
1354 struct GNUNET_ATS_Session *s = NULL;
1355 struct ServerRequest *sc = NULL;
1356 const union MHD_ConnectionInfo *conn_info;
1357 struct HttpAddress *addr;
1358 struct GNUNET_PeerIdentity target;
1360 struct GNUNET_ATS_SessionTagContext stc;
1362 int direction = GNUNET_SYSERR;
1364 enum GNUNET_ATS_Network_Type scope;
1366 conn_info = MHD_get_connection_info (mhd_connection,
1367 MHD_CONNECTION_INFO_CLIENT_ADDRESS);
1368 if ((conn_info->client_addr->sa_family != AF_INET) &&
1369 (conn_info->client_addr->sa_family != AF_INET6))
1371 LOG (GNUNET_ERROR_TYPE_DEBUG,
1372 "New %s request from %s\n",
1376 options = 0; /* make gcc happy */
1377 if (GNUNET_SYSERR ==
1378 server_parse_url (plugin, url, &target, &stc.tag, &options))
1380 LOG (GNUNET_ERROR_TYPE_DEBUG,
1381 "Invalid url %s\n", url);
1384 if (0 == strcmp (MHD_HTTP_METHOD_PUT, method))
1385 direction = _RECEIVE;
1386 else if (0 == strcmp (MHD_HTTP_METHOD_GET, method))
1390 LOG (GNUNET_ERROR_TYPE_DEBUG,
1391 "Invalid method %s for request from %s\n",
1396 plugin->cur_request++;
1397 LOG (GNUNET_ERROR_TYPE_DEBUG,
1398 "New %s request from %s with tag %u (%u of %u)\n",
1400 GNUNET_i2s (&target),
1402 plugin->cur_request, plugin->max_request);
1403 /* find existing session */
1405 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
1409 if (NULL == (s = stc.res))
1411 /* create new session */
1413 switch (conn_info->client_addr->sa_family)
1416 addr = http_common_address_from_socket (plugin->protocol,
1417 conn_info->client_addr,
1418 sizeof (struct sockaddr_in));
1419 addr_len = http_common_address_get_size (addr);
1420 scope = plugin->env->get_address_type (plugin->env->cls,
1421 conn_info->client_addr,
1422 sizeof (struct sockaddr_in));
1425 addr = http_common_address_from_socket (plugin->protocol,
1426 conn_info->client_addr,
1427 sizeof (struct sockaddr_in6));
1428 addr_len = http_common_address_get_size (addr);
1429 scope = plugin->env->get_address_type (plugin->env->cls,
1430 conn_info->client_addr,
1431 sizeof (struct sockaddr_in6));
1434 /* external host name */
1437 s = GNUNET_new (struct GNUNET_ATS_Session);
1441 s->address = GNUNET_HELLO_address_allocate (&s->target,
1445 GNUNET_HELLO_ADDRESS_INFO_INBOUND);
1446 s->next_receive = GNUNET_TIME_UNIT_ZERO_ABS;
1448 s->timeout = GNUNET_TIME_relative_to_absolute (HTTP_SERVER_SESSION_TIMEOUT);
1449 s->timeout_task = GNUNET_SCHEDULER_add_delayed (HTTP_SERVER_SESSION_TIMEOUT,
1450 &server_session_timeout,
1452 (void) GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
1455 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1456 notify_session_monitor (plugin,
1458 GNUNET_TRANSPORT_SS_INIT);
1459 notify_session_monitor (plugin,
1461 GNUNET_TRANSPORT_SS_HANDSHAKE);
1462 LOG (GNUNET_ERROR_TYPE_DEBUG,
1463 "Creating new session %p for peer `%s' connecting from `%s'\n",
1464 s, GNUNET_i2s (&target),
1465 http_common_plugin_address_to_string (plugin->protocol,
1468 GNUNET_free_non_null (addr);
1471 if ( (_RECEIVE == direction) &&
1472 (NULL != s->server_recv) )
1474 LOG (GNUNET_ERROR_TYPE_DEBUG,
1475 "Duplicate PUT request from `%s' tag %u, dismissing new request\n",
1476 GNUNET_i2s (&target),
1480 if ((_SEND == direction) && (NULL != s->server_send))
1482 LOG (GNUNET_ERROR_TYPE_DEBUG,
1483 "Duplicate GET request from `%s' tag %u, dismissing new request\n",
1484 GNUNET_i2s (&target),
1488 sc = GNUNET_new (struct ServerRequest);
1489 if (conn_info->client_addr->sa_family == AF_INET)
1490 sc->mhd_daemon = plugin->server_v4;
1491 if (conn_info->client_addr->sa_family == AF_INET6)
1492 sc->mhd_daemon = plugin->server_v6;
1493 sc->mhd_conn = mhd_connection;
1494 sc->direction = direction;
1495 sc->connected = GNUNET_NO;
1497 sc->options = options;
1498 if (direction == _SEND)
1500 s->server_send = sc;
1502 if (direction == _RECEIVE)
1504 s->server_recv = sc;
1507 if ((GNUNET_NO == s->known_to_service) &&
1508 (NULL != s->server_send) &&
1509 (NULL != s->server_recv) )
1511 s->known_to_service = GNUNET_YES;
1512 notify_session_monitor (plugin,
1514 GNUNET_TRANSPORT_SS_UP);
1515 plugin->env->session_start (plugin->env->cls,
1521 to = (HTTP_SERVER_SESSION_TIMEOUT.rel_value_us / 1000LL / 1000LL);
1522 server_mhd_connection_timeout (plugin, s, to);
1528 * Callback called by MHD when it needs data to send
1530 * @param cls current session
1531 * @param pos position in buffer
1532 * @param buf the buffer to write data to
1533 * @param max max number of bytes available in @a buf
1534 * @return bytes written to @a buf
1537 server_send_callback (void *cls,
1542 struct ServerRequest *sc = cls;
1543 struct GNUNET_ATS_Session *s = sc->session;
1544 ssize_t bytes_read = 0;
1545 struct HTTP_Message *msg;
1550 /* session is disconnecting */
1554 sc = s->server_send;
1561 bytes_read = GNUNET_MIN (msg->size - msg->pos,
1563 GNUNET_memcpy (buf, &msg->buf[msg->pos], bytes_read);
1564 msg->pos += bytes_read;
1566 /* removing message */
1567 if (msg->pos == msg->size)
1569 GNUNET_CONTAINER_DLL_remove (s->msg_head,
1572 if (NULL != msg->transmit_cont)
1573 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK,
1574 msg->size, msg->size + msg->overhead);
1575 GNUNET_assert (s->msgs_in_queue > 0);
1577 GNUNET_assert (s->bytes_in_queue >= msg->size);
1578 s->bytes_in_queue -= msg->size;
1580 notify_session_monitor (s->plugin,
1582 GNUNET_TRANSPORT_SS_UPDATE);
1587 sc->connected = GNUNET_YES;
1588 LOG (GNUNET_ERROR_TYPE_DEBUG,
1589 "Sent %u bytes to peer `%s' with session %p \n",
1591 GNUNET_i2s (&s->target),
1593 GNUNET_asprintf (&stat_txt,
1594 "# bytes currently in %s_server buffers",
1595 s->plugin->protocol);
1596 GNUNET_STATISTICS_update (s->plugin->env->stats,
1600 GNUNET_free (stat_txt);
1601 GNUNET_asprintf (&stat_txt,
1602 "# bytes transmitted via %s_server",
1603 s->plugin->protocol);
1604 GNUNET_STATISTICS_update (s->plugin->env->stats,
1605 stat_txt, bytes_read, GNUNET_NO);
1606 GNUNET_free (stat_txt);
1608 else if ((sc->options & OPTION_LONG_POLL) && sc->connected)
1610 LOG (GNUNET_ERROR_TYPE_DEBUG,
1611 "Completing GET response to peer `%s' with session %p\n",
1612 GNUNET_i2s (&s->target),
1614 return MHD_CONTENT_READER_END_OF_STREAM;
1621 * Callback called by MessageStreamTokenizer when a message has arrived
1623 * @param cls current session as closure
1624 * @param client client
1625 * @param message the message to be forwarded to transport service
1626 * @return #GNUNET_OK
1629 server_receive_mst_cb (void *cls,
1631 const struct GNUNET_MessageHeader *message)
1633 struct GNUNET_ATS_Session *s = cls;
1634 struct HTTP_Server_Plugin *plugin = s->plugin;
1635 struct GNUNET_TIME_Relative delay;
1638 if (GNUNET_NO == s->known_to_service)
1640 s->known_to_service = GNUNET_YES;
1641 plugin->env->session_start (plugin->env->cls,
1645 notify_session_monitor (plugin,
1647 GNUNET_TRANSPORT_SS_UP);
1649 delay = plugin->env->receive (plugin->env->cls,
1653 GNUNET_asprintf (&stat_txt,
1654 "# bytes received via %s_server",
1656 GNUNET_STATISTICS_update (plugin->env->stats,
1658 ntohs (message->size),
1660 GNUNET_free (stat_txt);
1661 s->next_receive = GNUNET_TIME_relative_to_absolute (delay);
1662 if (delay.rel_value_us > 0)
1664 LOG (GNUNET_ERROR_TYPE_DEBUG,
1665 "Peer `%s' address `%s' next read delayed for %s\n",
1666 GNUNET_i2s (&s->target),
1667 http_common_plugin_address_to_string (plugin->protocol,
1668 s->address->address,
1669 s->address->address_length),
1670 GNUNET_STRINGS_relative_time_to_string (delay,
1673 server_reschedule_session_timeout (s);
1679 * Add headers to a request indicating that we allow Cross-Origin Resource
1682 * @param response response object to modify
1685 add_cors_headers(struct MHD_Response *response)
1687 MHD_add_response_header (response,
1688 "Access-Control-Allow-Origin",
1690 MHD_add_response_header (response,
1691 "Access-Control-Allow-Methods",
1692 "GET, PUT, OPTIONS");
1693 MHD_add_response_header (response,
1694 "Access-Control-Max-Age",
1700 * MHD callback for a new incoming connection
1702 * @param cls the plugin handle
1703 * @param mhd_connection the mhd connection
1704 * @param url the requested URL
1705 * @param method GET or PUT
1706 * @param version HTTP version
1707 * @param upload_data upload data
1708 * @param upload_data_size size of @a upload_data
1709 * @param httpSessionCache the session cache to remember the connection
1710 * @return MHD_YES if connection is accepted, MHD_NO on reject
1713 server_access_cb (void *cls,
1714 struct MHD_Connection *mhd_connection,
1717 const char *version,
1718 const char *upload_data,
1719 size_t *upload_data_size,
1720 void **httpSessionCache)
1722 struct HTTP_Server_Plugin *plugin = cls;
1723 struct ServerRequest *sc = *httpSessionCache;
1724 struct GNUNET_ATS_Session *s;
1725 struct MHD_Response *response;
1728 LOG (GNUNET_ERROR_TYPE_DEBUG,
1729 _("Access from connection %p (%u of %u) for `%s' `%s' url `%s' with upload data size %u\n"),
1731 plugin->cur_request,
1732 plugin->max_request,
1736 (*upload_data_size));
1739 /* CORS pre-flight request */
1740 if (0 == strcmp (MHD_HTTP_METHOD_OPTIONS, method))
1742 response = MHD_create_response_from_buffer (0, NULL,
1743 MHD_RESPMEM_PERSISTENT);
1744 add_cors_headers(response);
1745 res = MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1746 MHD_destroy_response (response);
1749 /* new connection */
1750 sc = server_lookup_connection (plugin, mhd_connection, url, method);
1753 /* attach to new / existing session */
1754 (*httpSessionCache) = sc;
1758 /* existing session already has matching connection, refuse */
1759 response = MHD_create_response_from_buffer (strlen (HTTP_ERROR_RESPONSE),
1760 HTTP_ERROR_RESPONSE,
1761 MHD_RESPMEM_PERSISTENT);
1762 MHD_add_response_header (response,
1763 MHD_HTTP_HEADER_CONTENT_TYPE,
1765 add_cors_headers(response);
1766 res = MHD_queue_response (mhd_connection, MHD_HTTP_NOT_FOUND, response);
1767 MHD_destroy_response (response);
1771 /* 'old' connection */
1772 if (NULL == (s = sc->session))
1774 /* Session was already disconnected;
1775 sent HTTP/1.1: 200 OK as response */
1776 response = MHD_create_response_from_buffer (strlen ("Thank you!"),
1778 MHD_RESPMEM_PERSISTENT);
1779 add_cors_headers(response);
1780 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1781 MHD_destroy_response (response);
1785 if (sc->direction == _SEND)
1787 response = MHD_create_response_from_callback (MHD_SIZE_UNKNOWN, 32 * 1024,
1788 &server_send_callback, sc, NULL);
1789 add_cors_headers(response);
1790 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1791 MHD_destroy_response (response);
1794 if (sc->direction == _RECEIVE)
1796 if ((*upload_data_size == 0) && (sc->connected == GNUNET_NO))
1798 /* (*upload_data_size == 0) first callback when header are passed */
1799 LOG (GNUNET_ERROR_TYPE_DEBUG,
1800 "Session %p / Connection %p: Peer `%s' PUT on address `%s' connected\n",
1802 GNUNET_i2s (&s->target),
1803 http_common_plugin_address_to_string (plugin->protocol,
1804 s->address->address,
1805 s->address->address_length));
1806 sc->connected = GNUNET_YES;
1809 else if ((*upload_data_size == 0) && (sc->connected == GNUNET_YES))
1811 /* (*upload_data_size == 0) when upload is complete */
1812 LOG (GNUNET_ERROR_TYPE_DEBUG,
1813 "Session %p / Connection %p: Peer `%s' PUT on address `%s' finished upload\n",
1815 GNUNET_i2s (&s->target),
1816 http_common_plugin_address_to_string (plugin->protocol,
1817 s->address->address,
1818 s->address->address_length));
1819 sc->connected = GNUNET_NO;
1820 /* Sent HTTP/1.1: 200 OK as PUT Response\ */
1821 response = MHD_create_response_from_buffer (strlen ("Thank you!"),
1823 MHD_RESPMEM_PERSISTENT);
1824 add_cors_headers(response);
1825 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1826 MHD_destroy_response (response);
1829 else if ((*upload_data_size > 0) && (sc->connected == GNUNET_YES))
1831 struct GNUNET_TIME_Relative delay;
1833 /* (*upload_data_size > 0) for every segment received */
1834 LOG (GNUNET_ERROR_TYPE_DEBUG,
1835 "Session %p / Connection %p: Peer `%s' PUT on address `%s' received %u bytes\n",
1837 GNUNET_i2s (&s->target),
1838 http_common_plugin_address_to_string (plugin->protocol,
1839 s->address->address,
1840 s->address->address_length),
1842 delay = GNUNET_TIME_absolute_get_remaining (s->next_receive);
1843 if (0 == delay.rel_value_us)
1845 LOG (GNUNET_ERROR_TYPE_DEBUG,
1846 "PUT with %u bytes forwarded to MST\n",
1848 if (s->msg_tk == NULL)
1850 s->msg_tk = GNUNET_SERVER_mst_create (&server_receive_mst_cb, s);
1852 GNUNET_SERVER_mst_receive (s->msg_tk, s, upload_data, *upload_data_size,
1853 GNUNET_NO, GNUNET_NO);
1854 server_mhd_connection_timeout (plugin, s,
1855 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value_us / 1000LL
1857 (*upload_data_size) = 0;
1861 /* delay processing */
1862 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1863 "Session %p / Connection %p: no inbound bandwidth available! Next read was delayed by %s\n",
1866 GNUNET_STRINGS_relative_time_to_string (delay,
1868 GNUNET_assert(s->server_recv->mhd_conn == mhd_connection);
1869 MHD_suspend_connection (s->server_recv->mhd_conn);
1870 if (NULL == s->recv_wakeup_task)
1872 = GNUNET_SCHEDULER_add_delayed (delay,
1889 * Callback from MHD when a connection disconnects
1891 * @param cls closure with the `struct HTTP_Server_Plugin *`
1892 * @param connection the disconnected MHD connection
1893 * @param httpSessionCache the pointer to distinguish
1896 server_disconnect_cb (void *cls,
1897 struct MHD_Connection *connection,
1898 void **httpSessionCache)
1900 struct HTTP_Server_Plugin *plugin = cls;
1901 struct ServerRequest *sc = *httpSessionCache;
1903 LOG (GNUNET_ERROR_TYPE_DEBUG,
1904 "Disconnect for connection %p\n",
1908 /* CORS pre-flight request finished */
1912 if (NULL != sc->session)
1914 if (sc->direction == _SEND)
1916 LOG (GNUNET_ERROR_TYPE_DEBUG,
1917 "Peer `%s' connection %p, GET on address `%s' disconnected\n",
1918 GNUNET_i2s (&sc->session->target),
1919 sc->session->server_send,
1920 http_common_plugin_address_to_string (plugin->protocol,
1921 sc->session->address->address,
1922 sc->session->address->address_length));
1924 sc->session->server_send = NULL;
1926 else if (sc->direction == _RECEIVE)
1928 LOG (GNUNET_ERROR_TYPE_DEBUG,
1929 "Peer `%s' connection %p PUT on address `%s' disconnected\n",
1930 GNUNET_i2s (&sc->session->target),
1931 sc->session->server_recv,
1932 http_common_plugin_address_to_string (plugin->protocol,
1933 sc->session->address->address,
1934 sc->session->address->address_length));
1935 sc->session->server_recv = NULL;
1936 if (NULL != sc->session->msg_tk)
1938 GNUNET_SERVER_mst_destroy (sc->session->msg_tk);
1939 sc->session->msg_tk = NULL;
1944 plugin->cur_request--;
1949 * Check if incoming connection is accepted.
1951 * @param cls plugin as closure
1952 * @param addr address of incoming connection
1953 * @param addr_len number of bytes in @a addr
1954 * @return MHD_YES if connection is accepted, MHD_NO if connection is rejected
1957 server_accept_cb (void *cls,
1958 const struct sockaddr *addr,
1961 struct HTTP_Server_Plugin *plugin = cls;
1963 if (plugin->cur_request <= plugin->max_request)
1965 LOG (GNUNET_ERROR_TYPE_DEBUG,
1966 _("Accepting connection (%u of %u) from `%s'\n"),
1967 plugin->cur_request, plugin->max_request,
1968 GNUNET_a2s (addr, addr_len));
1973 LOG (GNUNET_ERROR_TYPE_WARNING,
1974 _("Server reached maximum number connections (%u), rejecting new connection\n"),
1975 plugin->max_request);
1982 * Log function called by MHD.
1985 * @param fmt format string
1986 * @param ap arguments for the format string (va_start() and va_end()
1987 * will be called by MHD)
1990 server_log (void *arg,
2000 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2008 * Load ssl certificate from file
2010 * @param file filename
2011 * @return content of the file
2014 server_load_file (const char *file)
2016 struct GNUNET_DISK_FileHandle *gn_file;
2020 if (GNUNET_OK != GNUNET_DISK_file_size (file,
2021 &fsize, GNUNET_NO, GNUNET_YES))
2023 text = GNUNET_malloc (fsize + 1);
2025 GNUNET_DISK_file_open (file, GNUNET_DISK_OPEN_READ,
2026 GNUNET_DISK_PERM_USER_READ);
2027 if (NULL == gn_file)
2032 if (GNUNET_SYSERR == GNUNET_DISK_file_read (gn_file, text, fsize))
2035 GNUNET_DISK_file_close (gn_file);
2039 GNUNET_DISK_file_close (gn_file);
2047 * Load ssl certificate
2049 * @param plugin the plugin
2050 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2053 server_load_certificate (struct HTTP_Server_Plugin *plugin)
2055 int res = GNUNET_OK;
2061 GNUNET_CONFIGURATION_get_value_filename (plugin->env->cfg,
2063 "KEY_FILE", &key_file))
2065 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2066 plugin->name, "CERT_FILE");
2067 return GNUNET_SYSERR;
2070 GNUNET_CONFIGURATION_get_value_filename (plugin->env->cfg,
2072 "CERT_FILE", &cert_file))
2074 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2075 plugin->name, "CERT_FILE");
2076 GNUNET_free (key_file);
2077 return GNUNET_SYSERR;
2079 /* Get crypto init string from config. If not present, use
2082 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2085 &plugin->crypto_init))
2086 LOG (GNUNET_ERROR_TYPE_DEBUG,
2087 "Using crypto init string `%s'\n",
2088 plugin->crypto_init);
2090 LOG (GNUNET_ERROR_TYPE_DEBUG,
2091 "Using default crypto init string \n");
2093 /* read key & certificates from file */
2094 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2095 "Trying to loading TLS certificate from key-file `%s' cert-file`%s'\n",
2096 key_file, cert_file);
2098 plugin->key = server_load_file (key_file);
2099 plugin->cert = server_load_file (cert_file);
2101 if ((plugin->key == NULL) || (plugin->cert == NULL))
2103 struct GNUNET_OS_Process *cert_creation;
2105 GNUNET_free_non_null (plugin->key);
2107 GNUNET_free_non_null (plugin->cert);
2108 plugin->cert = NULL;
2110 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2111 "No usable TLS certificate found, creating certificate\n");
2114 GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
2116 "gnunet-transport-certificate-creation",
2117 "gnunet-transport-certificate-creation",
2121 if (NULL == cert_creation)
2123 LOG (GNUNET_ERROR_TYPE_ERROR,
2124 _("Could not create a new TLS certificate, program `gnunet-transport-certificate-creation' could not be started!\n"));
2125 GNUNET_free (key_file);
2126 GNUNET_free (cert_file);
2128 GNUNET_free_non_null (plugin->key);
2130 GNUNET_free_non_null (plugin->cert);
2131 plugin->cert = NULL;
2132 GNUNET_free_non_null (plugin->crypto_init);
2133 plugin->crypto_init = NULL;
2135 return GNUNET_SYSERR;
2137 GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (cert_creation));
2138 GNUNET_OS_process_destroy (cert_creation);
2140 plugin->key = server_load_file (key_file);
2141 plugin->cert = server_load_file (cert_file);
2144 if ((plugin->key == NULL) || (plugin->cert == NULL))
2146 LOG (GNUNET_ERROR_TYPE_ERROR,
2147 _("No usable TLS certificate found and creating one at `%s/%s' failed!\n"),
2148 key_file, cert_file);
2149 GNUNET_free (key_file);
2150 GNUNET_free (cert_file);
2152 GNUNET_free_non_null (plugin->key);
2154 GNUNET_free_non_null (plugin->cert);
2155 plugin->cert = NULL;
2156 GNUNET_free_non_null (plugin->crypto_init);
2157 plugin->crypto_init = NULL;
2159 return GNUNET_SYSERR;
2161 GNUNET_free (key_file);
2162 GNUNET_free (cert_file);
2163 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2164 "TLS certificate loaded\n");
2171 * Invoke `MHD_start_daemon` with the various options we need to
2172 * setup the HTTP server with the given listen address.
2174 * @param plugin our plugin
2175 * @param addr listen address to use
2176 * @param v6 MHD_NO_FLAG or MHD_USE_IPv6, depending on context
2177 * @return NULL on error
2179 static struct MHD_Daemon *
2180 run_mhd_start_daemon (struct HTTP_Server_Plugin *plugin,
2181 const struct sockaddr_in *addr,
2184 struct MHD_Daemon *server;
2185 unsigned int timeout;
2187 #if MHD_VERSION >= 0x00090E00
2188 timeout = HTTP_SERVER_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL / 1000LL;
2189 LOG (GNUNET_ERROR_TYPE_DEBUG,
2190 "MHD can set timeout per connection! Default time out %u sec.\n",
2193 timeout = HTTP_SERVER_SESSION_TIMEOUT.rel_value_us / 1000LL / 1000LL;
2194 LOG (GNUNET_ERROR_TYPE_WARNING,
2195 "MHD cannot set timeout per connection! Default time out %u sec.\n",
2198 server = MHD_start_daemon (
2205 MHD_USE_SUSPEND_RESUME |
2208 &server_accept_cb, plugin,
2209 &server_access_cb, plugin,
2210 MHD_OPTION_SOCK_ADDR,
2212 MHD_OPTION_CONNECTION_LIMIT,
2213 (unsigned int) plugin->max_request,
2215 MHD_OPTION_HTTPS_PRIORITIES,
2216 plugin->crypto_init,
2217 MHD_OPTION_HTTPS_MEM_KEY,
2219 MHD_OPTION_HTTPS_MEM_CERT,
2222 MHD_OPTION_CONNECTION_TIMEOUT,
2224 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
2226 GNUNET_SERVER_MAX_MESSAGE_SIZE),
2227 MHD_OPTION_NOTIFY_COMPLETED,
2228 &server_disconnect_cb, plugin,
2229 MHD_OPTION_EXTERNAL_LOGGER,
2233 if ( (NULL != server) &&
2234 (0 != (plugin->options & HTTP_OPTIONS_TCP_STEALTH)) )
2236 const union MHD_DaemonInfo *di;
2238 di = MHD_get_daemon_info (server,
2239 MHD_DAEMON_INFO_LISTEN_FD,
2241 if ( (0 != setsockopt ((int) di->listen_fd,
2244 plugin->env->my_identity,
2245 sizeof (struct GNUNET_PeerIdentity))) )
2247 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2248 _("TCP_STEALTH not supported on this platform.\n"));
2249 MHD_stop_daemon (server);
2259 * Start the HTTP server
2261 * @param plugin the plugin handle
2262 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2265 server_start (struct HTTP_Server_Plugin *plugin)
2269 GNUNET_assert (NULL != plugin);
2271 if (GNUNET_SYSERR == server_load_certificate (plugin))
2273 LOG (GNUNET_ERROR_TYPE_ERROR,
2274 _("Could not load or create server certificate! Loading plugin failed!\n"));
2275 return GNUNET_SYSERR;
2281 plugin->server_v4 = NULL;
2282 if (GNUNET_YES == plugin->use_ipv4)
2285 = run_mhd_start_daemon (plugin,
2286 (const struct sockaddr_in *) plugin->server_addr_v4,
2289 if (NULL == plugin->server_v4)
2291 LOG (GNUNET_ERROR_TYPE_ERROR,
2292 "Failed to start %s IPv4 server component on port %u\n",
2297 server_reschedule (plugin,
2303 plugin->server_v6 = NULL;
2304 if (GNUNET_YES == plugin->use_ipv6)
2307 = run_mhd_start_daemon (plugin,
2308 (const struct sockaddr_in *) plugin->server_addr_v6,
2310 if (NULL == plugin->server_v6)
2312 LOG (GNUNET_ERROR_TYPE_ERROR,
2313 "Failed to start %s IPv6 server component on port %u\n",
2319 server_reschedule (plugin,
2325 if ( (NULL == plugin->server_v6) &&
2326 (NULL == plugin->server_v4) )
2328 LOG (GNUNET_ERROR_TYPE_ERROR,
2329 "%s %s server component started on port %u\n",
2333 return GNUNET_SYSERR;
2335 if ((NULL != plugin->server_v6) &&
2336 (NULL != plugin->server_v4))
2337 msg = "IPv4 and IPv6";
2338 else if (NULL != plugin->server_v6)
2340 else if (NULL != plugin->server_v4)
2342 LOG (GNUNET_ERROR_TYPE_DEBUG,
2343 "%s %s server component started on port %u\n",
2352 * Add an address to the server's set of addresses and notify transport
2354 * @param cls the plugin handle
2355 * @param add_remove #GNUNET_YES on add, #GNUNET_NO on remove
2356 * @param addr the address
2357 * @param addrlen address length
2360 server_add_address (void *cls,
2362 const struct sockaddr *addr,
2365 struct HTTP_Server_Plugin *plugin = cls;
2366 struct GNUNET_HELLO_Address *address;
2367 struct HttpAddressWrapper *w = NULL;
2369 w = GNUNET_new (struct HttpAddressWrapper);
2370 w->address = http_common_address_from_socket (plugin->protocol,
2373 if (NULL == w->address)
2378 w->addrlen = http_common_address_get_size (w->address);
2380 GNUNET_CONTAINER_DLL_insert (plugin->addr_head,
2383 LOG (GNUNET_ERROR_TYPE_DEBUG,
2384 "Notifying transport to add address `%s'\n",
2385 http_common_plugin_address_to_string (plugin->protocol,
2388 /* modify our published address list */
2390 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2391 "https_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2393 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2394 "http_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2397 plugin->env->notify_address (plugin->env->cls,
2400 GNUNET_HELLO_address_free (address);
2405 * Remove an address from the server's set of addresses and notify transport
2407 * @param cls the plugin handle
2408 * @param add_remove #GNUNET_YES on add, #GNUNET_NO on remove
2409 * @param addr the address
2410 * @param addrlen address length
2413 server_remove_address (void *cls,
2415 const struct sockaddr *addr,
2418 struct HTTP_Server_Plugin *plugin = cls;
2419 struct GNUNET_HELLO_Address *address;
2420 struct HttpAddressWrapper *w = plugin->addr_head;
2424 saddr = http_common_address_from_socket (plugin->protocol,
2429 saddr_len = http_common_address_get_size (saddr);
2434 http_common_cmp_addresses (w->address,
2441 GNUNET_free (saddr);
2446 LOG (GNUNET_ERROR_TYPE_DEBUG,
2447 "Notifying transport to remove address `%s'\n",
2448 http_common_plugin_address_to_string (plugin->protocol,
2451 GNUNET_CONTAINER_DLL_remove (plugin->addr_head,
2454 /* modify our published address list */
2456 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2457 "https_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2459 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2460 "http_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2462 plugin->env->notify_address (plugin->env->cls, add_remove, address);
2463 GNUNET_HELLO_address_free (address);
2464 GNUNET_free (w->address);
2471 * Our external IP address/port mapping has changed.
2473 * @param cls closure, the 'struct LocalAddrList'
2474 * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
2475 * the previous (now invalid) one
2476 * @param ac address class the address belongs to
2477 * @param addr either the previous or the new public IP address
2478 * @param addrlen actual lenght of the address
2481 server_nat_port_map_callback (void *cls,
2483 enum GNUNET_NAT_AddressClass ac,
2484 const struct sockaddr *addr,
2487 struct HTTP_Server_Plugin *plugin = cls;
2489 LOG (GNUNET_ERROR_TYPE_DEBUG,
2490 "NAT called to %s address `%s'\n",
2491 (add_remove == GNUNET_NO) ? "remove" : "add",
2492 GNUNET_a2s (addr, addrlen));
2494 if (AF_INET == addr->sa_family)
2496 struct sockaddr_in *s4 = (struct sockaddr_in *) addr;
2498 if (GNUNET_NO == plugin->use_ipv4)
2501 if ((NULL != plugin->server_addr_v4) &&
2502 (0 != memcmp (&plugin->server_addr_v4->sin_addr,
2504 sizeof (struct in_addr))))
2506 LOG (GNUNET_ERROR_TYPE_DEBUG,
2507 "Skipping address `%s' (not bindto address)\n",
2508 GNUNET_a2s (addr, addrlen));
2513 if (AF_INET6 == addr->sa_family)
2515 struct sockaddr_in6 *s6 = (struct sockaddr_in6 *) addr;
2516 if (GNUNET_NO == plugin->use_ipv6)
2519 if ((NULL != plugin->server_addr_v6) &&
2520 (0 != memcmp (&plugin->server_addr_v6->sin6_addr,
2521 &s6->sin6_addr, sizeof (struct in6_addr))))
2523 LOG (GNUNET_ERROR_TYPE_DEBUG,
2524 "Skipping address `%s' (not bindto address)\n",
2525 GNUNET_a2s (addr, addrlen));
2533 server_add_address (cls, add_remove, addr, addrlen);
2536 server_remove_address (cls, add_remove, addr, addrlen);
2543 * Get valid server addresses
2545 * @param plugin the plugin handle
2546 * @param service_name the servicename
2547 * @param cfg configuration handle
2548 * @param addrs addresses
2549 * @param addr_lens address length
2550 * @return number of addresses
2553 server_get_addresses (struct HTTP_Server_Plugin *plugin,
2554 const char *service_name,
2555 const struct GNUNET_CONFIGURATION_Handle *cfg,
2556 struct sockaddr ***addrs,
2557 socklen_t ** addr_lens)
2560 unsigned long long port;
2561 struct addrinfo hints;
2562 struct addrinfo *res;
2563 struct addrinfo *pos;
2564 struct addrinfo *next;
2568 struct sockaddr **saddrs;
2569 socklen_t *saddrlens;
2575 disablev6 = !plugin->use_ipv6;
2578 if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT"))
2580 GNUNET_break (GNUNET_OK ==
2581 GNUNET_CONFIGURATION_get_value_number (cfg, service_name,
2585 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2586 _("Require valid port number for service in configuration!\n"));
2587 return GNUNET_SYSERR;
2592 LOG (GNUNET_ERROR_TYPE_INFO,
2593 "Starting in listen only mode\n");
2594 return -1; /* listen only */
2598 if (GNUNET_CONFIGURATION_have_value (cfg, service_name,
2601 GNUNET_break (GNUNET_OK ==
2602 GNUNET_CONFIGURATION_get_value_string (cfg, service_name,
2603 "BINDTO", &hostname));
2608 if (NULL != hostname)
2610 LOG (GNUNET_ERROR_TYPE_DEBUG,
2611 "Resolving `%s' since that is where `%s' will bind to.\n",
2612 hostname, service_name);
2613 memset (&hints, 0, sizeof (struct addrinfo));
2615 hints.ai_family = AF_INET;
2616 if ((0 != (ret = getaddrinfo (hostname, NULL, &hints, &res))) ||
2619 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2620 _("Failed to resolve `%s': %s\n"),
2622 gai_strerror (ret));
2623 GNUNET_free (hostname);
2624 return GNUNET_SYSERR;
2628 while (NULL != (pos = next))
2630 next = pos->ai_next;
2631 if ((disablev6) && (pos->ai_family == AF_INET6))
2637 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2638 _("Failed to find %saddress for `%s'.\n"),
2639 disablev6 ? "IPv4 " : "", hostname);
2641 GNUNET_free (hostname);
2642 return GNUNET_SYSERR;
2645 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2646 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2649 while (NULL != (pos = next))
2651 next = pos->ai_next;
2652 if ((disablev6) && (pos->ai_family == AF_INET6))
2654 if ((pos->ai_protocol != IPPROTO_TCP) && (0 != pos->ai_protocol))
2655 continue; /* not TCP */
2656 if ((pos->ai_socktype != SOCK_STREAM) && (0 != pos->ai_socktype))
2657 continue; /* huh? */
2658 LOG (GNUNET_ERROR_TYPE_DEBUG,
2659 "Service will bind to `%s'\n",
2660 GNUNET_a2s (pos->ai_addr,
2662 if (pos->ai_family == AF_INET)
2664 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
2665 saddrlens[i] = pos->ai_addrlen;
2666 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2667 GNUNET_memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
2668 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2672 GNUNET_assert (pos->ai_family == AF_INET6);
2673 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
2674 saddrlens[i] = pos->ai_addrlen;
2675 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2676 GNUNET_memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
2677 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
2681 GNUNET_free (hostname);
2687 /* will bind against everything, just set port */
2693 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2694 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2696 saddrlens[i] = sizeof (struct sockaddr_in);
2697 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2698 #if HAVE_SOCKADDR_IN_SIN_LEN
2699 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
2701 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
2702 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2708 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2709 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2711 saddrlens[i] = sizeof (struct sockaddr_in6);
2712 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2713 #if HAVE_SOCKADDR_IN_SIN_LEN
2714 ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
2716 ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
2717 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
2719 saddrlens[i] = sizeof (struct sockaddr_in);
2720 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2721 #if HAVE_SOCKADDR_IN_SIN_LEN
2722 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
2724 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
2725 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2729 *addr_lens = saddrlens;
2735 * Ask NAT for addresses
2737 * @param plugin the plugin handle
2740 server_start_report_addresses (struct HTTP_Server_Plugin *plugin)
2742 int res = GNUNET_OK;
2743 struct sockaddr **addrs;
2744 socklen_t *addrlens;
2746 res = server_get_addresses (plugin,
2750 LOG (GNUNET_ERROR_TYPE_DEBUG,
2751 _("Found %u addresses to report to NAT service\n"),
2754 if (GNUNET_SYSERR == res)
2761 = GNUNET_NAT_register (plugin->env->cfg,
2762 "transport-http_server",
2765 (const struct sockaddr **) addrs,
2767 &server_nat_port_map_callback,
2773 GNUNET_assert (NULL != addrs[res]);
2774 GNUNET_free (addrs[res]);
2776 GNUNET_free_non_null (addrs);
2777 GNUNET_free_non_null (addrlens);
2782 * Stop NAT for addresses
2784 * @param plugin the plugin handle
2787 server_stop_report_addresses (struct HTTP_Server_Plugin *plugin)
2789 struct HttpAddressWrapper *w;
2791 /* Stop NAT handle */
2792 if (NULL != plugin->nat)
2794 GNUNET_NAT_unregister (plugin->nat);
2797 /* Clean up addresses */
2798 while (NULL != plugin->addr_head)
2800 w = plugin->addr_head;
2801 GNUNET_CONTAINER_DLL_remove (plugin->addr_head,
2804 GNUNET_free (w->address);
2811 * Check if IPv6 supported on this system
2813 * @param plugin the plugin handle
2814 * @return #GNUNET_YES on success, else #GNUNET_NO
2817 server_check_ipv6_support (struct HTTP_Server_Plugin *plugin)
2819 struct GNUNET_NETWORK_Handle *desc = NULL;
2820 int res = GNUNET_NO;
2822 /* Probe IPv6 support */
2823 desc = GNUNET_NETWORK_socket_create (PF_INET6,
2828 if ( (errno == ENOBUFS) ||
2829 (errno == ENOMEM) ||
2830 (errno == ENFILE) ||
2833 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
2836 LOG (GNUNET_ERROR_TYPE_WARNING,
2837 _("Disabling IPv6 since it is not supported on this system!\n"));
2842 GNUNET_break (GNUNET_OK ==
2843 GNUNET_NETWORK_socket_close (desc));
2847 LOG (GNUNET_ERROR_TYPE_DEBUG,
2848 "Testing IPv6 on this system: %s\n",
2849 (res == GNUNET_YES) ? "successful" : "failed");
2855 * Notify server about our external hostname
2860 server_notify_external_hostname (void *cls)
2862 struct HTTP_Server_Plugin *plugin = cls;
2863 struct HttpAddress *ext_addr;
2864 size_t ext_addr_len;
2868 plugin->notify_ext_task = NULL;
2869 GNUNET_asprintf (&url,
2872 plugin->external_hostname);
2873 urlen = strlen (url) + 1;
2874 ext_addr = GNUNET_malloc (sizeof (struct HttpAddress) + urlen);
2875 ext_addr->options = htonl (plugin->options);
2876 ext_addr->urlen = htonl (urlen);
2877 ext_addr_len = sizeof (struct HttpAddress) + urlen;
2878 GNUNET_memcpy (&ext_addr[1], url, urlen);
2881 LOG (GNUNET_ERROR_TYPE_DEBUG,
2882 "Notifying transport about external hostname address `%s'\n",
2883 plugin->external_hostname);
2886 if (GNUNET_YES == plugin->verify_external_hostname)
2887 LOG (GNUNET_ERROR_TYPE_INFO,
2888 "Enabling SSL verification for external hostname address `%s'\n",
2889 plugin->external_hostname);
2891 = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2895 GNUNET_HELLO_ADDRESS_INFO_NONE);
2896 plugin->env->notify_address (plugin->env->cls,
2899 GNUNET_free (ext_addr);
2902 = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2906 GNUNET_HELLO_ADDRESS_INFO_NONE);
2907 plugin->env->notify_address (plugin->env->cls,
2910 GNUNET_free (ext_addr);
2916 * Configure the plugin
2918 * @param plugin plugin handle
2919 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2922 server_configure_plugin (struct HTTP_Server_Plugin *plugin)
2924 unsigned long long port;
2925 unsigned long long max_connections;
2926 char *bind4_address = NULL;
2927 char *bind6_address = NULL;
2928 char *eh_tmp = NULL;
2929 int external_hostname_use_port;
2932 if (GNUNET_CONFIGURATION_have_value
2933 (plugin->env->cfg, plugin->name, "USE_IPv4"))
2936 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2941 plugin->use_ipv4 = GNUNET_YES;
2942 LOG (GNUNET_ERROR_TYPE_DEBUG,
2943 _("IPv4 support is %s\n"),
2944 (plugin->use_ipv4 == GNUNET_YES) ? "enabled" : "disabled");
2947 if (GNUNET_CONFIGURATION_have_value
2948 (plugin->env->cfg, plugin->name, "USE_IPv6"))
2951 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2956 plugin->use_ipv6 = GNUNET_YES;
2957 LOG (GNUNET_ERROR_TYPE_DEBUG,
2958 _("IPv6 support is %s\n"),
2959 (plugin->use_ipv6 == GNUNET_YES) ? "enabled" : "disabled");
2961 if ((plugin->use_ipv4 == GNUNET_NO) && (plugin->use_ipv6 == GNUNET_NO))
2963 LOG (GNUNET_ERROR_TYPE_ERROR,
2964 _("Neither IPv4 nor IPv6 are enabled! Fix in configuration\n"));
2965 return GNUNET_SYSERR;
2968 /* Reading port number from config file */
2970 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
2972 "PORT", &port)) || (port > 65535))
2974 LOG (GNUNET_ERROR_TYPE_ERROR,
2975 _("Port is required! Fix in configuration\n"));
2976 return GNUNET_SYSERR;
2978 plugin->port = port;
2980 LOG (GNUNET_ERROR_TYPE_INFO,
2981 _("Using port %u\n"), plugin->port);
2983 if ( (plugin->use_ipv4 == GNUNET_YES) &&
2985 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2990 LOG (GNUNET_ERROR_TYPE_DEBUG,
2991 "Binding %s plugin to specific IPv4 address: `%s'\n",
2994 plugin->server_addr_v4 = GNUNET_new (struct sockaddr_in);
2995 if (1 != inet_pton (AF_INET,
2997 &plugin->server_addr_v4->sin_addr))
2999 LOG (GNUNET_ERROR_TYPE_ERROR,
3000 _("Specific IPv4 address `%s' in configuration file is invalid!\n"),
3002 GNUNET_free (bind4_address);
3003 GNUNET_free (plugin->server_addr_v4);
3004 plugin->server_addr_v4 = NULL;
3005 return GNUNET_SYSERR;
3009 LOG (GNUNET_ERROR_TYPE_DEBUG,
3010 "Binding to IPv4 address %s\n",
3012 plugin->server_addr_v4->sin_family = AF_INET;
3013 plugin->server_addr_v4->sin_port = htons (plugin->port);
3015 GNUNET_free (bind4_address);
3018 if ((plugin->use_ipv6 == GNUNET_YES) &&
3020 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
3025 LOG (GNUNET_ERROR_TYPE_DEBUG,
3026 "Binding %s plugin to specific IPv6 address: `%s'\n",
3027 plugin->protocol, bind6_address);
3028 plugin->server_addr_v6 = GNUNET_new (struct sockaddr_in6);
3030 inet_pton (AF_INET6,
3032 &plugin->server_addr_v6->sin6_addr))
3034 LOG (GNUNET_ERROR_TYPE_ERROR,
3035 _("Specific IPv6 address `%s' in configuration file is invalid!\n"),
3037 GNUNET_free (bind6_address);
3038 GNUNET_free (plugin->server_addr_v6);
3039 plugin->server_addr_v6 = NULL;
3040 return GNUNET_SYSERR;
3044 LOG (GNUNET_ERROR_TYPE_DEBUG,
3045 "Binding to IPv6 address %s\n",
3047 plugin->server_addr_v6->sin6_family = AF_INET6;
3048 plugin->server_addr_v6->sin6_port = htons (plugin->port);
3050 GNUNET_free (bind6_address);
3053 plugin->verify_external_hostname = GNUNET_NO;
3055 plugin->verify_external_hostname
3056 = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3058 "VERIFY_EXTERNAL_HOSTNAME");
3059 if (GNUNET_SYSERR == plugin->verify_external_hostname)
3060 plugin->verify_external_hostname = GNUNET_NO;
3061 if (GNUNET_YES == plugin->verify_external_hostname)
3062 plugin->options |= HTTP_OPTIONS_VERIFY_CERTIFICATE;
3064 external_hostname_use_port
3065 = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3067 "EXTERNAL_HOSTNAME_USE_PORT");
3068 if (GNUNET_SYSERR == external_hostname_use_port)
3069 external_hostname_use_port = GNUNET_NO;
3073 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
3075 "EXTERNAL_HOSTNAME",
3080 char *pos_url = NULL;
3082 if (NULL != strstr(eh_tmp, "://"))
3083 tmp = &strstr(eh_tmp, "://")[3];
3087 if (GNUNET_YES == external_hostname_use_port)
3089 if ( (strlen (tmp) > 1) && (NULL != (pos = strchr(tmp, '/'))) )
3093 GNUNET_asprintf (&plugin->external_hostname,
3100 GNUNET_asprintf (&plugin->external_hostname,
3106 plugin->external_hostname = GNUNET_strdup (tmp);
3107 GNUNET_free (eh_tmp);
3109 LOG (GNUNET_ERROR_TYPE_INFO,
3110 _("Using external hostname `%s'\n"),
3111 plugin->external_hostname);
3112 plugin->notify_ext_task = GNUNET_SCHEDULER_add_now (&server_notify_external_hostname,
3115 /* Use only configured external hostname */
3116 if (GNUNET_CONFIGURATION_have_value
3119 "EXTERNAL_HOSTNAME_ONLY"))
3121 plugin->external_only =
3122 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3124 "EXTERNAL_HOSTNAME_ONLY");
3127 plugin->external_only = GNUNET_NO;
3129 if (GNUNET_YES == plugin->external_only)
3130 LOG (GNUNET_ERROR_TYPE_DEBUG,
3131 _("Notifying transport only about hostname `%s'\n"),
3132 plugin->external_hostname);
3135 LOG (GNUNET_ERROR_TYPE_DEBUG,
3136 "No external hostname configured\n");
3138 /* Optional parameters */
3140 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
3144 max_connections = 128;
3145 plugin->max_request = max_connections;
3147 LOG (GNUNET_ERROR_TYPE_DEBUG,
3148 _("Maximum number of connections is %u\n"),
3149 plugin->max_request);
3151 plugin->peer_id_length = strlen (GNUNET_i2s_full (plugin->env->my_identity));
3158 * Exit point from the plugin.
3164 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
3166 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
3167 struct HTTP_Server_Plugin *plugin = api->cls;
3169 if (NULL == api->cls)
3171 /* Free for stub mode */
3175 plugin->in_shutdown = GNUNET_YES;
3176 LOG (GNUNET_ERROR_TYPE_INFO,
3177 _("Shutting down plugin `%s'\n"),
3180 if (NULL != plugin->notify_ext_task)
3182 GNUNET_SCHEDULER_cancel (plugin->notify_ext_task);
3183 plugin->notify_ext_task = NULL;
3186 if (NULL != plugin->ext_addr)
3188 LOG (GNUNET_ERROR_TYPE_DEBUG,
3189 "Notifying transport to remove address `%s'\n",
3190 http_common_plugin_address_to_string (plugin->protocol,
3191 plugin->ext_addr->address,
3192 plugin->ext_addr->address_length));
3194 plugin->env->notify_address (plugin->env->cls,
3198 plugin->env->notify_address (plugin->env->cls,
3202 GNUNET_HELLO_address_free (plugin->ext_addr);
3203 plugin->ext_addr = NULL;
3206 /* Stop to report addresses to transport service */
3207 server_stop_report_addresses (plugin);
3208 if (NULL != plugin->server_v4_task)
3210 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
3211 plugin->server_v4_task = NULL;
3214 if (NULL != plugin->server_v6_task)
3216 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
3217 plugin->server_v6_task = NULL;
3220 GNUNET_free_non_null (plugin->crypto_init);
3221 GNUNET_free_non_null (plugin->cert);
3222 GNUNET_free_non_null (plugin->key);
3224 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
3225 &destroy_session_shutdown_cb,
3227 GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
3228 plugin->sessions = NULL;
3229 if (NULL != plugin->server_v4)
3231 MHD_stop_daemon (plugin->server_v4);
3232 plugin->server_v4 = NULL;
3234 if (NULL != plugin->server_v6)
3236 MHD_stop_daemon (plugin->server_v6);
3237 plugin->server_v6 = NULL;
3240 GNUNET_free_non_null (plugin->external_hostname);
3241 GNUNET_free_non_null (plugin->ext_addr);
3242 GNUNET_free_non_null (plugin->server_addr_v4);
3243 GNUNET_free_non_null (plugin->server_addr_v6);
3244 regfree (&plugin->url_regex);
3246 LOG (GNUNET_ERROR_TYPE_DEBUG,
3247 _("Shutdown for plugin `%s' complete\n"),
3250 GNUNET_free (plugin);
3257 * Function called for a quick conversion of the binary address to
3258 * a numeric address. Note that the caller must not free the
3259 * address and that the next call to this function is allowed
3260 * to override the address again.
3263 * @param addr binary address
3264 * @param addrlen length of the address
3265 * @return string representing the same address
3268 http_server_plugin_address_to_string (void *cls,
3272 return http_common_plugin_address_to_string (PLUGIN_NAME,
3279 * Function obtain the network type for a session
3281 * @param cls closure (`struct HTTP_Server_Plugin *`)
3282 * @param session the session
3283 * @return the network type in HBO or #GNUNET_SYSERR
3285 static enum GNUNET_ATS_Network_Type
3286 http_server_plugin_get_network (void *cls,
3287 struct GNUNET_ATS_Session *session)
3289 return session->scope;
3294 * Function obtain the network type for an address.
3296 * @param cls closure (`struct Plugin *`)
3297 * @param address the address
3298 * @return the network type
3300 static enum GNUNET_ATS_Network_Type
3301 http_server_plugin_get_network_for_address (void *cls,
3302 const struct GNUNET_HELLO_Address *address)
3304 struct HTTP_Server_Plugin *plugin = cls;
3306 return http_common_get_network_for_address (plugin->env,
3312 * Function that will be called whenever the transport service wants to
3313 * notify the plugin that the inbound quota changed and that the plugin
3314 * should update it's delay for the next receive value
3316 * @param cls closure
3317 * @param peer which peer was the session for
3318 * @param session which session is being updated
3319 * @param delay new delay to use for receiving
3322 http_server_plugin_update_inbound_delay (void *cls,
3323 const struct GNUNET_PeerIdentity *peer,
3324 struct GNUNET_ATS_Session *session,
3325 struct GNUNET_TIME_Relative delay)
3327 session->next_receive = GNUNET_TIME_relative_to_absolute (delay);
3328 LOG (GNUNET_ERROR_TYPE_DEBUG,
3329 "New inbound delay %s\n",
3330 GNUNET_STRINGS_relative_time_to_string (delay,
3332 if (NULL != session->recv_wakeup_task)
3334 GNUNET_SCHEDULER_cancel (session->recv_wakeup_task);
3335 session->recv_wakeup_task
3336 = GNUNET_SCHEDULER_add_delayed (delay,
3344 * Return information about the given session to the
3347 * @param cls the `struct Plugin` with the monitor callback (`sic`)
3348 * @param peer peer we send information about
3349 * @param value our `struct GNUNET_ATS_Session` to send information about
3350 * @return #GNUNET_OK (continue to iterate)
3353 send_session_info_iter (void *cls,
3354 const struct GNUNET_PeerIdentity *peer,
3357 struct HTTP_Server_Plugin *plugin = cls;
3358 struct GNUNET_ATS_Session *session = value;
3360 notify_session_monitor (plugin,
3362 GNUNET_TRANSPORT_SS_INIT);
3368 * Begin monitoring sessions of a plugin. There can only
3369 * be one active monitor per plugin (i.e. if there are
3370 * multiple monitors, the transport service needs to
3371 * multiplex the generated events over all of them).
3373 * @param cls closure of the plugin
3374 * @param sic callback to invoke, NULL to disable monitor;
3375 * plugin will being by iterating over all active
3376 * sessions immediately and then enter monitor mode
3377 * @param sic_cls closure for @a sic
3380 http_server_plugin_setup_monitor (void *cls,
3381 GNUNET_TRANSPORT_SessionInfoCallback sic,
3384 struct HTTP_Server_Plugin *plugin = cls;
3387 plugin->sic_cls = sic_cls;
3390 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
3391 &send_session_info_iter,
3393 /* signal end of first iteration */
3394 sic (sic_cls, NULL, NULL);
3400 * Entry point for the plugin.
3406 LIBGNUNET_PLUGIN_TRANSPORT_INIT (void *cls)
3408 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
3409 struct GNUNET_TRANSPORT_PluginFunctions *api;
3410 struct HTTP_Server_Plugin *plugin;
3412 if (NULL == env->receive)
3414 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
3415 initialze the plugin or the API */
3416 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3418 api->address_to_string = &http_server_plugin_address_to_string;
3419 api->string_to_address = &http_common_plugin_string_to_address;
3420 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
3423 plugin = GNUNET_new (struct HTTP_Server_Plugin);
3425 plugin->sessions = GNUNET_CONTAINER_multipeermap_create (128,
3428 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3430 api->send = &http_server_plugin_send;
3431 api->disconnect_peer = &http_server_plugin_disconnect_peer;
3432 api->disconnect_session = &http_server_plugin_disconnect_session;
3433 api->query_keepalive_factor = &http_server_query_keepalive_factor;
3434 api->check_address = &http_server_plugin_address_suggested;
3435 api->get_session = &http_server_plugin_get_session;
3437 api->address_to_string = &http_server_plugin_address_to_string;
3438 api->string_to_address = &http_common_plugin_string_to_address;
3439 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
3440 api->get_network = &http_server_plugin_get_network;
3441 api->get_network_for_address = &http_server_plugin_get_network_for_address;
3442 api->update_session_timeout = &http_server_plugin_update_session_timeout;
3443 api->update_inbound_delay = &http_server_plugin_update_inbound_delay;
3444 api->setup_monitor = &http_server_plugin_setup_monitor;
3446 plugin->name = "transport-https_server";
3447 plugin->protocol = "https";
3449 plugin->name = "transport-http_server";
3450 plugin->protocol = "http";
3454 GNUNET_CONFIGURATION_get_value_yesno (env->cfg,
3459 plugin->options |= HTTP_OPTIONS_TCP_STEALTH;
3461 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3462 _("TCP_STEALTH not supported on this platform.\n"));
3463 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3468 /* Compile URL regex */
3469 if (regcomp (&plugin->url_regex,
3473 LOG (GNUNET_ERROR_TYPE_ERROR,
3474 _("Unable to compile URL regex\n"));
3475 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3479 /* Configure plugin */
3480 if (GNUNET_SYSERR == server_configure_plugin (plugin))
3482 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3486 /* Check IPv6 support */
3487 if (GNUNET_YES == plugin->use_ipv6)
3488 plugin->use_ipv6 = server_check_ipv6_support (plugin);
3490 /* Report addresses to transport service */
3491 if (GNUNET_NO == plugin->external_only)
3492 server_start_report_addresses (plugin);
3494 if (GNUNET_SYSERR == server_start (plugin))
3496 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3502 /* end of plugin_transport_http_server.c */