src/transport/plugin_transport_tcp.c

   1 /*
   2   This file is part of GNUnet
   3   (C) 2002--2014 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19  */
  20 /**
  21  * @file transport/plugin_transport_tcp.c
  22  * @brief Implementation of the TCP transport service
  23  * @author Christian Grothoff
  24  */
  25 #include "platform.h"
  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"
  37
  38 #define LOG(kind,...) GNUNET_log_from (kind, "transport-tcp",__VA_ARGS__)
  39
  40 #define PLUGIN_NAME "tcp"
  41
  42 /**
  43  * How long until we give up on establishing an NAT connection?
  44  * Must be > 4 RTT
  45  */
  46 #define NAT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
  47
  48 GNUNET_NETWORK_STRUCT_BEGIN
  49
  50
  51 /**
  52  * Initial handshake message for a session.
  53  */
  54 struct WelcomeMessage
  55 {
  56   /**
  57    * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME.
  58    */
  59   struct GNUNET_MessageHeader header;
  60
  61   /**
  62    * Identity of the node connecting (TCP client)
  63    */
  64   struct GNUNET_PeerIdentity clientIdentity;
  65
  66 };
  67
  68 /**
  69  * Basically a WELCOME message, but with the purpose
  70  * of giving the waiting peer a client handle to use
  71  */
  72 struct TCP_NAT_ProbeMessage
  73 {
  74   /**
  75    * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE.
  76    */
  77   struct GNUNET_MessageHeader header;
  78
  79   /**
  80    * Identity of the sender of the message.
  81    */
  82   struct GNUNET_PeerIdentity clientIdentity;
  83
  84 };
  85 GNUNET_NETWORK_STRUCT_END
  86
  87 /**
  88  * Context for sending a NAT probe via TCP.
  89  */
  90 struct TCPProbeContext
  91 {
  92
  93   /**
  94    * Active probes are kept in a DLL.
  95    */
  96   struct TCPProbeContext *next;
  97
  98   /**
  99    * Active probes are kept in a DLL.
 100    */
 101   struct TCPProbeContext *prev;
 102
 103   /**
 104    * Probe connection.
 105    */
 106   struct GNUNET_CONNECTION_Handle *sock;
 107
 108   /**
 109    * Message to be sent.
 110    */
 111   struct TCP_NAT_ProbeMessage message;
 112
 113   /**
 114    * Handle to the transmission.
 115    */
 116   struct GNUNET_CONNECTION_TransmitHandle *transmit_handle;
 117
 118   /**
 119    * Transport plugin handle.
 120    */
 121   struct Plugin *plugin;
 122 };
 123
 124 /**
 125  * Bits in the `options` field of TCP addresses.
 126  */
 127 enum TcpAddressOptions
 128 {
 129
 130   /**
 131    * No bits set.
 132    */
 133   TCP_OPTIONS_NONE = 0,
 134
 135   /**
 136    * See #HTTP_OPTIONS_VERIFY_CERTIFICATE.
 137    */
 138   TCP_OPTIONS_RESERVED = 1,
 139
 140   /**
 141    * Enable TCP Stealth-style port knocking.
 142    */
 143   TCP_OPTIONS_TCP_STEALTH = 2
 144 };
 145
 146 GNUNET_NETWORK_STRUCT_BEGIN
 147
 148 /**
 149  * Network format for IPv4 addresses.
 150  */
 151 struct IPv4TcpAddress
 152 {
 153   /**
 154    * Optional options and flags for this address,
 155    * see `enum TcpAddressOptions`
 156    */
 157   uint32_t options;
 158
 159   /**
 160    * IPv4 address, in network byte order.
 161    */
 162   uint32_t ipv4_addr GNUNET_PACKED;
 163
 164   /**
 165    * Port number, in network byte order.
 166    */
 167   uint16_t t4_port GNUNET_PACKED;
 168
 169 };
 170
 171 /**
 172  * Network format for IPv6 addresses.
 173  */
 174 struct IPv6TcpAddress
 175 {
 176   /**
 177    * Optional flags for this address
 178    * see `enum TcpAddressOptions`
 179    */
 180   uint32_t options;
 181
 182   /**
 183    * IPv6 address.
 184    */
 185   struct in6_addr ipv6_addr GNUNET_PACKED;
 186
 187   /**
 188    * Port number, in network byte order.
 189    */
 190   uint16_t t6_port GNUNET_PACKED;
 191
 192 };
 193 GNUNET_NETWORK_STRUCT_END
 194
 195 /**
 196  * Encapsulation of all of the state of the plugin.
 197  */
 198 struct Plugin;
 199
 200 /**
 201  * Information kept for each message that is yet to
 202  * be transmitted.
 203  */
 204 struct PendingMessage
 205 {
 206
 207   /**
 208    * This is a doubly-linked list.
 209    */
 210   struct PendingMessage *next;
 211
 212   /**
 213    * This is a doubly-linked list.
 214    */
 215   struct PendingMessage *prev;
 216
 217   /**
 218    * The pending message
 219    */
 220   const char *msg;
 221
 222   /**
 223    * Continuation function to call once the message
 224    * has been sent.  Can be NULL if there is no
 225    * continuation to call.
 226    */
 227   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
 228
 229   /**
 230    * Closure for transmit_cont.
 231    */
 232   void *transmit_cont_cls;
 233
 234   /**
 235    * Timeout value for the pending message.
 236    */
 237   struct GNUNET_TIME_Absolute timeout;
 238
 239   /**
 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.
 243    */
 244   size_t message_size;
 245
 246 };
 247
 248 /**
 249  * Session handle for TCP connections.
 250  */
 251 struct Session
 252 {
 253   /**
 254    * To whom are we talking to (set to our identity
 255    * if we are still waiting for the welcome message)
 256    */
 257   struct GNUNET_PeerIdentity target;
 258
 259   /**
 260    * Pointer to the global plugin struct.
 261    */
 262   struct Plugin *plugin;
 263
 264   /**
 265    * The client (used to identify this connection)
 266    */
 267   struct GNUNET_SERVER_Client *client;
 268
 269   /**
 270    * Task cleaning up a NAT client connection establishment attempt;
 271    */
 272   struct GNUNET_SCHEDULER_Task * nat_connection_timeout;
 273
 274   /**
 275    * Messages currently pending for transmission
 276    * to this peer, if any.
 277    */
 278   struct PendingMessage *pending_messages_head;
 279
 280   /**
 281    * Messages currently pending for transmission
 282    * to this peer, if any.
 283    */
 284   struct PendingMessage *pending_messages_tail;
 285
 286   /**
 287    * Handle for pending transmission request.
 288    */
 289   struct GNUNET_SERVER_TransmitHandle *transmit_handle;
 290
 291   /**
 292    * Address of the other peer.
 293    */
 294   struct GNUNET_HELLO_Address *address;
 295
 296   /**
 297    * ID of task used to delay receiving more to throttle sender.
 298    */
 299   struct GNUNET_SCHEDULER_Task * receive_delay_task;
 300
 301   /**
 302    * Session timeout task
 303    */
 304   struct GNUNET_SCHEDULER_Task * timeout_task;
 305
 306   /**
 307    * When will this session time out?
 308    */
 309   struct GNUNET_TIME_Absolute timeout;
 310
 311   /**
 312    * When will we continue to read from the socket?
 313    * (used to enforce inbound quota).
 314    */
 315   struct GNUNET_TIME_Absolute receive_delay;
 316
 317   /**
 318    * Last activity on this connection.  Used to select preferred
 319    * connection.
 320    */
 321   struct GNUNET_TIME_Absolute last_activity;
 322
 323   /**
 324    * Number of bytes waiting for transmission to this peer.
 325    */
 326   unsigned long long bytes_in_queue;
 327
 328   /**
 329    * Number of messages waiting for transmission to this peer.
 330    */
 331   unsigned int msgs_in_queue;
 332
 333   /**
 334    * Are we still expecting the welcome message? (#GNUNET_YES/#GNUNET_NO)
 335    */
 336   int expecting_welcome;
 337
 338   /**
 339    * Was this session created using NAT traversal?
 340    */
 341   int is_nat;
 342
 343   /**
 344    * ATS network type in NBO
 345    */
 346   enum GNUNET_ATS_Network_Type ats_address_network_type;
 347 };
 348
 349 /**
 350  * Encapsulation of all of the state of the plugin.
 351  */
 352 struct Plugin
 353 {
 354   /**
 355    * Our environment.
 356    */
 357   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 358
 359   /**
 360    * The listen socket.
 361    */
 362   struct GNUNET_CONNECTION_Handle *lsock;
 363
 364   /**
 365    * Our handle to the NAT module.
 366    */
 367   struct GNUNET_NAT_Handle *nat;
 368
 369   /**
 370    * Map from peer identities to sessions for the given peer.
 371    */
 372   struct GNUNET_CONTAINER_MultiPeerMap *sessionmap;
 373
 374   /**
 375    * Handle to the network service.
 376    */
 377   struct GNUNET_SERVICE_Context *service;
 378
 379   /**
 380    * Handle to the server for this service.
 381    */
 382   struct GNUNET_SERVER_Handle *server;
 383
 384   /**
 385    * Copy of the handler array where the closures are
 386    * set to this struct's instance.
 387    */
 388   struct GNUNET_SERVER_MessageHandler *handlers;
 389
 390   /**
 391    * Map of peers we have tried to contact behind a NAT
 392    */
 393   struct GNUNET_CONTAINER_MultiPeerMap *nat_wait_conns;
 394
 395   /**
 396    * List of active TCP probes.
 397    */
 398   struct TCPProbeContext *probe_head;
 399
 400   /**
 401    * List of active TCP probes.
 402    */
 403   struct TCPProbeContext *probe_tail;
 404
 405   /**
 406    * Handle for (DYN)DNS lookup of our external IP.
 407    */
 408   struct GNUNET_RESOLVER_RequestHandle *ext_dns;
 409
 410   /**
 411    * Function to call about session status changes.
 412    */
 413   GNUNET_TRANSPORT_SessionInfoCallback sic;
 414
 415   /**
 416    * Closure for @e sic.
 417    */
 418   void *sic_cls;
 419
 420   /**
 421    * Welcome message used by this peer.
 422    */
 423   struct WelcomeMessage my_welcome;
 424
 425   /**
 426    * How many more TCP sessions are we allowed to open right now?
 427    */
 428   unsigned long long max_connections;
 429
 430   /**
 431    * How many more TCP sessions do we have right now?
 432    */
 433   unsigned long long cur_connections;
 434
 435   /**
 436    * ID of task used to update our addresses when one expires.
 437    */
 438   struct GNUNET_SCHEDULER_Task * address_update_task;
 439
 440   /**
 441    * Address options
 442    */
 443   uint32_t myoptions;
 444
 445   /**
 446    * Port that we are actually listening on.
 447    */
 448   uint16_t open_port;
 449
 450   /**
 451    * Port that the user said we would have visible to the
 452    * rest of the world.
 453    */
 454   uint16_t adv_port;
 455
 456 };
 457
 458
 459 /**
 460  * If a session monitor is attached, notify it about the new
 461  * session state.
 462  *
 463  * @param plugin our plugin
 464  * @param session session that changed state
 465  * @param state new state of the session
 466  */
 467 static void
 468 notify_session_monitor (struct Plugin *plugin,
 469                         struct Session *session,
 470                         enum GNUNET_TRANSPORT_SessionState state)
 471 {
 472   struct GNUNET_TRANSPORT_SessionInfo info;
 473
 474   if (NULL == plugin->sic)
 475     return;
 476   memset (&info, 0, sizeof (info));
 477   info.state = state;
 478   info.is_inbound = (0 != (GNUNET_HELLO_ADDRESS_INFO_INBOUND & session->address->local_info))
 479     ? GNUNET_YES
 480     : GNUNET_NO;
 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,
 488                session,
 489                &info);
 490 }
 491
 492
 493 /**
 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.
 498  *
 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
 503  */
 504 static const char *
 505 tcp_plugin_address_to_string (void *cls,
 506                               const void *addr,
 507                               size_t addrlen);
 508
 509
 510 /**
 511  * Function to check if an inbound connection is acceptable.
 512  * Mostly used to limit the total number of open connections
 513  * we can have.
 514  *
 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).
 521  */
 522 static int
 523 plugin_tcp_access_check (void *cls,
 524                          const struct GNUNET_CONNECTION_Credentials *ucred,
 525                          const struct sockaddr *addr,
 526                          socklen_t addrlen)
 527 {
 528   struct Plugin *plugin = cls;
 529
 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)
 534     return GNUNET_NO;
 535   plugin->cur_connections++;
 536   return GNUNET_YES;
 537 }
 538
 539
 540 /**
 541  * Our external IP address/port mapping has changed.
 542  *
 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
 548  */
 549 static void
 550 tcp_nat_port_map_callback (void *cls,
 551                            int add_remove,
 552                            const struct sockaddr *addr,
 553                            socklen_t addrlen)
 554 {
 555   struct Plugin *plugin = cls;
 556   struct GNUNET_HELLO_Address *address;
 557   struct IPv4TcpAddress t4;
 558   struct IPv6TcpAddress t6;
 559   void *arg;
 560   size_t args;
 561
 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)
 567   {
 568   case AF_INET:
 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;
 574     arg = &t4;
 575     args = sizeof (t4);
 576     break;
 577   case AF_INET6:
 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;
 584     arg = &t6;
 585     args = sizeof (t6);
 586     break;
 587   default:
 588     GNUNET_break(0);
 589     return;
 590   }
 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);
 598 }
 599
 600
 601 /**
 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.
 606  *
 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
 611  */
 612 static const char *
 613 tcp_plugin_address_to_string (void *cls,
 614                        const void *addr,
 615                        size_t addrlen)
 616 {
 617   static char rbuf[INET6_ADDRSTRLEN + 12];
 618   char buf[INET6_ADDRSTRLEN];
 619   const void *sb;
 620   struct in_addr a4;
 621   struct in6_addr a6;
 622   const struct IPv4TcpAddress *t4;
 623   const struct IPv6TcpAddress *t6;
 624   int af;
 625   uint16_t port;
 626   uint32_t options;
 627
 628   switch (addrlen)
 629   {
 630   case sizeof(struct IPv6TcpAddress):
 631     t6 = addr;
 632     af = AF_INET6;
 633     port = ntohs (t6->t6_port);
 634     options = ntohl (t6->options);
 635     memcpy (&a6, &t6->ipv6_addr, sizeof(a6));
 636     sb = &a6;
 637     break;
 638   case sizeof(struct IPv4TcpAddress):
 639     t4 = addr;
 640     af = AF_INET;
 641     port = ntohs (t4->t4_port);
 642     options = ntohl (t4->options);
 643     memcpy (&a4, &t4->ipv4_addr, sizeof(a4));
 644     sb = &a4;
 645     break;
 646   default:
 647     LOG (GNUNET_ERROR_TYPE_WARNING,
 648          _("Unexpected address length: %u bytes\n"),
 649          (unsigned int) addrlen);
 650     return NULL ;
 651   }
 652   if (NULL == inet_ntop (af, sb, buf, INET6_ADDRSTRLEN))
 653   {
 654     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
 655                          "inet_ntop");
 656     return NULL ;
 657   }
 658   GNUNET_snprintf (rbuf, sizeof(rbuf),
 659                    (af == AF_INET6) ? "%s.%u.[%s]:%u" : "%s.%u.%s:%u",
 660                    PLUGIN_NAME,
 661                    options,
 662                    buf,
 663                    port);
 664   return rbuf;
 665 }
 666
 667
 668 /**
 669  * Function called to convert a string address to
 670  * a binary address.
 671  *
 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
 679  */
 680 static int
 681 tcp_plugin_string_to_address (void *cls,
 682                               const char *addr,
 683                               uint16_t addrlen,
 684                               void **buf,
 685                               size_t *added)
 686 {
 687   struct sockaddr_storage socket_address;
 688   char *address;
 689   char *plugin;
 690   char *optionstr;
 691   uint32_t options;
 692
 693   /* Format tcp.options.address:port */
 694   address = NULL;
 695   plugin = NULL;
 696   optionstr = NULL;
 697   if ((NULL == addr) || (addrlen == 0))
 698   {
 699     GNUNET_break(0);
 700     return GNUNET_SYSERR;
 701   }
 702   if ('\0' != addr[addrlen - 1])
 703   {
 704     GNUNET_break(0);
 705     return GNUNET_SYSERR;
 706   }
 707   if (strlen (addr) != addrlen - 1)
 708   {
 709     GNUNET_break(0);
 710     return GNUNET_SYSERR;
 711   }
 712   plugin = GNUNET_strdup (addr);
 713   optionstr = strchr (plugin, '.');
 714   if (NULL == optionstr)
 715   {
 716     GNUNET_break(0);
 717     GNUNET_free(plugin);
 718     return GNUNET_SYSERR;
 719   }
 720   optionstr[0] = '\0';
 721   optionstr++;
 722   options = atol (optionstr);
 723   address = strchr (optionstr, '.');
 724   if (NULL == address)
 725   {
 726     GNUNET_break(0);
 727     GNUNET_free(plugin);
 728     return GNUNET_SYSERR;
 729   }
 730   address[0] = '\0';
 731   address++;
 732
 733   if (GNUNET_OK
 734       != GNUNET_STRINGS_to_address_ip (address, strlen (address),
 735           &socket_address))
 736   {
 737     GNUNET_break(0);
 738     GNUNET_free(plugin);
 739     return GNUNET_SYSERR;
 740   }
 741
 742   GNUNET_free(plugin);
 743   switch (socket_address.ss_family)
 744   {
 745   case AF_INET:
 746   {
 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;
 753     *buf = t4;
 754     *added = sizeof(struct IPv4TcpAddress);
 755     return GNUNET_OK;
 756   }
 757   case AF_INET6:
 758   {
 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;
 765     *buf = t6;
 766     *added = sizeof(struct IPv6TcpAddress);
 767     return GNUNET_OK;
 768   }
 769   default:
 770     return GNUNET_SYSERR;
 771   }
 772 }
 773
 774
 775 /**
 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.
 780  *
 781  * @param plugin the plugin
 782  * @param client which client to find the session handle for
 783  * @return NULL if no matching session exists
 784  */
 785 static struct Session *
 786 lookup_session_by_client (struct Plugin *plugin,
 787                           struct GNUNET_SERVER_Client *client)
 788 {
 789   return GNUNET_SERVER_client_get_user_context (client, struct Session);
 790 }
 791
 792
 793 /**
 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.
 797  *
 798  * @param cls the `struct Plugin`
 799  * @param session session to close down
 800  * @return #GNUNET_OK on success
 801  */
 802 static int
 803 tcp_plugin_disconnect_session (void *cls,
 804                                struct Session *session)
 805 {
 806   struct Plugin *plugin = cls;
 807   struct PendingMessage *pm;
 808
 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));
 815
 816   if (NULL != session->timeout_task)
 817   {
 818     GNUNET_SCHEDULER_cancel (session->timeout_task);
 819     session->timeout_task = NULL;
 820     session->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
 821   }
 822
 823   if (GNUNET_YES ==
 824       GNUNET_CONTAINER_multipeermap_remove (plugin->sessionmap,
 825                                             &session->target,
 826                                             session))
 827   {
 828     GNUNET_STATISTICS_update (session->plugin->env->stats,
 829         gettext_noop ("# TCP sessions active"), -1, GNUNET_NO);
 830   }
 831   else
 832   {
 833     GNUNET_assert(GNUNET_YES ==
 834                   GNUNET_CONTAINER_multipeermap_remove (plugin->nat_wait_conns,
 835                                                         &session->target,
 836                                                         session));
 837   }
 838   if (NULL != session->client)
 839     GNUNET_SERVER_client_set_user_context (session->client,
 840                                            NULL);
 841
 842   /* clean up state */
 843   if (NULL != session->transmit_handle)
 844   {
 845     GNUNET_SERVER_notify_transmit_ready_cancel (session->transmit_handle);
 846     session->transmit_handle = NULL;
 847   }
 848   plugin->env->unregister_quota_notification (plugin->env->cls,
 849                                               &session->target,
 850                                               PLUGIN_NAME,
 851                                               session);
 852   session->plugin->env->session_end (session->plugin->env->cls,
 853                                      session->address,
 854                                      session);
 855
 856   if (NULL != session->nat_connection_timeout)
 857   {
 858     GNUNET_SCHEDULER_cancel (session->nat_connection_timeout);
 859     session->nat_connection_timeout = NULL;
 860   }
 861
 862   while (NULL != (pm = session->pending_messages_head))
 863   {
 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)"),
 874                               pm->message_size,
 875                               GNUNET_NO);
 876     GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
 877                                  session->pending_messages_tail,
 878                                  pm);
 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,
 885                          &session->target,
 886                          GNUNET_SYSERR,
 887                          pm->message_size,
 888                          0);
 889     GNUNET_free (pm);
 890   }
 891   GNUNET_assert (0 == session->msgs_in_queue);
 892   GNUNET_assert (0 == session->bytes_in_queue);
 893   notify_session_monitor (session->plugin,
 894                           session,
 895                           GNUNET_TRANSPORT_SS_DONE);
 896
 897   if (session->receive_delay_task != NULL)
 898   {
 899     GNUNET_SCHEDULER_cancel (session->receive_delay_task);
 900     if (NULL != session->client)
 901       GNUNET_SERVER_receive_done (session->client, GNUNET_SYSERR);
 902   }
 903   if (NULL != session->client)
 904   {
 905     GNUNET_SERVER_client_disconnect (session->client);
 906     GNUNET_SERVER_client_drop (session->client);
 907     session->client = NULL;
 908   }
 909   GNUNET_HELLO_address_free (session->address);
 910   GNUNET_assert(NULL == session->transmit_handle);
 911   GNUNET_free(session);
 912   return GNUNET_OK;
 913 }
 914
 915
 916 /**
 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.
 920  *
 921  * @param cls closure with the `struct Plugin`
 922  * @return keepalive factor
 923  */
 924 static unsigned int
 925 tcp_plugin_query_keepalive_factor (void *cls)
 926 {
 927   return 3;
 928 }
 929
 930
 931 /**
 932  * Session was idle, so disconnect it
 933  *
 934  * @param cls the `struct Session` of the idle session
 935  * @param tc scheduler context
 936  */
 937 static void
 938 session_timeout (void *cls,
 939                  const struct GNUNET_SCHEDULER_TaskContext *tc)
 940 {
 941   struct Session *s = cls;
 942   struct GNUNET_TIME_Relative left;
 943
 944   s->timeout_task = NULL;
 945   left = GNUNET_TIME_absolute_get_remaining (s->timeout);
 946   if (0 != left.rel_value_us)
 947   {
 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,
 951                             s,
 952                             GNUNET_TRANSPORT_SS_UPDATE);
 953     s->timeout_task = GNUNET_SCHEDULER_add_delayed (left,
 954                                                     &session_timeout,
 955                                                     s);
 956     return;
 957   }
 958   LOG (GNUNET_ERROR_TYPE_DEBUG,
 959        "Session %p was idle for %s, disconnecting\n",
 960        s,
 961        GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 962                                                GNUNET_YES));
 963   /* call session destroy function */
 964   tcp_plugin_disconnect_session (s->plugin, s);
 965 }
 966
 967
 968 /**
 969  * Increment session timeout due to activity
 970  *
 971  * @param s session to increment timeout for
 972  */
 973 static void
 974 reschedule_session_timeout (struct Session *s)
 975 {
 976   GNUNET_assert(NULL != s->timeout_task);
 977   s->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
 978 }
 979
 980
 981 /**
 982  * Create a new session.  Also queues a welcome message.
 983  *
 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
 989  *               the session
 990  * @return new session object
 991  */
 992 static struct Session *
 993 create_session (struct Plugin *plugin,
 994                 const struct GNUNET_HELLO_Address *address,
 995                 struct GNUNET_SERVER_Client *client,
 996                 int is_nat)
 997 {
 998   struct Session *session;
 999   struct PendingMessage *pm;
1000
1001   if (GNUNET_YES != is_nat)
1002     GNUNET_assert (NULL != client);
1003   else
1004     GNUNET_assert (NULL == client);
1005
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);
1022   memcpy (&pm[1],
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,
1028                             GNUNET_NO);
1029   GNUNET_CONTAINER_DLL_insert (session->pending_messages_head,
1030                                session->pending_messages_tail,
1031                                pm);
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,
1036                                                         &session_timeout,
1037                                                         session);
1038   notify_session_monitor (session->plugin,
1039                           session,
1040                           GNUNET_TRANSPORT_SS_INIT);
1041   if (GNUNET_YES != is_nat)
1042   {
1043     GNUNET_STATISTICS_update (plugin->env->stats,
1044                               gettext_noop ("# TCP sessions active"),
1045                               1,
1046                               GNUNET_NO);
1047     notify_session_monitor (session->plugin,
1048                             session,
1049                             GNUNET_TRANSPORT_SS_UP);
1050   }
1051   else
1052   {
1053     notify_session_monitor (session->plugin,
1054                             session,
1055                             GNUNET_TRANSPORT_SS_HANDSHAKE);
1056   }
1057   plugin->env->register_quota_notification (plugin->env->cls,
1058                                             &address->peer,
1059                                             PLUGIN_NAME,
1060                                             session);
1061   return session;
1062 }
1063
1064
1065 /**
1066  * If we have pending messages, ask the server to
1067  * transmit them (schedule the respective tasks, etc.)
1068  *
1069  * @param session for which session should we do this
1070  */
1071 static void
1072 process_pending_messages (struct Session *session);
1073
1074
1075 /**
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.
1080  *
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
1085  */
1086 static size_t
1087 do_transmit (void *cls, size_t size, void *buf)
1088 {
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;
1096   char *cbuf;
1097   size_t ret;
1098
1099   session->transmit_handle = NULL;
1100   plugin = session->plugin;
1101   if (NULL == buf)
1102   {
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 */
1107     hd = NULL;
1108     tl = NULL;
1109     ret = 0;
1110     now = GNUNET_TIME_absolute_get ();
1111     while ((NULL != (pos = session->pending_messages_head))
1112         && (pos->timeout.abs_value_us <= now.abs_value_us))
1113     {
1114       GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
1115                                    session->pending_messages_tail,
1116                                    pos);
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",
1123            pos->message_size,
1124            GNUNET_i2s (&session->target));
1125       ret += pos->message_size;
1126       GNUNET_CONTAINER_DLL_insert_after (hd, tl, tl, pos);
1127     }
1128     /* do this call before callbacks (so that if callbacks destroy
1129      * session, they have a chance to cancel actions done by this
1130      * call) */
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))
1136     {
1137       GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
1138       if (pos->transmit_cont != NULL)
1139         pos->transmit_cont (pos->transmit_cont_cls,
1140                             &pid,
1141                             GNUNET_SYSERR,
1142                             pos->message_size, 0);
1143       GNUNET_free (pos);
1144     }
1145     GNUNET_STATISTICS_update (plugin->env->stats,
1146                               gettext_noop ("# bytes currently in TCP buffers"), -(int64_t) ret,
1147                               GNUNET_NO);
1148     GNUNET_STATISTICS_update (plugin->env->stats,
1149                               gettext_noop ("# bytes discarded by TCP (timeout)"),
1150                               ret,
1151                               GNUNET_NO);
1152     if (0 < ret)
1153       notify_session_monitor (session->plugin,
1154                               session,
1155                               GNUNET_TRANSPORT_SS_UPDATE);
1156     return 0;
1157   }
1158   /* copy all pending messages that would fit */
1159   ret = 0;
1160   cbuf = buf;
1161   hd = NULL;
1162   tl = NULL;
1163   while (NULL != (pos = session->pending_messages_head))
1164   {
1165     if (ret + pos->message_size > size)
1166       break;
1167     GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
1168                                  session->pending_messages_tail,
1169                                  pos);
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),
1178         pos->message_size);
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);
1185   }
1186   notify_session_monitor (session->plugin,
1187                           session,
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
1191    * exists... */
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))
1198   {
1199     GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
1200     if (pos->transmit_cont != NULL)
1201       pos->transmit_cont (pos->transmit_cont_cls,
1202                           &pid,
1203                           GNUNET_OK,
1204                           pos->message_size,
1205                           pos->message_size); /* FIXME: include TCP overhead */
1206     GNUNET_free(pos);
1207   }
1208   GNUNET_assert (NULL == hd);
1209   GNUNET_assert (NULL == tl);
1210   LOG(GNUNET_ERROR_TYPE_DEBUG,
1211       "Transmitting %u bytes\n",
1212       ret);
1213   GNUNET_STATISTICS_update (plugin->env->stats,
1214                             gettext_noop ("# bytes currently in TCP buffers"),
1215                             - (int64_t) ret,
1216                             GNUNET_NO);
1217   GNUNET_STATISTICS_update (plugin->env->stats,
1218                             gettext_noop ("# bytes transmitted via TCP"),
1219                             ret,
1220                             GNUNET_NO);
1221   return ret;
1222 }
1223
1224
1225 /**
1226  * If we have pending messages, ask the server to
1227  * transmit them (schedule the respective tasks, etc.)
1228  *
1229  * @param session for which session should we do this
1230  */
1231 static void
1232 process_pending_messages (struct Session *session)
1233 {
1234   struct PendingMessage *pm;
1235
1236   GNUNET_assert (NULL != session->client);
1237   if (NULL != session->transmit_handle)
1238     return;
1239   if (NULL == (pm = session->pending_messages_head))
1240     return;
1241
1242   session->transmit_handle = GNUNET_SERVER_notify_transmit_ready (session->client,
1243                                                                   pm->message_size,
1244                                                                   GNUNET_TIME_absolute_get_remaining (pm->timeout),
1245                                                                   &do_transmit,
1246                                                                   session);
1247 }
1248
1249
1250 /**
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.
1257  *
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
1267  *                this as well)
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)
1276  */
1277 static ssize_t
1278 tcp_plugin_send (void *cls,
1279                  struct Session *session,
1280                  const char *msgbuf,
1281                  size_t msgbuf_size,
1282                  unsigned int priority,
1283                  struct GNUNET_TIME_Relative to,
1284                  GNUNET_TRANSPORT_TransmitContinuation cont,
1285                  void *cont_cls)
1286 {
1287   struct Plugin * plugin = cls;
1288   struct PendingMessage *pm;
1289
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;
1298
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));
1302
1303   if (GNUNET_YES ==
1304       GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessionmap,
1305                                                     &session->target,
1306                                                     session))
1307   {
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,
1313         GNUNET_NO);
1314
1315     /* append pm to pending_messages list */
1316     GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1317                                       session->pending_messages_tail,
1318                                       pm);
1319     notify_session_monitor (session->plugin,
1320                             session,
1321                             GNUNET_TRANSPORT_SS_UPDATE);
1322     session->msgs_in_queue++;
1323     session->bytes_in_queue += pm->message_size;
1324     process_pending_messages (session);
1325     return msgbuf_size;
1326   }
1327   else if (GNUNET_YES ==
1328            GNUNET_CONTAINER_multipeermap_contains_value (plugin->nat_wait_conns,
1329                                                          &session->target,
1330                                                          session))
1331   {
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,
1337                               GNUNET_NO);
1338     /* append pm to pending_messages list */
1339     GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1340                                       session->pending_messages_tail,
1341                                       pm);
1342     session->msgs_in_queue++;
1343     session->bytes_in_queue += pm->message_size;
1344     notify_session_monitor (session->plugin,
1345                             session,
1346                             GNUNET_TRANSPORT_SS_HANDSHAKE);
1347     return msgbuf_size;
1348   }
1349   else
1350   {
1351     LOG(GNUNET_ERROR_TYPE_ERROR,
1352         "Invalid session %p\n",
1353         session);
1354     if (NULL != cont)
1355       cont (cont_cls,
1356             &session->target,
1357             GNUNET_SYSERR,
1358             pm->message_size,
1359             0);
1360     GNUNET_break (0);
1361     GNUNET_free (pm);
1362     return GNUNET_SYSERR; /* session does not exist here */
1363   }
1364 }
1365
1366 /**
1367  * Closure for #session_lookup_it().
1368  */
1369 struct SessionItCtx
1370 {
1371   /**
1372    * Address we are looking for.
1373    */
1374   const struct GNUNET_HELLO_Address *address;
1375
1376   /**
1377    * Where to store the session (if we found it).
1378    */
1379   struct Session *result;
1380
1381 };
1382
1383
1384 /**
1385  * Look for a session by address.
1386  *
1387  * @param cls the `struct SessionItCtx`
1388  * @param key unused
1389  * @param value a `struct Session`
1390  * @return #GNUNET_YES to continue looking, #GNUNET_NO if we found the session
1391  */
1392 static int
1393 session_lookup_it (void *cls,
1394                    const struct GNUNET_PeerIdentity *key,
1395                    void *value)
1396 {
1397   struct SessionItCtx * si_ctx = cls;
1398   struct Session * session = value;
1399
1400   if (0 != GNUNET_HELLO_address_cmp (si_ctx->address, session->address))
1401     return GNUNET_YES;
1402   /* Found existing session */
1403   si_ctx->result = session;
1404   return GNUNET_NO;
1405 }
1406
1407
1408 /**
1409  * Task cleaning up a NAT connection attempt after timeout
1410  *
1411  * @param cls the `struct Session`
1412  * @param tc scheduler context (unused)
1413  */
1414 static void
1415 nat_connect_timeout (void *cls,
1416                      const struct GNUNET_SCHEDULER_TaskContext *tc)
1417 {
1418   struct Session *session = cls;
1419
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,
1428                                  session);
1429 }
1430
1431
1432 /**
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
1436  *
1437  * @param cls closure
1438  * @param peer which peer was the session for
1439  * @param session which session is being updated
1440  */
1441 static void
1442 tcp_plugin_update_session_timeout (void *cls,
1443                                    const struct GNUNET_PeerIdentity *peer,
1444                                    struct Session *session)
1445 {
1446   reschedule_session_timeout (session);
1447 }
1448
1449
1450 /**
1451  * Task to signal the server that we can continue
1452  * receiving from the TCP client now.
1453  *
1454  * @param cls the `struct Session*`
1455  * @param tc task context (unused)
1456  */
1457 static void
1458 delayed_done (void *cls,
1459               const struct GNUNET_SCHEDULER_TaskContext *tc)
1460 {
1461   struct Session *session = cls;
1462
1463   session->receive_delay_task = NULL;
1464   reschedule_session_timeout (session);
1465
1466   GNUNET_SERVER_receive_done (session->client, GNUNET_OK);
1467 }
1468
1469
1470 /**
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
1474  *
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
1479  */
1480 static void
1481 tcp_plugin_update_inbound_delay (void *cls,
1482                                  const struct GNUNET_PeerIdentity *peer,
1483                                  struct Session *session,
1484                                  struct GNUNET_TIME_Relative delay)
1485 {
1486   if (NULL == session->receive_delay_task)
1487     return;
1488   LOG (GNUNET_ERROR_TYPE_DEBUG,
1489        "New inbound delay %s\n",
1490        GNUNET_STRINGS_relative_time_to_string (delay,
1491                                                GNUNET_NO));
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,
1495                                                               &delayed_done,
1496                                                               session);
1497 }
1498
1499
1500 /**
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
1504  *
1505  * @param cls closure
1506  * @param address the address to use
1507  * @return the session if the address is valid, NULL otherwise
1508  */
1509 static struct Session *
1510 tcp_plugin_get_session (void *cls,
1511                         const struct GNUNET_HELLO_Address *address)
1512 {
1513   struct Plugin *plugin = cls;
1514   struct Session *session = NULL;
1515   int af;
1516   const void *sb;
1517   size_t sbs;
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;
1526   size_t addrlen;
1527 #ifdef TCP_STEALTH
1528   struct GNUNET_NETWORK_Handle *s;
1529 #endif
1530
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));
1536
1537   if (GNUNET_HELLO_address_check_option(address, GNUNET_HELLO_ADDRESS_INFO_INBOUND))
1538   {
1539     GNUNET_break (0);
1540     return NULL;
1541   }
1542
1543   /* look for existing session */
1544   if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (plugin->sessionmap,
1545           &address->peer))
1546   {
1547     struct SessionItCtx si_ctx;
1548
1549     si_ctx.address = address;
1550     si_ctx.result = NULL;
1551
1552     GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessionmap,
1553         &address->peer, &session_lookup_it, &si_ctx);
1554     if (si_ctx.result != NULL)
1555     {
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),
1561           session);
1562       return session;
1563     }
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,
1567                                        address->address,
1568                                        address->address_length),
1569         GNUNET_i2s (&address->peer));
1570   }
1571
1572   if (addrlen == sizeof(struct IPv6TcpAddress))
1573   {
1574     GNUNET_assert(NULL != address->address); /* make static analysis happy */
1575     t6 = address->address;
1576     options = t6->options;
1577     af = AF_INET6;
1578     memset (&a6, 0, sizeof(a6));
1579 #if HAVE_SOCKADDR_IN_SIN_LEN
1580     a6.sin6_len = sizeof (a6);
1581 #endif
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));
1587     sb = &a6;
1588     sbs = sizeof(a6);
1589   }
1590   else if (addrlen == sizeof(struct IPv4TcpAddress))
1591   {
1592     GNUNET_assert(NULL != address->address); /* make static analysis happy */
1593     t4 = address->address;
1594     options = t4->options;
1595     af = AF_INET;
1596     memset (&a4, 0, sizeof(a4));
1597 #if HAVE_SOCKADDR_IN_SIN_LEN
1598     a4.sin_len = sizeof (a4);
1599 #endif
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;
1605     sb = &a4;
1606     sbs = sizeof(a4);
1607   }
1608   else
1609   {
1610     GNUNET_STATISTICS_update (plugin->env->stats, gettext_noop
1611     ("# requests to create session with invalid address"), 1, GNUNET_NO);
1612     return NULL;
1613   }
1614
1615   net_type = plugin->env->get_address_type (plugin->env->cls, sb, sbs);
1616
1617
1618   if ((is_natd == GNUNET_YES) && (addrlen == sizeof(struct IPv6TcpAddress)))
1619   {
1620     /* NAT client only works with IPv4 addresses */
1621     return NULL;
1622   }
1623
1624   if (plugin->cur_connections >= plugin->max_connections)
1625   {
1626     /* saturated */
1627     return NULL;
1628   }
1629
1630   if ((is_natd == GNUNET_YES)
1631       && (GNUNET_YES
1632           == GNUNET_CONTAINER_multipeermap_contains (plugin->nat_wait_conns,
1633               &address->peer)))
1634   {
1635     /* Only do one NAT punch attempt per peer identity */
1636     return NULL;
1637   }
1638
1639   if ((is_natd == GNUNET_YES) && (NULL != plugin->nat) &&
1640       (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (plugin->nat_wait_conns,
1641               &address->peer)))
1642   {
1643     LOG (GNUNET_ERROR_TYPE_DEBUG,
1644          "Found valid IPv4 NAT address (creating session)!\n");
1645     session = create_session (plugin,
1646                               address,
1647                               NULL,
1648                               GNUNET_YES);
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,
1653                                                                     session);
1654     GNUNET_assert(GNUNET_OK ==
1655                   GNUNET_CONTAINER_multipeermap_put (plugin->nat_wait_conns,
1656                                                      &session->target,
1657                                                      session,
1658                                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1659
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))
1665     {
1666       return session;
1667     }
1668     else
1669     {
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,
1675                                      session);
1676       return NULL;
1677     }
1678   }
1679
1680   /* create new outbound session */
1681   GNUNET_assert(plugin->cur_connections <= plugin->max_connections);
1682
1683   if (0 != (options & TCP_OPTIONS_TCP_STEALTH))
1684   {
1685 #ifdef TCP_STEALTH
1686     s = GNUNET_NETWORK_socket_create (af, SOCK_STREAM, 0);
1687     if (NULL == s)
1688     {
1689       GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
1690                            "socket");
1691       sa = NULL;
1692     }
1693     else
1694     {
1695       if ( (GNUNET_OK !=
1696             GNUNET_NETWORK_socket_setsockopt (s,
1697                                               IPPROTO_TCP,
1698                                               TCP_STEALTH,
1699                                               &session->target,
1700                                               sizeof (struct GNUNET_PeerIdentity))) ||
1701            (GNUNET_OK !=
1702             GNUNET_NETWORK_socket_setsockopt (s,
1703                                               IPPROTO_TCP,
1704                                               TCP_STEALTH_INTEGRITY,
1705                                               &plugin->my_welcome,
1706                                               sizeof (struct WelcomeMessage))) )
1707       {
1708         /* TCP STEALTH not supported by kernel */
1709         GNUNET_break (GNUNET_OK ==
1710                       GNUNET_NETWORK_socket_close (s));
1711         sa = NULL;
1712       }
1713       else
1714       {
1715         sa = GNUNET_CONNECTION_connect_socket (s, sb, sbs);
1716       }
1717     }
1718 #else
1719     sa = NULL;
1720 #endif
1721   }
1722   else
1723   {
1724     sa = GNUNET_CONNECTION_create_from_sockaddr (af, sb, sbs);
1725   }
1726   if (NULL == sa)
1727   {
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));
1732     return NULL;
1733   }
1734   plugin->cur_connections++;
1735   if (plugin->cur_connections == plugin->max_connections)
1736     GNUNET_SERVER_suspend (plugin->server); /* Maximum number of connections rechead */
1737
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));
1741
1742   session = create_session (plugin,
1743                             address,
1744                             GNUNET_SERVER_connect_socket (plugin->server, sa),
1745                             GNUNET_NO);
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,
1750                                      &session->target,
1751                                      session,
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,
1757                                      address->address,
1758                                      address->address_length),
1759        session);
1760   /* Send TCP Welcome */
1761   process_pending_messages (session);
1762
1763   return session;
1764 }
1765
1766
1767 static int
1768 session_disconnect_it (void *cls,
1769                        const struct GNUNET_PeerIdentity *key,
1770                        void *value)
1771 {
1772   struct Plugin *plugin = cls;
1773   struct Session *session = value;
1774
1775   GNUNET_STATISTICS_update (session->plugin->env->stats,
1776                             gettext_noop ("# transport-service disconnect requests for TCP"),
1777                             1,
1778                             GNUNET_NO);
1779   tcp_plugin_disconnect_session (plugin,
1780                                  session);
1781   return GNUNET_YES;
1782 }
1783
1784
1785 /**
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).
1792  *
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.
1796  *
1797  * @param cls closure
1798  * @param target peer for which the last transmission is
1799  *        to be cancelled
1800  */
1801 static void
1802 tcp_plugin_disconnect (void *cls,
1803                        const struct GNUNET_PeerIdentity *target)
1804 {
1805   struct Plugin *plugin = cls;
1806
1807   LOG(GNUNET_ERROR_TYPE_DEBUG,
1808       "Disconnecting peer `%4s'\n",
1809       GNUNET_i2s (target));
1810   GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessionmap,
1811                                               target,
1812                                               &session_disconnect_it,
1813                                               plugin);
1814   GNUNET_CONTAINER_multipeermap_get_multiple (plugin->nat_wait_conns,
1815                                               target,
1816                                               &session_disconnect_it,
1817                                               plugin);
1818 }
1819
1820
1821 /**
1822  * Running pretty printers: head
1823  */
1824 static struct PrettyPrinterContext *ppc_dll_head;
1825
1826 /**
1827  * Running pretty printers: tail
1828  */
1829 static struct PrettyPrinterContext *ppc_dll_tail;
1830
1831 /**
1832  * Context for address to string conversion, closure
1833  * for #append_port().
1834  */
1835 struct PrettyPrinterContext
1836 {
1837   /**
1838    * DLL
1839    */
1840   struct PrettyPrinterContext *next;
1841
1842   /**
1843    * DLL
1844    */
1845   struct PrettyPrinterContext *prev;
1846
1847   /**
1848    * Timeout task
1849    */
1850   struct GNUNET_SCHEDULER_Task * timeout_task;
1851
1852   /**
1853    * Resolver handle
1854    */
1855   struct GNUNET_RESOLVER_RequestHandle *resolver_handle;
1856
1857   /**
1858    * Function to call with the result.
1859    */
1860   GNUNET_TRANSPORT_AddressStringCallback asc;
1861
1862   /**
1863    * Clsoure for @e asc.
1864    */
1865   void *asc_cls;
1866
1867   /**
1868    * Port to add after the IP address.
1869    */
1870   uint16_t port;
1871
1872   /**
1873    * IPv6 address
1874    */
1875   int ipv6;
1876
1877   /**
1878    * Options
1879    */
1880   uint32_t options;
1881 };
1882
1883
1884 /**
1885  * Append our port and forward the result.
1886  *
1887  * @param cls the `struct PrettyPrinterContext *`
1888  * @param hostname hostname part of the address
1889  */
1890 static void
1891 append_port (void *cls,
1892              const char *hostname)
1893 {
1894   struct PrettyPrinterContext *ppc = cls;
1895   char *ret;
1896
1897   if (NULL == hostname)
1898   {
1899     /* Final call, done */
1900     ppc->resolver_handle = NULL;
1901     GNUNET_CONTAINER_DLL_remove (ppc_dll_head,
1902                                  ppc_dll_tail,
1903                                  ppc);
1904     ppc->asc (ppc->asc_cls,
1905               NULL,
1906               GNUNET_OK);
1907     GNUNET_free (ppc);
1908     return;
1909   }
1910   if (GNUNET_YES == ppc->ipv6)
1911     GNUNET_asprintf (&ret,
1912                      "%s.%u.[%s]:%d",
1913                      PLUGIN_NAME,
1914                      ppc->options,
1915                      hostname,
1916                      ppc->port);
1917   else
1918     GNUNET_asprintf (&ret,
1919                      "%s.%u.%s:%d",
1920                      PLUGIN_NAME,
1921                      ppc->options,
1922                      hostname,
1923                      ppc->port);
1924   ppc->asc (ppc->asc_cls,
1925             ret,
1926             GNUNET_OK);
1927   GNUNET_free (ret);
1928 }
1929
1930
1931 /**
1932  * Convert the transports address to a nice, human-readable
1933  * format.
1934  *
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
1944  */
1945 static void
1946 tcp_plugin_address_pretty_printer (void *cls,
1947                                    const char *type,
1948                                    const void *addr,
1949                                    size_t addrlen,
1950                                    int numeric,
1951                                    struct GNUNET_TIME_Relative timeout,
1952                                    GNUNET_TRANSPORT_AddressStringCallback asc,
1953                                    void *asc_cls)
1954 {
1955   struct PrettyPrinterContext *ppc;
1956   const void *sb;
1957   size_t sbs;
1958   struct sockaddr_in a4;
1959   struct sockaddr_in6 a6;
1960   const struct IPv4TcpAddress *t4;
1961   const struct IPv6TcpAddress *t6;
1962   uint16_t port;
1963   uint32_t options;
1964
1965   if (sizeof(struct IPv6TcpAddress) == addrlen)
1966   {
1967     t6 = addr;
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);
1974     sb = &a6;
1975     sbs = sizeof(a6);
1976   }
1977   else if (sizeof(struct IPv4TcpAddress) == addrlen)
1978   {
1979     t4 = addr;
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);
1986     sb = &a4;
1987     sbs = sizeof(a4);
1988   }
1989   else
1990   {
1991     /* invalid address */
1992     asc (asc_cls, NULL, GNUNET_SYSERR);
1993     asc (asc_cls, NULL, GNUNET_OK);
1994     return;
1995   }
1996   ppc = GNUNET_new (struct PrettyPrinterContext);
1997   if (addrlen == sizeof(struct IPv6TcpAddress))
1998     ppc->ipv6 = GNUNET_YES;
1999   else
2000     ppc->ipv6 = GNUNET_NO;
2001   ppc->asc = asc;
2002   ppc->asc_cls = asc_cls;
2003   ppc->port = port;
2004   ppc->options = options;
2005   ppc->resolver_handle = GNUNET_RESOLVER_hostname_get (sb,
2006                                                        sbs,
2007                                                        ! numeric,
2008                                                        timeout,
2009                                                        &append_port, ppc);
2010   if (NULL == ppc->resolver_handle)
2011   {
2012     GNUNET_break (0);
2013     GNUNET_free (ppc);
2014     return;
2015   }
2016   GNUNET_CONTAINER_DLL_insert (ppc_dll_head,
2017                                ppc_dll_tail,
2018                                ppc);
2019 }
2020
2021
2022 /**
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
2026  * #GNUNET_SYSERR.
2027  *
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
2031  */
2032 static int
2033 check_port (struct Plugin *plugin, uint16_t in_port)
2034 {
2035   if ((in_port == plugin->adv_port) || (in_port == plugin->open_port))
2036     return GNUNET_OK;
2037   return GNUNET_SYSERR;
2038 }
2039
2040 /**
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
2047  * traffic.
2048  *
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
2054  */
2055 static int
2056 tcp_plugin_check_address (void *cls, const void *addr, size_t addrlen)
2057 {
2058   struct Plugin *plugin = cls;
2059   struct IPv4TcpAddress *v4;
2060   struct IPv6TcpAddress *v6;
2061
2062   if ((addrlen != sizeof(struct IPv4TcpAddress))
2063       && (addrlen != sizeof(struct IPv6TcpAddress)))
2064   {
2065     GNUNET_break_op(0);
2066     return GNUNET_SYSERR;
2067   }
2068
2069   if (addrlen == sizeof(struct IPv4TcpAddress))
2070   {
2071     v4 = (struct IPv4TcpAddress *) addr;
2072     if (0 != memcmp (&v4->options,
2073                      &plugin->myoptions,
2074                      sizeof(uint32_t)))
2075     {
2076       GNUNET_break(0);
2077       return GNUNET_SYSERR;
2078     }
2079     if (GNUNET_OK != check_port (plugin, ntohs (v4->t4_port)))
2080       return GNUNET_SYSERR;
2081     if (GNUNET_OK
2082         != GNUNET_NAT_test_address (plugin->nat, &v4->ipv4_addr,
2083             sizeof(struct in_addr)))
2084       return GNUNET_SYSERR;
2085   }
2086   else
2087   {
2088     v6 = (struct IPv6TcpAddress *) addr;
2089     if (IN6_IS_ADDR_LINKLOCAL (&v6->ipv6_addr))
2090     {
2091       GNUNET_break_op(0);
2092       return GNUNET_SYSERR;
2093     }
2094     if (0 != memcmp (&v6->options,
2095                      &plugin->myoptions,
2096                      sizeof (uint32_t)))
2097     {
2098       GNUNET_break(0);
2099       return GNUNET_SYSERR;
2100     }
2101     if (GNUNET_OK != check_port (plugin, ntohs (v6->t6_port)))
2102       return GNUNET_SYSERR;
2103     if (GNUNET_OK
2104         != GNUNET_NAT_test_address (plugin->nat, &v6->ipv6_addr,
2105             sizeof(struct in6_addr)))
2106       return GNUNET_SYSERR;
2107   }
2108   return GNUNET_OK;
2109 }
2110
2111 /**
2112  * We've received a nat probe from this peer via TCP.  Finish
2113  * creating the client session and resume sending of queued
2114  * messages.
2115  *
2116  * @param cls closure
2117  * @param client identification of the client
2118  * @param message the actual message
2119  */
2120 static void
2121 handle_tcp_nat_probe (void *cls,
2122                       struct GNUNET_SERVER_Client *client,
2123                       const struct GNUNET_MessageHeader *message)
2124 {
2125   struct Plugin *plugin = cls;
2126   struct Session *session;
2127   const struct TCP_NAT_ProbeMessage *tcp_nat_probe;
2128   size_t alen;
2129   void *vaddr;
2130   struct IPv4TcpAddress *t4;
2131   struct IPv6TcpAddress *t6;
2132   const struct sockaddr_in *s4;
2133   const struct sockaddr_in6 *s6;
2134
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!
2141    */
2142   if (ntohs (message->size) != sizeof(struct TCP_NAT_ProbeMessage))
2143   {
2144     GNUNET_break_op(0);
2145     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2146     return;
2147   }
2148
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)))
2152   {
2153     /* refuse connections from ourselves */
2154     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2155     return;
2156   }
2157
2158   session = GNUNET_CONTAINER_multipeermap_get (plugin->nat_wait_conns,
2159       &tcp_nat_probe->clientIdentity);
2160   if (session == NULL)
2161   {
2162     LOG (GNUNET_ERROR_TYPE_DEBUG,
2163          "Did NOT find session for NAT probe!\n");
2164     GNUNET_SERVER_receive_done (client, GNUNET_OK);
2165     return;
2166   }
2167   LOG (GNUNET_ERROR_TYPE_DEBUG,
2168        "Found session for NAT probe!\n");
2169
2170   if (session->nat_connection_timeout != NULL)
2171   {
2172     GNUNET_SCHEDULER_cancel (session->nat_connection_timeout);
2173     session->nat_connection_timeout = NULL;
2174   }
2175
2176   if (GNUNET_OK != GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2177   {
2178     GNUNET_break(0);
2179     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2180     tcp_plugin_disconnect_session (plugin,
2181                                    session);
2182     return;
2183   }
2184   GNUNET_assert(
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)
2193   {
2194   case AF_INET:
2195     s4 = vaddr;
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,
2201                                                       PLUGIN_NAME,
2202                                                       &t4,
2203                                                       sizeof(struct IPv4TcpAddress),
2204                                                       GNUNET_HELLO_ADDRESS_INFO_NONE);
2205     break;
2206   case AF_INET6:
2207     s6 = vaddr;
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,
2213                                                       PLUGIN_NAME,
2214                                                       &t6,
2215                                                       sizeof(struct IPv6TcpAddress),
2216                                                       GNUNET_HELLO_ADDRESS_INFO_NONE);
2217     break;
2218   default:
2219     GNUNET_break_op(0);
2220     LOG(GNUNET_ERROR_TYPE_DEBUG,
2221         "Bad address for incoming connection!\n");
2222     GNUNET_free(vaddr);
2223     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2224     tcp_plugin_disconnect_session (plugin,
2225                                    session);
2226     return;
2227   }
2228   GNUNET_free(vaddr);
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);
2236 }
2237
2238 /**
2239  * We've received a welcome from this peer via TCP.  Possibly create a
2240  * fresh client record and send back our welcome.
2241  *
2242  * @param cls closure
2243  * @param client identification of the client
2244  * @param message the actual message
2245  */
2246 static void
2247 handle_tcp_welcome (void *cls,
2248                     struct GNUNET_SERVER_Client *client,
2249                     const struct GNUNET_MessageHeader *message)
2250 {
2251   struct Plugin *plugin = cls;
2252   const struct WelcomeMessage *wm = (const struct WelcomeMessage *) message;
2253   struct GNUNET_HELLO_Address *address;
2254   struct Session *session;
2255   size_t alen;
2256   void *vaddr;
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;
2262
2263
2264   if (0 == memcmp (&wm->clientIdentity,
2265                    plugin->env->my_identity,
2266                    sizeof(struct GNUNET_PeerIdentity)))
2267   {
2268     /* refuse connections from ourselves */
2269     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2270     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2271     {
2272       LOG(GNUNET_ERROR_TYPE_INFO,
2273           "Received %s message from my own identity `%4s' on address `%s'\n",
2274           "WELCOME", GNUNET_i2s (&wm->clientIdentity),
2275           GNUNET_a2s (vaddr, alen));
2276       GNUNET_free(vaddr);
2277     }
2278     return;
2279   }
2280
2281   LOG(GNUNET_ERROR_TYPE_DEBUG,
2282       "Received %s message from `%4s' %p\n",
2283       "WELCOME",
2284       GNUNET_i2s (&wm->clientIdentity), client);
2285   GNUNET_STATISTICS_update (plugin->env->stats,
2286                             gettext_noop ("# TCP WELCOME messages received"),
2287                             1,
2288                             GNUNET_NO);
2289   session = lookup_session_by_client (plugin, client);
2290   if (NULL != session)
2291   {
2292     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2293     {
2294       LOG (GNUNET_ERROR_TYPE_DEBUG,
2295            "Found existing session %p for peer `%s'\n",
2296            session,
2297            GNUNET_a2s (vaddr, alen));
2298       GNUNET_free (vaddr);
2299     }
2300   }
2301   else
2302   {
2303     GNUNET_SERVER_client_keep (client);
2304     if (NULL != plugin->service) /* Otherwise value is incremented in tcp_access_check */
2305       plugin->cur_connections++;
2306     if (plugin->cur_connections == plugin->max_connections)
2307       GNUNET_SERVER_suspend (plugin->server); /* Maximum number of connections rechead */
2308
2309     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2310     {
2311       if (alen == sizeof(struct sockaddr_in))
2312       {
2313         s4 = vaddr;
2314         memset (&t4, '\0', sizeof (t4));
2315         t4.options = htonl (TCP_OPTIONS_NONE);
2316         t4.t4_port = s4->sin_port;
2317         t4.ipv4_addr = s4->sin_addr.s_addr;
2318         address = GNUNET_HELLO_address_allocate (&wm->clientIdentity,
2319                                                  PLUGIN_NAME,
2320                                                  &t4,
2321                                                  sizeof(t4),
2322                                                  GNUNET_HELLO_ADDRESS_INFO_INBOUND);
2323       }
2324       else if (alen == sizeof(struct sockaddr_in6))
2325       {
2326         s6 = vaddr;
2327         memset (&t6, '\0', sizeof (t6));
2328         t6.options = htonl (TCP_OPTIONS_NONE);
2329         t6.t6_port = s6->sin6_port;
2330         memcpy (&t6.ipv6_addr, &s6->sin6_addr, sizeof(struct in6_addr));
2331         address = GNUNET_HELLO_address_allocate (&wm->clientIdentity,
2332             PLUGIN_NAME, &t6, sizeof (t6),
2333             GNUNET_HELLO_ADDRESS_INFO_INBOUND);
2334       }
2335       else
2336       {
2337         GNUNET_break (0);
2338         GNUNET_free_non_null (vaddr);
2339         return;
2340       }
2341       session = create_session (plugin, address, client, GNUNET_NO);
2342       GNUNET_HELLO_address_free (address);
2343       session->ats_address_network_type = plugin->env->get_address_type (plugin->env->cls, vaddr, alen);
2344       ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
2345       ats.value = htonl (session->ats_address_network_type);
2346       LOG (GNUNET_ERROR_TYPE_DEBUG,
2347            "Creating new%s session %p for peer `%s' client %p \n",
2348            GNUNET_HELLO_address_check_option (session->address,
2349                                               GNUNET_HELLO_ADDRESS_INFO_INBOUND)
2350            ? " inbound" : "",
2351            session,
2352            tcp_plugin_address_to_string (NULL,
2353                                          (void *) session->address->address,
2354                                          session->address->address_length),
2355            client);
2356       GNUNET_free (vaddr);
2357       GNUNET_SERVER_client_set_user_context (session->client, session);
2358       GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap,
2359                                          &session->target,
2360                                          session,
2361                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2362       /* Notify transport and ATS about new session */
2363       plugin->env->session_start (plugin->env->cls,
2364                                   session->address,
2365                                   session,
2366                                   &ats, 1);
2367       notify_session_monitor (plugin,
2368                               session,
2369                               GNUNET_TRANSPORT_SS_INIT);
2370     }
2371     else
2372     {
2373       LOG(GNUNET_ERROR_TYPE_DEBUG,
2374           "Did not obtain TCP socket address for incoming connection\n");
2375       GNUNET_break(0);
2376       return;
2377     }
2378   }
2379
2380   if (session->expecting_welcome != GNUNET_YES)
2381   {
2382     GNUNET_break_op(0);
2383     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2384     GNUNET_break(0);
2385     return;
2386   }
2387   session->last_activity = GNUNET_TIME_absolute_get ();
2388   session->expecting_welcome = GNUNET_NO;
2389
2390   process_pending_messages (session);
2391   GNUNET_SERVER_client_set_timeout (client,
2392       GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2393   GNUNET_SERVER_receive_done (client, GNUNET_OK);
2394 }
2395
2396
2397 /**
2398  * We've received data for this peer via TCP.  Unbox,
2399  * compute latency and forward.
2400  *
2401  * @param cls closure
2402  * @param client identification of the client
2403  * @param message the actual message
2404  */
2405 static void
2406 handle_tcp_data (void *cls,
2407                  struct GNUNET_SERVER_Client *client,
2408                  const struct GNUNET_MessageHeader *message)
2409 {
2410   struct Plugin *plugin = cls;
2411   struct Session *session;
2412   struct GNUNET_TIME_Relative delay;
2413   uint16_t type;
2414
2415   type = ntohs (message->type);
2416   if ((GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME == type)
2417       || (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE == type))
2418   {
2419     /* We don't want to propagate WELCOME and NAT Probe messages up! */
2420     GNUNET_SERVER_receive_done (client, GNUNET_OK);
2421     return;
2422   }
2423   session = lookup_session_by_client (plugin, client);
2424   if (NULL == session)
2425   {
2426     /* No inbound session found */
2427     void *vaddr;
2428     size_t alen;
2429
2430     GNUNET_SERVER_client_get_address (client, &vaddr, &alen);
2431     LOG(GNUNET_ERROR_TYPE_ERROR,
2432         "Received unexpected %u bytes of type %u from `%s'\n",
2433         (unsigned int) ntohs (message->size),
2434         (unsigned int) ntohs (message->type), GNUNET_a2s (vaddr, alen));
2435     GNUNET_break_op(0);
2436     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2437     GNUNET_free_non_null(vaddr);
2438     return;
2439   }
2440   else if (GNUNET_YES == session->expecting_welcome)
2441   {
2442     /* Session is expecting WELCOME message */
2443     void *vaddr;
2444     size_t alen;
2445
2446     GNUNET_SERVER_client_get_address (client, &vaddr, &alen);
2447     LOG(GNUNET_ERROR_TYPE_ERROR,
2448         "Received unexpected %u bytes of type %u from `%s'\n",
2449         (unsigned int) ntohs (message->size),
2450         (unsigned int) ntohs (message->type), GNUNET_a2s (vaddr, alen));
2451     GNUNET_break_op(0);
2452     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2453     GNUNET_free_non_null(vaddr);
2454     return;
2455   }
2456
2457   session->last_activity = GNUNET_TIME_absolute_get ();
2458   LOG(GNUNET_ERROR_TYPE_DEBUG,
2459       "Passing %u bytes of type %u from `%4s' to transport service.\n",
2460       (unsigned int) ntohs (message->size),
2461       (unsigned int) ntohs (message->type), GNUNET_i2s (&session->target));
2462
2463   GNUNET_STATISTICS_update (plugin->env->stats,
2464       gettext_noop ("# bytes received via TCP"), ntohs (message->size),
2465       GNUNET_NO);
2466   struct GNUNET_ATS_Information distance;
2467
2468   distance.type = htonl (GNUNET_ATS_NETWORK_TYPE);
2469   distance.value = htonl ((uint32_t) session->ats_address_network_type);
2470   GNUNET_break(session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
2471
2472   GNUNET_assert(GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessionmap,
2473                                                               &session->target,
2474                                                               session));
2475
2476   delay = plugin->env->receive (plugin->env->cls,
2477                                 session->address,
2478                                 session,
2479                                 message);
2480   plugin->env->update_address_metrics (plugin->env->cls,
2481                                        session->address,
2482                                        session,
2483                                        &distance, 1);
2484   reschedule_session_timeout (session);
2485   if (0 == delay.rel_value_us)
2486   {
2487     GNUNET_SERVER_receive_done (client, GNUNET_OK);
2488   }
2489   else
2490   {
2491     LOG(GNUNET_ERROR_TYPE_DEBUG,
2492         "Throttling receiving from `%s' for %s\n",
2493         GNUNET_i2s (&session->target),
2494         GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
2495     GNUNET_SERVER_disable_receive_done_warning (client);
2496     session->receive_delay_task = GNUNET_SCHEDULER_add_delayed (delay,
2497         &delayed_done, session);
2498   }
2499 }
2500
2501
2502 /**
2503  * Functions with this signature are called whenever a peer
2504  * is disconnected on the network level.
2505  *
2506  * @param cls closure
2507  * @param client identification of the client
2508  */
2509 static void
2510 disconnect_notify (void *cls,
2511                    struct GNUNET_SERVER_Client *client)
2512 {
2513   struct Plugin *plugin = cls;
2514   struct Session *session;
2515
2516   if (NULL == client)
2517     return;
2518   session = lookup_session_by_client (plugin, client);
2519   if (NULL == session)
2520     return; /* unknown, nothing to do */
2521   LOG (GNUNET_ERROR_TYPE_DEBUG,
2522        "Destroying session of `%4s' with %s due to network-level disconnect.\n",
2523        GNUNET_i2s (&session->target),
2524        tcp_plugin_address_to_string (session->plugin, session->address->address,
2525                               session->address->address_length));
2526
2527   if (plugin->cur_connections == plugin->max_connections)
2528     GNUNET_SERVER_resume (plugin->server); /* Resume server  */
2529
2530   if (plugin->cur_connections < 1)
2531     GNUNET_break(0);
2532   else
2533     plugin->cur_connections--;
2534
2535   GNUNET_STATISTICS_update (session->plugin->env->stats, gettext_noop
2536                             ("# network-level TCP disconnect events"),
2537                             1,
2538                             GNUNET_NO);
2539   tcp_plugin_disconnect_session (plugin, session);
2540 }
2541
2542
2543 /**
2544  * We can now send a probe message, copy into buffer to really send.
2545  *
2546  * @param cls closure, a struct TCPProbeContext
2547  * @param size max size to copy
2548  * @param buf buffer to copy message to
2549  * @return number of bytes copied into @a buf
2550  */
2551 static size_t
2552 notify_send_probe (void *cls,
2553                    size_t size,
2554                    void *buf)
2555 {
2556   struct TCPProbeContext *tcp_probe_ctx = cls;
2557   struct Plugin *plugin = tcp_probe_ctx->plugin;
2558   size_t ret;
2559
2560   tcp_probe_ctx->transmit_handle = NULL;
2561   GNUNET_CONTAINER_DLL_remove (plugin->probe_head,
2562                                plugin->probe_tail,
2563                                tcp_probe_ctx);
2564   if (buf == NULL)
2565   {
2566     GNUNET_CONNECTION_destroy (tcp_probe_ctx->sock);
2567     GNUNET_free(tcp_probe_ctx);
2568     return 0;
2569   }
2570   GNUNET_assert(size >= sizeof(tcp_probe_ctx->message));
2571   memcpy (buf, &tcp_probe_ctx->message, sizeof(tcp_probe_ctx->message));
2572   GNUNET_SERVER_connect_socket (tcp_probe_ctx->plugin->server,
2573                                 tcp_probe_ctx->sock);
2574   ret = sizeof(tcp_probe_ctx->message);
2575   GNUNET_free(tcp_probe_ctx);
2576   return ret;
2577 }
2578
2579
2580 /**
2581  * Function called by the NAT subsystem suggesting another peer wants
2582  * to connect to us via connection reversal.  Try to connect back to the
2583  * given IP.
2584  *
2585  * @param cls closure
2586  * @param addr address to try
2587  * @param addrlen number of bytes in @a addr
2588  */
2589 static void
2590 try_connection_reversal (void *cls,
2591                          const struct sockaddr *addr,
2592                          socklen_t addrlen)
2593 {
2594   struct Plugin *plugin = cls;
2595   struct GNUNET_CONNECTION_Handle *sock;
2596   struct TCPProbeContext *tcp_probe_ctx;
2597
2598   /**
2599    * We have received an ICMP response, ostensibly from a peer
2600    * that wants to connect to us! Send a message to establish a connection.
2601    */
2602   sock = GNUNET_CONNECTION_create_from_sockaddr (AF_INET, addr, addrlen);
2603   if (sock == NULL)
2604   {
2605     /* failed for some odd reason (out of sockets?); ignore attempt */
2606     return;
2607   }
2608
2609   tcp_probe_ctx = GNUNET_new (struct TCPProbeContext);
2610   tcp_probe_ctx->message.header.size
2611     = htons (sizeof (struct TCP_NAT_ProbeMessage));
2612   tcp_probe_ctx->message.header.type
2613     = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE);
2614   tcp_probe_ctx->message.clientIdentity
2615     = *plugin->env->my_identity;
2616   tcp_probe_ctx->plugin = plugin;
2617   tcp_probe_ctx->sock = sock;
2618   GNUNET_CONTAINER_DLL_insert (plugin->probe_head,
2619                                plugin->probe_tail,
2620                                tcp_probe_ctx);
2621   tcp_probe_ctx->transmit_handle
2622     = GNUNET_CONNECTION_notify_transmit_ready (sock,
2623                                                ntohs (tcp_probe_ctx->message.header.size),
2624                                                GNUNET_TIME_UNIT_FOREVER_REL,
2625                                                &notify_send_probe,
2626                                                tcp_probe_ctx);
2627 }
2628
2629
2630 /**
2631  * Function obtain the network type for a session
2632  *
2633  * @param cls closure ('struct Plugin*')
2634  * @param session the session
2635  * @return the network type in HBO or #GNUNET_SYSERR
2636  */
2637 static enum GNUNET_ATS_Network_Type
2638 tcp_plugin_get_network (void *cls,
2639                         struct Session *session)
2640 {
2641   return session->ats_address_network_type;
2642 }
2643
2644
2645 /**
2646  * Return information about the given session to the
2647  * monitor callback.
2648  *
2649  * @param cls the `struct Plugin` with the monitor callback (`sic`)
2650  * @param peer peer we send information about
2651  * @param value our `struct Session` to send information about
2652  * @return #GNUNET_OK (continue to iterate)
2653  */
2654 static int
2655 send_session_info_iter (void *cls,
2656                         const struct GNUNET_PeerIdentity *peer,
2657                         void *value)
2658 {
2659   struct Plugin *plugin = cls;
2660   struct Session *session = value;
2661
2662   notify_session_monitor (plugin,
2663                           session,
2664                           GNUNET_TRANSPORT_SS_INIT);
2665   /* FIXME: cannot tell if this is up or not from current
2666      session state... */
2667   notify_session_monitor (plugin,
2668                           session,
2669                           GNUNET_TRANSPORT_SS_UP);
2670   return GNUNET_OK;
2671 }
2672
2673
2674 /**
2675  * Begin monitoring sessions of a plugin.  There can only
2676  * be one active monitor per plugin (i.e. if there are
2677  * multiple monitors, the transport service needs to
2678  * multiplex the generated events over all of them).
2679  *
2680  * @param cls closure of the plugin
2681  * @param sic callback to invoke, NULL to disable monitor;
2682  *            plugin will being by iterating over all active
2683  *            sessions immediately and then enter monitor mode
2684  * @param sic_cls closure for @a sic
2685  */
2686 static void
2687 tcp_plugin_setup_monitor (void *cls,
2688                           GNUNET_TRANSPORT_SessionInfoCallback sic,
2689                           void *sic_cls)
2690 {
2691   struct Plugin *plugin = cls;
2692
2693   plugin->sic = sic;
2694   plugin->sic_cls = sic_cls;
2695   if (NULL != sic)
2696   {
2697     GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
2698                                            &send_session_info_iter,
2699                                            plugin);
2700     /* signal end of first iteration */
2701     sic (sic_cls, NULL, NULL);
2702   }
2703 }
2704
2705
2706 /**
2707  * Entry point for the plugin.
2708  *
2709  * @param cls closure, the `struct GNUNET_TRANSPORT_PluginEnvironment *`
2710  * @return the `struct GNUNET_TRANSPORT_PluginFunctions *` or NULL on error
2711  */
2712 void *
2713 libgnunet_plugin_transport_tcp_init (void *cls)
2714 {
2715   static const struct GNUNET_SERVER_MessageHandler my_handlers[] = {
2716     { &handle_tcp_welcome, NULL,
2717       GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME, sizeof(struct WelcomeMessage) },
2718     { &handle_tcp_nat_probe, NULL,
2719       GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE, sizeof(struct TCP_NAT_ProbeMessage) },
2720     { &handle_tcp_data, NULL,
2721       GNUNET_MESSAGE_TYPE_ALL, 0 },
2722     { NULL, NULL, 0, 0 }
2723   };
2724   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
2725   struct GNUNET_TRANSPORT_PluginFunctions *api;
2726   struct Plugin *plugin;
2727   struct GNUNET_SERVICE_Context *service;
2728   unsigned long long aport;
2729   unsigned long long bport;
2730   unsigned long long max_connections;
2731   unsigned int i;
2732   struct GNUNET_TIME_Relative idle_timeout;
2733 #ifdef TCP_STEALTH
2734   struct GNUNET_NETWORK_Handle *const*lsocks;
2735 #endif
2736   int ret;
2737   int ret_s;
2738   struct sockaddr **addrs;
2739   socklen_t *addrlens;
2740
2741   if (NULL == env->receive)
2742   {
2743     /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
2744      initialze the plugin or the API */
2745     api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2746     api->cls = NULL;
2747     api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2748     api->address_to_string = &tcp_plugin_address_to_string;
2749     api->string_to_address = &tcp_plugin_string_to_address;
2750     return api;
2751   }
2752
2753   GNUNET_assert (NULL != env->cfg);
2754   if (GNUNET_OK !=
2755       GNUNET_CONFIGURATION_get_value_number (env->cfg,
2756                                              "transport-tcp",
2757                                              "MAX_CONNECTIONS",
2758                                              &max_connections))
2759     max_connections = 128;
2760
2761   aport = 0;
2762   if ((GNUNET_OK !=
2763        GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2764                                               "PORT", &bport)) ||
2765       (bport > 65535) ||
2766       ((GNUNET_OK ==
2767         GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2768                                                "ADVERTISED-PORT", &aport)) &&
2769        (aport > 65535) ))
2770   {
2771     LOG(GNUNET_ERROR_TYPE_ERROR,
2772         _("Require valid port number for service `%s' in configuration!\n"),
2773         "transport-tcp");
2774     return NULL ;
2775   }
2776   if (0 == aport)
2777     aport = bport;
2778   if (0 == bport)
2779     aport = 0;
2780   if (0 != bport)
2781   {
2782     service = GNUNET_SERVICE_start ("transport-tcp",
2783                                     env->cfg,
2784                                     GNUNET_SERVICE_OPTION_NONE);
2785     if (NULL == service)
2786     {
2787       LOG (GNUNET_ERROR_TYPE_WARNING,
2788            _("Failed to start service.\n"));
2789       return NULL;
2790     }
2791   }
2792   else
2793     service = NULL;
2794
2795   api = NULL;
2796   plugin = GNUNET_new (struct Plugin);
2797   plugin->sessionmap = GNUNET_CONTAINER_multipeermap_create (max_connections,
2798                                                              GNUNET_YES);
2799   plugin->max_connections = max_connections;
2800   plugin->open_port = bport;
2801   plugin->adv_port = aport;
2802   plugin->env = env;
2803   plugin->my_welcome.header.size = htons (sizeof(struct WelcomeMessage));
2804   plugin->my_welcome.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME);
2805   plugin->my_welcome.clientIdentity = *plugin->env->my_identity;
2806
2807   if ( (NULL != service) &&
2808        (GNUNET_YES ==
2809         GNUNET_CONFIGURATION_get_value_yesno (env->cfg,
2810                                               "transport-tcp",
2811                                               "TCP_STEALTH")) )
2812   {
2813 #ifdef TCP_STEALTH
2814     plugin->myoptions |= TCP_OPTIONS_TCP_STEALTH;
2815     lsocks = GNUNET_SERVICE_get_listen_sockets (service);
2816     if (NULL != lsocks)
2817     {
2818       uint32_t len = sizeof (struct WelcomeMessage);
2819
2820       for (i=0;NULL!=lsocks[i];i++)
2821       {
2822         if ( (GNUNET_OK !=
2823               GNUNET_NETWORK_socket_setsockopt (lsocks[i],
2824                                                 IPPROTO_TCP,
2825                                                 TCP_STEALTH,
2826                                                 env->my_identity,
2827                                                 sizeof (struct GNUNET_PeerIdentity))) ||
2828              (GNUNET_OK !=
2829               GNUNET_NETWORK_socket_setsockopt (lsocks[i],
2830                                                 IPPROTO_TCP,
2831                                                 TCP_STEALTH_INTEGRITY_LEN,
2832                                                 &len,
2833                                                 sizeof (len))) )
2834         {
2835           /* TCP STEALTH not supported by kernel */
2836           GNUNET_assert (0 == i);
2837           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2838                       _("TCP_STEALTH not supported on this platform.\n"));
2839           goto die;
2840         }
2841       }
2842     }
2843 #else
2844     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2845                 _("TCP_STEALTH not supported on this platform.\n"));
2846     goto die;
2847 #endif
2848   }
2849
2850   if ( (NULL != service) &&
2851        (GNUNET_SYSERR !=
2852         (ret_s =
2853          GNUNET_SERVICE_get_server_addresses ("transport-tcp",
2854                                               env->cfg,
2855                                               &addrs,
2856                                               &addrlens))))
2857   {
2858     for (ret = ret_s-1; ret >= 0; ret--)
2859       LOG (GNUNET_ERROR_TYPE_INFO,
2860            "Binding to address `%s'\n",
2861            GNUNET_a2s (addrs[ret], addrlens[ret]));
2862     plugin->nat
2863       = GNUNET_NAT_register (env->cfg,
2864                              GNUNET_YES,
2865                              aport,
2866                              (unsigned int) ret_s,
2867                              (const struct sockaddr **) addrs, addrlens,
2868                              &tcp_nat_port_map_callback,
2869                              &try_connection_reversal,
2870                              plugin);
2871     for (ret = ret_s -1; ret >= 0; ret--)
2872       GNUNET_free (addrs[ret]);
2873     GNUNET_free_non_null (addrs);
2874     GNUNET_free_non_null (addrlens);
2875   }
2876   else
2877   {
2878     plugin->nat = GNUNET_NAT_register (plugin->env->cfg,
2879                                        GNUNET_YES, 0, 0, NULL, NULL, NULL,
2880                                        &try_connection_reversal, plugin);
2881   }
2882   api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2883   api->cls = plugin;
2884   api->send = &tcp_plugin_send;
2885   api->get_session = &tcp_plugin_get_session;
2886   api->disconnect_session = &tcp_plugin_disconnect_session;
2887   api->query_keepalive_factor = &tcp_plugin_query_keepalive_factor;
2888   api->disconnect_peer = &tcp_plugin_disconnect;
2889   api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2890   api->check_address = &tcp_plugin_check_address;
2891   api->address_to_string = &tcp_plugin_address_to_string;
2892   api->string_to_address = &tcp_plugin_string_to_address;
2893   api->get_network = &tcp_plugin_get_network;
2894   api->update_session_timeout = &tcp_plugin_update_session_timeout;
2895   api->update_inbound_delay = &tcp_plugin_update_inbound_delay;
2896   api->setup_monitor = &tcp_plugin_setup_monitor;
2897   plugin->service = service;
2898   if (NULL != service)
2899   {
2900     plugin->server = GNUNET_SERVICE_get_server (service);
2901   }
2902   else
2903   {
2904     if (GNUNET_OK !=
2905         GNUNET_CONFIGURATION_get_value_time (env->cfg,
2906                                              "transport-tcp",
2907                                              "TIMEOUT",
2908                                              &idle_timeout))
2909     {
2910       GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2911                                  "transport-tcp",
2912                                  "TIMEOUT");
2913       goto die;
2914     }
2915     plugin->server
2916       = GNUNET_SERVER_create_with_sockets (&plugin_tcp_access_check,
2917                                            plugin, NULL,
2918                                            idle_timeout, GNUNET_YES);
2919   }
2920   plugin->handlers = GNUNET_malloc (sizeof (my_handlers));
2921   memcpy (plugin->handlers, my_handlers, sizeof(my_handlers));
2922   for (i = 0;i < sizeof(my_handlers) / sizeof(struct GNUNET_SERVER_MessageHandler);i++)
2923     plugin->handlers[i].callback_cls = plugin;
2924
2925   GNUNET_SERVER_add_handlers (plugin->server, plugin->handlers);
2926   GNUNET_SERVER_disconnect_notify (plugin->server, &disconnect_notify, plugin);
2927   plugin->nat_wait_conns = GNUNET_CONTAINER_multipeermap_create (16,
2928                                                                  GNUNET_YES);
2929   if (0 != bport)
2930     LOG (GNUNET_ERROR_TYPE_INFO,
2931          _("TCP transport listening on port %llu\n"),
2932          bport);
2933   else
2934     LOG (GNUNET_ERROR_TYPE_INFO,
2935          _("TCP transport not listening on any port (client only)\n"));
2936   if ( (aport != bport) &&
2937        (0 != bport) )
2938     LOG (GNUNET_ERROR_TYPE_INFO,
2939          _("TCP transport advertises itself as being on port %llu\n"),
2940          aport);
2941   /* Initially set connections to 0 */
2942   GNUNET_assert(NULL != plugin->env->stats);
2943   GNUNET_STATISTICS_set (plugin->env->stats,
2944                          gettext_noop ("# TCP sessions active"),
2945                          0,
2946                          GNUNET_NO);
2947   return api;
2948
2949  die:
2950   if (NULL != plugin->nat)
2951     GNUNET_NAT_unregister (plugin->nat);
2952   GNUNET_CONTAINER_multipeermap_destroy (plugin->sessionmap);
2953   if (NULL != service)
2954     GNUNET_SERVICE_stop (service);
2955   GNUNET_free (plugin);
2956   GNUNET_free_non_null (api);
2957   return NULL;
2958 }
2959
2960
2961 /**
2962  * Exit point from the plugin.
2963  *
2964  * @param cls the `struct GNUNET_TRANSPORT_PluginFunctions`
2965  * @return NULL
2966  */
2967 void *
2968 libgnunet_plugin_transport_tcp_done (void *cls)
2969 {
2970   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
2971   struct Plugin *plugin = api->cls;
2972   struct TCPProbeContext *tcp_probe;
2973   struct PrettyPrinterContext *cur;
2974   struct PrettyPrinterContext *next;
2975
2976   if (NULL == plugin)
2977   {
2978     GNUNET_free(api);
2979     return NULL ;
2980   }
2981   LOG (GNUNET_ERROR_TYPE_DEBUG,
2982        "Shutting down TCP plugin\n");
2983
2984   /* Removing leftover sessions */
2985   GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
2986                                          &session_disconnect_it,
2987                                          plugin);
2988   /* Removing leftover NAT sessions */
2989   GNUNET_CONTAINER_multipeermap_iterate (plugin->nat_wait_conns,
2990                                          &session_disconnect_it,
2991                                          plugin);
2992
2993   for (cur = ppc_dll_head; NULL != cur; cur = next)
2994   {
2995     next = cur->next;
2996     GNUNET_CONTAINER_DLL_remove (ppc_dll_head,
2997                                  ppc_dll_tail,
2998                                  cur);
2999     GNUNET_RESOLVER_request_cancel (cur->resolver_handle);
3000     cur->asc (cur->asc_cls, NULL, GNUNET_OK);
3001     GNUNET_free (cur);
3002   }
3003
3004   if (NULL != plugin->service)
3005     GNUNET_SERVICE_stop (plugin->service);
3006   else
3007     GNUNET_SERVER_destroy (plugin->server);
3008   GNUNET_free(plugin->handlers);
3009   if (NULL != plugin->nat)
3010     GNUNET_NAT_unregister (plugin->nat);
3011   while (NULL != (tcp_probe = plugin->probe_head))
3012   {
3013     GNUNET_CONTAINER_DLL_remove (plugin->probe_head,
3014                                  plugin->probe_tail,
3015                                  tcp_probe);
3016     GNUNET_CONNECTION_destroy (tcp_probe->sock);
3017     GNUNET_free(tcp_probe);
3018   }
3019   GNUNET_CONTAINER_multipeermap_destroy (plugin->nat_wait_conns);
3020   GNUNET_CONTAINER_multipeermap_destroy (plugin->sessionmap);
3021   GNUNET_free(plugin);
3022   GNUNET_free(api);
3023   return NULL;
3024 }
3025
3026 /* end of plugin_transport_tcp.c */