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.
60 struct ServerConnection
63 * The session this server connection belongs to
65 struct Session *session;
70 struct MHD_Connection *mhd_conn;
75 struct MHD_Daemon *mhd_daemon;
78 * Options requested by peer
81 #define OPTION_LONG_POLL 1 /* GET request wants long-poll semantics */
89 * For PUT connections: Is this the first or last callback with size 0
90 * For GET connections: Have we sent a message
98 * Wrapper to manage addresses
100 struct HttpAddressWrapper
105 struct HttpAddressWrapper *next;
108 * Linked list previous
110 struct HttpAddressWrapper *prev;
113 * An address we are using.
115 struct HttpAddress *address;
118 * Length of the address.
125 * Message to send using http
130 * next pointer for double linked list
132 struct HTTP_Message *next;
135 * previous pointer for double linked list
137 struct HTTP_Message *prev;
140 * buffer containing data to send
145 * amount of data already sent
155 * HTTP/S specific overhead
160 * Continuation function to call once the transmission buffer
161 * has again space available. NULL if there is no
162 * continuation to call.
164 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
167 * Closure for transmit_cont.
169 void *transmit_cont_cls;
174 * Session handle for connections.
180 * To whom are we talking to (set to our identity
181 * if we are still waiting for the welcome message)
183 struct GNUNET_PeerIdentity target;
186 * Pointer to the global plugin struct.
188 struct HTTP_Server_Plugin *plugin;
191 * next pointer for double linked list
193 struct HTTP_Message *msg_head;
196 * previous pointer for double linked list
198 struct HTTP_Message *msg_tail;
201 * Message stream tokenizer for incoming data
203 struct GNUNET_SERVER_MessageStreamTokenizer *msg_tk;
208 struct ServerConnection *server_recv;
213 struct ServerConnection *server_send;
218 struct GNUNET_HELLO_Address *address;
221 * Absolute time when to receive data again
222 * Used for receive throttling
224 struct GNUNET_TIME_Absolute next_receive;
227 * Absolute time when this connection will time out.
229 struct GNUNET_TIME_Absolute timeout;
232 * Session timeout task
234 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
237 * Task to resume MHD handling when receiving is allowed again
239 GNUNET_SCHEDULER_TaskIdentifier recv_wakeup_task;
242 * Number of bytes waiting for transmission to this peer.
244 unsigned long long bytes_in_queue;
247 * Number of messages waiting for transmission to this peer.
249 unsigned int msgs_in_queue;
252 * Unique HTTP/S connection tag for this connection
257 * ATS network type in NBO
259 uint32_t ats_address_network_type;
262 * #GNUNET_YES if this session is known to the service.
264 int known_to_service;
270 * Encapsulation of all of the state of the plugin.
272 struct HTTP_Server_Plugin
277 struct GNUNET_TRANSPORT_PluginEnvironment *env;
280 * Hash map of open sessions.
282 struct GNUNET_CONTAINER_MultiPeerMap *sessions;
285 * Function to call about session status changes.
287 GNUNET_TRANSPORT_SessionInfoCallback sic;
290 * Closure for @e sic.
307 char *external_hostname;
310 * External hostname the plugin can be connected to, can be different to
311 * the host's FQDN, used e.g. for reverse proxying
313 struct GNUNET_HELLO_Address *ext_addr;
316 * NAT handle & address management
318 struct GNUNET_NAT_Handle *nat;
321 * IPv4 addresses DLL head
323 struct HttpAddressWrapper *addr_head;
326 * IPv4 addresses DLL tail
328 struct HttpAddressWrapper *addr_tail;
331 * IPv4 server socket to bind to
333 struct sockaddr_in *server_addr_v4;
336 * IPv6 server socket to bind to
338 struct sockaddr_in6 *server_addr_v6;
343 struct MHD_Daemon *server_v4;
348 struct MHD_Daemon *server_v6;
356 * Use RC4-128 instead of AES:
357 * NONE:+VERS-TLS1.0:+ARCFOUR-128:+SHA1:+RSA:+COMP-NULL
376 GNUNET_SCHEDULER_TaskIdentifier server_v4_task;
381 GNUNET_SCHEDULER_TaskIdentifier server_v6_task;
384 * Task calling transport service about external address
386 GNUNET_SCHEDULER_TaskIdentifier notify_ext_task;
389 * Notify transport only about external address
391 unsigned int external_only;
394 * The IPv4 server is scheduled to run asap
396 int server_v4_immediately;
399 * The IPv6 server is scheduled to run asap
401 int server_v6_immediately;
404 * Verify external address
406 int verify_external_hostname;
409 * Maximum number of sockets the plugin can use
410 * Each http inbound /outbound connections are two connections
412 unsigned int max_connections;
415 * Current number of sockets the plugin can use
416 * Each http inbound /outbound connections are two connections
418 unsigned int cur_connections;
421 * Did we immediately end the session in disconnect_cb
431 * My options to be included in the address
451 * Regex for parsing URLs. FIXME: this seems overkill.
459 * If a session monitor is attached, notify it about the new
462 * @param plugin our plugin
463 * @param session session that changed state
464 * @param state new state of the session
467 notify_session_monitor (struct HTTP_Server_Plugin *plugin,
468 struct Session *session,
469 enum GNUNET_TRANSPORT_SessionState state)
471 struct GNUNET_TRANSPORT_SessionInfo info;
473 if (NULL == plugin->sic)
475 memset (&info, 0, sizeof (info));
477 info.is_inbound = GNUNET_YES;
478 info.num_msg_pending = session->msgs_in_queue;
479 info.num_bytes_pending = session->bytes_in_queue;
480 info.receive_delay = session->next_receive;
481 info.session_timeout = session->timeout;
482 info.address = session->address;
483 plugin->sic (plugin->sic_cls,
490 * Wake up an MHD connection which was suspended
492 * @param cls the session
493 * @param tc task context
496 server_wake_up (void *cls,
497 const struct GNUNET_SCHEDULER_TaskContext *tc)
499 struct Session *s = cls;
501 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
502 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
504 LOG (GNUNET_ERROR_TYPE_DEBUG,
505 "Session %p: Waking up PUT handle\n",
507 MHD_resume_connection (s->server_recv->mhd_conn);
512 * Reschedule the execution of both IPv4 and IPv6 server.
514 * @param plugin the plugin
515 * @param server which server to schedule v4 or v6?
516 * @param now #GNUNET_YES to schedule execution immediately, #GNUNET_NO to wait
520 server_reschedule (struct HTTP_Server_Plugin *plugin,
521 struct MHD_Daemon *server,
526 * Deletes the session. Must not be used afterwards.
528 * @param s the session to delete
531 server_delete_session (struct Session *s)
533 struct HTTP_Server_Plugin *plugin = s->plugin;
534 struct HTTP_Message *msg;
535 struct ServerConnection *send;
536 struct ServerConnection *recv;
538 if (GNUNET_SCHEDULER_NO_TASK != s->timeout_task)
540 GNUNET_SCHEDULER_cancel (s->timeout_task);
541 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
542 s->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
544 if (GNUNET_SCHEDULER_NO_TASK != s->recv_wakeup_task)
546 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
547 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
548 if (NULL != s->server_recv)
549 MHD_resume_connection (s->server_recv->mhd_conn);
551 GNUNET_assert (GNUNET_OK ==
552 GNUNET_CONTAINER_multipeermap_remove (plugin->sessions,
555 while (NULL != (msg = s->msg_head))
557 GNUNET_CONTAINER_DLL_remove (s->msg_head,
560 if (NULL != msg->transmit_cont)
561 msg->transmit_cont (msg->transmit_cont_cls,
565 msg->pos + msg->overhead);
566 GNUNET_assert (s->msgs_in_queue > 0);
568 GNUNET_assert (s->bytes_in_queue >= msg->size);
569 s->bytes_in_queue -= msg->size;
572 GNUNET_assert (0 == s->msgs_in_queue);
573 GNUNET_assert (0 == s->bytes_in_queue);
574 send = 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 send->session = NULL;
582 MHD_set_connection_option (send->mhd_conn,
583 MHD_CONNECTION_OPTION_TIMEOUT,
584 1 /* 0 = no timeout, so this is MIN */);
585 server_reschedule (plugin,
589 recv = s->server_recv;
592 LOG (GNUNET_ERROR_TYPE_DEBUG,
593 "Server: %p / %p Terminating inbound GET session to peer `%s'\n",
594 s, recv, GNUNET_i2s (&s->target));
595 recv->session = NULL;
596 MHD_set_connection_option (recv->mhd_conn,
597 MHD_CONNECTION_OPTION_TIMEOUT,
598 1 /* 0 = no timeout, so this is MIN */);
599 server_reschedule (plugin,
603 notify_session_monitor (plugin,
605 GNUNET_TRANSPORT_SS_DOWN);
606 if (GNUNET_YES == s->known_to_service)
607 plugin->env->session_end (plugin->env->cls,
610 if (NULL != s->msg_tk)
612 GNUNET_SERVER_mst_destroy (s->msg_tk);
615 GNUNET_HELLO_address_free (s->address);
616 LOG (GNUNET_ERROR_TYPE_DEBUG,
617 "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 = GNUNET_SCHEDULER_NO_TASK;
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 (GNUNET_SCHEDULER_NO_TASK != 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/connection %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,
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_cb (void *cls,
783 const struct GNUNET_PeerIdentity *peer,
786 struct Session *s = value;
788 server_delete_session (s);
794 * Function that can be used to force the plugin to disconnect
795 * from the given peer and cancel all previous transmissions
796 * (and their continuationc).
799 * @param target peer from which to disconnect
802 http_server_plugin_disconnect_peer (void *cls,
803 const struct GNUNET_PeerIdentity *target)
805 struct HTTP_Server_Plugin *plugin = cls;
807 LOG (GNUNET_ERROR_TYPE_DEBUG,
808 "Transport tells me to disconnect `%s'\n",
809 GNUNET_i2s (target));
810 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
818 * Another peer has suggested an address for this
819 * peer and transport plugin. Check that this could be a valid
820 * address. If so, consider adding it to the list
824 * @param addr pointer to the address
825 * @param addrlen length of @a addr
826 * @return #GNUNET_OK if this is a plausible address for this peer
830 http_server_plugin_address_suggested (void *cls,
834 struct HTTP_Server_Plugin *plugin = cls;
835 struct HttpAddressWrapper *next;
836 struct HttpAddressWrapper *pos;
837 const struct HttpAddress *haddr = addr;
839 if ((NULL != plugin->ext_addr) &&
840 GNUNET_YES == (http_common_cmp_addresses (addr, addrlen,
841 plugin->ext_addr->address,
842 plugin->ext_addr->address_length)))
844 /* Checking HTTP_OPTIONS_VERIFY_CERTIFICATE option for external hostname */
845 if ((ntohl (haddr->options) & HTTP_OPTIONS_VERIFY_CERTIFICATE) !=
846 (plugin->options & HTTP_OPTIONS_VERIFY_CERTIFICATE))
847 return GNUNET_NO; /* VERIFY option not set as required! */
850 next = plugin->addr_head;
851 while (NULL != (pos = next))
854 if (GNUNET_YES == (http_common_cmp_addresses(addr,
865 * Creates a new outbound session the transport
866 * service will use to send data to the peer.
868 * Since HTTP/S server cannot create sessions, always returns NULL.
870 * @param cls the plugin
871 * @param address the address
872 * @return always NULL
874 static struct Session *
875 http_server_plugin_get_session (void *cls,
876 const struct GNUNET_HELLO_Address *address)
883 * Call MHD IPv4 to process pending requests and then go back
884 * and schedule the next run.
886 * @param cls plugin as closure
887 * @param tc task context
890 server_v4_run (void *cls,
891 const struct GNUNET_SCHEDULER_TaskContext *tc)
893 struct HTTP_Server_Plugin *plugin = cls;
895 plugin->server_v4_task = GNUNET_SCHEDULER_NO_TASK;
896 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
898 plugin->server_v4_immediately = GNUNET_NO;
899 GNUNET_assert (MHD_YES == MHD_run (plugin->server_v4));
900 server_reschedule (plugin, plugin->server_v4, GNUNET_NO);
905 * Call MHD IPv6 to process pending requests and then go back
906 * and schedule the next run.
908 * @param cls plugin as closure
909 * @param tc task context
912 server_v6_run (void *cls,
913 const struct GNUNET_SCHEDULER_TaskContext *tc)
915 struct HTTP_Server_Plugin *plugin = cls;
917 plugin->server_v6_task = GNUNET_SCHEDULER_NO_TASK;
918 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
920 plugin->server_v6_immediately = GNUNET_NO;
921 GNUNET_assert (MHD_YES == MHD_run (plugin->server_v6));
922 server_reschedule (plugin, plugin->server_v6, GNUNET_NO);
927 * Function that queries MHD's select sets and
928 * starts the task waiting for them.
930 * @param plugin plugin
931 * @param daemon_handle the MHD daemon handle
932 * @return gnunet task identifier
934 static GNUNET_SCHEDULER_TaskIdentifier
935 server_schedule (struct HTTP_Server_Plugin *plugin,
936 struct MHD_Daemon *daemon_handle,
939 GNUNET_SCHEDULER_TaskIdentifier ret;
943 struct GNUNET_NETWORK_FDSet *wrs;
944 struct GNUNET_NETWORK_FDSet *wws;
946 MHD_UNSIGNED_LONG_LONG timeout;
947 static unsigned long long last_timeout = 0;
949 struct GNUNET_TIME_Relative tv;
951 if (GNUNET_YES == plugin->in_shutdown)
952 return GNUNET_SCHEDULER_NO_TASK;
954 ret = GNUNET_SCHEDULER_NO_TASK;
958 wrs = GNUNET_NETWORK_fdset_create ();
959 wws = GNUNET_NETWORK_fdset_create ();
961 GNUNET_assert (MHD_YES ==
962 MHD_get_fdset (daemon_handle,
967 haveto = MHD_get_timeout (daemon_handle, &timeout);
968 if (haveto == MHD_YES)
970 if (timeout != last_timeout)
972 LOG (GNUNET_ERROR_TYPE_DEBUG,
973 "SELECT Timeout changed from %llu to %llu (ms)\n",
974 last_timeout, timeout);
975 last_timeout = timeout;
977 if (timeout <= GNUNET_TIME_UNIT_SECONDS.rel_value_us / 1000LL)
978 tv.rel_value_us = (uint64_t) timeout * 1000LL;
980 tv = GNUNET_TIME_UNIT_SECONDS;
983 tv = GNUNET_TIME_UNIT_SECONDS;
984 /* Force immediate run, since we have outbound data to send */
985 if (now == GNUNET_YES)
986 tv = GNUNET_TIME_UNIT_MILLISECONDS;
987 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
988 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
990 if (daemon_handle == plugin->server_v4)
992 if (plugin->server_v4_task != GNUNET_SCHEDULER_NO_TASK)
994 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
995 plugin->server_v4_task = GNUNET_SCHEDULER_NO_TASK;
998 LOG (GNUNET_ERROR_TYPE_DEBUG,
999 "Scheduling IPv4 server task in %llu ms\n",
1003 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1005 &server_v4_run, plugin);
1007 if (daemon_handle == plugin->server_v6)
1009 if (plugin->server_v6_task != GNUNET_SCHEDULER_NO_TASK)
1011 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
1012 plugin->server_v6_task = GNUNET_SCHEDULER_NO_TASK;
1015 LOG (GNUNET_ERROR_TYPE_DEBUG,
1016 "Scheduling IPv6 server task in %llu ms\n", tv);
1019 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1021 &server_v6_run, plugin);
1023 GNUNET_NETWORK_fdset_destroy (wrs);
1024 GNUNET_NETWORK_fdset_destroy (wws);
1030 * Reschedule the execution of both IPv4 and IPv6 server
1032 * @param plugin the plugin
1033 * @param server which server to schedule v4 or v6?
1034 * @param now #GNUNET_YES to schedule execution immediately, #GNUNET_NO to wait
1038 server_reschedule (struct HTTP_Server_Plugin *plugin,
1039 struct MHD_Daemon *server,
1042 if ((server == plugin->server_v4) && (plugin->server_v4 != NULL))
1044 if (GNUNET_YES == plugin->server_v4_immediately)
1045 return; /* No rescheduling, server will run asap */
1047 if (GNUNET_YES == now)
1048 plugin->server_v4_immediately = GNUNET_YES;
1050 if (plugin->server_v4_task != GNUNET_SCHEDULER_NO_TASK)
1052 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
1053 plugin->server_v4_task = GNUNET_SCHEDULER_NO_TASK;
1055 plugin->server_v4_task = server_schedule (plugin, plugin->server_v4, now);
1058 if ((server == plugin->server_v6) && (plugin->server_v6 != NULL))
1060 if (GNUNET_YES == plugin->server_v6_immediately)
1061 return; /* No rescheduling, server will run asap */
1063 if (GNUNET_YES == now)
1064 plugin->server_v6_immediately = GNUNET_YES;
1066 if (plugin->server_v6_task != GNUNET_SCHEDULER_NO_TASK)
1068 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
1069 plugin->server_v6_task = GNUNET_SCHEDULER_NO_TASK;
1071 plugin->server_v6_task = server_schedule (plugin, plugin->server_v6, now);
1077 * Function that is called to get the keepalive factor.
1078 * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
1079 * calculate the interval between keepalive packets.
1081 * @param cls closure with the `struct HTTP_Server_Plugin`
1082 * @return keepalive factor
1085 http_server_query_keepalive_factor (void *cls)
1092 * Function that will be called whenever the transport service wants to
1093 * notify the plugin that a session is still active and in use and
1094 * therefore the session timeout for this session has to be updated
1096 * @param cls closure
1097 * @param peer which peer was the session for
1098 * @param session which session is being updated
1101 http_server_plugin_update_session_timeout (void *cls,
1102 const struct GNUNET_PeerIdentity *peer,
1103 struct Session *session)
1105 server_reschedule_session_timeout (session);
1110 * Tell MHD that the connection should timeout after @a to seconds.
1112 * @param plugin our plugin
1113 * @param s session for which the timeout changes
1114 * @param to timeout in seconds
1117 server_mhd_connection_timeout (struct HTTP_Server_Plugin *plugin,
1121 /* Setting timeouts for other connections */
1122 if (NULL != s->server_recv)
1124 LOG (GNUNET_ERROR_TYPE_DEBUG,
1125 "Setting timeout for %p to %u sec.\n",
1126 s->server_recv, to);
1127 MHD_set_connection_option (s->server_recv->mhd_conn,
1128 MHD_CONNECTION_OPTION_TIMEOUT,
1130 server_reschedule (plugin, s->server_recv->mhd_daemon, GNUNET_NO);
1132 if (NULL != s->server_send)
1134 LOG (GNUNET_ERROR_TYPE_DEBUG,
1135 "Setting timeout for %p to %u sec.\n",
1136 s->server_send, to);
1137 MHD_set_connection_option (s->server_send->mhd_conn,
1138 MHD_CONNECTION_OPTION_TIMEOUT,
1140 server_reschedule (plugin, s->server_send->mhd_daemon, GNUNET_NO);
1146 * Parse incoming URL for tag and target
1148 * @param plugin plugin
1149 * @param url incoming url
1150 * @param target where to store the target
1151 * @param tag where to store the tag
1152 * @param options where to store the options
1153 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1156 server_parse_url (struct HTTP_Server_Plugin *plugin,
1158 struct GNUNET_PeerIdentity *target,
1162 regmatch_t matches[4];
1163 const char *tag_start;
1164 const char *target_start;
1168 unsigned long int rc;
1172 ("^.*/([0-9A-Z]+);([0-9]+)(,[0-9]+)?$")
1177 return GNUNET_SYSERR;
1180 if (regexec(&plugin->url_regex, url, 4, matches, 0))
1182 LOG (GNUNET_ERROR_TYPE_DEBUG,
1183 "URL `%s' did not match regex\n", url);
1184 return GNUNET_SYSERR;
1187 target_start = &url[matches[1].rm_so];
1188 tag_start = &url[matches[2].rm_so];
1191 rc = strtoul (tag_start, &tag_end, 10);
1192 if (&url[matches[2].rm_eo] != tag_end)
1194 LOG (GNUNET_ERROR_TYPE_DEBUG,
1195 "URL tag did not line up with submatch\n");
1196 return GNUNET_SYSERR;
1200 LOG (GNUNET_ERROR_TYPE_DEBUG,
1201 "URL tag is zero\n");
1202 return GNUNET_SYSERR;
1204 if ((rc == ULONG_MAX) && (ERANGE == errno))
1206 LOG (GNUNET_ERROR_TYPE_DEBUG,
1207 "URL tag > ULONG_MAX\n");
1208 return GNUNET_SYSERR;
1210 if (rc > UINT32_MAX)
1212 LOG (GNUNET_ERROR_TYPE_DEBUG,
1213 "URL tag > UINT32_MAX\n");
1214 return GNUNET_SYSERR;
1216 (*tag) = (uint32_t)rc;
1217 LOG (GNUNET_ERROR_TYPE_DEBUG,
1218 "Found tag `%u' in url\n",
1221 /* convert peer id */
1222 hash_length = matches[1].rm_eo - matches[1].rm_so;
1223 if (hash_length != plugin->peer_id_length)
1225 LOG (GNUNET_ERROR_TYPE_DEBUG,
1226 "URL target is %u bytes, expecting %u\n",
1227 hash_length, plugin->peer_id_length);
1228 return GNUNET_SYSERR;
1231 GNUNET_CRYPTO_eddsa_public_key_from_string (target_start,
1233 &target->public_key))
1235 LOG (GNUNET_ERROR_TYPE_DEBUG,
1236 "URL target conversion failed\n");
1237 return GNUNET_SYSERR;
1239 LOG (GNUNET_ERROR_TYPE_DEBUG,
1240 "Found target `%s' in URL\n",
1241 GNUNET_i2s_full (target));
1243 /* convert options */
1244 if (-1 == matches[3].rm_so)
1250 rc = strtoul (&url[matches[3].rm_so + 1], &options_end, 10);
1251 if (&url[matches[3].rm_eo] != options_end)
1253 LOG (GNUNET_ERROR_TYPE_DEBUG,
1254 "URL options did not line up with submatch\n");
1255 return GNUNET_SYSERR;
1257 if ((rc == ULONG_MAX) && (ERANGE == errno))
1259 LOG (GNUNET_ERROR_TYPE_DEBUG,
1260 "URL options > ULONG_MAX\n");
1261 return GNUNET_SYSERR;
1263 if (rc > UINT32_MAX)
1265 LOG (GNUNET_ERROR_TYPE_DEBUG,
1266 "URL options > UINT32_MAX\n");
1267 return GNUNET_SYSERR;
1269 (*options) = (uint32_t) rc;
1270 LOG (GNUNET_ERROR_TYPE_DEBUG,
1271 "Found options `%u' in url\n",
1279 * Closure for #session_tag_it().
1281 struct SessionTagContext
1284 * Set to session matching the tag.
1286 struct Session *res;
1289 * Tag we are looking for.
1296 * Find a session with a matching tag.
1298 * @param cls the `struct SessionTagContext *`
1299 * @param key peer identity (unused)
1300 * @param value the `struct Session *`
1301 * @return #GNUNET_NO if we found the session, #GNUNET_OK if not
1304 session_tag_it (void *cls,
1305 const struct GNUNET_PeerIdentity *key,
1308 struct SessionTagContext *stc = cls;
1309 struct Session *s = value;
1311 if (s->tag == stc->tag)
1321 * Lookup a mhd connection and create one if none is found
1323 * @param plugin the plugin handle
1324 * @param mhd_connection the incoming mhd_connection
1325 * @param url incoming requested URL
1326 * @param method PUT or GET
1327 * @return the server connecetion
1329 static struct ServerConnection *
1330 server_lookup_connection (struct HTTP_Server_Plugin *plugin,
1331 struct MHD_Connection *mhd_connection,
1335 struct Session *s = NULL;
1336 struct ServerConnection *sc = NULL;
1337 const union MHD_ConnectionInfo *conn_info;
1338 struct HttpAddress *addr;
1339 struct GNUNET_ATS_Information ats;
1340 struct GNUNET_PeerIdentity target;
1342 struct SessionTagContext stc;
1344 int direction = GNUNET_SYSERR;
1347 conn_info = MHD_get_connection_info (mhd_connection,
1348 MHD_CONNECTION_INFO_CLIENT_ADDRESS);
1349 if ((conn_info->client_addr->sa_family != AF_INET) &&
1350 (conn_info->client_addr->sa_family != AF_INET6))
1352 LOG (GNUNET_ERROR_TYPE_DEBUG,
1353 "New %s connection from %s\n",
1357 if (GNUNET_SYSERR ==
1358 server_parse_url (plugin, url, &target, &stc.tag, &options))
1360 LOG (GNUNET_ERROR_TYPE_DEBUG,
1361 "Invalid url %s\n", url);
1364 if (0 == strcmp (MHD_HTTP_METHOD_PUT, method))
1365 direction = _RECEIVE;
1366 else if (0 == strcmp (MHD_HTTP_METHOD_GET, method))
1370 LOG (GNUNET_ERROR_TYPE_DEBUG,
1371 "Invalid method %s connection from %s\n",
1376 plugin->cur_connections++;
1377 LOG (GNUNET_ERROR_TYPE_DEBUG,
1378 "New %s connection from %s with tag %u (%u of %u)\n",
1380 GNUNET_i2s (&target),
1382 plugin->cur_connections, plugin->max_connections);
1383 /* find existing session */
1385 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
1389 if (NULL == (s = stc.res))
1391 /* create new session */
1393 switch (conn_info->client_addr->sa_family)
1396 addr = http_common_address_from_socket (plugin->protocol,
1397 conn_info->client_addr,
1398 sizeof (struct sockaddr_in));
1399 addr_len = http_common_address_get_size (addr);
1400 ats = plugin->env->get_address_type (plugin->env->cls,
1401 conn_info->client_addr,
1402 sizeof (struct sockaddr_in));
1405 addr = http_common_address_from_socket (plugin->protocol,
1406 conn_info->client_addr,
1407 sizeof (struct sockaddr_in6));
1408 addr_len = http_common_address_get_size (addr);
1409 ats = plugin->env->get_address_type (plugin->env->cls,
1410 conn_info->client_addr,
1411 sizeof (struct sockaddr_in6));
1414 /* external host name */
1415 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
1416 ats.type = htonl (GNUNET_ATS_NET_WAN);
1419 s = GNUNET_new (struct Session);
1422 s->address = GNUNET_HELLO_address_allocate (&s->target,
1426 GNUNET_HELLO_ADDRESS_INFO_INBOUND);
1427 s->ats_address_network_type = ats.value;
1428 s->next_receive = GNUNET_TIME_UNIT_ZERO_ABS;
1430 s->timeout = GNUNET_TIME_relative_to_absolute (HTTP_SERVER_SESSION_TIMEOUT);
1431 s->timeout_task = GNUNET_SCHEDULER_add_delayed (HTTP_SERVER_SESSION_TIMEOUT,
1432 &server_session_timeout,
1434 (void) GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
1437 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1438 notify_session_monitor (plugin,
1440 GNUNET_TRANSPORT_SS_HANDSHAKE);
1441 LOG (GNUNET_ERROR_TYPE_DEBUG,
1442 "Creating new session %p for peer `%s' connecting from `%s'\n",
1443 s, GNUNET_i2s (&target),
1444 http_common_plugin_address_to_string (plugin->protocol,
1447 GNUNET_free_non_null (addr);
1450 if ( (_RECEIVE == direction) &&
1451 (NULL != s->server_recv) )
1453 LOG (GNUNET_ERROR_TYPE_DEBUG,
1454 "Duplicate PUT connection from `%s' tag %u, dismissing new connection\n",
1455 GNUNET_i2s (&target),
1459 if ((_SEND == direction) && (NULL != s->server_send))
1461 LOG (GNUNET_ERROR_TYPE_DEBUG,
1462 "Duplicate GET connection from `%s' tag %u, dismissing new connection\n",
1463 GNUNET_i2s (&target),
1467 sc = GNUNET_new (struct ServerConnection);
1468 if (conn_info->client_addr->sa_family == AF_INET)
1469 sc->mhd_daemon = plugin->server_v4;
1470 if (conn_info->client_addr->sa_family == AF_INET6)
1471 sc->mhd_daemon = plugin->server_v6;
1472 sc->mhd_conn = mhd_connection;
1473 sc->direction = direction;
1474 sc->connected = GNUNET_NO;
1476 sc->options = options;
1477 if (direction == _SEND)
1478 s->server_send = sc;
1479 if (direction == _RECEIVE)
1480 s->server_recv = sc;
1482 if ((GNUNET_NO == s->known_to_service) &&
1483 (NULL != s->server_send) &&
1484 (NULL != s->server_recv) )
1486 s->known_to_service = GNUNET_YES;
1487 plugin->env->session_start (NULL, s->address ,s, NULL, 0);
1490 if ( (NULL == s->server_recv) ||
1491 (NULL == s->server_send) )
1493 to = (HTTP_SERVER_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL / 1000LL);
1494 MHD_set_connection_option (mhd_connection,
1495 MHD_CONNECTION_OPTION_TIMEOUT, to);
1496 server_reschedule (plugin, sc->mhd_daemon, GNUNET_NO);
1500 LOG (GNUNET_ERROR_TYPE_DEBUG,
1501 "Session %p for peer `%s' fully connected\n",
1502 s, GNUNET_i2s (&target));
1503 to = (HTTP_SERVER_SESSION_TIMEOUT.rel_value_us / 1000LL / 1000LL);
1504 server_mhd_connection_timeout (plugin, s, to);
1506 LOG (GNUNET_ERROR_TYPE_DEBUG,
1507 "Setting timeout for %p to %u sec.\n", sc, to);
1513 * Callback called by MHD when it needs data to send
1515 * @param cls current session
1516 * @param pos position in buffer
1517 * @param buf the buffer to write data to
1518 * @param max max number of bytes available in @a buf
1519 * @return bytes written to @a buf
1522 server_send_callback (void *cls,
1527 struct Session *s = cls;
1528 struct ServerConnection *sc;
1529 ssize_t bytes_read = 0;
1530 struct HTTP_Message *msg;
1533 sc = s->server_send;
1540 bytes_read = GNUNET_MIN (msg->size - msg->pos,
1542 memcpy (buf, &msg->buf[msg->pos], bytes_read);
1543 msg->pos += bytes_read;
1545 /* removing message */
1546 if (msg->pos == msg->size)
1548 GNUNET_CONTAINER_DLL_remove (s->msg_head,
1551 if (NULL != msg->transmit_cont)
1552 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK,
1553 msg->size, msg->size + msg->overhead);
1554 GNUNET_assert (s->msgs_in_queue > 0);
1556 GNUNET_assert (s->bytes_in_queue >= msg->size);
1557 s->bytes_in_queue -= msg->size;
1559 notify_session_monitor (s->plugin,
1561 GNUNET_TRANSPORT_SS_UP);
1566 sc->connected = GNUNET_YES;
1567 LOG (GNUNET_ERROR_TYPE_DEBUG,
1568 "Sent %u bytes to peer `%s' with session %p \n",
1570 GNUNET_i2s (&s->target),
1572 GNUNET_asprintf (&stat_txt,
1573 "# bytes currently in %s_server buffers",
1574 s->plugin->protocol);
1575 GNUNET_STATISTICS_update (s->plugin->env->stats,
1579 GNUNET_free (stat_txt);
1580 GNUNET_asprintf (&stat_txt,
1581 "# bytes transmitted via %s_server",
1582 s->plugin->protocol);
1583 GNUNET_STATISTICS_update (s->plugin->env->stats,
1584 stat_txt, bytes_read, GNUNET_NO);
1585 GNUNET_free (stat_txt);
1587 else if ((sc->options & OPTION_LONG_POLL) && sc->connected)
1589 LOG (GNUNET_ERROR_TYPE_DEBUG,
1590 "Completing GET response to peer `%s' with session %p\n",
1591 GNUNET_i2s (&s->target),
1593 return MHD_CONTENT_READER_END_OF_STREAM;
1600 * Callback called by MessageStreamTokenizer when a message has arrived
1602 * @param cls current session as closure
1603 * @param client client
1604 * @param message the message to be forwarded to transport service
1605 * @return #GNUNET_OK
1608 server_receive_mst_cb (void *cls,
1610 const struct GNUNET_MessageHeader *message)
1612 struct Session *s = cls;
1613 struct HTTP_Server_Plugin *plugin = s->plugin;
1614 struct GNUNET_ATS_Information atsi;
1615 struct GNUNET_TIME_Relative delay;
1618 atsi.type = htonl (GNUNET_ATS_NETWORK_TYPE);
1619 atsi.value = s->ats_address_network_type;
1620 GNUNET_break (s->ats_address_network_type !=
1621 ntohl (GNUNET_ATS_NET_UNSPECIFIED));
1623 if (GNUNET_NO == s->known_to_service)
1625 s->known_to_service = GNUNET_YES;
1626 plugin->env->session_start (NULL,
1631 notify_session_monitor (plugin,
1633 GNUNET_TRANSPORT_SS_UP);
1635 delay = plugin->env->receive (plugin->env->cls,
1639 plugin->env->update_address_metrics (plugin->env->cls,
1642 GNUNET_asprintf (&stat_txt,
1643 "# bytes received via %s_server",
1645 GNUNET_STATISTICS_update (plugin->env->stats,
1646 stat_txt, ntohs (message->size), GNUNET_NO);
1647 GNUNET_free (stat_txt);
1648 s->next_receive = GNUNET_TIME_relative_to_absolute (delay);
1649 if (delay.rel_value_us > 0)
1651 LOG (GNUNET_ERROR_TYPE_DEBUG,
1652 "Peer `%s' address `%s' next read delayed for %s\n",
1653 GNUNET_i2s (&s->target),
1654 http_common_plugin_address_to_string (plugin->protocol,
1655 s->address->address,
1656 s->address->address_length),
1657 GNUNET_STRINGS_relative_time_to_string (delay,
1660 server_reschedule_session_timeout (s);
1666 * Add headers to a request indicating that we allow Cross-Origin Resource
1669 * @param response response object to modify
1672 add_cors_headers(struct MHD_Response *response)
1674 MHD_add_response_header (response,
1675 "Access-Control-Allow-Origin",
1677 MHD_add_response_header (response,
1678 "Access-Control-Allow-Methods",
1679 "GET, PUT, OPTIONS");
1680 MHD_add_response_header (response,
1681 "Access-Control-Max-Age",
1687 * MHD callback for a new incoming connection
1689 * @param cls the plugin handle
1690 * @param mhd_connection the mhd connection
1691 * @param url the requested URL
1692 * @param method GET or PUT
1693 * @param version HTTP version
1694 * @param upload_data upload data
1695 * @param upload_data_size size of @a upload_data
1696 * @param httpSessionCache the session cache to remember the connection
1697 * @return MHD_YES if connection is accepted, MHD_NO on reject
1700 server_access_cb (void *cls,
1701 struct MHD_Connection *mhd_connection,
1704 const char *version,
1705 const char *upload_data,
1706 size_t *upload_data_size,
1707 void **httpSessionCache)
1709 struct HTTP_Server_Plugin *plugin = cls;
1710 struct ServerConnection *sc = *httpSessionCache;
1712 struct MHD_Response *response;
1715 LOG (GNUNET_ERROR_TYPE_DEBUG,
1716 _("Access from connection %p (%u of %u) for `%s' `%s' url `%s' with upload data size %u\n"),
1718 plugin->cur_connections,
1719 plugin->max_connections,
1723 (*upload_data_size));
1726 /* CORS pre-flight request */
1727 if (0 == strcmp (MHD_HTTP_METHOD_OPTIONS, method))
1729 response = MHD_create_response_from_buffer (0, NULL,
1730 MHD_RESPMEM_PERSISTENT);
1731 add_cors_headers(response);
1732 res = MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1733 MHD_destroy_response (response);
1736 /* new connection */
1737 sc = server_lookup_connection (plugin, mhd_connection, url, method);
1740 /* attach to new / existing session */
1741 (*httpSessionCache) = sc;
1745 /* existing session already has matching connection, refuse */
1746 response = MHD_create_response_from_data (strlen (HTTP_ERROR_RESPONSE),
1747 HTTP_ERROR_RESPONSE,
1750 MHD_add_response_header (response,
1751 MHD_HTTP_HEADER_CONTENT_TYPE,
1753 add_cors_headers(response);
1754 res = MHD_queue_response (mhd_connection, MHD_HTTP_NOT_FOUND, response);
1755 MHD_destroy_response (response);
1759 /* 'old' connection */
1760 if (NULL == (s = sc->session))
1762 /* Session was already disconnected;
1763 sent HTTP/1.1: 200 OK as response */
1764 response = MHD_create_response_from_data (strlen ("Thank you!"),
1767 add_cors_headers(response);
1768 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1769 MHD_destroy_response (response);
1773 if (sc->direction == _SEND)
1775 response = MHD_create_response_from_callback (MHD_SIZE_UNKNOWN,
1777 &server_send_callback, s,
1779 add_cors_headers(response);
1780 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1781 MHD_destroy_response (response);
1784 if (sc->direction == _RECEIVE)
1786 if ((*upload_data_size == 0) && (sc->connected == GNUNET_NO))
1788 /* (*upload_data_size == 0) first callback when header are passed */
1789 LOG (GNUNET_ERROR_TYPE_DEBUG,
1790 "Session %p / Connection %p: Peer `%s' PUT on address `%s' connected\n",
1792 GNUNET_i2s (&s->target),
1793 http_common_plugin_address_to_string (plugin->protocol,
1794 s->address->address,
1795 s->address->address_length));
1796 sc->connected = GNUNET_YES;
1799 else if ((*upload_data_size == 0) && (sc->connected == GNUNET_YES))
1801 /* (*upload_data_size == 0) when upload is complete */
1802 LOG (GNUNET_ERROR_TYPE_DEBUG,
1803 "Session %p / Connection %p: Peer `%s' PUT on address `%s' finished upload\n",
1805 GNUNET_i2s (&s->target),
1806 http_common_plugin_address_to_string (plugin->protocol,
1807 s->address->address,
1808 s->address->address_length));
1809 sc->connected = GNUNET_NO;
1810 /* Sent HTTP/1.1: 200 OK as PUT Response\ */
1811 response = MHD_create_response_from_data (strlen ("Thank you!"),
1814 add_cors_headers(response);
1815 MHD_queue_response (mhd_connection, MHD_HTTP_OK, response);
1816 MHD_destroy_response (response);
1819 else if ((*upload_data_size > 0) && (sc->connected == GNUNET_YES))
1821 struct GNUNET_TIME_Relative delay;
1823 /* (*upload_data_size > 0) for every segment received */
1824 LOG (GNUNET_ERROR_TYPE_DEBUG,
1825 "Session %p / Connection %p: Peer `%s' PUT on address `%s' received %u bytes\n",
1827 GNUNET_i2s (&s->target),
1828 http_common_plugin_address_to_string (plugin->protocol,
1829 s->address->address,
1830 s->address->address_length),
1832 delay = GNUNET_TIME_absolute_get_remaining (s->next_receive);
1833 if (0 == delay.rel_value_us)
1835 LOG (GNUNET_ERROR_TYPE_DEBUG,
1836 "PUT with %u bytes forwarded to MST\n",
1838 if (s->msg_tk == NULL)
1840 s->msg_tk = GNUNET_SERVER_mst_create (&server_receive_mst_cb, s);
1842 GNUNET_SERVER_mst_receive (s->msg_tk, s, upload_data,
1843 *upload_data_size, GNUNET_NO, GNUNET_NO);
1844 server_mhd_connection_timeout (plugin, s,
1845 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value_us / 1000LL / 1000LL);
1846 (*upload_data_size) = 0;
1850 /* delay processing */
1851 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1852 "Session %p / Connection %p: no inbound bandwidth available! Next read was delayed by %s\n",
1854 GNUNET_STRINGS_relative_time_to_string (delay,
1856 GNUNET_assert (s->server_recv->mhd_conn == mhd_connection);
1857 MHD_suspend_connection (s->server_recv->mhd_conn);
1858 if (GNUNET_SCHEDULER_NO_TASK == s->recv_wakeup_task)
1859 s->recv_wakeup_task = GNUNET_SCHEDULER_add_delayed (delay,
1876 * Callback from MHD when a connection disconnects
1878 * @param cls closure with the `struct HTTP_Server_Plugin *`
1879 * @param connection the disconnected MHD connection
1880 * @param httpSessionCache the pointer to distinguish
1883 server_disconnect_cb (void *cls,
1884 struct MHD_Connection *connection,
1885 void **httpSessionCache)
1887 struct HTTP_Server_Plugin *plugin = cls;
1888 struct ServerConnection *sc = *httpSessionCache;
1891 LOG (GNUNET_ERROR_TYPE_DEBUG,
1892 "Disconnect for connection %p\n",
1895 return; /* never really got setup */
1896 if (NULL == (s = sc->session))
1897 return; /* session already dead */
1898 if (sc->direction == _SEND)
1900 LOG (GNUNET_ERROR_TYPE_DEBUG,
1901 "Peer `%s' connection %p, GET on address `%s' disconnected\n",
1902 GNUNET_i2s (&s->target),
1904 http_common_plugin_address_to_string (plugin->protocol,
1905 s->address->address,
1906 s->address->address_length));
1907 s->server_send = NULL;
1909 else if (sc->direction == _RECEIVE)
1911 LOG (GNUNET_ERROR_TYPE_DEBUG,
1912 "Peer `%s' connection %p PUT on address `%s' disconnected\n",
1913 GNUNET_i2s (&s->target),
1915 http_common_plugin_address_to_string (plugin->protocol,
1916 s->address->address,
1917 s->address->address_length));
1918 s->server_recv = NULL;
1919 if (NULL != s->msg_tk)
1921 GNUNET_SERVER_mst_destroy (s->msg_tk);
1926 plugin->cur_connections--;
1931 * Check if incoming connection is accepted.
1933 * @param cls plugin as closure
1934 * @param addr address of incoming connection
1935 * @param addr_len number of bytes in @a addr
1936 * @return MHD_YES if connection is accepted, MHD_NO if connection is rejected
1939 server_accept_cb (void *cls,
1940 const struct sockaddr *addr,
1943 struct HTTP_Server_Plugin *plugin = cls;
1945 if (plugin->cur_connections <= plugin->max_connections)
1947 LOG (GNUNET_ERROR_TYPE_DEBUG,
1948 _("Accepting connection (%u of %u) from `%s'\n"),
1949 plugin->cur_connections, plugin->max_connections,
1950 GNUNET_a2s (addr, addr_len));
1955 LOG (GNUNET_ERROR_TYPE_WARNING,
1956 _("Server reached maximum number connections (%u), rejecting new connection\n"),
1957 plugin->max_connections);
1964 * Log function called by MHD.
1967 * @param fmt format string
1968 * @param ap arguments for the format string (va_start() and va_end()
1969 * will be called by MHD)
1972 server_log (void *arg,
1982 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1990 * Load ssl certificate from file
1992 * @param file filename
1993 * @return content of the file
1996 server_load_file (const char *file)
1998 struct GNUNET_DISK_FileHandle *gn_file;
2002 if (GNUNET_OK != GNUNET_DISK_file_size (file,
2003 &fsize, GNUNET_NO, GNUNET_YES))
2005 text = GNUNET_malloc (fsize + 1);
2007 GNUNET_DISK_file_open (file, GNUNET_DISK_OPEN_READ,
2008 GNUNET_DISK_PERM_USER_READ);
2009 if (NULL == gn_file)
2014 if (GNUNET_SYSERR == GNUNET_DISK_file_read (gn_file, text, fsize))
2017 GNUNET_DISK_file_close (gn_file);
2021 GNUNET_DISK_file_close (gn_file);
2029 * Load ssl certificate
2031 * @param plugin the plugin
2032 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2035 server_load_certificate (struct HTTP_Server_Plugin *plugin)
2037 int res = GNUNET_OK;
2043 GNUNET_CONFIGURATION_get_value_filename (plugin->env->cfg,
2045 "KEY_FILE", &key_file))
2047 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2048 plugin->name, "CERT_FILE");
2049 return GNUNET_SYSERR;
2052 GNUNET_CONFIGURATION_get_value_filename (plugin->env->cfg,
2054 "CERT_FILE", &cert_file))
2056 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2057 plugin->name, "CERT_FILE");
2058 GNUNET_free (key_file);
2059 return GNUNET_SYSERR;
2061 /* Get crypto init string from config. If not present, use
2064 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2067 &plugin->crypto_init))
2068 LOG (GNUNET_ERROR_TYPE_DEBUG,
2069 "Using crypto init string `%s'\n",
2070 plugin->crypto_init);
2072 LOG (GNUNET_ERROR_TYPE_DEBUG,
2073 "Using default crypto init string \n");
2075 /* read key & certificates from file */
2076 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2077 "Trying to loading TLS certificate from key-file `%s' cert-file`%s'\n",
2078 key_file, cert_file);
2080 plugin->key = server_load_file (key_file);
2081 plugin->cert = server_load_file (cert_file);
2083 if ((plugin->key == NULL) || (plugin->cert == NULL))
2085 struct GNUNET_OS_Process *cert_creation;
2087 GNUNET_free_non_null (plugin->key);
2089 GNUNET_free_non_null (plugin->cert);
2090 plugin->cert = NULL;
2092 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2093 "No usable TLS certificate found, creating certificate\n");
2096 GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
2098 "gnunet-transport-certificate-creation",
2099 "gnunet-transport-certificate-creation",
2100 key_file, cert_file, NULL);
2101 if (cert_creation == NULL)
2103 LOG (GNUNET_ERROR_TYPE_ERROR,
2104 _("Could not create a new TLS certificate, program `gnunet-transport-certificate-creation' could not be started!\n"));
2105 GNUNET_free (key_file);
2106 GNUNET_free (cert_file);
2108 GNUNET_free_non_null (plugin->key);
2110 GNUNET_free_non_null (plugin->cert);
2111 plugin->cert = NULL;
2112 GNUNET_free_non_null (plugin->crypto_init);
2113 plugin->crypto_init = NULL;
2115 return GNUNET_SYSERR;
2117 GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (cert_creation));
2118 GNUNET_OS_process_destroy (cert_creation);
2120 plugin->key = server_load_file (key_file);
2121 plugin->cert = server_load_file (cert_file);
2124 if ((plugin->key == NULL) || (plugin->cert == NULL))
2126 LOG (GNUNET_ERROR_TYPE_ERROR,
2127 _("No usable TLS certificate found and creating one at `%s/%s' failed!\n"),
2128 key_file, cert_file);
2129 GNUNET_free (key_file);
2130 GNUNET_free (cert_file);
2132 GNUNET_free_non_null (plugin->key);
2134 GNUNET_free_non_null (plugin->cert);
2135 plugin->cert = NULL;
2136 GNUNET_free_non_null (plugin->crypto_init);
2137 plugin->crypto_init = NULL;
2139 return GNUNET_SYSERR;
2141 GNUNET_free (key_file);
2142 GNUNET_free (cert_file);
2143 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "TLS certificate loaded\n");
2150 * Start the HTTP server
2152 * @param plugin the plugin handle
2153 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2156 server_start (struct HTTP_Server_Plugin *plugin)
2158 unsigned int timeout;
2160 GNUNET_assert (NULL != plugin);
2163 if (GNUNET_SYSERR == server_load_certificate (plugin))
2165 LOG (GNUNET_ERROR_TYPE_ERROR,
2166 "Could not load or create server certificate! Loading plugin failed!\n");
2167 return GNUNET_SYSERR;
2172 #if MHD_VERSION >= 0x00090E00
2173 timeout = HTTP_SERVER_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL / 1000LL;
2174 LOG (GNUNET_ERROR_TYPE_DEBUG,
2175 "MHD can set timeout per connection! Default time out %u sec.\n",
2178 timeout = HTTP_SERVER_SESSION_TIMEOUT.rel_value_us / 1000LL / 1000LL;
2179 LOG (GNUNET_ERROR_TYPE_WARNING,
2180 "MHD cannot set timeout per connection! Default time out %u sec.\n",
2184 plugin->server_v4 = NULL;
2185 if (plugin->use_ipv4 == GNUNET_YES)
2187 plugin->server_v4 = MHD_start_daemon (
2194 MHD_NO_FLAG, plugin->port,
2195 &server_accept_cb, plugin,
2196 &server_access_cb, plugin,
2197 MHD_OPTION_SOCK_ADDR,
2198 (struct sockaddr_in *)
2199 plugin->server_addr_v4,
2200 MHD_OPTION_CONNECTION_LIMIT,
2202 plugin->max_connections,
2204 MHD_OPTION_HTTPS_PRIORITIES,
2205 plugin->crypto_init,
2206 MHD_OPTION_HTTPS_MEM_KEY,
2208 MHD_OPTION_HTTPS_MEM_CERT,
2211 MHD_OPTION_CONNECTION_TIMEOUT,
2213 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
2215 GNUNET_SERVER_MAX_MESSAGE_SIZE),
2216 MHD_OPTION_NOTIFY_COMPLETED,
2217 &server_disconnect_cb, plugin,
2218 MHD_OPTION_EXTERNAL_LOGGER,
2219 server_log, NULL, MHD_OPTION_END);
2220 if (plugin->server_v4 == NULL)
2222 LOG (GNUNET_ERROR_TYPE_ERROR,
2223 "Failed to start %s IPv4 server component on port %u\n",
2224 plugin->name, plugin->port);
2227 server_reschedule (plugin,
2233 plugin->server_v6 = NULL;
2234 if (plugin->use_ipv6 == GNUNET_YES)
2236 plugin->server_v6 = MHD_start_daemon (
2243 MHD_USE_IPv6, plugin->port,
2244 &server_accept_cb, plugin,
2245 &server_access_cb, plugin,
2246 MHD_OPTION_SOCK_ADDR,
2247 (struct sockaddr_in6 *)
2248 plugin->server_addr_v6,
2249 MHD_OPTION_CONNECTION_LIMIT,
2251 plugin->max_connections,
2253 MHD_OPTION_HTTPS_PRIORITIES,
2254 plugin->crypto_init,
2255 MHD_OPTION_HTTPS_MEM_KEY,
2257 MHD_OPTION_HTTPS_MEM_CERT,
2260 MHD_OPTION_CONNECTION_TIMEOUT,
2262 MHD_OPTION_CONNECTION_MEMORY_LIMIT,
2264 GNUNET_SERVER_MAX_MESSAGE_SIZE),
2265 MHD_OPTION_NOTIFY_COMPLETED,
2266 &server_disconnect_cb, plugin,
2267 MHD_OPTION_EXTERNAL_LOGGER,
2268 server_log, NULL, MHD_OPTION_END);
2269 if (plugin->server_v6 == NULL)
2271 LOG (GNUNET_ERROR_TYPE_ERROR,
2272 "Failed to start %s IPv6 server component on port %u\n",
2273 plugin->name, plugin->port);
2276 server_reschedule (plugin, plugin->server_v6, GNUNET_NO);
2280 if ((plugin->server_v6 == NULL) && (plugin->server_v4 == NULL))
2282 LOG (GNUNET_ERROR_TYPE_ERROR,
2283 "%s %s server component started on port %u\n",
2284 msg, plugin->name, plugin->port);
2286 return GNUNET_SYSERR;
2288 else if ((plugin->server_v6 != NULL) && (plugin->server_v4 != NULL))
2289 msg = "IPv4 and IPv6";
2290 else if (plugin->server_v6 != NULL)
2292 else if (plugin->server_v4 != NULL)
2294 LOG (GNUNET_ERROR_TYPE_DEBUG,
2295 "%s %s server component started on port %u\n",
2296 msg, plugin->name, plugin->port);
2302 * Add an address to the server's set of addresses and notify transport
2304 * @param cls the plugin handle
2305 * @param add_remove #GNUNET_YES on add, #GNUNET_NO on remove
2306 * @param addr the address
2307 * @param addrlen address length
2310 server_add_address (void *cls,
2312 const struct sockaddr *addr,
2315 struct HTTP_Server_Plugin *plugin = cls;
2316 struct GNUNET_HELLO_Address *address;
2317 struct HttpAddressWrapper *w = NULL;
2319 w = GNUNET_new (struct HttpAddressWrapper);
2320 w->address = http_common_address_from_socket (plugin->protocol,
2323 if (NULL == w->address)
2328 w->addrlen = http_common_address_get_size (w->address);
2330 GNUNET_CONTAINER_DLL_insert (plugin->addr_head,
2333 LOG (GNUNET_ERROR_TYPE_DEBUG,
2334 "Notifying transport to add address `%s'\n",
2335 http_common_plugin_address_to_string (plugin->protocol,
2338 /* modify our published address list */
2340 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2341 "https_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2343 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2344 "http_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2347 plugin->env->notify_address (plugin->env->cls,
2350 GNUNET_HELLO_address_free (address);
2355 * Remove an address from the server's set of addresses and notify transport
2357 * @param cls the plugin handle
2358 * @param add_remove #GNUNET_YES on add, #GNUNET_NO on remove
2359 * @param addr the address
2360 * @param addrlen address length
2363 server_remove_address (void *cls,
2365 const struct sockaddr *addr,
2368 struct HTTP_Server_Plugin *plugin = cls;
2369 struct GNUNET_HELLO_Address *address;
2370 struct HttpAddressWrapper *w = plugin->addr_head;
2374 saddr = http_common_address_from_socket (plugin->protocol,
2379 saddr_len = http_common_address_get_size (saddr);
2384 http_common_cmp_addresses (w->address,
2391 GNUNET_free (saddr);
2396 LOG (GNUNET_ERROR_TYPE_DEBUG,
2397 "Notifying transport to remove address `%s'\n",
2398 http_common_plugin_address_to_string (plugin->protocol,
2401 GNUNET_CONTAINER_DLL_remove (plugin->addr_head,
2404 /* modify our published address list */
2406 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2407 "https_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2409 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2410 "http_client", w->address, w->addrlen, GNUNET_HELLO_ADDRESS_INFO_NONE);
2412 plugin->env->notify_address (plugin->env->cls, add_remove, address);
2413 GNUNET_HELLO_address_free (address);
2414 GNUNET_free (w->address);
2421 * Our external IP address/port mapping has changed.
2423 * @param cls closure, the 'struct LocalAddrList'
2424 * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
2425 * the previous (now invalid) one
2426 * @param addr either the previous or the new public IP address
2427 * @param addrlen actual lenght of the address
2430 server_nat_port_map_callback (void *cls,
2432 const struct sockaddr *addr,
2435 struct HTTP_Server_Plugin *plugin = cls;
2437 LOG (GNUNET_ERROR_TYPE_DEBUG,
2438 "NAT called to %s address `%s'\n",
2439 (add_remove == GNUNET_NO) ? "remove" : "add",
2440 GNUNET_a2s (addr, addrlen));
2442 if (AF_INET == addr->sa_family)
2444 struct sockaddr_in *s4 = (struct sockaddr_in *) addr;
2446 if (GNUNET_NO == plugin->use_ipv4)
2449 if ((NULL != plugin->server_addr_v4) &&
2450 (0 != memcmp (&plugin->server_addr_v4->sin_addr,
2451 &s4->sin_addr, sizeof (struct in_addr))))
2453 LOG (GNUNET_ERROR_TYPE_DEBUG,
2454 "Skipping address `%s' (not bindto address)\n",
2455 GNUNET_a2s (addr, addrlen));
2460 if (AF_INET6 == addr->sa_family)
2462 struct sockaddr_in6 *s6 = (struct sockaddr_in6 *) addr;
2463 if (GNUNET_NO == plugin->use_ipv6)
2466 if ((NULL != plugin->server_addr_v6) &&
2467 (0 != memcmp (&plugin->server_addr_v6->sin6_addr,
2468 &s6->sin6_addr, sizeof (struct in6_addr))))
2470 LOG (GNUNET_ERROR_TYPE_DEBUG,
2471 "Skipping address `%s' (not bindto address)\n",
2472 GNUNET_a2s (addr, addrlen));
2480 server_add_address (cls, add_remove, addr, addrlen);
2483 server_remove_address (cls, add_remove, addr, addrlen);
2490 * Get valid server addresses
2492 * @param plugin the plugin handle
2493 * @param service_name the servicename
2494 * @param cfg configuration handle
2495 * @param addrs addresses
2496 * @param addr_lens address length
2497 * @return number of addresses
2500 server_get_addresses (struct HTTP_Server_Plugin *plugin,
2501 const char *service_name,
2502 const struct GNUNET_CONFIGURATION_Handle *cfg,
2503 struct sockaddr ***addrs,
2504 socklen_t ** addr_lens)
2507 unsigned long long port;
2508 struct addrinfo hints;
2509 struct addrinfo *res;
2510 struct addrinfo *pos;
2511 struct addrinfo *next;
2515 struct sockaddr **saddrs;
2516 socklen_t *saddrlens;
2522 disablev6 = !plugin->use_ipv6;
2525 if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT"))
2527 GNUNET_break (GNUNET_OK ==
2528 GNUNET_CONFIGURATION_get_value_number (cfg, service_name,
2532 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2533 _("Require valid port number for service in configuration!\n"));
2534 return GNUNET_SYSERR;
2539 LOG (GNUNET_ERROR_TYPE_INFO,
2540 "Starting in listen only mode\n");
2541 return -1; /* listen only */
2545 if (GNUNET_CONFIGURATION_have_value (cfg, service_name,
2548 GNUNET_break (GNUNET_OK ==
2549 GNUNET_CONFIGURATION_get_value_string (cfg, service_name,
2550 "BINDTO", &hostname));
2555 if (NULL != hostname)
2557 LOG (GNUNET_ERROR_TYPE_DEBUG,
2558 "Resolving `%s' since that is where `%s' will bind to.\n",
2559 hostname, service_name);
2560 memset (&hints, 0, sizeof (struct addrinfo));
2562 hints.ai_family = AF_INET;
2563 if ((0 != (ret = getaddrinfo (hostname, NULL, &hints, &res))) ||
2566 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2567 _("Failed to resolve `%s': %s\n"),
2569 gai_strerror (ret));
2570 GNUNET_free (hostname);
2571 return GNUNET_SYSERR;
2575 while (NULL != (pos = next))
2577 next = pos->ai_next;
2578 if ((disablev6) && (pos->ai_family == AF_INET6))
2584 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2585 _("Failed to find %saddress for `%s'.\n"),
2586 disablev6 ? "IPv4 " : "", hostname);
2588 GNUNET_free (hostname);
2589 return GNUNET_SYSERR;
2592 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2593 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2596 while (NULL != (pos = next))
2598 next = pos->ai_next;
2599 if ((disablev6) && (pos->ai_family == AF_INET6))
2601 if ((pos->ai_protocol != IPPROTO_TCP) && (0 != pos->ai_protocol))
2602 continue; /* not TCP */
2603 if ((pos->ai_socktype != SOCK_STREAM) && (0 != pos->ai_socktype))
2604 continue; /* huh? */
2605 LOG (GNUNET_ERROR_TYPE_DEBUG,
2606 "Service will bind to `%s'\n",
2607 GNUNET_a2s (pos->ai_addr,
2609 if (pos->ai_family == AF_INET)
2611 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
2612 saddrlens[i] = pos->ai_addrlen;
2613 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2614 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
2615 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2619 GNUNET_assert (pos->ai_family == AF_INET6);
2620 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
2621 saddrlens[i] = pos->ai_addrlen;
2622 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2623 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
2624 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
2628 GNUNET_free (hostname);
2634 /* will bind against everything, just set port */
2640 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2641 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2643 saddrlens[i] = sizeof (struct sockaddr_in);
2644 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2645 #if HAVE_SOCKADDR_IN_SIN_LEN
2646 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
2648 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
2649 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2655 saddrs = GNUNET_malloc ((resi + 1) * sizeof (struct sockaddr *));
2656 saddrlens = GNUNET_malloc ((resi + 1) * sizeof (socklen_t));
2658 saddrlens[i] = sizeof (struct sockaddr_in6);
2659 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2660 #if HAVE_SOCKADDR_IN_SIN_LEN
2661 ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
2663 ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
2664 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
2666 saddrlens[i] = sizeof (struct sockaddr_in);
2667 saddrs[i] = GNUNET_malloc (saddrlens[i]);
2668 #if HAVE_SOCKADDR_IN_SIN_LEN
2669 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
2671 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
2672 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
2676 *addr_lens = saddrlens;
2682 * Ask NAT for addresses
2684 * @param plugin the plugin handle
2687 server_start_report_addresses (struct HTTP_Server_Plugin *plugin)
2689 int res = GNUNET_OK;
2690 struct sockaddr **addrs;
2691 socklen_t *addrlens;
2693 res = server_get_addresses (plugin,
2697 LOG (GNUNET_ERROR_TYPE_DEBUG,
2698 _("Found %u addresses to report to NAT service\n"),
2701 if (GNUNET_SYSERR == res)
2708 GNUNET_NAT_register (plugin->env->cfg,
2712 (const struct sockaddr **) addrs, addrlens,
2713 &server_nat_port_map_callback, NULL, plugin);
2717 GNUNET_assert (NULL != addrs[res]);
2718 GNUNET_free (addrs[res]);
2720 GNUNET_free_non_null (addrs);
2721 GNUNET_free_non_null (addrlens);
2726 * Stop NAT for addresses
2728 * @param plugin the plugin handle
2731 server_stop_report_addresses (struct HTTP_Server_Plugin *plugin)
2733 struct HttpAddressWrapper *w;
2735 /* Stop NAT handle */
2736 if (NULL != plugin->nat)
2738 GNUNET_NAT_unregister (plugin->nat);
2741 /* Clean up addresses */
2742 while (NULL != plugin->addr_head)
2744 w = plugin->addr_head;
2745 GNUNET_CONTAINER_DLL_remove (plugin->addr_head,
2748 GNUNET_free (w->address);
2755 * Check if IPv6 supported on this system
2757 * @param plugin the plugin handle
2758 * @return #GNUNET_YES on success, else #GNUNET_NO
2761 server_check_ipv6_support (struct HTTP_Server_Plugin *plugin)
2763 struct GNUNET_NETWORK_Handle *desc = NULL;
2764 int res = GNUNET_NO;
2766 /* Probe IPv6 support */
2767 desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
2770 if ((errno == ENOBUFS) || (errno == ENOMEM) || (errno == ENFILE) ||
2773 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
2775 LOG (GNUNET_ERROR_TYPE_WARNING,
2776 _("Disabling IPv6 since it is not supported on this system!\n"));
2781 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
2785 LOG (GNUNET_ERROR_TYPE_DEBUG,
2786 "Testing IPv6 on this system: %s\n",
2787 (res == GNUNET_YES) ? "successful" : "failed");
2793 * Notify server about our external hostname
2796 * @param tc task context (unused)
2799 server_notify_external_hostname (void *cls,
2800 const struct GNUNET_SCHEDULER_TaskContext *tc)
2802 struct HTTP_Server_Plugin *plugin = cls;
2803 struct HttpAddress *ext_addr;
2804 size_t ext_addr_len;
2808 plugin->notify_ext_task = GNUNET_SCHEDULER_NO_TASK;
2809 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
2812 GNUNET_asprintf(&url,
2815 plugin->external_hostname);
2817 urlen = strlen (url) + 1;
2818 ext_addr = GNUNET_malloc (sizeof (struct HttpAddress) + urlen);
2819 ext_addr->options = htonl(plugin->options);
2820 ext_addr->urlen = htonl (urlen);
2821 ext_addr_len = sizeof (struct HttpAddress) + urlen;
2822 memcpy (&ext_addr[1], url, urlen);
2825 LOG (GNUNET_ERROR_TYPE_DEBUG,
2826 "Notifying transport about external hostname address `%s'\n",
2827 plugin->external_hostname);
2830 if (GNUNET_YES == plugin->verify_external_hostname)
2831 LOG (GNUNET_ERROR_TYPE_INFO,
2832 "Enabling SSL verification for external hostname address `%s'\n",
2833 plugin->external_hostname);
2834 plugin->ext_addr = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2835 "https_client", ext_addr, ext_addr_len, GNUNET_HELLO_ADDRESS_INFO_NONE );
2836 plugin->env->notify_address (plugin->env->cls, GNUNET_YES, plugin->ext_addr);
2837 GNUNET_free (ext_addr);
2839 plugin->ext_addr = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
2840 "http_client", ext_addr, ext_addr_len, GNUNET_HELLO_ADDRESS_INFO_NONE );
2841 plugin->env->notify_address (plugin->env->cls, GNUNET_YES, plugin->ext_addr);
2842 GNUNET_free (ext_addr);
2848 * Configure the plugin
2850 * @param plugin plugin handle
2851 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2854 server_configure_plugin (struct HTTP_Server_Plugin *plugin)
2856 unsigned long long port;
2857 unsigned long long max_connections;
2858 char *bind4_address = NULL;
2859 char *bind6_address = NULL;
2860 char *eh_tmp = NULL;
2861 int external_hostname_use_port;
2864 if (GNUNET_CONFIGURATION_have_value
2865 (plugin->env->cfg, plugin->name, "USE_IPv4"))
2868 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2873 plugin->use_ipv4 = GNUNET_YES;
2874 LOG (GNUNET_ERROR_TYPE_DEBUG,
2875 _("IPv4 support is %s\n"),
2876 (plugin->use_ipv4 == GNUNET_YES) ? "enabled" : "disabled");
2879 if (GNUNET_CONFIGURATION_have_value
2880 (plugin->env->cfg, plugin->name, "USE_IPv6"))
2883 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2888 plugin->use_ipv6 = GNUNET_YES;
2889 LOG (GNUNET_ERROR_TYPE_DEBUG,
2890 _("IPv6 support is %s\n"),
2891 (plugin->use_ipv6 == GNUNET_YES) ? "enabled" : "disabled");
2893 if ((plugin->use_ipv4 == GNUNET_NO) && (plugin->use_ipv6 == GNUNET_NO))
2895 LOG (GNUNET_ERROR_TYPE_ERROR,
2896 _("Neither IPv4 nor IPv6 are enabled! Fix in configuration\n"));
2897 return GNUNET_SYSERR;
2900 /* Reading port number from config file */
2902 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
2904 "PORT", &port)) || (port > 65535))
2906 LOG (GNUNET_ERROR_TYPE_ERROR,
2907 _("Port is required! Fix in configuration\n"));
2908 return GNUNET_SYSERR;
2910 plugin->port = port;
2912 LOG (GNUNET_ERROR_TYPE_INFO,
2913 _("Using port %u\n"), plugin->port);
2915 if ((plugin->use_ipv4 == GNUNET_YES) &&
2916 (GNUNET_YES == GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2917 plugin->name, "BINDTO", &bind4_address)))
2919 LOG (GNUNET_ERROR_TYPE_DEBUG,
2920 "Binding %s plugin to specific IPv4 address: `%s'\n",
2921 plugin->protocol, bind4_address);
2922 plugin->server_addr_v4 = GNUNET_new (struct sockaddr_in);
2923 if (1 != inet_pton (AF_INET, bind4_address,
2924 &plugin->server_addr_v4->sin_addr))
2926 LOG (GNUNET_ERROR_TYPE_ERROR,
2927 _("Specific IPv4 address `%s' in configuration file is invalid!\n"),
2929 GNUNET_free (bind4_address);
2930 GNUNET_free (plugin->server_addr_v4);
2931 plugin->server_addr_v4 = NULL;
2932 return GNUNET_SYSERR;
2936 LOG (GNUNET_ERROR_TYPE_DEBUG,
2937 _("Binding to IPv4 address %s\n"),
2939 plugin->server_addr_v4->sin_family = AF_INET;
2940 plugin->server_addr_v4->sin_port = htons (plugin->port);
2942 GNUNET_free (bind4_address);
2945 if ((plugin->use_ipv6 == GNUNET_YES) &&
2947 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2949 "BINDTO6", &bind6_address)))
2951 LOG (GNUNET_ERROR_TYPE_DEBUG,
2952 "Binding %s plugin to specific IPv6 address: `%s'\n",
2953 plugin->protocol, bind6_address);
2954 plugin->server_addr_v6 = GNUNET_new (struct sockaddr_in6);
2956 inet_pton (AF_INET6, bind6_address, &plugin->server_addr_v6->sin6_addr))
2958 LOG (GNUNET_ERROR_TYPE_ERROR,
2959 _("Specific IPv6 address `%s' in configuration file is invalid!\n"),
2961 GNUNET_free (bind6_address);
2962 GNUNET_free (plugin->server_addr_v6);
2963 plugin->server_addr_v6 = NULL;
2964 return GNUNET_SYSERR;
2968 LOG (GNUNET_ERROR_TYPE_DEBUG,
2969 _("Binding to IPv6 address %s\n"),
2971 plugin->server_addr_v6->sin6_family = AF_INET6;
2972 plugin->server_addr_v6->sin6_port = htons (plugin->port);
2974 GNUNET_free (bind6_address);
2977 plugin->verify_external_hostname = GNUNET_NO;
2979 plugin->verify_external_hostname = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2981 "VERIFY_EXTERNAL_HOSTNAME");
2982 if (GNUNET_SYSERR == plugin->verify_external_hostname)
2983 plugin->verify_external_hostname = GNUNET_NO;
2984 if (GNUNET_YES == plugin->verify_external_hostname)
2985 plugin->options |= HTTP_OPTIONS_VERIFY_CERTIFICATE;
2987 external_hostname_use_port = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2989 "EXTERNAL_HOSTNAME_USE_PORT");
2990 if (GNUNET_SYSERR == external_hostname_use_port)
2991 external_hostname_use_port = GNUNET_NO;
2995 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2997 "EXTERNAL_HOSTNAME",
3002 char *pos_url = NULL;
3004 if (NULL != strstr(eh_tmp, "://"))
3005 tmp = &strstr(eh_tmp, "://")[3];
3009 if (GNUNET_YES == external_hostname_use_port)
3011 if ( (strlen (tmp) > 1) && (NULL != (pos = strchr(tmp, '/'))) )
3015 GNUNET_asprintf (&plugin->external_hostname,
3019 (NULL == pos_url) ? "" : pos_url);
3022 GNUNET_asprintf (&plugin->external_hostname,
3028 plugin->external_hostname = GNUNET_strdup (tmp);
3029 GNUNET_free (eh_tmp);
3031 LOG (GNUNET_ERROR_TYPE_INFO,
3032 _("Using external hostname `%s'\n"),
3033 plugin->external_hostname);
3034 plugin->notify_ext_task = GNUNET_SCHEDULER_add_now (&server_notify_external_hostname,
3037 /* Use only configured external hostname */
3038 if (GNUNET_CONFIGURATION_have_value
3041 "EXTERNAL_HOSTNAME_ONLY"))
3043 plugin->external_only =
3044 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
3046 "EXTERNAL_HOSTNAME_ONLY");
3049 plugin->external_only = GNUNET_NO;
3051 if (GNUNET_YES == plugin->external_only)
3052 LOG (GNUNET_ERROR_TYPE_DEBUG,
3053 _("Notifying transport only about hostname `%s'\n"),
3054 plugin->external_hostname);
3057 LOG (GNUNET_ERROR_TYPE_DEBUG,
3058 "No external hostname configured\n");
3060 /* Optional parameters */
3062 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
3066 max_connections = 128;
3067 plugin->max_connections = max_connections;
3069 LOG (GNUNET_ERROR_TYPE_DEBUG,
3070 _("Maximum number of connections is %u\n"),
3071 plugin->max_connections);
3073 plugin->peer_id_length = strlen (GNUNET_i2s_full (plugin->env->my_identity));
3080 * Exit point from the plugin.
3086 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
3088 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
3089 struct HTTP_Server_Plugin *plugin = api->cls;
3091 if (NULL == api->cls)
3093 /* Free for stub mode */
3097 plugin->in_shutdown = GNUNET_YES;
3098 LOG (GNUNET_ERROR_TYPE_DEBUG,
3099 _("Shutting down plugin `%s'\n"),
3102 if (GNUNET_SCHEDULER_NO_TASK != plugin->notify_ext_task)
3104 GNUNET_SCHEDULER_cancel (plugin->notify_ext_task);
3105 plugin->notify_ext_task = GNUNET_SCHEDULER_NO_TASK;
3108 if (NULL != plugin->ext_addr)
3110 LOG (GNUNET_ERROR_TYPE_DEBUG,
3111 "Notifying transport to remove address `%s'\n",
3112 http_common_plugin_address_to_string (plugin->protocol,
3113 plugin->ext_addr->address,
3114 plugin->ext_addr->address_length));
3116 plugin->env->notify_address (plugin->env->cls,
3120 plugin->env->notify_address (plugin->env->cls,
3124 GNUNET_HELLO_address_free (plugin->ext_addr);
3125 plugin->ext_addr = NULL;
3128 /* Stop to report addresses to transport service */
3129 server_stop_report_addresses (plugin);
3130 if (NULL != plugin->server_v4)
3132 MHD_stop_daemon (plugin->server_v4);
3133 plugin->server_v4 = NULL;
3135 if (NULL != plugin->server_v6)
3137 MHD_stop_daemon (plugin->server_v6);
3138 plugin->server_v6 = NULL;
3140 if (GNUNET_SCHEDULER_NO_TASK != plugin->server_v4_task)
3142 GNUNET_SCHEDULER_cancel (plugin->server_v4_task);
3143 plugin->server_v4_task = GNUNET_SCHEDULER_NO_TASK;
3146 if (GNUNET_SCHEDULER_NO_TASK != plugin->server_v6_task)
3148 GNUNET_SCHEDULER_cancel (plugin->server_v6_task);
3149 plugin->server_v6_task = GNUNET_SCHEDULER_NO_TASK;
3152 GNUNET_free_non_null (plugin->crypto_init);
3153 GNUNET_free_non_null (plugin->cert);
3154 GNUNET_free_non_null (plugin->key);
3156 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
3157 &destroy_session_cb,
3159 GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
3160 plugin->sessions = NULL;
3162 GNUNET_free_non_null (plugin->external_hostname);
3163 GNUNET_free_non_null (plugin->ext_addr);
3164 GNUNET_free_non_null (plugin->server_addr_v4);
3165 GNUNET_free_non_null (plugin->server_addr_v6);
3166 regfree (&plugin->url_regex);
3168 LOG (GNUNET_ERROR_TYPE_DEBUG,
3169 _("Shutdown for plugin `%s' complete\n"),
3172 GNUNET_free (plugin);
3179 * Function called by the pretty printer for the resolved address for
3180 * each human-readable address obtained. The callback can be called
3181 * several times. The last invocation must be with a @a address of
3182 * NULL and a @a res of #GNUNET_OK. Thus, to indicate conversion
3183 * errors, the callback might be called first with @a address NULL and
3184 * @a res being #GNUNET_SYSERR. In that case, there must still be a
3185 * subsequent call later with @a address NULL and @a res #GNUNET_OK.
3187 * @param cls closure
3188 * @param address one of the names for the host, NULL on last callback
3189 * @param res #GNUNET_OK if conversion was successful, #GNUNET_SYSERR on failure,
3190 * #GNUNET_OK on last callback
3193 http_server_plugin_address_to_string (void *cls,
3197 return http_common_plugin_address_to_string (PLUGIN_NAME,
3204 * Function obtain the network type for a session
3206 * @param cls closure ('struct HTTP_Server_Plugin*')
3207 * @param session the session
3208 * @return the network type in HBO or #GNUNET_SYSERR
3210 static enum GNUNET_ATS_Network_Type
3211 http_server_plugin_get_network (void *cls,
3212 struct Session *session)
3214 return ntohl (session->ats_address_network_type);
3219 * Function that will be called whenever the transport service wants to
3220 * notify the plugin that the inbound quota changed and that the plugin
3221 * should update it's delay for the next receive value
3223 * @param cls closure
3224 * @param peer which peer was the session for
3225 * @param session which session is being updated
3226 * @param delay new delay to use for receiving
3229 http_server_plugin_update_inbound_delay (void *cls,
3230 const struct GNUNET_PeerIdentity *peer,
3232 struct GNUNET_TIME_Relative delay)
3234 s->next_receive = GNUNET_TIME_relative_to_absolute (delay);
3235 LOG (GNUNET_ERROR_TYPE_DEBUG,
3236 "New inbound delay %s\n",
3237 GNUNET_STRINGS_relative_time_to_string (delay,
3239 if (GNUNET_SCHEDULER_NO_TASK != s->recv_wakeup_task)
3241 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
3243 = GNUNET_SCHEDULER_add_delayed (delay,
3251 * Return information about the given session to the
3254 * @param cls the `struct Plugin` with the monitor callback (`sic`)
3255 * @param peer peer we send information about
3256 * @param value our `struct Session` to send information about
3257 * @return #GNUNET_OK (continue to iterate)
3260 send_session_info_iter (void *cls,
3261 const struct GNUNET_PeerIdentity *peer,
3264 struct HTTP_Server_Plugin *plugin = cls;
3265 struct Session *session = value;
3267 notify_session_monitor (plugin,
3269 GNUNET_TRANSPORT_SS_UP);
3275 * Begin monitoring sessions of a plugin. There can only
3276 * be one active monitor per plugin (i.e. if there are
3277 * multiple monitors, the transport service needs to
3278 * multiplex the generated events over all of them).
3280 * @param cls closure of the plugin
3281 * @param sic callback to invoke, NULL to disable monitor;
3282 * plugin will being by iterating over all active
3283 * sessions immediately and then enter monitor mode
3284 * @param sic_cls closure for @a sic
3287 http_server_plugin_setup_monitor (void *cls,
3288 GNUNET_TRANSPORT_SessionInfoCallback sic,
3291 struct HTTP_Server_Plugin *plugin = cls;
3294 plugin->sic_cls = sic_cls;
3297 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
3298 &send_session_info_iter,
3300 /* signal end of first iteration */
3301 sic (sic_cls, NULL, NULL);
3307 * Entry point for the plugin.
3313 LIBGNUNET_PLUGIN_TRANSPORT_INIT (void *cls)
3315 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
3316 struct GNUNET_TRANSPORT_PluginFunctions *api;
3317 struct HTTP_Server_Plugin *plugin;
3319 if (NULL == env->receive)
3321 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
3322 initialze the plugin or the API */
3323 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3325 api->address_to_string = &http_server_plugin_address_to_string;
3326 api->string_to_address = &http_common_plugin_string_to_address;
3327 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
3330 plugin = GNUNET_new (struct HTTP_Server_Plugin);
3332 plugin->sessions = GNUNET_CONTAINER_multipeermap_create (128,
3334 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
3336 api->send = &http_server_plugin_send;
3337 api->disconnect_peer = &http_server_plugin_disconnect_peer;
3338 api->disconnect_session = &http_server_plugin_disconnect_session;
3339 api->query_keepalive_factor = &http_server_query_keepalive_factor;
3340 api->check_address = &http_server_plugin_address_suggested;
3341 api->get_session = &http_server_plugin_get_session;
3343 api->address_to_string = &http_server_plugin_address_to_string;
3344 api->string_to_address = &http_common_plugin_string_to_address;
3345 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
3346 api->get_network = &http_server_plugin_get_network;
3347 api->update_session_timeout = &http_server_plugin_update_session_timeout;
3348 api->update_inbound_delay = &http_server_plugin_update_inbound_delay;
3349 api->setup_monitor = &http_server_plugin_setup_monitor;
3351 plugin->name = "transport-https_server";
3352 plugin->protocol = "https";
3354 plugin->name = "transport-http_server";
3355 plugin->protocol = "http";
3358 /* Compile URL regex */
3359 if (regcomp(&plugin->url_regex,
3363 LOG (GNUNET_ERROR_TYPE_ERROR,
3364 _("Unable to compile URL regex\n"));
3365 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3369 /* Configure plugin */
3370 if (GNUNET_SYSERR == server_configure_plugin (plugin))
3372 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3376 /* Check IPv6 support */
3377 if (GNUNET_YES == plugin->use_ipv6)
3378 plugin->use_ipv6 = server_check_ipv6_support (plugin);
3380 /* Report addresses to transport service */
3381 if (GNUNET_NO == plugin->external_only)
3382 server_start_report_addresses (plugin);
3384 if (GNUNET_SYSERR == server_start (plugin))
3386 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
3392 /* end of plugin_transport_http_server.c */