2 This file is part of GNUnet
3 Copyright (C) 2002-2014 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 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_lib.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 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.
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 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
494 * @param tc task context
497 server_wake_up (void *cls,
498 const struct GNUNET_SCHEDULER_TaskContext *tc)
500 struct Session *s = cls;
502 s->recv_wakeup_task = NULL;
503 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
505 LOG (GNUNET_ERROR_TYPE_DEBUG,
506 "Session %p: Waking up PUT handle\n",
508 MHD_resume_connection (s->server_recv->mhd_conn);
513 * Reschedule the execution of both IPv4 and IPv6 server.
515 * @param plugin the plugin
516 * @param server which server to schedule v4 or v6?
517 * @param now #GNUNET_YES to schedule execution immediately, #GNUNET_NO to wait
521 server_reschedule (struct HTTP_Server_Plugin *plugin,
522 struct MHD_Daemon *server,
527 * Deletes the session. Must not be used afterwards.
529 * @param s the session to delete
532 server_delete_session (struct Session *s)
534 struct HTTP_Server_Plugin *plugin = s->plugin;
535 struct HTTP_Message *msg;
537 if (NULL != s->timeout_task)
539 GNUNET_SCHEDULER_cancel (s->timeout_task);
540 s->timeout_task = NULL;
541 s->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
543 if (NULL != s->recv_wakeup_task)
545 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
546 s->recv_wakeup_task = NULL;
547 if (NULL != s->server_recv)
548 MHD_resume_connection (s->server_recv->mhd_conn);
550 GNUNET_assert (GNUNET_OK ==
551 GNUNET_CONTAINER_multipeermap_remove (plugin->sessions,
554 while (NULL != (msg = s->msg_head))
556 GNUNET_CONTAINER_DLL_remove (s->msg_head,
559 if (NULL != msg->transmit_cont)
560 msg->transmit_cont (msg->transmit_cont_cls,
564 msg->pos + msg->overhead);
565 GNUNET_assert (s->msgs_in_queue > 0);
567 GNUNET_assert (s->bytes_in_queue >= msg->size);
568 s->bytes_in_queue -= msg->size;
572 GNUNET_assert (0 == s->msgs_in_queue);
573 GNUNET_assert (0 == s->bytes_in_queue);
575 if (NULL != s->server_send)
577 LOG (GNUNET_ERROR_TYPE_DEBUG,
578 "Server: %p / %p Terminating inbound PUT session to peer `%s'\n",
580 GNUNET_i2s (&s->target));
581 s->server_send->session = NULL;
582 MHD_set_connection_option (s->server_send->mhd_conn,
583 MHD_CONNECTION_OPTION_TIMEOUT,
584 1 /* 0 = no timeout, so this is MIN */);
585 server_reschedule (plugin, s->server_send->mhd_daemon, GNUNET_YES);
588 if (NULL != s->server_recv)
590 LOG (GNUNET_ERROR_TYPE_DEBUG,
591 "Server: %p / %p Terminating inbound GET session to peer `%s'\n",
592 s, s->server_recv, GNUNET_i2s (&s->target));
593 s->server_recv->session = NULL;
594 MHD_set_connection_option (s->server_recv->mhd_conn,
595 MHD_CONNECTION_OPTION_TIMEOUT,
596 1 /* 0 = no timeout, so this is MIN */);
597 server_reschedule (plugin, s->server_recv->mhd_daemon, GNUNET_YES);
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",
624 * Disconnect session @a s by telling MHD to close the
625 * connections (reducing timeout, etc.).
627 * @param cls closure with the `struct HTTP_Server_Plugin`
628 * @param s the session
629 * @return #GNUNET_OK on success
632 http_server_plugin_disconnect_session (void *cls,
635 server_delete_session (s);
641 * Session was idle, so disconnect it
643 * @param cls the session
644 * @param tc task context
647 server_session_timeout (void *cls,
648 const struct GNUNET_SCHEDULER_TaskContext *tc)
650 struct Session *s = cls;
651 struct GNUNET_TIME_Relative left;
653 s->timeout_task = NULL;
654 left = GNUNET_TIME_absolute_get_remaining (s->timeout);
655 if (0 != left.rel_value_us)
657 /* not actually our turn yet, but let's at least update
658 the monitor, it may think we're about to die ... */
659 notify_session_monitor (s->plugin,
661 GNUNET_TRANSPORT_SS_UP);
662 s->timeout_task = GNUNET_SCHEDULER_add_delayed (left,
663 &server_session_timeout,
667 GNUNET_log (TIMEOUT_LOG,
668 "Session %p was idle for %s, disconnecting\n",
670 GNUNET_STRINGS_relative_time_to_string (HTTP_SERVER_SESSION_TIMEOUT,
672 server_delete_session (s);
677 * Increment session timeout due to activity session @a s
679 * @param s the session
682 server_reschedule_session_timeout (struct Session *s)
684 GNUNET_assert (NULL != s->timeout_task);
685 s->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
690 * Function that can be used by the transport service to transmit
691 * a message using the plugin. Note that in the case of a
692 * peer disconnecting, the continuation MUST be called
693 * prior to the disconnect notification itself. This function
694 * will be called with this peer's HELLO message to initiate
695 * a fresh connection to another peer.
698 * @param session which session must be used
699 * @param msgbuf the message to transmit
700 * @param msgbuf_size number of bytes in @a msgbuf
701 * @param priority how important is the message (most plugins will
702 * ignore message priority and just FIFO)
703 * @param to how long to wait at most for the transmission (does not
704 * require plugins to discard the message after the timeout,
705 * just advisory for the desired delay; most plugins will ignore
707 * @param cont continuation to call once the message has
708 * been transmitted (or if the transport is ready
709 * for the next transmission call; or if the
710 * peer disconnected...); can be NULL
711 * @param cont_cls closure for @a cont
712 * @return number of bytes used (on the physical network, with overheads);
713 * -1 on hard errors (i.e. address invalid); 0 is a legal value
714 * and does NOT mean that the message was not transmitted (DV)
717 http_server_plugin_send (void *cls,
718 struct Session *session,
721 unsigned int priority,
722 struct GNUNET_TIME_Relative to,
723 GNUNET_TRANSPORT_TransmitContinuation cont,
726 struct HTTP_Server_Plugin *plugin = cls;
727 struct HTTP_Message *msg;
728 ssize_t bytes_sent = 0;
731 LOG (GNUNET_ERROR_TYPE_DEBUG,
732 "Session %p/request %p: Sending message with %u to peer `%s'\n",
734 session->server_send,
736 GNUNET_i2s (&session->target));
738 /* create new message and schedule */
739 bytes_sent = sizeof (struct HTTP_Message) + msgbuf_size;
740 msg = GNUNET_malloc (bytes_sent);
742 msg->size = msgbuf_size;
744 msg->buf = (char *) &msg[1];
745 msg->transmit_cont = cont;
746 msg->transmit_cont_cls = cont_cls;
750 GNUNET_CONTAINER_DLL_insert_tail (session->msg_head,
753 session->msgs_in_queue++;
754 session->bytes_in_queue += msg->size;
755 notify_session_monitor (plugin,
757 GNUNET_TRANSPORT_SS_UP);
758 GNUNET_asprintf (&stat_txt,
759 "# bytes currently in %s_server buffers",
761 GNUNET_STATISTICS_update (plugin->env->stats,
762 stat_txt, msgbuf_size, GNUNET_NO);
763 GNUNET_free (stat_txt);
765 if (NULL != session->server_send)
766 server_reschedule (session->plugin,
767 session->server_send->mhd_daemon,
774 * Terminate session during shutdown.
776 * @param cls the `struct HTTP_Server_Plugin *`
777 * @param peer for which this is a session
778 * @param value the `struct Session` to clean up
779 * @return #GNUNET_OK (continue to iterate)
782 destroy_session_shutdown_cb (void *cls,
783 const struct GNUNET_PeerIdentity *peer,
786 struct Session *s = value;
787 struct ServerRequest *sc_send;
788 struct ServerRequest *sc_recv;
790 sc_send = s->server_send;
791 sc_recv = s->server_recv;
792 server_delete_session (s);
794 GNUNET_free_non_null (sc_send);
795 GNUNET_free_non_null (sc_recv);
803 * @param cls the `struct HTTP_Server_Plugin *`
804 * @param peer for which this is a session
805 * @param value the `struct Session` to clean up
806 * @return #GNUNET_OK (continue to iterate)
809 destroy_session_cb (void *cls,
810 const struct GNUNET_PeerIdentity *peer,
813 struct Session *s = value;
815 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 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
913 * @param tc task context
916 server_v4_run (void *cls,
917 const struct GNUNET_SCHEDULER_TaskContext *tc)
919 struct HTTP_Server_Plugin *plugin = cls;
921 plugin->server_v4_task = NULL;
922 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
924 plugin->server_v4_immediately = GNUNET_NO;
925 GNUNET_assert (MHD_YES == MHD_run (plugin->server_v4));
926 server_reschedule (plugin, plugin->server_v4, GNUNET_NO);
931 * Call MHD IPv6 to process pending requests and then go back
932 * and schedule the next run.
934 * @param cls plugin as closure
935 * @param tc task context
938 server_v6_run (void *cls,
939 const struct GNUNET_SCHEDULER_TaskContext *tc)
941 struct HTTP_Server_Plugin *plugin = cls;
943 plugin->server_v6_task = NULL;
944 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
946 plugin->server_v6_immediately = GNUNET_NO;
947 GNUNET_assert (MHD_YES == MHD_run (plugin->server_v6));
948 server_reschedule (plugin, plugin->server_v6, GNUNET_NO);
953 * Function that queries MHD's select sets and
954 * starts the task waiting for them.
956 * @param plugin plugin
957 * @param daemon_handle the MHD daemon handle
958 * @param now schedule now
959 * @return gnunet task identifier
961 static struct GNUNET_SCHEDULER_Task *
962 server_schedule (struct HTTP_Server_Plugin *plugin,
963 struct MHD_Daemon *daemon_handle,
966 struct GNUNET_SCHEDULER_Task * ret;
970 struct GNUNET_NETWORK_FDSet *wrs;
971 struct GNUNET_NETWORK_FDSet *wws;
973 MHD_UNSIGNED_LONG_LONG timeout;
974 static unsigned long long last_timeout = 0;
976 struct GNUNET_TIME_Relative tv;
978 if (GNUNET_YES == plugin->in_shutdown)
985 wrs = GNUNET_NETWORK_fdset_create ();
986 wws = GNUNET_NETWORK_fdset_create ();
988 GNUNET_assert (MHD_YES ==
989 MHD_get_fdset (daemon_handle,
994 haveto = MHD_get_timeout (daemon_handle, &timeout);
995 if (haveto == MHD_YES)
997 if (timeout != last_timeout)
999 LOG (GNUNET_ERROR_TYPE_DEBUG,
1000 "SELECT Timeout changed from %llu to %llu (ms)\n",
1001 last_timeout, timeout);
1002 last_timeout = timeout;
1004 if (timeout <= GNUNET_TIME_UNIT_SECONDS.rel_value_us / 1000LL)
1005 tv.rel_value_us = (uint64_t) timeout * 1000LL;
1007 tv = GNUNET_TIME_UNIT_SECONDS;
1010 tv = GNUNET_TIME_UNIT_SECONDS;
1011 /* Force immediate run, since we have outbound data to send */
1012 if (now == GNUNET_YES)
1013 tv = GNUNET_TIME_UNIT_MILLISECONDS;
1014 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
1015 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
1017 if (daemon_handle == plugin->server_v4)
1019 if (plugin->server_v4_task != NULL)
1021 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
1022 plugin->server_v4_task = NULL;
1025 LOG (GNUNET_ERROR_TYPE_DEBUG,
1026 "Scheduling IPv4 server task in %llu ms\n",
1030 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1032 &server_v4_run, plugin);
1034 if (daemon_handle == plugin->server_v6)
1036 if (plugin->server_v6_task != NULL)
1038 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
1039 plugin->server_v6_task = NULL;
1042 LOG (GNUNET_ERROR_TYPE_DEBUG,
1043 "Scheduling IPv6 server task in %llu ms\n", tv);
1046 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1048 &server_v6_run, plugin);
1050 GNUNET_NETWORK_fdset_destroy (wrs);
1051 GNUNET_NETWORK_fdset_destroy (wws);
1057 * Reschedule the execution of both IPv4 and IPv6 server
1059 * @param plugin the plugin
1060 * @param server which server to schedule v4 or v6?
1061 * @param now #GNUNET_YES to schedule execution immediately, #GNUNET_NO to wait
1065 server_reschedule (struct HTTP_Server_Plugin *plugin,
1066 struct MHD_Daemon *server,
1069 if ((server == plugin->server_v4) && (plugin->server_v4 != NULL))
1071 if (GNUNET_YES == plugin->server_v4_immediately)
1072 return; /* No rescheduling, server will run asap */
1074 if (GNUNET_YES == now)
1075 plugin->server_v4_immediately = GNUNET_YES;
1077 if (plugin->server_v4_task != NULL)
1079 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
1080 plugin->server_v4_task = NULL;
1082 plugin->server_v4_task = server_schedule (plugin, plugin->server_v4, now);
1085 if ((server == plugin->server_v6) && (plugin->server_v6 != NULL))
1087 if (GNUNET_YES == plugin->server_v6_immediately)
1088 return; /* No rescheduling, server will run asap */
1090 if (GNUNET_YES == now)
1091 plugin->server_v6_immediately = GNUNET_YES;
1093 if (plugin->server_v6_task != NULL)
1095 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
1096 plugin->server_v6_task = NULL;
1098 plugin->server_v6_task = server_schedule (plugin, plugin->server_v6, now);
1104 * Function that is called to get the keepalive factor.
1105 * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
1106 * calculate the interval between keepalive packets.
1108 * @param cls closure with the `struct HTTP_Server_Plugin`
1109 * @return keepalive factor
1112 http_server_query_keepalive_factor (void *cls)
1119 * Function that will be called whenever the transport service wants to
1120 * notify the plugin that a session is still active and in use and
1121 * therefore the session timeout for this session has to be updated
1123 * @param cls closure
1124 * @param peer which peer was the session for
1125 * @param session which session is being updated
1128 http_server_plugin_update_session_timeout (void *cls,
1129 const struct GNUNET_PeerIdentity *peer,
1130 struct Session *session)
1132 server_reschedule_session_timeout (session);
1137 * Tell MHD that the connection should timeout after @a to seconds.
1139 * @param plugin our plugin
1140 * @param s session for which the timeout changes
1141 * @param to timeout in seconds
1144 server_mhd_connection_timeout (struct HTTP_Server_Plugin *plugin,
1148 /* Setting timeouts for other connections */
1149 if (NULL != s->server_recv)
1151 LOG (GNUNET_ERROR_TYPE_DEBUG,
1152 "Setting timeout for %p to %u sec.\n",
1153 s->server_recv, to);
1154 MHD_set_connection_option (s->server_recv->mhd_conn,
1155 MHD_CONNECTION_OPTION_TIMEOUT,
1157 server_reschedule (plugin, s->server_recv->mhd_daemon, GNUNET_NO);
1159 if (NULL != s->server_send)
1161 LOG (GNUNET_ERROR_TYPE_DEBUG,
1162 "Setting timeout for %p to %u sec.\n",
1163 s->server_send, to);
1164 MHD_set_connection_option (s->server_send->mhd_conn,
1165 MHD_CONNECTION_OPTION_TIMEOUT,
1167 server_reschedule (plugin, s->server_send->mhd_daemon, GNUNET_NO);
1173 * Parse incoming URL for tag and target
1175 * @param plugin plugin
1176 * @param url incoming url
1177 * @param target where to store the target
1178 * @param tag where to store the tag
1179 * @param options where to store the options
1180 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1183 server_parse_url (struct HTTP_Server_Plugin *plugin,
1185 struct GNUNET_PeerIdentity *target,
1189 regmatch_t matches[4];
1190 const char *tag_start;
1191 const char *target_start;
1195 unsigned long int rc;
1199 ("^.*/([0-9A-Z]+);([0-9]+)(,[0-9]+)?$")
1204 return GNUNET_SYSERR;
1207 if (regexec(&plugin->url_regex, url, 4, matches, 0))
1209 LOG (GNUNET_ERROR_TYPE_DEBUG,
1210 "URL `%s' did not match regex\n", url);
1211 return GNUNET_SYSERR;
1214 target_start = &url[matches[1].rm_so];
1215 tag_start = &url[matches[2].rm_so];
1218 rc = strtoul (tag_start, &tag_end, 10);
1219 if (&url[matches[2].rm_eo] != tag_end)
1221 LOG (GNUNET_ERROR_TYPE_DEBUG,
1222 "URL tag did not line up with submatch\n");
1223 return GNUNET_SYSERR;
1227 LOG (GNUNET_ERROR_TYPE_DEBUG,
1228 "URL tag is zero\n");
1229 return GNUNET_SYSERR;
1231 if ((rc == ULONG_MAX) && (ERANGE == errno))
1233 LOG (GNUNET_ERROR_TYPE_DEBUG,
1234 "URL tag > ULONG_MAX\n");
1235 return GNUNET_SYSERR;
1237 if (rc > UINT32_MAX)
1239 LOG (GNUNET_ERROR_TYPE_DEBUG,
1240 "URL tag > UINT32_MAX\n");
1241 return GNUNET_SYSERR;
1243 (*tag) = (uint32_t)rc;
1244 LOG (GNUNET_ERROR_TYPE_DEBUG,
1245 "Found tag `%u' in url\n",
1248 /* convert peer id */
1249 hash_length = matches[1].rm_eo - matches[1].rm_so;
1250 if (hash_length != plugin->peer_id_length)
1252 LOG (GNUNET_ERROR_TYPE_DEBUG,
1253 "URL target is %u bytes, expecting %u\n",
1254 hash_length, plugin->peer_id_length);
1255 return GNUNET_SYSERR;
1258 GNUNET_CRYPTO_eddsa_public_key_from_string (target_start,
1260 &target->public_key))
1262 LOG (GNUNET_ERROR_TYPE_DEBUG,
1263 "URL target conversion failed\n");
1264 return GNUNET_SYSERR;
1266 LOG (GNUNET_ERROR_TYPE_DEBUG,
1267 "Found target `%s' in URL\n",
1268 GNUNET_i2s_full (target));
1270 /* convert options */
1271 if (-1 == matches[3].rm_so)
1277 rc = strtoul (&url[matches[3].rm_so + 1], &options_end, 10);
1278 if (&url[matches[3].rm_eo] != options_end)
1280 LOG (GNUNET_ERROR_TYPE_DEBUG,
1281 "URL options did not line up with submatch\n");
1282 return GNUNET_SYSERR;
1284 if ((rc == ULONG_MAX) && (ERANGE == errno))
1286 LOG (GNUNET_ERROR_TYPE_DEBUG,
1287 "URL options > ULONG_MAX\n");
1288 return GNUNET_SYSERR;
1290 if (rc > UINT32_MAX)
1292 LOG (GNUNET_ERROR_TYPE_DEBUG,
1293 "URL options > UINT32_MAX\n");
1294 return GNUNET_SYSERR;
1296 (*options) = (uint32_t) rc;
1297 LOG (GNUNET_ERROR_TYPE_DEBUG,
1298 "Found options `%u' in url\n",
1306 * Closure for #session_tag_it().
1308 struct SessionTagContext
1311 * Set to session matching the tag.
1313 struct Session *res;
1316 * Tag we are looking for.
1323 * Find a session with a matching tag.
1325 * @param cls the `struct SessionTagContext *`
1326 * @param key peer identity (unused)
1327 * @param value the `struct Session *`
1328 * @return #GNUNET_NO if we found the session, #GNUNET_OK if not
1331 session_tag_it (void *cls,
1332 const struct GNUNET_PeerIdentity *key,
1335 struct SessionTagContext *stc = cls;
1336 struct Session *s = value;
1338 if (s->tag == stc->tag)
1348 * Lookup a mhd connection and create one if none is found
1350 * @param plugin the plugin handle
1351 * @param mhd_connection the incoming mhd_connection
1352 * @param url incoming requested URL
1353 * @param method PUT or GET
1354 * @return the server connecetion
1356 static struct ServerRequest *
1357 server_lookup_connection (struct HTTP_Server_Plugin *plugin,
1358 struct MHD_Connection *mhd_connection,
1362 struct Session *s = NULL;
1363 struct ServerRequest *sc = NULL;
1364 const union MHD_ConnectionInfo *conn_info;
1365 struct HttpAddress *addr;
1366 struct GNUNET_PeerIdentity target;
1368 struct SessionTagContext stc;
1370 int direction = GNUNET_SYSERR;
1372 enum GNUNET_ATS_Network_Type scope;
1374 conn_info = MHD_get_connection_info (mhd_connection,
1375 MHD_CONNECTION_INFO_CLIENT_ADDRESS);
1376 if ((conn_info->client_addr->sa_family != AF_INET) &&
1377 (conn_info->client_addr->sa_family != AF_INET6))
1379 LOG (GNUNET_ERROR_TYPE_DEBUG,
1380 "New %s request from %s\n",
1384 options = 0; /* make gcc happy */
1385 if (GNUNET_SYSERR ==
1386 server_parse_url (plugin, url, &target, &stc.tag, &options))
1388 LOG (GNUNET_ERROR_TYPE_DEBUG,
1389 "Invalid url %s\n", url);
1392 if (0 == strcmp (MHD_HTTP_METHOD_PUT, method))
1393 direction = _RECEIVE;
1394 else if (0 == strcmp (MHD_HTTP_METHOD_GET, method))
1398 LOG (GNUNET_ERROR_TYPE_DEBUG,
1399 "Invalid method %s for request from %s\n",
1404 plugin->cur_request++;
1405 LOG (GNUNET_ERROR_TYPE_DEBUG,
1406 "New %s request from %s with tag %u (%u of %u)\n",
1408 GNUNET_i2s (&target),
1410 plugin->cur_request, plugin->max_request);
1411 /* find existing session */
1413 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
1417 if (NULL == (s = stc.res))
1419 /* create new session */
1421 switch (conn_info->client_addr->sa_family)
1424 addr = http_common_address_from_socket (plugin->protocol,
1425 conn_info->client_addr,
1426 sizeof (struct sockaddr_in));
1427 addr_len = http_common_address_get_size (addr);
1428 scope = plugin->env->get_address_type (plugin->env->cls,
1429 conn_info->client_addr,
1430 sizeof (struct sockaddr_in));
1433 addr = http_common_address_from_socket (plugin->protocol,
1434 conn_info->client_addr,
1435 sizeof (struct sockaddr_in6));
1436 addr_len = http_common_address_get_size (addr);
1437 scope = plugin->env->get_address_type (plugin->env->cls,
1438 conn_info->client_addr,
1439 sizeof (struct sockaddr_in6));
1442 /* external host name */
1445 s = GNUNET_new (struct Session);
1449 s->address = GNUNET_HELLO_address_allocate (&s->target,
1453 GNUNET_HELLO_ADDRESS_INFO_INBOUND);
1454 s->next_receive = GNUNET_TIME_UNIT_ZERO_ABS;
1456 s->timeout = GNUNET_TIME_relative_to_absolute (HTTP_SERVER_SESSION_TIMEOUT);
1457 s->timeout_task = GNUNET_SCHEDULER_add_delayed (HTTP_SERVER_SESSION_TIMEOUT,
1458 &server_session_timeout,
1460 (void) GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
1463 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1464 notify_session_monitor (plugin,
1466 GNUNET_TRANSPORT_SS_INIT);
1467 notify_session_monitor (plugin,
1469 GNUNET_TRANSPORT_SS_HANDSHAKE);
1470 LOG (GNUNET_ERROR_TYPE_DEBUG,
1471 "Creating new session %p for peer `%s' connecting from `%s'\n",
1472 s, GNUNET_i2s (&target),
1473 http_common_plugin_address_to_string (plugin->protocol,
1476 GNUNET_free_non_null (addr);
1479 if ( (_RECEIVE == direction) &&
1480 (NULL != s->server_recv) )
1482 LOG (GNUNET_ERROR_TYPE_DEBUG,
1483 "Duplicate PUT request from `%s' tag %u, dismissing new request\n",
1484 GNUNET_i2s (&target),
1488 if ((_SEND == direction) && (NULL != s->server_send))
1490 LOG (GNUNET_ERROR_TYPE_DEBUG,
1491 "Duplicate GET request from `%s' tag %u, dismissing new request\n",
1492 GNUNET_i2s (&target),
1496 sc = GNUNET_new (struct ServerRequest);
1497 if (conn_info->client_addr->sa_family == AF_INET)
1498 sc->mhd_daemon = plugin->server_v4;
1499 if (conn_info->client_addr->sa_family == AF_INET6)
1500 sc->mhd_daemon = plugin->server_v6;
1501 sc->mhd_conn = mhd_connection;
1502 sc->direction = direction;
1503 sc->connected = GNUNET_NO;
1505 sc->options = options;
1506 if (direction == _SEND)
1508 s->server_send = sc;
1510 if (direction == _RECEIVE)
1512 s->server_recv = sc;
1515 if ((GNUNET_NO == s->known_to_service) &&
1516 (NULL != s->server_send) &&
1517 (NULL != s->server_recv) )
1519 s->known_to_service = GNUNET_YES;
1520 notify_session_monitor (plugin,
1522 GNUNET_TRANSPORT_SS_UP);
1523 plugin->env->session_start (plugin->env->cls,
1529 to = (HTTP_SERVER_SESSION_TIMEOUT.rel_value_us / 1000LL / 1000LL);
1530 server_mhd_connection_timeout (plugin, s, to);
1536 * Callback called by MHD when it needs data to send
1538 * @param cls current session
1539 * @param pos position in buffer
1540 * @param buf the buffer to write data to
1541 * @param max max number of bytes available in @a buf
1542 * @return bytes written to @a buf
1545 server_send_callback (void *cls,
1550 struct ServerRequest *sc = cls;
1551 struct Session *s = sc->session;
1552 ssize_t bytes_read = 0;
1553 struct HTTP_Message *msg;
1558 /* session is disconnecting */
1562 sc = s->server_send;
1569 bytes_read = GNUNET_MIN (msg->size - msg->pos,
1571 memcpy (buf, &msg->buf[msg->pos], bytes_read);
1572 msg->pos += bytes_read;
1574 /* removing message */
1575 if (msg->pos == msg->size)
1577 GNUNET_CONTAINER_DLL_remove (s->msg_head,
1580 if (NULL != msg->transmit_cont)
1581 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK,
1582 msg->size, msg->size + msg->overhead);
1583 GNUNET_assert (s->msgs_in_queue > 0);
1585 GNUNET_assert (s->bytes_in_queue >= msg->size);
1586 s->bytes_in_queue -= msg->size;
1588 notify_session_monitor (s->plugin,
1590 GNUNET_TRANSPORT_SS_UPDATE);
1595 sc->connected = GNUNET_YES;
1596 LOG (GNUNET_ERROR_TYPE_DEBUG,
1597 "Sent %u bytes to peer `%s' with session %p \n",
1599 GNUNET_i2s (&s->target),
1601 GNUNET_asprintf (&stat_txt,
1602 "# bytes currently in %s_server buffers",
1603 s->plugin->protocol);
1604 GNUNET_STATISTICS_update (s->plugin->env->stats,
1608 GNUNET_free (stat_txt);
1609 GNUNET_asprintf (&stat_txt,
1610 "# bytes transmitted via %s_server",
1611 s->plugin->protocol);
1612 GNUNET_STATISTICS_update (s->plugin->env->stats,
1613 stat_txt, bytes_read, GNUNET_NO);
1614 GNUNET_free (stat_txt);
1616 else if ((sc->options & OPTION_LONG_POLL) && sc->connected)
1618 LOG (GNUNET_ERROR_TYPE_DEBUG,
1619 "Completing GET response to peer `%s' with session %p\n",
1620 GNUNET_i2s (&s->target),
1622 return MHD_CONTENT_READER_END_OF_STREAM;
1629 * Callback called by MessageStreamTokenizer when a message has arrived
1631 * @param cls current session as closure
1632 * @param client client
1633 * @param message the message to be forwarded to transport service
1634 * @return #GNUNET_OK
1637 server_receive_mst_cb (void *cls,
1639 const struct GNUNET_MessageHeader *message)
1641 struct Session *s = cls;
1642 struct HTTP_Server_Plugin *plugin = s->plugin;
1643 struct GNUNET_TIME_Relative delay;
1646 if (GNUNET_NO == s->known_to_service)
1648 s->known_to_service = GNUNET_YES;
1649 plugin->env->session_start (plugin->env->cls,
1653 notify_session_monitor (plugin,
1655 GNUNET_TRANSPORT_SS_UP);
1657 delay = plugin->env->receive (plugin->env->cls,
1661 GNUNET_asprintf (&stat_txt,
1662 "# bytes received via %s_server",
1664 GNUNET_STATISTICS_update (plugin->env->stats,
1665 stat_txt, ntohs (message->size), GNUNET_NO);
1666 GNUNET_free (stat_txt);
1667 s->next_receive = GNUNET_TIME_relative_to_absolute (delay);
1668 if (delay.rel_value_us > 0)
1670 LOG (GNUNET_ERROR_TYPE_DEBUG,
1671 "Peer `%s' address `%s' next read delayed for %s\n",
1672 GNUNET_i2s (&s->target),
1673 http_common_plugin_address_to_string (plugin->protocol,
1674 s->address->address,
1675 s->address->address_length),
1676 GNUNET_STRINGS_relative_time_to_string (delay,
1679 server_reschedule_session_timeout (s);
1685 * Add headers to a request indicating that we allow Cross-Origin Resource
1688 * @param response response object to modify
1691 add_cors_headers(struct MHD_Response *response)
1693 MHD_add_response_header (response,
1694 "Access-Control-Allow-Origin",
1696 MHD_add_response_header (response,
1697 "Access-Control-Allow-Methods",
1698 "GET, PUT, OPTIONS");
1699 MHD_add_response_header (response,
1700 "Access-Control-Max-Age",
1706 * MHD callback for a new incoming connection
1708 * @param cls the plugin handle
1709 * @param mhd_connection the mhd connection
1710 * @param url the requested URL
1711 * @param method GET or PUT
1712 * @param version HTTP version
1713 * @param upload_data upload data
1714 * @param upload_data_size size of @a upload_data
1715 * @param httpSessionCache the session cache to remember the connection
1716 * @return MHD_YES if connection is accepted, MHD_NO on reject
1719 server_access_cb (void *cls,
1720 struct MHD_Connection *mhd_connection,
1723 const char *version,
1724 const char *upload_data,
1725 size_t *upload_data_size,
1726 void **httpSessionCache)
1728 struct HTTP_Server_Plugin *plugin = cls;
1729 struct ServerRequest *sc = *httpSessionCache;
1731 struct MHD_Response *response;
1734 LOG (GNUNET_ERROR_TYPE_DEBUG,
1735 _("Access from connection %p (%u of %u) for `%s' `%s' url `%s' with upload data size %u\n"),
1737 plugin->cur_request,
1738 plugin->max_request,
1742 (*upload_data_size));
1745 /* CORS pre-flight request */
1746 if (0 == strcmp (MHD_HTTP_METHOD_OPTIONS, method))
1748 response = MHD_create_response_from_buffer (0, NULL,
1749 MHD_RESPMEM_PERSISTENT);
1750 add_cors_headers(response);
1751 res = MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1752 MHD_destroy_response (response);
1755 /* new connection */
1756 sc = server_lookup_connection (plugin, mhd_connection, url, method);
1759 /* attach to new / existing session */
1760 (*httpSessionCache) = sc;
1764 /* existing session already has matching connection, refuse */
1765 response = MHD_create_response_from_buffer (strlen (HTTP_ERROR_RESPONSE),
1766 HTTP_ERROR_RESPONSE,
1767 MHD_RESPMEM_PERSISTENT);
1768 MHD_add_response_header (response,
1769 MHD_HTTP_HEADER_CONTENT_TYPE,
1771 add_cors_headers(response);
1772 res = MHD_queue_response (mhd_connection, MHD_HTTP_NOT_FOUND, response);
1773 MHD_destroy_response (response);
1777 /* 'old' connection */
1778 if (NULL == (s = sc->session))
1780 /* Session was already disconnected;
1781 sent HTTP/1.1: 200 OK as response */
1782 response = MHD_create_response_from_buffer (strlen ("Thank you!"),
1784 MHD_RESPMEM_PERSISTENT);
1785 add_cors_headers(response);
1786 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1787 MHD_destroy_response (response);
1791 if (sc->direction == _SEND)
1793 response = MHD_create_response_from_callback (MHD_SIZE_UNKNOWN, 32 * 1024,
1794 &server_send_callback, sc, NULL);
1795 add_cors_headers(response);
1796 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1797 MHD_destroy_response (response);
1800 if (sc->direction == _RECEIVE)
1802 if ((*upload_data_size == 0) && (sc->connected == GNUNET_NO))
1804 /* (*upload_data_size == 0) first callback when header are passed */
1805 LOG (GNUNET_ERROR_TYPE_DEBUG,
1806 "Session %p / Connection %p: Peer `%s' PUT on address `%s' connected\n",
1808 GNUNET_i2s (&s->target),
1809 http_common_plugin_address_to_string (plugin->protocol,
1810 s->address->address,
1811 s->address->address_length));
1812 sc->connected = GNUNET_YES;
1815 else if ((*upload_data_size == 0) && (sc->connected == GNUNET_YES))
1817 /* (*upload_data_size == 0) when upload is complete */
1818 LOG (GNUNET_ERROR_TYPE_DEBUG,
1819 "Session %p / Connection %p: Peer `%s' PUT on address `%s' finished upload\n",
1821 GNUNET_i2s (&s->target),
1822 http_common_plugin_address_to_string (plugin->protocol,
1823 s->address->address,
1824 s->address->address_length));
1825 sc->connected = GNUNET_NO;
1826 /* Sent HTTP/1.1: 200 OK as PUT Response\ */
1827 response = MHD_create_response_from_buffer (strlen ("Thank you!"),
1829 MHD_RESPMEM_PERSISTENT);
1830 add_cors_headers(response);
1831 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1832 MHD_destroy_response (response);
1835 else if ((*upload_data_size > 0) && (sc->connected == GNUNET_YES))
1837 struct GNUNET_TIME_Relative delay;
1839 /* (*upload_data_size > 0) for every segment received */
1840 LOG (GNUNET_ERROR_TYPE_DEBUG,
1841 "Session %p / Connection %p: Peer `%s' PUT on address `%s' received %u bytes\n",
1843 GNUNET_i2s (&s->target),
1844 http_common_plugin_address_to_string (plugin->protocol,
1845 s->address->address,
1846 s->address->address_length),
1848 delay = GNUNET_TIME_absolute_get_remaining (s->next_receive);
1849 if (0 == delay.rel_value_us)
1851 LOG (GNUNET_ERROR_TYPE_DEBUG,
1852 "PUT with %u bytes forwarded to MST\n",
1854 if (s->msg_tk == NULL)
1856 s->msg_tk = GNUNET_SERVER_mst_create (&server_receive_mst_cb, s);
1858 GNUNET_SERVER_mst_receive (s->msg_tk, s, upload_data, *upload_data_size,
1859 GNUNET_NO, GNUNET_NO);
1860 server_mhd_connection_timeout (plugin, s,
1861 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value_us / 1000LL
1863 (*upload_data_size) = 0;
1867 /* delay processing */
1868 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1869 "Session %p / Connection %p: no inbound bandwidth available! Next read was delayed by %s\n",
1870 s, sc, GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1871 GNUNET_assert(s->server_recv->mhd_conn == mhd_connection);
1872 MHD_suspend_connection (s->server_recv->mhd_conn);
1873 if (NULL == s->recv_wakeup_task)
1874 s->recv_wakeup_task = GNUNET_SCHEDULER_add_delayed (delay,
1875 &server_wake_up, s);
1890 * Callback from MHD when a connection disconnects
1892 * @param cls closure with the `struct HTTP_Server_Plugin *`
1893 * @param connection the disconnected MHD connection
1894 * @param httpSessionCache the pointer to distinguish
1897 server_disconnect_cb (void *cls,
1898 struct MHD_Connection *connection,
1899 void **httpSessionCache)
1901 struct HTTP_Server_Plugin *plugin = cls;
1902 struct ServerRequest *sc = *httpSessionCache;
1904 LOG (GNUNET_ERROR_TYPE_DEBUG,
1905 "Disconnect for connection %p\n",
1909 /* CORS pre-flight request finished */
1913 if (NULL != sc->session)
1915 if (sc->direction == _SEND)
1917 LOG (GNUNET_ERROR_TYPE_DEBUG,
1918 "Peer `%s' connection %p, GET on address `%s' disconnected\n",
1919 GNUNET_i2s (&sc->session->target),
1920 sc->session->server_send,
1921 http_common_plugin_address_to_string (plugin->protocol,
1922 sc->session->address->address,
1923 sc->session->address->address_length));
1925 sc->session->server_send = NULL;
1927 else if (sc->direction == _RECEIVE)
1929 LOG (GNUNET_ERROR_TYPE_DEBUG,
1930 "Peer `%s' connection %p PUT on address `%s' disconnected\n",
1931 GNUNET_i2s (&sc->session->target),
1932 sc->session->server_recv,
1933 http_common_plugin_address_to_string (plugin->protocol,
1934 sc->session->address->address,
1935 sc->session->address->address_length));
1936 sc->session->server_recv = NULL;
1937 if (NULL != sc->session->msg_tk)
1939 GNUNET_SERVER_mst_destroy (sc->session->msg_tk);
1940 sc->session->msg_tk = NULL;
1945 plugin->cur_request--;
1950 * Check if incoming connection is accepted.
1952 * @param cls plugin as closure
1953 * @param addr address of incoming connection
1954 * @param addr_len number of bytes in @a addr
1955 * @return MHD_YES if connection is accepted, MHD_NO if connection is rejected
1958 server_accept_cb (void *cls,
1959 const struct sockaddr *addr,
1962 struct HTTP_Server_Plugin *plugin = cls;
1964 if (plugin->cur_request <= plugin->max_request)
1966 LOG (GNUNET_ERROR_TYPE_DEBUG,
1967 _("Accepting connection (%u of %u) from `%s'\n"),
1968 plugin->cur_request, plugin->max_request,
1969 GNUNET_a2s (addr, addr_len));
1974 LOG (GNUNET_ERROR_TYPE_WARNING,
1975 _("Server reached maximum number connections (%u), rejecting new connection\n"),
1976 plugin->max_request);
1983 * Log function called by MHD.
1986 * @param fmt format string
1987 * @param ap arguments for the format string (va_start() and va_end()
1988 * will be called by MHD)
1991 server_log (void *arg,
2001 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2009 * Load ssl certificate from file
2011 * @param file filename
2012 * @return content of the file
2015 server_load_file (const char *file)
2017 struct GNUNET_DISK_FileHandle *gn_file;
2021 if (GNUNET_OK != GNUNET_DISK_file_size (file,
2022 &fsize, GNUNET_NO, GNUNET_YES))
2024 text = GNUNET_malloc (fsize + 1);
2026 GNUNET_DISK_file_open (file, GNUNET_DISK_OPEN_READ,
2027 GNUNET_DISK_PERM_USER_READ);
2028 if (NULL == gn_file)
2033 if (GNUNET_SYSERR == GNUNET_DISK_file_read (gn_file, text, fsize))
2036 GNUNET_DISK_file_close (gn_file);
2040 GNUNET_DISK_file_close (gn_file);
2048 * Load ssl certificate
2050 * @param plugin the plugin
2051 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2054 server_load_certificate (struct HTTP_Server_Plugin *plugin)
2056 int res = GNUNET_OK;
2062 GNUNET_CONFIGURATION_get_value_filename (plugin->env->cfg,
2064 "KEY_FILE", &key_file))
2066 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2067 plugin->name, "CERT_FILE");
2068 return GNUNET_SYSERR;
2071 GNUNET_CONFIGURATION_get_value_filename (plugin->env->cfg,
2073 "CERT_FILE", &cert_file))
2075 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2076 plugin->name, "CERT_FILE");
2077 GNUNET_free (key_file);
2078 return GNUNET_SYSERR;
2080 /* Get crypto init string from config. If not present, use
2083 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2086 &plugin->crypto_init))
2087 LOG (GNUNET_ERROR_TYPE_DEBUG,
2088 "Using crypto init string `%s'\n",
2089 plugin->crypto_init);
2091 LOG (GNUNET_ERROR_TYPE_DEBUG,
2092 "Using default crypto init string \n");
2094 /* read key & certificates from file */
2095 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2096 "Trying to loading TLS certificate from key-file `%s' cert-file`%s'\n",
2097 key_file, cert_file);
2099 plugin->key = server_load_file (key_file);
2100 plugin->cert = server_load_file (cert_file);
2102 if ((plugin->key == NULL) || (plugin->cert == NULL))
2104 struct GNUNET_OS_Process *cert_creation;
2106 GNUNET_free_non_null (plugin->key);
2108 GNUNET_free_non_null (plugin->cert);
2109 plugin->cert = NULL;
2111 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2112 "No usable TLS certificate found, creating certificate\n");
2115 GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
2117 "gnunet-transport-certificate-creation",
2118 "gnunet-transport-certificate-creation",
2122 if (NULL == cert_creation)
2124 LOG (GNUNET_ERROR_TYPE_ERROR,
2125 _("Could not create a new TLS certificate, program `gnunet-transport-certificate-creation' could not be started!\n"));
2126 GNUNET_free (key_file);
2127 GNUNET_free (cert_file);
2129 GNUNET_free_non_null (plugin->key);
2131 GNUNET_free_non_null (plugin->cert);
2132 plugin->cert = NULL;
2133 GNUNET_free_non_null (plugin->crypto_init);
2134 plugin->crypto_init = NULL;
2136 return GNUNET_SYSERR;
2138 GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (cert_creation));
2139 GNUNET_OS_process_destroy (cert_creation);
2141 plugin->key = server_load_file (key_file);
2142 plugin->cert = server_load_file (cert_file);
2145 if ((plugin->key == NULL) || (plugin->cert == NULL))
2147 LOG (GNUNET_ERROR_TYPE_ERROR,
2148 _("No usable TLS certificate found and creating one at `%s/%s' failed!\n"),
2149 key_file, cert_file);
2150 GNUNET_free (key_file);
2151 GNUNET_free (cert_file);
2153 GNUNET_free_non_null (plugin->key);
2155 GNUNET_free_non_null (plugin->cert);
2156 plugin->cert = NULL;
2157 GNUNET_free_non_null (plugin->crypto_init);
2158 plugin->crypto_init = NULL;
2160 return GNUNET_SYSERR;
2162 GNUNET_free (key_file);
2163 GNUNET_free (cert_file);
2164 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2165 "TLS certificate loaded\n");
2172 * Invoke `MHD_start_daemon` with the various options we need to
2173 * setup the HTTP server with the given listen address.
2175 * @param plugin our plugin
2176 * @param addr listen address to use
2177 * @param v6 MHD_NO_FLAG or MHD_USE_IPv6, depending on context
2178 * @return NULL on error
2180 static struct MHD_Daemon *
2181 run_mhd_start_daemon (struct HTTP_Server_Plugin *plugin,
2182 const struct sockaddr_in *addr,
2185 struct MHD_Daemon *server;
2186 unsigned int timeout;
2188 #if MHD_VERSION >= 0x00090E00
2189 timeout = HTTP_SERVER_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL / 1000LL;
2190 LOG (GNUNET_ERROR_TYPE_DEBUG,
2191 "MHD can set timeout per connection! Default time out %u sec.\n",
2194 timeout = HTTP_SERVER_SESSION_TIMEOUT.rel_value_us / 1000LL / 1000LL;
2195 LOG (GNUNET_ERROR_TYPE_WARNING,
2196 "MHD cannot set timeout per connection! Default time out %u sec.\n",
2199 server = MHD_start_daemon (
2206 MHD_USE_SUSPEND_RESUME |
2209 &server_accept_cb, plugin,
2210 &server_access_cb, plugin,
2211 MHD_OPTION_SOCK_ADDR,
2213 MHD_OPTION_CONNECTION_LIMIT,
2214 (unsigned int) plugin->max_request,
2216 MHD_OPTION_HTTPS_PRIORITIES,
2217 plugin->crypto_init,
2218 MHD_OPTION_HTTPS_MEM_KEY,
2220 MHD_OPTION_HTTPS_MEM_CERT,
2223 MHD_OPTION_CONNECTION_TIMEOUT,
2225 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
2227 GNUNET_SERVER_MAX_MESSAGE_SIZE),
2228 MHD_OPTION_NOTIFY_COMPLETED,
2229 &server_disconnect_cb, plugin,
2230 MHD_OPTION_EXTERNAL_LOGGER,
2234 if ( (NULL != server) &&
2235 (0 != (plugin->options & HTTP_OPTIONS_TCP_STEALTH)) )
2237 const union MHD_DaemonInfo *di;
2239 di = MHD_get_daemon_info (server,
2240 MHD_DAEMON_INFO_LISTEN_FD,
2242 if ( (0 != setsockopt ((int) di->listen_fd,
2245 plugin->env->my_identity,
2246 sizeof (struct GNUNET_PeerIdentity))) )
2248 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2249 _("TCP_STEALTH not supported on this platform.\n"));
2250 MHD_stop_daemon (server);
2260 * Start the HTTP server
2262 * @param plugin the plugin handle
2263 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2266 server_start (struct HTTP_Server_Plugin *plugin)
2270 GNUNET_assert (NULL != plugin);
2272 if (GNUNET_SYSERR == server_load_certificate (plugin))
2274 LOG (GNUNET_ERROR_TYPE_ERROR,
2275 _("Could not load or create server certificate! Loading plugin failed!\n"));
2276 return GNUNET_SYSERR;
2282 plugin->server_v4 = NULL;
2283 if (GNUNET_YES == plugin->use_ipv4)
2286 = run_mhd_start_daemon (plugin,
2287 (const struct sockaddr_in *) plugin->server_addr_v4,
2290 if (NULL == plugin->server_v4)
2292 LOG (GNUNET_ERROR_TYPE_ERROR,
2293 "Failed to start %s IPv4 server component on port %u\n",
2298 server_reschedule (plugin,
2304 plugin->server_v6 = NULL;
2305 if (GNUNET_YES == plugin->use_ipv6)
2308 = run_mhd_start_daemon (plugin,
2309 (const struct sockaddr_in *) plugin->server_addr_v6,
2311 if (NULL == plugin->server_v6)
2313 LOG (GNUNET_ERROR_TYPE_ERROR,
2314 "Failed to start %s IPv6 server component on port %u\n",
2320 server_reschedule (plugin,
2326 if ( (NULL == plugin->server_v6) &&
2327 (NULL == plugin->server_v4) )
2329 LOG (GNUNET_ERROR_TYPE_ERROR,
2330 "%s %s server component started on port %u\n",
2334 return GNUNET_SYSERR;
2336 if ((NULL != plugin->server_v6) &&
2337 (NULL != plugin->server_v4))
2338 msg = "IPv4 and IPv6";
2339 else if (NULL != plugin->server_v6)
2341 else if (NULL != plugin->server_v4)
2343 LOG (GNUNET_ERROR_TYPE_DEBUG,
2344 "%s %s server component started on port %u\n",
2353 * Add an address to the server's set of addresses and notify transport
2355 * @param cls the plugin handle
2356 * @param add_remove #GNUNET_YES on add, #GNUNET_NO on remove
2357 * @param addr the address
2358 * @param addrlen address length
2361 server_add_address (void *cls,
2363 const struct sockaddr *addr,
2366 struct HTTP_Server_Plugin *plugin = cls;
2367 struct GNUNET_HELLO_Address *address;
2368 struct HttpAddressWrapper *w = NULL;
2370 w = GNUNET_new (struct HttpAddressWrapper);
2371 w->address = http_common_address_from_socket (plugin->protocol,
2374 if (NULL == w->address)
2379 w->addrlen = http_common_address_get_size (w->address);
2381 GNUNET_CONTAINER_DLL_insert (plugin->addr_head,
2384 LOG (GNUNET_ERROR_TYPE_DEBUG,
2385 "Notifying transport to add address `%s'\n",
2386 http_common_plugin_address_to_string (plugin->protocol,
2389 /* modify our published address list */
2391 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2392 "https_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2394 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2395 "http_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2398 plugin->env->notify_address (plugin->env->cls,
2401 GNUNET_HELLO_address_free (address);
2406 * Remove an address from the server's set of addresses and notify transport
2408 * @param cls the plugin handle
2409 * @param add_remove #GNUNET_YES on add, #GNUNET_NO on remove
2410 * @param addr the address
2411 * @param addrlen address length
2414 server_remove_address (void *cls,
2416 const struct sockaddr *addr,
2419 struct HTTP_Server_Plugin *plugin = cls;
2420 struct GNUNET_HELLO_Address *address;
2421 struct HttpAddressWrapper *w = plugin->addr_head;
2425 saddr = http_common_address_from_socket (plugin->protocol,
2430 saddr_len = http_common_address_get_size (saddr);
2435 http_common_cmp_addresses (w->address,
2442 GNUNET_free (saddr);
2447 LOG (GNUNET_ERROR_TYPE_DEBUG,
2448 "Notifying transport to remove address `%s'\n",
2449 http_common_plugin_address_to_string (plugin->protocol,
2452 GNUNET_CONTAINER_DLL_remove (plugin->addr_head,
2455 /* modify our published address list */
2457 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2458 "https_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2460 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2461 "http_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2463 plugin->env->notify_address (plugin->env->cls, add_remove, address);
2464 GNUNET_HELLO_address_free (address);
2465 GNUNET_free (w->address);
2472 * Our external IP address/port mapping has changed.
2474 * @param cls closure, the 'struct LocalAddrList'
2475 * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
2476 * the previous (now invalid) one
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 const struct sockaddr *addr,
2486 struct HTTP_Server_Plugin *plugin = cls;
2488 LOG (GNUNET_ERROR_TYPE_DEBUG,
2489 "NAT called to %s address `%s'\n",
2490 (add_remove == GNUNET_NO) ? "remove" : "add",
2491 GNUNET_a2s (addr, addrlen));
2493 if (AF_INET == addr->sa_family)
2495 struct sockaddr_in *s4 = (struct sockaddr_in *) addr;
2497 if (GNUNET_NO == plugin->use_ipv4)
2500 if ((NULL != plugin->server_addr_v4) &&
2501 (0 != memcmp (&plugin->server_addr_v4->sin_addr,
2502 &s4->sin_addr, sizeof (struct in_addr))))
2504 LOG (GNUNET_ERROR_TYPE_DEBUG,
2505 "Skipping address `%s' (not bindto address)\n",
2506 GNUNET_a2s (addr, addrlen));
2511 if (AF_INET6 == addr->sa_family)
2513 struct sockaddr_in6 *s6 = (struct sockaddr_in6 *) addr;
2514 if (GNUNET_NO == plugin->use_ipv6)
2517 if ((NULL != plugin->server_addr_v6) &&
2518 (0 != memcmp (&plugin->server_addr_v6->sin6_addr,
2519 &s6->sin6_addr, sizeof (struct in6_addr))))
2521 LOG (GNUNET_ERROR_TYPE_DEBUG,
2522 "Skipping address `%s' (not bindto address)\n",
2523 GNUNET_a2s (addr, addrlen));
2531 server_add_address (cls, add_remove, addr, addrlen);
2534 server_remove_address (cls, add_remove, addr, addrlen);
2541 * Get valid server addresses
2543 * @param plugin the plugin handle
2544 * @param service_name the servicename
2545 * @param cfg configuration handle
2546 * @param addrs addresses
2547 * @param addr_lens address length
2548 * @return number of addresses
2551 server_get_addresses (struct HTTP_Server_Plugin *plugin,
2552 const char *service_name,
2553 const struct GNUNET_CONFIGURATION_Handle *cfg,
2554 struct sockaddr ***addrs,
2555 socklen_t ** addr_lens)
2558 unsigned long long port;
2559 struct addrinfo hints;
2560 struct addrinfo *res;
2561 struct addrinfo *pos;
2562 struct addrinfo *next;
2566 struct sockaddr **saddrs;
2567 socklen_t *saddrlens;
2573 disablev6 = !plugin->use_ipv6;
2576 if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT"))
2578 GNUNET_break (GNUNET_OK ==
2579 GNUNET_CONFIGURATION_get_value_number (cfg, service_name,
2583 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2584 _("Require valid port number for service in configuration!\n"));
2585 return GNUNET_SYSERR;
2590 LOG (GNUNET_ERROR_TYPE_INFO,
2591 "Starting in listen only mode\n");
2592 return -1; /* listen only */
2596 if (GNUNET_CONFIGURATION_have_value (cfg, service_name,
2599 GNUNET_break (GNUNET_OK ==
2600 GNUNET_CONFIGURATION_get_value_string (cfg, service_name,
2601 "BINDTO", &hostname));
2606 if (NULL != hostname)
2608 LOG (GNUNET_ERROR_TYPE_DEBUG,
2609 "Resolving `%s' since that is where `%s' will bind to.\n",
2610 hostname, service_name);
2611 memset (&hints, 0, sizeof (struct addrinfo));
2613 hints.ai_family = AF_INET;
2614 if ((0 != (ret = getaddrinfo (hostname, NULL, &hints, &res))) ||
2617 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2618 _("Failed to resolve `%s': %s\n"),
2620 gai_strerror (ret));
2621 GNUNET_free (hostname);
2622 return GNUNET_SYSERR;
2626 while (NULL != (pos = next))
2628 next = pos->ai_next;
2629 if ((disablev6) && (pos->ai_family == AF_INET6))
2635 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2636 _("Failed to find %saddress for `%s'.\n"),
2637 disablev6 ? "IPv4 " : "", hostname);
2639 GNUNET_free (hostname);
2640 return GNUNET_SYSERR;
2643 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2644 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2647 while (NULL != (pos = next))
2649 next = pos->ai_next;
2650 if ((disablev6) && (pos->ai_family == AF_INET6))
2652 if ((pos->ai_protocol != IPPROTO_TCP) && (0 != pos->ai_protocol))
2653 continue; /* not TCP */
2654 if ((pos->ai_socktype != SOCK_STREAM) && (0 != pos->ai_socktype))
2655 continue; /* huh? */
2656 LOG (GNUNET_ERROR_TYPE_DEBUG,
2657 "Service will bind to `%s'\n",
2658 GNUNET_a2s (pos->ai_addr,
2660 if (pos->ai_family == AF_INET)
2662 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
2663 saddrlens[i] = pos->ai_addrlen;
2664 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2665 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
2666 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2670 GNUNET_assert (pos->ai_family == AF_INET6);
2671 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
2672 saddrlens[i] = pos->ai_addrlen;
2673 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2674 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
2675 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
2679 GNUNET_free (hostname);
2685 /* will bind against everything, just set port */
2691 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2692 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2694 saddrlens[i] = sizeof (struct sockaddr_in);
2695 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2696 #if HAVE_SOCKADDR_IN_SIN_LEN
2697 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
2699 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
2700 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2706 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2707 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2709 saddrlens[i] = sizeof (struct sockaddr_in6);
2710 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2711 #if HAVE_SOCKADDR_IN_SIN_LEN
2712 ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
2714 ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
2715 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
2717 saddrlens[i] = sizeof (struct sockaddr_in);
2718 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2719 #if HAVE_SOCKADDR_IN_SIN_LEN
2720 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
2722 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
2723 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2727 *addr_lens = saddrlens;
2733 * Ask NAT for addresses
2735 * @param plugin the plugin handle
2738 server_start_report_addresses (struct HTTP_Server_Plugin *plugin)
2740 int res = GNUNET_OK;
2741 struct sockaddr **addrs;
2742 socklen_t *addrlens;
2744 res = server_get_addresses (plugin,
2748 LOG (GNUNET_ERROR_TYPE_DEBUG,
2749 _("Found %u addresses to report to NAT service\n"),
2752 if (GNUNET_SYSERR == res)
2759 GNUNET_NAT_register (plugin->env->cfg,
2763 (const struct sockaddr **) addrs, addrlens,
2764 &server_nat_port_map_callback, NULL, plugin, NULL);
2768 GNUNET_assert (NULL != addrs[res]);
2769 GNUNET_free (addrs[res]);
2771 GNUNET_free_non_null (addrs);
2772 GNUNET_free_non_null (addrlens);
2777 * Stop NAT for addresses
2779 * @param plugin the plugin handle
2782 server_stop_report_addresses (struct HTTP_Server_Plugin *plugin)
2784 struct HttpAddressWrapper *w;
2786 /* Stop NAT handle */
2787 if (NULL != plugin->nat)
2789 GNUNET_NAT_unregister (plugin->nat);
2792 /* Clean up addresses */
2793 while (NULL != plugin->addr_head)
2795 w = plugin->addr_head;
2796 GNUNET_CONTAINER_DLL_remove (plugin->addr_head,
2799 GNUNET_free (w->address);
2806 * Check if IPv6 supported on this system
2808 * @param plugin the plugin handle
2809 * @return #GNUNET_YES on success, else #GNUNET_NO
2812 server_check_ipv6_support (struct HTTP_Server_Plugin *plugin)
2814 struct GNUNET_NETWORK_Handle *desc = NULL;
2815 int res = GNUNET_NO;
2817 /* Probe IPv6 support */
2818 desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
2821 if ((errno == ENOBUFS) || (errno == ENOMEM) || (errno == ENFILE) ||
2824 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
2826 LOG (GNUNET_ERROR_TYPE_WARNING,
2827 _("Disabling IPv6 since it is not supported on this system!\n"));
2832 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
2836 LOG (GNUNET_ERROR_TYPE_DEBUG,
2837 "Testing IPv6 on this system: %s\n",
2838 (res == GNUNET_YES) ? "successful" : "failed");
2844 * Notify server about our external hostname
2847 * @param tc task context (unused)
2850 server_notify_external_hostname (void *cls,
2851 const struct GNUNET_SCHEDULER_TaskContext *tc)
2853 struct HTTP_Server_Plugin *plugin = cls;
2854 struct HttpAddress *ext_addr;
2855 size_t ext_addr_len;
2859 plugin->notify_ext_task = NULL;
2860 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
2863 GNUNET_asprintf(&url,
2866 plugin->external_hostname);
2868 urlen = strlen (url) + 1;
2869 ext_addr = GNUNET_malloc (sizeof (struct HttpAddress) + urlen);
2870 ext_addr->options = htonl (plugin->options);
2871 ext_addr->urlen = htonl (urlen);
2872 ext_addr_len = sizeof (struct HttpAddress) + urlen;
2873 memcpy (&ext_addr[1], url, urlen);
2876 LOG (GNUNET_ERROR_TYPE_DEBUG,
2877 "Notifying transport about external hostname address `%s'\n",
2878 plugin->external_hostname);
2881 if (GNUNET_YES == plugin->verify_external_hostname)
2882 LOG (GNUNET_ERROR_TYPE_INFO,
2883 "Enabling SSL verification for external hostname address `%s'\n",
2884 plugin->external_hostname);
2885 plugin->ext_addr = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2886 "https_client", ext_addr, ext_addr_len, GNUNET_HELLO_ADDRESS_INFO_NONE );
2887 plugin->env->notify_address (plugin->env->cls, GNUNET_YES, plugin->ext_addr);
2888 GNUNET_free (ext_addr);
2890 plugin->ext_addr = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2891 "http_client", ext_addr, ext_addr_len, GNUNET_HELLO_ADDRESS_INFO_NONE );
2892 plugin->env->notify_address (plugin->env->cls, GNUNET_YES, plugin->ext_addr);
2893 GNUNET_free (ext_addr);
2899 * Configure the plugin
2901 * @param plugin plugin handle
2902 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2905 server_configure_plugin (struct HTTP_Server_Plugin *plugin)
2907 unsigned long long port;
2908 unsigned long long max_connections;
2909 char *bind4_address = NULL;
2910 char *bind6_address = NULL;
2911 char *eh_tmp = NULL;
2912 int external_hostname_use_port;
2915 if (GNUNET_CONFIGURATION_have_value
2916 (plugin->env->cfg, plugin->name, "USE_IPv4"))
2919 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2924 plugin->use_ipv4 = GNUNET_YES;
2925 LOG (GNUNET_ERROR_TYPE_DEBUG,
2926 _("IPv4 support is %s\n"),
2927 (plugin->use_ipv4 == GNUNET_YES) ? "enabled" : "disabled");
2930 if (GNUNET_CONFIGURATION_have_value
2931 (plugin->env->cfg, plugin->name, "USE_IPv6"))
2934 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2939 plugin->use_ipv6 = GNUNET_YES;
2940 LOG (GNUNET_ERROR_TYPE_DEBUG,
2941 _("IPv6 support is %s\n"),
2942 (plugin->use_ipv6 == GNUNET_YES) ? "enabled" : "disabled");
2944 if ((plugin->use_ipv4 == GNUNET_NO) && (plugin->use_ipv6 == GNUNET_NO))
2946 LOG (GNUNET_ERROR_TYPE_ERROR,
2947 _("Neither IPv4 nor IPv6 are enabled! Fix in configuration\n"));
2948 return GNUNET_SYSERR;
2951 /* Reading port number from config file */
2953 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
2955 "PORT", &port)) || (port > 65535))
2957 LOG (GNUNET_ERROR_TYPE_ERROR,
2958 _("Port is required! Fix in configuration\n"));
2959 return GNUNET_SYSERR;
2961 plugin->port = port;
2963 LOG (GNUNET_ERROR_TYPE_INFO,
2964 _("Using port %u\n"), plugin->port);
2966 if ((plugin->use_ipv4 == GNUNET_YES) &&
2967 (GNUNET_YES == GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2968 plugin->name, "BINDTO", &bind4_address)))
2970 LOG (GNUNET_ERROR_TYPE_DEBUG,
2971 "Binding %s plugin to specific IPv4 address: `%s'\n",
2972 plugin->protocol, bind4_address);
2973 plugin->server_addr_v4 = GNUNET_new (struct sockaddr_in);
2974 if (1 != inet_pton (AF_INET, bind4_address,
2975 &plugin->server_addr_v4->sin_addr))
2977 LOG (GNUNET_ERROR_TYPE_ERROR,
2978 _("Specific IPv4 address `%s' in configuration file is invalid!\n"),
2980 GNUNET_free (bind4_address);
2981 GNUNET_free (plugin->server_addr_v4);
2982 plugin->server_addr_v4 = NULL;
2983 return GNUNET_SYSERR;
2987 LOG (GNUNET_ERROR_TYPE_DEBUG,
2988 _("Binding to IPv4 address %s\n"),
2990 plugin->server_addr_v4->sin_family = AF_INET;
2991 plugin->server_addr_v4->sin_port = htons (plugin->port);
2993 GNUNET_free (bind4_address);
2996 if ((plugin->use_ipv6 == GNUNET_YES) &&
2998 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
3000 "BINDTO6", &bind6_address)))
3002 LOG (GNUNET_ERROR_TYPE_DEBUG,
3003 "Binding %s plugin to specific IPv6 address: `%s'\n",
3004 plugin->protocol, bind6_address);
3005 plugin->server_addr_v6 = GNUNET_new (struct sockaddr_in6);
3007 inet_pton (AF_INET6, bind6_address, &plugin->server_addr_v6->sin6_addr))
3009 LOG (GNUNET_ERROR_TYPE_ERROR,
3010 _("Specific IPv6 address `%s' in configuration file is invalid!\n"),
3012 GNUNET_free (bind6_address);
3013 GNUNET_free (plugin->server_addr_v6);
3014 plugin->server_addr_v6 = NULL;
3015 return GNUNET_SYSERR;
3019 LOG (GNUNET_ERROR_TYPE_DEBUG,
3020 _("Binding to IPv6 address %s\n"),
3022 plugin->server_addr_v6->sin6_family = AF_INET6;
3023 plugin->server_addr_v6->sin6_port = htons (plugin->port);
3025 GNUNET_free (bind6_address);
3028 plugin->verify_external_hostname = GNUNET_NO;
3030 plugin->verify_external_hostname = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3032 "VERIFY_EXTERNAL_HOSTNAME");
3033 if (GNUNET_SYSERR == plugin->verify_external_hostname)
3034 plugin->verify_external_hostname = GNUNET_NO;
3035 if (GNUNET_YES == plugin->verify_external_hostname)
3036 plugin->options |= HTTP_OPTIONS_VERIFY_CERTIFICATE;
3038 external_hostname_use_port = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3040 "EXTERNAL_HOSTNAME_USE_PORT");
3041 if (GNUNET_SYSERR == external_hostname_use_port)
3042 external_hostname_use_port = GNUNET_NO;
3046 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
3048 "EXTERNAL_HOSTNAME",
3053 char *pos_url = NULL;
3055 if (NULL != strstr(eh_tmp, "://"))
3056 tmp = &strstr(eh_tmp, "://")[3];
3060 if (GNUNET_YES == external_hostname_use_port)
3062 if ( (strlen (tmp) > 1) && (NULL != (pos = strchr(tmp, '/'))) )
3066 GNUNET_asprintf (&plugin->external_hostname,
3070 (NULL == pos_url) ? "" : pos_url);
3073 GNUNET_asprintf (&plugin->external_hostname,
3079 plugin->external_hostname = GNUNET_strdup (tmp);
3080 GNUNET_free (eh_tmp);
3082 LOG (GNUNET_ERROR_TYPE_INFO,
3083 _("Using external hostname `%s'\n"),
3084 plugin->external_hostname);
3085 plugin->notify_ext_task = GNUNET_SCHEDULER_add_now (&server_notify_external_hostname,
3088 /* Use only configured external hostname */
3089 if (GNUNET_CONFIGURATION_have_value
3092 "EXTERNAL_HOSTNAME_ONLY"))
3094 plugin->external_only =
3095 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3097 "EXTERNAL_HOSTNAME_ONLY");
3100 plugin->external_only = GNUNET_NO;
3102 if (GNUNET_YES == plugin->external_only)
3103 LOG (GNUNET_ERROR_TYPE_DEBUG,
3104 _("Notifying transport only about hostname `%s'\n"),
3105 plugin->external_hostname);
3108 LOG (GNUNET_ERROR_TYPE_DEBUG,
3109 "No external hostname configured\n");
3111 /* Optional parameters */
3113 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
3117 max_connections = 128;
3118 plugin->max_request = max_connections;
3120 LOG (GNUNET_ERROR_TYPE_DEBUG,
3121 _("Maximum number of connections is %u\n"),
3122 plugin->max_request);
3124 plugin->peer_id_length = strlen (GNUNET_i2s_full (plugin->env->my_identity));
3131 * Exit point from the plugin.
3137 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
3139 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
3140 struct HTTP_Server_Plugin *plugin = api->cls;
3142 if (NULL == api->cls)
3144 /* Free for stub mode */
3148 plugin->in_shutdown = GNUNET_YES;
3149 LOG (GNUNET_ERROR_TYPE_INFO,
3150 _("Shutting down plugin `%s'\n"),
3153 if (NULL != plugin->notify_ext_task)
3155 GNUNET_SCHEDULER_cancel (plugin->notify_ext_task);
3156 plugin->notify_ext_task = NULL;
3159 if (NULL != plugin->ext_addr)
3161 LOG (GNUNET_ERROR_TYPE_DEBUG,
3162 "Notifying transport to remove address `%s'\n",
3163 http_common_plugin_address_to_string (plugin->protocol,
3164 plugin->ext_addr->address,
3165 plugin->ext_addr->address_length));
3167 plugin->env->notify_address (plugin->env->cls,
3171 plugin->env->notify_address (plugin->env->cls,
3175 GNUNET_HELLO_address_free (plugin->ext_addr);
3176 plugin->ext_addr = NULL;
3179 /* Stop to report addresses to transport service */
3180 server_stop_report_addresses (plugin);
3181 if (NULL != plugin->server_v4)
3183 MHD_stop_daemon (plugin->server_v4);
3184 plugin->server_v4 = NULL;
3186 if (NULL != plugin->server_v6)
3188 MHD_stop_daemon (plugin->server_v6);
3189 plugin->server_v6 = NULL;
3191 if (NULL != plugin->server_v4_task)
3193 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
3194 plugin->server_v4_task = NULL;
3197 if (NULL != plugin->server_v6_task)
3199 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
3200 plugin->server_v6_task = NULL;
3203 GNUNET_free_non_null (plugin->crypto_init);
3204 GNUNET_free_non_null (plugin->cert);
3205 GNUNET_free_non_null (plugin->key);
3207 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
3208 &destroy_session_shutdown_cb,
3210 GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
3211 plugin->sessions = NULL;
3213 GNUNET_free_non_null (plugin->external_hostname);
3214 GNUNET_free_non_null (plugin->ext_addr);
3215 GNUNET_free_non_null (plugin->server_addr_v4);
3216 GNUNET_free_non_null (plugin->server_addr_v6);
3217 regfree (&plugin->url_regex);
3219 LOG (GNUNET_ERROR_TYPE_DEBUG,
3220 _("Shutdown for plugin `%s' complete\n"),
3223 GNUNET_free (plugin);
3230 * Function called for a quick conversion of the binary address to
3231 * a numeric address. Note that the caller must not free the
3232 * address and that the next call to this function is allowed
3233 * to override the address again.
3236 * @param addr binary address
3237 * @param addrlen length of the address
3238 * @return string representing the same address
3241 http_server_plugin_address_to_string (void *cls,
3245 return http_common_plugin_address_to_string (PLUGIN_NAME,
3252 * Function obtain the network type for a session
3254 * @param cls closure ('struct HTTP_Server_Plugin*')
3255 * @param session the session
3256 * @return the network type in HBO or #GNUNET_SYSERR
3258 static enum GNUNET_ATS_Network_Type
3259 http_server_plugin_get_network (void *cls,
3260 struct Session *session)
3262 return session->scope;
3267 * Function that will be called whenever the transport service wants to
3268 * notify the plugin that the inbound quota changed and that the plugin
3269 * should update it's delay for the next receive value
3271 * @param cls closure
3272 * @param peer which peer was the session for
3273 * @param session which session is being updated
3274 * @param delay new delay to use for receiving
3277 http_server_plugin_update_inbound_delay (void *cls,
3278 const struct GNUNET_PeerIdentity *peer,
3279 struct Session *session,
3280 struct GNUNET_TIME_Relative delay)
3282 session->next_receive = GNUNET_TIME_relative_to_absolute (delay);
3283 LOG (GNUNET_ERROR_TYPE_DEBUG,
3284 "New inbound delay %s\n",
3285 GNUNET_STRINGS_relative_time_to_string (delay,
3287 if (NULL != session->recv_wakeup_task)
3289 GNUNET_SCHEDULER_cancel (session->recv_wakeup_task);
3290 session->recv_wakeup_task
3291 = GNUNET_SCHEDULER_add_delayed (delay,
3299 * Return information about the given session to the
3302 * @param cls the `struct Plugin` with the monitor callback (`sic`)
3303 * @param peer peer we send information about
3304 * @param value our `struct Session` to send information about
3305 * @return #GNUNET_OK (continue to iterate)
3308 send_session_info_iter (void *cls,
3309 const struct GNUNET_PeerIdentity *peer,
3312 struct HTTP_Server_Plugin *plugin = cls;
3313 struct Session *session = value;
3315 notify_session_monitor (plugin,
3317 GNUNET_TRANSPORT_SS_INIT);
3323 * Begin monitoring sessions of a plugin. There can only
3324 * be one active monitor per plugin (i.e. if there are
3325 * multiple monitors, the transport service needs to
3326 * multiplex the generated events over all of them).
3328 * @param cls closure of the plugin
3329 * @param sic callback to invoke, NULL to disable monitor;
3330 * plugin will being by iterating over all active
3331 * sessions immediately and then enter monitor mode
3332 * @param sic_cls closure for @a sic
3335 http_server_plugin_setup_monitor (void *cls,
3336 GNUNET_TRANSPORT_SessionInfoCallback sic,
3339 struct HTTP_Server_Plugin *plugin = cls;
3342 plugin->sic_cls = sic_cls;
3345 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
3346 &send_session_info_iter,
3348 /* signal end of first iteration */
3349 sic (sic_cls, NULL, NULL);
3355 * Entry point for the plugin.
3361 LIBGNUNET_PLUGIN_TRANSPORT_INIT (void *cls)
3363 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
3364 struct GNUNET_TRANSPORT_PluginFunctions *api;
3365 struct HTTP_Server_Plugin *plugin;
3367 if (NULL == env->receive)
3369 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
3370 initialze the plugin or the API */
3371 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3373 api->address_to_string = &http_server_plugin_address_to_string;
3374 api->string_to_address = &http_common_plugin_string_to_address;
3375 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
3378 plugin = GNUNET_new (struct HTTP_Server_Plugin);
3380 plugin->sessions = GNUNET_CONTAINER_multipeermap_create (128,
3383 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3385 api->send = &http_server_plugin_send;
3386 api->disconnect_peer = &http_server_plugin_disconnect_peer;
3387 api->disconnect_session = &http_server_plugin_disconnect_session;
3388 api->query_keepalive_factor = &http_server_query_keepalive_factor;
3389 api->check_address = &http_server_plugin_address_suggested;
3390 api->get_session = &http_server_plugin_get_session;
3392 api->address_to_string = &http_server_plugin_address_to_string;
3393 api->string_to_address = &http_common_plugin_string_to_address;
3394 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
3395 api->get_network = &http_server_plugin_get_network;
3396 api->update_session_timeout = &http_server_plugin_update_session_timeout;
3397 api->update_inbound_delay = &http_server_plugin_update_inbound_delay;
3398 api->setup_monitor = &http_server_plugin_setup_monitor;
3400 plugin->name = "transport-https_server";
3401 plugin->protocol = "https";
3403 plugin->name = "transport-http_server";
3404 plugin->protocol = "http";
3408 GNUNET_CONFIGURATION_get_value_yesno (env->cfg,
3413 plugin->options |= HTTP_OPTIONS_TCP_STEALTH;
3415 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3416 _("TCP_STEALTH not supported on this platform.\n"));
3417 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3422 /* Compile URL regex */
3423 if (regcomp(&plugin->url_regex,
3427 LOG (GNUNET_ERROR_TYPE_ERROR,
3428 _("Unable to compile URL regex\n"));
3429 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3433 /* Configure plugin */
3434 if (GNUNET_SYSERR == server_configure_plugin (plugin))
3436 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3440 /* Check IPv6 support */
3441 if (GNUNET_YES == plugin->use_ipv6)
3442 plugin->use_ipv6 = server_check_ipv6_support (plugin);
3444 /* Report addresses to transport service */
3445 if (GNUNET_NO == plugin->external_only)
3446 server_start_report_addresses (plugin);
3448 if (GNUNET_SYSERR == server_start (plugin))
3450 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3456 /* end of plugin_transport_http_server.c */