unix/uxnet.c

   1 /*
   2  * Unix networking abstraction.
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <assert.h>
   8 #include <errno.h>
   9 #include <fcntl.h>
  10 #include <unistd.h>
  11 #include <sys/types.h>
  12 #include <sys/socket.h>
  13 #include <sys/ioctl.h>
  14 #include <arpa/inet.h>
  15 #include <netinet/in.h>
  16 #include <netinet/tcp.h>
  17 #include <netdb.h>
  18 #include <sys/un.h>
  19
  20 #define DEFINE_PLUG_METHOD_MACROS
  21 #include "putty.h"
  22 #include "network.h"
  23 #include "tree234.h"
  24
  25 #ifndef X11_UNIX_PATH
  26 # define X11_UNIX_PATH "/tmp/.X11-unix/X"
  27 #endif
  28
  29 struct Socket_tag {
  30     struct socket_function_table *fn;
  31     /* the above variable absolutely *must* be the first in this structure */
  32     const char *error;
  33     int s;
  34     Plug plug;
  35     void *private_ptr;
  36     bufchain output_data;
  37     int connected;                     /* irrelevant for listening sockets */
  38     int writable;
  39     int frozen; /* this causes readability notifications to be ignored */
  40     int frozen_readable; /* this means we missed at least one readability
  41                           * notification while we were frozen */
  42     int localhost_only;                /* for listening sockets */
  43     char oobdata[1];
  44     int sending_oob;
  45     int oobpending;                    /* is there OOB data available to read? */
  46     int oobinline;
  47     int pending_error;                 /* in case send() returns error */
  48     int listener;
  49     int nodelay, keepalive;            /* for connect()-type sockets */
  50     int privport, port;                /* and again */
  51     SockAddr addr;
  52 };
  53
  54 /*
  55  * We used to typedef struct Socket_tag *Socket.
  56  *
  57  * Since we have made the networking abstraction slightly more
  58  * abstract, Socket no longer means a tcp socket (it could mean
  59  * an ssl socket).  So now we must use Actual_Socket when we know
  60  * we are talking about a tcp socket.
  61  */
  62 typedef struct Socket_tag *Actual_Socket;
  63
  64 struct SockAddr_tag {
  65     const char *error;
  66     /*
  67      * Which address family this address belongs to. AF_INET for
  68      * IPv4; AF_INET6 for IPv6; AF_UNSPEC indicates that name
  69      * resolution has not been done and a simple host name is held
  70      * in this SockAddr structure.
  71      */
  72     int family;
  73 #ifndef NO_IPV6
  74     struct addrinfo *ais;              /* Addresses IPv6 style. */
  75     struct addrinfo *ai;               /* steps along the linked list */
  76 #else
  77     unsigned long *addresses;          /* Addresses IPv4 style. */
  78     int naddresses, curraddr;
  79 #endif
  80     char hostname[512];                /* Store an unresolved host name. */
  81 };
  82
  83 static tree234 *sktree;
  84
  85 static void uxsel_tell(Actual_Socket s);
  86
  87 static int cmpfortree(void *av, void *bv)
  88 {
  89     Actual_Socket a = (Actual_Socket) av, b = (Actual_Socket) bv;
  90     int as = a->s, bs = b->s;
  91     if (as < bs)
  92         return -1;
  93     if (as > bs)
  94         return +1;
  95     return 0;
  96 }
  97
  98 static int cmpforsearch(void *av, void *bv)
  99 {
 100     Actual_Socket b = (Actual_Socket) bv;
 101     int as = *(int *)av, bs = b->s;
 102     if (as < bs)
 103         return -1;
 104     if (as > bs)
 105         return +1;
 106     return 0;
 107 }
 108
 109 void sk_init(void)
 110 {
 111     sktree = newtree234(cmpfortree);
 112 }
 113
 114 void sk_cleanup(void)
 115 {
 116     Actual_Socket s;
 117     int i;
 118
 119     if (sktree) {
 120         for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
 121             close(s->s);
 122         }
 123     }
 124 }
 125
 126 SockAddr sk_namelookup(const char *host, char **canonicalname, int address_family)
 127 {
 128     SockAddr ret = snew(struct SockAddr_tag);
 129 #ifndef NO_IPV6
 130     struct addrinfo hints;
 131     int err;
 132 #else
 133     unsigned long a;
 134     struct hostent *h = NULL;
 135     int n;
 136 #endif
 137     char realhost[8192];
 138
 139     /* Clear the structure and default to IPv4. */
 140     memset(ret, 0, sizeof(struct SockAddr_tag));
 141     ret->family = 0;                   /* We set this one when we have resolved the host. */
 142     *realhost = '\0';
 143     ret->error = NULL;
 144
 145 #ifndef NO_IPV6
 146     hints.ai_flags = AI_CANONNAME;
 147     hints.ai_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
 148                        address_family == ADDRTYPE_IPV6 ? AF_INET6 :
 149                        AF_UNSPEC);
 150     hints.ai_socktype = SOCK_STREAM;
 151     hints.ai_protocol = 0;
 152     hints.ai_addrlen = 0;
 153     hints.ai_addr = NULL;
 154     hints.ai_canonname = NULL;
 155     hints.ai_next = NULL;
 156     err = getaddrinfo(host, NULL, &hints, &ret->ais);
 157     ret->ai = ret->ais;
 158     if (err != 0) {
 159         ret->error = gai_strerror(err);
 160         return ret;
 161     }
 162     ret->family = ret->ai->ai_family;
 163     *realhost = '\0';
 164     if (ret->ai->ai_canonname != NULL)
 165         strncat(realhost, ret->ai->ai_canonname, sizeof(realhost) - 1);
 166     else
 167         strncat(realhost, host, sizeof(realhost) - 1);
 168 #else
 169     if ((a = inet_addr(host)) == (unsigned long)(in_addr_t)(-1)) {
 170         /*
 171          * Otherwise use the IPv4-only gethostbyname... (NOTE:
 172          * we don't use gethostbyname as a fallback!)
 173          */
 174         if (ret->family == 0) {
 175             /*debug(("Resolving \"%s\" with gethostbyname() (IPv4 only)...\n", host)); */
 176             if ( (h = gethostbyname(host)) )
 177                 ret->family = AF_INET;
 178         }
 179         if (ret->family == 0) {
 180             ret->error = (h_errno == HOST_NOT_FOUND ||
 181                           h_errno == NO_DATA ||
 182                           h_errno == NO_ADDRESS ? "Host does not exist" :
 183                           h_errno == TRY_AGAIN ?
 184                           "Temporary name service failure" :
 185                           "gethostbyname: unknown error");
 186             return ret;
 187         }
 188         /* This way we are always sure the h->h_name is valid :) */
 189         strncpy(realhost, h->h_name, sizeof(realhost));
 190         for (n = 0; h->h_addr_list[n]; n++);
 191         ret->addresses = snewn(n, unsigned long);
 192         ret->naddresses = n;
 193         for (n = 0; n < ret->naddresses; n++) {
 194             memcpy(&a, h->h_addr_list[n], sizeof(a));
 195             ret->addresses[n] = ntohl(a);
 196         }
 197     } else {
 198         /*
 199          * This must be a numeric IPv4 address because it caused a
 200          * success return from inet_addr.
 201          */
 202         ret->family = AF_INET;
 203         strncpy(realhost, host, sizeof(realhost));
 204         ret->addresses = snew(unsigned long);
 205         ret->naddresses = 1;
 206         ret->addresses[0] = ntohl(a);
 207         ret->curraddr = 0;
 208     }
 209 #endif
 210     realhost[lenof(realhost)-1] = '\0';
 211     *canonicalname = snewn(1+strlen(realhost), char);
 212     strcpy(*canonicalname, realhost);
 213     return ret;
 214 }
 215
 216 SockAddr sk_nonamelookup(const char *host)
 217 {
 218     SockAddr ret = snew(struct SockAddr_tag);
 219     ret->error = NULL;
 220     ret->family = AF_UNSPEC;
 221     strncpy(ret->hostname, host, lenof(ret->hostname));
 222     ret->hostname[lenof(ret->hostname)-1] = '\0';
 223 #ifndef NO_IPV6
 224     ret->ais = NULL;
 225 #else
 226     ret->addresses = NULL;
 227 #endif
 228     return ret;
 229 }
 230
 231 static int sk_nextaddr(SockAddr addr)
 232 {
 233 #ifndef NO_IPV6
 234     if (addr->ai->ai_next) {
 235         addr->ai = addr->ai->ai_next;
 236         addr->family = addr->ai->ai_family;
 237         return TRUE;
 238     } else
 239         return FALSE;
 240 #else
 241     if (addr->curraddr+1 < addr->naddresses) {
 242         addr->curraddr++;
 243         return TRUE;
 244     } else {
 245         return FALSE;
 246     }
 247 #endif
 248 }
 249
 250 void sk_getaddr(SockAddr addr, char *buf, int buflen)
 251 {
 252
 253     if (addr->family == AF_UNSPEC) {
 254         strncpy(buf, addr->hostname, buflen);
 255         buf[buflen-1] = '\0';
 256     } else {
 257 #ifndef NO_IPV6
 258         if (getnameinfo(addr->ai->ai_addr, addr->ai->ai_addrlen, buf, buflen,
 259                         NULL, 0, NI_NUMERICHOST) != 0) {
 260             buf[0] = '\0';
 261             strncat(buf, "<unknown>", buflen - 1);
 262         }
 263 #else
 264         struct in_addr a;
 265         assert(addr->family == AF_INET);
 266         a.s_addr = htonl(addr->addresses[addr->curraddr]);
 267         strncpy(buf, inet_ntoa(a), buflen);
 268         buf[buflen-1] = '\0';
 269 #endif
 270     }
 271 }
 272
 273 int sk_hostname_is_local(char *name)
 274 {
 275     return !strcmp(name, "localhost");
 276 }
 277
 278 #define ipv4_is_loopback(addr) \
 279     (((addr).s_addr & htonl(0xff000000)) == htonl(0x7f000000))
 280
 281 static int sockaddr_is_loopback(struct sockaddr *sa)
 282 {
 283     struct sockaddr_in *sin;
 284 #ifndef NO_IPV6
 285     struct sockaddr_in6 *sin6;
 286 #endif
 287
 288     switch (sa->sa_family) {
 289       case AF_INET:
 290         sin = (struct sockaddr_in *)sa;
 291         return ipv4_is_loopback(sin->sin_addr);
 292 #ifndef NO_IPV6
 293       case AF_INET6:
 294         sin6 = (struct sockaddr_in6 *)sa;
 295         return IN6_IS_ADDR_LOOPBACK(&sin6->sin6_addr);
 296 #endif
 297       case AF_UNIX:
 298         return TRUE;
 299       default:
 300         return FALSE;
 301     }
 302 }
 303
 304 int sk_address_is_local(SockAddr addr)
 305 {
 306
 307     if (addr->family == AF_UNSPEC)
 308         return 0;                      /* we don't know; assume not */
 309     else {
 310 #ifndef NO_IPV6
 311         return sockaddr_is_loopback(addr->ai->ai_addr);
 312 #else
 313         struct in_addr a;
 314         assert(addr->family == AF_INET);
 315         a.s_addr = htonl(addr->addresses[addr->curraddr]);
 316         return ipv4_is_loopback(a);
 317 #endif
 318     }
 319 }
 320
 321 int sk_addrtype(SockAddr addr)
 322 {
 323     return (addr->family == AF_INET ? ADDRTYPE_IPV4 :
 324 #ifndef NO_IPV6
 325             addr->family == AF_INET6 ? ADDRTYPE_IPV6 :
 326 #endif
 327             ADDRTYPE_NAME);
 328 }
 329
 330 void sk_addrcopy(SockAddr addr, char *buf)
 331 {
 332
 333 #ifndef NO_IPV6
 334     if (addr->family == AF_INET)
 335         memcpy(buf, &((struct sockaddr_in *)addr->ai->ai_addr)->sin_addr,
 336                sizeof(struct in_addr));
 337     else if (addr->family == AF_INET6)
 338         memcpy(buf, &((struct sockaddr_in6 *)addr->ai->ai_addr)->sin6_addr,
 339                sizeof(struct in6_addr));
 340     else
 341         assert(FALSE);
 342 #else
 343     struct in_addr a;
 344
 345     assert(addr->family == AF_INET);
 346     a.s_addr = htonl(addr->addresses[addr->curraddr]);
 347     memcpy(buf, (char*) &a.s_addr, 4);
 348 #endif
 349 }
 350
 351 void sk_addr_free(SockAddr addr)
 352 {
 353
 354 #ifndef NO_IPV6
 355     if (addr->ais != NULL)
 356         freeaddrinfo(addr->ais);
 357 #else
 358     sfree(addr->addresses);
 359 #endif
 360     sfree(addr);
 361 }
 362
 363 static Plug sk_tcp_plug(Socket sock, Plug p)
 364 {
 365     Actual_Socket s = (Actual_Socket) sock;
 366     Plug ret = s->plug;
 367     if (p)
 368         s->plug = p;
 369     return ret;
 370 }
 371
 372 static void sk_tcp_flush(Socket s)
 373 {
 374     /*
 375      * We send data to the socket as soon as we can anyway,
 376      * so we don't need to do anything here.  :-)
 377      */
 378 }
 379
 380 static void sk_tcp_close(Socket s);
 381 static int sk_tcp_write(Socket s, const char *data, int len);
 382 static int sk_tcp_write_oob(Socket s, const char *data, int len);
 383 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
 384 static void *sk_tcp_get_private_ptr(Socket s);
 385 static void sk_tcp_set_frozen(Socket s, int is_frozen);
 386 static const char *sk_tcp_socket_error(Socket s);
 387
 388 static struct socket_function_table tcp_fn_table = {
 389     sk_tcp_plug,
 390     sk_tcp_close,
 391     sk_tcp_write,
 392     sk_tcp_write_oob,
 393     sk_tcp_flush,
 394     sk_tcp_set_private_ptr,
 395     sk_tcp_get_private_ptr,
 396     sk_tcp_set_frozen,
 397     sk_tcp_socket_error
 398 };
 399
 400 Socket sk_register(OSSocket sockfd, Plug plug)
 401 {
 402     Actual_Socket ret;
 403
 404     /*
 405      * Create Socket structure.
 406      */
 407     ret = snew(struct Socket_tag);
 408     ret->fn = &tcp_fn_table;
 409     ret->error = NULL;
 410     ret->plug = plug;
 411     bufchain_init(&ret->output_data);
 412     ret->writable = 1;                 /* to start with */
 413     ret->sending_oob = 0;
 414     ret->frozen = 1;
 415     ret->frozen_readable = 0;
 416     ret->localhost_only = 0;           /* unused, but best init anyway */
 417     ret->pending_error = 0;
 418     ret->oobpending = FALSE;
 419     ret->listener = 0;
 420     ret->addr = NULL;
 421     ret->connected = 1;
 422
 423     ret->s = sockfd;
 424
 425     if (ret->s < 0) {
 426         ret->error = strerror(errno);
 427         return (Socket) ret;
 428     }
 429
 430     ret->oobinline = 0;
 431
 432     uxsel_tell(ret);
 433     add234(sktree, ret);
 434
 435     return (Socket) ret;
 436 }
 437
 438 static int try_connect(Actual_Socket sock)
 439 {
 440     int s;
 441 #ifndef NO_IPV6
 442     struct sockaddr_in6 a6;
 443 #endif
 444     struct sockaddr_in a;
 445     struct sockaddr_un au;
 446     const struct sockaddr *sa;
 447     int err = 0;
 448     short localport;
 449     int fl, salen;
 450
 451     if (sock->s >= 0)
 452         close(sock->s);
 453
 454     plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
 455
 456     /*
 457      * Open socket.
 458      */
 459     assert(sock->addr->family != AF_UNSPEC);
 460     s = socket(sock->addr->family, SOCK_STREAM, 0);
 461     sock->s = s;
 462
 463     if (s < 0) {
 464         err = errno;
 465         goto ret;
 466     }
 467
 468     if (sock->oobinline) {
 469         int b = TRUE;
 470         setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
 471     }
 472
 473     if (sock->nodelay) {
 474         int b = TRUE;
 475         setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
 476     }
 477
 478     if (sock->keepalive) {
 479         int b = TRUE;
 480         setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
 481     }
 482
 483     /*
 484      * Bind to local address.
 485      */
 486     if (sock->privport)
 487         localport = 1023;              /* count from 1023 downwards */
 488     else
 489         localport = 0;                 /* just use port 0 (ie kernel picks) */
 490
 491     /* BSD IP stacks need sockaddr_in zeroed before filling in */
 492     memset(&a,'\0',sizeof(struct sockaddr_in));
 493 #ifndef NO_IPV6
 494     memset(&a6,'\0',sizeof(struct sockaddr_in6));
 495 #endif
 496
 497     /* We don't try to bind to a local address for UNIX domain sockets.  (Why
 498      * do we bother doing the bind when localport == 0 anyway?) */
 499     if(sock->addr->family != AF_UNIX) {
 500         /* Loop round trying to bind */
 501         while (1) {
 502             int retcode;
 503
 504 #ifndef NO_IPV6
 505             if (sock->addr->family == AF_INET6) {
 506                 /* XXX use getaddrinfo to get a local address? */
 507                 a6.sin6_family = AF_INET6;
 508                 a6.sin6_addr = in6addr_any;
 509                 a6.sin6_port = htons(localport);
 510                 retcode = bind(s, (struct sockaddr *) &a6, sizeof(a6));
 511             } else
 512 #endif
 513             {
 514                 assert(sock->addr->family == AF_INET);
 515                 a.sin_family = AF_INET;
 516                 a.sin_addr.s_addr = htonl(INADDR_ANY);
 517                 a.sin_port = htons(localport);
 518                 retcode = bind(s, (struct sockaddr *) &a, sizeof(a));
 519             }
 520             if (retcode >= 0) {
 521                 err = 0;
 522                 break;                 /* done */
 523             } else {
 524                 err = errno;
 525                 if (err != EADDRINUSE) /* failed, for a bad reason */
 526                   break;
 527             }
 528
 529             if (localport == 0)
 530               break;                   /* we're only looping once */
 531             localport--;
 532             if (localport == 0)
 533               break;                   /* we might have got to the end */
 534         }
 535
 536         if (err)
 537             goto ret;
 538     }
 539
 540     /*
 541      * Connect to remote address.
 542      */
 543     switch(sock->addr->family) {
 544 #ifndef NO_IPV6
 545       case AF_INET:
 546         /* XXX would be better to have got getaddrinfo() to fill in the port. */
 547         ((struct sockaddr_in *)sock->addr->ai->ai_addr)->sin_port =
 548             htons(sock->port);
 549         sa = (const struct sockaddr *)sock->addr->ai->ai_addr;
 550         salen = sock->addr->ai->ai_addrlen;
 551         break;
 552       case AF_INET6:
 553         ((struct sockaddr_in *)sock->addr->ai->ai_addr)->sin_port =
 554             htons(sock->port);
 555         sa = (const struct sockaddr *)sock->addr->ai->ai_addr;
 556         salen = sock->addr->ai->ai_addrlen;
 557         break;
 558 #else
 559       case AF_INET:
 560         a.sin_family = AF_INET;
 561         a.sin_addr.s_addr = htonl(sock->addr->addresses[sock->addr->curraddr]);
 562         a.sin_port = htons((short) sock->port);
 563         sa = (const struct sockaddr *)&a;
 564         salen = sizeof a;
 565         break;
 566 #endif
 567       case AF_UNIX:
 568         assert(sock->port == 0);       /* to catch confused people */
 569         assert(strlen(sock->addr->hostname) < sizeof au.sun_path);
 570         memset(&au, 0, sizeof au);
 571         au.sun_family = AF_UNIX;
 572         strcpy(au.sun_path, sock->addr->hostname);
 573         sa = (const struct sockaddr *)&au;
 574         salen = sizeof au;
 575         break;
 576
 577       default:
 578         assert(0 && "unknown address family");
 579     }
 580
 581     fl = fcntl(s, F_GETFL);
 582     if (fl != -1)
 583         fcntl(s, F_SETFL, fl | O_NONBLOCK);
 584
 585     if ((connect(s, sa, salen)) < 0) {
 586         if ( errno != EINPROGRESS ) {
 587             err = errno;
 588             goto ret;
 589         }
 590     } else {
 591         /*
 592          * If we _don't_ get EWOULDBLOCK, the connect has completed
 593          * and we should set the socket as connected and writable.
 594          */
 595         sock->connected = 1;
 596         sock->writable = 1;
 597     }
 598
 599     uxsel_tell(sock);
 600     add234(sktree, sock);
 601
 602     ret:
 603     if (err)
 604         plug_log(sock->plug, 1, sock->addr, sock->port, strerror(err), err);
 605     return err;
 606 }
 607
 608 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
 609               int nodelay, int keepalive, Plug plug)
 610 {
 611     Actual_Socket ret;
 612     int err;
 613
 614     /*
 615      * Create Socket structure.
 616      */
 617     ret = snew(struct Socket_tag);
 618     ret->fn = &tcp_fn_table;
 619     ret->error = NULL;
 620     ret->plug = plug;
 621     bufchain_init(&ret->output_data);
 622     ret->connected = 0;                /* to start with */
 623     ret->writable = 0;                 /* to start with */
 624     ret->sending_oob = 0;
 625     ret->frozen = 0;
 626     ret->frozen_readable = 0;
 627     ret->localhost_only = 0;           /* unused, but best init anyway */
 628     ret->pending_error = 0;
 629     ret->oobpending = FALSE;
 630     ret->listener = 0;
 631     ret->addr = addr;
 632     ret->s = -1;
 633     ret->oobinline = oobinline;
 634     ret->nodelay = nodelay;
 635     ret->keepalive = keepalive;
 636     ret->privport = privport;
 637     ret->port = port;
 638
 639     err = 0;
 640     do {
 641         err = try_connect(ret);
 642     } while (err && sk_nextaddr(ret->addr));
 643
 644     if (err)
 645         ret->error = strerror(err);
 646
 647     return (Socket) ret;
 648 }
 649
 650 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only, int address_family)
 651 {
 652     int s;
 653 #ifndef NO_IPV6
 654     struct addrinfo hints, *ai;
 655     char portstr[6];
 656     struct sockaddr_in6 a6;
 657 #endif
 658     struct sockaddr *addr;
 659     int addrlen;
 660     struct sockaddr_in a;
 661     Actual_Socket ret;
 662     int retcode;
 663     int on = 1;
 664
 665     /*
 666      * Create Socket structure.
 667      */
 668     ret = snew(struct Socket_tag);
 669     ret->fn = &tcp_fn_table;
 670     ret->error = NULL;
 671     ret->plug = plug;
 672     bufchain_init(&ret->output_data);
 673     ret->writable = 0;                 /* to start with */
 674     ret->sending_oob = 0;
 675     ret->frozen = 0;
 676     ret->frozen_readable = 0;
 677     ret->localhost_only = local_host_only;
 678     ret->pending_error = 0;
 679     ret->oobpending = FALSE;
 680     ret->listener = 1;
 681     ret->addr = NULL;
 682
 683     /*
 684      * Translate address_family from platform-independent constants
 685      * into local reality.
 686      */
 687     address_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
 688                       address_family == ADDRTYPE_IPV6 ? AF_INET6 : AF_UNSPEC);
 689
 690 #ifndef NO_IPV6
 691     /* Let's default to IPv6.
 692      * If the stack doesn't support IPv6, we will fall back to IPv4. */
 693     if (address_family == AF_UNSPEC) address_family = AF_INET6;
 694 #else
 695     /* No other choice, default to IPv4 */
 696     if (address_family == AF_UNSPEC)  address_family = AF_INET;
 697 #endif
 698
 699     /*
 700      * Open socket.
 701      */
 702     s = socket(address_family, SOCK_STREAM, 0);
 703
 704     /* If the host doesn't support IPv6 try fallback to IPv4. */
 705     if (s < 0 && address_family == AF_INET6) {
 706         address_family = AF_INET;
 707         s = socket(address_family, SOCK_STREAM, 0);
 708     }
 709
 710     if (s < 0) {
 711         ret->error = strerror(errno);
 712         return (Socket) ret;
 713     }
 714
 715     ret->oobinline = 0;
 716
 717     setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
 718
 719     retcode = -1;
 720     addr = NULL; addrlen = -1;         /* placate optimiser */
 721
 722     if (srcaddr != NULL) {
 723 #ifndef NO_IPV6
 724         hints.ai_flags = AI_NUMERICHOST;
 725         hints.ai_family = address_family;
 726         hints.ai_socktype = SOCK_STREAM;
 727         hints.ai_protocol = 0;
 728         hints.ai_addrlen = 0;
 729         hints.ai_addr = NULL;
 730         hints.ai_canonname = NULL;
 731         hints.ai_next = NULL;
 732         assert(port >= 0 && port <= 99999);
 733         sprintf(portstr, "%d", port);
 734         retcode = getaddrinfo(srcaddr, portstr, &hints, &ai);
 735         if (retcode == 0) {
 736             addr = ai->ai_addr;
 737             addrlen = ai->ai_addrlen;
 738         }
 739 #else
 740         memset(&a,'\0',sizeof(struct sockaddr_in));
 741         a.sin_family = AF_INET;
 742         a.sin_port = htons(port);
 743         a.sin_addr.s_addr = inet_addr(srcaddr);
 744         if (a.sin_addr.s_addr != (in_addr_t)(-1)) {
 745             /* Override localhost_only with specified listen addr. */
 746             ret->localhost_only = ipv4_is_loopback(a.sin_addr);
 747         }
 748         addr = (struct sockaddr *)&a;
 749         addrlen = sizeof(a);
 750         retcode = 0;
 751 #endif
 752     }
 753
 754     if (retcode != 0) {
 755 #ifndef NO_IPV6
 756         if (address_family == AF_INET6) {
 757             memset(&a6,'\0',sizeof(struct sockaddr_in6));
 758             a6.sin6_family = AF_INET6;
 759             a6.sin6_port = htons(port);
 760             if (local_host_only)
 761                 a6.sin6_addr = in6addr_loopback;
 762             else
 763                 a6.sin6_addr = in6addr_any;
 764             addr = (struct sockaddr *)&a6;
 765             addrlen = sizeof(a6);
 766         } else
 767 #endif
 768         {
 769             memset(&a,'\0',sizeof(struct sockaddr_in));
 770             a.sin_family = AF_INET;
 771             a.sin_port = htons(port);
 772             if (local_host_only)
 773                 a.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
 774             else
 775                 a.sin_addr.s_addr = htonl(INADDR_ANY);
 776             addr = (struct sockaddr *)&a;
 777             addrlen = sizeof(a);
 778         }
 779     }
 780
 781     retcode = bind(s, addr, addrlen);
 782     if (retcode < 0) {
 783         close(s);
 784         ret->error = strerror(errno);
 785         return (Socket) ret;
 786     }
 787
 788     if (listen(s, SOMAXCONN) < 0) {
 789         close(s);
 790         ret->error = strerror(errno);
 791         return (Socket) ret;
 792     }
 793
 794     ret->s = s;
 795
 796     uxsel_tell(ret);
 797     add234(sktree, ret);
 798
 799     return (Socket) ret;
 800 }
 801
 802 static void sk_tcp_close(Socket sock)
 803 {
 804     Actual_Socket s = (Actual_Socket) sock;
 805
 806     uxsel_del(s->s);
 807     del234(sktree, s);
 808     close(s->s);
 809     if (s->addr)
 810         sk_addr_free(s->addr);
 811     sfree(s);
 812 }
 813
 814 #define PUT_32BIT_MSB_FIRST(cp, value) ( \
 815   (cp)[0] = (char)((value) >> 24), \
 816   (cp)[1] = (char)((value) >> 16), \
 817   (cp)[2] = (char)((value) >> 8), \
 818   (cp)[3] = (char)(value) )
 819
 820 #define PUT_16BIT_MSB_FIRST(cp, value) ( \
 821   (cp)[0] = (char)((value) >> 8), \
 822   (cp)[1] = (char)(value) )
 823
 824 void *sk_getxdmdata(void *sock, int *lenp)
 825 {
 826     Actual_Socket s = (Actual_Socket) sock;
 827 #ifdef NO_IPV6
 828     struct sockaddr_in addr;
 829 #else
 830     struct sockaddr_storage addr;
 831     struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)&addr;
 832 #endif
 833     struct sockaddr *sa = (struct sockaddr *)&addr;
 834     struct sockaddr_in *sin = (struct sockaddr_in *)&addr;
 835     socklen_t addrlen;
 836     char *buf;
 837     static unsigned int unix_addr = 0xFFFFFFFF;
 838
 839     /*
 840      * We must check that this socket really _is_ an Actual_Socket.
 841      */
 842     if (s->fn != &tcp_fn_table)
 843         return NULL;                   /* failure */
 844
 845     addrlen = sizeof(addr);
 846     if (getsockname(s->s, sa, &addrlen) < 0)
 847         return NULL;
 848     switch(sa->sa_family) {
 849       case AF_INET:
 850         *lenp = 6;
 851         buf = snewn(*lenp, char);
 852         PUT_32BIT_MSB_FIRST(buf, ntohl(sin->sin_addr.s_addr));
 853         PUT_16BIT_MSB_FIRST(buf+4, ntohs(sin->sin_port));
 854         break;
 855 #ifndef NO_IPV6
 856     case AF_INET6:
 857         *lenp = 6;
 858         buf = snewn(*lenp, char);
 859         if (IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr)) {
 860             memcpy(buf, sin6->sin6_addr.s6_addr + 12, 4);
 861             PUT_16BIT_MSB_FIRST(buf+4, ntohs(sin6->sin6_port));
 862         } else
 863             /* This is stupid, but it's what XLib does. */
 864             memset(buf, 0, 6);
 865         break;
 866 #endif
 867       case AF_UNIX:
 868         *lenp = 6;
 869         buf = snewn(*lenp, char);
 870         PUT_32BIT_MSB_FIRST(buf, unix_addr--);
 871         PUT_16BIT_MSB_FIRST(buf+4, getpid());
 872         break;
 873
 874         /* XXX IPV6 */
 875
 876       default:
 877         return NULL;
 878     }
 879
 880     return buf;
 881 }
 882
 883 /*
 884  * The function which tries to send on a socket once it's deemed
 885  * writable.
 886  */
 887 void try_send(Actual_Socket s)
 888 {
 889     while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
 890         int nsent;
 891         int err;
 892         void *data;
 893         int len, urgentflag;
 894
 895         if (s->sending_oob) {
 896             urgentflag = MSG_OOB;
 897             len = s->sending_oob;
 898             data = &s->oobdata;
 899         } else {
 900             urgentflag = 0;
 901             bufchain_prefix(&s->output_data, &data, &len);
 902         }
 903         nsent = send(s->s, data, len, urgentflag);
 904         noise_ultralight(nsent);
 905         if (nsent <= 0) {
 906             err = (nsent < 0 ? errno : 0);
 907             if (err == EWOULDBLOCK) {
 908                 /*
 909                  * Perfectly normal: we've sent all we can for the moment.
 910                  */
 911                 s->writable = FALSE;
 912                 return;
 913             } else {
 914                 /*
 915                  * We unfortunately can't just call plug_closing(),
 916                  * because it's quite likely that we're currently
 917                  * _in_ a call from the code we'd be calling back
 918                  * to, so we'd have to make half the SSH code
 919                  * reentrant. Instead we flag a pending error on
 920                  * the socket, to be dealt with (by calling
 921                  * plug_closing()) at some suitable future moment.
 922                  */
 923                 s->pending_error = err;
 924                 return;
 925             }
 926         } else {
 927             if (s->sending_oob) {
 928                 if (nsent < len) {
 929                     memmove(s->oobdata, s->oobdata+nsent, len-nsent);
 930                     s->sending_oob = len - nsent;
 931                 } else {
 932                     s->sending_oob = 0;
 933                 }
 934             } else {
 935                 bufchain_consume(&s->output_data, nsent);
 936             }
 937         }
 938     }
 939     uxsel_tell(s);
 940 }
 941
 942 static int sk_tcp_write(Socket sock, const char *buf, int len)
 943 {
 944     Actual_Socket s = (Actual_Socket) sock;
 945
 946     /*
 947      * Add the data to the buffer list on the socket.
 948      */
 949     bufchain_add(&s->output_data, buf, len);
 950
 951     /*
 952      * Now try sending from the start of the buffer list.
 953      */
 954     if (s->writable)
 955         try_send(s);
 956
 957     /*
 958      * Update the select() status to correctly reflect whether or
 959      * not we should be selecting for write.
 960      */
 961     uxsel_tell(s);
 962
 963     return bufchain_size(&s->output_data);
 964 }
 965
 966 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
 967 {
 968     Actual_Socket s = (Actual_Socket) sock;
 969
 970     /*
 971      * Replace the buffer list on the socket with the data.
 972      */
 973     bufchain_clear(&s->output_data);
 974     assert(len <= sizeof(s->oobdata));
 975     memcpy(s->oobdata, buf, len);
 976     s->sending_oob = len;
 977
 978     /*
 979      * Now try sending from the start of the buffer list.
 980      */
 981     if (s->writable)
 982         try_send(s);
 983
 984     /*
 985      * Update the select() status to correctly reflect whether or
 986      * not we should be selecting for write.
 987      */
 988     uxsel_tell(s);
 989
 990     return s->sending_oob;
 991 }
 992
 993 static int net_select_result(int fd, int event)
 994 {
 995     int ret;
 996     char buf[20480];                   /* nice big buffer for plenty of speed */
 997     Actual_Socket s;
 998     u_long atmark;
 999
1000     /* Find the Socket structure */
1001     s = find234(sktree, &fd, cmpforsearch);
1002     if (!s)
1003         return 1;                      /* boggle */
1004
1005     noise_ultralight(event);
1006
1007     switch (event) {
1008       case 4:                          /* exceptional */
1009         if (!s->oobinline) {
1010             /*
1011              * On a non-oobinline socket, this indicates that we
1012              * can immediately perform an OOB read and get back OOB
1013              * data, which we will send to the back end with
1014              * type==2 (urgent data).
1015              */
1016             ret = recv(s->s, buf, sizeof(buf), MSG_OOB);
1017             noise_ultralight(ret);
1018             if (ret <= 0) {
1019                 return plug_closing(s->plug,
1020                                     ret == 0 ? "Internal networking trouble" :
1021                                     strerror(errno), errno, 0);
1022             } else {
1023                 /*
1024                  * Receiving actual data on a socket means we can
1025                  * stop falling back through the candidate
1026                  * addresses to connect to.
1027                  */
1028                 if (s->addr) {
1029                     sk_addr_free(s->addr);
1030                     s->addr = NULL;
1031                 }
1032                 return plug_receive(s->plug, 2, buf, ret);
1033             }
1034             break;
1035         }
1036
1037         /*
1038          * If we reach here, this is an oobinline socket, which
1039          * means we should set s->oobpending and then deal with it
1040          * when we get called for the readability event (which
1041          * should also occur).
1042          */
1043         s->oobpending = TRUE;
1044         break;
1045       case 1:                          /* readable; also acceptance */
1046         if (s->listener) {
1047             /*
1048              * On a listening socket, the readability event means a
1049              * connection is ready to be accepted.
1050              */
1051 #ifdef NO_IPV6
1052             struct sockaddr_in ss;
1053 #else
1054             struct sockaddr_storage ss;
1055 #endif
1056             socklen_t addrlen = sizeof(ss);
1057             int t;  /* socket of connection */
1058
1059             memset(&ss, 0, addrlen);
1060             t = accept(s->s, (struct sockaddr *)&ss, &addrlen);
1061             if (t < 0) {
1062                 break;
1063             }
1064
1065             if (s->localhost_only &&
1066                 !sockaddr_is_loopback((struct sockaddr *)&ss)) {
1067                 close(t);              /* someone let nonlocal through?! */
1068             } else if (plug_accepting(s->plug, t)) {
1069                 close(t);              /* denied or error */
1070             }
1071             break;
1072         }
1073
1074         /*
1075          * If we reach here, this is not a listening socket, so
1076          * readability really means readability.
1077          */
1078
1079         /* In the case the socket is still frozen, we don't even bother */
1080         if (s->frozen) {
1081             s->frozen_readable = 1;
1082             break;
1083         }
1084
1085         /*
1086          * We have received data on the socket. For an oobinline
1087          * socket, this might be data _before_ an urgent pointer,
1088          * in which case we send it to the back end with type==1
1089          * (data prior to urgent).
1090          */
1091         if (s->oobinline && s->oobpending) {
1092             atmark = 1;
1093             if (ioctl(s->s, SIOCATMARK, &atmark) == 0 && atmark)
1094                 s->oobpending = FALSE; /* clear this indicator */
1095         } else
1096             atmark = 1;
1097
1098         ret = recv(s->s, buf, s->oobpending ? 1 : sizeof(buf), 0);
1099         noise_ultralight(ret);
1100         if (ret < 0) {
1101             if (errno == EWOULDBLOCK) {
1102                 break;
1103             }
1104         }
1105         if (ret < 0) {
1106             /*
1107              * An error at this point _might_ be an error reported
1108              * by a non-blocking connect(). So before we return a
1109              * panic status to the user, let's just see whether
1110              * that's the case.
1111              */
1112             int err = errno;
1113             if (s->addr) {
1114                 plug_log(s->plug, 1, s->addr, s->port, strerror(err), err);
1115                 while (s->addr && sk_nextaddr(s->addr)) {
1116                     err = try_connect(s);
1117                 }
1118             }
1119             if (err != 0)
1120                 return plug_closing(s->plug, strerror(err), err, 0);
1121         } else if (0 == ret) {
1122             return plug_closing(s->plug, NULL, 0, 0);
1123         } else {
1124             /*
1125              * Receiving actual data on a socket means we can
1126              * stop falling back through the candidate
1127              * addresses to connect to.
1128              */
1129             if (s->addr) {
1130                 sk_addr_free(s->addr);
1131                 s->addr = NULL;
1132             }
1133             return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1134         }
1135         break;
1136       case 2:                          /* writable */
1137         if (!s->connected) {
1138             /*
1139              * select() reports a socket as _writable_ when an
1140              * asynchronous connection is completed.
1141              */
1142             s->connected = s->writable = 1;
1143             uxsel_tell(s);
1144             break;
1145         } else {
1146             int bufsize_before, bufsize_after;
1147             s->writable = 1;
1148             bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1149             try_send(s);
1150             bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1151             if (bufsize_after < bufsize_before)
1152                 plug_sent(s->plug, bufsize_after);
1153         }
1154         break;
1155     }
1156
1157     return 1;
1158 }
1159
1160 /*
1161  * Deal with socket errors detected in try_send().
1162  */
1163 void net_pending_errors(void)
1164 {
1165     int i;
1166     Actual_Socket s;
1167
1168     /*
1169      * This might be a fiddly business, because it's just possible
1170      * that handling a pending error on one socket might cause
1171      * others to be closed. (I can't think of any reason this might
1172      * happen in current SSH implementation, but to maintain
1173      * generality of this network layer I'll assume the worst.)
1174      *
1175      * So what we'll do is search the socket list for _one_ socket
1176      * with a pending error, and then handle it, and then search
1177      * the list again _from the beginning_. Repeat until we make a
1178      * pass with no socket errors present. That way we are
1179      * protected against the socket list changing under our feet.
1180      */
1181
1182     do {
1183         for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1184             if (s->pending_error) {
1185                 /*
1186                  * An error has occurred on this socket. Pass it to the
1187                  * plug.
1188                  */
1189                 plug_closing(s->plug, strerror(s->pending_error),
1190                              s->pending_error, 0);
1191                 break;
1192             }
1193         }
1194     } while (s);
1195 }
1196
1197 /*
1198  * Each socket abstraction contains a `void *' private field in
1199  * which the client can keep state.
1200  */
1201 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1202 {
1203     Actual_Socket s = (Actual_Socket) sock;
1204     s->private_ptr = ptr;
1205 }
1206
1207 static void *sk_tcp_get_private_ptr(Socket sock)
1208 {
1209     Actual_Socket s = (Actual_Socket) sock;
1210     return s->private_ptr;
1211 }
1212
1213 /*
1214  * Special error values are returned from sk_namelookup and sk_new
1215  * if there's a problem. These functions extract an error message,
1216  * or return NULL if there's no problem.
1217  */
1218 const char *sk_addr_error(SockAddr addr)
1219 {
1220     return addr->error;
1221 }
1222 static const char *sk_tcp_socket_error(Socket sock)
1223 {
1224     Actual_Socket s = (Actual_Socket) sock;
1225     return s->error;
1226 }
1227
1228 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1229 {
1230     Actual_Socket s = (Actual_Socket) sock;
1231     if (s->frozen == is_frozen)
1232         return;
1233     s->frozen = is_frozen;
1234     if (!is_frozen && s->frozen_readable) {
1235         char c;
1236         recv(s->s, &c, 1, MSG_PEEK);
1237     }
1238     s->frozen_readable = 0;
1239     uxsel_tell(s);
1240 }
1241
1242 static void uxsel_tell(Actual_Socket s)
1243 {
1244     int rwx = 0;
1245     if (s->listener) {
1246         rwx |= 1;                       /* read == accept */
1247     } else {
1248         if (!s->connected)
1249             rwx |= 2;                   /* write == connect */
1250         if (s->connected && !s->frozen)
1251             rwx |= 1 | 4;               /* read, except */
1252         if (bufchain_size(&s->output_data))
1253             rwx |= 2;                   /* write */
1254     }
1255     uxsel_set(s->s, rwx, net_select_result);
1256 }
1257
1258 int net_service_lookup(char *service)
1259 {
1260     struct servent *se;
1261     se = getservbyname(service, NULL);
1262     if (se != NULL)
1263         return ntohs(se->s_port);
1264     else
1265         return 0;
1266 }
1267
1268 SockAddr platform_get_x11_unix_address(int displaynum, char **canonicalname)
1269 {
1270     SockAddr ret = snew(struct SockAddr_tag);
1271     int n;
1272
1273     memset(ret, 0, sizeof *ret);
1274     ret->family = AF_UNIX;
1275     n = snprintf(ret->hostname, sizeof ret->hostname,
1276                  "%s%d", X11_UNIX_PATH, displaynum);
1277     if(n < 0)
1278         ret->error = "snprintf failed";
1279     else if(n >= sizeof ret->hostname)
1280         ret->error = "X11 UNIX name too long";
1281     else
1282         *canonicalname = dupstr(ret->hostname);
1283 #ifndef NO_IPV6
1284     ret->ais = NULL;
1285 #else
1286     ret->addresses = NULL;
1287 #endif
1288     return ret;
1289 }