src/transport/plugin_transport_unix.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2010 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 /**
  22  * @file transport/plugin_transport_unix.c
  23  * @brief Transport plugin using unix domain sockets (!)
  24  *        Clearly, can only be used locally on Unix/Linux hosts...
  25  *        ONLY INTENDED FOR TESTING!!!
  26  * @author Christian Grothoff
  27  * @author Nathan Evans
  28  */
  29
  30 #include "platform.h"
  31 #include "gnunet_hello_lib.h"
  32 #include "gnunet_connection_lib.h"
  33 #include "gnunet_container_lib.h"
  34 #include "gnunet_os_lib.h"
  35 #include "gnunet_peerinfo_service.h"
  36 #include "gnunet_protocols.h"
  37 #include "gnunet_resolver_service.h"
  38 #include "gnunet_server_lib.h"
  39 #include "gnunet_signatures.h"
  40 #include "gnunet_statistics_service.h"
  41 #include "gnunet_transport_service.h"
  42 #include "gnunet_transport_plugin.h"
  43 #include "transport.h"
  44
  45 #define DEBUG_UNIX GNUNET_NO
  46 #define DETAILS GNUNET_NO
  47
  48 #define MAX_PROBES 20
  49
  50 /*
  51  * Transport cost to peer, always 1 for UNIX (direct connection)
  52  */
  53 #define UNIX_DIRECT_DISTANCE 1
  54
  55 #define DEFAULT_NAT_PORT 0
  56
  57 /**
  58  * How long until we give up on transmitting the welcome message?
  59  */
  60 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  61
  62 /**
  63  * Starting port for listening and sending, eventually a config value
  64  */
  65 #define UNIX_NAT_DEFAULT_PORT 22086
  66
  67 /**
  68  * UNIX Message-Packet header.
  69  */
  70 struct UNIXMessage
  71 {
  72   /**
  73    * Message header.
  74    */
  75   struct GNUNET_MessageHeader header;
  76
  77   /**
  78    * What is the identity of the sender (GNUNET_hash of public key)
  79    */
  80   struct GNUNET_PeerIdentity sender;
  81
  82 };
  83
  84 struct RetryList
  85 {
  86   /**
  87    * Pointer to next element.
  88    */
  89   struct RetryList *next;
  90
  91   /**
  92    * Pointer to previous element.
  93    */
  94   struct RetryList *prev;
  95
  96   /**
  97    * The actual retry context.
  98    */
  99   struct RetrySendContext *retry_ctx;
 100 };
 101
 102 /**
 103  * Network format for IPv4 addresses.
 104  */
 105 struct IPv4UdpAddress
 106 {
 107   /**
 108    * IPv4 address, in network byte order.
 109    */
 110   uint32_t ipv4_addr GNUNET_PACKED;
 111
 112   /**
 113    * Port number, in network byte order.
 114    */
 115   uint16_t u_port GNUNET_PACKED;
 116 };
 117
 118
 119 /**
 120  * Network format for IPv6 addresses.
 121  */
 122 struct IPv6UdpAddress
 123 {
 124   /**
 125    * IPv6 address.
 126    */
 127   struct in6_addr ipv6_addr GNUNET_PACKED;
 128
 129   /**
 130    * Port number, in network byte order.
 131    */
 132   uint16_t u6_port GNUNET_PACKED;
 133 };
 134
 135 /* Forward definition */
 136 struct Plugin;
 137
 138 struct PrettyPrinterContext
 139 {
 140   GNUNET_TRANSPORT_AddressStringCallback asc;
 141   void *asc_cls;
 142   uint16_t port;
 143 };
 144
 145 struct RetrySendContext
 146 {
 147
 148   /**
 149    * Main plugin handle.
 150    */
 151   struct Plugin *plugin;
 152
 153   /**
 154    * Address of recipient.
 155    */
 156   char *addr;
 157
 158   /**
 159    * Length of address.
 160    */
 161   ssize_t addrlen;
 162
 163   /**
 164    * Message to send.
 165    */
 166   char *msg;
 167
 168   /**
 169    * Size of the message.
 170    */
 171   int msg_size;
 172
 173   /**
 174    * Handle to send message out on.
 175    */
 176   struct GNUNET_NETWORK_Handle *send_handle;
 177
 178   /**
 179    * Continuation to call on success or
 180    * timeout.
 181    */
 182   GNUNET_TRANSPORT_TransmitContinuation cont;
 183
 184   /**
 185    * Closure for continuation.
 186    */
 187   void *cont_cls;
 188
 189   /**
 190    * The peer the message is destined for.
 191    */
 192   struct GNUNET_PeerIdentity target;
 193
 194   /**
 195    * How long before not retrying any longer.
 196    */
 197   struct GNUNET_TIME_Absolute timeout;
 198
 199   /**
 200    * How long the last message was delayed.
 201    */
 202   struct GNUNET_TIME_Relative delay;
 203
 204   /**
 205    * The actual retry task.
 206    */
 207   GNUNET_SCHEDULER_TaskIdentifier retry_task;
 208
 209   /**
 210    * The priority of the message.
 211    */
 212   unsigned int priority;
 213
 214   /**
 215    * Entry in the DLL of retry items.
 216    */
 217   struct RetryList *retry_list_entry;
 218 };
 219
 220
 221 /**
 222  * UNIX NAT "Session"
 223  */
 224 struct PeerSession
 225 {
 226
 227   /**
 228    * Stored in a linked list.
 229    */
 230   struct PeerSession *next;
 231
 232   /**
 233    * Pointer to the global plugin struct.
 234    */
 235   struct Plugin *plugin;
 236
 237   /**
 238    * To whom are we talking to (set to our identity
 239    * if we are still waiting for the welcome message)
 240    */
 241   struct GNUNET_PeerIdentity target;
 242
 243   /**
 244    * Address of the other peer (either based on our 'connect'
 245    * call or on our 'accept' call).
 246    */
 247   void *connect_addr;
 248
 249   /**
 250    * Length of connect_addr.
 251    */
 252   size_t connect_alen;
 253
 254   /**
 255    * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
 256    */
 257   int expecting_welcome;
 258
 259   /**
 260    * From which socket do we need to send to this peer?
 261    */
 262   struct GNUNET_NETWORK_Handle *sock;
 263
 264   /*
 265    * Queue of messages for this peer, in the case that
 266    * we have to await a connection...
 267    */
 268   struct MessageQueue *messages;
 269
 270 };
 271
 272 /**
 273  * Information we keep for each of our listen sockets.
 274  */
 275 struct UNIX_Sock_Info
 276 {
 277   /**
 278    * The network handle
 279    */
 280   struct GNUNET_NETWORK_Handle *desc;
 281
 282   /**
 283    * The port we bound to
 284    */
 285   uint16_t port;
 286 };
 287
 288
 289 /**
 290  * Encapsulation of all of the state of the plugin.
 291  */
 292 struct Plugin
 293 {
 294   /**
 295    * Our environment.
 296    */
 297   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 298
 299   /*
 300    * Session of peers with whom we are currently connected
 301    */
 302   struct PeerSession *sessions;
 303
 304   /**
 305    * ID of task used to update our addresses when one expires.
 306    */
 307   GNUNET_SCHEDULER_TaskIdentifier address_update_task;
 308
 309   /**
 310    * ID of select task
 311    */
 312   GNUNET_SCHEDULER_TaskIdentifier select_task;
 313
 314   /**
 315    * Integer to append to unix domain socket.
 316    */
 317   uint16_t port;
 318
 319   /**
 320    * FD Read set
 321    */
 322   struct GNUNET_NETWORK_FDSet *rs;
 323
 324   /**
 325    * socket that we transmit all data with
 326    */
 327   struct UNIX_Sock_Info unix_sock;
 328
 329   /**
 330    * Path of our unix domain socket (/tmp/unix-plugin-PORT)
 331    */
 332   char *unix_socket_path;
 333
 334 };
 335
 336 /**
 337  * Head of retry DLL.
 338  */
 339 static struct RetryList *retry_list_head;
 340
 341 /**
 342  * Tail of retry DLL.
 343  */
 344 static struct RetryList *retry_list_tail;
 345
 346
 347 /**
 348  * Disconnect from a remote node.  Clean up session if we have one for this peer
 349  *
 350  * @param cls closure for this call (should be handle to Plugin)
 351  * @param target the peeridentity of the peer to disconnect
 352  * @return GNUNET_OK on success, GNUNET_SYSERR if the operation failed
 353  */
 354 void
 355 unix_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
 356 {
 357   /** TODO: Implement! */
 358   return;
 359 }
 360
 361 /**
 362  * Shutdown the server process (stop receiving inbound traffic). Maybe
 363  * restarted later!
 364  *
 365  * @param cls Handle to the plugin for this transport
 366  *
 367  * @return returns the number of sockets successfully closed,
 368  *         should equal the number of sockets successfully opened
 369  */
 370 static int
 371 unix_transport_server_stop (void *cls)
 372 {
 373   struct Plugin *plugin = cls;
 374   struct RetryList *pos;
 375
 376   pos = retry_list_head;
 377
 378   while (NULL != (pos = retry_list_head))
 379   {
 380     GNUNET_CONTAINER_DLL_remove (retry_list_head, retry_list_tail, pos);
 381     if (GNUNET_SCHEDULER_NO_TASK != pos->retry_ctx->retry_task)
 382     {
 383       GNUNET_SCHEDULER_cancel (pos->retry_ctx->retry_task);
 384     }
 385     GNUNET_free (pos->retry_ctx->msg);
 386     GNUNET_free (pos->retry_ctx->addr);
 387     GNUNET_free (pos->retry_ctx);
 388     GNUNET_free (pos);
 389   }
 390
 391   if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
 392   {
 393     GNUNET_SCHEDULER_cancel (plugin->select_task);
 394     plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
 395   }
 396
 397   GNUNET_break (GNUNET_OK ==
 398                 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
 399   plugin->unix_sock.desc = NULL;
 400
 401   return GNUNET_OK;
 402 }
 403
 404
 405 struct PeerSession *
 406 find_session (struct Plugin *plugin, const struct GNUNET_PeerIdentity *peer)
 407 {
 408   struct PeerSession *pos;
 409
 410   pos = plugin->sessions;
 411   while (pos != NULL)
 412   {
 413     if (memcmp (&pos->target, peer, sizeof (struct GNUNET_PeerIdentity)) == 0)
 414       return pos;
 415     pos = pos->next;
 416   }
 417
 418   return pos;
 419 }
 420
 421 /* Forward Declaration */
 422 static ssize_t
 423 unix_real_send (void *cls, struct RetrySendContext *incoming_retry_context,
 424                 struct GNUNET_NETWORK_Handle *send_handle,
 425                 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
 426                 size_t msgbuf_size, unsigned int priority,
 427                 struct GNUNET_TIME_Relative timeout, const void *addr,
 428                 size_t addrlen, GNUNET_TRANSPORT_TransmitContinuation cont,
 429                 void *cont_cls);
 430
 431 /**
 432  * Retry sending a message.
 433  *
 434  * @param cls closure a struct RetrySendContext
 435  * @param tc context information
 436  */
 437 void
 438 retry_send_message (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 439 {
 440   struct RetrySendContext *retry_ctx = cls;
 441
 442   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 443   {
 444     GNUNET_free (retry_ctx->msg);
 445     GNUNET_free (retry_ctx->addr);
 446     GNUNET_free (retry_ctx);
 447     return;
 448   }
 449
 450   unix_real_send (retry_ctx->plugin, retry_ctx, retry_ctx->send_handle,
 451                   &retry_ctx->target, retry_ctx->msg, retry_ctx->msg_size,
 452                   retry_ctx->priority,
 453                   GNUNET_TIME_absolute_get_remaining (retry_ctx->timeout),
 454                   retry_ctx->addr, retry_ctx->addrlen, retry_ctx->cont,
 455                   retry_ctx->cont_cls);
 456   return;
 457 }
 458
 459 /**
 460  * Actually send out the message, assume we've got the address and
 461  * send_handle squared away!
 462  *
 463  * @param cls closure
 464  * @param incoming_retry_context the retry context to use
 465  * @param send_handle which handle to send message on
 466  * @param target who should receive this message (ignored by UNIX)
 467  * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
 468  * @param msgbuf_size the size of the msgbuf to send
 469  * @param priority how important is the message (ignored by UNIX)
 470  * @param timeout when should we time out (give up) if we can not transmit?
 471  * @param addr the addr to send the message to, needs to be a sockaddr for us
 472  * @param addrlen the len of addr
 473  * @param cont continuation to call once the message has
 474  *        been transmitted (or if the transport is ready
 475  *        for the next transmission call; or if the
 476  *        peer disconnected...)
 477  * @param cont_cls closure for cont
 478  *
 479  * @return the number of bytes written, -1 on errors
 480  */
 481 static ssize_t
 482 unix_real_send (void *cls, struct RetrySendContext *incoming_retry_context,
 483                 struct GNUNET_NETWORK_Handle *send_handle,
 484                 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
 485                 size_t msgbuf_size, unsigned int priority,
 486                 struct GNUNET_TIME_Relative timeout, const void *addr,
 487                 size_t addrlen, GNUNET_TRANSPORT_TransmitContinuation cont,
 488                 void *cont_cls)
 489 {
 490   struct Plugin *plugin = cls;
 491   struct UNIXMessage *message;
 492   struct RetrySendContext *retry_ctx;
 493   int ssize;
 494   ssize_t sent;
 495   const void *sb;
 496   size_t sbs;
 497   struct sockaddr_un un;
 498   size_t slen;
 499   struct RetryList *retry_list_entry;
 500   int retry;
 501
 502   if (send_handle == NULL)
 503   {
 504 #if DEBUG_UNIX
 505     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 506                 "unix_real_send with send_handle NULL!\n");
 507 #endif
 508     /* failed to open send socket for AF */
 509     if (cont != NULL)
 510       cont (cont_cls, target, GNUNET_SYSERR);
 511     return 0;
 512   }
 513   if ((addr == NULL) || (addrlen == 0))
 514   {
 515 #if DEBUG_UNIX
 516     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 517                 "unix_real_send called without address, returning!\n");
 518 #endif
 519     if (cont != NULL)
 520       cont (cont_cls, target, GNUNET_SYSERR);
 521     return 0;                   /* Can never send if we don't have an address!! */
 522   }
 523
 524   /* Build the message to be sent */
 525   message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
 526   ssize = sizeof (struct UNIXMessage) + msgbuf_size;
 527
 528   message->header.size = htons (ssize);
 529   message->header.type = htons (0);
 530   memcpy (&message->sender, plugin->env->my_identity,
 531           sizeof (struct GNUNET_PeerIdentity));
 532   memcpy (&message[1], msgbuf, msgbuf_size);
 533
 534   memset (&un, 0, sizeof (un));
 535   un.sun_family = AF_UNIX;
 536   slen = strlen (addr) + 1;
 537   if (slen >= sizeof (un.sun_path))
 538     slen = sizeof (un.sun_path) - 1;
 539   sent = 0;
 540   GNUNET_assert (slen < sizeof (un.sun_path));
 541   memcpy (un.sun_path, addr, slen);
 542   un.sun_path[slen] = '\0';
 543   slen = sizeof (struct sockaddr_un);
 544 #if LINUX
 545   un.sun_path[0] = '\0';
 546 #endif
 547 #if HAVE_SOCKADDR_IN_SIN_LEN
 548   un.sun_len = (u_char) slen;
 549 #endif
 550   sb = (struct sockaddr *) &un;
 551   sbs = slen;
 552   retry = GNUNET_NO;
 553
 554   sent = GNUNET_NETWORK_socket_sendto (send_handle, message, ssize, sb, sbs);
 555
 556   if ((GNUNET_SYSERR == sent) && (errno == EAGAIN))
 557     retry = GNUNET_YES;
 558
 559   if ((GNUNET_SYSERR == sent) && (errno == EMSGSIZE))
 560   {
 561     socklen_t size = 0;
 562     socklen_t len = sizeof (size);
 563
 564     GNUNET_NETWORK_socket_getsockopt ((struct GNUNET_NETWORK_Handle *)
 565                                       send_handle, SOL_SOCKET, SO_SNDBUF, &size,
 566                                       &len);
 567
 568     if (size < ssize)
 569     {
 570 #if DEBUG_UNIX
 571       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 572                   "Trying to increase socket buffer size from %i to %i for message size %i\n",
 573                   size, ((ssize / 1000) + 2) * 1000, ssize);
 574 #endif
 575       size = ((ssize / 1000) + 2) * 1000;
 576       if (GNUNET_NETWORK_socket_setsockopt
 577           ((struct GNUNET_NETWORK_Handle *) send_handle, SOL_SOCKET, SO_SNDBUF,
 578            &size, sizeof (size)) == GNUNET_OK)
 579         retry = GNUNET_YES;
 580       else
 581         GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
 582     }
 583   }
 584
 585   if (retry == GNUNET_YES)
 586   {
 587     if (incoming_retry_context == NULL)
 588     {
 589       retry_list_entry = GNUNET_malloc (sizeof (struct RetryList));
 590       retry_ctx = GNUNET_malloc (sizeof (struct RetrySendContext));
 591       retry_ctx->addr = GNUNET_malloc (addrlen);
 592       retry_ctx->msg = GNUNET_malloc (msgbuf_size);
 593       retry_ctx->plugin = plugin;
 594       memcpy (retry_ctx->addr, addr, addrlen);
 595       memcpy (retry_ctx->msg, msgbuf, msgbuf_size);
 596       retry_ctx->msg_size = msgbuf_size;
 597       retry_ctx->addrlen = addrlen;
 598       retry_ctx->send_handle = send_handle;
 599       retry_ctx->cont = cont;
 600       retry_ctx->cont_cls = cont_cls;
 601       retry_ctx->priority = priority;
 602       retry_ctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 603       memcpy (&retry_ctx->target, target, sizeof (struct GNUNET_PeerIdentity));
 604       retry_ctx->delay = GNUNET_TIME_UNIT_MILLISECONDS;
 605       retry_ctx->retry_list_entry = retry_list_entry;
 606       retry_list_entry->retry_ctx = retry_ctx;
 607       GNUNET_CONTAINER_DLL_insert (retry_list_head, retry_list_tail,
 608                                    retry_list_entry);
 609     }
 610     else
 611     {
 612       retry_ctx = incoming_retry_context;
 613       retry_ctx->delay = GNUNET_TIME_relative_multiply (retry_ctx->delay, 2);
 614     }
 615     retry_ctx->retry_task =
 616         GNUNET_SCHEDULER_add_delayed (retry_ctx->delay, &retry_send_message,
 617                                       retry_ctx);
 618
 619     //GNUNET_log_strerror (GNUNET_ERROR_TYPE_DEBUG, "send");
 620     GNUNET_free (message);
 621     return ssize;
 622   }
 623 #if DEBUG_UNIX
 624   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 625               "UNIX transmit %u-byte message to %s (%d: %s)\n",
 626               (unsigned int) ssize, GNUNET_a2s (sb, sbs), (int) sent,
 627               (sent < 0) ? STRERROR (errno) : "ok");
 628 #endif
 629   if (cont != NULL)
 630   {
 631     if (sent == GNUNET_SYSERR)
 632       cont (cont_cls, target, GNUNET_SYSERR);
 633     else
 634     {
 635       cont (cont_cls, target, GNUNET_OK);
 636     }
 637   }
 638
 639   if (incoming_retry_context != NULL)
 640   {
 641     GNUNET_CONTAINER_DLL_remove (retry_list_head, retry_list_tail,
 642                                  incoming_retry_context->retry_list_entry);
 643     GNUNET_free (incoming_retry_context->retry_list_entry);
 644     GNUNET_free (incoming_retry_context->msg);
 645     GNUNET_free (incoming_retry_context->addr);
 646     GNUNET_free (incoming_retry_context);
 647   }
 648
 649   GNUNET_free (message);
 650   return sent;
 651 }
 652
 653
 654 /**
 655  * Function that can be used by the transport service to transmit
 656  * a message using the plugin.
 657  *
 658  * @param cls closure
 659  * @param target who should receive this message (ignored by UNIX)
 660  * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
 661  * @param msgbuf_size the size of the msgbuf to send
 662  * @param priority how important is the message (ignored by UNIX)
 663  * @param timeout when should we time out (give up) if we can not transmit?
 664  * @param session identifier used for this session (can be NULL)
 665  * @param addr the addr to send the message to, needs to be a sockaddr for us
 666  * @param addrlen the len of addr
 667  * @param force_address not used, we had better have an address to send to
 668  *        because we are stateless!!
 669  * @param cont continuation to call once the message has
 670  *        been transmitted (or if the transport is ready
 671  *        for the next transmission call; or if the
 672  *        peer disconnected...)
 673  * @param cont_cls closure for cont
 674  *
 675  * @return the number of bytes written (may return 0 and the message can
 676  *         still be transmitted later!)
 677  */
 678 static ssize_t
 679 unix_plugin_send (void *cls, const struct GNUNET_PeerIdentity *target,
 680                   const char *msgbuf, size_t msgbuf_size, unsigned int priority,
 681                   struct GNUNET_TIME_Relative timeout, struct Session *session,
 682                   const void *addr, size_t addrlen, int force_address,
 683                   GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
 684 {
 685   struct Plugin *plugin = cls;
 686   ssize_t sent;
 687
 688   if (force_address == GNUNET_SYSERR)
 689     return GNUNET_SYSERR;
 690   GNUNET_assert (NULL == session);
 691
 692 #if DEBUG_UNIX
 693   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Asked to send message to `%s'\n",
 694               (char *) addr);
 695 #endif
 696   sent =
 697       unix_real_send (cls, NULL, plugin->unix_sock.desc, target, msgbuf,
 698                       msgbuf_size, priority, timeout, addr, addrlen, cont,
 699                       cont_cls);
 700 #if DEBUG_UNIX
 701   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sent %d bytes to `%s'\n", sent,
 702               (char *) addr);
 703 #endif
 704   if (sent == GNUNET_SYSERR)
 705     return 0;
 706   return sent;
 707 }
 708
 709
 710 /**
 711  * Demultiplexer for UNIX messages
 712  *
 713  * @param plugin the main plugin for this transport
 714  * @param sender from which peer the message was received
 715  * @param currhdr pointer to the header of the message
 716  * @param un the address from which the message was received
 717  * @param fromlen the length of the address
 718  */
 719 static void
 720 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
 721                     const struct GNUNET_MessageHeader *currhdr,
 722                     const struct sockaddr_un *un, size_t fromlen)
 723 {
 724   struct GNUNET_TRANSPORT_ATS_Information distance[2];
 725
 726   distance[0].type = htonl (GNUNET_TRANSPORT_ATS_QUALITY_NET_DISTANCE);
 727   distance[0].value = htonl (UNIX_DIRECT_DISTANCE);
 728   distance[1].type = htonl (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR);
 729   distance[1].value = htonl (0);
 730
 731   GNUNET_assert (fromlen >= sizeof (struct sockaddr_un));
 732
 733 #if DEBUG_UNIX
 734   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received message from %s\n",
 735               un->sun_path);
 736 #endif
 737   plugin->env->receive (plugin->env->cls, sender, currhdr,
 738                         (const struct GNUNET_TRANSPORT_ATS_Information *)
 739                         &distance, 2, NULL, un->sun_path,
 740                         strlen (un->sun_path) + 1);
 741 }
 742
 743
 744 /*
 745  * @param cls the plugin handle
 746  * @param tc the scheduling context (for rescheduling this function again)
 747  *
 748  * We have been notified that our writeset has something to read.  We don't
 749  * know which socket needs to be read, so we have to check each one
 750  * Then reschedule this function to be called again once more is available.
 751  *
 752  */
 753 static void
 754 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 755 {
 756   struct Plugin *plugin = cls;
 757   char buf[65536];
 758   struct UNIXMessage *msg;
 759   struct GNUNET_PeerIdentity sender;
 760   struct sockaddr_un un;
 761   socklen_t addrlen;
 762   ssize_t ret;
 763   int offset;
 764   int tsize;
 765   char *msgbuf;
 766   const struct GNUNET_MessageHeader *currhdr;
 767   uint16_t csize;
 768
 769   plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
 770   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 771     return;
 772
 773   addrlen = sizeof (un);
 774   memset (&un, 0, sizeof (un));
 775   GNUNET_assert (GNUNET_NETWORK_fdset_isset
 776                  (tc->read_ready, plugin->unix_sock.desc));
 777   ret =
 778       GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc, buf, sizeof (buf),
 779                                       (struct sockaddr *) &un, &addrlen);
 780
 781   if (ret == GNUNET_SYSERR)
 782   {
 783     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "recvfrom");
 784     plugin->select_task =
 785         GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
 786                                      GNUNET_SCHEDULER_NO_TASK,
 787                                      GNUNET_TIME_UNIT_FOREVER_REL, plugin->rs,
 788                                      NULL, &unix_plugin_select, plugin);
 789     return;
 790   }
 791   else
 792   {
 793 #if LINUX
 794     un.sun_path[0] = '/';
 795 #endif
 796 #if DEBUG_UNIX
 797     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Read %d bytes from socket %s\n", ret,
 798                 &un.sun_path[0]);
 799 #endif
 800   }
 801
 802   GNUNET_assert (AF_UNIX == (un.sun_family));
 803
 804   msg = (struct UNIXMessage *) buf;
 805   csize = ntohs (msg->header.size);
 806   if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
 807   {
 808     GNUNET_break_op (0);
 809     plugin->select_task =
 810         GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
 811                                      GNUNET_SCHEDULER_NO_TASK,
 812                                      GNUNET_TIME_UNIT_FOREVER_REL, plugin->rs,
 813                                      NULL, &unix_plugin_select, plugin);
 814     return;
 815   }
 816   msgbuf = (char *) &msg[1];
 817   memcpy (&sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
 818   offset = 0;
 819   tsize = csize - sizeof (struct UNIXMessage);
 820   while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
 821   {
 822     currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
 823     csize = ntohs (currhdr->size);
 824     if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
 825         (csize > tsize - offset))
 826     {
 827       GNUNET_break_op (0);
 828       break;
 829     }
 830     unix_demultiplexer (plugin, &sender, currhdr, &un, sizeof (un));
 831     offset += csize;
 832   }
 833   plugin->select_task =
 834       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
 835                                    GNUNET_SCHEDULER_NO_TASK,
 836                                    GNUNET_TIME_UNIT_FOREVER_REL, plugin->rs,
 837                                    NULL, &unix_plugin_select, plugin);
 838 }
 839
 840 /**
 841  * Create a slew of UNIX sockets.  If possible, use IPv6 and IPv4.
 842  *
 843  * @param cls closure for server start, should be a struct Plugin *
 844  * @return number of sockets created or GNUNET_SYSERR on error
 845 */
 846 static int
 847 unix_transport_server_start (void *cls)
 848 {
 849   struct Plugin *plugin = cls;
 850   struct sockaddr *serverAddr;
 851   socklen_t addrlen;
 852   struct sockaddr_un un;
 853   size_t slen;
 854
 855   memset (&un, 0, sizeof (un));
 856   un.sun_family = AF_UNIX;
 857   slen = strlen (plugin->unix_socket_path) + 1;
 858   if (slen >= sizeof (un.sun_path))
 859     slen = sizeof (un.sun_path) - 1;
 860
 861   memcpy (un.sun_path, plugin->unix_socket_path, slen);
 862   un.sun_path[slen] = '\0';
 863   slen = sizeof (struct sockaddr_un);
 864 #if HAVE_SOCKADDR_IN_SIN_LEN
 865   un.sun_len = (u_char) slen;
 866 #endif
 867
 868   serverAddr = (struct sockaddr *) &un;
 869   addrlen = slen;
 870 #if LINUX
 871   un.sun_path[0] = '\0';
 872 #endif
 873
 874   plugin->unix_sock.desc =
 875       GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_DGRAM, 0);
 876   if (NULL == plugin->unix_sock.desc)
 877   {
 878     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
 879     return GNUNET_SYSERR;
 880   }
 881   if (GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, serverAddr, addrlen)
 882       != GNUNET_OK)
 883   {
 884     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
 885     GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
 886     plugin->unix_sock.desc = NULL;
 887     return GNUNET_SYSERR;
 888   }
 889 #if DEBUG_UNIX
 890   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "unix", "Bound to `%s'\n",
 891                    &un.sun_path[0]);
 892 #endif
 893   plugin->rs = GNUNET_NETWORK_fdset_create ();
 894   GNUNET_NETWORK_fdset_zero (plugin->rs);
 895   GNUNET_NETWORK_fdset_set (plugin->rs, plugin->unix_sock.desc);
 896
 897   plugin->select_task =
 898       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
 899                                    GNUNET_SCHEDULER_NO_TASK,
 900                                    GNUNET_TIME_UNIT_FOREVER_REL, plugin->rs,
 901                                    NULL, &unix_plugin_select, plugin);
 902   return 1;
 903 }
 904
 905
 906 /**
 907  * Function that will be called to check if a binary address for this
 908  * plugin is well-formed and corresponds to an address for THIS peer
 909  * (as per our configuration).  Naturally, if absolutely necessary,
 910  * plugins can be a bit conservative in their answer, but in general
 911  * plugins should make sure that the address does not redirect
 912  * traffic to a 3rd party that might try to man-in-the-middle our
 913  * traffic.
 914  *
 915  * @param cls closure, should be our handle to the Plugin
 916  * @param addr pointer to the address
 917  * @param addrlen length of addr
 918  * @return GNUNET_OK if this is a plausible address for this peer
 919  *         and transport, GNUNET_SYSERR if not
 920  *
 921  */
 922 static int
 923 unix_check_address (void *cls, const void *addr, size_t addrlen)
 924 {
 925
 926 #if DEBUG_UNIX
 927   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 928               "Informing transport service about my address `%s'\n",
 929               (char *) addr);
 930 #endif
 931   return GNUNET_OK;
 932 }
 933
 934
 935 /**
 936  * Append our port and forward the result.
 937  */
 938 static void
 939 append_port (void *cls, const char *hostname)
 940 {
 941   struct PrettyPrinterContext *ppc = cls;
 942   char *ret;
 943
 944   if (hostname == NULL)
 945   {
 946     ppc->asc (ppc->asc_cls, NULL);
 947     GNUNET_free (ppc);
 948     return;
 949   }
 950   GNUNET_asprintf (&ret, "%s:%d", hostname, ppc->port);
 951   ppc->asc (ppc->asc_cls, ret);
 952   GNUNET_free (ret);
 953 }
 954
 955
 956 /**
 957  * Convert the transports address to a nice, human-readable
 958  * format.
 959  *
 960  * @param cls closure
 961  * @param type name of the transport that generated the address
 962  * @param addr one of the addresses of the host, NULL for the last address
 963  *        the specific address format depends on the transport
 964  * @param addrlen length of the address
 965  * @param numeric should (IP) addresses be displayed in numeric form?
 966  * @param timeout after how long should we give up?
 967  * @param asc function to call on each string
 968  * @param asc_cls closure for asc
 969  */
 970 static void
 971 unix_plugin_address_pretty_printer (void *cls, const char *type,
 972                                     const void *addr, size_t addrlen,
 973                                     int numeric,
 974                                     struct GNUNET_TIME_Relative timeout,
 975                                     GNUNET_TRANSPORT_AddressStringCallback asc,
 976                                     void *asc_cls)
 977 {
 978   struct PrettyPrinterContext *ppc;
 979   const void *sb;
 980   size_t sbs;
 981   struct sockaddr_in a4;
 982   struct sockaddr_in6 a6;
 983   const struct IPv4UdpAddress *u4;
 984   const struct IPv6UdpAddress *u6;
 985   uint16_t port;
 986
 987   if (addrlen == sizeof (struct IPv6UdpAddress))
 988   {
 989     u6 = addr;
 990     memset (&a6, 0, sizeof (a6));
 991     a6.sin6_family = AF_INET6;
 992     a6.sin6_port = u6->u6_port;
 993     memcpy (&a6.sin6_addr, &u6->ipv6_addr, sizeof (struct in6_addr));
 994     port = ntohs (u6->u6_port);
 995     sb = &a6;
 996     sbs = sizeof (a6);
 997   }
 998   else if (addrlen == sizeof (struct IPv4UdpAddress))
 999   {
1000     u4 = addr;
1001     memset (&a4, 0, sizeof (a4));
1002     a4.sin_family = AF_INET;
1003     a4.sin_port = u4->u_port;
1004     a4.sin_addr.s_addr = u4->ipv4_addr;
1005     port = ntohs (u4->u_port);
1006     sb = &a4;
1007     sbs = sizeof (a4);
1008   }
1009   else
1010   {
1011     /* invalid address */
1012     GNUNET_break_op (0);
1013     asc (asc_cls, NULL);
1014     return;
1015   }
1016   ppc = GNUNET_malloc (sizeof (struct PrettyPrinterContext));
1017   ppc->asc = asc;
1018   ppc->asc_cls = asc_cls;
1019   ppc->port = port;
1020   GNUNET_RESOLVER_hostname_get (sb, sbs, !numeric, timeout, &append_port, ppc);
1021 }
1022
1023 /**
1024  * Function called for a quick conversion of the binary address to
1025  * a numeric address.  Note that the caller must not free the
1026  * address and that the next call to this function is allowed
1027  * to override the address again.
1028  *
1029  * @param cls closure
1030  * @param addr binary address
1031  * @param addrlen length of the address
1032  * @return string representing the same address
1033  */
1034 static const char *
1035 unix_address_to_string (void *cls, const void *addr, size_t addrlen)
1036 {
1037   if ((addr != NULL) && (addrlen > 0))
1038     return (const char *) addr;
1039   else
1040     return NULL;
1041 }
1042
1043 /**
1044  * Notify transport service about address
1045  *
1046  * @param cls the plugin
1047  * @param tc unused
1048  */
1049 static void
1050 address_notification (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1051 {
1052   struct Plugin *plugin = cls;
1053
1054   plugin->env->notify_address (plugin->env->cls, GNUNET_YES,
1055                                plugin->unix_socket_path,
1056                                strlen (plugin->unix_socket_path) + 1);
1057 }
1058
1059 /**
1060  * The exported method. Makes the core api available via a global and
1061  * returns the unix transport API.
1062  */
1063 void *
1064 libgnunet_plugin_transport_unix_init (void *cls)
1065 {
1066   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1067   unsigned long long port;
1068   struct GNUNET_TRANSPORT_PluginFunctions *api;
1069   struct Plugin *plugin;
1070   int sockets_created;
1071
1072   if (GNUNET_OK !=
1073       GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
1074                                              &port))
1075     port = UNIX_NAT_DEFAULT_PORT;
1076   plugin = GNUNET_malloc (sizeof (struct Plugin));
1077   plugin->port = port;
1078   plugin->env = env;
1079   GNUNET_asprintf (&plugin->unix_socket_path, "/tmp/unix-plugin-sock.%d",
1080                    plugin->port);
1081
1082   api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1083   api->cls = plugin;
1084
1085   api->send = &unix_plugin_send;
1086   api->disconnect = &unix_disconnect;
1087   api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1088   api->address_to_string = &unix_address_to_string;
1089   api->check_address = &unix_check_address;
1090   sockets_created = unix_transport_server_start (plugin);
1091   if (sockets_created == 0)
1092     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to open UNIX sockets\n"));
1093
1094   GNUNET_SCHEDULER_add_now (address_notification, plugin);
1095   return api;
1096 }
1097
1098 void *
1099 libgnunet_plugin_transport_unix_done (void *cls)
1100 {
1101   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1102   struct Plugin *plugin = api->cls;
1103
1104   unix_transport_server_stop (plugin);
1105
1106   GNUNET_NETWORK_fdset_destroy (plugin->rs);
1107   GNUNET_free (plugin->unix_socket_path);
1108   GNUNET_free (plugin);
1109   GNUNET_free (api);
1110   return NULL;
1111 }
1112
1113 /* end of plugin_transport_unix.c */