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.
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, "NAT notification to %s address `%s'\n",
563 (GNUNET_YES == add_remove) ? "add" : "remove",
564 GNUNET_a2s (addr, addrlen));
565 /* convert 'addr' to our internal format */
566 switch (addr->sa_family)
569 GNUNET_assert(addrlen == sizeof(struct sockaddr_in));
570 memset (&t4, 0, sizeof(t4));
571 t4.options = htonl (plugin->myoptions);
572 t4.ipv4_addr = ((struct sockaddr_in *) addr)->sin_addr.s_addr;
573 t4.t4_port = ((struct sockaddr_in *) addr)->sin_port;
578 GNUNET_assert(addrlen == sizeof(struct sockaddr_in6));
579 memset (&t6, 0, sizeof(t6));
580 memcpy (&t6.ipv6_addr, &((struct sockaddr_in6 *) addr)->sin6_addr,
581 sizeof(struct in6_addr));
582 t6.options = htonl (plugin->myoptions);
583 t6.t6_port = ((struct sockaddr_in6 *) addr)->sin6_port;
591 /* modify our published address list */
592 GNUNET_assert ((args == sizeof (struct IPv4TcpAddress)) ||
593 (args == sizeof (struct IPv6TcpAddress)));
594 address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
595 PLUGIN_NAME, arg, args, GNUNET_HELLO_ADDRESS_INFO_NONE);
596 plugin->env->notify_address (plugin->env->cls, add_remove, address);
597 GNUNET_HELLO_address_free(address);
602 * Function called for a quick conversion of the binary address to
603 * a numeric address. Note that the caller must not free the
604 * address and that the next call to this function is allowed
605 * to override the address again.
607 * @param cls closure (`struct Plugin*`)
608 * @param addr binary address
609 * @param addrlen length of @a addr
610 * @return string representing the same address
613 tcp_plugin_address_to_string (void *cls,
617 static char rbuf[INET6_ADDRSTRLEN + 12];
618 char buf[INET6_ADDRSTRLEN];
622 const struct IPv4TcpAddress *t4;
623 const struct IPv6TcpAddress *t6;
630 case sizeof(struct IPv6TcpAddress):
633 port = ntohs (t6->t6_port);
634 options = ntohl (t6->options);
635 memcpy (&a6, &t6->ipv6_addr, sizeof(a6));
638 case sizeof(struct IPv4TcpAddress):
641 port = ntohs (t4->t4_port);
642 options = ntohl (t4->options);
643 memcpy (&a4, &t4->ipv4_addr, sizeof(a4));
647 LOG (GNUNET_ERROR_TYPE_WARNING,
648 _("Unexpected address length: %u bytes\n"),
649 (unsigned int) addrlen);
652 if (NULL == inet_ntop (af, sb, buf, INET6_ADDRSTRLEN))
654 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
658 GNUNET_snprintf (rbuf, sizeof(rbuf),
659 (af == AF_INET6) ? "%s.%u.[%s]:%u" : "%s.%u.%s:%u",
669 * Function called to convert a string address to
672 * @param cls closure (`struct Plugin*`)
673 * @param addr string address
674 * @param addrlen length of the address
675 * @param buf location to store the buffer
676 * @param added location to store the number of bytes in the buffer.
677 * If the function returns #GNUNET_SYSERR, its contents are undefined.
678 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
681 tcp_plugin_string_to_address (void *cls,
687 struct sockaddr_storage socket_address;
693 /* Format tcp.options.address:port */
697 if ((NULL == addr) || (addrlen == 0))
700 return GNUNET_SYSERR;
702 if ('\0' != addr[addrlen - 1])
705 return GNUNET_SYSERR;
707 if (strlen (addr) != addrlen - 1)
710 return GNUNET_SYSERR;
712 plugin = GNUNET_strdup (addr);
713 optionstr = strchr (plugin, '.');
714 if (NULL == optionstr)
718 return GNUNET_SYSERR;
722 options = atol (optionstr);
723 address = strchr (optionstr, '.');
728 return GNUNET_SYSERR;
734 != GNUNET_STRINGS_to_address_ip (address, strlen (address),
739 return GNUNET_SYSERR;
743 switch (socket_address.ss_family)
747 struct IPv4TcpAddress *t4;
748 struct sockaddr_in *in4 = (struct sockaddr_in *) &socket_address;
749 t4 = GNUNET_new (struct IPv4TcpAddress);
750 t4->options = htonl (options);
751 t4->ipv4_addr = in4->sin_addr.s_addr;
752 t4->t4_port = in4->sin_port;
754 *added = sizeof(struct IPv4TcpAddress);
759 struct IPv6TcpAddress *t6;
760 struct sockaddr_in6 *in6 = (struct sockaddr_in6 *) &socket_address;
761 t6 = GNUNET_new (struct IPv6TcpAddress);
762 t6->options = htonl (options);
763 t6->ipv6_addr = in6->sin6_addr;
764 t6->t6_port = in6->sin6_port;
766 *added = sizeof(struct IPv6TcpAddress);
770 return GNUNET_SYSERR;
776 * Find the session handle for the given client.
777 * Currently uses both the hashmap and the client
778 * context, as the client context is new and the
779 * logic still needs to be tested.
781 * @param plugin the plugin
782 * @param client which client to find the session handle for
783 * @return NULL if no matching session exists
785 static struct Session *
786 lookup_session_by_client (struct Plugin *plugin,
787 struct GNUNET_SERVER_Client *client)
789 return GNUNET_SERVER_client_get_user_context (client, struct Session);
794 * Functions with this signature are called whenever we need
795 * to close a session due to a disconnect or failure to
796 * establish a connection.
798 * @param cls the `struct Plugin`
799 * @param session session to close down
800 * @return #GNUNET_OK on success
803 tcp_plugin_disconnect_session (void *cls,
804 struct Session *session)
806 struct Plugin *plugin = cls;
807 struct PendingMessage *pm;
809 LOG (GNUNET_ERROR_TYPE_DEBUG,
810 "Disconnecting session of peer `%s' address `%s'\n",
811 GNUNET_i2s (&session->target),
812 tcp_plugin_address_to_string (NULL,
813 session->address->address,
814 session->address->address_length));
816 if (NULL != session->timeout_task)
818 GNUNET_SCHEDULER_cancel (session->timeout_task);
819 session->timeout_task = NULL;
820 session->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
824 GNUNET_CONTAINER_multipeermap_remove (plugin->sessionmap,
828 GNUNET_STATISTICS_update (session->plugin->env->stats,
829 gettext_noop ("# TCP sessions active"), -1, GNUNET_NO);
833 GNUNET_assert(GNUNET_YES ==
834 GNUNET_CONTAINER_multipeermap_remove (plugin->nat_wait_conns,
838 if (NULL != session->client)
839 GNUNET_SERVER_client_set_user_context (session->client,
843 if (NULL != session->transmit_handle)
845 GNUNET_SERVER_notify_transmit_ready_cancel (session->transmit_handle);
846 session->transmit_handle = NULL;
848 plugin->env->unregister_quota_notification (plugin->env->cls,
852 session->plugin->env->session_end (session->plugin->env->cls,
856 if (NULL != session->nat_connection_timeout)
858 GNUNET_SCHEDULER_cancel (session->nat_connection_timeout);
859 session->nat_connection_timeout = NULL;
862 while (NULL != (pm = session->pending_messages_head))
864 LOG (GNUNET_ERROR_TYPE_DEBUG,
865 (NULL != pm->transmit_cont)
866 ? "Could not deliver message to `%4s'.\n"
867 : "Could not deliver message to `%4s', notifying.\n",
868 GNUNET_i2s (&session->target));
869 GNUNET_STATISTICS_update (session->plugin->env->stats,
870 gettext_noop ("# bytes currently in TCP buffers"),
871 -(int64_t) pm->message_size, GNUNET_NO);
872 GNUNET_STATISTICS_update (session->plugin->env->stats,
873 gettext_noop ("# bytes discarded by TCP (disconnect)"),
876 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
877 session->pending_messages_tail,
879 GNUNET_assert (0 < session->msgs_in_queue);
880 session->msgs_in_queue--;
881 GNUNET_assert (pm->message_size <= session->bytes_in_queue);
882 session->bytes_in_queue -= pm->message_size;
883 if (NULL != pm->transmit_cont)
884 pm->transmit_cont (pm->transmit_cont_cls,
891 GNUNET_assert (0 == session->msgs_in_queue);
892 GNUNET_assert (0 == session->bytes_in_queue);
893 notify_session_monitor (session->plugin,
895 GNUNET_TRANSPORT_SS_DONE);
897 if (session->receive_delay_task != NULL)
899 GNUNET_SCHEDULER_cancel (session->receive_delay_task);
900 if (NULL != session->client)
901 GNUNET_SERVER_receive_done (session->client, GNUNET_SYSERR);
903 if (NULL != session->client)
905 GNUNET_SERVER_client_disconnect (session->client);
906 GNUNET_SERVER_client_drop (session->client);
907 session->client = NULL;
909 GNUNET_HELLO_address_free (session->address);
910 GNUNET_assert(NULL == session->transmit_handle);
911 GNUNET_free(session);
917 * Function that is called to get the keepalive factor.
918 * #GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
919 * calculate the interval between keepalive packets.
921 * @param cls closure with the `struct Plugin`
922 * @return keepalive factor
925 tcp_plugin_query_keepalive_factor (void *cls)
932 * Session was idle, so disconnect it
934 * @param cls the `struct Session` of the idle session
935 * @param tc scheduler context
938 session_timeout (void *cls,
939 const struct GNUNET_SCHEDULER_TaskContext *tc)
941 struct Session *s = cls;
942 struct GNUNET_TIME_Relative left;
944 s->timeout_task = NULL;
945 left = GNUNET_TIME_absolute_get_remaining (s->timeout);
946 if (0 != left.rel_value_us)
948 /* not actually our turn yet, but let's at least update
949 the monitor, it may think we're about to die ... */
950 notify_session_monitor (s->plugin,
952 GNUNET_TRANSPORT_SS_UPDATE);
953 s->timeout_task = GNUNET_SCHEDULER_add_delayed (left,
958 LOG (GNUNET_ERROR_TYPE_DEBUG,
959 "Session %p was idle for %s, disconnecting\n",
961 GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
963 /* call session destroy function */
964 tcp_plugin_disconnect_session (s->plugin, s);
969 * Increment session timeout due to activity
971 * @param s session to increment timeout for
974 reschedule_session_timeout (struct Session *s)
976 GNUNET_assert(NULL != s->timeout_task);
977 s->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
982 * Create a new session. Also queues a welcome message.
984 * @param plugin the plugin
985 * @param address the address to create the session for
986 * @param client client to use, reference counter must have already been increased
987 * @param is_nat this a NAT session, we should wait for a client to
988 * connect to us from an address, then assign that to
990 * @return new session object
992 static struct Session *
993 create_session (struct Plugin *plugin,
994 const struct GNUNET_HELLO_Address *address,
995 struct GNUNET_SERVER_Client *client,
998 struct Session *session;
999 struct PendingMessage *pm;
1001 if (GNUNET_YES != is_nat)
1002 GNUNET_assert (NULL != client);
1004 GNUNET_assert (NULL == client);
1006 LOG (GNUNET_ERROR_TYPE_DEBUG,
1007 "Creating new session for peer `%4s'\n",
1008 GNUNET_i2s (&address->peer));
1009 session = GNUNET_new (struct Session);
1010 session->last_activity = GNUNET_TIME_absolute_get ();
1011 session->plugin = plugin;
1012 session->is_nat = is_nat;
1013 session->client = client;
1014 session->address = GNUNET_HELLO_address_copy (address);
1015 session->target = address->peer;
1016 session->expecting_welcome = GNUNET_YES;
1017 session->ats_address_network_type = GNUNET_ATS_NET_UNSPECIFIED;
1018 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
1019 sizeof (struct WelcomeMessage));
1020 pm->msg = (const char *) &pm[1];
1021 pm->message_size = sizeof(struct WelcomeMessage);
1023 &plugin->my_welcome,
1024 sizeof(struct WelcomeMessage));
1025 pm->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1026 GNUNET_STATISTICS_update (plugin->env->stats,
1027 gettext_noop ("# bytes currently in TCP buffers"), pm->message_size,
1029 GNUNET_CONTAINER_DLL_insert (session->pending_messages_head,
1030 session->pending_messages_tail,
1032 session->msgs_in_queue++;
1033 session->bytes_in_queue += pm->message_size;
1034 session->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1035 session->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1038 notify_session_monitor (session->plugin,
1040 GNUNET_TRANSPORT_SS_INIT);
1041 if (GNUNET_YES != is_nat)
1043 GNUNET_STATISTICS_update (plugin->env->stats,
1044 gettext_noop ("# TCP sessions active"),
1047 notify_session_monitor (session->plugin,
1049 GNUNET_TRANSPORT_SS_UP);
1053 notify_session_monitor (session->plugin,
1055 GNUNET_TRANSPORT_SS_HANDSHAKE);
1057 plugin->env->register_quota_notification (plugin->env->cls,
1066 * If we have pending messages, ask the server to
1067 * transmit them (schedule the respective tasks, etc.)
1069 * @param session for which session should we do this
1072 process_pending_messages (struct Session *session);
1076 * Function called to notify a client about the socket
1077 * being ready to queue more data. "buf" will be
1078 * NULL and "size" zero if the socket was closed for
1079 * writing in the meantime.
1081 * @param cls closure
1082 * @param size number of bytes available in @a buf
1083 * @param buf where the callee should write the message
1084 * @return number of bytes written to @a buf
1087 do_transmit (void *cls, size_t size, void *buf)
1089 struct Session *session = cls;
1090 struct GNUNET_PeerIdentity pid;
1091 struct Plugin *plugin;
1092 struct PendingMessage *pos;
1093 struct PendingMessage *hd;
1094 struct PendingMessage *tl;
1095 struct GNUNET_TIME_Absolute now;
1099 session->transmit_handle = NULL;
1100 plugin = session->plugin;
1103 LOG (GNUNET_ERROR_TYPE_DEBUG,
1104 "Timeout trying to transmit to peer `%4s', discarding message queue.\n",
1105 GNUNET_i2s (&session->target));
1106 /* timeout; cancel all messages that have already expired */
1110 now = GNUNET_TIME_absolute_get ();
1111 while ((NULL != (pos = session->pending_messages_head))
1112 && (pos->timeout.abs_value_us <= now.abs_value_us))
1114 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
1115 session->pending_messages_tail,
1117 GNUNET_assert (0 < session->msgs_in_queue);
1118 session->msgs_in_queue--;
1119 GNUNET_assert (pos->message_size <= session->bytes_in_queue);
1120 session->bytes_in_queue -= pos->message_size;
1121 LOG (GNUNET_ERROR_TYPE_DEBUG,
1122 "Failed to transmit %u byte message to `%4s'.\n",
1124 GNUNET_i2s (&session->target));
1125 ret += pos->message_size;
1126 GNUNET_CONTAINER_DLL_insert_after (hd, tl, tl, pos);
1128 /* do this call before callbacks (so that if callbacks destroy
1129 * session, they have a chance to cancel actions done by this
1131 process_pending_messages (session);
1132 pid = session->target;
1133 /* no do callbacks and do not use session again since
1134 * the callbacks may abort the session */
1135 while (NULL != (pos = hd))
1137 GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
1138 if (pos->transmit_cont != NULL)
1139 pos->transmit_cont (pos->transmit_cont_cls,
1142 pos->message_size, 0);
1145 GNUNET_STATISTICS_update (plugin->env->stats,
1146 gettext_noop ("# bytes currently in TCP buffers"), -(int64_t) ret,
1148 GNUNET_STATISTICS_update (plugin->env->stats,
1149 gettext_noop ("# bytes discarded by TCP (timeout)"),
1153 notify_session_monitor (session->plugin,
1155 GNUNET_TRANSPORT_SS_UPDATE);
1158 /* copy all pending messages that would fit */
1163 while (NULL != (pos = session->pending_messages_head))
1165 if (ret + pos->message_size > size)
1167 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
1168 session->pending_messages_tail,
1170 GNUNET_assert (0 < session->msgs_in_queue);
1171 session->msgs_in_queue--;
1172 GNUNET_assert (pos->message_size <= session->bytes_in_queue);
1173 session->bytes_in_queue -= pos->message_size;
1174 GNUNET_assert(size >= pos->message_size);
1175 LOG(GNUNET_ERROR_TYPE_DEBUG,
1176 "Transmitting message of type %u size %u\n",
1177 ntohs (((struct GNUNET_MessageHeader *) pos->msg)->type),
1179 /* FIXME: this memcpy can be up to 7% of our total runtime */
1180 memcpy (cbuf, pos->msg, pos->message_size);
1181 cbuf += pos->message_size;
1182 ret += pos->message_size;
1183 size -= pos->message_size;
1184 GNUNET_CONTAINER_DLL_insert_tail (hd, tl, pos);
1186 notify_session_monitor (session->plugin,
1188 GNUNET_TRANSPORT_SS_UPDATE);
1189 /* schedule 'continuation' before callbacks so that callbacks that
1190 * cancel everything don't cause us to use a session that no longer
1192 process_pending_messages (session);
1193 session->last_activity = GNUNET_TIME_absolute_get ();
1194 pid = session->target;
1195 /* we'll now call callbacks that may cancel the session; hence
1196 * we should not use 'session' after this point */
1197 while (NULL != (pos = hd))
1199 GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
1200 if (pos->transmit_cont != NULL)
1201 pos->transmit_cont (pos->transmit_cont_cls,
1205 pos->message_size); /* FIXME: include TCP overhead */
1208 GNUNET_assert (NULL == hd);
1209 GNUNET_assert (NULL == tl);
1210 LOG(GNUNET_ERROR_TYPE_DEBUG,
1211 "Transmitting %u bytes\n",
1213 GNUNET_STATISTICS_update (plugin->env->stats,
1214 gettext_noop ("# bytes currently in TCP buffers"),
1217 GNUNET_STATISTICS_update (plugin->env->stats,
1218 gettext_noop ("# bytes transmitted via TCP"),
1226 * If we have pending messages, ask the server to
1227 * transmit them (schedule the respective tasks, etc.)
1229 * @param session for which session should we do this
1232 process_pending_messages (struct Session *session)
1234 struct PendingMessage *pm;
1236 GNUNET_assert (NULL != session->client);
1237 if (NULL != session->transmit_handle)
1239 if (NULL == (pm = session->pending_messages_head))
1242 session->transmit_handle = GNUNET_SERVER_notify_transmit_ready (session->client,
1244 GNUNET_TIME_absolute_get_remaining (pm->timeout),
1251 * Function that can be used by the transport service to transmit
1252 * a message using the plugin. Note that in the case of a
1253 * peer disconnecting, the continuation MUST be called
1254 * prior to the disconnect notification itself. This function
1255 * will be called with this peer's HELLO message to initiate
1256 * a fresh connection to another peer.
1258 * @param cls closure
1259 * @param session which session must be used
1260 * @param msgbuf the message to transmit
1261 * @param msgbuf_size number of bytes in 'msgbuf'
1262 * @param priority how important is the message (most plugins will
1263 * ignore message priority and just FIFO)
1264 * @param to how long to wait at most for the transmission (does not
1265 * require plugins to discard the message after the timeout,
1266 * just advisory for the desired delay; most plugins will ignore
1268 * @param cont continuation to call once the message has
1269 * been transmitted (or if the transport is ready
1270 * for the next transmission call; or if the
1271 * peer disconnected...); can be NULL
1272 * @param cont_cls closure for @a cont
1273 * @return number of bytes used (on the physical network, with overheads);
1274 * -1 on hard errors (i.e. address invalid); 0 is a legal value
1275 * and does NOT mean that the message was not transmitted (DV)
1278 tcp_plugin_send (void *cls,
1279 struct Session *session,
1282 unsigned int priority,
1283 struct GNUNET_TIME_Relative to,
1284 GNUNET_TRANSPORT_TransmitContinuation cont,
1287 struct Plugin * plugin = cls;
1288 struct PendingMessage *pm;
1290 /* create new message entry */
1291 pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
1292 pm->msg = (const char *) &pm[1];
1293 memcpy (&pm[1], msgbuf, msgbuf_size);
1294 pm->message_size = msgbuf_size;
1295 pm->timeout = GNUNET_TIME_relative_to_absolute (to);
1296 pm->transmit_cont = cont;
1297 pm->transmit_cont_cls = cont_cls;
1299 LOG(GNUNET_ERROR_TYPE_DEBUG,
1300 "Asked to transmit %u bytes to `%s', added message to list.\n",
1301 msgbuf_size, GNUNET_i2s (&session->target));
1304 GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessionmap,
1308 GNUNET_assert (NULL != session->client);
1309 GNUNET_SERVER_client_set_timeout (session->client,
1310 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1311 GNUNET_STATISTICS_update (plugin->env->stats,
1312 gettext_noop ("# bytes currently in TCP buffers"), msgbuf_size,
1315 /* append pm to pending_messages list */
1316 GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1317 session->pending_messages_tail,
1319 notify_session_monitor (session->plugin,
1321 GNUNET_TRANSPORT_SS_UPDATE);
1322 session->msgs_in_queue++;
1323 session->bytes_in_queue += pm->message_size;
1324 process_pending_messages (session);
1327 else if (GNUNET_YES ==
1328 GNUNET_CONTAINER_multipeermap_contains_value (plugin->nat_wait_conns,
1332 LOG (GNUNET_ERROR_TYPE_DEBUG,
1333 "This NAT WAIT session for peer `%s' is not yet ready!\n",
1334 GNUNET_i2s (&session->target));
1335 GNUNET_STATISTICS_update (plugin->env->stats,
1336 gettext_noop ("# bytes currently in TCP buffers"), msgbuf_size,
1338 /* append pm to pending_messages list */
1339 GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1340 session->pending_messages_tail,
1342 session->msgs_in_queue++;
1343 session->bytes_in_queue += pm->message_size;
1344 notify_session_monitor (session->plugin,
1346 GNUNET_TRANSPORT_SS_HANDSHAKE);
1351 LOG(GNUNET_ERROR_TYPE_ERROR,
1352 "Invalid session %p\n",
1362 return GNUNET_SYSERR; /* session does not exist here */
1367 * Closure for #session_lookup_it().
1372 * Address we are looking for.
1374 const struct GNUNET_HELLO_Address *address;
1377 * Where to store the session (if we found it).
1379 struct Session *result;
1385 * Look for a session by address.
1387 * @param cls the `struct SessionItCtx`
1389 * @param value a `struct Session`
1390 * @return #GNUNET_YES to continue looking, #GNUNET_NO if we found the session
1393 session_lookup_it (void *cls,
1394 const struct GNUNET_PeerIdentity *key,
1397 struct SessionItCtx * si_ctx = cls;
1398 struct Session * session = value;
1400 if (0 != GNUNET_HELLO_address_cmp (si_ctx->address, session->address))
1402 /* Found existing session */
1403 si_ctx->result = session;
1409 * Task cleaning up a NAT connection attempt after timeout
1411 * @param cls the `struct Session`
1412 * @param tc scheduler context (unused)
1415 nat_connect_timeout (void *cls,
1416 const struct GNUNET_SCHEDULER_TaskContext *tc)
1418 struct Session *session = cls;
1420 session->nat_connection_timeout = NULL;
1421 LOG (GNUNET_ERROR_TYPE_DEBUG,
1422 "NAT WAIT connection to `%4s' at `%s' could not be established, removing session\n",
1423 GNUNET_i2s (&session->target),
1424 tcp_plugin_address_to_string (NULL,
1425 session->address->address,
1426 session->address->address_length));
1427 tcp_plugin_disconnect_session (session->plugin,
1433 * Function that will be called whenever the transport service wants to
1434 * notify the plugin that a session is still active and in use and
1435 * therefore the session timeout for this session has to be updated
1437 * @param cls closure
1438 * @param peer which peer was the session for
1439 * @param session which session is being updated
1442 tcp_plugin_update_session_timeout (void *cls,
1443 const struct GNUNET_PeerIdentity *peer,
1444 struct Session *session)
1446 reschedule_session_timeout (session);
1451 * Task to signal the server that we can continue
1452 * receiving from the TCP client now.
1454 * @param cls the `struct Session*`
1455 * @param tc task context (unused)
1458 delayed_done (void *cls,
1459 const struct GNUNET_SCHEDULER_TaskContext *tc)
1461 struct Session *session = cls;
1463 session->receive_delay_task = NULL;
1464 reschedule_session_timeout (session);
1466 GNUNET_SERVER_receive_done (session->client, GNUNET_OK);
1471 * Function that will be called whenever the transport service wants to
1472 * notify the plugin that the inbound quota changed and that the plugin
1473 * should update it's delay for the next receive value
1475 * @param cls closure
1476 * @param peer which peer was the session for
1477 * @param session which session is being updated
1478 * @param delay new delay to use for receiving
1481 tcp_plugin_update_inbound_delay (void *cls,
1482 const struct GNUNET_PeerIdentity *peer,
1483 struct Session *session,
1484 struct GNUNET_TIME_Relative delay)
1486 if (NULL == session->receive_delay_task)
1488 LOG (GNUNET_ERROR_TYPE_DEBUG,
1489 "New inbound delay %s\n",
1490 GNUNET_STRINGS_relative_time_to_string (delay,
1492 session->receive_delay = GNUNET_TIME_relative_to_absolute (delay);
1493 GNUNET_SCHEDULER_cancel (session->receive_delay_task);
1494 session->receive_delay_task = GNUNET_SCHEDULER_add_delayed (delay,
1501 * Create a new session to transmit data to the target
1502 * This session will used to send data to this peer and the plugin will
1503 * notify us by calling the env->session_end function
1505 * @param cls closure
1506 * @param address the address to use
1507 * @return the session if the address is valid, NULL otherwise
1509 static struct Session *
1510 tcp_plugin_get_session (void *cls,
1511 const struct GNUNET_HELLO_Address *address)
1513 struct Plugin *plugin = cls;
1514 struct Session *session = NULL;
1518 struct GNUNET_CONNECTION_Handle *sa;
1519 struct sockaddr_in a4;
1520 struct sockaddr_in6 a6;
1521 const struct IPv4TcpAddress *t4;
1522 const struct IPv6TcpAddress *t6;
1523 unsigned int options;
1524 enum GNUNET_ATS_Network_Type net_type;
1525 unsigned int is_natd = GNUNET_NO;
1528 struct GNUNET_NETWORK_Handle *s;
1531 addrlen = address->address_length;
1532 LOG(GNUNET_ERROR_TYPE_DEBUG,
1533 "Trying to get session for `%s' address of peer `%s'\n",
1534 tcp_plugin_address_to_string(NULL, address->address, address->address_length),
1535 GNUNET_i2s (&address->peer));
1537 if (GNUNET_HELLO_address_check_option(address, GNUNET_HELLO_ADDRESS_INFO_INBOUND))
1543 /* look for existing session */
1544 if (GNUNET_YES == 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,
1553 &address->peer, &session_lookup_it, &si_ctx);
1554 if (si_ctx.result != NULL)
1556 session = si_ctx.result;
1557 LOG(GNUNET_ERROR_TYPE_DEBUG,
1558 "Found existing session for `%s' address `%s' session %p\n",
1559 GNUNET_i2s (&address->peer),
1560 tcp_plugin_address_to_string(NULL, address->address, address->address_length),
1564 LOG (GNUNET_ERROR_TYPE_DEBUG,
1565 "Existing sessions did not match address `%s' or peer `%s'\n",
1566 tcp_plugin_address_to_string (NULL,
1568 address->address_length),
1569 GNUNET_i2s (&address->peer));
1572 if (addrlen == sizeof(struct IPv6TcpAddress))
1574 GNUNET_assert(NULL != address->address); /* make static analysis happy */
1575 t6 = address->address;
1576 options = t6->options;
1578 memset (&a6, 0, sizeof(a6));
1579 #if HAVE_SOCKADDR_IN_SIN_LEN
1580 a6.sin6_len = sizeof (a6);
1582 a6.sin6_family = AF_INET6;
1583 a6.sin6_port = t6->t6_port;
1584 if (t6->t6_port == 0)
1585 is_natd = GNUNET_YES;
1586 memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof(struct in6_addr));
1590 else if (addrlen == sizeof(struct IPv4TcpAddress))
1592 GNUNET_assert(NULL != address->address); /* make static analysis happy */
1593 t4 = address->address;
1594 options = t4->options;
1596 memset (&a4, 0, sizeof(a4));
1597 #if HAVE_SOCKADDR_IN_SIN_LEN
1598 a4.sin_len = sizeof (a4);
1600 a4.sin_family = AF_INET;
1601 a4.sin_port = t4->t4_port;
1602 if (t4->t4_port == 0)
1603 is_natd = GNUNET_YES;
1604 a4.sin_addr.s_addr = t4->ipv4_addr;
1610 GNUNET_STATISTICS_update (plugin->env->stats, gettext_noop
1611 ("# requests to create session with invalid address"), 1, GNUNET_NO);
1615 net_type = plugin->env->get_address_type (plugin->env->cls, sb, sbs);
1618 if ((is_natd == GNUNET_YES) && (addrlen == sizeof(struct IPv6TcpAddress)))
1620 /* NAT client only works with IPv4 addresses */
1624 if (plugin->cur_connections >= plugin->max_connections)
1630 if ((is_natd == GNUNET_YES)
1632 == GNUNET_CONTAINER_multipeermap_contains (plugin->nat_wait_conns,
1635 /* Only do one NAT punch attempt per peer identity */
1639 if ((is_natd == GNUNET_YES) && (NULL != plugin->nat) &&
1640 (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (plugin->nat_wait_conns,
1643 LOG (GNUNET_ERROR_TYPE_DEBUG,
1644 "Found valid IPv4 NAT address (creating session)!\n");
1645 session = create_session (plugin,
1649 session->ats_address_network_type = net_type;
1650 GNUNET_break (session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
1651 session->nat_connection_timeout = GNUNET_SCHEDULER_add_delayed (NAT_TIMEOUT,
1652 &nat_connect_timeout,
1654 GNUNET_assert(GNUNET_OK ==
1655 GNUNET_CONTAINER_multipeermap_put (plugin->nat_wait_conns,
1658 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1660 LOG (GNUNET_ERROR_TYPE_DEBUG,
1661 "Created NAT WAIT connection to `%4s' at `%s'\n",
1662 GNUNET_i2s (&session->target),
1663 GNUNET_a2s (sb, sbs));
1664 if (GNUNET_OK == GNUNET_NAT_run_client (plugin->nat, &a4))
1670 LOG(GNUNET_ERROR_TYPE_DEBUG,
1671 "Running NAT client for `%4s' at `%s' failed\n",
1672 GNUNET_i2s (&session->target),
1673 GNUNET_a2s (sb, sbs));
1674 tcp_plugin_disconnect_session (plugin,
1680 /* create new outbound session */
1681 GNUNET_assert(plugin->cur_connections <= plugin->max_connections);
1683 if (0 != (options & TCP_OPTIONS_TCP_STEALTH))
1686 s = GNUNET_NETWORK_socket_create (af, SOCK_STREAM, 0);
1689 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
1696 GNUNET_NETWORK_socket_setsockopt (s,
1700 sizeof (struct GNUNET_PeerIdentity))) ||
1702 GNUNET_NETWORK_socket_setsockopt (s,
1704 TCP_STEALTH_INTEGRITY,
1705 &plugin->my_welcome,
1706 sizeof (struct WelcomeMessage))) )
1708 /* TCP STEALTH not supported by kernel */
1709 GNUNET_break (GNUNET_OK ==
1710 GNUNET_NETWORK_socket_close (s));
1715 sa = GNUNET_CONNECTION_connect_socket (s, sb, sbs);
1724 sa = GNUNET_CONNECTION_create_from_sockaddr (af, sb, sbs);
1728 LOG (GNUNET_ERROR_TYPE_DEBUG,
1729 "Failed to create connection to `%4s' at `%s'\n",
1730 GNUNET_i2s (&address->peer),
1731 GNUNET_a2s (sb, sbs));
1734 plugin->cur_connections++;
1735 if (plugin->cur_connections == plugin->max_connections)
1736 GNUNET_SERVER_suspend (plugin->server); /* Maximum number of connections rechead */
1738 LOG (GNUNET_ERROR_TYPE_DEBUG,
1739 "Asked to transmit to `%4s', creating fresh session using address `%s'.\n",
1740 GNUNET_i2s (&address->peer), GNUNET_a2s (sb, sbs));
1742 session = create_session (plugin,
1744 GNUNET_SERVER_connect_socket (plugin->server, sa),
1746 session->ats_address_network_type = net_type;
1747 GNUNET_break (session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
1748 GNUNET_SERVER_client_set_user_context(session->client, session);
1749 GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap,
1752 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1753 LOG (GNUNET_ERROR_TYPE_DEBUG,
1754 "Creating new session for `%s' address `%s' session %p\n",
1755 GNUNET_i2s (&address->peer),
1756 tcp_plugin_address_to_string (NULL,
1758 address->address_length),
1760 /* Send TCP Welcome */
1761 process_pending_messages (session);
1768 session_disconnect_it (void *cls,
1769 const struct GNUNET_PeerIdentity *key,
1772 struct Plugin *plugin = cls;
1773 struct Session *session = value;
1775 GNUNET_STATISTICS_update (session->plugin->env->stats,
1776 gettext_noop ("# transport-service disconnect requests for TCP"),
1779 tcp_plugin_disconnect_session (plugin,
1786 * Function that can be called to force a disconnect from the
1787 * specified neighbour. This should also cancel all previously
1788 * scheduled transmissions. Obviously the transmission may have been
1789 * partially completed already, which is OK. The plugin is supposed
1790 * to close the connection (if applicable) and no longer call the
1791 * transmit continuation(s).
1793 * Finally, plugin MUST NOT call the services's receive function to
1794 * notify the service that the connection to the specified target was
1795 * closed after a getting this call.
1797 * @param cls closure
1798 * @param target peer for which the last transmission is
1802 tcp_plugin_disconnect (void *cls,
1803 const struct GNUNET_PeerIdentity *target)
1805 struct Plugin *plugin = cls;
1807 LOG(GNUNET_ERROR_TYPE_DEBUG,
1808 "Disconnecting peer `%4s'\n",
1809 GNUNET_i2s (target));
1810 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessionmap,
1812 &session_disconnect_it,
1814 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->nat_wait_conns,
1816 &session_disconnect_it,
1822 * Running pretty printers: head
1824 static struct PrettyPrinterContext *ppc_dll_head;
1827 * Running pretty printers: tail
1829 static struct PrettyPrinterContext *ppc_dll_tail;
1832 * Context for address to string conversion, closure
1833 * for #append_port().
1835 struct PrettyPrinterContext
1840 struct PrettyPrinterContext *next;
1845 struct PrettyPrinterContext *prev;
1850 struct GNUNET_SCHEDULER_Task * timeout_task;
1855 struct GNUNET_RESOLVER_RequestHandle *resolver_handle;
1858 * Function to call with the result.
1860 GNUNET_TRANSPORT_AddressStringCallback asc;
1863 * Clsoure for @e asc.
1868 * Port to add after the IP address.
1885 * Append our port and forward the result.
1887 * @param cls the `struct PrettyPrinterContext *`
1888 * @param hostname hostname part of the address
1891 append_port (void *cls,
1892 const char *hostname)
1894 struct PrettyPrinterContext *ppc = cls;
1897 if (NULL == hostname)
1899 /* Final call, done */
1900 ppc->resolver_handle = NULL;
1901 GNUNET_CONTAINER_DLL_remove (ppc_dll_head,
1904 ppc->asc (ppc->asc_cls,
1910 if (GNUNET_YES == ppc->ipv6)
1911 GNUNET_asprintf (&ret,
1918 GNUNET_asprintf (&ret,
1924 ppc->asc (ppc->asc_cls,
1932 * Convert the transports address to a nice, human-readable
1935 * @param cls closure
1936 * @param type name of the transport that generated the address
1937 * @param addr one of the addresses of the host, NULL for the last address
1938 * the specific address format depends on the transport
1939 * @param addrlen length of the @a addr
1940 * @param numeric should (IP) addresses be displayed in numeric form?
1941 * @param timeout after how long should we give up?
1942 * @param asc function to call on each string
1943 * @param asc_cls closure for @a asc
1946 tcp_plugin_address_pretty_printer (void *cls,
1951 struct GNUNET_TIME_Relative timeout,
1952 GNUNET_TRANSPORT_AddressStringCallback asc,
1955 struct PrettyPrinterContext *ppc;
1958 struct sockaddr_in a4;
1959 struct sockaddr_in6 a6;
1960 const struct IPv4TcpAddress *t4;
1961 const struct IPv6TcpAddress *t6;
1965 if (sizeof(struct IPv6TcpAddress) == addrlen)
1968 memset (&a6, 0, sizeof(a6));
1969 a6.sin6_family = AF_INET6;
1970 a6.sin6_port = t6->t6_port;
1971 memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof(struct in6_addr));
1972 port = ntohs (t6->t6_port);
1973 options = ntohl (t6->options);
1977 else if (sizeof(struct IPv4TcpAddress) == addrlen)
1980 memset (&a4, 0, sizeof(a4));
1981 a4.sin_family = AF_INET;
1982 a4.sin_port = t4->t4_port;
1983 a4.sin_addr.s_addr = t4->ipv4_addr;
1984 port = ntohs (t4->t4_port);
1985 options = ntohl (t4->options);
1991 /* invalid address */
1992 asc (asc_cls, NULL, GNUNET_SYSERR);
1993 asc (asc_cls, NULL, GNUNET_OK);
1996 ppc = GNUNET_new (struct PrettyPrinterContext);
1997 if (addrlen == sizeof(struct IPv6TcpAddress))
1998 ppc->ipv6 = GNUNET_YES;
2000 ppc->ipv6 = GNUNET_NO;
2002 ppc->asc_cls = asc_cls;
2004 ppc->options = options;
2005 ppc->resolver_handle = GNUNET_RESOLVER_hostname_get (sb,
2010 if (NULL == ppc->resolver_handle)
2016 GNUNET_CONTAINER_DLL_insert (ppc_dll_head,
2023 * Check if the given port is plausible (must be either our listen
2024 * port or our advertised port), or any port if we are behind NAT
2025 * and do not have a port open. If it is neither, we return
2028 * @param plugin global variables
2029 * @param in_port port number to check
2030 * @return #GNUNET_OK if port is either open_port or adv_port
2033 check_port (struct Plugin *plugin, uint16_t in_port)
2035 if ((in_port == plugin->adv_port) || (in_port == plugin->open_port))
2037 return GNUNET_SYSERR;
2041 * Function that will be called to check if a binary address for this
2042 * plugin is well-formed and corresponds to an address for THIS peer
2043 * (as per our configuration). Naturally, if absolutely necessary,
2044 * plugins can be a bit conservative in their answer, but in general
2045 * plugins should make sure that the address does not redirect
2046 * traffic to a 3rd party that might try to man-in-the-middle our
2049 * @param cls closure, our `struct Plugin *`
2050 * @param addr pointer to the address
2051 * @param addrlen length of addr
2052 * @return #GNUNET_OK if this is a plausible address for this peer
2053 * and transport, #GNUNET_SYSERR if not
2056 tcp_plugin_check_address (void *cls, const void *addr, size_t addrlen)
2058 struct Plugin *plugin = cls;
2059 struct IPv4TcpAddress *v4;
2060 struct IPv6TcpAddress *v6;
2062 if ((addrlen != sizeof(struct IPv4TcpAddress))
2063 && (addrlen != sizeof(struct IPv6TcpAddress)))
2066 return GNUNET_SYSERR;
2069 if (addrlen == sizeof(struct IPv4TcpAddress))
2071 v4 = (struct IPv4TcpAddress *) addr;
2072 if (0 != memcmp (&v4->options,
2077 return GNUNET_SYSERR;
2079 if (GNUNET_OK != check_port (plugin, ntohs (v4->t4_port)))
2080 return GNUNET_SYSERR;
2082 != GNUNET_NAT_test_address (plugin->nat, &v4->ipv4_addr,
2083 sizeof(struct in_addr)))
2084 return GNUNET_SYSERR;
2088 v6 = (struct IPv6TcpAddress *) addr;
2089 if (IN6_IS_ADDR_LINKLOCAL (&v6->ipv6_addr))
2092 return GNUNET_SYSERR;
2094 if (0 != memcmp (&v6->options,
2099 return GNUNET_SYSERR;
2101 if (GNUNET_OK != check_port (plugin, ntohs (v6->t6_port)))
2102 return GNUNET_SYSERR;
2104 != GNUNET_NAT_test_address (plugin->nat, &v6->ipv6_addr,
2105 sizeof(struct in6_addr)))
2106 return GNUNET_SYSERR;
2112 * We've received a nat probe from this peer via TCP. Finish
2113 * creating the client session and resume sending of queued
2116 * @param cls closure
2117 * @param client identification of the client
2118 * @param message the actual message
2121 handle_tcp_nat_probe (void *cls,
2122 struct GNUNET_SERVER_Client *client,
2123 const struct GNUNET_MessageHeader *message)
2125 struct Plugin *plugin = cls;
2126 struct Session *session;
2127 const struct TCP_NAT_ProbeMessage *tcp_nat_probe;
2130 struct IPv4TcpAddress *t4;
2131 struct IPv6TcpAddress *t6;
2132 const struct sockaddr_in *s4;
2133 const struct sockaddr_in6 *s6;
2135 LOG(GNUNET_ERROR_TYPE_DEBUG, "Received NAT probe\n");
2136 /* We have received a TCP NAT probe, meaning we (hopefully) initiated
2137 * a connection to this peer by running gnunet-nat-client. This peer
2138 * received the punch message and now wants us to use the new connection
2139 * as the default for that peer. Do so and then send a WELCOME message
2140 * so we can really be connected!
2142 if (ntohs (message->size) != sizeof(struct TCP_NAT_ProbeMessage))
2145 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2149 tcp_nat_probe = (const struct TCP_NAT_ProbeMessage *) message;
2150 if (0 == memcmp (&tcp_nat_probe->clientIdentity, plugin->env->my_identity,
2151 sizeof(struct GNUNET_PeerIdentity)))
2153 /* refuse connections from ourselves */
2154 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2158 session = GNUNET_CONTAINER_multipeermap_get (plugin->nat_wait_conns,
2159 &tcp_nat_probe->clientIdentity);
2160 if (session == NULL)
2162 LOG (GNUNET_ERROR_TYPE_DEBUG,
2163 "Did NOT find session for NAT probe!\n");
2164 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2167 LOG (GNUNET_ERROR_TYPE_DEBUG,
2168 "Found session for NAT probe!\n");
2170 if (session->nat_connection_timeout != NULL)
2172 GNUNET_SCHEDULER_cancel (session->nat_connection_timeout);
2173 session->nat_connection_timeout = NULL;
2176 if (GNUNET_OK != GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2179 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2180 tcp_plugin_disconnect_session (plugin,
2185 GNUNET_CONTAINER_multipeermap_remove (plugin->nat_wait_conns, &tcp_nat_probe->clientIdentity, session) == GNUNET_YES);
2186 GNUNET_SERVER_client_set_user_context(client, session);
2187 GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap, &session->target,
2188 session, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2189 session->last_activity = GNUNET_TIME_absolute_get ();
2190 LOG(GNUNET_ERROR_TYPE_DEBUG, "Found address `%s' for incoming connection\n",
2191 GNUNET_a2s (vaddr, alen));
2192 switch (((const struct sockaddr *) vaddr)->sa_family)
2196 t4 = GNUNET_new (struct IPv4TcpAddress);
2197 t4->options = htonl (TCP_OPTIONS_NONE);
2198 t4->t4_port = s4->sin_port;
2199 t4->ipv4_addr = s4->sin_addr.s_addr;
2200 session->address = GNUNET_HELLO_address_allocate (&tcp_nat_probe->clientIdentity,
2203 sizeof(struct IPv4TcpAddress),
2204 GNUNET_HELLO_ADDRESS_INFO_NONE);
2208 t6 = GNUNET_new (struct IPv6TcpAddress);
2209 t6->options = htonl (TCP_OPTIONS_NONE);
2210 t6->t6_port = s6->sin6_port;
2211 memcpy (&t6->ipv6_addr, &s6->sin6_addr, sizeof(struct in6_addr));
2212 session->address = GNUNET_HELLO_address_allocate (&tcp_nat_probe->clientIdentity,
2215 sizeof(struct IPv6TcpAddress),
2216 GNUNET_HELLO_ADDRESS_INFO_NONE);
2220 LOG(GNUNET_ERROR_TYPE_DEBUG,
2221 "Bad address for incoming connection!\n");
2223 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2224 tcp_plugin_disconnect_session (plugin,
2229 GNUNET_break(NULL == session->client);
2230 GNUNET_SERVER_client_keep (client);
2231 session->client = client;
2232 GNUNET_STATISTICS_update (plugin->env->stats,
2233 gettext_noop ("# TCP sessions active"), 1, GNUNET_NO);
2234 process_pending_messages (session);
2235 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2239 * We've received a welcome from this peer via TCP. Possibly create a
2240 * fresh client record and send back our welcome.
2242 * @param cls closure
2243 * @param client identification of the client
2244 * @param message the actual message
2247 handle_tcp_welcome (void *cls,
2248 struct GNUNET_SERVER_Client *client,
2249 const struct GNUNET_MessageHeader *message)
2251 struct Plugin *plugin = cls;
2252 const struct WelcomeMessage *wm = (const struct WelcomeMessage *) message;
2253 struct GNUNET_HELLO_Address *address;
2254 struct Session *session;
2257 struct IPv4TcpAddress t4;
2258 struct IPv6TcpAddress t6;
2259 const struct sockaddr_in *s4;
2260 const struct sockaddr_in6 *s6;
2261 struct GNUNET_ATS_Information ats;
2264 if (0 == memcmp (&wm->clientIdentity, plugin->env->my_identity,
2265 sizeof(struct GNUNET_PeerIdentity)))
2267 /* refuse connections from ourselves */
2268 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2269 if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2271 LOG(GNUNET_ERROR_TYPE_INFO,
2272 "Received %s message from my own identity `%4s' on address `%s'\n",
2273 "WELCOME", GNUNET_i2s (&wm->clientIdentity),
2274 GNUNET_a2s (vaddr, alen));
2280 LOG(GNUNET_ERROR_TYPE_DEBUG, "Received %s message from `%4s' %p\n", "WELCOME",
2281 GNUNET_i2s (&wm->clientIdentity), client);
2282 GNUNET_STATISTICS_update (plugin->env->stats,
2283 gettext_noop ("# TCP WELCOME messages received"), 1, GNUNET_NO);
2284 session = lookup_session_by_client (plugin, client);
2285 if (NULL != session)
2287 if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2289 LOG (GNUNET_ERROR_TYPE_DEBUG,
2290 "Found existing session %p for peer `%s'\n",
2291 session, GNUNET_a2s (vaddr, alen));
2297 GNUNET_SERVER_client_keep (client);
2298 if (NULL != plugin->service) /* Otherwise value is incremented in tcp_access_check */
2299 plugin->cur_connections++;
2300 if (plugin->cur_connections == plugin->max_connections)
2301 GNUNET_SERVER_suspend (plugin->server); /* Maximum number of connections rechead */
2303 if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2305 if (alen == sizeof(struct sockaddr_in))
2308 memset (&t4, '\0', sizeof (t4));
2309 t4.options = htonl (TCP_OPTIONS_NONE);
2310 t4.t4_port = s4->sin_port;
2311 t4.ipv4_addr = s4->sin_addr.s_addr;
2312 address = GNUNET_HELLO_address_allocate (&wm->clientIdentity,
2316 GNUNET_HELLO_ADDRESS_INFO_INBOUND);
2318 else if (alen == sizeof(struct sockaddr_in6))
2321 memset (&t6, '\0', sizeof (t6));
2322 t6.options = htonl (TCP_OPTIONS_NONE);
2323 t6.t6_port = s6->sin6_port;
2324 memcpy (&t6.ipv6_addr, &s6->sin6_addr, sizeof(struct in6_addr));
2325 address = GNUNET_HELLO_address_allocate (&wm->clientIdentity,
2326 PLUGIN_NAME, &t6, sizeof (t6),
2327 GNUNET_HELLO_ADDRESS_INFO_INBOUND);
2332 GNUNET_free_non_null (vaddr);
2335 session = create_session (plugin, address, client, GNUNET_NO);
2336 GNUNET_HELLO_address_free (address);
2337 session->ats_address_network_type = plugin->env->get_address_type (plugin->env->cls, vaddr, alen);
2338 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
2339 ats.value = htonl (session->ats_address_network_type);
2340 LOG(GNUNET_ERROR_TYPE_DEBUG,
2341 "Creating new%s session %p for peer `%s' client %p \n",
2342 GNUNET_HELLO_address_check_option (session->address,
2343 GNUNET_HELLO_ADDRESS_INFO_INBOUND)
2346 tcp_plugin_address_to_string(NULL, (void *) session->address->address,
2347 session->address->address_length),
2350 GNUNET_SERVER_client_set_user_context(session->client, session);
2351 GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap,
2354 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2355 /* Notify transport and ATS about new session */
2356 plugin->env->session_start (NULL, session->address, session, &ats, 1);
2357 notify_session_monitor (plugin,
2359 GNUNET_TRANSPORT_SS_INIT);
2363 LOG(GNUNET_ERROR_TYPE_DEBUG,
2364 "Did not obtain TCP socket address for incoming connection\n");
2370 if (session->expecting_welcome != GNUNET_YES)
2373 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2377 session->last_activity = GNUNET_TIME_absolute_get ();
2378 session->expecting_welcome = GNUNET_NO;
2380 process_pending_messages (session);
2381 GNUNET_SERVER_client_set_timeout (client,
2382 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2383 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2388 * We've received data for this peer via TCP. Unbox,
2389 * compute latency and forward.
2391 * @param cls closure
2392 * @param client identification of the client
2393 * @param message the actual message
2396 handle_tcp_data (void *cls,
2397 struct GNUNET_SERVER_Client *client,
2398 const struct GNUNET_MessageHeader *message)
2400 struct Plugin *plugin = cls;
2401 struct Session *session;
2402 struct GNUNET_TIME_Relative delay;
2405 type = ntohs (message->type);
2406 if ((GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME == type)
2407 || (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE == type))
2409 /* We don't want to propagate WELCOME and NAT Probe messages up! */
2410 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2413 session = lookup_session_by_client (plugin, client);
2414 if (NULL == session)
2416 /* No inbound session found */
2420 GNUNET_SERVER_client_get_address (client, &vaddr, &alen);
2421 LOG(GNUNET_ERROR_TYPE_ERROR,
2422 "Received unexpected %u bytes of type %u from `%s'\n",
2423 (unsigned int) ntohs (message->size),
2424 (unsigned int) ntohs (message->type), GNUNET_a2s (vaddr, alen));
2426 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2427 GNUNET_free_non_null(vaddr);
2430 else if (GNUNET_YES == session->expecting_welcome)
2432 /* Session is expecting WELCOME message */
2436 GNUNET_SERVER_client_get_address (client, &vaddr, &alen);
2437 LOG(GNUNET_ERROR_TYPE_ERROR,
2438 "Received unexpected %u bytes of type %u from `%s'\n",
2439 (unsigned int) ntohs (message->size),
2440 (unsigned int) ntohs (message->type), GNUNET_a2s (vaddr, alen));
2442 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2443 GNUNET_free_non_null(vaddr);
2447 session->last_activity = GNUNET_TIME_absolute_get ();
2448 LOG(GNUNET_ERROR_TYPE_DEBUG,
2449 "Passing %u bytes of type %u from `%4s' to transport service.\n",
2450 (unsigned int) ntohs (message->size),
2451 (unsigned int) ntohs (message->type), GNUNET_i2s (&session->target));
2453 GNUNET_STATISTICS_update (plugin->env->stats,
2454 gettext_noop ("# bytes received via TCP"), ntohs (message->size),
2456 struct GNUNET_ATS_Information distance;
2458 distance.type = htonl (GNUNET_ATS_NETWORK_TYPE);
2459 distance.value = htonl ((uint32_t) session->ats_address_network_type);
2460 GNUNET_break(session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
2462 GNUNET_assert(GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessionmap,
2466 delay = plugin->env->receive (plugin->env->cls,
2470 plugin->env->update_address_metrics (plugin->env->cls,
2474 reschedule_session_timeout (session);
2475 if (0 == delay.rel_value_us)
2477 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2481 LOG(GNUNET_ERROR_TYPE_DEBUG,
2482 "Throttling receiving from `%s' for %s\n",
2483 GNUNET_i2s (&session->target),
2484 GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
2485 GNUNET_SERVER_disable_receive_done_warning (client);
2486 session->receive_delay_task = GNUNET_SCHEDULER_add_delayed (delay,
2487 &delayed_done, session);
2493 * Functions with this signature are called whenever a peer
2494 * is disconnected on the network level.
2496 * @param cls closure
2497 * @param client identification of the client
2500 disconnect_notify (void *cls,
2501 struct GNUNET_SERVER_Client *client)
2503 struct Plugin *plugin = cls;
2504 struct Session *session;
2508 session = lookup_session_by_client (plugin, client);
2509 if (NULL == session)
2510 return; /* unknown, nothing to do */
2511 LOG (GNUNET_ERROR_TYPE_DEBUG,
2512 "Destroying session of `%4s' with %s due to network-level disconnect.\n",
2513 GNUNET_i2s (&session->target),
2514 tcp_plugin_address_to_string (session->plugin, session->address->address,
2515 session->address->address_length));
2517 if (plugin->cur_connections == plugin->max_connections)
2518 GNUNET_SERVER_resume (plugin->server); /* Resume server */
2520 if (plugin->cur_connections < 1)
2523 plugin->cur_connections--;
2525 GNUNET_STATISTICS_update (session->plugin->env->stats, gettext_noop
2526 ("# network-level TCP disconnect events"),
2529 tcp_plugin_disconnect_session (plugin, session);
2534 * We can now send a probe message, copy into buffer to really send.
2536 * @param cls closure, a struct TCPProbeContext
2537 * @param size max size to copy
2538 * @param buf buffer to copy message to
2539 * @return number of bytes copied into @a buf
2542 notify_send_probe (void *cls,
2546 struct TCPProbeContext *tcp_probe_ctx = cls;
2547 struct Plugin *plugin = tcp_probe_ctx->plugin;
2550 tcp_probe_ctx->transmit_handle = NULL;
2551 GNUNET_CONTAINER_DLL_remove (plugin->probe_head,
2556 GNUNET_CONNECTION_destroy (tcp_probe_ctx->sock);
2557 GNUNET_free(tcp_probe_ctx);
2560 GNUNET_assert(size >= sizeof(tcp_probe_ctx->message));
2561 memcpy (buf, &tcp_probe_ctx->message, sizeof(tcp_probe_ctx->message));
2562 GNUNET_SERVER_connect_socket (tcp_probe_ctx->plugin->server,
2563 tcp_probe_ctx->sock);
2564 ret = sizeof(tcp_probe_ctx->message);
2565 GNUNET_free(tcp_probe_ctx);
2571 * Function called by the NAT subsystem suggesting another peer wants
2572 * to connect to us via connection reversal. Try to connect back to the
2575 * @param cls closure
2576 * @param addr address to try
2577 * @param addrlen number of bytes in @a addr
2580 try_connection_reversal (void *cls,
2581 const struct sockaddr *addr,
2584 struct Plugin *plugin = cls;
2585 struct GNUNET_CONNECTION_Handle *sock;
2586 struct TCPProbeContext *tcp_probe_ctx;
2589 * We have received an ICMP response, ostensibly from a peer
2590 * that wants to connect to us! Send a message to establish a connection.
2592 sock = GNUNET_CONNECTION_create_from_sockaddr (AF_INET, addr, addrlen);
2595 /* failed for some odd reason (out of sockets?); ignore attempt */
2599 tcp_probe_ctx = GNUNET_new (struct TCPProbeContext);
2600 tcp_probe_ctx->message.header.size
2601 = htons (sizeof (struct TCP_NAT_ProbeMessage));
2602 tcp_probe_ctx->message.header.type
2603 = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE);
2604 tcp_probe_ctx->message.clientIdentity
2605 = *plugin->env->my_identity;
2606 tcp_probe_ctx->plugin = plugin;
2607 tcp_probe_ctx->sock = sock;
2608 GNUNET_CONTAINER_DLL_insert (plugin->probe_head,
2611 tcp_probe_ctx->transmit_handle
2612 = GNUNET_CONNECTION_notify_transmit_ready (sock,
2613 ntohs (tcp_probe_ctx->message.header.size),
2614 GNUNET_TIME_UNIT_FOREVER_REL,
2621 * Function obtain the network type for a session
2623 * @param cls closure ('struct Plugin*')
2624 * @param session the session
2625 * @return the network type in HBO or #GNUNET_SYSERR
2627 static enum GNUNET_ATS_Network_Type
2628 tcp_plugin_get_network (void *cls,
2629 struct Session *session)
2631 return session->ats_address_network_type;
2636 * Return information about the given session to the
2639 * @param cls the `struct Plugin` with the monitor callback (`sic`)
2640 * @param peer peer we send information about
2641 * @param value our `struct Session` to send information about
2642 * @return #GNUNET_OK (continue to iterate)
2645 send_session_info_iter (void *cls,
2646 const struct GNUNET_PeerIdentity *peer,
2649 struct Plugin *plugin = cls;
2650 struct Session *session = value;
2652 notify_session_monitor (plugin,
2654 GNUNET_TRANSPORT_SS_INIT);
2655 /* FIXME: cannot tell if this is up or not from current
2657 notify_session_monitor (plugin,
2659 GNUNET_TRANSPORT_SS_UP);
2665 * Begin monitoring sessions of a plugin. There can only
2666 * be one active monitor per plugin (i.e. if there are
2667 * multiple monitors, the transport service needs to
2668 * multiplex the generated events over all of them).
2670 * @param cls closure of the plugin
2671 * @param sic callback to invoke, NULL to disable monitor;
2672 * plugin will being by iterating over all active
2673 * sessions immediately and then enter monitor mode
2674 * @param sic_cls closure for @a sic
2677 tcp_plugin_setup_monitor (void *cls,
2678 GNUNET_TRANSPORT_SessionInfoCallback sic,
2681 struct Plugin *plugin = cls;
2684 plugin->sic_cls = sic_cls;
2687 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
2688 &send_session_info_iter,
2690 /* signal end of first iteration */
2691 sic (sic_cls, NULL, NULL);
2697 * Entry point for the plugin.
2699 * @param cls closure, the `struct GNUNET_TRANSPORT_PluginEnvironment *`
2700 * @return the `struct GNUNET_TRANSPORT_PluginFunctions *` or NULL on error
2703 libgnunet_plugin_transport_tcp_init (void *cls)
2705 static const struct GNUNET_SERVER_MessageHandler my_handlers[] = {
2706 { &handle_tcp_welcome, NULL,
2707 GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME, sizeof(struct WelcomeMessage) },
2708 { &handle_tcp_nat_probe, NULL,
2709 GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE, sizeof(struct TCP_NAT_ProbeMessage) },
2710 { &handle_tcp_data, NULL,
2711 GNUNET_MESSAGE_TYPE_ALL, 0 },
2712 { NULL, NULL, 0, 0 }
2714 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
2715 struct GNUNET_TRANSPORT_PluginFunctions *api;
2716 struct Plugin *plugin;
2717 struct GNUNET_SERVICE_Context *service;
2718 unsigned long long aport;
2719 unsigned long long bport;
2720 unsigned long long max_connections;
2722 struct GNUNET_TIME_Relative idle_timeout;
2724 struct GNUNET_NETWORK_Handle *const*lsocks;
2728 struct sockaddr **addrs;
2729 socklen_t *addrlens;
2731 if (NULL == env->receive)
2733 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
2734 initialze the plugin or the API */
2735 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2737 api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2738 api->address_to_string = &tcp_plugin_address_to_string;
2739 api->string_to_address = &tcp_plugin_string_to_address;
2743 GNUNET_assert (NULL != env->cfg);
2745 GNUNET_CONFIGURATION_get_value_number (env->cfg,
2749 max_connections = 128;
2753 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2757 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2758 "ADVERTISED-PORT", &aport)) &&
2761 LOG(GNUNET_ERROR_TYPE_ERROR,
2762 _("Require valid port number for service `%s' in configuration!\n"),
2772 service = GNUNET_SERVICE_start ("transport-tcp",
2774 GNUNET_SERVICE_OPTION_NONE);
2775 if (NULL == service)
2777 LOG (GNUNET_ERROR_TYPE_WARNING,
2778 _("Failed to start service.\n"));
2786 plugin = GNUNET_new (struct Plugin);
2787 plugin->sessionmap = GNUNET_CONTAINER_multipeermap_create (max_connections,
2789 plugin->max_connections = max_connections;
2790 plugin->open_port = bport;
2791 plugin->adv_port = aport;
2793 plugin->my_welcome.header.size = htons (sizeof(struct WelcomeMessage));
2794 plugin->my_welcome.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME);
2795 plugin->my_welcome.clientIdentity = *plugin->env->my_identity;
2797 if ( (NULL != service) &&
2799 GNUNET_CONFIGURATION_get_value_yesno (env->cfg,
2804 plugin->myoptions |= TCP_OPTIONS_TCP_STEALTH;
2805 lsocks = GNUNET_SERVICE_get_listen_sockets (service);
2808 uint32_t len = sizeof (struct WelcomeMessage);
2810 for (i=0;NULL!=lsocks[i];i++)
2813 GNUNET_NETWORK_socket_setsockopt (lsocks[i],
2817 sizeof (struct GNUNET_PeerIdentity))) ||
2819 GNUNET_NETWORK_socket_setsockopt (lsocks[i],
2821 TCP_STEALTH_INTEGRITY_LEN,
2825 /* TCP STEALTH not supported by kernel */
2826 GNUNET_assert (0 == i);
2827 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2828 _("TCP_STEALTH not supported on this platform.\n"));
2834 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2835 _("TCP_STEALTH not supported on this platform.\n"));
2840 if ( (NULL != service) &&
2843 GNUNET_SERVICE_get_server_addresses ("transport-tcp",
2848 for (ret = ret_s-1; ret >= 0; ret--)
2849 LOG (GNUNET_ERROR_TYPE_INFO,
2850 "Binding to address `%s'\n",
2851 GNUNET_a2s (addrs[ret], addrlens[ret]));
2853 = GNUNET_NAT_register (env->cfg,
2856 (unsigned int) ret_s,
2857 (const struct sockaddr **) addrs, addrlens,
2858 &tcp_nat_port_map_callback,
2859 &try_connection_reversal,
2861 for (ret = ret_s -1; ret >= 0; ret--)
2862 GNUNET_free (addrs[ret]);
2863 GNUNET_free_non_null (addrs);
2864 GNUNET_free_non_null (addrlens);
2868 plugin->nat = GNUNET_NAT_register (plugin->env->cfg,
2869 GNUNET_YES, 0, 0, NULL, NULL, NULL,
2870 &try_connection_reversal, plugin);
2872 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2874 api->send = &tcp_plugin_send;
2875 api->get_session = &tcp_plugin_get_session;
2876 api->disconnect_session = &tcp_plugin_disconnect_session;
2877 api->query_keepalive_factor = &tcp_plugin_query_keepalive_factor;
2878 api->disconnect_peer = &tcp_plugin_disconnect;
2879 api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2880 api->check_address = &tcp_plugin_check_address;
2881 api->address_to_string = &tcp_plugin_address_to_string;
2882 api->string_to_address = &tcp_plugin_string_to_address;
2883 api->get_network = &tcp_plugin_get_network;
2884 api->update_session_timeout = &tcp_plugin_update_session_timeout;
2885 api->update_inbound_delay = &tcp_plugin_update_inbound_delay;
2886 api->setup_monitor = &tcp_plugin_setup_monitor;
2887 plugin->service = service;
2888 if (NULL != service)
2890 plugin->server = GNUNET_SERVICE_get_server (service);
2895 GNUNET_CONFIGURATION_get_value_time (env->cfg,
2900 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2906 = GNUNET_SERVER_create_with_sockets (&plugin_tcp_access_check,
2908 idle_timeout, GNUNET_YES);
2910 plugin->handlers = GNUNET_malloc (sizeof (my_handlers));
2911 memcpy (plugin->handlers, my_handlers, sizeof(my_handlers));
2912 for (i = 0;i < sizeof(my_handlers) / sizeof(struct GNUNET_SERVER_MessageHandler);i++)
2913 plugin->handlers[i].callback_cls = plugin;
2915 GNUNET_SERVER_add_handlers (plugin->server, plugin->handlers);
2916 GNUNET_SERVER_disconnect_notify (plugin->server, &disconnect_notify, plugin);
2917 plugin->nat_wait_conns = GNUNET_CONTAINER_multipeermap_create (16,
2920 LOG (GNUNET_ERROR_TYPE_INFO,
2921 _("TCP transport listening on port %llu\n"),
2924 LOG (GNUNET_ERROR_TYPE_INFO,
2925 _("TCP transport not listening on any port (client only)\n"));
2926 if ( (aport != bport) &&
2928 LOG (GNUNET_ERROR_TYPE_INFO,
2929 _("TCP transport advertises itself as being on port %llu\n"),
2931 /* Initially set connections to 0 */
2932 GNUNET_assert(NULL != plugin->env->stats);
2933 GNUNET_STATISTICS_set (plugin->env->stats,
2934 gettext_noop ("# TCP sessions active"),
2940 if (NULL != plugin->nat)
2941 GNUNET_NAT_unregister (plugin->nat);
2942 GNUNET_CONTAINER_multipeermap_destroy (plugin->sessionmap);
2943 if (NULL != service)
2944 GNUNET_SERVICE_stop (service);
2945 GNUNET_free (plugin);
2946 GNUNET_free_non_null (api);
2952 * Exit point from the plugin.
2954 * @param cls the `struct GNUNET_TRANSPORT_PluginFunctions`
2958 libgnunet_plugin_transport_tcp_done (void *cls)
2960 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
2961 struct Plugin *plugin = api->cls;
2962 struct TCPProbeContext *tcp_probe;
2963 struct PrettyPrinterContext *cur;
2964 struct PrettyPrinterContext *next;
2971 LOG (GNUNET_ERROR_TYPE_DEBUG,
2972 "Shutting down TCP plugin\n");
2974 /* Removing leftover sessions */
2975 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
2976 &session_disconnect_it,
2978 /* Removing leftover NAT sessions */
2979 GNUNET_CONTAINER_multipeermap_iterate (plugin->nat_wait_conns,
2980 &session_disconnect_it,
2983 for (cur = ppc_dll_head; NULL != cur; cur = next)
2986 GNUNET_CONTAINER_DLL_remove (ppc_dll_head,
2989 GNUNET_RESOLVER_request_cancel (cur->resolver_handle);
2990 cur->asc (cur->asc_cls, NULL, GNUNET_OK);
2994 if (NULL != plugin->service)
2995 GNUNET_SERVICE_stop (plugin->service);
2997 GNUNET_SERVER_destroy (plugin->server);
2998 GNUNET_free(plugin->handlers);
2999 if (NULL != plugin->nat)
3000 GNUNET_NAT_unregister (plugin->nat);
3001 while (NULL != (tcp_probe = plugin->probe_head))
3003 GNUNET_CONTAINER_DLL_remove (plugin->probe_head,
3006 GNUNET_CONNECTION_destroy (tcp_probe->sock);
3007 GNUNET_free(tcp_probe);
3009 GNUNET_CONTAINER_multipeermap_destroy (plugin->nat_wait_conns);
3010 GNUNET_CONTAINER_multipeermap_destroy (plugin->sessionmap);
3011 GNUNET_free(plugin);
3016 /* end of plugin_transport_tcp.c */