src/transport/plugin_transport_tcp.c

   1 /*
   2   This file is part of GNUnet
   3   Copyright (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,
 563       "NAT notification to %s address `%s'\n",
 564       (GNUNET_YES == add_remove) ? "add" : "remove",
 565       GNUNET_a2s (addr, addrlen));
 566   /* convert 'addr' to our internal format */
 567   switch (addr->sa_family)
 568   {
 569   case AF_INET:
 570     GNUNET_assert(addrlen == sizeof(struct sockaddr_in));
 571     memset (&t4, 0, sizeof(t4));
 572     t4.options = htonl (plugin->myoptions);
 573     t4.ipv4_addr = ((struct sockaddr_in *) addr)->sin_addr.s_addr;
 574     t4.t4_port = ((struct sockaddr_in *) addr)->sin_port;
 575     arg = &t4;
 576     args = sizeof (t4);
 577     break;
 578   case AF_INET6:
 579     GNUNET_assert(addrlen == sizeof(struct sockaddr_in6));
 580     memset (&t6, 0, sizeof(t6));
 581     memcpy (&t6.ipv6_addr, &((struct sockaddr_in6 *) addr)->sin6_addr,
 582         sizeof(struct in6_addr));
 583     t6.options = htonl (plugin->myoptions);
 584     t6.t6_port = ((struct sockaddr_in6 *) addr)->sin6_port;
 585     arg = &t6;
 586     args = sizeof (t6);
 587     break;
 588   default:
 589     GNUNET_break(0);
 590     return;
 591   }
 592   /* modify our published address list */
 593   GNUNET_assert ((args == sizeof (struct IPv4TcpAddress)) ||
 594       (args == sizeof (struct IPv6TcpAddress)));
 595   address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
 596       PLUGIN_NAME, arg, args, GNUNET_HELLO_ADDRESS_INFO_NONE);
 597   plugin->env->notify_address (plugin->env->cls, add_remove, address);
 598   GNUNET_HELLO_address_free(address);
 599 }
 600
 601
 602 /**
 603  * Function called for a quick conversion of the binary address to
 604  * a numeric address.  Note that the caller must not free the
 605  * address and that the next call to this function is allowed
 606  * to override the address again.
 607  *
 608  * @param cls closure (`struct Plugin*`)
 609  * @param addr binary address
 610  * @param addrlen length of @a addr
 611  * @return string representing the same address
 612  */
 613 static const char *
 614 tcp_plugin_address_to_string (void *cls,
 615                        const void *addr,
 616                        size_t addrlen)
 617 {
 618   static char rbuf[INET6_ADDRSTRLEN + 12];
 619   char buf[INET6_ADDRSTRLEN];
 620   const void *sb;
 621   struct in_addr a4;
 622   struct in6_addr a6;
 623   const struct IPv4TcpAddress *t4;
 624   const struct IPv6TcpAddress *t6;
 625   int af;
 626   uint16_t port;
 627   uint32_t options;
 628
 629   switch (addrlen)
 630   {
 631   case sizeof(struct IPv6TcpAddress):
 632     t6 = addr;
 633     af = AF_INET6;
 634     port = ntohs (t6->t6_port);
 635     options = ntohl (t6->options);
 636     memcpy (&a6, &t6->ipv6_addr, sizeof(a6));
 637     sb = &a6;
 638     break;
 639   case sizeof(struct IPv4TcpAddress):
 640     t4 = addr;
 641     af = AF_INET;
 642     port = ntohs (t4->t4_port);
 643     options = ntohl (t4->options);
 644     memcpy (&a4, &t4->ipv4_addr, sizeof(a4));
 645     sb = &a4;
 646     break;
 647   default:
 648     LOG (GNUNET_ERROR_TYPE_WARNING,
 649          _("Unexpected address length: %u bytes\n"),
 650          (unsigned int) addrlen);
 651     return NULL ;
 652   }
 653   if (NULL == inet_ntop (af, sb, buf, INET6_ADDRSTRLEN))
 654   {
 655     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
 656                          "inet_ntop");
 657     return NULL ;
 658   }
 659   GNUNET_snprintf (rbuf, sizeof(rbuf),
 660                    (af == AF_INET6) ? "%s.%u.[%s]:%u" : "%s.%u.%s:%u",
 661                    PLUGIN_NAME,
 662                    options,
 663                    buf,
 664                    port);
 665   return rbuf;
 666 }
 667
 668
 669 /**
 670  * Function called to convert a string address to
 671  * a binary address.
 672  *
 673  * @param cls closure (`struct Plugin*`)
 674  * @param addr string address
 675  * @param addrlen length of the address
 676  * @param buf location to store the buffer
 677  * @param added location to store the number of bytes in the buffer.
 678  *        If the function returns #GNUNET_SYSERR, its contents are undefined.
 679  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
 680  */
 681 static int
 682 tcp_plugin_string_to_address (void *cls,
 683                               const char *addr,
 684                               uint16_t addrlen,
 685                               void **buf,
 686                               size_t *added)
 687 {
 688   struct sockaddr_storage socket_address;
 689   char *address;
 690   char *plugin;
 691   char *optionstr;
 692   uint32_t options;
 693
 694   /* Format tcp.options.address:port */
 695   address = NULL;
 696   plugin = NULL;
 697   optionstr = NULL;
 698   if ((NULL == addr) || (addrlen == 0))
 699   {
 700     GNUNET_break(0);
 701     return GNUNET_SYSERR;
 702   }
 703   if ('\0' != addr[addrlen - 1])
 704   {
 705     GNUNET_break(0);
 706     return GNUNET_SYSERR;
 707   }
 708   if (strlen (addr) != addrlen - 1)
 709   {
 710     GNUNET_break(0);
 711     return GNUNET_SYSERR;
 712   }
 713   plugin = GNUNET_strdup (addr);
 714   optionstr = strchr (plugin, '.');
 715   if (NULL == optionstr)
 716   {
 717     GNUNET_break(0);
 718     GNUNET_free(plugin);
 719     return GNUNET_SYSERR;
 720   }
 721   optionstr[0] = '\0';
 722   optionstr++;
 723   options = atol (optionstr);
 724   address = strchr (optionstr, '.');
 725   if (NULL == address)
 726   {
 727     GNUNET_break(0);
 728     GNUNET_free(plugin);
 729     return GNUNET_SYSERR;
 730   }
 731   address[0] = '\0';
 732   address++;
 733
 734   if (GNUNET_OK
 735       != GNUNET_STRINGS_to_address_ip (address, strlen (address),
 736           &socket_address))
 737   {
 738     GNUNET_break(0);
 739     GNUNET_free(plugin);
 740     return GNUNET_SYSERR;
 741   }
 742
 743   GNUNET_free(plugin);
 744   switch (socket_address.ss_family)
 745   {
 746   case AF_INET:
 747   {
 748     struct IPv4TcpAddress *t4;
 749     struct sockaddr_in *in4 = (struct sockaddr_in *) &socket_address;
 750     t4 = GNUNET_new (struct IPv4TcpAddress);
 751     t4->options = htonl (options);
 752     t4->ipv4_addr = in4->sin_addr.s_addr;
 753     t4->t4_port = in4->sin_port;
 754     *buf = t4;
 755     *added = sizeof(struct IPv4TcpAddress);
 756     return GNUNET_OK;
 757   }
 758   case AF_INET6:
 759   {
 760     struct IPv6TcpAddress *t6;
 761     struct sockaddr_in6 *in6 = (struct sockaddr_in6 *) &socket_address;
 762     t6 = GNUNET_new (struct IPv6TcpAddress);
 763     t6->options = htonl (options);
 764     t6->ipv6_addr = in6->sin6_addr;
 765     t6->t6_port = in6->sin6_port;
 766     *buf = t6;
 767     *added = sizeof(struct IPv6TcpAddress);
 768     return GNUNET_OK;
 769   }
 770   default:
 771     return GNUNET_SYSERR;
 772   }
 773 }
 774
 775
 776 /**
 777  * Find the session handle for the given client.
 778  * Currently uses both the hashmap and the client
 779  * context, as the client context is new and the
 780  * logic still needs to be tested.
 781  *
 782  * @param plugin the plugin
 783  * @param client which client to find the session handle for
 784  * @return NULL if no matching session exists
 785  */
 786 static struct Session *
 787 lookup_session_by_client (struct Plugin *plugin,
 788                           struct GNUNET_SERVER_Client *client)
 789 {
 790   return GNUNET_SERVER_client_get_user_context (client, struct Session);
 791 }
 792
 793
 794 /**
 795  * Functions with this signature are called whenever we need
 796  * to close a session due to a disconnect or failure to
 797  * establish a connection.
 798  *
 799  * @param cls the `struct Plugin`
 800  * @param session session to close down
 801  * @return #GNUNET_OK on success
 802  */
 803 static int
 804 tcp_plugin_disconnect_session (void *cls,
 805                                struct Session *session)
 806 {
 807   struct Plugin *plugin = cls;
 808   struct PendingMessage *pm;
 809
 810   LOG (GNUNET_ERROR_TYPE_DEBUG,
 811        "Disconnecting session of peer `%s' address `%s'\n",
 812        GNUNET_i2s (&session->target),
 813        tcp_plugin_address_to_string (NULL,
 814                              session->address->address,
 815                              session->address->address_length));
 816
 817   if (NULL != session->timeout_task)
 818   {
 819     GNUNET_SCHEDULER_cancel (session->timeout_task);
 820     session->timeout_task = NULL;
 821     session->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
 822   }
 823
 824   if (GNUNET_YES ==
 825       GNUNET_CONTAINER_multipeermap_remove (plugin->sessionmap,
 826                                             &session->target,
 827                                             session))
 828   {
 829     GNUNET_STATISTICS_update (session->plugin->env->stats,
 830         gettext_noop ("# TCP sessions active"), -1, GNUNET_NO);
 831   }
 832   else
 833   {
 834     GNUNET_assert(GNUNET_YES ==
 835                   GNUNET_CONTAINER_multipeermap_remove (plugin->nat_wait_conns,
 836                                                         &session->target,
 837                                                         session));
 838   }
 839   if (NULL != session->client)
 840     GNUNET_SERVER_client_set_user_context (session->client,
 841                                            NULL);
 842
 843   /* clean up state */
 844   if (NULL != session->transmit_handle)
 845   {
 846     GNUNET_SERVER_notify_transmit_ready_cancel (session->transmit_handle);
 847     session->transmit_handle = NULL;
 848   }
 849   session->plugin->env->session_end (session->plugin->env->cls,
 850                                      session->address,
 851                                      session);
 852
 853   if (NULL != session->nat_connection_timeout)
 854   {
 855     GNUNET_SCHEDULER_cancel (session->nat_connection_timeout);
 856     session->nat_connection_timeout = NULL;
 857   }
 858
 859   while (NULL != (pm = session->pending_messages_head))
 860   {
 861     LOG (GNUNET_ERROR_TYPE_DEBUG,
 862          (NULL != pm->transmit_cont)
 863          ? "Could not deliver message to `%4s'.\n"
 864          : "Could not deliver message to `%4s', notifying.\n",
 865          GNUNET_i2s (&session->target));
 866     GNUNET_STATISTICS_update (session->plugin->env->stats,
 867                               gettext_noop ("# bytes currently in TCP buffers"),
 868                               -(int64_t) pm->message_size, GNUNET_NO);
 869     GNUNET_STATISTICS_update (session->plugin->env->stats,
 870                               gettext_noop ("# bytes discarded by TCP (disconnect)"),
 871                               pm->message_size,
 872                               GNUNET_NO);
 873     GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
 874                                  session->pending_messages_tail,
 875                                  pm);
 876     GNUNET_assert (0 < session->msgs_in_queue);
 877     session->msgs_in_queue--;
 878     GNUNET_assert (pm->message_size <= session->bytes_in_queue);
 879     session->bytes_in_queue -= pm->message_size;
 880     if (NULL != pm->transmit_cont)
 881       pm->transmit_cont (pm->transmit_cont_cls,
 882                          &session->target,
 883                          GNUNET_SYSERR,
 884                          pm->message_size,
 885                          0);
 886     GNUNET_free (pm);
 887   }
 888   GNUNET_assert (0 == session->msgs_in_queue);
 889   GNUNET_assert (0 == session->bytes_in_queue);
 890   notify_session_monitor (session->plugin,
 891                           session,
 892                           GNUNET_TRANSPORT_SS_DONE);
 893
 894   if (session->receive_delay_task != NULL)
 895   {
 896     GNUNET_SCHEDULER_cancel (session->receive_delay_task);
 897     if (NULL != session->client)
 898       GNUNET_SERVER_receive_done (session->client, GNUNET_SYSERR);
 899   }
 900   if (NULL != session->client)
 901   {
 902     GNUNET_SERVER_client_disconnect (session->client);
 903     GNUNET_SERVER_client_drop (session->client);
 904     session->client = NULL;
 905   }
 906   GNUNET_HELLO_address_free (session->address);
 907   GNUNET_assert(NULL == session->transmit_handle);
 908   GNUNET_free(session);
 909   return GNUNET_OK;
 910 }
 911
 912
 913 /**
 914  * Function that is called to get the keepalive factor.
 915  * #GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
 916  * calculate the interval between keepalive packets.
 917  *
 918  * @param cls closure with the `struct Plugin`
 919  * @return keepalive factor
 920  */
 921 static unsigned int
 922 tcp_plugin_query_keepalive_factor (void *cls)
 923 {
 924   return 3;
 925 }
 926
 927
 928 /**
 929  * Session was idle, so disconnect it
 930  *
 931  * @param cls the `struct Session` of the idle session
 932  * @param tc scheduler context
 933  */
 934 static void
 935 session_timeout (void *cls,
 936                  const struct GNUNET_SCHEDULER_TaskContext *tc)
 937 {
 938   struct Session *s = cls;
 939   struct GNUNET_TIME_Relative left;
 940
 941   s->timeout_task = NULL;
 942   left = GNUNET_TIME_absolute_get_remaining (s->timeout);
 943   if (0 != left.rel_value_us)
 944   {
 945     /* not actually our turn yet, but let's at least update
 946        the monitor, it may think we're about to die ... */
 947     notify_session_monitor (s->plugin,
 948                             s,
 949                             GNUNET_TRANSPORT_SS_UPDATE);
 950     s->timeout_task = GNUNET_SCHEDULER_add_delayed (left,
 951                                                     &session_timeout,
 952                                                     s);
 953     return;
 954   }
 955   LOG (GNUNET_ERROR_TYPE_DEBUG,
 956        "Session %p was idle for %s, disconnecting\n",
 957        s,
 958        GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 959                                                GNUNET_YES));
 960   /* call session destroy function */
 961   tcp_plugin_disconnect_session (s->plugin, s);
 962 }
 963
 964
 965 /**
 966  * Increment session timeout due to activity
 967  *
 968  * @param s session to increment timeout for
 969  */
 970 static void
 971 reschedule_session_timeout (struct Session *s)
 972 {
 973   GNUNET_assert(NULL != s->timeout_task);
 974   s->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
 975 }
 976
 977
 978 /**
 979  * Create a new session.  Also queues a welcome message.
 980  *
 981  * @param plugin the plugin
 982  * @param address the address to create the session for
 983  * @param client client to use, reference counter must have already been increased
 984  * @param is_nat this a NAT session, we should wait for a client to
 985  *               connect to us from an address, then assign that to
 986  *               the session
 987  * @return new session object
 988  */
 989 static struct Session *
 990 create_session (struct Plugin *plugin,
 991                 const struct GNUNET_HELLO_Address *address,
 992                 struct GNUNET_SERVER_Client *client,
 993                 int is_nat)
 994 {
 995   struct Session *session;
 996   struct PendingMessage *pm;
 997
 998   if (GNUNET_YES != is_nat)
 999     GNUNET_assert (NULL != client);
1000   else
1001     GNUNET_assert (NULL == client);
1002
1003   LOG (GNUNET_ERROR_TYPE_DEBUG,
1004        "Creating new session for peer `%4s'\n",
1005        GNUNET_i2s (&address->peer));
1006   session = GNUNET_new (struct Session);
1007   session->last_activity = GNUNET_TIME_absolute_get ();
1008   session->plugin = plugin;
1009   session->is_nat = is_nat;
1010   session->client = client;
1011   session->address = GNUNET_HELLO_address_copy (address);
1012   session->target = address->peer;
1013   session->expecting_welcome = GNUNET_YES;
1014   session->ats_address_network_type = GNUNET_ATS_NET_UNSPECIFIED;
1015   pm = GNUNET_malloc (sizeof (struct PendingMessage) +
1016       sizeof (struct WelcomeMessage));
1017   pm->msg = (const char *) &pm[1];
1018   pm->message_size = sizeof(struct WelcomeMessage);
1019   memcpy (&pm[1],
1020           &plugin->my_welcome,
1021           sizeof(struct WelcomeMessage));
1022   pm->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1023   GNUNET_STATISTICS_update (plugin->env->stats,
1024                             gettext_noop ("# bytes currently in TCP buffers"), pm->message_size,
1025                             GNUNET_NO);
1026   GNUNET_CONTAINER_DLL_insert (session->pending_messages_head,
1027                                session->pending_messages_tail,
1028                                pm);
1029   session->msgs_in_queue++;
1030   session->bytes_in_queue += pm->message_size;
1031   session->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1032   session->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1033                                                         &session_timeout,
1034                                                         session);
1035   notify_session_monitor (session->plugin,
1036                           session,
1037                           GNUNET_TRANSPORT_SS_INIT);
1038   if (GNUNET_YES != is_nat)
1039   {
1040     GNUNET_STATISTICS_update (plugin->env->stats,
1041                               gettext_noop ("# TCP sessions active"),
1042                               1,
1043                               GNUNET_NO);
1044     notify_session_monitor (session->plugin,
1045                             session,
1046                             GNUNET_TRANSPORT_SS_UP);
1047   }
1048   else
1049   {
1050     notify_session_monitor (session->plugin,
1051                             session,
1052                             GNUNET_TRANSPORT_SS_HANDSHAKE);
1053   }
1054   return session;
1055 }
1056
1057
1058 /**
1059  * If we have pending messages, ask the server to
1060  * transmit them (schedule the respective tasks, etc.)
1061  *
1062  * @param session for which session should we do this
1063  */
1064 static void
1065 process_pending_messages (struct Session *session);
1066
1067
1068 /**
1069  * Function called to notify a client about the socket
1070  * being ready to queue more data.  "buf" will be
1071  * NULL and "size" zero if the socket was closed for
1072  * writing in the meantime.
1073  *
1074  * @param cls closure
1075  * @param size number of bytes available in @a buf
1076  * @param buf where the callee should write the message
1077  * @return number of bytes written to @a buf
1078  */
1079 static size_t
1080 do_transmit (void *cls, size_t size, void *buf)
1081 {
1082   struct Session *session = cls;
1083   struct GNUNET_PeerIdentity pid;
1084   struct Plugin *plugin;
1085   struct PendingMessage *pos;
1086   struct PendingMessage *hd;
1087   struct PendingMessage *tl;
1088   struct GNUNET_TIME_Absolute now;
1089   char *cbuf;
1090   size_t ret;
1091
1092   session->transmit_handle = NULL;
1093   plugin = session->plugin;
1094   if (NULL == buf)
1095   {
1096     LOG (GNUNET_ERROR_TYPE_DEBUG,
1097          "Timeout trying to transmit to peer `%4s', discarding message queue.\n",
1098          GNUNET_i2s (&session->target));
1099     /* timeout; cancel all messages that have already expired */
1100     hd = NULL;
1101     tl = NULL;
1102     ret = 0;
1103     now = GNUNET_TIME_absolute_get ();
1104     while ((NULL != (pos = session->pending_messages_head))
1105         && (pos->timeout.abs_value_us <= now.abs_value_us))
1106     {
1107       GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
1108                                    session->pending_messages_tail,
1109                                    pos);
1110       GNUNET_assert (0 < session->msgs_in_queue);
1111       session->msgs_in_queue--;
1112       GNUNET_assert (pos->message_size <= session->bytes_in_queue);
1113       session->bytes_in_queue -= pos->message_size;
1114       LOG (GNUNET_ERROR_TYPE_DEBUG,
1115            "Failed to transmit %u byte message to `%4s'.\n",
1116            pos->message_size,
1117            GNUNET_i2s (&session->target));
1118       ret += pos->message_size;
1119       GNUNET_CONTAINER_DLL_insert_after (hd, tl, tl, pos);
1120     }
1121     /* do this call before callbacks (so that if callbacks destroy
1122      * session, they have a chance to cancel actions done by this
1123      * call) */
1124     process_pending_messages (session);
1125     pid = session->target;
1126     /* no do callbacks and do not use session again since
1127      * the callbacks may abort the session */
1128     while (NULL != (pos = hd))
1129     {
1130       GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
1131       if (pos->transmit_cont != NULL)
1132         pos->transmit_cont (pos->transmit_cont_cls,
1133                             &pid,
1134                             GNUNET_SYSERR,
1135                             pos->message_size, 0);
1136       GNUNET_free (pos);
1137     }
1138     GNUNET_STATISTICS_update (plugin->env->stats,
1139                               gettext_noop ("# bytes currently in TCP buffers"), -(int64_t) ret,
1140                               GNUNET_NO);
1141     GNUNET_STATISTICS_update (plugin->env->stats,
1142                               gettext_noop ("# bytes discarded by TCP (timeout)"),
1143                               ret,
1144                               GNUNET_NO);
1145     if (0 < ret)
1146       notify_session_monitor (session->plugin,
1147                               session,
1148                               GNUNET_TRANSPORT_SS_UPDATE);
1149     return 0;
1150   }
1151   /* copy all pending messages that would fit */
1152   ret = 0;
1153   cbuf = buf;
1154   hd = NULL;
1155   tl = NULL;
1156   while (NULL != (pos = session->pending_messages_head))
1157   {
1158     if (ret + pos->message_size > size)
1159       break;
1160     GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
1161                                  session->pending_messages_tail,
1162                                  pos);
1163     GNUNET_assert (0 < session->msgs_in_queue);
1164     session->msgs_in_queue--;
1165     GNUNET_assert (pos->message_size <= session->bytes_in_queue);
1166     session->bytes_in_queue -= pos->message_size;
1167     GNUNET_assert(size >= pos->message_size);
1168     LOG(GNUNET_ERROR_TYPE_DEBUG,
1169         "Transmitting message of type %u size %u\n",
1170         ntohs (((struct GNUNET_MessageHeader *) pos->msg)->type),
1171         pos->message_size);
1172     /* FIXME: this memcpy can be up to 7% of our total runtime */
1173     memcpy (cbuf, pos->msg, pos->message_size);
1174     cbuf += pos->message_size;
1175     ret += pos->message_size;
1176     size -= pos->message_size;
1177     GNUNET_CONTAINER_DLL_insert_tail (hd, tl, pos);
1178   }
1179   notify_session_monitor (session->plugin,
1180                           session,
1181                           GNUNET_TRANSPORT_SS_UPDATE);
1182   /* schedule 'continuation' before callbacks so that callbacks that
1183    * cancel everything don't cause us to use a session that no longer
1184    * exists... */
1185   process_pending_messages (session);
1186   session->last_activity = GNUNET_TIME_absolute_get ();
1187   pid = session->target;
1188   /* we'll now call callbacks that may cancel the session; hence
1189    * we should not use 'session' after this point */
1190   while (NULL != (pos = hd))
1191   {
1192     GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
1193     if (pos->transmit_cont != NULL)
1194       pos->transmit_cont (pos->transmit_cont_cls,
1195                           &pid,
1196                           GNUNET_OK,
1197                           pos->message_size,
1198                           pos->message_size); /* FIXME: include TCP overhead */
1199     GNUNET_free(pos);
1200   }
1201   GNUNET_assert (NULL == hd);
1202   GNUNET_assert (NULL == tl);
1203   LOG(GNUNET_ERROR_TYPE_DEBUG,
1204       "Transmitting %u bytes\n",
1205       ret);
1206   GNUNET_STATISTICS_update (plugin->env->stats,
1207                             gettext_noop ("# bytes currently in TCP buffers"),
1208                             - (int64_t) ret,
1209                             GNUNET_NO);
1210   GNUNET_STATISTICS_update (plugin->env->stats,
1211                             gettext_noop ("# bytes transmitted via TCP"),
1212                             ret,
1213                             GNUNET_NO);
1214   return ret;
1215 }
1216
1217
1218 /**
1219  * If we have pending messages, ask the server to
1220  * transmit them (schedule the respective tasks, etc.)
1221  *
1222  * @param session for which session should we do this
1223  */
1224 static void
1225 process_pending_messages (struct Session *session)
1226 {
1227   struct PendingMessage *pm;
1228
1229   GNUNET_assert (NULL != session->client);
1230   if (NULL != session->transmit_handle)
1231     return;
1232   if (NULL == (pm = session->pending_messages_head))
1233     return;
1234
1235   session->transmit_handle = GNUNET_SERVER_notify_transmit_ready (session->client,
1236                                                                   pm->message_size,
1237                                                                   GNUNET_TIME_absolute_get_remaining (pm->timeout),
1238                                                                   &do_transmit,
1239                                                                   session);
1240 }
1241
1242
1243 /**
1244  * Function that can be used by the transport service to transmit
1245  * a message using the plugin.   Note that in the case of a
1246  * peer disconnecting, the continuation MUST be called
1247  * prior to the disconnect notification itself.  This function
1248  * will be called with this peer's HELLO message to initiate
1249  * a fresh connection to another peer.
1250  *
1251  * @param cls closure
1252  * @param session which session must be used
1253  * @param msgbuf the message to transmit
1254  * @param msgbuf_size number of bytes in 'msgbuf'
1255  * @param priority how important is the message (most plugins will
1256  *                 ignore message priority and just FIFO)
1257  * @param to how long to wait at most for the transmission (does not
1258  *                require plugins to discard the message after the timeout,
1259  *                just advisory for the desired delay; most plugins will ignore
1260  *                this as well)
1261  * @param cont continuation to call once the message has
1262  *        been transmitted (or if the transport is ready
1263  *        for the next transmission call; or if the
1264  *        peer disconnected...); can be NULL
1265  * @param cont_cls closure for @a cont
1266  * @return number of bytes used (on the physical network, with overheads);
1267  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
1268  *         and does NOT mean that the message was not transmitted (DV)
1269  */
1270 static ssize_t
1271 tcp_plugin_send (void *cls,
1272                  struct Session *session,
1273                  const char *msgbuf,
1274                  size_t msgbuf_size,
1275                  unsigned int priority,
1276                  struct GNUNET_TIME_Relative to,
1277                  GNUNET_TRANSPORT_TransmitContinuation cont,
1278                  void *cont_cls)
1279 {
1280   struct Plugin * plugin = cls;
1281   struct PendingMessage *pm;
1282
1283   /* create new message entry */
1284   pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
1285   pm->msg = (const char *) &pm[1];
1286   memcpy (&pm[1], msgbuf, msgbuf_size);
1287   pm->message_size = msgbuf_size;
1288   pm->timeout = GNUNET_TIME_relative_to_absolute (to);
1289   pm->transmit_cont = cont;
1290   pm->transmit_cont_cls = cont_cls;
1291
1292   LOG(GNUNET_ERROR_TYPE_DEBUG,
1293       "Asked to transmit %u bytes to `%s', added message to list.\n",
1294       msgbuf_size, GNUNET_i2s (&session->target));
1295
1296   if (GNUNET_YES ==
1297       GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessionmap,
1298                                                     &session->target,
1299                                                     session))
1300   {
1301     GNUNET_assert (NULL != session->client);
1302     GNUNET_SERVER_client_set_timeout (session->client,
1303         GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1304     GNUNET_STATISTICS_update (plugin->env->stats,
1305         gettext_noop ("# bytes currently in TCP buffers"), msgbuf_size,
1306         GNUNET_NO);
1307
1308     /* append pm to pending_messages list */
1309     GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1310                                       session->pending_messages_tail,
1311                                       pm);
1312     notify_session_monitor (session->plugin,
1313                             session,
1314                             GNUNET_TRANSPORT_SS_UPDATE);
1315     session->msgs_in_queue++;
1316     session->bytes_in_queue += pm->message_size;
1317     process_pending_messages (session);
1318     return msgbuf_size;
1319   }
1320   else if (GNUNET_YES ==
1321            GNUNET_CONTAINER_multipeermap_contains_value (plugin->nat_wait_conns,
1322                                                          &session->target,
1323                                                          session))
1324   {
1325     LOG (GNUNET_ERROR_TYPE_DEBUG,
1326          "This NAT WAIT session for peer `%s' is not yet ready!\n",
1327          GNUNET_i2s (&session->target));
1328     GNUNET_STATISTICS_update (plugin->env->stats,
1329                               gettext_noop ("# bytes currently in TCP buffers"), msgbuf_size,
1330                               GNUNET_NO);
1331     /* append pm to pending_messages list */
1332     GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1333                                       session->pending_messages_tail,
1334                                       pm);
1335     session->msgs_in_queue++;
1336     session->bytes_in_queue += pm->message_size;
1337     notify_session_monitor (session->plugin,
1338                             session,
1339                             GNUNET_TRANSPORT_SS_HANDSHAKE);
1340     return msgbuf_size;
1341   }
1342   else
1343   {
1344     LOG(GNUNET_ERROR_TYPE_ERROR,
1345         "Invalid session %p\n",
1346         session);
1347     if (NULL != cont)
1348       cont (cont_cls,
1349             &session->target,
1350             GNUNET_SYSERR,
1351             pm->message_size,
1352             0);
1353     GNUNET_break (0);
1354     GNUNET_free (pm);
1355     return GNUNET_SYSERR; /* session does not exist here */
1356   }
1357 }
1358
1359 /**
1360  * Closure for #session_lookup_it().
1361  */
1362 struct SessionItCtx
1363 {
1364   /**
1365    * Address we are looking for.
1366    */
1367   const struct GNUNET_HELLO_Address *address;
1368
1369   /**
1370    * Where to store the session (if we found it).
1371    */
1372   struct Session *result;
1373
1374 };
1375
1376
1377 /**
1378  * Look for a session by address.
1379  *
1380  * @param cls the `struct SessionItCtx`
1381  * @param key unused
1382  * @param value a `struct Session`
1383  * @return #GNUNET_YES to continue looking, #GNUNET_NO if we found the session
1384  */
1385 static int
1386 session_lookup_it (void *cls,
1387                    const struct GNUNET_PeerIdentity *key,
1388                    void *value)
1389 {
1390   struct SessionItCtx * si_ctx = cls;
1391   struct Session * session = value;
1392
1393   if (0 != GNUNET_HELLO_address_cmp (si_ctx->address, session->address))
1394     return GNUNET_YES;
1395   /* Found existing session */
1396   si_ctx->result = session;
1397   return GNUNET_NO;
1398 }
1399
1400
1401 /**
1402  * Task cleaning up a NAT connection attempt after timeout
1403  *
1404  * @param cls the `struct Session`
1405  * @param tc scheduler context (unused)
1406  */
1407 static void
1408 nat_connect_timeout (void *cls,
1409                      const struct GNUNET_SCHEDULER_TaskContext *tc)
1410 {
1411   struct Session *session = cls;
1412
1413   session->nat_connection_timeout = NULL;
1414   LOG (GNUNET_ERROR_TYPE_DEBUG,
1415        "NAT WAIT connection to `%4s' at `%s' could not be established, removing session\n",
1416        GNUNET_i2s (&session->target),
1417        tcp_plugin_address_to_string (NULL,
1418                                      session->address->address,
1419                                      session->address->address_length));
1420   tcp_plugin_disconnect_session (session->plugin,
1421                                  session);
1422 }
1423
1424
1425 /**
1426  * Function that will be called whenever the transport service wants to
1427  * notify the plugin that a session is still active and in use and
1428  * therefore the session timeout for this session has to be updated
1429  *
1430  * @param cls closure
1431  * @param peer which peer was the session for
1432  * @param session which session is being updated
1433  */
1434 static void
1435 tcp_plugin_update_session_timeout (void *cls,
1436                                    const struct GNUNET_PeerIdentity *peer,
1437                                    struct Session *session)
1438 {
1439   reschedule_session_timeout (session);
1440 }
1441
1442
1443 /**
1444  * Task to signal the server that we can continue
1445  * receiving from the TCP client now.
1446  *
1447  * @param cls the `struct Session*`
1448  * @param tc task context (unused)
1449  */
1450 static void
1451 delayed_done (void *cls,
1452               const struct GNUNET_SCHEDULER_TaskContext *tc)
1453 {
1454   struct Session *session = cls;
1455
1456   session->receive_delay_task = NULL;
1457   reschedule_session_timeout (session);
1458
1459   GNUNET_SERVER_receive_done (session->client, GNUNET_OK);
1460 }
1461
1462
1463 /**
1464  * Function that will be called whenever the transport service wants to
1465  * notify the plugin that the inbound quota changed and that the plugin
1466  * should update it's delay for the next receive value
1467  *
1468  * @param cls closure
1469  * @param peer which peer was the session for
1470  * @param session which session is being updated
1471  * @param delay new delay to use for receiving
1472  */
1473 static void
1474 tcp_plugin_update_inbound_delay (void *cls,
1475                                  const struct GNUNET_PeerIdentity *peer,
1476                                  struct Session *session,
1477                                  struct GNUNET_TIME_Relative delay)
1478 {
1479   if (NULL == session->receive_delay_task)
1480     return;
1481   LOG (GNUNET_ERROR_TYPE_DEBUG,
1482        "New inbound delay %s\n",
1483        GNUNET_STRINGS_relative_time_to_string (delay,
1484                                                GNUNET_NO));
1485   session->receive_delay = GNUNET_TIME_relative_to_absolute (delay);
1486   GNUNET_SCHEDULER_cancel (session->receive_delay_task);
1487   session->receive_delay_task = GNUNET_SCHEDULER_add_delayed (delay,
1488                                                               &delayed_done,
1489                                                               session);
1490 }
1491
1492
1493 /**
1494  * Create a new session to transmit data to the target
1495  * This session will used to send data to this peer and the plugin will
1496  * notify us by calling the env->session_end function
1497  *
1498  * @param cls closure
1499  * @param address the address to use
1500  * @return the session if the address is valid, NULL otherwise
1501  */
1502 static struct Session *
1503 tcp_plugin_get_session (void *cls,
1504                         const struct GNUNET_HELLO_Address *address)
1505 {
1506   struct Plugin *plugin = cls;
1507   struct Session *session = NULL;
1508   int af;
1509   const void *sb;
1510   size_t sbs;
1511   struct GNUNET_CONNECTION_Handle *sa;
1512   struct sockaddr_in a4;
1513   struct sockaddr_in6 a6;
1514   const struct IPv4TcpAddress *t4;
1515   const struct IPv6TcpAddress *t6;
1516   unsigned int options;
1517   enum GNUNET_ATS_Network_Type net_type;
1518   unsigned int is_natd = GNUNET_NO;
1519   size_t addrlen;
1520 #ifdef TCP_STEALTH
1521   struct GNUNET_NETWORK_Handle *s;
1522 #endif
1523
1524   addrlen = address->address_length;
1525   LOG (GNUNET_ERROR_TYPE_DEBUG,
1526        "Trying to get session for `%s' address of peer `%s'\n",
1527        tcp_plugin_address_to_string (NULL,
1528                                      address->address,
1529                                      address->address_length),
1530        GNUNET_i2s (&address->peer));
1531
1532   if (GNUNET_HELLO_address_check_option (address,
1533                                          GNUNET_HELLO_ADDRESS_INFO_INBOUND))
1534   {
1535     GNUNET_break (0);
1536     return NULL;
1537   }
1538
1539   /* look for existing session */
1540   if (GNUNET_YES ==
1541       GNUNET_CONTAINER_multipeermap_contains (plugin->sessionmap,
1542                                               &address->peer))
1543   {
1544     struct SessionItCtx si_ctx;
1545
1546     si_ctx.address = address;
1547     si_ctx.result = NULL;
1548
1549     GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessionmap,
1550                                                 &address->peer,
1551                                                 &session_lookup_it, &si_ctx);
1552     if (NULL != si_ctx.result)
1553     {
1554       session = si_ctx.result;
1555       LOG (GNUNET_ERROR_TYPE_DEBUG,
1556            "Found existing session for `%s' address `%s' session %p\n",
1557            GNUNET_i2s (&address->peer),
1558            tcp_plugin_address_to_string (NULL,
1559                                          address->address,
1560                                          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 ==
1641        GNUNET_CONTAINER_multipeermap_contains (plugin->nat_wait_conns,
1642                                                &address->peer)))
1643   {
1644     LOG (GNUNET_ERROR_TYPE_DEBUG,
1645          "Found valid IPv4 NAT address (creating session)!\n");
1646     session = create_session (plugin,
1647                               address,
1648                               NULL,
1649                               GNUNET_YES);
1650     session->ats_address_network_type = net_type;
1651     GNUNET_break (session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
1652     session->nat_connection_timeout = GNUNET_SCHEDULER_add_delayed (NAT_TIMEOUT,
1653                                                                     &nat_connect_timeout,
1654                                                                     session);
1655     GNUNET_assert(GNUNET_OK ==
1656                   GNUNET_CONTAINER_multipeermap_put (plugin->nat_wait_conns,
1657                                                      &session->target,
1658                                                      session,
1659                                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1660
1661     LOG (GNUNET_ERROR_TYPE_DEBUG,
1662          "Created NAT WAIT connection to `%4s' at `%s'\n",
1663          GNUNET_i2s (&session->target),
1664          GNUNET_a2s (sb, sbs));
1665     if (GNUNET_OK == GNUNET_NAT_run_client (plugin->nat, &a4))
1666     {
1667       return session;
1668     }
1669     else
1670     {
1671       LOG(GNUNET_ERROR_TYPE_DEBUG,
1672           "Running NAT client for `%4s' at `%s' failed\n",
1673           GNUNET_i2s (&session->target),
1674           GNUNET_a2s (sb, sbs));
1675       tcp_plugin_disconnect_session (plugin,
1676                                      session);
1677       return NULL;
1678     }
1679   }
1680
1681   /* create new outbound session */
1682   GNUNET_assert(plugin->cur_connections <= plugin->max_connections);
1683
1684   if (0 != (options & TCP_OPTIONS_TCP_STEALTH))
1685   {
1686 #ifdef TCP_STEALTH
1687     s = GNUNET_NETWORK_socket_create (af, SOCK_STREAM, 0);
1688     if (NULL == s)
1689     {
1690       GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
1691                            "socket");
1692       sa = NULL;
1693     }
1694     else
1695     {
1696       if ( (GNUNET_OK !=
1697             GNUNET_NETWORK_socket_setsockopt (s,
1698                                               IPPROTO_TCP,
1699                                               TCP_STEALTH,
1700                                               &session->target,
1701                                               sizeof (struct GNUNET_PeerIdentity))) ||
1702            (GNUNET_OK !=
1703             GNUNET_NETWORK_socket_setsockopt (s,
1704                                               IPPROTO_TCP,
1705                                               TCP_STEALTH_INTEGRITY,
1706                                               &plugin->my_welcome,
1707                                               sizeof (struct WelcomeMessage))) )
1708       {
1709         /* TCP STEALTH not supported by kernel */
1710         GNUNET_break (GNUNET_OK ==
1711                       GNUNET_NETWORK_socket_close (s));
1712         sa = NULL;
1713       }
1714       else
1715       {
1716         sa = GNUNET_CONNECTION_connect_socket (s, sb, sbs);
1717       }
1718     }
1719 #else
1720     sa = NULL;
1721 #endif
1722   }
1723   else
1724   {
1725     sa = GNUNET_CONNECTION_create_from_sockaddr (af, sb, sbs);
1726   }
1727   if (NULL == sa)
1728   {
1729     LOG (GNUNET_ERROR_TYPE_DEBUG,
1730          "Failed to create connection to `%4s' at `%s'\n",
1731          GNUNET_i2s (&address->peer),
1732          GNUNET_a2s (sb, sbs));
1733     return NULL;
1734   }
1735   plugin->cur_connections++;
1736   if (plugin->cur_connections == plugin->max_connections)
1737     GNUNET_SERVER_suspend (plugin->server); /* Maximum number of connections rechead */
1738
1739   LOG (GNUNET_ERROR_TYPE_DEBUG,
1740        "Asked to transmit to `%4s', creating fresh session using address `%s'.\n",
1741        GNUNET_i2s (&address->peer),
1742        GNUNET_a2s (sb, sbs));
1743
1744   session = create_session (plugin,
1745                             address,
1746                             GNUNET_SERVER_connect_socket (plugin->server, sa),
1747                             GNUNET_NO);
1748   session->ats_address_network_type = net_type;
1749   GNUNET_break (session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
1750   GNUNET_SERVER_client_set_user_context(session->client, session);
1751   GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap,
1752                                      &session->target,
1753                                      session,
1754                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1755   LOG (GNUNET_ERROR_TYPE_DEBUG,
1756        "Creating new session for `%s' address `%s' session %p\n",
1757        GNUNET_i2s (&address->peer),
1758        tcp_plugin_address_to_string (NULL,
1759                                      address->address,
1760                                      address->address_length),
1761        session);
1762   /* Send TCP Welcome */
1763   process_pending_messages (session);
1764
1765   return session;
1766 }
1767
1768
1769 static int
1770 session_disconnect_it (void *cls,
1771                        const struct GNUNET_PeerIdentity *key,
1772                        void *value)
1773 {
1774   struct Plugin *plugin = cls;
1775   struct Session *session = value;
1776
1777   GNUNET_STATISTICS_update (session->plugin->env->stats,
1778                             gettext_noop ("# transport-service disconnect requests for TCP"),
1779                             1,
1780                             GNUNET_NO);
1781   tcp_plugin_disconnect_session (plugin,
1782                                  session);
1783   return GNUNET_YES;
1784 }
1785
1786
1787 /**
1788  * Function that can be called to force a disconnect from the
1789  * specified neighbour.  This should also cancel all previously
1790  * scheduled transmissions.  Obviously the transmission may have been
1791  * partially completed already, which is OK.  The plugin is supposed
1792  * to close the connection (if applicable) and no longer call the
1793  * transmit continuation(s).
1794  *
1795  * Finally, plugin MUST NOT call the services's receive function to
1796  * notify the service that the connection to the specified target was
1797  * closed after a getting this call.
1798  *
1799  * @param cls closure
1800  * @param target peer for which the last transmission is
1801  *        to be cancelled
1802  */
1803 static void
1804 tcp_plugin_disconnect (void *cls,
1805                        const struct GNUNET_PeerIdentity *target)
1806 {
1807   struct Plugin *plugin = cls;
1808
1809   LOG(GNUNET_ERROR_TYPE_DEBUG,
1810       "Disconnecting peer `%4s'\n",
1811       GNUNET_i2s (target));
1812   GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessionmap,
1813                                               target,
1814                                               &session_disconnect_it,
1815                                               plugin);
1816   GNUNET_CONTAINER_multipeermap_get_multiple (plugin->nat_wait_conns,
1817                                               target,
1818                                               &session_disconnect_it,
1819                                               plugin);
1820 }
1821
1822
1823 /**
1824  * Running pretty printers: head
1825  */
1826 static struct PrettyPrinterContext *ppc_dll_head;
1827
1828 /**
1829  * Running pretty printers: tail
1830  */
1831 static struct PrettyPrinterContext *ppc_dll_tail;
1832
1833 /**
1834  * Context for address to string conversion, closure
1835  * for #append_port().
1836  */
1837 struct PrettyPrinterContext
1838 {
1839   /**
1840    * DLL
1841    */
1842   struct PrettyPrinterContext *next;
1843
1844   /**
1845    * DLL
1846    */
1847   struct PrettyPrinterContext *prev;
1848
1849   /**
1850    * Timeout task
1851    */
1852   struct GNUNET_SCHEDULER_Task * timeout_task;
1853
1854   /**
1855    * Resolver handle
1856    */
1857   struct GNUNET_RESOLVER_RequestHandle *resolver_handle;
1858
1859   /**
1860    * Function to call with the result.
1861    */
1862   GNUNET_TRANSPORT_AddressStringCallback asc;
1863
1864   /**
1865    * Clsoure for @e asc.
1866    */
1867   void *asc_cls;
1868
1869   /**
1870    * Port to add after the IP address.
1871    */
1872   uint16_t port;
1873
1874   /**
1875    * IPv6 address
1876    */
1877   int ipv6;
1878
1879   /**
1880    * Options
1881    */
1882   uint32_t options;
1883 };
1884
1885
1886 /**
1887  * Append our port and forward the result.
1888  *
1889  * @param cls the `struct PrettyPrinterContext *`
1890  * @param hostname hostname part of the address
1891  */
1892 static void
1893 append_port (void *cls,
1894              const char *hostname)
1895 {
1896   struct PrettyPrinterContext *ppc = cls;
1897   char *ret;
1898
1899   if (NULL == hostname)
1900   {
1901     /* Final call, done */
1902     ppc->resolver_handle = NULL;
1903     GNUNET_CONTAINER_DLL_remove (ppc_dll_head,
1904                                  ppc_dll_tail,
1905                                  ppc);
1906     ppc->asc (ppc->asc_cls,
1907               NULL,
1908               GNUNET_OK);
1909     GNUNET_free (ppc);
1910     return;
1911   }
1912   if (GNUNET_YES == ppc->ipv6)
1913     GNUNET_asprintf (&ret,
1914                      "%s.%u.[%s]:%d",
1915                      PLUGIN_NAME,
1916                      ppc->options,
1917                      hostname,
1918                      ppc->port);
1919   else
1920     GNUNET_asprintf (&ret,
1921                      "%s.%u.%s:%d",
1922                      PLUGIN_NAME,
1923                      ppc->options,
1924                      hostname,
1925                      ppc->port);
1926   ppc->asc (ppc->asc_cls,
1927             ret,
1928             GNUNET_OK);
1929   GNUNET_free (ret);
1930 }
1931
1932
1933 /**
1934  * Convert the transports address to a nice, human-readable
1935  * format.
1936  *
1937  * @param cls closure
1938  * @param type name of the transport that generated the address
1939  * @param addr one of the addresses of the host, NULL for the last address
1940  *        the specific address format depends on the transport
1941  * @param addrlen length of the @a addr
1942  * @param numeric should (IP) addresses be displayed in numeric form?
1943  * @param timeout after how long should we give up?
1944  * @param asc function to call on each string
1945  * @param asc_cls closure for @a asc
1946  */
1947 static void
1948 tcp_plugin_address_pretty_printer (void *cls,
1949                                    const char *type,
1950                                    const void *addr,
1951                                    size_t addrlen,
1952                                    int numeric,
1953                                    struct GNUNET_TIME_Relative timeout,
1954                                    GNUNET_TRANSPORT_AddressStringCallback asc,
1955                                    void *asc_cls)
1956 {
1957   struct PrettyPrinterContext *ppc;
1958   const void *sb;
1959   size_t sbs;
1960   struct sockaddr_in a4;
1961   struct sockaddr_in6 a6;
1962   const struct IPv4TcpAddress *t4;
1963   const struct IPv6TcpAddress *t6;
1964   uint16_t port;
1965   uint32_t options;
1966
1967   if (sizeof(struct IPv6TcpAddress) == addrlen)
1968   {
1969     t6 = addr;
1970     memset (&a6, 0, sizeof(a6));
1971     a6.sin6_family = AF_INET6;
1972     a6.sin6_port = t6->t6_port;
1973     memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof(struct in6_addr));
1974     port = ntohs (t6->t6_port);
1975     options = ntohl (t6->options);
1976     sb = &a6;
1977     sbs = sizeof(a6);
1978   }
1979   else if (sizeof(struct IPv4TcpAddress) == addrlen)
1980   {
1981     t4 = addr;
1982     memset (&a4, 0, sizeof(a4));
1983     a4.sin_family = AF_INET;
1984     a4.sin_port = t4->t4_port;
1985     a4.sin_addr.s_addr = t4->ipv4_addr;
1986     port = ntohs (t4->t4_port);
1987     options = ntohl (t4->options);
1988     sb = &a4;
1989     sbs = sizeof(a4);
1990   }
1991   else
1992   {
1993     /* invalid address */
1994     asc (asc_cls, NULL, GNUNET_SYSERR);
1995     asc (asc_cls, NULL, GNUNET_OK);
1996     return;
1997   }
1998   ppc = GNUNET_new (struct PrettyPrinterContext);
1999   if (addrlen == sizeof(struct IPv6TcpAddress))
2000     ppc->ipv6 = GNUNET_YES;
2001   else
2002     ppc->ipv6 = GNUNET_NO;
2003   ppc->asc = asc;
2004   ppc->asc_cls = asc_cls;
2005   ppc->port = port;
2006   ppc->options = options;
2007   ppc->resolver_handle = GNUNET_RESOLVER_hostname_get (sb,
2008                                                        sbs,
2009                                                        ! numeric,
2010                                                        timeout,
2011                                                        &append_port, ppc);
2012   if (NULL == ppc->resolver_handle)
2013   {
2014     GNUNET_break (0);
2015     GNUNET_free (ppc);
2016     return;
2017   }
2018   GNUNET_CONTAINER_DLL_insert (ppc_dll_head,
2019                                ppc_dll_tail,
2020                                ppc);
2021 }
2022
2023
2024 /**
2025  * Check if the given port is plausible (must be either our listen
2026  * port or our advertised port), or any port if we are behind NAT
2027  * and do not have a port open.  If it is neither, we return
2028  * #GNUNET_SYSERR.
2029  *
2030  * @param plugin global variables
2031  * @param in_port port number to check
2032  * @return #GNUNET_OK if port is either open_port or adv_port
2033  */
2034 static int
2035 check_port (struct Plugin *plugin, uint16_t in_port)
2036 {
2037   if ((in_port == plugin->adv_port) || (in_port == plugin->open_port))
2038     return GNUNET_OK;
2039   return GNUNET_SYSERR;
2040 }
2041
2042 /**
2043  * Function that will be called to check if a binary address for this
2044  * plugin is well-formed and corresponds to an address for THIS peer
2045  * (as per our configuration).  Naturally, if absolutely necessary,
2046  * plugins can be a bit conservative in their answer, but in general
2047  * plugins should make sure that the address does not redirect
2048  * traffic to a 3rd party that might try to man-in-the-middle our
2049  * traffic.
2050  *
2051  * @param cls closure, our `struct Plugin *`
2052  * @param addr pointer to the address
2053  * @param addrlen length of addr
2054  * @return #GNUNET_OK if this is a plausible address for this peer
2055  *         and transport, #GNUNET_SYSERR if not
2056  */
2057 static int
2058 tcp_plugin_check_address (void *cls, const void *addr, size_t addrlen)
2059 {
2060   struct Plugin *plugin = cls;
2061   struct IPv4TcpAddress *v4;
2062   struct IPv6TcpAddress *v6;
2063
2064   if ((addrlen != sizeof(struct IPv4TcpAddress))
2065       && (addrlen != sizeof(struct IPv6TcpAddress)))
2066   {
2067     GNUNET_break_op(0);
2068     return GNUNET_SYSERR;
2069   }
2070
2071   if (addrlen == sizeof(struct IPv4TcpAddress))
2072   {
2073     v4 = (struct IPv4TcpAddress *) addr;
2074     if (0 != memcmp (&v4->options,
2075                      &plugin->myoptions,
2076                      sizeof(uint32_t)))
2077     {
2078       GNUNET_break(0);
2079       return GNUNET_SYSERR;
2080     }
2081     if (GNUNET_OK != check_port (plugin, ntohs (v4->t4_port)))
2082       return GNUNET_SYSERR;
2083     if (GNUNET_OK
2084         != GNUNET_NAT_test_address (plugin->nat, &v4->ipv4_addr,
2085             sizeof(struct in_addr)))
2086       return GNUNET_SYSERR;
2087   }
2088   else
2089   {
2090     v6 = (struct IPv6TcpAddress *) addr;
2091     if (IN6_IS_ADDR_LINKLOCAL (&v6->ipv6_addr))
2092     {
2093       GNUNET_break_op(0);
2094       return GNUNET_SYSERR;
2095     }
2096     if (0 != memcmp (&v6->options,
2097                      &plugin->myoptions,
2098                      sizeof (uint32_t)))
2099     {
2100       GNUNET_break(0);
2101       return GNUNET_SYSERR;
2102     }
2103     if (GNUNET_OK != check_port (plugin, ntohs (v6->t6_port)))
2104       return GNUNET_SYSERR;
2105     if (GNUNET_OK
2106         != GNUNET_NAT_test_address (plugin->nat, &v6->ipv6_addr,
2107             sizeof(struct in6_addr)))
2108       return GNUNET_SYSERR;
2109   }
2110   return GNUNET_OK;
2111 }
2112
2113 /**
2114  * We've received a nat probe from this peer via TCP.  Finish
2115  * creating the client session and resume sending of queued
2116  * messages.
2117  *
2118  * @param cls closure
2119  * @param client identification of the client
2120  * @param message the actual message
2121  */
2122 static void
2123 handle_tcp_nat_probe (void *cls,
2124                       struct GNUNET_SERVER_Client *client,
2125                       const struct GNUNET_MessageHeader *message)
2126 {
2127   struct Plugin *plugin = cls;
2128   struct Session *session;
2129   const struct TCP_NAT_ProbeMessage *tcp_nat_probe;
2130   size_t alen;
2131   void *vaddr;
2132   struct IPv4TcpAddress *t4;
2133   struct IPv6TcpAddress *t6;
2134   const struct sockaddr_in *s4;
2135   const struct sockaddr_in6 *s6;
2136
2137   LOG (GNUNET_ERROR_TYPE_DEBUG,
2138        "Received NAT probe\n");
2139   /* We have received a TCP NAT probe, meaning we (hopefully) initiated
2140    * a connection to this peer by running gnunet-nat-client.  This peer
2141    * received the punch message and now wants us to use the new connection
2142    * as the default for that peer.  Do so and then send a WELCOME message
2143    * so we can really be connected!
2144    */
2145   if (ntohs (message->size) != sizeof(struct TCP_NAT_ProbeMessage))
2146   {
2147     GNUNET_break_op(0);
2148     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2149     return;
2150   }
2151
2152   tcp_nat_probe = (const struct TCP_NAT_ProbeMessage *) message;
2153   if (0 == memcmp (&tcp_nat_probe->clientIdentity, plugin->env->my_identity,
2154           sizeof(struct GNUNET_PeerIdentity)))
2155   {
2156     /* refuse connections from ourselves */
2157     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2158     return;
2159   }
2160
2161   session = GNUNET_CONTAINER_multipeermap_get (plugin->nat_wait_conns,
2162                                                &tcp_nat_probe->clientIdentity);
2163   if (session == NULL)
2164   {
2165     LOG (GNUNET_ERROR_TYPE_DEBUG,
2166          "Did NOT find session for NAT probe!\n");
2167     GNUNET_SERVER_receive_done (client, GNUNET_OK);
2168     return;
2169   }
2170   LOG (GNUNET_ERROR_TYPE_DEBUG,
2171        "Found session for NAT probe!\n");
2172
2173   if (session->nat_connection_timeout != NULL)
2174   {
2175     GNUNET_SCHEDULER_cancel (session->nat_connection_timeout);
2176     session->nat_connection_timeout = NULL;
2177   }
2178
2179   if (GNUNET_OK != GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2180   {
2181     GNUNET_break(0);
2182     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2183     tcp_plugin_disconnect_session (plugin,
2184                                    session);
2185     return;
2186   }
2187   GNUNET_assert(
2188       GNUNET_CONTAINER_multipeermap_remove (plugin->nat_wait_conns, &tcp_nat_probe->clientIdentity, session) == GNUNET_YES);
2189   GNUNET_SERVER_client_set_user_context(client, session);
2190   GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap, &session->target,
2191       session, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2192   session->last_activity = GNUNET_TIME_absolute_get ();
2193   LOG(GNUNET_ERROR_TYPE_DEBUG, "Found address `%s' for incoming connection\n",
2194       GNUNET_a2s (vaddr, alen));
2195   switch (((const struct sockaddr *) vaddr)->sa_family)
2196   {
2197   case AF_INET:
2198     s4 = vaddr;
2199     t4 = GNUNET_new (struct IPv4TcpAddress);
2200     t4->options = htonl (TCP_OPTIONS_NONE);
2201     t4->t4_port = s4->sin_port;
2202     t4->ipv4_addr = s4->sin_addr.s_addr;
2203     session->address = GNUNET_HELLO_address_allocate (&tcp_nat_probe->clientIdentity,
2204                                                       PLUGIN_NAME,
2205                                                       &t4,
2206                                                       sizeof(struct IPv4TcpAddress),
2207                                                       GNUNET_HELLO_ADDRESS_INFO_NONE);
2208     break;
2209   case AF_INET6:
2210     s6 = vaddr;
2211     t6 = GNUNET_new (struct IPv6TcpAddress);
2212     t6->options = htonl (TCP_OPTIONS_NONE);
2213     t6->t6_port = s6->sin6_port;
2214     memcpy (&t6->ipv6_addr, &s6->sin6_addr, sizeof(struct in6_addr));
2215     session->address = GNUNET_HELLO_address_allocate (&tcp_nat_probe->clientIdentity,
2216                                                       PLUGIN_NAME,
2217                                                       &t6,
2218                                                       sizeof(struct IPv6TcpAddress),
2219                                                       GNUNET_HELLO_ADDRESS_INFO_NONE);
2220     break;
2221   default:
2222     GNUNET_break_op(0);
2223     LOG(GNUNET_ERROR_TYPE_DEBUG,
2224         "Bad address for incoming connection!\n");
2225     GNUNET_free(vaddr);
2226     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2227     tcp_plugin_disconnect_session (plugin,
2228                                    session);
2229     return;
2230   }
2231   GNUNET_free(vaddr);
2232   GNUNET_break(NULL == session->client);
2233   GNUNET_SERVER_client_keep (client);
2234   session->client = client;
2235   GNUNET_STATISTICS_update (plugin->env->stats,
2236       gettext_noop ("# TCP sessions active"), 1, GNUNET_NO);
2237   process_pending_messages (session);
2238   GNUNET_SERVER_receive_done (client, GNUNET_OK);
2239 }
2240
2241 /**
2242  * We've received a welcome from this peer via TCP.  Possibly create a
2243  * fresh client record and send back our welcome.
2244  *
2245  * @param cls closure
2246  * @param client identification of the client
2247  * @param message the actual message
2248  */
2249 static void
2250 handle_tcp_welcome (void *cls,
2251                     struct GNUNET_SERVER_Client *client,
2252                     const struct GNUNET_MessageHeader *message)
2253 {
2254   struct Plugin *plugin = cls;
2255   const struct WelcomeMessage *wm = (const struct WelcomeMessage *) message;
2256   struct GNUNET_HELLO_Address *address;
2257   struct Session *session;
2258   size_t alen;
2259   void *vaddr;
2260   struct IPv4TcpAddress t4;
2261   struct IPv6TcpAddress t6;
2262   const struct sockaddr_in *s4;
2263   const struct sockaddr_in6 *s6;
2264   struct GNUNET_ATS_Information ats;
2265
2266
2267   if (0 == memcmp (&wm->clientIdentity,
2268                    plugin->env->my_identity,
2269                    sizeof(struct GNUNET_PeerIdentity)))
2270   {
2271     /* refuse connections from ourselves */
2272     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2273     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2274     {
2275       LOG(GNUNET_ERROR_TYPE_INFO,
2276           "Received %s message from my own identity `%4s' on address `%s'\n",
2277           "WELCOME", GNUNET_i2s (&wm->clientIdentity),
2278           GNUNET_a2s (vaddr, alen));
2279       GNUNET_free(vaddr);
2280     }
2281     return;
2282   }
2283
2284   LOG(GNUNET_ERROR_TYPE_DEBUG,
2285       "Received %s message from `%4s' %p\n",
2286       "WELCOME",
2287       GNUNET_i2s (&wm->clientIdentity), client);
2288   GNUNET_STATISTICS_update (plugin->env->stats,
2289                             gettext_noop ("# TCP WELCOME messages received"),
2290                             1,
2291                             GNUNET_NO);
2292   session = lookup_session_by_client (plugin, client);
2293   if (NULL != session)
2294   {
2295     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2296     {
2297       LOG (GNUNET_ERROR_TYPE_DEBUG,
2298            "Found existing session %p for peer `%s'\n",
2299            session,
2300            GNUNET_a2s (vaddr, alen));
2301       GNUNET_free (vaddr);
2302     }
2303   }
2304   else
2305   {
2306     GNUNET_SERVER_client_keep (client);
2307     if (NULL != plugin->service) /* Otherwise value is incremented in tcp_access_check */
2308       plugin->cur_connections++;
2309     if (plugin->cur_connections == plugin->max_connections)
2310       GNUNET_SERVER_suspend (plugin->server); /* Maximum number of connections rechead */
2311
2312     if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
2313     {
2314       if (alen == sizeof(struct sockaddr_in))
2315       {
2316         s4 = vaddr;
2317         memset (&t4, '\0', sizeof (t4));
2318         t4.options = htonl (TCP_OPTIONS_NONE);
2319         t4.t4_port = s4->sin_port;
2320         t4.ipv4_addr = s4->sin_addr.s_addr;
2321         address = GNUNET_HELLO_address_allocate (&wm->clientIdentity,
2322                                                  PLUGIN_NAME,
2323                                                  &t4,
2324                                                  sizeof(t4),
2325                                                  GNUNET_HELLO_ADDRESS_INFO_INBOUND);
2326       }
2327       else if (alen == sizeof(struct sockaddr_in6))
2328       {
2329         s6 = vaddr;
2330         memset (&t6, '\0', sizeof (t6));
2331         t6.options = htonl (TCP_OPTIONS_NONE);
2332         t6.t6_port = s6->sin6_port;
2333         memcpy (&t6.ipv6_addr, &s6->sin6_addr, sizeof(struct in6_addr));
2334         address = GNUNET_HELLO_address_allocate (&wm->clientIdentity,
2335             PLUGIN_NAME, &t6, sizeof (t6),
2336             GNUNET_HELLO_ADDRESS_INFO_INBOUND);
2337       }
2338       else
2339       {
2340         GNUNET_break (0);
2341         GNUNET_free_non_null (vaddr);
2342         return;
2343       }
2344       session = create_session (plugin, address, client, GNUNET_NO);
2345       GNUNET_HELLO_address_free (address);
2346       session->ats_address_network_type = plugin->env->get_address_type (plugin->env->cls, vaddr, alen);
2347       ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
2348       ats.value = htonl (session->ats_address_network_type);
2349       LOG (GNUNET_ERROR_TYPE_DEBUG,
2350            "Creating new%s session %p for peer `%s' client %p \n",
2351            GNUNET_HELLO_address_check_option (session->address,
2352                                               GNUNET_HELLO_ADDRESS_INFO_INBOUND)
2353            ? " inbound" : "",
2354            session,
2355            tcp_plugin_address_to_string (NULL,
2356                                          (void *) session->address->address,
2357                                          session->address->address_length),
2358            client);
2359       GNUNET_free (vaddr);
2360       GNUNET_SERVER_client_set_user_context (session->client, session);
2361       GNUNET_CONTAINER_multipeermap_put (plugin->sessionmap,
2362                                          &session->target,
2363                                          session,
2364                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2365       /* Notify transport and ATS about new session */
2366       plugin->env->session_start (plugin->env->cls,
2367                                   session->address,
2368                                   session,
2369                                   &ats, 1);
2370       notify_session_monitor (plugin,
2371                               session,
2372                               GNUNET_TRANSPORT_SS_INIT);
2373     }
2374     else
2375     {
2376       LOG(GNUNET_ERROR_TYPE_DEBUG,
2377           "Did not obtain TCP socket address for incoming connection\n");
2378       GNUNET_break(0);
2379       return;
2380     }
2381   }
2382
2383   if (session->expecting_welcome != GNUNET_YES)
2384   {
2385     GNUNET_break_op(0);
2386     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2387     GNUNET_break(0);
2388     return;
2389   }
2390   session->last_activity = GNUNET_TIME_absolute_get ();
2391   session->expecting_welcome = GNUNET_NO;
2392
2393   process_pending_messages (session);
2394   GNUNET_SERVER_client_set_timeout (client,
2395       GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2396   GNUNET_SERVER_receive_done (client, GNUNET_OK);
2397 }
2398
2399
2400 /**
2401  * We've received data for this peer via TCP.  Unbox,
2402  * compute latency and forward.
2403  *
2404  * @param cls closure
2405  * @param client identification of the client
2406  * @param message the actual message
2407  */
2408 static void
2409 handle_tcp_data (void *cls,
2410                  struct GNUNET_SERVER_Client *client,
2411                  const struct GNUNET_MessageHeader *message)
2412 {
2413   struct Plugin *plugin = cls;
2414   struct Session *session;
2415   struct GNUNET_TIME_Relative delay;
2416   uint16_t type;
2417
2418   type = ntohs (message->type);
2419   if ((GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME == type)
2420       || (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE == type))
2421   {
2422     /* We don't want to propagate WELCOME and NAT Probe messages up! */
2423     GNUNET_SERVER_receive_done (client, GNUNET_OK);
2424     return;
2425   }
2426   session = lookup_session_by_client (plugin, client);
2427   if (NULL == session)
2428   {
2429     /* No inbound session found */
2430     void *vaddr;
2431     size_t alen;
2432
2433     GNUNET_SERVER_client_get_address (client, &vaddr, &alen);
2434     LOG(GNUNET_ERROR_TYPE_ERROR,
2435         "Received unexpected %u bytes of type %u from `%s'\n",
2436         (unsigned int) ntohs (message->size),
2437         (unsigned int) ntohs (message->type), GNUNET_a2s (vaddr, alen));
2438     GNUNET_break_op(0);
2439     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2440     GNUNET_free_non_null(vaddr);
2441     return;
2442   }
2443   else if (GNUNET_YES == session->expecting_welcome)
2444   {
2445     /* Session is expecting WELCOME message */
2446     void *vaddr;
2447     size_t alen;
2448
2449     GNUNET_SERVER_client_get_address (client, &vaddr, &alen);
2450     LOG(GNUNET_ERROR_TYPE_ERROR,
2451         "Received unexpected %u bytes of type %u from `%s'\n",
2452         (unsigned int) ntohs (message->size),
2453         (unsigned int) ntohs (message->type), GNUNET_a2s (vaddr, alen));
2454     GNUNET_break_op(0);
2455     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2456     GNUNET_free_non_null(vaddr);
2457     return;
2458   }
2459
2460   session->last_activity = GNUNET_TIME_absolute_get ();
2461   LOG(GNUNET_ERROR_TYPE_DEBUG,
2462       "Passing %u bytes of type %u from `%4s' to transport service.\n",
2463       (unsigned int) ntohs (message->size),
2464       (unsigned int) ntohs (message->type), GNUNET_i2s (&session->target));
2465
2466   GNUNET_STATISTICS_update (plugin->env->stats,
2467       gettext_noop ("# bytes received via TCP"), ntohs (message->size),
2468       GNUNET_NO);
2469   struct GNUNET_ATS_Information distance;
2470
2471   distance.type = htonl (GNUNET_ATS_NETWORK_TYPE);
2472   distance.value = htonl ((uint32_t) session->ats_address_network_type);
2473   GNUNET_break(session->ats_address_network_type != GNUNET_ATS_NET_UNSPECIFIED);
2474
2475   GNUNET_assert(GNUNET_CONTAINER_multipeermap_contains_value (plugin->sessionmap,
2476                                                               &session->target,
2477                                                               session));
2478
2479   delay = plugin->env->receive (plugin->env->cls,
2480                                 session->address,
2481                                 session,
2482                                 message);
2483   plugin->env->update_address_metrics (plugin->env->cls,
2484                                        session->address,
2485                                        session,
2486                                        &distance, 1);
2487   reschedule_session_timeout (session);
2488   if (0 == delay.rel_value_us)
2489   {
2490     GNUNET_SERVER_receive_done (client, GNUNET_OK);
2491   }
2492   else
2493   {
2494     LOG(GNUNET_ERROR_TYPE_DEBUG,
2495         "Throttling receiving from `%s' for %s\n",
2496         GNUNET_i2s (&session->target),
2497         GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
2498     GNUNET_SERVER_disable_receive_done_warning (client);
2499     session->receive_delay_task = GNUNET_SCHEDULER_add_delayed (delay,
2500         &delayed_done, session);
2501   }
2502 }
2503
2504
2505 /**
2506  * Functions with this signature are called whenever a peer
2507  * is disconnected on the network level.
2508  *
2509  * @param cls closure
2510  * @param client identification of the client
2511  */
2512 static void
2513 disconnect_notify (void *cls,
2514                    struct GNUNET_SERVER_Client *client)
2515 {
2516   struct Plugin *plugin = cls;
2517   struct Session *session;
2518
2519   if (NULL == client)
2520     return;
2521   session = lookup_session_by_client (plugin, client);
2522   if (NULL == session)
2523     return; /* unknown, nothing to do */
2524   LOG (GNUNET_ERROR_TYPE_DEBUG,
2525        "Destroying session of `%4s' with %s due to network-level disconnect.\n",
2526        GNUNET_i2s (&session->target),
2527        tcp_plugin_address_to_string (session->plugin, session->address->address,
2528                               session->address->address_length));
2529
2530   if (plugin->cur_connections == plugin->max_connections)
2531     GNUNET_SERVER_resume (plugin->server); /* Resume server  */
2532
2533   if (plugin->cur_connections < 1)
2534     GNUNET_break(0);
2535   else
2536     plugin->cur_connections--;
2537
2538   GNUNET_STATISTICS_update (session->plugin->env->stats, gettext_noop
2539                             ("# network-level TCP disconnect events"),
2540                             1,
2541                             GNUNET_NO);
2542   tcp_plugin_disconnect_session (plugin, session);
2543 }
2544
2545
2546 /**
2547  * We can now send a probe message, copy into buffer to really send.
2548  *
2549  * @param cls closure, a struct TCPProbeContext
2550  * @param size max size to copy
2551  * @param buf buffer to copy message to
2552  * @return number of bytes copied into @a buf
2553  */
2554 static size_t
2555 notify_send_probe (void *cls,
2556                    size_t size,
2557                    void *buf)
2558 {
2559   struct TCPProbeContext *tcp_probe_ctx = cls;
2560   struct Plugin *plugin = tcp_probe_ctx->plugin;
2561   size_t ret;
2562
2563   tcp_probe_ctx->transmit_handle = NULL;
2564   GNUNET_CONTAINER_DLL_remove (plugin->probe_head,
2565                                plugin->probe_tail,
2566                                tcp_probe_ctx);
2567   if (buf == NULL)
2568   {
2569     GNUNET_CONNECTION_destroy (tcp_probe_ctx->sock);
2570     GNUNET_free(tcp_probe_ctx);
2571     return 0;
2572   }
2573   GNUNET_assert(size >= sizeof(tcp_probe_ctx->message));
2574   memcpy (buf, &tcp_probe_ctx->message, sizeof(tcp_probe_ctx->message));
2575   GNUNET_SERVER_connect_socket (tcp_probe_ctx->plugin->server,
2576                                 tcp_probe_ctx->sock);
2577   ret = sizeof(tcp_probe_ctx->message);
2578   GNUNET_free(tcp_probe_ctx);
2579   return ret;
2580 }
2581
2582
2583 /**
2584  * Function called by the NAT subsystem suggesting another peer wants
2585  * to connect to us via connection reversal.  Try to connect back to the
2586  * given IP.
2587  *
2588  * @param cls closure
2589  * @param addr address to try
2590  * @param addrlen number of bytes in @a addr
2591  */
2592 static void
2593 try_connection_reversal (void *cls,
2594                          const struct sockaddr *addr,
2595                          socklen_t addrlen)
2596 {
2597   struct Plugin *plugin = cls;
2598   struct GNUNET_CONNECTION_Handle *sock;
2599   struct TCPProbeContext *tcp_probe_ctx;
2600
2601   /**
2602    * We have received an ICMP response, ostensibly from a peer
2603    * that wants to connect to us! Send a message to establish a connection.
2604    */
2605   sock = GNUNET_CONNECTION_create_from_sockaddr (AF_INET, addr, addrlen);
2606   if (sock == NULL)
2607   {
2608     /* failed for some odd reason (out of sockets?); ignore attempt */
2609     return;
2610   }
2611
2612   tcp_probe_ctx = GNUNET_new (struct TCPProbeContext);
2613   tcp_probe_ctx->message.header.size
2614     = htons (sizeof (struct TCP_NAT_ProbeMessage));
2615   tcp_probe_ctx->message.header.type
2616     = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE);
2617   tcp_probe_ctx->message.clientIdentity
2618     = *plugin->env->my_identity;
2619   tcp_probe_ctx->plugin = plugin;
2620   tcp_probe_ctx->sock = sock;
2621   GNUNET_CONTAINER_DLL_insert (plugin->probe_head,
2622                                plugin->probe_tail,
2623                                tcp_probe_ctx);
2624   tcp_probe_ctx->transmit_handle
2625     = GNUNET_CONNECTION_notify_transmit_ready (sock,
2626                                                ntohs (tcp_probe_ctx->message.header.size),
2627                                                GNUNET_TIME_UNIT_FOREVER_REL,
2628                                                &notify_send_probe,
2629                                                tcp_probe_ctx);
2630 }
2631
2632
2633 /**
2634  * Function obtain the network type for a session
2635  *
2636  * @param cls closure ('struct Plugin*')
2637  * @param session the session
2638  * @return the network type in HBO or #GNUNET_SYSERR
2639  */
2640 static enum GNUNET_ATS_Network_Type
2641 tcp_plugin_get_network (void *cls,
2642                         struct Session *session)
2643 {
2644   return session->ats_address_network_type;
2645 }
2646
2647
2648 /**
2649  * Return information about the given session to the
2650  * monitor callback.
2651  *
2652  * @param cls the `struct Plugin` with the monitor callback (`sic`)
2653  * @param peer peer we send information about
2654  * @param value our `struct Session` to send information about
2655  * @return #GNUNET_OK (continue to iterate)
2656  */
2657 static int
2658 send_session_info_iter (void *cls,
2659                         const struct GNUNET_PeerIdentity *peer,
2660                         void *value)
2661 {
2662   struct Plugin *plugin = cls;
2663   struct Session *session = value;
2664
2665   notify_session_monitor (plugin,
2666                           session,
2667                           GNUNET_TRANSPORT_SS_INIT);
2668   /* FIXME: cannot tell if this is up or not from current
2669      session state... */
2670   notify_session_monitor (plugin,
2671                           session,
2672                           GNUNET_TRANSPORT_SS_UP);
2673   return GNUNET_OK;
2674 }
2675
2676
2677 /**
2678  * Begin monitoring sessions of a plugin.  There can only
2679  * be one active monitor per plugin (i.e. if there are
2680  * multiple monitors, the transport service needs to
2681  * multiplex the generated events over all of them).
2682  *
2683  * @param cls closure of the plugin
2684  * @param sic callback to invoke, NULL to disable monitor;
2685  *            plugin will being by iterating over all active
2686  *            sessions immediately and then enter monitor mode
2687  * @param sic_cls closure for @a sic
2688  */
2689 static void
2690 tcp_plugin_setup_monitor (void *cls,
2691                           GNUNET_TRANSPORT_SessionInfoCallback sic,
2692                           void *sic_cls)
2693 {
2694   struct Plugin *plugin = cls;
2695
2696   plugin->sic = sic;
2697   plugin->sic_cls = sic_cls;
2698   if (NULL != sic)
2699   {
2700     GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
2701                                            &send_session_info_iter,
2702                                            plugin);
2703     /* signal end of first iteration */
2704     sic (sic_cls, NULL, NULL);
2705   }
2706 }
2707
2708
2709 /**
2710  * Entry point for the plugin.
2711  *
2712  * @param cls closure, the `struct GNUNET_TRANSPORT_PluginEnvironment *`
2713  * @return the `struct GNUNET_TRANSPORT_PluginFunctions *` or NULL on error
2714  */
2715 void *
2716 libgnunet_plugin_transport_tcp_init (void *cls)
2717 {
2718   static const struct GNUNET_SERVER_MessageHandler my_handlers[] = {
2719     { &handle_tcp_welcome, NULL,
2720       GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME, sizeof(struct WelcomeMessage) },
2721     { &handle_tcp_nat_probe, NULL,
2722       GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE, sizeof(struct TCP_NAT_ProbeMessage) },
2723     { &handle_tcp_data, NULL,
2724       GNUNET_MESSAGE_TYPE_ALL, 0 },
2725     { NULL, NULL, 0, 0 }
2726   };
2727   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
2728   struct GNUNET_TRANSPORT_PluginFunctions *api;
2729   struct Plugin *plugin;
2730   struct GNUNET_SERVICE_Context *service;
2731   unsigned long long aport;
2732   unsigned long long bport;
2733   unsigned long long max_connections;
2734   unsigned int i;
2735   struct GNUNET_TIME_Relative idle_timeout;
2736 #ifdef TCP_STEALTH
2737   struct GNUNET_NETWORK_Handle *const*lsocks;
2738 #endif
2739   int ret;
2740   int ret_s;
2741   struct sockaddr **addrs;
2742   socklen_t *addrlens;
2743
2744   if (NULL == env->receive)
2745   {
2746     /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
2747      initialze the plugin or the API */
2748     api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2749     api->cls = NULL;
2750     api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2751     api->address_to_string = &tcp_plugin_address_to_string;
2752     api->string_to_address = &tcp_plugin_string_to_address;
2753     return api;
2754   }
2755
2756   GNUNET_assert (NULL != env->cfg);
2757   if (GNUNET_OK !=
2758       GNUNET_CONFIGURATION_get_value_number (env->cfg,
2759                                              "transport-tcp",
2760                                              "MAX_CONNECTIONS",
2761                                              &max_connections))
2762     max_connections = 128;
2763
2764   aport = 0;
2765   if ((GNUNET_OK !=
2766        GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2767                                               "PORT", &bport)) ||
2768       (bport > 65535) ||
2769       ((GNUNET_OK ==
2770         GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2771                                                "ADVERTISED-PORT", &aport)) &&
2772        (aport > 65535) ))
2773   {
2774     LOG(GNUNET_ERROR_TYPE_ERROR,
2775         _("Require valid port number for service `%s' in configuration!\n"),
2776         "transport-tcp");
2777     return NULL ;
2778   }
2779   if (0 == aport)
2780     aport = bport;
2781   if (0 == bport)
2782     aport = 0;
2783   if (0 != bport)
2784   {
2785     service = GNUNET_SERVICE_start ("transport-tcp",
2786                                     env->cfg,
2787                                     GNUNET_SERVICE_OPTION_NONE);
2788     if (NULL == service)
2789     {
2790       LOG (GNUNET_ERROR_TYPE_WARNING,
2791            _("Failed to start service.\n"));
2792       return NULL;
2793     }
2794   }
2795   else
2796     service = NULL;
2797
2798   api = NULL;
2799   plugin = GNUNET_new (struct Plugin);
2800   plugin->sessionmap = GNUNET_CONTAINER_multipeermap_create (max_connections,
2801                                                              GNUNET_YES);
2802   plugin->max_connections = max_connections;
2803   plugin->open_port = bport;
2804   plugin->adv_port = aport;
2805   plugin->env = env;
2806   plugin->my_welcome.header.size = htons (sizeof(struct WelcomeMessage));
2807   plugin->my_welcome.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME);
2808   plugin->my_welcome.clientIdentity = *plugin->env->my_identity;
2809
2810   if ( (NULL != service) &&
2811        (GNUNET_YES ==
2812         GNUNET_CONFIGURATION_get_value_yesno (env->cfg,
2813                                               "transport-tcp",
2814                                               "TCP_STEALTH")) )
2815   {
2816 #ifdef TCP_STEALTH
2817     plugin->myoptions |= TCP_OPTIONS_TCP_STEALTH;
2818     lsocks = GNUNET_SERVICE_get_listen_sockets (service);
2819     if (NULL != lsocks)
2820     {
2821       uint32_t len = sizeof (struct WelcomeMessage);
2822
2823       for (i=0;NULL!=lsocks[i];i++)
2824       {
2825         if ( (GNUNET_OK !=
2826               GNUNET_NETWORK_socket_setsockopt (lsocks[i],
2827                                                 IPPROTO_TCP,
2828                                                 TCP_STEALTH,
2829                                                 env->my_identity,
2830                                                 sizeof (struct GNUNET_PeerIdentity))) ||
2831              (GNUNET_OK !=
2832               GNUNET_NETWORK_socket_setsockopt (lsocks[i],
2833                                                 IPPROTO_TCP,
2834                                                 TCP_STEALTH_INTEGRITY_LEN,
2835                                                 &len,
2836                                                 sizeof (len))) )
2837         {
2838           /* TCP STEALTH not supported by kernel */
2839           GNUNET_assert (0 == i);
2840           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2841                       _("TCP_STEALTH not supported on this platform.\n"));
2842           goto die;
2843         }
2844       }
2845     }
2846 #else
2847     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2848                 _("TCP_STEALTH not supported on this platform.\n"));
2849     goto die;
2850 #endif
2851   }
2852
2853   if ( (NULL != service) &&
2854        (GNUNET_SYSERR !=
2855         (ret_s =
2856          GNUNET_SERVICE_get_server_addresses ("transport-tcp",
2857                                               env->cfg,
2858                                               &addrs,
2859                                               &addrlens))))
2860   {
2861     for (ret = ret_s-1; ret >= 0; ret--)
2862       LOG (GNUNET_ERROR_TYPE_INFO,
2863            "Binding to address `%s'\n",
2864            GNUNET_a2s (addrs[ret], addrlens[ret]));
2865     plugin->nat
2866       = GNUNET_NAT_register (env->cfg,
2867                              GNUNET_YES,
2868                              aport,
2869                              (unsigned int) ret_s,
2870                              (const struct sockaddr **) addrs, addrlens,
2871                              &tcp_nat_port_map_callback,
2872                              &try_connection_reversal,
2873                              plugin);
2874     for (ret = ret_s -1; ret >= 0; ret--)
2875       GNUNET_free (addrs[ret]);
2876     GNUNET_free_non_null (addrs);
2877     GNUNET_free_non_null (addrlens);
2878   }
2879   else
2880   {
2881     plugin->nat = GNUNET_NAT_register (plugin->env->cfg,
2882                                        GNUNET_YES,
2883                                        0,
2884                                        0,
2885                                        NULL,
2886                                        NULL,
2887                                        NULL,
2888                                        &try_connection_reversal,
2889                                        plugin);
2890   }
2891   api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2892   api->cls = plugin;
2893   api->send = &tcp_plugin_send;
2894   api->get_session = &tcp_plugin_get_session;
2895   api->disconnect_session = &tcp_plugin_disconnect_session;
2896   api->query_keepalive_factor = &tcp_plugin_query_keepalive_factor;
2897   api->disconnect_peer = &tcp_plugin_disconnect;
2898   api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2899   api->check_address = &tcp_plugin_check_address;
2900   api->address_to_string = &tcp_plugin_address_to_string;
2901   api->string_to_address = &tcp_plugin_string_to_address;
2902   api->get_network = &tcp_plugin_get_network;
2903   api->update_session_timeout = &tcp_plugin_update_session_timeout;
2904   api->update_inbound_delay = &tcp_plugin_update_inbound_delay;
2905   api->setup_monitor = &tcp_plugin_setup_monitor;
2906   plugin->service = service;
2907   if (NULL != service)
2908   {
2909     plugin->server = GNUNET_SERVICE_get_server (service);
2910   }
2911   else
2912   {
2913     if (GNUNET_OK !=
2914         GNUNET_CONFIGURATION_get_value_time (env->cfg,
2915                                              "transport-tcp",
2916                                              "TIMEOUT",
2917                                              &idle_timeout))
2918     {
2919       GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2920                                  "transport-tcp",
2921                                  "TIMEOUT");
2922       goto die;
2923     }
2924     plugin->server
2925       = GNUNET_SERVER_create_with_sockets (&plugin_tcp_access_check,
2926                                            plugin, NULL,
2927                                            idle_timeout, GNUNET_YES);
2928   }
2929   plugin->handlers = GNUNET_malloc (sizeof (my_handlers));
2930   memcpy (plugin->handlers, my_handlers, sizeof(my_handlers));
2931   for (i = 0;i < sizeof(my_handlers) / sizeof(struct GNUNET_SERVER_MessageHandler);i++)
2932     plugin->handlers[i].callback_cls = plugin;
2933
2934   GNUNET_SERVER_add_handlers (plugin->server, plugin->handlers);
2935   GNUNET_SERVER_disconnect_notify (plugin->server, &disconnect_notify, plugin);
2936   plugin->nat_wait_conns = GNUNET_CONTAINER_multipeermap_create (16,
2937                                                                  GNUNET_YES);
2938   if (0 != bport)
2939     LOG (GNUNET_ERROR_TYPE_INFO,
2940          _("TCP transport listening on port %llu\n"),
2941          bport);
2942   else
2943     LOG (GNUNET_ERROR_TYPE_INFO,
2944          _("TCP transport not listening on any port (client only)\n"));
2945   if ( (aport != bport) &&
2946        (0 != bport) )
2947     LOG (GNUNET_ERROR_TYPE_INFO,
2948          _("TCP transport advertises itself as being on port %llu\n"),
2949          aport);
2950   /* Initially set connections to 0 */
2951   GNUNET_assert(NULL != plugin->env->stats);
2952   GNUNET_STATISTICS_set (plugin->env->stats,
2953                          gettext_noop ("# TCP sessions active"),
2954                          0,
2955                          GNUNET_NO);
2956   return api;
2957
2958  die:
2959   if (NULL != plugin->nat)
2960     GNUNET_NAT_unregister (plugin->nat);
2961   GNUNET_CONTAINER_multipeermap_destroy (plugin->sessionmap);
2962   if (NULL != service)
2963     GNUNET_SERVICE_stop (service);
2964   GNUNET_free (plugin);
2965   GNUNET_free_non_null (api);
2966   return NULL;
2967 }
2968
2969
2970 /**
2971  * Exit point from the plugin.
2972  *
2973  * @param cls the `struct GNUNET_TRANSPORT_PluginFunctions`
2974  * @return NULL
2975  */
2976 void *
2977 libgnunet_plugin_transport_tcp_done (void *cls)
2978 {
2979   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
2980   struct Plugin *plugin = api->cls;
2981   struct TCPProbeContext *tcp_probe;
2982   struct PrettyPrinterContext *cur;
2983   struct PrettyPrinterContext *next;
2984
2985   if (NULL == plugin)
2986   {
2987     GNUNET_free(api);
2988     return NULL ;
2989   }
2990   LOG (GNUNET_ERROR_TYPE_DEBUG,
2991        "Shutting down TCP plugin\n");
2992
2993   /* Removing leftover sessions */
2994   GNUNET_CONTAINER_multipeermap_iterate (plugin->sessionmap,
2995                                          &session_disconnect_it,
2996                                          plugin);
2997   /* Removing leftover NAT sessions */
2998   GNUNET_CONTAINER_multipeermap_iterate (plugin->nat_wait_conns,
2999                                          &session_disconnect_it,
3000                                          plugin);
3001
3002   for (cur = ppc_dll_head; NULL != cur; cur = next)
3003   {
3004     next = cur->next;
3005     GNUNET_CONTAINER_DLL_remove (ppc_dll_head,
3006                                  ppc_dll_tail,
3007                                  cur);
3008     GNUNET_RESOLVER_request_cancel (cur->resolver_handle);
3009     cur->asc (cur->asc_cls, NULL, GNUNET_OK);
3010     GNUNET_free (cur);
3011   }
3012
3013   if (NULL != plugin->service)
3014     GNUNET_SERVICE_stop (plugin->service);
3015   else
3016     GNUNET_SERVER_destroy (plugin->server);
3017   GNUNET_free(plugin->handlers);
3018   if (NULL != plugin->nat)
3019     GNUNET_NAT_unregister (plugin->nat);
3020   while (NULL != (tcp_probe = plugin->probe_head))
3021   {
3022     GNUNET_CONTAINER_DLL_remove (plugin->probe_head,
3023                                  plugin->probe_tail,
3024                                  tcp_probe);
3025     GNUNET_CONNECTION_destroy (tcp_probe->sock);
3026     GNUNET_free(tcp_probe);
3027   }
3028   GNUNET_CONTAINER_multipeermap_destroy (plugin->nat_wait_conns);
3029   GNUNET_CONTAINER_multipeermap_destroy (plugin->sessionmap);
3030   GNUNET_free(plugin);
3031   GNUNET_free(api);
3032   return NULL;
3033 }
3034
3035 /* end of plugin_transport_tcp.c */