2 This file is part of GNUnet
3 (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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, 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 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
238 * Task to resume MHD handling when receiving is allowed again
240 GNUNET_SCHEDULER_TaskIdentifier 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
258 * ATS network type in NBO
260 uint32_t ats_address_network_type;
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 GNUNET_SCHEDULER_TaskIdentifier server_v4_task;
382 GNUNET_SCHEDULER_TaskIdentifier server_v6_task;
385 * Task calling transport service about external address
387 GNUNET_SCHEDULER_TaskIdentifier 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 = GNUNET_SCHEDULER_NO_TASK;
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 (GNUNET_SCHEDULER_NO_TASK != s->timeout_task)
539 GNUNET_SCHEDULER_cancel (s->timeout_task);
540 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
541 s->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
543 if (GNUNET_SCHEDULER_NO_TASK != s->recv_wakeup_task)
545 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
546 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
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_DOWN);
602 if (GNUNET_YES == s->known_to_service)
603 plugin->env->session_end (plugin->env->cls,
606 if (NULL != s->msg_tk)
608 GNUNET_SERVER_mst_destroy (s->msg_tk);
611 GNUNET_HELLO_address_free (s->address);
612 LOG (GNUNET_ERROR_TYPE_DEBUG,
613 "Session %p destroyed\n",
621 * Disconnect session @a s by telling MHD to close the
622 * connections (reducing timeout, etc.).
624 * @param cls closure with the `struct HTTP_Server_Plugin`
625 * @param s the session
626 * @return #GNUNET_OK on success
629 http_server_plugin_disconnect_session (void *cls,
632 server_delete_session (s);
638 * Session was idle, so disconnect it
640 * @param cls the session
641 * @param tc task context
644 server_session_timeout (void *cls,
645 const struct GNUNET_SCHEDULER_TaskContext *tc)
647 struct Session *s = cls;
648 struct GNUNET_TIME_Relative left;
650 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
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 Session *s)
681 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != 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 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;
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 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 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 GNUNET_free (sc_send);
792 GNUNET_free (sc_recv);
800 * @param cls the `struct HTTP_Server_Plugin *`
801 * @param peer for which this is a session
802 * @param value the `struct Session` to clean up
803 * @return #GNUNET_OK (continue to iterate)
806 destroy_session_cb (void *cls,
807 const struct GNUNET_PeerIdentity *peer,
810 struct Session *s = value;
812 server_delete_session (s);
817 * Function that can be used to force the plugin to disconnect
818 * from the given peer and cancel all previous transmissions
819 * (and their continuationc).
822 * @param target peer from which to disconnect
825 http_server_plugin_disconnect_peer (void *cls,
826 const struct GNUNET_PeerIdentity *target)
828 struct HTTP_Server_Plugin *plugin = cls;
830 LOG (GNUNET_ERROR_TYPE_DEBUG,
831 "Transport tells me to disconnect `%s'\n",
832 GNUNET_i2s (target));
833 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
841 * Another peer has suggested an address for this
842 * peer and transport plugin. Check that this could be a valid
843 * address. If so, consider adding it to the list
847 * @param addr pointer to the address
848 * @param addrlen length of @a addr
849 * @return #GNUNET_OK if this is a plausible address for this peer
853 http_server_plugin_address_suggested (void *cls,
857 struct HTTP_Server_Plugin *plugin = cls;
858 struct HttpAddressWrapper *next;
859 struct HttpAddressWrapper *pos;
860 const struct HttpAddress *haddr = addr;
862 if ((NULL != plugin->ext_addr) &&
863 GNUNET_YES == (http_common_cmp_addresses (addr, addrlen,
864 plugin->ext_addr->address,
865 plugin->ext_addr->address_length)))
867 /* Checking HTTP_OPTIONS_VERIFY_CERTIFICATE option for external hostname */
868 if ((ntohl (haddr->options) & HTTP_OPTIONS_VERIFY_CERTIFICATE) !=
869 (plugin->options & HTTP_OPTIONS_VERIFY_CERTIFICATE))
870 return GNUNET_NO; /* VERIFY option not set as required! */
873 next = plugin->addr_head;
874 while (NULL != (pos = next))
877 if (GNUNET_YES == (http_common_cmp_addresses(addr,
888 * Creates a new outbound session the transport
889 * service will use to send data to the peer.
891 * Since HTTP/S server cannot create sessions, always returns NULL.
893 * @param cls the plugin
894 * @param address the address
895 * @return always NULL
897 static struct Session *
898 http_server_plugin_get_session (void *cls,
899 const struct GNUNET_HELLO_Address *address)
906 * Call MHD IPv4 to process pending requests and then go back
907 * and schedule the next run.
909 * @param cls plugin as closure
910 * @param tc task context
913 server_v4_run (void *cls,
914 const struct GNUNET_SCHEDULER_TaskContext *tc)
916 struct HTTP_Server_Plugin *plugin = cls;
918 plugin->server_v4_task = GNUNET_SCHEDULER_NO_TASK;
919 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
921 plugin->server_v4_immediately = GNUNET_NO;
922 GNUNET_assert (MHD_YES == MHD_run (plugin->server_v4));
923 server_reschedule (plugin, plugin->server_v4, GNUNET_NO);
928 * Call MHD IPv6 to process pending requests and then go back
929 * and schedule the next run.
931 * @param cls plugin as closure
932 * @param tc task context
935 server_v6_run (void *cls,
936 const struct GNUNET_SCHEDULER_TaskContext *tc)
938 struct HTTP_Server_Plugin *plugin = cls;
940 plugin->server_v6_task = GNUNET_SCHEDULER_NO_TASK;
941 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
943 plugin->server_v6_immediately = GNUNET_NO;
944 GNUNET_assert (MHD_YES == MHD_run (plugin->server_v6));
945 server_reschedule (plugin, plugin->server_v6, GNUNET_NO);
950 * Function that queries MHD's select sets and
951 * starts the task waiting for them.
953 * @param plugin plugin
954 * @param daemon_handle the MHD daemon handle
955 * @return gnunet task identifier
957 static GNUNET_SCHEDULER_TaskIdentifier
958 server_schedule (struct HTTP_Server_Plugin *plugin,
959 struct MHD_Daemon *daemon_handle,
962 GNUNET_SCHEDULER_TaskIdentifier ret;
966 struct GNUNET_NETWORK_FDSet *wrs;
967 struct GNUNET_NETWORK_FDSet *wws;
969 MHD_UNSIGNED_LONG_LONG timeout;
970 static unsigned long long last_timeout = 0;
972 struct GNUNET_TIME_Relative tv;
974 if (GNUNET_YES == plugin->in_shutdown)
975 return GNUNET_SCHEDULER_NO_TASK;
977 ret = GNUNET_SCHEDULER_NO_TASK;
981 wrs = GNUNET_NETWORK_fdset_create ();
982 wws = GNUNET_NETWORK_fdset_create ();
984 GNUNET_assert (MHD_YES ==
985 MHD_get_fdset (daemon_handle,
990 haveto = MHD_get_timeout (daemon_handle, &timeout);
991 if (haveto == MHD_YES)
993 if (timeout != last_timeout)
995 LOG (GNUNET_ERROR_TYPE_DEBUG,
996 "SELECT Timeout changed from %llu to %llu (ms)\n",
997 last_timeout, timeout);
998 last_timeout = timeout;
1000 if (timeout <= GNUNET_TIME_UNIT_SECONDS.rel_value_us / 1000LL)
1001 tv.rel_value_us = (uint64_t) timeout * 1000LL;
1003 tv = GNUNET_TIME_UNIT_SECONDS;
1006 tv = GNUNET_TIME_UNIT_SECONDS;
1007 /* Force immediate run, since we have outbound data to send */
1008 if (now == GNUNET_YES)
1009 tv = GNUNET_TIME_UNIT_MILLISECONDS;
1010 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
1011 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
1013 if (daemon_handle == plugin->server_v4)
1015 if (plugin->server_v4_task != GNUNET_SCHEDULER_NO_TASK)
1017 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
1018 plugin->server_v4_task = GNUNET_SCHEDULER_NO_TASK;
1021 LOG (GNUNET_ERROR_TYPE_DEBUG,
1022 "Scheduling IPv4 server task in %llu ms\n",
1026 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1028 &server_v4_run, plugin);
1030 if (daemon_handle == plugin->server_v6)
1032 if (plugin->server_v6_task != GNUNET_SCHEDULER_NO_TASK)
1034 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
1035 plugin->server_v6_task = GNUNET_SCHEDULER_NO_TASK;
1038 LOG (GNUNET_ERROR_TYPE_DEBUG,
1039 "Scheduling IPv6 server task in %llu ms\n", tv);
1042 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1044 &server_v6_run, plugin);
1046 GNUNET_NETWORK_fdset_destroy (wrs);
1047 GNUNET_NETWORK_fdset_destroy (wws);
1053 * Reschedule the execution of both IPv4 and IPv6 server
1055 * @param plugin the plugin
1056 * @param server which server to schedule v4 or v6?
1057 * @param now #GNUNET_YES to schedule execution immediately, #GNUNET_NO to wait
1061 server_reschedule (struct HTTP_Server_Plugin *plugin,
1062 struct MHD_Daemon *server,
1065 if ((server == plugin->server_v4) && (plugin->server_v4 != NULL))
1067 if (GNUNET_YES == plugin->server_v4_immediately)
1068 return; /* No rescheduling, server will run asap */
1070 if (GNUNET_YES == now)
1071 plugin->server_v4_immediately = GNUNET_YES;
1073 if (plugin->server_v4_task != GNUNET_SCHEDULER_NO_TASK)
1075 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
1076 plugin->server_v4_task = GNUNET_SCHEDULER_NO_TASK;
1078 plugin->server_v4_task = server_schedule (plugin, plugin->server_v4, now);
1081 if ((server == plugin->server_v6) && (plugin->server_v6 != NULL))
1083 if (GNUNET_YES == plugin->server_v6_immediately)
1084 return; /* No rescheduling, server will run asap */
1086 if (GNUNET_YES == now)
1087 plugin->server_v6_immediately = GNUNET_YES;
1089 if (plugin->server_v6_task != GNUNET_SCHEDULER_NO_TASK)
1091 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
1092 plugin->server_v6_task = GNUNET_SCHEDULER_NO_TASK;
1094 plugin->server_v6_task = server_schedule (plugin, plugin->server_v6, now);
1100 * Function that is called to get the keepalive factor.
1101 * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
1102 * calculate the interval between keepalive packets.
1104 * @param cls closure with the `struct HTTP_Server_Plugin`
1105 * @return keepalive factor
1108 http_server_query_keepalive_factor (void *cls)
1115 * Function that will be called whenever the transport service wants to
1116 * notify the plugin that a session is still active and in use and
1117 * therefore the session timeout for this session has to be updated
1119 * @param cls closure
1120 * @param peer which peer was the session for
1121 * @param session which session is being updated
1124 http_server_plugin_update_session_timeout (void *cls,
1125 const struct GNUNET_PeerIdentity *peer,
1126 struct Session *session)
1128 server_reschedule_session_timeout (session);
1133 * Tell MHD that the connection should timeout after @a to seconds.
1135 * @param plugin our plugin
1136 * @param s session for which the timeout changes
1137 * @param to timeout in seconds
1140 server_mhd_connection_timeout (struct HTTP_Server_Plugin *plugin,
1144 /* Setting timeouts for other connections */
1145 if (NULL != s->server_recv)
1147 LOG (GNUNET_ERROR_TYPE_DEBUG,
1148 "Setting timeout for %p to %u sec.\n",
1149 s->server_recv, to);
1150 MHD_set_connection_option (s->server_recv->mhd_conn,
1151 MHD_CONNECTION_OPTION_TIMEOUT,
1153 server_reschedule (plugin, s->server_recv->mhd_daemon, GNUNET_NO);
1155 if (NULL != s->server_send)
1157 LOG (GNUNET_ERROR_TYPE_DEBUG,
1158 "Setting timeout for %p to %u sec.\n",
1159 s->server_send, to);
1160 MHD_set_connection_option (s->server_send->mhd_conn,
1161 MHD_CONNECTION_OPTION_TIMEOUT,
1163 server_reschedule (plugin, s->server_send->mhd_daemon, GNUNET_NO);
1169 * Parse incoming URL for tag and target
1171 * @param plugin plugin
1172 * @param url incoming url
1173 * @param target where to store the target
1174 * @param tag where to store the tag
1175 * @param options where to store the options
1176 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1179 server_parse_url (struct HTTP_Server_Plugin *plugin,
1181 struct GNUNET_PeerIdentity *target,
1185 regmatch_t matches[4];
1186 const char *tag_start;
1187 const char *target_start;
1191 unsigned long int rc;
1195 ("^.*/([0-9A-Z]+);([0-9]+)(,[0-9]+)?$")
1200 return GNUNET_SYSERR;
1203 if (regexec(&plugin->url_regex, url, 4, matches, 0))
1205 LOG (GNUNET_ERROR_TYPE_DEBUG,
1206 "URL `%s' did not match regex\n", url);
1207 return GNUNET_SYSERR;
1210 target_start = &url[matches[1].rm_so];
1211 tag_start = &url[matches[2].rm_so];
1214 rc = strtoul (tag_start, &tag_end, 10);
1215 if (&url[matches[2].rm_eo] != tag_end)
1217 LOG (GNUNET_ERROR_TYPE_DEBUG,
1218 "URL tag did not line up with submatch\n");
1219 return GNUNET_SYSERR;
1223 LOG (GNUNET_ERROR_TYPE_DEBUG,
1224 "URL tag is zero\n");
1225 return GNUNET_SYSERR;
1227 if ((rc == ULONG_MAX) && (ERANGE == errno))
1229 LOG (GNUNET_ERROR_TYPE_DEBUG,
1230 "URL tag > ULONG_MAX\n");
1231 return GNUNET_SYSERR;
1233 if (rc > UINT32_MAX)
1235 LOG (GNUNET_ERROR_TYPE_DEBUG,
1236 "URL tag > UINT32_MAX\n");
1237 return GNUNET_SYSERR;
1239 (*tag) = (uint32_t)rc;
1240 LOG (GNUNET_ERROR_TYPE_DEBUG,
1241 "Found tag `%u' in url\n",
1244 /* convert peer id */
1245 hash_length = matches[1].rm_eo - matches[1].rm_so;
1246 if (hash_length != plugin->peer_id_length)
1248 LOG (GNUNET_ERROR_TYPE_DEBUG,
1249 "URL target is %u bytes, expecting %u\n",
1250 hash_length, plugin->peer_id_length);
1251 return GNUNET_SYSERR;
1254 GNUNET_CRYPTO_eddsa_public_key_from_string (target_start,
1256 &target->public_key))
1258 LOG (GNUNET_ERROR_TYPE_DEBUG,
1259 "URL target conversion failed\n");
1260 return GNUNET_SYSERR;
1262 LOG (GNUNET_ERROR_TYPE_DEBUG,
1263 "Found target `%s' in URL\n",
1264 GNUNET_i2s_full (target));
1266 /* convert options */
1267 if (-1 == matches[3].rm_so)
1273 rc = strtoul (&url[matches[3].rm_so + 1], &options_end, 10);
1274 if (&url[matches[3].rm_eo] != options_end)
1276 LOG (GNUNET_ERROR_TYPE_DEBUG,
1277 "URL options did not line up with submatch\n");
1278 return GNUNET_SYSERR;
1280 if ((rc == ULONG_MAX) && (ERANGE == errno))
1282 LOG (GNUNET_ERROR_TYPE_DEBUG,
1283 "URL options > ULONG_MAX\n");
1284 return GNUNET_SYSERR;
1286 if (rc > UINT32_MAX)
1288 LOG (GNUNET_ERROR_TYPE_DEBUG,
1289 "URL options > UINT32_MAX\n");
1290 return GNUNET_SYSERR;
1292 (*options) = (uint32_t) rc;
1293 LOG (GNUNET_ERROR_TYPE_DEBUG,
1294 "Found options `%u' in url\n",
1302 * Closure for #session_tag_it().
1304 struct SessionTagContext
1307 * Set to session matching the tag.
1309 struct Session *res;
1312 * Tag we are looking for.
1319 * Find a session with a matching tag.
1321 * @param cls the `struct SessionTagContext *`
1322 * @param key peer identity (unused)
1323 * @param value the `struct Session *`
1324 * @return #GNUNET_NO if we found the session, #GNUNET_OK if not
1327 session_tag_it (void *cls,
1328 const struct GNUNET_PeerIdentity *key,
1331 struct SessionTagContext *stc = cls;
1332 struct Session *s = value;
1334 if (s->tag == stc->tag)
1344 * Lookup a mhd connection and create one if none is found
1346 * @param plugin the plugin handle
1347 * @param mhd_connection the incoming mhd_connection
1348 * @param url incoming requested URL
1349 * @param method PUT or GET
1350 * @return the server connecetion
1352 static struct ServerRequest *
1353 server_lookup_connection (struct HTTP_Server_Plugin *plugin,
1354 struct MHD_Connection *mhd_connection,
1358 struct Session *s = NULL;
1359 struct ServerRequest *sc = NULL;
1360 const union MHD_ConnectionInfo *conn_info;
1361 struct HttpAddress *addr;
1362 struct GNUNET_ATS_Information ats;
1363 struct GNUNET_PeerIdentity target;
1365 struct SessionTagContext stc;
1367 int direction = GNUNET_SYSERR;
1370 conn_info = MHD_get_connection_info (mhd_connection,
1371 MHD_CONNECTION_INFO_CLIENT_ADDRESS);
1372 if ((conn_info->client_addr->sa_family != AF_INET) &&
1373 (conn_info->client_addr->sa_family != AF_INET6))
1375 LOG (GNUNET_ERROR_TYPE_DEBUG,
1376 "New %s request from %s\n",
1380 if (GNUNET_SYSERR ==
1381 server_parse_url (plugin, url, &target, &stc.tag, &options))
1383 LOG (GNUNET_ERROR_TYPE_DEBUG,
1384 "Invalid url %s\n", url);
1387 if (0 == strcmp (MHD_HTTP_METHOD_PUT, method))
1388 direction = _RECEIVE;
1389 else if (0 == strcmp (MHD_HTTP_METHOD_GET, method))
1393 LOG (GNUNET_ERROR_TYPE_DEBUG,
1394 "Invalid method %s for request from %s\n",
1399 plugin->cur_request++;
1400 LOG (GNUNET_ERROR_TYPE_DEBUG,
1401 "New %s request from %s with tag %u (%u of %u)\n",
1403 GNUNET_i2s (&target),
1405 plugin->cur_request, plugin->max_request);
1406 /* find existing session */
1408 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
1412 if (NULL == (s = stc.res))
1414 /* create new session */
1416 switch (conn_info->client_addr->sa_family)
1419 addr = http_common_address_from_socket (plugin->protocol,
1420 conn_info->client_addr,
1421 sizeof (struct sockaddr_in));
1422 addr_len = http_common_address_get_size (addr);
1423 ats = plugin->env->get_address_type (plugin->env->cls,
1424 conn_info->client_addr,
1425 sizeof (struct sockaddr_in));
1428 addr = http_common_address_from_socket (plugin->protocol,
1429 conn_info->client_addr,
1430 sizeof (struct sockaddr_in6));
1431 addr_len = http_common_address_get_size (addr);
1432 ats = plugin->env->get_address_type (plugin->env->cls,
1433 conn_info->client_addr,
1434 sizeof (struct sockaddr_in6));
1437 /* external host name */
1438 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
1439 ats.type = htonl (GNUNET_ATS_NET_WAN);
1442 s = GNUNET_new (struct Session);
1445 s->address = GNUNET_HELLO_address_allocate (&s->target,
1449 GNUNET_HELLO_ADDRESS_INFO_INBOUND);
1450 s->ats_address_network_type = ats.value;
1451 s->next_receive = GNUNET_TIME_UNIT_ZERO_ABS;
1453 s->timeout = GNUNET_TIME_relative_to_absolute (HTTP_SERVER_SESSION_TIMEOUT);
1454 s->timeout_task = GNUNET_SCHEDULER_add_delayed (HTTP_SERVER_SESSION_TIMEOUT,
1455 &server_session_timeout,
1457 (void) GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
1460 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1461 notify_session_monitor (plugin,
1463 GNUNET_TRANSPORT_SS_HANDSHAKE);
1464 LOG (GNUNET_ERROR_TYPE_DEBUG,
1465 "Creating new session %p for peer `%s' connecting from `%s'\n",
1466 s, GNUNET_i2s (&target),
1467 http_common_plugin_address_to_string (plugin->protocol,
1470 GNUNET_free_non_null (addr);
1473 if ( (_RECEIVE == direction) &&
1474 (NULL != s->server_recv) )
1476 LOG (GNUNET_ERROR_TYPE_DEBUG,
1477 "Duplicate PUT request from `%s' tag %u, dismissing new request\n",
1478 GNUNET_i2s (&target),
1482 if ((_SEND == direction) && (NULL != s->server_send))
1484 LOG (GNUNET_ERROR_TYPE_DEBUG,
1485 "Duplicate GET request from `%s' tag %u, dismissing new request\n",
1486 GNUNET_i2s (&target),
1490 sc = GNUNET_new (struct ServerRequest);
1491 if (conn_info->client_addr->sa_family == AF_INET)
1492 sc->mhd_daemon = plugin->server_v4;
1493 if (conn_info->client_addr->sa_family == AF_INET6)
1494 sc->mhd_daemon = plugin->server_v6;
1495 sc->mhd_conn = mhd_connection;
1496 sc->direction = direction;
1497 sc->connected = GNUNET_NO;
1499 sc->options = options;
1500 if (direction == _SEND)
1502 s->server_send = sc;
1504 if (direction == _RECEIVE)
1506 s->server_recv = sc;
1509 if ((GNUNET_NO == s->known_to_service) &&
1510 (NULL != s->server_send) &&
1511 (NULL != s->server_recv) )
1513 s->known_to_service = GNUNET_YES;
1514 plugin->env->session_start (NULL, s->address ,s, NULL, 0);
1517 if ( (NULL == s->server_recv) ||
1518 (NULL == s->server_send) )
1520 to = (HTTP_SERVER_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL / 1000LL);
1521 MHD_set_connection_option (mhd_connection,
1522 MHD_CONNECTION_OPTION_TIMEOUT, to);
1523 server_reschedule (plugin, sc->mhd_daemon, GNUNET_NO);
1527 LOG (GNUNET_ERROR_TYPE_DEBUG,
1528 "Session %p for peer `%s' fully connected\n",
1529 s, GNUNET_i2s (&target));
1530 to = (HTTP_SERVER_SESSION_TIMEOUT.rel_value_us / 1000LL / 1000LL);
1531 server_mhd_connection_timeout (plugin, s, to);
1533 LOG (GNUNET_ERROR_TYPE_DEBUG,
1534 "Setting timeout for %p to %u sec.\n", sc, to);
1540 * Callback called by MHD when it needs data to send
1542 * @param cls current session
1543 * @param pos position in buffer
1544 * @param buf the buffer to write data to
1545 * @param max max number of bytes available in @a buf
1546 * @return bytes written to @a buf
1549 server_send_callback (void *cls,
1554 struct ServerRequest *sc = cls;
1555 struct Session *s = sc->session;
1556 ssize_t bytes_read = 0;
1557 struct HTTP_Message *msg;
1562 /* session is disconnecting */
1566 sc = s->server_send;
1573 bytes_read = GNUNET_MIN (msg->size - msg->pos,
1575 memcpy (buf, &msg->buf[msg->pos], bytes_read);
1576 msg->pos += bytes_read;
1578 /* removing message */
1579 if (msg->pos == msg->size)
1581 GNUNET_CONTAINER_DLL_remove (s->msg_head,
1584 if (NULL != msg->transmit_cont)
1585 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK,
1586 msg->size, msg->size + msg->overhead);
1587 GNUNET_assert (s->msgs_in_queue > 0);
1589 GNUNET_assert (s->bytes_in_queue >= msg->size);
1590 s->bytes_in_queue -= msg->size;
1592 notify_session_monitor (s->plugin,
1594 GNUNET_TRANSPORT_SS_UP);
1599 sc->connected = GNUNET_YES;
1600 LOG (GNUNET_ERROR_TYPE_DEBUG,
1601 "Sent %u bytes to peer `%s' with session %p \n",
1603 GNUNET_i2s (&s->target),
1605 GNUNET_asprintf (&stat_txt,
1606 "# bytes currently in %s_server buffers",
1607 s->plugin->protocol);
1608 GNUNET_STATISTICS_update (s->plugin->env->stats,
1612 GNUNET_free (stat_txt);
1613 GNUNET_asprintf (&stat_txt,
1614 "# bytes transmitted via %s_server",
1615 s->plugin->protocol);
1616 GNUNET_STATISTICS_update (s->plugin->env->stats,
1617 stat_txt, bytes_read, GNUNET_NO);
1618 GNUNET_free (stat_txt);
1620 else if ((sc->options & OPTION_LONG_POLL) && sc->connected)
1622 LOG (GNUNET_ERROR_TYPE_DEBUG,
1623 "Completing GET response to peer `%s' with session %p\n",
1624 GNUNET_i2s (&s->target),
1626 return MHD_CONTENT_READER_END_OF_STREAM;
1633 * Callback called by MessageStreamTokenizer when a message has arrived
1635 * @param cls current session as closure
1636 * @param client client
1637 * @param message the message to be forwarded to transport service
1638 * @return #GNUNET_OK
1641 server_receive_mst_cb (void *cls,
1643 const struct GNUNET_MessageHeader *message)
1645 struct Session *s = cls;
1646 struct HTTP_Server_Plugin *plugin = s->plugin;
1647 struct GNUNET_ATS_Information atsi;
1648 struct GNUNET_TIME_Relative delay;
1651 atsi.type = htonl (GNUNET_ATS_NETWORK_TYPE);
1652 atsi.value = s->ats_address_network_type;
1653 GNUNET_break (s->ats_address_network_type !=
1654 ntohl (GNUNET_ATS_NET_UNSPECIFIED));
1656 if (GNUNET_NO == s->known_to_service)
1658 s->known_to_service = GNUNET_YES;
1659 plugin->env->session_start (NULL,
1664 notify_session_monitor (plugin,
1666 GNUNET_TRANSPORT_SS_UP);
1668 delay = plugin->env->receive (plugin->env->cls,
1672 plugin->env->update_address_metrics (plugin->env->cls,
1675 GNUNET_asprintf (&stat_txt,
1676 "# bytes received via %s_server",
1678 GNUNET_STATISTICS_update (plugin->env->stats,
1679 stat_txt, ntohs (message->size), GNUNET_NO);
1680 GNUNET_free (stat_txt);
1681 s->next_receive = GNUNET_TIME_relative_to_absolute (delay);
1682 if (delay.rel_value_us > 0)
1684 LOG (GNUNET_ERROR_TYPE_DEBUG,
1685 "Peer `%s' address `%s' next read delayed for %s\n",
1686 GNUNET_i2s (&s->target),
1687 http_common_plugin_address_to_string (plugin->protocol,
1688 s->address->address,
1689 s->address->address_length),
1690 GNUNET_STRINGS_relative_time_to_string (delay,
1693 server_reschedule_session_timeout (s);
1699 * Add headers to a request indicating that we allow Cross-Origin Resource
1702 * @param response response object to modify
1705 add_cors_headers(struct MHD_Response *response)
1707 MHD_add_response_header (response,
1708 "Access-Control-Allow-Origin",
1710 MHD_add_response_header (response,
1711 "Access-Control-Allow-Methods",
1712 "GET, PUT, OPTIONS");
1713 MHD_add_response_header (response,
1714 "Access-Control-Max-Age",
1720 * MHD callback for a new incoming connection
1722 * @param cls the plugin handle
1723 * @param mhd_connection the mhd connection
1724 * @param url the requested URL
1725 * @param method GET or PUT
1726 * @param version HTTP version
1727 * @param upload_data upload data
1728 * @param upload_data_size size of @a upload_data
1729 * @param httpSessionCache the session cache to remember the connection
1730 * @return MHD_YES if connection is accepted, MHD_NO on reject
1733 server_access_cb (void *cls,
1734 struct MHD_Connection *mhd_connection,
1737 const char *version,
1738 const char *upload_data,
1739 size_t *upload_data_size,
1740 void **httpSessionCache)
1742 struct HTTP_Server_Plugin *plugin = cls;
1743 struct ServerRequest *sc = *httpSessionCache;
1745 struct MHD_Response *response;
1748 LOG (GNUNET_ERROR_TYPE_DEBUG,
1749 _("Access from connection %p (%u of %u) for `%s' `%s' url `%s' with upload data size %u\n"),
1751 plugin->cur_request,
1752 plugin->max_request,
1756 (*upload_data_size));
1759 /* CORS pre-flight request */
1760 if (0 == strcmp (MHD_HTTP_METHOD_OPTIONS, method))
1762 response = MHD_create_response_from_buffer (0, NULL,
1763 MHD_RESPMEM_PERSISTENT);
1764 add_cors_headers(response);
1765 res = MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1766 MHD_destroy_response (response);
1769 /* new connection */
1770 sc = server_lookup_connection (plugin, mhd_connection, url, method);
1773 /* attach to new / existing session */
1774 (*httpSessionCache) = sc;
1778 /* existing session already has matching connection, refuse */
1779 response = MHD_create_response_from_data (strlen (HTTP_ERROR_RESPONSE),
1780 HTTP_ERROR_RESPONSE,
1783 MHD_add_response_header (response,
1784 MHD_HTTP_HEADER_CONTENT_TYPE,
1786 add_cors_headers(response);
1787 res = MHD_queue_response (mhd_connection, MHD_HTTP_NOT_FOUND, response);
1788 MHD_destroy_response (response);
1792 /* 'old' connection */
1793 if (NULL == (s = sc->session))
1795 /* Session was already disconnected;
1796 sent HTTP/1.1: 200 OK as response */
1797 response = MHD_create_response_from_data (strlen ("Thank you!"),
1798 "Thank you!", MHD_NO, MHD_NO);
1799 add_cors_headers(response);
1800 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1801 MHD_destroy_response (response);
1805 if (sc->direction == _SEND)
1807 response = MHD_create_response_from_callback (MHD_SIZE_UNKNOWN, 32 * 1024,
1808 &server_send_callback, sc, NULL);
1809 add_cors_headers(response);
1810 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1811 MHD_destroy_response (response);
1814 if (sc->direction == _RECEIVE)
1816 if ((*upload_data_size == 0) && (sc->connected == GNUNET_NO))
1818 /* (*upload_data_size == 0) first callback when header are passed */
1819 LOG (GNUNET_ERROR_TYPE_DEBUG,
1820 "Session %p / Connection %p: Peer `%s' PUT on address `%s' connected\n",
1822 GNUNET_i2s (&s->target),
1823 http_common_plugin_address_to_string (plugin->protocol,
1824 s->address->address,
1825 s->address->address_length));
1826 sc->connected = GNUNET_YES;
1829 else if ((*upload_data_size == 0) && (sc->connected == GNUNET_YES))
1831 /* (*upload_data_size == 0) when upload is complete */
1832 LOG (GNUNET_ERROR_TYPE_DEBUG,
1833 "Session %p / Connection %p: Peer `%s' PUT on address `%s' finished upload\n",
1835 GNUNET_i2s (&s->target),
1836 http_common_plugin_address_to_string (plugin->protocol,
1837 s->address->address,
1838 s->address->address_length));
1839 sc->connected = GNUNET_NO;
1840 /* Sent HTTP/1.1: 200 OK as PUT Response\ */
1841 response = MHD_create_response_from_data (strlen ("Thank you!"),
1842 "Thank you!", MHD_NO, MHD_NO);
1843 add_cors_headers(response);
1844 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1845 MHD_destroy_response (response);
1848 else if ((*upload_data_size > 0) && (sc->connected == GNUNET_YES))
1850 struct GNUNET_TIME_Relative delay;
1852 /* (*upload_data_size > 0) for every segment received */
1853 LOG (GNUNET_ERROR_TYPE_DEBUG,
1854 "Session %p / Connection %p: Peer `%s' PUT on address `%s' received %u bytes\n",
1856 GNUNET_i2s (&s->target),
1857 http_common_plugin_address_to_string (plugin->protocol,
1858 s->address->address,
1859 s->address->address_length),
1861 delay = GNUNET_TIME_absolute_get_remaining (s->next_receive);
1862 if (0 == delay.rel_value_us)
1864 LOG (GNUNET_ERROR_TYPE_DEBUG,
1865 "PUT with %u bytes forwarded to MST\n",
1867 if (s->msg_tk == NULL)
1869 s->msg_tk = GNUNET_SERVER_mst_create (&server_receive_mst_cb, s);
1871 GNUNET_SERVER_mst_receive (s->msg_tk, s, upload_data, *upload_data_size,
1872 GNUNET_NO, GNUNET_NO);
1873 server_mhd_connection_timeout (plugin, s,
1874 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value_us / 1000LL
1876 (*upload_data_size) = 0;
1880 /* delay processing */
1881 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
1882 "Session %p / Connection %p: no inbound bandwidth available! Next read was delayed by %s\n",
1883 s, sc, GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1884 GNUNET_assert(s->server_recv->mhd_conn == mhd_connection);
1885 MHD_suspend_connection (s->server_recv->mhd_conn);
1886 if (GNUNET_SCHEDULER_NO_TASK == s->recv_wakeup_task)
1887 s->recv_wakeup_task = GNUNET_SCHEDULER_add_delayed (delay,
1888 &server_wake_up, s);
1903 * Callback from MHD when a connection disconnects
1905 * @param cls closure with the `struct HTTP_Server_Plugin *`
1906 * @param connection the disconnected MHD connection
1907 * @param httpSessionCache the pointer to distinguish
1910 server_disconnect_cb (void *cls,
1911 struct MHD_Connection *connection,
1912 void **httpSessionCache)
1914 struct HTTP_Server_Plugin *plugin = cls;
1915 struct ServerRequest *sc = *httpSessionCache;
1917 LOG (GNUNET_ERROR_TYPE_DEBUG,
1918 "Disconnect for connection %p\n",
1922 /* CORS pre-flight request finished */
1926 if (NULL != sc->session)
1928 if (sc->direction == _SEND)
1930 LOG (GNUNET_ERROR_TYPE_DEBUG,
1931 "Peer `%s' connection %p, GET on address `%s' disconnected\n",
1932 GNUNET_i2s (&sc->session->target),
1933 sc->session->server_send,
1934 http_common_plugin_address_to_string (plugin->protocol,
1935 sc->session->address->address,
1936 sc->session->address->address_length));
1938 sc->session->server_send = NULL;
1940 else if (sc->direction == _RECEIVE)
1942 LOG (GNUNET_ERROR_TYPE_DEBUG,
1943 "Peer `%s' connection %p PUT on address `%s' disconnected\n",
1944 GNUNET_i2s (&sc->session->target),
1945 sc->session->server_recv,
1946 http_common_plugin_address_to_string (plugin->protocol,
1947 sc->session->address->address,
1948 sc->session->address->address_length));
1949 sc->session->server_recv = NULL;
1950 if (NULL != sc->session->msg_tk)
1952 GNUNET_SERVER_mst_destroy (sc->session->msg_tk);
1953 sc->session->msg_tk = NULL;
1958 plugin->cur_request--;
1963 * Check if incoming connection is accepted.
1965 * @param cls plugin as closure
1966 * @param addr address of incoming connection
1967 * @param addr_len number of bytes in @a addr
1968 * @return MHD_YES if connection is accepted, MHD_NO if connection is rejected
1971 server_accept_cb (void *cls,
1972 const struct sockaddr *addr,
1975 struct HTTP_Server_Plugin *plugin = cls;
1977 if (plugin->cur_request <= plugin->max_request)
1979 LOG (GNUNET_ERROR_TYPE_DEBUG,
1980 _("Accepting connection (%u of %u) from `%s'\n"),
1981 plugin->cur_request, plugin->max_request,
1982 GNUNET_a2s (addr, addr_len));
1987 LOG (GNUNET_ERROR_TYPE_WARNING,
1988 _("Server reached maximum number connections (%u), rejecting new connection\n"),
1989 plugin->max_request);
1996 * Log function called by MHD.
1999 * @param fmt format string
2000 * @param ap arguments for the format string (va_start() and va_end()
2001 * will be called by MHD)
2004 server_log (void *arg,
2014 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2022 * Load ssl certificate from file
2024 * @param file filename
2025 * @return content of the file
2028 server_load_file (const char *file)
2030 struct GNUNET_DISK_FileHandle *gn_file;
2034 if (GNUNET_OK != GNUNET_DISK_file_size (file,
2035 &fsize, GNUNET_NO, GNUNET_YES))
2037 text = GNUNET_malloc (fsize + 1);
2039 GNUNET_DISK_file_open (file, GNUNET_DISK_OPEN_READ,
2040 GNUNET_DISK_PERM_USER_READ);
2041 if (NULL == gn_file)
2046 if (GNUNET_SYSERR == GNUNET_DISK_file_read (gn_file, text, fsize))
2049 GNUNET_DISK_file_close (gn_file);
2053 GNUNET_DISK_file_close (gn_file);
2061 * Load ssl certificate
2063 * @param plugin the plugin
2064 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2067 server_load_certificate (struct HTTP_Server_Plugin *plugin)
2069 int res = GNUNET_OK;
2075 GNUNET_CONFIGURATION_get_value_filename (plugin->env->cfg,
2077 "KEY_FILE", &key_file))
2079 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2080 plugin->name, "CERT_FILE");
2081 return GNUNET_SYSERR;
2084 GNUNET_CONFIGURATION_get_value_filename (plugin->env->cfg,
2086 "CERT_FILE", &cert_file))
2088 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2089 plugin->name, "CERT_FILE");
2090 GNUNET_free (key_file);
2091 return GNUNET_SYSERR;
2093 /* Get crypto init string from config. If not present, use
2096 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2099 &plugin->crypto_init))
2100 LOG (GNUNET_ERROR_TYPE_DEBUG,
2101 "Using crypto init string `%s'\n",
2102 plugin->crypto_init);
2104 LOG (GNUNET_ERROR_TYPE_DEBUG,
2105 "Using default crypto init string \n");
2107 /* read key & certificates from file */
2108 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2109 "Trying to loading TLS certificate from key-file `%s' cert-file`%s'\n",
2110 key_file, cert_file);
2112 plugin->key = server_load_file (key_file);
2113 plugin->cert = server_load_file (cert_file);
2115 if ((plugin->key == NULL) || (plugin->cert == NULL))
2117 struct GNUNET_OS_Process *cert_creation;
2119 GNUNET_free_non_null (plugin->key);
2121 GNUNET_free_non_null (plugin->cert);
2122 plugin->cert = NULL;
2124 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2125 "No usable TLS certificate found, creating certificate\n");
2128 GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
2130 "gnunet-transport-certificate-creation",
2131 "gnunet-transport-certificate-creation",
2132 key_file, cert_file, NULL);
2133 if (cert_creation == NULL)
2135 LOG (GNUNET_ERROR_TYPE_ERROR,
2136 _("Could not create a new TLS certificate, program `gnunet-transport-certificate-creation' could not be started!\n"));
2137 GNUNET_free (key_file);
2138 GNUNET_free (cert_file);
2140 GNUNET_free_non_null (plugin->key);
2142 GNUNET_free_non_null (plugin->cert);
2143 plugin->cert = NULL;
2144 GNUNET_free_non_null (plugin->crypto_init);
2145 plugin->crypto_init = NULL;
2147 return GNUNET_SYSERR;
2149 GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (cert_creation));
2150 GNUNET_OS_process_destroy (cert_creation);
2152 plugin->key = server_load_file (key_file);
2153 plugin->cert = server_load_file (cert_file);
2156 if ((plugin->key == NULL) || (plugin->cert == NULL))
2158 LOG (GNUNET_ERROR_TYPE_ERROR,
2159 _("No usable TLS certificate found and creating one at `%s/%s' failed!\n"),
2160 key_file, cert_file);
2161 GNUNET_free (key_file);
2162 GNUNET_free (cert_file);
2164 GNUNET_free_non_null (plugin->key);
2166 GNUNET_free_non_null (plugin->cert);
2167 plugin->cert = NULL;
2168 GNUNET_free_non_null (plugin->crypto_init);
2169 plugin->crypto_init = NULL;
2171 return GNUNET_SYSERR;
2173 GNUNET_free (key_file);
2174 GNUNET_free (cert_file);
2175 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "TLS certificate loaded\n");
2182 * Start the HTTP server
2184 * @param plugin the plugin handle
2185 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2188 server_start (struct HTTP_Server_Plugin *plugin)
2190 unsigned int timeout;
2192 GNUNET_assert (NULL != plugin);
2195 if (GNUNET_SYSERR == server_load_certificate (plugin))
2197 LOG (GNUNET_ERROR_TYPE_ERROR,
2198 "Could not load or create server certificate! Loading plugin failed!\n");
2199 return GNUNET_SYSERR;
2204 #if MHD_VERSION >= 0x00090E00
2205 timeout = HTTP_SERVER_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL / 1000LL;
2206 LOG (GNUNET_ERROR_TYPE_DEBUG,
2207 "MHD can set timeout per connection! Default time out %u sec.\n",
2210 timeout = HTTP_SERVER_SESSION_TIMEOUT.rel_value_us / 1000LL / 1000LL;
2211 LOG (GNUNET_ERROR_TYPE_WARNING,
2212 "MHD cannot set timeout per connection! Default time out %u sec.\n",
2216 plugin->server_v4 = NULL;
2217 if (plugin->use_ipv4 == GNUNET_YES)
2219 plugin->server_v4 = MHD_start_daemon (
2226 MHD_NO_FLAG, plugin->port,
2227 &server_accept_cb, plugin,
2228 &server_access_cb, plugin,
2229 MHD_OPTION_SOCK_ADDR,
2230 (struct sockaddr_in *)
2231 plugin->server_addr_v4,
2232 MHD_OPTION_CONNECTION_LIMIT,
2234 plugin->max_request,
2236 MHD_OPTION_HTTPS_PRIORITIES,
2237 plugin->crypto_init,
2238 MHD_OPTION_HTTPS_MEM_KEY,
2240 MHD_OPTION_HTTPS_MEM_CERT,
2243 MHD_OPTION_CONNECTION_TIMEOUT,
2245 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
2247 GNUNET_SERVER_MAX_MESSAGE_SIZE),
2248 MHD_OPTION_NOTIFY_COMPLETED,
2249 &server_disconnect_cb, plugin,
2250 MHD_OPTION_EXTERNAL_LOGGER,
2251 server_log, NULL, MHD_OPTION_END);
2252 if (plugin->server_v4 == NULL)
2254 LOG (GNUNET_ERROR_TYPE_ERROR,
2255 "Failed to start %s IPv4 server component on port %u\n",
2256 plugin->name, plugin->port);
2259 server_reschedule (plugin,
2265 plugin->server_v6 = NULL;
2266 if (plugin->use_ipv6 == GNUNET_YES)
2268 plugin->server_v6 = MHD_start_daemon (
2275 MHD_USE_IPv6, plugin->port,
2276 &server_accept_cb, plugin,
2277 &server_access_cb, plugin,
2278 MHD_OPTION_SOCK_ADDR,
2279 (struct sockaddr_in6 *)
2280 plugin->server_addr_v6,
2281 MHD_OPTION_CONNECTION_LIMIT,
2283 plugin->max_request,
2285 MHD_OPTION_HTTPS_PRIORITIES,
2286 plugin->crypto_init,
2287 MHD_OPTION_HTTPS_MEM_KEY,
2289 MHD_OPTION_HTTPS_MEM_CERT,
2292 MHD_OPTION_CONNECTION_TIMEOUT,
2294 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
2296 GNUNET_SERVER_MAX_MESSAGE_SIZE),
2297 MHD_OPTION_NOTIFY_COMPLETED,
2298 &server_disconnect_cb, plugin,
2299 MHD_OPTION_EXTERNAL_LOGGER,
2300 server_log, NULL, MHD_OPTION_END);
2301 if (plugin->server_v6 == NULL)
2303 LOG (GNUNET_ERROR_TYPE_ERROR,
2304 "Failed to start %s IPv6 server component on port %u\n",
2305 plugin->name, plugin->port);
2308 server_reschedule (plugin, plugin->server_v6, GNUNET_NO);
2312 if ((plugin->server_v6 == NULL) && (plugin->server_v4 == NULL))
2314 LOG (GNUNET_ERROR_TYPE_ERROR,
2315 "%s %s server component started on port %u\n",
2316 msg, plugin->name, plugin->port);
2318 return GNUNET_SYSERR;
2320 else if ((plugin->server_v6 != NULL) && (plugin->server_v4 != NULL))
2321 msg = "IPv4 and IPv6";
2322 else if (plugin->server_v6 != NULL)
2324 else if (plugin->server_v4 != NULL)
2326 LOG (GNUNET_ERROR_TYPE_DEBUG,
2327 "%s %s server component started on port %u\n",
2328 msg, plugin->name, plugin->port);
2334 * Add an address to the server's set of addresses and notify transport
2336 * @param cls the plugin handle
2337 * @param add_remove #GNUNET_YES on add, #GNUNET_NO on remove
2338 * @param addr the address
2339 * @param addrlen address length
2342 server_add_address (void *cls,
2344 const struct sockaddr *addr,
2347 struct HTTP_Server_Plugin *plugin = cls;
2348 struct GNUNET_HELLO_Address *address;
2349 struct HttpAddressWrapper *w = NULL;
2351 w = GNUNET_new (struct HttpAddressWrapper);
2352 w->address = http_common_address_from_socket (plugin->protocol,
2355 if (NULL == w->address)
2360 w->addrlen = http_common_address_get_size (w->address);
2362 GNUNET_CONTAINER_DLL_insert (plugin->addr_head,
2365 LOG (GNUNET_ERROR_TYPE_DEBUG,
2366 "Notifying transport to add address `%s'\n",
2367 http_common_plugin_address_to_string (plugin->protocol,
2370 /* modify our published address list */
2372 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2373 "https_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2375 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2376 "http_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2379 plugin->env->notify_address (plugin->env->cls,
2382 GNUNET_HELLO_address_free (address);
2387 * Remove an address from the server's set of addresses and notify transport
2389 * @param cls the plugin handle
2390 * @param add_remove #GNUNET_YES on add, #GNUNET_NO on remove
2391 * @param addr the address
2392 * @param addrlen address length
2395 server_remove_address (void *cls,
2397 const struct sockaddr *addr,
2400 struct HTTP_Server_Plugin *plugin = cls;
2401 struct GNUNET_HELLO_Address *address;
2402 struct HttpAddressWrapper *w = plugin->addr_head;
2406 saddr = http_common_address_from_socket (plugin->protocol,
2411 saddr_len = http_common_address_get_size (saddr);
2416 http_common_cmp_addresses (w->address,
2423 GNUNET_free (saddr);
2428 LOG (GNUNET_ERROR_TYPE_DEBUG,
2429 "Notifying transport to remove address `%s'\n",
2430 http_common_plugin_address_to_string (plugin->protocol,
2433 GNUNET_CONTAINER_DLL_remove (plugin->addr_head,
2436 /* modify our published address list */
2438 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2439 "https_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2441 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2442 "http_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2444 plugin->env->notify_address (plugin->env->cls, add_remove, address);
2445 GNUNET_HELLO_address_free (address);
2446 GNUNET_free (w->address);
2453 * Our external IP address/port mapping has changed.
2455 * @param cls closure, the 'struct LocalAddrList'
2456 * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
2457 * the previous (now invalid) one
2458 * @param addr either the previous or the new public IP address
2459 * @param addrlen actual lenght of the address
2462 server_nat_port_map_callback (void *cls,
2464 const struct sockaddr *addr,
2467 struct HTTP_Server_Plugin *plugin = cls;
2469 LOG (GNUNET_ERROR_TYPE_DEBUG,
2470 "NAT called to %s address `%s'\n",
2471 (add_remove == GNUNET_NO) ? "remove" : "add",
2472 GNUNET_a2s (addr, addrlen));
2474 if (AF_INET == addr->sa_family)
2476 struct sockaddr_in *s4 = (struct sockaddr_in *) addr;
2478 if (GNUNET_NO == plugin->use_ipv4)
2481 if ((NULL != plugin->server_addr_v4) &&
2482 (0 != memcmp (&plugin->server_addr_v4->sin_addr,
2483 &s4->sin_addr, sizeof (struct in_addr))))
2485 LOG (GNUNET_ERROR_TYPE_DEBUG,
2486 "Skipping address `%s' (not bindto address)\n",
2487 GNUNET_a2s (addr, addrlen));
2492 if (AF_INET6 == addr->sa_family)
2494 struct sockaddr_in6 *s6 = (struct sockaddr_in6 *) addr;
2495 if (GNUNET_NO == plugin->use_ipv6)
2498 if ((NULL != plugin->server_addr_v6) &&
2499 (0 != memcmp (&plugin->server_addr_v6->sin6_addr,
2500 &s6->sin6_addr, sizeof (struct in6_addr))))
2502 LOG (GNUNET_ERROR_TYPE_DEBUG,
2503 "Skipping address `%s' (not bindto address)\n",
2504 GNUNET_a2s (addr, addrlen));
2512 server_add_address (cls, add_remove, addr, addrlen);
2515 server_remove_address (cls, add_remove, addr, addrlen);
2522 * Get valid server addresses
2524 * @param plugin the plugin handle
2525 * @param service_name the servicename
2526 * @param cfg configuration handle
2527 * @param addrs addresses
2528 * @param addr_lens address length
2529 * @return number of addresses
2532 server_get_addresses (struct HTTP_Server_Plugin *plugin,
2533 const char *service_name,
2534 const struct GNUNET_CONFIGURATION_Handle *cfg,
2535 struct sockaddr ***addrs,
2536 socklen_t ** addr_lens)
2539 unsigned long long port;
2540 struct addrinfo hints;
2541 struct addrinfo *res;
2542 struct addrinfo *pos;
2543 struct addrinfo *next;
2547 struct sockaddr **saddrs;
2548 socklen_t *saddrlens;
2554 disablev6 = !plugin->use_ipv6;
2557 if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT"))
2559 GNUNET_break (GNUNET_OK ==
2560 GNUNET_CONFIGURATION_get_value_number (cfg, service_name,
2564 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2565 _("Require valid port number for service in configuration!\n"));
2566 return GNUNET_SYSERR;
2571 LOG (GNUNET_ERROR_TYPE_INFO,
2572 "Starting in listen only mode\n");
2573 return -1; /* listen only */
2577 if (GNUNET_CONFIGURATION_have_value (cfg, service_name,
2580 GNUNET_break (GNUNET_OK ==
2581 GNUNET_CONFIGURATION_get_value_string (cfg, service_name,
2582 "BINDTO", &hostname));
2587 if (NULL != hostname)
2589 LOG (GNUNET_ERROR_TYPE_DEBUG,
2590 "Resolving `%s' since that is where `%s' will bind to.\n",
2591 hostname, service_name);
2592 memset (&hints, 0, sizeof (struct addrinfo));
2594 hints.ai_family = AF_INET;
2595 if ((0 != (ret = getaddrinfo (hostname, NULL, &hints, &res))) ||
2598 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2599 _("Failed to resolve `%s': %s\n"),
2601 gai_strerror (ret));
2602 GNUNET_free (hostname);
2603 return GNUNET_SYSERR;
2607 while (NULL != (pos = next))
2609 next = pos->ai_next;
2610 if ((disablev6) && (pos->ai_family == AF_INET6))
2616 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2617 _("Failed to find %saddress for `%s'.\n"),
2618 disablev6 ? "IPv4 " : "", hostname);
2620 GNUNET_free (hostname);
2621 return GNUNET_SYSERR;
2624 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2625 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2628 while (NULL != (pos = next))
2630 next = pos->ai_next;
2631 if ((disablev6) && (pos->ai_family == AF_INET6))
2633 if ((pos->ai_protocol != IPPROTO_TCP) && (0 != pos->ai_protocol))
2634 continue; /* not TCP */
2635 if ((pos->ai_socktype != SOCK_STREAM) && (0 != pos->ai_socktype))
2636 continue; /* huh? */
2637 LOG (GNUNET_ERROR_TYPE_DEBUG,
2638 "Service will bind to `%s'\n",
2639 GNUNET_a2s (pos->ai_addr,
2641 if (pos->ai_family == AF_INET)
2643 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
2644 saddrlens[i] = pos->ai_addrlen;
2645 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2646 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
2647 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2651 GNUNET_assert (pos->ai_family == AF_INET6);
2652 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
2653 saddrlens[i] = pos->ai_addrlen;
2654 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2655 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
2656 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
2660 GNUNET_free (hostname);
2666 /* will bind against everything, just set port */
2672 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2673 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2675 saddrlens[i] = sizeof (struct sockaddr_in);
2676 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2677 #if HAVE_SOCKADDR_IN_SIN_LEN
2678 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
2680 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
2681 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2687 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2688 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2690 saddrlens[i] = sizeof (struct sockaddr_in6);
2691 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2692 #if HAVE_SOCKADDR_IN_SIN_LEN
2693 ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
2695 ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
2696 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
2698 saddrlens[i] = sizeof (struct sockaddr_in);
2699 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2700 #if HAVE_SOCKADDR_IN_SIN_LEN
2701 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
2703 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
2704 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2708 *addr_lens = saddrlens;
2714 * Ask NAT for addresses
2716 * @param plugin the plugin handle
2719 server_start_report_addresses (struct HTTP_Server_Plugin *plugin)
2721 int res = GNUNET_OK;
2722 struct sockaddr **addrs;
2723 socklen_t *addrlens;
2725 res = server_get_addresses (plugin,
2729 LOG (GNUNET_ERROR_TYPE_DEBUG,
2730 _("Found %u addresses to report to NAT service\n"),
2733 if (GNUNET_SYSERR == res)
2740 GNUNET_NAT_register (plugin->env->cfg,
2744 (const struct sockaddr **) addrs, addrlens,
2745 &server_nat_port_map_callback, NULL, plugin);
2749 GNUNET_assert (NULL != addrs[res]);
2750 GNUNET_free (addrs[res]);
2752 GNUNET_free_non_null (addrs);
2753 GNUNET_free_non_null (addrlens);
2758 * Stop NAT for addresses
2760 * @param plugin the plugin handle
2763 server_stop_report_addresses (struct HTTP_Server_Plugin *plugin)
2765 struct HttpAddressWrapper *w;
2767 /* Stop NAT handle */
2768 if (NULL != plugin->nat)
2770 GNUNET_NAT_unregister (plugin->nat);
2773 /* Clean up addresses */
2774 while (NULL != plugin->addr_head)
2776 w = plugin->addr_head;
2777 GNUNET_CONTAINER_DLL_remove (plugin->addr_head,
2780 GNUNET_free (w->address);
2787 * Check if IPv6 supported on this system
2789 * @param plugin the plugin handle
2790 * @return #GNUNET_YES on success, else #GNUNET_NO
2793 server_check_ipv6_support (struct HTTP_Server_Plugin *plugin)
2795 struct GNUNET_NETWORK_Handle *desc = NULL;
2796 int res = GNUNET_NO;
2798 /* Probe IPv6 support */
2799 desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
2802 if ((errno == ENOBUFS) || (errno == ENOMEM) || (errno == ENFILE) ||
2805 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
2807 LOG (GNUNET_ERROR_TYPE_WARNING,
2808 _("Disabling IPv6 since it is not supported on this system!\n"));
2813 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
2817 LOG (GNUNET_ERROR_TYPE_DEBUG,
2818 "Testing IPv6 on this system: %s\n",
2819 (res == GNUNET_YES) ? "successful" : "failed");
2825 * Notify server about our external hostname
2828 * @param tc task context (unused)
2831 server_notify_external_hostname (void *cls,
2832 const struct GNUNET_SCHEDULER_TaskContext *tc)
2834 struct HTTP_Server_Plugin *plugin = cls;
2835 struct HttpAddress *ext_addr;
2836 size_t ext_addr_len;
2840 plugin->notify_ext_task = GNUNET_SCHEDULER_NO_TASK;
2841 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
2844 GNUNET_asprintf(&url,
2847 plugin->external_hostname);
2849 urlen = strlen (url) + 1;
2850 ext_addr = GNUNET_malloc (sizeof (struct HttpAddress) + urlen);
2851 ext_addr->options = htonl(plugin->options);
2852 ext_addr->urlen = htonl (urlen);
2853 ext_addr_len = sizeof (struct HttpAddress) + urlen;
2854 memcpy (&ext_addr[1], url, urlen);
2857 LOG (GNUNET_ERROR_TYPE_DEBUG,
2858 "Notifying transport about external hostname address `%s'\n",
2859 plugin->external_hostname);
2862 if (GNUNET_YES == plugin->verify_external_hostname)
2863 LOG (GNUNET_ERROR_TYPE_INFO,
2864 "Enabling SSL verification for external hostname address `%s'\n",
2865 plugin->external_hostname);
2866 plugin->ext_addr = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2867 "https_client", ext_addr, ext_addr_len, GNUNET_HELLO_ADDRESS_INFO_NONE );
2868 plugin->env->notify_address (plugin->env->cls, GNUNET_YES, plugin->ext_addr);
2869 GNUNET_free (ext_addr);
2871 plugin->ext_addr = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2872 "http_client", ext_addr, ext_addr_len, GNUNET_HELLO_ADDRESS_INFO_NONE );
2873 plugin->env->notify_address (plugin->env->cls, GNUNET_YES, plugin->ext_addr);
2874 GNUNET_free (ext_addr);
2880 * Configure the plugin
2882 * @param plugin plugin handle
2883 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2886 server_configure_plugin (struct HTTP_Server_Plugin *plugin)
2888 unsigned long long port;
2889 unsigned long long max_connections;
2890 char *bind4_address = NULL;
2891 char *bind6_address = NULL;
2892 char *eh_tmp = NULL;
2893 int external_hostname_use_port;
2896 if (GNUNET_CONFIGURATION_have_value
2897 (plugin->env->cfg, plugin->name, "USE_IPv4"))
2900 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2905 plugin->use_ipv4 = GNUNET_YES;
2906 LOG (GNUNET_ERROR_TYPE_DEBUG,
2907 _("IPv4 support is %s\n"),
2908 (plugin->use_ipv4 == GNUNET_YES) ? "enabled" : "disabled");
2911 if (GNUNET_CONFIGURATION_have_value
2912 (plugin->env->cfg, plugin->name, "USE_IPv6"))
2915 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2920 plugin->use_ipv6 = GNUNET_YES;
2921 LOG (GNUNET_ERROR_TYPE_DEBUG,
2922 _("IPv6 support is %s\n"),
2923 (plugin->use_ipv6 == GNUNET_YES) ? "enabled" : "disabled");
2925 if ((plugin->use_ipv4 == GNUNET_NO) && (plugin->use_ipv6 == GNUNET_NO))
2927 LOG (GNUNET_ERROR_TYPE_ERROR,
2928 _("Neither IPv4 nor IPv6 are enabled! Fix in configuration\n"));
2929 return GNUNET_SYSERR;
2932 /* Reading port number from config file */
2934 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
2936 "PORT", &port)) || (port > 65535))
2938 LOG (GNUNET_ERROR_TYPE_ERROR,
2939 _("Port is required! Fix in configuration\n"));
2940 return GNUNET_SYSERR;
2942 plugin->port = port;
2944 LOG (GNUNET_ERROR_TYPE_INFO,
2945 _("Using port %u\n"), plugin->port);
2947 if ((plugin->use_ipv4 == GNUNET_YES) &&
2948 (GNUNET_YES == GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2949 plugin->name, "BINDTO", &bind4_address)))
2951 LOG (GNUNET_ERROR_TYPE_DEBUG,
2952 "Binding %s plugin to specific IPv4 address: `%s'\n",
2953 plugin->protocol, bind4_address);
2954 plugin->server_addr_v4 = GNUNET_new (struct sockaddr_in);
2955 if (1 != inet_pton (AF_INET, bind4_address,
2956 &plugin->server_addr_v4->sin_addr))
2958 LOG (GNUNET_ERROR_TYPE_ERROR,
2959 _("Specific IPv4 address `%s' in configuration file is invalid!\n"),
2961 GNUNET_free (bind4_address);
2962 GNUNET_free (plugin->server_addr_v4);
2963 plugin->server_addr_v4 = NULL;
2964 return GNUNET_SYSERR;
2968 LOG (GNUNET_ERROR_TYPE_DEBUG,
2969 _("Binding to IPv4 address %s\n"),
2971 plugin->server_addr_v4->sin_family = AF_INET;
2972 plugin->server_addr_v4->sin_port = htons (plugin->port);
2974 GNUNET_free (bind4_address);
2977 if ((plugin->use_ipv6 == GNUNET_YES) &&
2979 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2981 "BINDTO6", &bind6_address)))
2983 LOG (GNUNET_ERROR_TYPE_DEBUG,
2984 "Binding %s plugin to specific IPv6 address: `%s'\n",
2985 plugin->protocol, bind6_address);
2986 plugin->server_addr_v6 = GNUNET_new (struct sockaddr_in6);
2988 inet_pton (AF_INET6, bind6_address, &plugin->server_addr_v6->sin6_addr))
2990 LOG (GNUNET_ERROR_TYPE_ERROR,
2991 _("Specific IPv6 address `%s' in configuration file is invalid!\n"),
2993 GNUNET_free (bind6_address);
2994 GNUNET_free (plugin->server_addr_v6);
2995 plugin->server_addr_v6 = NULL;
2996 return GNUNET_SYSERR;
3000 LOG (GNUNET_ERROR_TYPE_DEBUG,
3001 _("Binding to IPv6 address %s\n"),
3003 plugin->server_addr_v6->sin6_family = AF_INET6;
3004 plugin->server_addr_v6->sin6_port = htons (plugin->port);
3006 GNUNET_free (bind6_address);
3009 plugin->verify_external_hostname = GNUNET_NO;
3011 plugin->verify_external_hostname = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3013 "VERIFY_EXTERNAL_HOSTNAME");
3014 if (GNUNET_SYSERR == plugin->verify_external_hostname)
3015 plugin->verify_external_hostname = GNUNET_NO;
3016 if (GNUNET_YES == plugin->verify_external_hostname)
3017 plugin->options |= HTTP_OPTIONS_VERIFY_CERTIFICATE;
3019 external_hostname_use_port = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3021 "EXTERNAL_HOSTNAME_USE_PORT");
3022 if (GNUNET_SYSERR == external_hostname_use_port)
3023 external_hostname_use_port = GNUNET_NO;
3027 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
3029 "EXTERNAL_HOSTNAME",
3034 char *pos_url = NULL;
3036 if (NULL != strstr(eh_tmp, "://"))
3037 tmp = &strstr(eh_tmp, "://")[3];
3041 if (GNUNET_YES == external_hostname_use_port)
3043 if ( (strlen (tmp) > 1) && (NULL != (pos = strchr(tmp, '/'))) )
3047 GNUNET_asprintf (&plugin->external_hostname,
3051 (NULL == pos_url) ? "" : pos_url);
3054 GNUNET_asprintf (&plugin->external_hostname,
3060 plugin->external_hostname = GNUNET_strdup (tmp);
3061 GNUNET_free (eh_tmp);
3063 LOG (GNUNET_ERROR_TYPE_INFO,
3064 _("Using external hostname `%s'\n"),
3065 plugin->external_hostname);
3066 plugin->notify_ext_task = GNUNET_SCHEDULER_add_now (&server_notify_external_hostname,
3069 /* Use only configured external hostname */
3070 if (GNUNET_CONFIGURATION_have_value
3073 "EXTERNAL_HOSTNAME_ONLY"))
3075 plugin->external_only =
3076 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3078 "EXTERNAL_HOSTNAME_ONLY");
3081 plugin->external_only = GNUNET_NO;
3083 if (GNUNET_YES == plugin->external_only)
3084 LOG (GNUNET_ERROR_TYPE_DEBUG,
3085 _("Notifying transport only about hostname `%s'\n"),
3086 plugin->external_hostname);
3089 LOG (GNUNET_ERROR_TYPE_DEBUG,
3090 "No external hostname configured\n");
3092 /* Optional parameters */
3094 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
3098 max_connections = 128;
3099 plugin->max_request = max_connections;
3101 LOG (GNUNET_ERROR_TYPE_DEBUG,
3102 _("Maximum number of connections is %u\n"),
3103 plugin->max_request);
3105 plugin->peer_id_length = strlen (GNUNET_i2s_full (plugin->env->my_identity));
3112 * Exit point from the plugin.
3118 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
3120 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
3121 struct HTTP_Server_Plugin *plugin = api->cls;
3123 if (NULL == api->cls)
3125 /* Free for stub mode */
3129 plugin->in_shutdown = GNUNET_YES;
3130 LOG (GNUNET_ERROR_TYPE_INFO,
3131 _("Shutting down plugin `%s'\n"),
3134 if (GNUNET_SCHEDULER_NO_TASK != plugin->notify_ext_task)
3136 GNUNET_SCHEDULER_cancel (plugin->notify_ext_task);
3137 plugin->notify_ext_task = GNUNET_SCHEDULER_NO_TASK;
3140 if (NULL != plugin->ext_addr)
3142 LOG (GNUNET_ERROR_TYPE_DEBUG,
3143 "Notifying transport to remove address `%s'\n",
3144 http_common_plugin_address_to_string (plugin->protocol,
3145 plugin->ext_addr->address,
3146 plugin->ext_addr->address_length));
3148 plugin->env->notify_address (plugin->env->cls,
3152 plugin->env->notify_address (plugin->env->cls,
3156 GNUNET_HELLO_address_free (plugin->ext_addr);
3157 plugin->ext_addr = NULL;
3160 /* Stop to report addresses to transport service */
3161 server_stop_report_addresses (plugin);
3162 if (NULL != plugin->server_v4)
3164 MHD_stop_daemon (plugin->server_v4);
3165 plugin->server_v4 = NULL;
3167 if (NULL != plugin->server_v6)
3169 MHD_stop_daemon (plugin->server_v6);
3170 plugin->server_v6 = NULL;
3172 if (GNUNET_SCHEDULER_NO_TASK != plugin->server_v4_task)
3174 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
3175 plugin->server_v4_task = GNUNET_SCHEDULER_NO_TASK;
3178 if (GNUNET_SCHEDULER_NO_TASK != plugin->server_v6_task)
3180 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
3181 plugin->server_v6_task = GNUNET_SCHEDULER_NO_TASK;
3184 GNUNET_free_non_null (plugin->crypto_init);
3185 GNUNET_free_non_null (plugin->cert);
3186 GNUNET_free_non_null (plugin->key);
3188 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
3189 &destroy_session_shutdown_cb,
3191 GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
3192 plugin->sessions = NULL;
3194 GNUNET_free_non_null (plugin->external_hostname);
3195 GNUNET_free_non_null (plugin->ext_addr);
3196 GNUNET_free_non_null (plugin->server_addr_v4);
3197 GNUNET_free_non_null (plugin->server_addr_v6);
3198 regfree (&plugin->url_regex);
3200 LOG (GNUNET_ERROR_TYPE_DEBUG,
3201 _("Shutdown for plugin `%s' complete\n"),
3204 GNUNET_free (plugin);
3211 * Function called by the pretty printer for the resolved address for
3212 * each human-readable address obtained. The callback can be called
3213 * several times. The last invocation must be with a @a address of
3214 * NULL and a @a res of #GNUNET_OK. Thus, to indicate conversion
3215 * errors, the callback might be called first with @a address NULL and
3216 * @a res being #GNUNET_SYSERR. In that case, there must still be a
3217 * subsequent call later with @a address NULL and @a res #GNUNET_OK.
3219 * @param cls closure
3220 * @param address one of the names for the host, NULL on last callback
3221 * @param res #GNUNET_OK if conversion was successful, #GNUNET_SYSERR on failure,
3222 * #GNUNET_OK on last callback
3225 http_server_plugin_address_to_string (void *cls,
3229 return http_common_plugin_address_to_string (PLUGIN_NAME,
3236 * Function obtain the network type for a session
3238 * @param cls closure ('struct HTTP_Server_Plugin*')
3239 * @param session the session
3240 * @return the network type in HBO or #GNUNET_SYSERR
3242 static enum GNUNET_ATS_Network_Type
3243 http_server_plugin_get_network (void *cls,
3244 struct Session *session)
3246 return ntohl (session->ats_address_network_type);
3251 * Function that will be called whenever the transport service wants to
3252 * notify the plugin that the inbound quota changed and that the plugin
3253 * should update it's delay for the next receive value
3255 * @param cls closure
3256 * @param peer which peer was the session for
3257 * @param session which session is being updated
3258 * @param delay new delay to use for receiving
3261 http_server_plugin_update_inbound_delay (void *cls,
3262 const struct GNUNET_PeerIdentity *peer,
3264 struct GNUNET_TIME_Relative delay)
3266 s->next_receive = GNUNET_TIME_relative_to_absolute (delay);
3267 LOG (GNUNET_ERROR_TYPE_DEBUG,
3268 "New inbound delay %s\n",
3269 GNUNET_STRINGS_relative_time_to_string (delay,
3271 if (GNUNET_SCHEDULER_NO_TASK != s->recv_wakeup_task)
3273 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
3275 = GNUNET_SCHEDULER_add_delayed (delay,
3283 * Return information about the given session to the
3286 * @param cls the `struct Plugin` with the monitor callback (`sic`)
3287 * @param peer peer we send information about
3288 * @param value our `struct Session` to send information about
3289 * @return #GNUNET_OK (continue to iterate)
3292 send_session_info_iter (void *cls,
3293 const struct GNUNET_PeerIdentity *peer,
3296 struct HTTP_Server_Plugin *plugin = cls;
3297 struct Session *session = value;
3299 notify_session_monitor (plugin,
3301 GNUNET_TRANSPORT_SS_UP);
3307 * Begin monitoring sessions of a plugin. There can only
3308 * be one active monitor per plugin (i.e. if there are
3309 * multiple monitors, the transport service needs to
3310 * multiplex the generated events over all of them).
3312 * @param cls closure of the plugin
3313 * @param sic callback to invoke, NULL to disable monitor;
3314 * plugin will being by iterating over all active
3315 * sessions immediately and then enter monitor mode
3316 * @param sic_cls closure for @a sic
3319 http_server_plugin_setup_monitor (void *cls,
3320 GNUNET_TRANSPORT_SessionInfoCallback sic,
3323 struct HTTP_Server_Plugin *plugin = cls;
3326 plugin->sic_cls = sic_cls;
3329 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
3330 &send_session_info_iter,
3332 /* signal end of first iteration */
3333 sic (sic_cls, NULL, NULL);
3339 * Entry point for the plugin.
3345 LIBGNUNET_PLUGIN_TRANSPORT_INIT (void *cls)
3347 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
3348 struct GNUNET_TRANSPORT_PluginFunctions *api;
3349 struct HTTP_Server_Plugin *plugin;
3351 if (NULL == env->receive)
3353 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
3354 initialze the plugin or the API */
3355 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3357 api->address_to_string = &http_server_plugin_address_to_string;
3358 api->string_to_address = &http_common_plugin_string_to_address;
3359 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
3362 plugin = GNUNET_new (struct HTTP_Server_Plugin);
3364 plugin->sessions = GNUNET_CONTAINER_multipeermap_create (128,
3366 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3368 api->send = &http_server_plugin_send;
3369 api->disconnect_peer = &http_server_plugin_disconnect_peer;
3370 api->disconnect_session = &http_server_plugin_disconnect_session;
3371 api->query_keepalive_factor = &http_server_query_keepalive_factor;
3372 api->check_address = &http_server_plugin_address_suggested;
3373 api->get_session = &http_server_plugin_get_session;
3375 api->address_to_string = &http_server_plugin_address_to_string;
3376 api->string_to_address = &http_common_plugin_string_to_address;
3377 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
3378 api->get_network = &http_server_plugin_get_network;
3379 api->update_session_timeout = &http_server_plugin_update_session_timeout;
3380 api->update_inbound_delay = &http_server_plugin_update_inbound_delay;
3381 api->setup_monitor = &http_server_plugin_setup_monitor;
3383 plugin->name = "transport-https_server";
3384 plugin->protocol = "https";
3386 plugin->name = "transport-http_server";
3387 plugin->protocol = "http";
3390 /* Compile URL regex */
3391 if (regcomp(&plugin->url_regex,
3395 LOG (GNUNET_ERROR_TYPE_ERROR,
3396 _("Unable to compile URL regex\n"));
3397 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3401 /* Configure plugin */
3402 if (GNUNET_SYSERR == server_configure_plugin (plugin))
3404 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3408 /* Check IPv6 support */
3409 if (GNUNET_YES == plugin->use_ipv6)
3410 plugin->use_ipv6 = server_check_ipv6_support (plugin);
3412 /* Report addresses to transport service */
3413 if (GNUNET_NO == plugin->external_only)
3414 server_start_report_addresses (plugin);
3416 if (GNUNET_SYSERR == server_start (plugin))
3418 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3424 /* end of plugin_transport_http_server.c */