2 This file is part of GNUnet
3 Copyright (C) 2002--2014 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
21 * @file transport/plugin_transport_tcp.c
22 * @brief Implementation of the TCP transport service
23 * @author Christian Grothoff
26 #include "gnunet_hello_lib.h"
27 #include "gnunet_constants.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet_nat_lib.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_resolver_service.h"
32 #include "gnunet_signatures.h"
33 #include "gnunet_statistics_service.h"
34 #include "gnunet_transport_service.h"
35 #include "gnunet_transport_plugin.h"
36 #include "transport.h"
38 #define LOG(kind,...) GNUNET_log_from (kind, "transport-tcp",__VA_ARGS__)
40 #define PLUGIN_NAME "tcp"
43 * How long until we give up on establishing an NAT connection?
46 #define NAT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
48 GNUNET_NETWORK_STRUCT_BEGIN
52 * Initial handshake message for a session.
57 * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME.
59 struct GNUNET_MessageHeader header;
62 * Identity of the node connecting (TCP client)
64 struct GNUNET_PeerIdentity clientIdentity;
69 * Basically a WELCOME message, but with the purpose
70 * of giving the waiting peer a client handle to use
72 struct TCP_NAT_ProbeMessage
75 * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE.
77 struct GNUNET_MessageHeader header;
80 * Identity of the sender of the message.
82 struct GNUNET_PeerIdentity clientIdentity;
85 GNUNET_NETWORK_STRUCT_END
88 * Context for sending a NAT probe via TCP.
90 struct TCPProbeContext
94 * Active probes are kept in a DLL.
96 struct TCPProbeContext *next;
99 * Active probes are kept in a DLL.
101 struct TCPProbeContext *prev;
106 struct GNUNET_CONNECTION_Handle *sock;
109 * Message to be sent.
111 struct TCP_NAT_ProbeMessage message;
114 * Handle to the transmission.
116 struct GNUNET_CONNECTION_TransmitHandle *transmit_handle;
119 * Transport plugin handle.
121 struct Plugin *plugin;
125 * Bits in the `options` field of TCP addresses.
127 enum TcpAddressOptions
133 TCP_OPTIONS_NONE = 0,
136 * See #HTTP_OPTIONS_VERIFY_CERTIFICATE.
138 TCP_OPTIONS_RESERVED = 1,
141 * Enable TCP Stealth-style port knocking.
143 TCP_OPTIONS_TCP_STEALTH = 2
146 GNUNET_NETWORK_STRUCT_BEGIN
149 * Network format for IPv4 addresses.
151 struct IPv4TcpAddress
154 * Optional options and flags for this address,
155 * see `enum TcpAddressOptions`
160 * IPv4 address, in network byte order.
162 uint32_t ipv4_addr GNUNET_PACKED;
165 * Port number, in network byte order.
167 uint16_t t4_port GNUNET_PACKED;
172 * Network format for IPv6 addresses.
174 struct IPv6TcpAddress
177 * Optional flags for this address
178 * see `enum TcpAddressOptions`
185 struct in6_addr ipv6_addr GNUNET_PACKED;
188 * Port number, in network byte order.
190 uint16_t t6_port GNUNET_PACKED;
193 GNUNET_NETWORK_STRUCT_END
196 * Encapsulation of all of the state of the plugin.
201 * Information kept for each message that is yet to
204 struct PendingMessage
208 * This is a doubly-linked list.
210 struct PendingMessage *next;
213 * This is a doubly-linked list.
215 struct PendingMessage *prev;
218 * The pending message
223 * Continuation function to call once the message
224 * has been sent. Can be NULL if there is no
225 * continuation to call.
227 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
230 * Closure for transmit_cont.
232 void *transmit_cont_cls;
235 * Timeout value for the pending message.
237 struct GNUNET_TIME_Absolute timeout;
240 * So that the gnunet-service-transport can group messages together,
241 * these pending messages need to accept a message buffer and size
242 * instead of just a GNUNET_MessageHeader.
249 * Session handle for TCP connections.
254 * To whom are we talking to (set to our identity
255 * if we are still waiting for the welcome message)
257 struct GNUNET_PeerIdentity target;
260 * Pointer to the global plugin struct.
262 struct Plugin *plugin;
265 * The client (used to identify this connection)
267 struct GNUNET_SERVER_Client *client;
270 * Task cleaning up a NAT client connection establishment attempt;
272 struct GNUNET_SCHEDULER_Task * nat_connection_timeout;
275 * Messages currently pending for transmission
276 * to this peer, if any.
278 struct PendingMessage *pending_messages_head;
281 * Messages currently pending for transmission
282 * to this peer, if any.
284 struct PendingMessage *pending_messages_tail;
287 * Handle for pending transmission request.
289 struct GNUNET_SERVER_TransmitHandle *transmit_handle;
292 * Address of the other peer.
294 struct GNUNET_HELLO_Address *address;
297 * ID of task used to delay receiving more to throttle sender.
299 struct GNUNET_SCHEDULER_Task * receive_delay_task;
302 * Session timeout task
304 struct GNUNET_SCHEDULER_Task * timeout_task;
307 * When will this session time out?
309 struct GNUNET_TIME_Absolute timeout;
312 * When will we continue to read from the socket?
313 * (used to enforce inbound quota).
315 struct GNUNET_TIME_Absolute receive_delay;
318 * Last activity on this connection. Used to select preferred
321 struct GNUNET_TIME_Absolute last_activity;
324 * Number of bytes waiting for transmission to this peer.
326 unsigned long long bytes_in_queue;
329 * Number of messages waiting for transmission to this peer.
331 unsigned int msgs_in_queue;
334 * Are we still expecting the welcome message? (#GNUNET_YES/#GNUNET_NO)
336 int expecting_welcome;
339 * Was this session created using NAT traversal?
344 * ATS network type in NBO
346 enum GNUNET_ATS_Network_Type ats_address_network_type;
350 * Encapsulation of all of the state of the plugin.
357 struct GNUNET_TRANSPORT_PluginEnvironment *env;
362 struct GNUNET_CONNECTION_Handle *lsock;
365 * Our handle to the NAT module.
367 struct GNUNET_NAT_Handle *nat;
370 * Map from peer identities to sessions for the given peer.
372 struct GNUNET_CONTAINER_MultiPeerMap *sessionmap;
375 * Handle to the network service.
377 struct GNUNET_SERVICE_Context *service;
380 * Handle to the server for this service.
382 struct GNUNET_SERVER_Handle *server;
385 * Copy of the handler array where the closures are
386 * set to this struct's instance.
388 struct GNUNET_SERVER_MessageHandler *handlers;
391 * Map of peers we have tried to contact behind a NAT
393 struct GNUNET_CONTAINER_MultiPeerMap *nat_wait_conns;
396 * List of active TCP probes.
398 struct TCPProbeContext *probe_head;
401 * List of active TCP probes.
403 struct TCPProbeContext *probe_tail;
406 * Handle for (DYN)DNS lookup of our external IP.
408 struct GNUNET_RESOLVER_RequestHandle *ext_dns;
411 * Function to call about session status changes.
413 GNUNET_TRANSPORT_SessionInfoCallback sic;
416 * Closure for @e sic.
421 * Welcome message used by this peer.
423 struct WelcomeMessage my_welcome;
426 * How many more TCP sessions are we allowed to open right now?
428 unsigned long long max_connections;
431 * How many more TCP sessions do we have right now?
433 unsigned long long cur_connections;
436 * ID of task used to update our addresses when one expires.
438 struct GNUNET_SCHEDULER_Task * address_update_task;
446 * Port that we are actually listening on.
451 * Port that the user said we would have visible to the
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 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 = (0 != (GNUNET_HELLO_ADDRESS_INFO_INBOUND & session->address->local_info))
481 info.num_msg_pending = session->msgs_in_queue;
482 info.num_bytes_pending = session->bytes_in_queue;
483 if (NULL != session->receive_delay_task)
484 info.receive_delay = session->receive_delay;
485 info.session_timeout = session->timeout;
486 info.address = session->address;
487 plugin->sic (plugin->sic_cls,
494 * Function called for a quick conversion of the binary address to
495 * a numeric address. Note that the caller must not free the
496 * address and that the next call to this function is allowed
497 * to override the address again.
499 * @param cls closure (`struct Plugin *`)
500 * @param addr binary address
501 * @param addrlen length of @a addr
502 * @return string representing the same address
505 tcp_plugin_address_to_string (void *cls,
511 * Function to check if an inbound connection is acceptable.
512 * Mostly used to limit the total number of open connections
515 * @param cls the `struct Plugin`
516 * @param ucred credentials, if available, otherwise NULL
517 * @param addr address
518 * @param addrlen length of @a addr
519 * @return #GNUNET_YES to allow, #GNUNET_NO to deny, #GNUNET_SYSERR
520 * for unknown address family (will be denied).
523 plugin_tcp_access_check (void *cls,
524 const struct GNUNET_CONNECTION_Credentials *ucred,
525 const struct sockaddr *addr,
528 struct Plugin *plugin = cls;
530 LOG (GNUNET_ERROR_TYPE_DEBUG,
531 "Accepting new incoming TCP connection from `%s'\n",
532 GNUNET_a2s (addr, addrlen));
533 if (plugin->cur_connections >= plugin->max_connections)
535 plugin->cur_connections++;
541 * Our external IP address/port mapping has changed.
543 * @param cls closure, the `struct Plugin`
544 * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
545 * the previous (now invalid) one
546 * @param addr either the previous or the new public IP address
547 * @param addrlen actual length of @a addr
550 tcp_nat_port_map_callback (void *cls,
552 const struct sockaddr *addr,
555 struct Plugin *plugin = cls;
556 struct GNUNET_HELLO_Address *address;
557 struct IPv4TcpAddress t4;
558 struct IPv6TcpAddress t6;
562 LOG(GNUNET_ERROR_TYPE_INFO,
563 "NAT notification to %s address `%s'\n",
564 (GNUNET_YES == add_remove) ? "add" : "remove",
565 GNUNET_a2s (addr, addrlen));
566 /* convert 'addr' to our internal format */
567 switch (addr->sa_family)
570 GNUNET_assert(addrlen == sizeof(struct sockaddr_in));
571 memset (&t4, 0, sizeof(t4));
572 t4.options = htonl (plugin->myoptions);
573 t4.ipv4_addr = ((struct sockaddr_in *) addr)->sin_addr.s_addr;
574 t4.t4_port = ((struct sockaddr_in *) addr)->sin_port;
579 GNUNET_assert(addrlen == sizeof(struct sockaddr_in6));
580 memset (&t6, 0, sizeof(t6));
581 memcpy (&t6.ipv6_addr, &((struct sockaddr_in6 *) addr)->sin6_addr,
582 sizeof(struct in6_addr));
583 t6.options = htonl (plugin->myoptions);
584 t6.t6_port = ((struct sockaddr_in6 *) addr)->sin6_port;
592 /* modify our published address list */
593 GNUNET_assert ((args == sizeof (struct IPv4TcpAddress)) ||
594 (args == sizeof (struct IPv6TcpAddress)));
595 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
596 PLUGIN_NAME, arg, args, GNUNET_HELLO_ADDRESS_INFO_NONE);
597 plugin->env->notify_address (plugin->env->cls, add_remove, address);
598 GNUNET_HELLO_address_free(address);
603 * Function called for a quick conversion of the binary address to
604 * a numeric address. Note that the caller must not free the
605 * address and that the next call to this function is allowed
606 * to override the address again.
608 * @param cls closure (`struct Plugin*`)
609 * @param addr binary address
610 * @param addrlen length of @a addr
611 * @return string representing the same address
614 tcp_plugin_address_to_string (void *cls,
618 static char rbuf[INET6_ADDRSTRLEN + 12];
619 char buf[INET6_ADDRSTRLEN];
623 const struct IPv4TcpAddress *t4;
624 const struct IPv6TcpAddress *t6;
631 case sizeof(struct IPv6TcpAddress):
634 port = ntohs (t6->t6_port);
635 options = ntohl (t6->options);
636 memcpy (&a6, &t6->ipv6_addr, sizeof(a6));
639 case sizeof(struct IPv4TcpAddress):
642 port = ntohs (t4->t4_port);
643 options = ntohl (t4->options);
644 memcpy (&a4, &t4->ipv4_addr, sizeof(a4));
648 LOG (GNUNET_ERROR_TYPE_WARNING,
649 _("Unexpected address length: %u bytes\n"),
650 (unsigned int) addrlen);
653 if (NULL == inet_ntop (af, sb, buf, INET6_ADDRSTRLEN))
655 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
659 GNUNET_snprintf (rbuf, sizeof(rbuf),
660 (af == AF_INET6) ? "%s.%u.[%s]:%u" : "%s.%u.%s:%u",
670 * Function called to convert a string address to
673 * @param cls closure (`struct Plugin*`)
674 * @param addr string address
675 * @param addrlen length of the address
676 * @param buf location to store the buffer
677 * @param added location to store the number of bytes in the buffer.
678 * If the function returns #GNUNET_SYSERR, its contents are undefined.
679 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
682 tcp_plugin_string_to_address (void *cls,
688 struct sockaddr_storage socket_address;
694 /* Format tcp.options.address:port */
698 if ((NULL == addr) || (addrlen == 0))
701 return GNUNET_SYSERR;
703 if ('\0' != addr[addrlen - 1])
706 return GNUNET_SYSERR;
708 if (strlen (addr) != addrlen - 1)
711 return GNUNET_SYSERR;
713 plugin = GNUNET_strdup (addr);
714 optionstr = strchr (plugin, '.');
715 if (NULL == optionstr)
719 return GNUNET_SYSERR;
723 options = atol (optionstr);
724 address = strchr (optionstr, '.');
729 return GNUNET_SYSERR;
735 != GNUNET_STRINGS_to_address_ip (address, strlen (address),
740 return GNUNET_SYSERR;
744 switch (socket_address.ss_family)
748 struct IPv4TcpAddress *t4;
749 struct sockaddr_in *in4 = (struct sockaddr_in *) &socket_address;
750 t4 = GNUNET_new (struct IPv4TcpAddress);
751 t4->options = htonl (options);
752 t4->ipv4_addr = in4->sin_addr.s_addr;
753 t4->t4_port = in4->sin_port;
755 *added = sizeof(struct IPv4TcpAddress);
760 struct IPv6TcpAddress *t6;
761 struct sockaddr_in6 *in6 = (struct sockaddr_in6 *) &socket_address;
762 t6 = GNUNET_new (struct IPv6TcpAddress);
763 t6->options = htonl (options);
764 t6->ipv6_addr = in6->sin6_addr;
765 t6->t6_port = in6->sin6_port;
767 *added = sizeof(struct IPv6TcpAddress);
771 return GNUNET_SYSERR;
777 * Find the session handle for the given client.
778 * Currently uses both the hashmap and the client
779 * context, as the client context is new and the
780 * logic still needs to be tested.
782 * @param plugin the plugin
783 * @param client which client to find the session handle for
784 * @return NULL if no matching session exists
786 static struct Session *
787 lookup_session_by_client (struct Plugin *plugin,
788 struct GNUNET_SERVER_Client *client)
790 return GNUNET_SERVER_client_get_user_context (client, struct Session);
795 * Functions with this signature are called whenever we need
796 * to close a session due to a disconnect or failure to
797 * establish a connection.
799 * @param cls the `struct Plugin`
800 * @param session session to close down
801 * @return #GNUNET_OK on success
804 tcp_plugin_disconnect_session (void *cls,
805 struct Session *session)
807 struct Plugin *plugin = cls;
808 struct PendingMessage *pm;
810 LOG (GNUNET_ERROR_TYPE_DEBUG,
811 "Disconnecting session of peer `%s' address `%s'\n",
812 GNUNET_i2s (&session->target),
813 tcp_plugin_address_to_string (session->plugin,
814 session->address->address,
815 session->address->address_length));
817 if (NULL != session->timeout_task)
819 GNUNET_SCHEDULER_cancel (session->timeout_task);
820 session->timeout_task = NULL;
821 session->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
825 GNUNET_CONTAINER_multipeermap_remove (plugin->sessionmap,
829 GNUNET_STATISTICS_update (session->plugin->env->stats,
830 gettext_noop ("# TCP sessions active"), -1, GNUNET_NO);
834 GNUNET_assert(GNUNET_YES ==
835 GNUNET_CONTAINER_multipeermap_remove (plugin->nat_wait_conns,
839 if (NULL != session->client)
840 GNUNET_SERVER_client_set_user_context (session->client,
844 if (NULL != session->transmit_handle)
846 GNUNET_SERVER_notify_transmit_ready_cancel (session->transmit_handle);
847 session->transmit_handle = NULL;
849 session->plugin->env->session_end (session->plugin->env->cls,
853 if (NULL != session->nat_connection_timeout)
855 GNUNET_SCHEDULER_cancel (session->nat_connection_timeout);
856 session->nat_connection_timeout = NULL;
859 while (NULL != (pm = session->pending_messages_head))
861 LOG (GNUNET_ERROR_TYPE_DEBUG,
862 (NULL != pm->transmit_cont)
863 ? "Could not deliver message to `%4s'.\n"
864 : "Could not deliver message to `%4s', notifying.\n",
865 GNUNET_i2s (&session->target));
866 GNUNET_STATISTICS_update (session->plugin->env->stats,
867 gettext_noop ("# bytes currently in TCP buffers"),
868 -(int64_t) pm->message_size, GNUNET_NO);
869 GNUNET_STATISTICS_update (session->plugin->env->stats,
870 gettext_noop ("# bytes discarded by TCP (disconnect)"),
873 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
874 session->pending_messages_tail,
876 GNUNET_assert (0 < session->msgs_in_queue);
877 session->msgs_in_queue--;
878 GNUNET_assert (pm->message_size <= session->bytes_in_queue);
879 session->bytes_in_queue -= pm->message_size;
880 if (NULL != pm->transmit_cont)
881 pm->transmit_cont (pm->transmit_cont_cls,
888 GNUNET_assert (0 == session->msgs_in_queue);
889 GNUNET_assert (0 == session->bytes_in_queue);
890 notify_session_monitor (session->plugin,
892 GNUNET_TRANSPORT_SS_DONE);
894 if (session->receive_delay_task != NULL)
896 GNUNET_SCHEDULER_cancel (session->receive_delay_task);
897 if (NULL != session->client)
898 GNUNET_SERVER_receive_done (session->client, GNUNET_SYSERR);
900 if (NULL != session->client)
902 GNUNET_SERVER_client_disconnect (session->client);
903 GNUNET_SERVER_client_drop (session->client);
904 session->client = NULL;
906 GNUNET_HELLO_address_free (session->address);
907 GNUNET_assert(NULL == session->transmit_handle);
908 GNUNET_free(session);
914 * Function that is called to get the keepalive factor.
915 * #GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
916 * calculate the interval between keepalive packets.
918 * @param cls closure with the `struct Plugin`
919 * @return keepalive factor
922 tcp_plugin_query_keepalive_factor (void *cls)
929 * Session was idle, so disconnect it
931 * @param cls the `struct Session` of the idle session
932 * @param tc scheduler context
935 session_timeout (void *cls,
936 const struct GNUNET_SCHEDULER_TaskContext *tc)
938 struct Session *s = cls;
939 struct GNUNET_TIME_Relative left;
941 s->timeout_task = NULL;
942 left = GNUNET_TIME_absolute_get_remaining (s->timeout);
943 if (0 != left.rel_value_us)
945 /* not actually our turn yet, but let's at least update
946 the monitor, it may think we're about to die ... */
947 notify_session_monitor (s->plugin,
949 GNUNET_TRANSPORT_SS_UPDATE);
950 s->timeout_task = GNUNET_SCHEDULER_add_delayed (left,
955 LOG (GNUNET_ERROR_TYPE_DEBUG,
956 "Session %p was idle for %s, disconnecting\n",
958 GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
960 /* call session destroy function */
961 tcp_plugin_disconnect_session (s->plugin, s);
966 * Increment session timeout due to activity
968 * @param s session to increment timeout for
971 reschedule_session_timeout (struct Session *s)
973 GNUNET_assert(NULL != s->timeout_task);
974 s->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
979 * Create a new session. Also queues a welcome message.
981 * @param plugin the plugin
982 * @param address the address to create the session for
983 * @param client client to use, reference counter must have already been increased
984 * @param is_nat this a NAT session, we should wait for a client to
985 * connect to us from an address, then assign that to
987 * @return new session object
989 static struct Session *
990 create_session (struct Plugin *plugin,
991 const struct GNUNET_HELLO_Address *address,
992 struct GNUNET_SERVER_Client *client,
995 struct Session *session;
996 struct PendingMessage *pm;
998 if (GNUNET_YES != is_nat)
999 GNUNET_assert (NULL != client);
1001 GNUNET_assert (NULL == client);
1003 LOG (GNUNET_ERROR_TYPE_DEBUG,
1004 "Creating new session for peer `%4s'\n",
1005 GNUNET_i2s (&address->peer));
1006 session = GNUNET_new (struct Session);
1007 session->last_activity = GNUNET_TIME_absolute_get ();
1008 session->plugin = plugin;
1009 session->is_nat = is_nat;
1010 session->client = client;
1011 session->address = GNUNET_HELLO_address_copy (address);
1012 session->target = address->peer;
1013 session->expecting_welcome = GNUNET_YES;
1014 session->ats_address_network_type = GNUNET_ATS_NET_UNSPECIFIED;
1015 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
1016 sizeof (struct WelcomeMessage));
1017 pm->msg = (const char *) &pm[1];
1018 pm->message_size = sizeof(struct WelcomeMessage);
1020 &plugin->my_welcome,
1021 sizeof(struct WelcomeMessage));
1022 pm->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1023 GNUNET_STATISTICS_update (plugin->env->stats,
1024 gettext_noop ("# bytes currently in TCP buffers"), pm->message_size,
1026 GNUNET_CONTAINER_DLL_insert (session->pending_messages_head,
1027 session->pending_messages_tail,
1029 session->msgs_in_queue++;
1030 session->bytes_in_queue += pm->message_size;
1031 session->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1032 session->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1035 notify_session_monitor (session->plugin,
1037 GNUNET_TRANSPORT_SS_INIT);
1038 if (GNUNET_YES != is_nat)
1040 GNUNET_STATISTICS_update (plugin->env->stats,
1041 gettext_noop ("# TCP sessions active"),
1044 notify_session_monitor (session->plugin,
1046 GNUNET_TRANSPORT_SS_UP);
1050 notify_session_monitor (session->plugin,
1052 GNUNET_TRANSPORT_SS_HANDSHAKE);
1059 * If we have pending messages, ask the server to
1060 * transmit them (schedule the respective tasks, etc.)
1062 * @param session for which session should we do this
1065 process_pending_messages (struct Session *session);
1069 * Function called to notify a client about the socket
1070 * being ready to queue more data. "buf" will be
1071 * NULL and "size" zero if the socket was closed for
1072 * writing in the meantime.
1074 * @param cls closure
1075 * @param size number of bytes available in @a buf
1076 * @param buf where the callee should write the message
1077 * @return number of bytes written to @a buf
1080 do_transmit (void *cls, size_t size, void *buf)
1082 struct Session *session = cls;
1083 struct GNUNET_PeerIdentity pid;
1084 struct Plugin *plugin;
1085 struct PendingMessage *pos;
1086 struct PendingMessage *hd;
1087 struct PendingMessage *tl;
1088 struct GNUNET_TIME_Absolute now;
1092 session->transmit_handle = NULL;
1093 plugin = session->plugin;
1096 LOG (GNUNET_ERROR_TYPE_DEBUG,
1097 "Timeout trying to transmit to peer `%4s', discarding message queue.\n",
1098 GNUNET_i2s (&session->target));
1099 /* timeout; cancel all messages that have already expired */
1103 now = GNUNET_TIME_absolute_get ();
1104 while ((NULL != (pos = session->pending_messages_head))
1105 && (pos->timeout.abs_value_us <= now.abs_value_us))
1107 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
1108 session->pending_messages_tail,
1110 GNUNET_assert (0 < session->msgs_in_queue);
1111 session->msgs_in_queue--;
1112 GNUNET_assert (pos->message_size <= session->bytes_in_queue);
1113 session->bytes_in_queue -= pos->message_size;
1114 LOG (GNUNET_ERROR_TYPE_DEBUG,
1115 "Failed to transmit %u byte message to `%4s'.\n",
1117 GNUNET_i2s (&session->target));
1118 ret += pos->message_size;
1119 GNUNET_CONTAINER_DLL_insert_after (hd, tl, tl, pos);
1121 /* do this call before callbacks (so that if callbacks destroy
1122 * session, they have a chance to cancel actions done by this
1124 process_pending_messages (session);
1125 pid = session->target;
1126 /* no do callbacks and do not use session again since
1127 * the callbacks may abort the session */
1128 while (NULL != (pos = hd))
1130 GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
1131 if (pos->transmit_cont != NULL)
1132 pos->transmit_cont (pos->transmit_cont_cls,
1135 pos->message_size, 0);
1138 GNUNET_STATISTICS_update (plugin->env->stats,
1139 gettext_noop ("# bytes currently in TCP buffers"), -(int64_t) ret,
1141 GNUNET_STATISTICS_update (plugin->env->stats,
1142 gettext_noop ("# bytes discarded by TCP (timeout)"),
1146 notify_session_monitor (session->plugin,
1148 GNUNET_TRANSPORT_SS_UPDATE);
1151 /* copy all pending messages that would fit */
1156 while (NULL != (pos = session->pending_messages_head))
1158 if (ret + pos->message_size > size)
1160 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
1161 session->pending_messages_tail,
1163 GNUNET_assert (0 < session->msgs_in_queue);
1164 session->msgs_in_queue--;
1165 GNUNET_assert (pos->message_size <= session->bytes_in_queue);
1166 session->bytes_in_queue -= pos->message_size;
1167 GNUNET_assert(size >= pos->message_size);
1168 LOG(GNUNET_ERROR_TYPE_DEBUG,
1169 "Transmitting message of type %u size %u to %s\n",
1170 ntohs (((struct GNUNET_MessageHeader *) pos->msg)->type),
1172 tcp_plugin_address_to_string (session->plugin,
1173 session->address->address,
1174 session->address->address_length));
1175 /* FIXME: this memcpy can be up to 7% of our total runtime */
1176 memcpy (cbuf, pos->msg, pos->message_size);
1177 cbuf += pos->message_size;
1178 ret += pos->message_size;
1179 size -= pos->message_size;
1180 GNUNET_CONTAINER_DLL_insert_tail (hd, tl, pos);
1182 notify_session_monitor (session->plugin,
1184 GNUNET_TRANSPORT_SS_UPDATE);
1185 /* schedule 'continuation' before callbacks so that callbacks that
1186 * cancel everything don't cause us to use a session that no longer
1188 process_pending_messages (session);
1189 session->last_activity = GNUNET_TIME_absolute_get ();
1190 pid = session->target;
1191 /* we'll now call callbacks that may cancel the session; hence
1192 * we should not use 'session' after this point */
1193 while (NULL != (pos = hd))
1195 GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
1196 if (pos->transmit_cont != NULL)
1197 pos->transmit_cont (pos->transmit_cont_cls,
1201 pos->message_size); /* FIXME: include TCP overhead */
1204 GNUNET_assert (NULL == hd);
1205 GNUNET_assert (NULL == tl);
1206 LOG(GNUNET_ERROR_TYPE_DEBUG,
1207 "Transmitting %u bytes\n",
1209 GNUNET_STATISTICS_update (plugin->env->stats,
1210 gettext_noop ("# bytes currently in TCP buffers"),
1213 GNUNET_STATISTICS_update (plugin->env->stats,
1214 gettext_noop ("# bytes transmitted via TCP"),
1222 * If we have pending messages, ask the server to
1223 * transmit them (schedule the respective tasks, etc.)
1225 * @param session for which session should we do this
1228 process_pending_messages (struct Session *session)
1230 struct PendingMessage *pm;
1232 GNUNET_assert (NULL != session->client);
1233 if (NULL != session->transmit_handle)
1235 if (NULL == (pm = session->pending_messages_head))
1238 session->transmit_handle = GNUNET_SERVER_notify_transmit_ready (session->client,
1240 GNUNET_TIME_absolute_get_remaining (pm->timeout),
1247 * Function that can be used by the transport service to transmit
1248 * a message using the plugin. Note that in the case of a
1249 * peer disconnecting, the continuation MUST be called
1250 * prior to the disconnect notification itself. This function
1251 * will be called with this peer's HELLO message to initiate
1252 * a fresh connection to another peer.
1254 * @param cls closure
1255 * @param session which session must be used
1256 * @param msgbuf the message to transmit
1257 * @param msgbuf_size number of bytes in 'msgbuf'
1258 * @param priority how important is the message (most plugins will
1259 * ignore message priority and just FIFO)
1260 * @param to how long to wait at most for the transmission (does not
1261 * require plugins to discard the message after the timeout,
1262 * just advisory for the desired delay; most plugins will ignore
1264 * @param cont continuation to call once the message has
1265 * been transmitted (or if the transport is ready
1266 * for the next transmission call; or if the
1267 * peer disconnected...); can be NULL
1268 * @param cont_cls closure for @a cont
1269 * @return number of bytes used (on the physical network, with overheads);
1270 * -1 on hard errors (i.e. address invalid); 0 is a legal value
1271 * and does NOT mean that the message was not transmitted (DV)
1274 tcp_plugin_send (void *cls,
1275 struct Session *session,
1278 unsigned int priority,
1279 struct GNUNET_TIME_Relative to,
1280 GNUNET_TRANSPORT_TransmitContinuation cont,
1283 struct Plugin * plugin = cls;
1284 struct PendingMessage *pm;
1286 /* create new message entry */
1287 pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
1288 pm->msg = (const char *) &pm[1];
1289 memcpy (&pm[1], msgbuf, msgbuf_size);
1290 pm->message_size = msgbuf_size;
1291 pm->timeout = GNUNET_TIME_relative_to_absolute (to);
1292 pm->transmit_cont = cont;
1293 pm->transmit_cont_cls = cont_cls;
1295 LOG(GNUNET_ERROR_TYPE_DEBUG,
1296 "Asked to transmit %u bytes to `%s', added message to list.\n",
1297 msgbuf_size, GNUNET_i2s (&session->target));
1300 GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessionmap,
1304 GNUNET_assert (NULL != session->client);
1305 GNUNET_SERVER_client_set_timeout (session->client,
1306 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1307 GNUNET_STATISTICS_update (plugin->env->stats,
1308 gettext_noop ("# bytes currently in TCP buffers"), msgbuf_size,
1311 /* append pm to pending_messages list */
1312 GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1313 session->pending_messages_tail,
1315 notify_session_monitor (session->plugin,
1317 GNUNET_TRANSPORT_SS_UPDATE);
1318 session->msgs_in_queue++;
1319 session->bytes_in_queue += pm->message_size;
1320 process_pending_messages (session);
1323 else if (GNUNET_YES ==
1324 GNUNET_CONTAINER_multipeermap_contains_value (plugin->nat_wait_conns,
1328 LOG (GNUNET_ERROR_TYPE_DEBUG,
1329 "This NAT WAIT session for peer `%s' is not yet ready!\n",
1330 GNUNET_i2s (&session->target));
1331 GNUNET_STATISTICS_update (plugin->env->stats,
1332 gettext_noop ("# bytes currently in TCP buffers"), msgbuf_size,
1334 /* append pm to pending_messages list */
1335 GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1336 session->pending_messages_tail,
1338 session->msgs_in_queue++;
1339 session->bytes_in_queue += pm->message_size;
1340 notify_session_monitor (session->plugin,
1342 GNUNET_TRANSPORT_SS_HANDSHAKE);
1347 LOG(GNUNET_ERROR_TYPE_ERROR,
1348 "Invalid session %p\n",
1358 return GNUNET_SYSERR; /* session does not exist here */
1363 * Closure for #session_lookup_it().
1368 * Address we are looking for.
1370 const struct GNUNET_HELLO_Address *address;
1373 * Where to store the session (if we found it).
1375 struct Session *result;
1381 * Look for a session by address.
1383 * @param cls the `struct SessionItCtx`
1385 * @param value a `struct Session`
1386 * @return #GNUNET_YES to continue looking, #GNUNET_NO if we found the session
1389 session_lookup_it (void *cls,
1390 const struct GNUNET_PeerIdentity *key,
1393 struct SessionItCtx * si_ctx = cls;
1394 struct Session * session = value;
1396 if (0 != GNUNET_HELLO_address_cmp (si_ctx->address, session->address))
1398 /* Found existing session */
1399 si_ctx->result = session;
1405 * Task cleaning up a NAT connection attempt after timeout
1407 * @param cls the `struct Session`
1408 * @param tc scheduler context (unused)
1411 nat_connect_timeout (void *cls,
1412 const struct GNUNET_SCHEDULER_TaskContext *tc)
1414 struct Session *session = cls;
1416 session->nat_connection_timeout = NULL;
1417 LOG (GNUNET_ERROR_TYPE_DEBUG,
1418 "NAT WAIT connection to `%4s' at `%s' could not be established, removing session\n",
1419 GNUNET_i2s (&session->target),
1420 tcp_plugin_address_to_string (session->plugin,
1421 session->address->address,
1422 session->address->address_length));
1423 tcp_plugin_disconnect_session (session->plugin,
1429 * Function that will be called whenever the transport service wants to
1430 * notify the plugin that a session is still active and in use and
1431 * therefore the session timeout for this session has to be updated
1433 * @param cls closure
1434 * @param peer which peer was the session for
1435 * @param session which session is being updated
1438 tcp_plugin_update_session_timeout (void *cls,
1439 const struct GNUNET_PeerIdentity *peer,
1440 struct Session *session)
1442 reschedule_session_timeout (session);
1447 * Task to signal the server that we can continue
1448 * receiving from the TCP client now.
1450 * @param cls the `struct Session*`
1451 * @param tc task context (unused)
1454 delayed_done (void *cls,
1455 const struct GNUNET_SCHEDULER_TaskContext *tc)
1457 struct Session *session = cls;
1459 session->receive_delay_task = NULL;
1460 reschedule_session_timeout (session);
1462 GNUNET_SERVER_receive_done (session->client, GNUNET_OK);
1467 * Function that will be called whenever the transport service wants to
1468 * notify the plugin that the inbound quota changed and that the plugin
1469 * should update it's delay for the next receive value
1471 * @param cls closure
1472 * @param peer which peer was the session for
1473 * @param session which session is being updated
1474 * @param delay new delay to use for receiving
1477 tcp_plugin_update_inbound_delay (void *cls,
1478 const struct GNUNET_PeerIdentity *peer,
1479 struct Session *session,
1480 struct GNUNET_TIME_Relative delay)
1482 if (NULL == session->receive_delay_task)
1484 LOG (GNUNET_ERROR_TYPE_DEBUG,
1485 "New inbound delay %s\n",
1486 GNUNET_STRINGS_relative_time_to_string (delay,
1488 session->receive_delay = GNUNET_TIME_relative_to_absolute (delay);
1489 GNUNET_SCHEDULER_cancel (session->receive_delay_task);
1490 session->receive_delay_task = GNUNET_SCHEDULER_add_delayed (delay,
1497 * Create a new session to transmit data to the target
1498 * This session will used to send data to this peer and the plugin will
1499 * notify us by calling the env->session_end function
1501 * @param cls closure
1502 * @param address the address to use
1503 * @return the session if the address is valid, NULL otherwise
1505 static struct Session *
1506 tcp_plugin_get_session (void *cls,
1507 const struct GNUNET_HELLO_Address *address)
1509 struct Plugin *plugin = cls;
1510 struct Session *session = NULL;
1514 struct GNUNET_CONNECTION_Handle *sa;
1515 struct sockaddr_in a4;
1516 struct sockaddr_in6 a6;
1517 const struct IPv4TcpAddress *t4;
1518 const struct IPv6TcpAddress *t6;
1519 unsigned int options;
1520 enum GNUNET_ATS_Network_Type net_type;
1521 unsigned int is_natd = GNUNET_NO;
1524 struct GNUNET_NETWORK_Handle *s;
1527 addrlen = address->address_length;
1528 LOG (GNUNET_ERROR_TYPE_DEBUG,
1529 "Trying to get session for `%s' address of peer `%s'\n",
1530 tcp_plugin_address_to_string (plugin,
1532 address->address_length),
1533 GNUNET_i2s (&address->peer));
1535 if (GNUNET_HELLO_address_check_option (address,
1536 GNUNET_HELLO_ADDRESS_INFO_INBOUND))
1542 /* look for existing session */
1544 GNUNET_CONTAINER_multipeermap_contains (plugin->sessionmap,
1547 struct SessionItCtx si_ctx;
1549 si_ctx.address = address;
1550 si_ctx.result = NULL;
1552 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessionmap,
1554 &session_lookup_it, &si_ctx);
1555 if (NULL != si_ctx.result)
1557 session = si_ctx.result;
1558 LOG (GNUNET_ERROR_TYPE_DEBUG,
1559 "Found existing session for `%s' address `%s' session %p\n",
1560 GNUNET_i2s (&address->peer),
1561 tcp_plugin_address_to_string (plugin,
1563 address->address_length),
1567 LOG (GNUNET_ERROR_TYPE_DEBUG,
1568 "Existing sessions did not match address `%s' or peer `%s'\n",
1569 tcp_plugin_address_to_string (plugin,
1571 address->address_length),
1572 GNUNET_i2s (&address->peer));
1575 if (addrlen == sizeof(struct IPv6TcpAddress))
1577 GNUNET_assert(NULL != address->address); /* make static analysis happy */
1578 t6 = address->address;
1579 options = t6->options;
1581 memset (&a6, 0, sizeof(a6));
1582 #if HAVE_SOCKADDR_IN_SIN_LEN
1583 a6.sin6_len = sizeof (a6);
1585 a6.sin6_family = AF_INET6;
1586 a6.sin6_port = t6->t6_port;
1587 if (t6->t6_port == 0)
1588 is_natd = GNUNET_YES;
1589 memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof(struct in6_addr));
1593 else if (addrlen == sizeof(struct IPv4TcpAddress))
1595 GNUNET_assert(NULL != address->address); /* make static analysis happy */
1596 t4 = address->address;
1597 options = t4->options;
1599 memset (&a4, 0, sizeof(a4));
1600 #if HAVE_SOCKADDR_IN_SIN_LEN
1601 a4.sin_len = sizeof (a4);
1603 a4.sin_family = AF_INET;
1604 a4.sin_port = t4->t4_port;
1605 if (t4->t4_port == 0)
1606 is_natd = GNUNET_YES;
1607 a4.sin_addr.s_addr = t4->ipv4_addr;
1613 GNUNET_STATISTICS_update (plugin->env->stats, gettext_noop
1614 ("# requests to create session with invalid address"), 1, GNUNET_NO);
1618 net_type = plugin->env->get_address_type (plugin->env->cls, sb, sbs);
1621 if ((is_natd == GNUNET_YES) && (addrlen == sizeof(struct IPv6TcpAddress)))
1623 /* NAT client only works with IPv4 addresses */
1627 if (plugin->cur_connections >= plugin->max_connections)
1633 if ((is_natd == GNUNET_YES)
1635 == GNUNET_CONTAINER_multipeermap_contains (plugin->nat_wait_conns,
1638 /* Only do one NAT punch attempt per peer identity */
1642 if ((is_natd == GNUNET_YES) && (NULL != plugin->nat) &&
1644 GNUNET_CONTAINER_multipeermap_contains (plugin->nat_wait_conns,
1647 LOG (GNUNET_ERROR_TYPE_DEBUG,
1648 "Found valid IPv4 NAT address (creating session)!\n");
1649 session = create_session (plugin,
1653 session->ats_address_network_type = net_type;
1654 GNUNET_break (session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
1655 session->nat_connection_timeout = GNUNET_SCHEDULER_add_delayed (NAT_TIMEOUT,
1656 &nat_connect_timeout,
1658 GNUNET_assert(GNUNET_OK ==
1659 GNUNET_CONTAINER_multipeermap_put (plugin->nat_wait_conns,
1662 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1664 LOG (GNUNET_ERROR_TYPE_DEBUG,
1665 "Created NAT WAIT connection to `%4s' at `%s'\n",
1666 GNUNET_i2s (&session->target),
1667 GNUNET_a2s (sb, sbs));
1668 if (GNUNET_OK == GNUNET_NAT_run_client (plugin->nat, &a4))
1674 LOG(GNUNET_ERROR_TYPE_DEBUG,
1675 "Running NAT client for `%4s' at `%s' failed\n",
1676 GNUNET_i2s (&session->target),
1677 GNUNET_a2s (sb, sbs));
1678 tcp_plugin_disconnect_session (plugin,
1684 /* create new outbound session */
1685 GNUNET_assert(plugin->cur_connections <= plugin->max_connections);
1687 if (0 != (options & TCP_OPTIONS_TCP_STEALTH))
1690 s = GNUNET_NETWORK_socket_create (af, SOCK_STREAM, 0);
1693 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
1700 GNUNET_NETWORK_socket_setsockopt (s,
1704 sizeof (struct GNUNET_PeerIdentity))) ||
1706 GNUNET_NETWORK_socket_setsockopt (s,
1708 TCP_STEALTH_INTEGRITY,
1709 &plugin->my_welcome,
1710 sizeof (struct WelcomeMessage))) )
1712 /* TCP STEALTH not supported by kernel */
1713 GNUNET_break (GNUNET_OK ==
1714 GNUNET_NETWORK_socket_close (s));
1719 sa = GNUNET_CONNECTION_connect_socket (s, sb, sbs);
1728 sa = GNUNET_CONNECTION_create_from_sockaddr (af, sb, sbs);
1732 LOG (GNUNET_ERROR_TYPE_DEBUG,
1733 "Failed to create connection to `%4s' at `%s'\n",
1734 GNUNET_i2s (&address->peer),
1735 GNUNET_a2s (sb, sbs));
1738 plugin->cur_connections++;
1739 if (plugin->cur_connections == plugin->max_connections)
1740 GNUNET_SERVER_suspend (plugin->server); /* Maximum number of connections rechead */
1742 LOG (GNUNET_ERROR_TYPE_DEBUG,
1743 "Asked to transmit to `%4s', creating fresh session using address `%s'.\n",
1744 GNUNET_i2s (&address->peer),
1745 GNUNET_a2s (sb, sbs));
1747 session = create_session (plugin,
1749 GNUNET_SERVER_connect_socket (plugin->server, sa),
1751 session->ats_address_network_type = net_type;
1752 GNUNET_break (session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
1753 GNUNET_SERVER_client_set_user_context(session->client, session);
1754 GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap,
1757 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1758 LOG (GNUNET_ERROR_TYPE_DEBUG,
1759 "Creating new session for `%s' address `%s' session %p\n",
1760 GNUNET_i2s (&address->peer),
1761 tcp_plugin_address_to_string (plugin,
1763 address->address_length),
1765 /* Send TCP Welcome */
1766 process_pending_messages (session);
1773 session_disconnect_it (void *cls,
1774 const struct GNUNET_PeerIdentity *key,
1777 struct Plugin *plugin = cls;
1778 struct Session *session = value;
1780 GNUNET_STATISTICS_update (session->plugin->env->stats,
1781 gettext_noop ("# transport-service disconnect requests for TCP"),
1784 tcp_plugin_disconnect_session (plugin,
1791 * Function that can be called to force a disconnect from the
1792 * specified neighbour. This should also cancel all previously
1793 * scheduled transmissions. Obviously the transmission may have been
1794 * partially completed already, which is OK. The plugin is supposed
1795 * to close the connection (if applicable) and no longer call the
1796 * transmit continuation(s).
1798 * Finally, plugin MUST NOT call the services's receive function to
1799 * notify the service that the connection to the specified target was
1800 * closed after a getting this call.
1802 * @param cls closure
1803 * @param target peer for which the last transmission is
1807 tcp_plugin_disconnect (void *cls,
1808 const struct GNUNET_PeerIdentity *target)
1810 struct Plugin *plugin = cls;
1812 LOG(GNUNET_ERROR_TYPE_DEBUG,
1813 "Disconnecting peer `%4s'\n",
1814 GNUNET_i2s (target));
1815 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessionmap,
1817 &session_disconnect_it,
1819 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->nat_wait_conns,
1821 &session_disconnect_it,
1827 * Running pretty printers: head
1829 static struct PrettyPrinterContext *ppc_dll_head;
1832 * Running pretty printers: tail
1834 static struct PrettyPrinterContext *ppc_dll_tail;
1837 * Context for address to string conversion, closure
1838 * for #append_port().
1840 struct PrettyPrinterContext
1845 struct PrettyPrinterContext *next;
1850 struct PrettyPrinterContext *prev;
1855 struct GNUNET_SCHEDULER_Task * timeout_task;
1860 struct GNUNET_RESOLVER_RequestHandle *resolver_handle;
1863 * Function to call with the result.
1865 GNUNET_TRANSPORT_AddressStringCallback asc;
1868 * Clsoure for @e asc.
1873 * Port to add after the IP address.
1890 * Append our port and forward the result.
1892 * @param cls the `struct PrettyPrinterContext *`
1893 * @param hostname hostname part of the address
1896 append_port (void *cls,
1897 const char *hostname)
1899 struct PrettyPrinterContext *ppc = cls;
1902 if (NULL == hostname)
1904 /* Final call, done */
1905 ppc->resolver_handle = NULL;
1906 GNUNET_CONTAINER_DLL_remove (ppc_dll_head,
1909 ppc->asc (ppc->asc_cls,
1915 if (GNUNET_YES == ppc->ipv6)
1916 GNUNET_asprintf (&ret,
1923 GNUNET_asprintf (&ret,
1929 ppc->asc (ppc->asc_cls,
1937 * Convert the transports address to a nice, human-readable
1940 * @param cls closure
1941 * @param type name of the transport that generated the address
1942 * @param addr one of the addresses of the host, NULL for the last address
1943 * the specific address format depends on the transport
1944 * @param addrlen length of the @a addr
1945 * @param numeric should (IP) addresses be displayed in numeric form?
1946 * @param timeout after how long should we give up?
1947 * @param asc function to call on each string
1948 * @param asc_cls closure for @a asc
1951 tcp_plugin_address_pretty_printer (void *cls,
1956 struct GNUNET_TIME_Relative timeout,
1957 GNUNET_TRANSPORT_AddressStringCallback asc,
1960 struct PrettyPrinterContext *ppc;
1963 struct sockaddr_in a4;
1964 struct sockaddr_in6 a6;
1965 const struct IPv4TcpAddress *t4;
1966 const struct IPv6TcpAddress *t6;
1970 if (sizeof(struct IPv6TcpAddress) == addrlen)
1973 memset (&a6, 0, sizeof(a6));
1974 a6.sin6_family = AF_INET6;
1975 a6.sin6_port = t6->t6_port;
1976 memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof(struct in6_addr));
1977 port = ntohs (t6->t6_port);
1978 options = ntohl (t6->options);
1982 else if (sizeof(struct IPv4TcpAddress) == addrlen)
1985 memset (&a4, 0, sizeof(a4));
1986 a4.sin_family = AF_INET;
1987 a4.sin_port = t4->t4_port;
1988 a4.sin_addr.s_addr = t4->ipv4_addr;
1989 port = ntohs (t4->t4_port);
1990 options = ntohl (t4->options);
1996 /* invalid address */
1997 asc (asc_cls, NULL, GNUNET_SYSERR);
1998 asc (asc_cls, NULL, GNUNET_OK);
2001 ppc = GNUNET_new (struct PrettyPrinterContext);
2002 if (addrlen == sizeof(struct IPv6TcpAddress))
2003 ppc->ipv6 = GNUNET_YES;
2005 ppc->ipv6 = GNUNET_NO;
2007 ppc->asc_cls = asc_cls;
2009 ppc->options = options;
2010 ppc->resolver_handle = GNUNET_RESOLVER_hostname_get (sb,
2015 if (NULL == ppc->resolver_handle)
2021 GNUNET_CONTAINER_DLL_insert (ppc_dll_head,
2028 * Check if the given port is plausible (must be either our listen
2029 * port or our advertised port), or any port if we are behind NAT
2030 * and do not have a port open. If it is neither, we return
2033 * @param plugin global variables
2034 * @param in_port port number to check
2035 * @return #GNUNET_OK if port is either open_port or adv_port
2038 check_port (struct Plugin *plugin, uint16_t in_port)
2040 if ((in_port == plugin->adv_port) || (in_port == plugin->open_port))
2042 return GNUNET_SYSERR;
2046 * Function that will be called to check if a binary address for this
2047 * plugin is well-formed and corresponds to an address for THIS peer
2048 * (as per our configuration). Naturally, if absolutely necessary,
2049 * plugins can be a bit conservative in their answer, but in general
2050 * plugins should make sure that the address does not redirect
2051 * traffic to a 3rd party that might try to man-in-the-middle our
2054 * @param cls closure, our `struct Plugin *`
2055 * @param addr pointer to the address
2056 * @param addrlen length of addr
2057 * @return #GNUNET_OK if this is a plausible address for this peer
2058 * and transport, #GNUNET_SYSERR if not
2061 tcp_plugin_check_address (void *cls, const void *addr, size_t addrlen)
2063 struct Plugin *plugin = cls;
2064 struct IPv4TcpAddress *v4;
2065 struct IPv6TcpAddress *v6;
2067 if ((addrlen != sizeof(struct IPv4TcpAddress))
2068 && (addrlen != sizeof(struct IPv6TcpAddress)))
2071 return GNUNET_SYSERR;
2074 if (addrlen == sizeof(struct IPv4TcpAddress))
2076 v4 = (struct IPv4TcpAddress *) addr;
2077 if (0 != memcmp (&v4->options,
2082 return GNUNET_SYSERR;
2084 if (GNUNET_OK != check_port (plugin, ntohs (v4->t4_port)))
2085 return GNUNET_SYSERR;
2087 != GNUNET_NAT_test_address (plugin->nat, &v4->ipv4_addr,
2088 sizeof(struct in_addr)))
2089 return GNUNET_SYSERR;
2093 v6 = (struct IPv6TcpAddress *) addr;
2094 if (IN6_IS_ADDR_LINKLOCAL (&v6->ipv6_addr))
2097 return GNUNET_SYSERR;
2099 if (0 != memcmp (&v6->options,
2104 return GNUNET_SYSERR;
2106 if (GNUNET_OK != check_port (plugin, ntohs (v6->t6_port)))
2107 return GNUNET_SYSERR;
2109 != GNUNET_NAT_test_address (plugin->nat, &v6->ipv6_addr,
2110 sizeof(struct in6_addr)))
2111 return GNUNET_SYSERR;
2117 * We've received a nat probe from this peer via TCP. Finish
2118 * creating the client session and resume sending of queued
2121 * @param cls closure
2122 * @param client identification of the client
2123 * @param message the actual message
2126 handle_tcp_nat_probe (void *cls,
2127 struct GNUNET_SERVER_Client *client,
2128 const struct GNUNET_MessageHeader *message)
2130 struct Plugin *plugin = cls;
2131 struct Session *session;
2132 const struct TCP_NAT_ProbeMessage *tcp_nat_probe;
2135 struct IPv4TcpAddress *t4;
2136 struct IPv6TcpAddress *t6;
2137 const struct sockaddr_in *s4;
2138 const struct sockaddr_in6 *s6;
2140 LOG (GNUNET_ERROR_TYPE_DEBUG,
2141 "Received NAT probe\n");
2142 /* We have received a TCP NAT probe, meaning we (hopefully) initiated
2143 * a connection to this peer by running gnunet-nat-client. This peer
2144 * received the punch message and now wants us to use the new connection
2145 * as the default for that peer. Do so and then send a WELCOME message
2146 * so we can really be connected!
2148 if (ntohs (message->size) != sizeof(struct TCP_NAT_ProbeMessage))
2151 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2155 tcp_nat_probe = (const struct TCP_NAT_ProbeMessage *) message;
2156 if (0 == memcmp (&tcp_nat_probe->clientIdentity, plugin->env->my_identity,
2157 sizeof(struct GNUNET_PeerIdentity)))
2159 /* refuse connections from ourselves */
2160 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2164 session = GNUNET_CONTAINER_multipeermap_get (plugin->nat_wait_conns,
2165 &tcp_nat_probe->clientIdentity);
2166 if (session == NULL)
2168 LOG (GNUNET_ERROR_TYPE_DEBUG,
2169 "Did NOT find session for NAT probe!\n");
2170 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2173 LOG (GNUNET_ERROR_TYPE_DEBUG,
2174 "Found session for NAT probe!\n");
2176 if (session->nat_connection_timeout != NULL)
2178 GNUNET_SCHEDULER_cancel (session->nat_connection_timeout);
2179 session->nat_connection_timeout = NULL;
2182 if (GNUNET_OK != GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2185 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2186 tcp_plugin_disconnect_session (plugin,
2191 GNUNET_CONTAINER_multipeermap_remove (plugin->nat_wait_conns, &tcp_nat_probe->clientIdentity, session) == GNUNET_YES);
2192 GNUNET_SERVER_client_set_user_context(client, session);
2193 GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap, &session->target,
2194 session, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2195 session->last_activity = GNUNET_TIME_absolute_get ();
2196 LOG (GNUNET_ERROR_TYPE_DEBUG,
2197 "Found address `%s' for incoming connection\n",
2198 GNUNET_a2s (vaddr, alen));
2199 switch (((const struct sockaddr *) vaddr)->sa_family)
2203 t4 = GNUNET_new (struct IPv4TcpAddress);
2204 t4->options = htonl (TCP_OPTIONS_NONE);
2205 t4->t4_port = s4->sin_port;
2206 t4->ipv4_addr = s4->sin_addr.s_addr;
2207 session->address = GNUNET_HELLO_address_allocate (&tcp_nat_probe->clientIdentity,
2210 sizeof(struct IPv4TcpAddress),
2211 GNUNET_HELLO_ADDRESS_INFO_NONE);
2215 t6 = GNUNET_new (struct IPv6TcpAddress);
2216 t6->options = htonl (TCP_OPTIONS_NONE);
2217 t6->t6_port = s6->sin6_port;
2218 memcpy (&t6->ipv6_addr, &s6->sin6_addr, sizeof(struct in6_addr));
2219 session->address = GNUNET_HELLO_address_allocate (&tcp_nat_probe->clientIdentity,
2222 sizeof(struct IPv6TcpAddress),
2223 GNUNET_HELLO_ADDRESS_INFO_NONE);
2227 LOG(GNUNET_ERROR_TYPE_DEBUG,
2228 "Bad address for incoming connection!\n");
2230 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2231 tcp_plugin_disconnect_session (plugin,
2236 GNUNET_break(NULL == session->client);
2237 GNUNET_SERVER_client_keep (client);
2238 session->client = client;
2239 GNUNET_STATISTICS_update (plugin->env->stats,
2240 gettext_noop ("# TCP sessions active"), 1, GNUNET_NO);
2241 process_pending_messages (session);
2242 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2246 * We've received a welcome from this peer via TCP. Possibly create a
2247 * fresh client record and send back our welcome.
2249 * @param cls closure
2250 * @param client identification of the client
2251 * @param message the actual message
2254 handle_tcp_welcome (void *cls,
2255 struct GNUNET_SERVER_Client *client,
2256 const struct GNUNET_MessageHeader *message)
2258 struct Plugin *plugin = cls;
2259 const struct WelcomeMessage *wm = (const struct WelcomeMessage *) message;
2260 struct GNUNET_HELLO_Address *address;
2261 struct Session *session;
2264 struct IPv4TcpAddress t4;
2265 struct IPv6TcpAddress t6;
2266 const struct sockaddr_in *s4;
2267 const struct sockaddr_in6 *s6;
2268 struct GNUNET_ATS_Information ats;
2271 if (0 == memcmp (&wm->clientIdentity,
2272 plugin->env->my_identity,
2273 sizeof(struct GNUNET_PeerIdentity)))
2275 /* refuse connections from ourselves */
2276 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2277 if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2279 LOG (GNUNET_ERROR_TYPE_INFO,
2280 "Received %s message from my own identity `%4s' on address `%s'\n",
2281 "WELCOME", GNUNET_i2s (&wm->clientIdentity),
2282 GNUNET_a2s (vaddr, alen));
2288 LOG(GNUNET_ERROR_TYPE_DEBUG,
2289 "Received %s message from `%4s' %p\n",
2291 GNUNET_i2s (&wm->clientIdentity), client);
2292 GNUNET_STATISTICS_update (plugin->env->stats,
2293 gettext_noop ("# TCP WELCOME messages received"),
2296 session = lookup_session_by_client (plugin, client);
2297 if (NULL != session)
2299 if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2301 LOG (GNUNET_ERROR_TYPE_DEBUG,
2302 "Found existing session %p for peer `%s'\n",
2304 GNUNET_a2s (vaddr, alen));
2305 GNUNET_free (vaddr);
2310 GNUNET_SERVER_client_keep (client);
2311 if (NULL != plugin->service) /* Otherwise value is incremented in tcp_access_check */
2312 plugin->cur_connections++;
2313 if (plugin->cur_connections == plugin->max_connections)
2314 GNUNET_SERVER_suspend (plugin->server); /* Maximum number of connections rechead */
2316 if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2318 if (alen == sizeof(struct sockaddr_in))
2321 memset (&t4, '\0', sizeof (t4));
2322 t4.options = htonl (TCP_OPTIONS_NONE);
2323 t4.t4_port = s4->sin_port;
2324 t4.ipv4_addr = s4->sin_addr.s_addr;
2325 address = GNUNET_HELLO_address_allocate (&wm->clientIdentity,
2329 GNUNET_HELLO_ADDRESS_INFO_INBOUND);
2331 else if (alen == sizeof(struct sockaddr_in6))
2334 memset (&t6, '\0', sizeof (t6));
2335 t6.options = htonl (TCP_OPTIONS_NONE);
2336 t6.t6_port = s6->sin6_port;
2337 memcpy (&t6.ipv6_addr, &s6->sin6_addr, sizeof(struct in6_addr));
2338 address = GNUNET_HELLO_address_allocate (&wm->clientIdentity,
2339 PLUGIN_NAME, &t6, sizeof (t6),
2340 GNUNET_HELLO_ADDRESS_INFO_INBOUND);
2345 GNUNET_free_non_null (vaddr);
2348 session = create_session (plugin, address, client, GNUNET_NO);
2349 GNUNET_HELLO_address_free (address);
2350 session->ats_address_network_type = plugin->env->get_address_type (plugin->env->cls, vaddr, alen);
2351 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
2352 ats.value = htonl (session->ats_address_network_type);
2353 LOG (GNUNET_ERROR_TYPE_DEBUG,
2354 "Creating new%s session %p for peer `%s' client %p \n",
2355 GNUNET_HELLO_address_check_option (session->address,
2356 GNUNET_HELLO_ADDRESS_INFO_INBOUND)
2359 tcp_plugin_address_to_string (plugin,
2360 session->address->address,
2361 session->address->address_length),
2363 GNUNET_free (vaddr);
2364 GNUNET_SERVER_client_set_user_context (session->client, session);
2365 GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap,
2368 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2369 /* Notify transport and ATS about new session */
2370 plugin->env->session_start (plugin->env->cls,
2374 notify_session_monitor (plugin,
2376 GNUNET_TRANSPORT_SS_INIT);
2380 LOG(GNUNET_ERROR_TYPE_DEBUG,
2381 "Did not obtain TCP socket address for incoming connection\n");
2387 if (session->expecting_welcome != GNUNET_YES)
2390 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2394 session->last_activity = GNUNET_TIME_absolute_get ();
2395 session->expecting_welcome = GNUNET_NO;
2397 process_pending_messages (session);
2398 GNUNET_SERVER_client_set_timeout (client,
2399 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2400 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2405 * We've received data for this peer via TCP. Unbox,
2406 * compute latency and forward.
2408 * @param cls closure
2409 * @param client identification of the client
2410 * @param message the actual message
2413 handle_tcp_data (void *cls,
2414 struct GNUNET_SERVER_Client *client,
2415 const struct GNUNET_MessageHeader *message)
2417 struct Plugin *plugin = cls;
2418 struct Session *session;
2419 struct GNUNET_TIME_Relative delay;
2422 type = ntohs (message->type);
2423 if ((GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME == type)
2424 || (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE == type))
2426 /* We don't want to propagate WELCOME and NAT Probe messages up! */
2427 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2430 session = lookup_session_by_client (plugin, client);
2431 if (NULL == session)
2433 /* No inbound session found */
2437 GNUNET_SERVER_client_get_address (client, &vaddr, &alen);
2438 LOG(GNUNET_ERROR_TYPE_ERROR,
2439 "Received unexpected %u bytes of type %u from `%s'\n",
2440 (unsigned int) ntohs (message->size),
2441 (unsigned int) ntohs (message->type), GNUNET_a2s (vaddr, alen));
2443 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2444 GNUNET_free_non_null(vaddr);
2447 else if (GNUNET_YES == session->expecting_welcome)
2449 /* Session is expecting WELCOME message */
2453 GNUNET_SERVER_client_get_address (client, &vaddr, &alen);
2454 LOG(GNUNET_ERROR_TYPE_ERROR,
2455 "Received unexpected %u bytes of type %u from `%s'\n",
2456 (unsigned int) ntohs (message->size),
2457 (unsigned int) ntohs (message->type), GNUNET_a2s (vaddr, alen));
2459 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2460 GNUNET_free_non_null(vaddr);
2464 session->last_activity = GNUNET_TIME_absolute_get ();
2465 LOG(GNUNET_ERROR_TYPE_DEBUG,
2466 "Passing %u bytes of type %u from `%4s' to transport service.\n",
2467 (unsigned int) ntohs (message->size),
2468 (unsigned int) ntohs (message->type), GNUNET_i2s (&session->target));
2470 GNUNET_STATISTICS_update (plugin->env->stats,
2471 gettext_noop ("# bytes received via TCP"), ntohs (message->size),
2473 struct GNUNET_ATS_Information distance;
2475 distance.type = htonl (GNUNET_ATS_NETWORK_TYPE);
2476 distance.value = htonl ((uint32_t) session->ats_address_network_type);
2477 GNUNET_break(session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
2479 GNUNET_assert(GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessionmap,
2483 delay = plugin->env->receive (plugin->env->cls,
2487 plugin->env->update_address_metrics (plugin->env->cls,
2491 reschedule_session_timeout (session);
2492 if (0 == delay.rel_value_us)
2494 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2498 LOG(GNUNET_ERROR_TYPE_DEBUG,
2499 "Throttling receiving from `%s' for %s\n",
2500 GNUNET_i2s (&session->target),
2501 GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
2502 GNUNET_SERVER_disable_receive_done_warning (client);
2503 session->receive_delay_task = GNUNET_SCHEDULER_add_delayed (delay,
2504 &delayed_done, session);
2510 * Functions with this signature are called whenever a peer
2511 * is disconnected on the network level.
2513 * @param cls closure
2514 * @param client identification of the client
2517 disconnect_notify (void *cls,
2518 struct GNUNET_SERVER_Client *client)
2520 struct Plugin *plugin = cls;
2521 struct Session *session;
2525 session = lookup_session_by_client (plugin, client);
2526 if (NULL == session)
2527 return; /* unknown, nothing to do */
2528 LOG (GNUNET_ERROR_TYPE_DEBUG,
2529 "Destroying session of `%4s' with %s due to network-level disconnect.\n",
2530 GNUNET_i2s (&session->target),
2531 tcp_plugin_address_to_string (session->plugin,
2532 session->address->address,
2533 session->address->address_length));
2535 if (plugin->cur_connections == plugin->max_connections)
2536 GNUNET_SERVER_resume (plugin->server); /* Resume server */
2538 if (plugin->cur_connections < 1)
2541 plugin->cur_connections--;
2543 GNUNET_STATISTICS_update (session->plugin->env->stats, gettext_noop
2544 ("# network-level TCP disconnect events"),
2547 tcp_plugin_disconnect_session (plugin, session);
2552 * We can now send a probe message, copy into buffer to really send.
2554 * @param cls closure, a struct TCPProbeContext
2555 * @param size max size to copy
2556 * @param buf buffer to copy message to
2557 * @return number of bytes copied into @a buf
2560 notify_send_probe (void *cls,
2564 struct TCPProbeContext *tcp_probe_ctx = cls;
2565 struct Plugin *plugin = tcp_probe_ctx->plugin;
2568 tcp_probe_ctx->transmit_handle = NULL;
2569 GNUNET_CONTAINER_DLL_remove (plugin->probe_head,
2574 GNUNET_CONNECTION_destroy (tcp_probe_ctx->sock);
2575 GNUNET_free(tcp_probe_ctx);
2578 GNUNET_assert(size >= sizeof(tcp_probe_ctx->message));
2579 memcpy (buf, &tcp_probe_ctx->message, sizeof(tcp_probe_ctx->message));
2580 GNUNET_SERVER_connect_socket (tcp_probe_ctx->plugin->server,
2581 tcp_probe_ctx->sock);
2582 ret = sizeof(tcp_probe_ctx->message);
2583 GNUNET_free(tcp_probe_ctx);
2589 * Function called by the NAT subsystem suggesting another peer wants
2590 * to connect to us via connection reversal. Try to connect back to the
2593 * @param cls closure
2594 * @param addr address to try
2595 * @param addrlen number of bytes in @a addr
2598 try_connection_reversal (void *cls,
2599 const struct sockaddr *addr,
2602 struct Plugin *plugin = cls;
2603 struct GNUNET_CONNECTION_Handle *sock;
2604 struct TCPProbeContext *tcp_probe_ctx;
2607 * We have received an ICMP response, ostensibly from a peer
2608 * that wants to connect to us! Send a message to establish a connection.
2610 sock = GNUNET_CONNECTION_create_from_sockaddr (AF_INET, addr, addrlen);
2613 /* failed for some odd reason (out of sockets?); ignore attempt */
2617 tcp_probe_ctx = GNUNET_new (struct TCPProbeContext);
2618 tcp_probe_ctx->message.header.size
2619 = htons (sizeof (struct TCP_NAT_ProbeMessage));
2620 tcp_probe_ctx->message.header.type
2621 = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE);
2622 tcp_probe_ctx->message.clientIdentity
2623 = *plugin->env->my_identity;
2624 tcp_probe_ctx->plugin = plugin;
2625 tcp_probe_ctx->sock = sock;
2626 GNUNET_CONTAINER_DLL_insert (plugin->probe_head,
2629 tcp_probe_ctx->transmit_handle
2630 = GNUNET_CONNECTION_notify_transmit_ready (sock,
2631 ntohs (tcp_probe_ctx->message.header.size),
2632 GNUNET_TIME_UNIT_FOREVER_REL,
2639 * Function obtain the network type for a session
2641 * @param cls closure ('struct Plugin*')
2642 * @param session the session
2643 * @return the network type in HBO or #GNUNET_SYSERR
2645 static enum GNUNET_ATS_Network_Type
2646 tcp_plugin_get_network (void *cls,
2647 struct Session *session)
2649 return session->ats_address_network_type;
2654 * Return information about the given session to the
2657 * @param cls the `struct Plugin` with the monitor callback (`sic`)
2658 * @param peer peer we send information about
2659 * @param value our `struct Session` to send information about
2660 * @return #GNUNET_OK (continue to iterate)
2663 send_session_info_iter (void *cls,
2664 const struct GNUNET_PeerIdentity *peer,
2667 struct Plugin *plugin = cls;
2668 struct Session *session = value;
2670 notify_session_monitor (plugin,
2672 GNUNET_TRANSPORT_SS_INIT);
2673 /* FIXME: cannot tell if this is up or not from current
2675 notify_session_monitor (plugin,
2677 GNUNET_TRANSPORT_SS_UP);
2683 * Begin monitoring sessions of a plugin. There can only
2684 * be one active monitor per plugin (i.e. if there are
2685 * multiple monitors, the transport service needs to
2686 * multiplex the generated events over all of them).
2688 * @param cls closure of the plugin
2689 * @param sic callback to invoke, NULL to disable monitor;
2690 * plugin will being by iterating over all active
2691 * sessions immediately and then enter monitor mode
2692 * @param sic_cls closure for @a sic
2695 tcp_plugin_setup_monitor (void *cls,
2696 GNUNET_TRANSPORT_SessionInfoCallback sic,
2699 struct Plugin *plugin = cls;
2702 plugin->sic_cls = sic_cls;
2705 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
2706 &send_session_info_iter,
2708 /* signal end of first iteration */
2709 sic (sic_cls, NULL, NULL);
2715 * Entry point for the plugin.
2717 * @param cls closure, the `struct GNUNET_TRANSPORT_PluginEnvironment *`
2718 * @return the `struct GNUNET_TRANSPORT_PluginFunctions *` or NULL on error
2721 libgnunet_plugin_transport_tcp_init (void *cls)
2723 static const struct GNUNET_SERVER_MessageHandler my_handlers[] = {
2724 { &handle_tcp_welcome, NULL,
2725 GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME, sizeof(struct WelcomeMessage) },
2726 { &handle_tcp_nat_probe, NULL,
2727 GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE, sizeof(struct TCP_NAT_ProbeMessage) },
2728 { &handle_tcp_data, NULL,
2729 GNUNET_MESSAGE_TYPE_ALL, 0 },
2730 { NULL, NULL, 0, 0 }
2732 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
2733 struct GNUNET_TRANSPORT_PluginFunctions *api;
2734 struct Plugin *plugin;
2735 struct GNUNET_SERVICE_Context *service;
2736 unsigned long long aport;
2737 unsigned long long bport;
2738 unsigned long long max_connections;
2740 struct GNUNET_TIME_Relative idle_timeout;
2742 struct GNUNET_NETWORK_Handle *const*lsocks;
2746 struct sockaddr **addrs;
2747 socklen_t *addrlens;
2749 if (NULL == env->receive)
2751 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
2752 initialze the plugin or the API */
2753 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2755 api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2756 api->address_to_string = &tcp_plugin_address_to_string;
2757 api->string_to_address = &tcp_plugin_string_to_address;
2761 GNUNET_assert (NULL != env->cfg);
2763 GNUNET_CONFIGURATION_get_value_number (env->cfg,
2767 max_connections = 128;
2771 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2775 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2776 "ADVERTISED-PORT", &aport)) &&
2779 LOG(GNUNET_ERROR_TYPE_ERROR,
2780 _("Require valid port number for service `%s' in configuration!\n"),
2790 service = GNUNET_SERVICE_start ("transport-tcp",
2792 GNUNET_SERVICE_OPTION_NONE);
2793 if (NULL == service)
2795 LOG (GNUNET_ERROR_TYPE_WARNING,
2796 _("Failed to start service.\n"));
2804 plugin = GNUNET_new (struct Plugin);
2805 plugin->sessionmap = GNUNET_CONTAINER_multipeermap_create (max_connections,
2807 plugin->max_connections = max_connections;
2808 plugin->open_port = bport;
2809 plugin->adv_port = aport;
2811 plugin->my_welcome.header.size = htons (sizeof(struct WelcomeMessage));
2812 plugin->my_welcome.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME);
2813 plugin->my_welcome.clientIdentity = *plugin->env->my_identity;
2815 if ( (NULL != service) &&
2817 GNUNET_CONFIGURATION_get_value_yesno (env->cfg,
2822 plugin->myoptions |= TCP_OPTIONS_TCP_STEALTH;
2823 lsocks = GNUNET_SERVICE_get_listen_sockets (service);
2826 uint32_t len = sizeof (struct WelcomeMessage);
2828 for (i=0;NULL!=lsocks[i];i++)
2831 GNUNET_NETWORK_socket_setsockopt (lsocks[i],
2835 sizeof (struct GNUNET_PeerIdentity))) ||
2837 GNUNET_NETWORK_socket_setsockopt (lsocks[i],
2839 TCP_STEALTH_INTEGRITY_LEN,
2843 /* TCP STEALTH not supported by kernel */
2844 GNUNET_assert (0 == i);
2845 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2846 _("TCP_STEALTH not supported on this platform.\n"));
2852 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2853 _("TCP_STEALTH not supported on this platform.\n"));
2858 if ( (NULL != service) &&
2861 GNUNET_SERVICE_get_server_addresses ("transport-tcp",
2866 for (ret = ret_s-1; ret >= 0; ret--)
2867 LOG (GNUNET_ERROR_TYPE_INFO,
2868 "Binding to address `%s'\n",
2869 GNUNET_a2s (addrs[ret], addrlens[ret]));
2871 = GNUNET_NAT_register (env->cfg,
2874 (unsigned int) ret_s,
2875 (const struct sockaddr **) addrs, addrlens,
2876 &tcp_nat_port_map_callback,
2877 &try_connection_reversal,
2879 for (ret = ret_s -1; ret >= 0; ret--)
2880 GNUNET_free (addrs[ret]);
2881 GNUNET_free_non_null (addrs);
2882 GNUNET_free_non_null (addrlens);
2886 plugin->nat = GNUNET_NAT_register (plugin->env->cfg,
2893 &try_connection_reversal,
2896 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2898 api->send = &tcp_plugin_send;
2899 api->get_session = &tcp_plugin_get_session;
2900 api->disconnect_session = &tcp_plugin_disconnect_session;
2901 api->query_keepalive_factor = &tcp_plugin_query_keepalive_factor;
2902 api->disconnect_peer = &tcp_plugin_disconnect;
2903 api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2904 api->check_address = &tcp_plugin_check_address;
2905 api->address_to_string = &tcp_plugin_address_to_string;
2906 api->string_to_address = &tcp_plugin_string_to_address;
2907 api->get_network = &tcp_plugin_get_network;
2908 api->update_session_timeout = &tcp_plugin_update_session_timeout;
2909 api->update_inbound_delay = &tcp_plugin_update_inbound_delay;
2910 api->setup_monitor = &tcp_plugin_setup_monitor;
2911 plugin->service = service;
2912 if (NULL != service)
2914 plugin->server = GNUNET_SERVICE_get_server (service);
2919 GNUNET_CONFIGURATION_get_value_time (env->cfg,
2924 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2930 = GNUNET_SERVER_create_with_sockets (&plugin_tcp_access_check,
2932 idle_timeout, GNUNET_YES);
2934 plugin->handlers = GNUNET_malloc (sizeof (my_handlers));
2935 memcpy (plugin->handlers, my_handlers, sizeof(my_handlers));
2936 for (i = 0;i < sizeof(my_handlers) / sizeof(struct GNUNET_SERVER_MessageHandler);i++)
2937 plugin->handlers[i].callback_cls = plugin;
2939 GNUNET_SERVER_add_handlers (plugin->server, plugin->handlers);
2940 GNUNET_SERVER_disconnect_notify (plugin->server, &disconnect_notify, plugin);
2941 plugin->nat_wait_conns = GNUNET_CONTAINER_multipeermap_create (16,
2944 LOG (GNUNET_ERROR_TYPE_INFO,
2945 _("TCP transport listening on port %llu\n"),
2948 LOG (GNUNET_ERROR_TYPE_INFO,
2949 _("TCP transport not listening on any port (client only)\n"));
2950 if ( (aport != bport) &&
2952 LOG (GNUNET_ERROR_TYPE_INFO,
2953 _("TCP transport advertises itself as being on port %llu\n"),
2955 /* Initially set connections to 0 */
2956 GNUNET_assert(NULL != plugin->env->stats);
2957 GNUNET_STATISTICS_set (plugin->env->stats,
2958 gettext_noop ("# TCP sessions active"),
2964 if (NULL != plugin->nat)
2965 GNUNET_NAT_unregister (plugin->nat);
2966 GNUNET_CONTAINER_multipeermap_destroy (plugin->sessionmap);
2967 if (NULL != service)
2968 GNUNET_SERVICE_stop (service);
2969 GNUNET_free (plugin);
2970 GNUNET_free_non_null (api);
2976 * Exit point from the plugin.
2978 * @param cls the `struct GNUNET_TRANSPORT_PluginFunctions`
2982 libgnunet_plugin_transport_tcp_done (void *cls)
2984 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
2985 struct Plugin *plugin = api->cls;
2986 struct TCPProbeContext *tcp_probe;
2987 struct PrettyPrinterContext *cur;
2988 struct PrettyPrinterContext *next;
2995 LOG (GNUNET_ERROR_TYPE_DEBUG,
2996 "Shutting down TCP plugin\n");
2998 /* Removing leftover sessions */
2999 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
3000 &session_disconnect_it,
3002 /* Removing leftover NAT sessions */
3003 GNUNET_CONTAINER_multipeermap_iterate (plugin->nat_wait_conns,
3004 &session_disconnect_it,
3007 for (cur = ppc_dll_head; NULL != cur; cur = next)
3010 GNUNET_CONTAINER_DLL_remove (ppc_dll_head,
3013 GNUNET_RESOLVER_request_cancel (cur->resolver_handle);
3014 cur->asc (cur->asc_cls, NULL, GNUNET_OK);
3018 if (NULL != plugin->service)
3019 GNUNET_SERVICE_stop (plugin->service);
3021 GNUNET_SERVER_destroy (plugin->server);
3022 GNUNET_free(plugin->handlers);
3023 if (NULL != plugin->nat)
3024 GNUNET_NAT_unregister (plugin->nat);
3025 while (NULL != (tcp_probe = plugin->probe_head))
3027 GNUNET_CONTAINER_DLL_remove (plugin->probe_head,
3030 GNUNET_CONNECTION_destroy (tcp_probe->sock);
3031 GNUNET_free(tcp_probe);
3033 GNUNET_CONTAINER_multipeermap_destroy (plugin->nat_wait_conns);
3034 GNUNET_CONTAINER_multipeermap_destroy (plugin->sessionmap);
3035 GNUNET_free(plugin);
3040 /* end of plugin_transport_tcp.c */