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
  19 #define DEFINE_PLUG_METHOD_MACROS
  20 #include "putty.h"
  21 #include "network.h"
  22 #include "tree234.h"
  23
  24 #define ipv4_is_loopback(addr) (inet_netof(addr) == IN_LOOPBACKNET)
  25
  26 struct Socket_tag {
  27     struct socket_function_table *fn;
  28     /* the above variable absolutely *must* be the first in this structure */
  29     char *error;
  30     int s;
  31     Plug plug;
  32     void *private_ptr;
  33     bufchain output_data;
  34     int connected;
  35     int writable;
  36     int frozen; /* this causes readability notifications to be ignored */
  37     int frozen_readable; /* this means we missed at least one readability
  38                           * notification while we were frozen */
  39     int localhost_only;                /* for listening sockets */
  40     char oobdata[1];
  41     int sending_oob;
  42     int oobpending;                    /* is there OOB data available to read? */
  43     int oobinline;
  44     int pending_error;                 /* in case send() returns error */
  45     int listener;
  46 };
  47
  48 /*
  49  * We used to typedef struct Socket_tag *Socket.
  50  *
  51  * Since we have made the networking abstraction slightly more
  52  * abstract, Socket no longer means a tcp socket (it could mean
  53  * an ssl socket).  So now we must use Actual_Socket when we know
  54  * we are talking about a tcp socket.
  55  */
  56 typedef struct Socket_tag *Actual_Socket;
  57
  58 struct SockAddr_tag {
  59     char *error;
  60     /*
  61      * Which address family this address belongs to. AF_INET for
  62      * IPv4; AF_INET6 for IPv6; AF_UNSPEC indicates that name
  63      * resolution has not been done and a simple host name is held
  64      * in this SockAddr structure.
  65      */
  66     int family;
  67     unsigned long address;             /* Address IPv4 style. */
  68 #ifdef IPV6
  69     struct addrinfo *ai;               /* Address IPv6 style. */
  70 #endif
  71     char hostname[512];                /* Store an unresolved host name. */
  72 };
  73
  74 static tree234 *sktree;
  75
  76 static int cmpfortree(void *av, void *bv)
  77 {
  78     Actual_Socket a = (Actual_Socket) av, b = (Actual_Socket) bv;
  79     int as = a->s, bs = b->s;
  80     if (as < bs)
  81         return -1;
  82     if (as > bs)
  83         return +1;
  84     return 0;
  85 }
  86
  87 static int cmpforsearch(void *av, void *bv)
  88 {
  89     Actual_Socket b = (Actual_Socket) bv;
  90     int as = (int) av, bs = b->s;
  91     if (as < bs)
  92         return -1;
  93     if (as > bs)
  94         return +1;
  95     return 0;
  96 }
  97
  98 void sk_init(void)
  99 {
 100     sktree = newtree234(cmpfortree);
 101 }
 102
 103 void sk_cleanup(void)
 104 {
 105     Actual_Socket s;
 106     int i;
 107
 108     if (sktree) {
 109         for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
 110             close(s->s);
 111         }
 112     }
 113 }
 114
 115 char *error_string(int error)
 116 {
 117     return strerror(error);
 118 }
 119
 120 SockAddr sk_namelookup(char *host, char **canonicalname)
 121 {
 122     SockAddr ret = smalloc(sizeof(struct SockAddr_tag));
 123     unsigned long a;
 124     struct hostent *h = NULL;
 125     char realhost[8192];
 126
 127     /* Clear the structure and default to IPv4. */
 128     memset(ret, 0, sizeof(struct SockAddr_tag));
 129     ret->family = 0;                   /* We set this one when we have resolved the host. */
 130     *realhost = '\0';
 131     ret->error = NULL;
 132
 133     if ((a = inet_addr(host)) == (unsigned long) INADDR_NONE) {
 134 #ifdef IPV6
 135         if (getaddrinfo(host, NULL, NULL, &ret->ai) == 0) {
 136             ret->family = ret->ai->ai_family;
 137         } else
 138 #endif
 139         {
 140             /*
 141              * Otherwise use the IPv4-only gethostbyname... (NOTE:
 142              * we don't use gethostbyname as a fallback!)
 143              */
 144             if (ret->family == 0) {
 145                 /*debug(("Resolving \"%s\" with gethostbyname() (IPv4 only)...\n", host)); */
 146                 if ( (h = gethostbyname(host)) )
 147                     ret->family = AF_INET;
 148             }
 149             if (ret->family == 0) {
 150                 ret->error = (h_errno == HOST_NOT_FOUND ||
 151                               h_errno == NO_DATA ||
 152                               h_errno == NO_ADDRESS ? "Host does not exist" :
 153                               h_errno == TRY_AGAIN ?
 154                               "Temporary name service failure" :
 155                               "gethostbyname: unknown error");
 156                 return ret;
 157             }
 158         }
 159
 160 #ifdef IPV6
 161         /* If we got an address info use that... */
 162         if (ret->ai) {
 163
 164             /* Are we in IPv4 fallback mode? */
 165             /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
 166             if (ret->family == AF_INET)
 167                 memcpy(&a,
 168                        (char *) &((struct sockaddr_in *) ret->ai->
 169                                   ai_addr)->sin_addr, sizeof(a));
 170
 171             /* Now let's find that canonicalname... */
 172             if (getnameinfo((struct sockaddr *) ret->ai->ai_addr,
 173                             ret->family ==
 174                             AF_INET ? sizeof(struct sockaddr_in) :
 175                             sizeof(struct sockaddr_in6), realhost,
 176                             sizeof(realhost), NULL, 0, 0) != 0) {
 177                 strncpy(realhost, host, sizeof(realhost));
 178             }
 179         }
 180         /* We used the IPv4-only gethostbyname()... */
 181         else
 182 #endif
 183         {
 184             memcpy(&a, h->h_addr, sizeof(a));
 185             /* This way we are always sure the h->h_name is valid :) */
 186             strncpy(realhost, h->h_name, sizeof(realhost));
 187         }
 188     } else {
 189         /*
 190          * This must be a numeric IPv4 address because it caused a
 191          * success return from inet_addr.
 192          */
 193         ret->family = AF_INET;
 194         strncpy(realhost, host, sizeof(realhost));
 195     }
 196     ret->address = ntohl(a);
 197     realhost[lenof(realhost)-1] = '\0';
 198     *canonicalname = smalloc(1+strlen(realhost));
 199     strcpy(*canonicalname, realhost);
 200     return ret;
 201 }
 202
 203 SockAddr sk_nonamelookup(char *host)
 204 {
 205     SockAddr ret = smalloc(sizeof(struct SockAddr_tag));
 206     ret->error = NULL;
 207     ret->family = AF_UNSPEC;
 208     strncpy(ret->hostname, host, lenof(ret->hostname));
 209     ret->hostname[lenof(ret->hostname)-1] = '\0';
 210     return ret;
 211 }
 212
 213 void sk_getaddr(SockAddr addr, char *buf, int buflen)
 214 {
 215 #ifdef IPV6
 216     if (addr->family == AF_INET6) {
 217         FIXME; /* I don't know how to get a text form of an IPv6 address. */
 218     } else
 219 #endif
 220     if (addr->family == AF_INET) {
 221         struct in_addr a;
 222         a.s_addr = htonl(addr->address);
 223         strncpy(buf, inet_ntoa(a), buflen);
 224         buf[buflen-1] = '\0';
 225     } else {
 226         assert(addr->family == AF_UNSPEC);
 227         strncpy(buf, addr->hostname, buflen);
 228         buf[buflen-1] = '\0';
 229     }
 230 }
 231
 232 int sk_hostname_is_local(char *name)
 233 {
 234     return !strcmp(name, "localhost");
 235 }
 236
 237 int sk_address_is_local(SockAddr addr)
 238 {
 239 #ifdef IPV6
 240     if (addr->family == AF_INET6) {
 241         FIXME;  /* someone who can compile for IPV6 had better do this bit */
 242     } else
 243 #endif
 244     if (addr->family == AF_INET) {
 245         struct in_addr a;
 246         a.s_addr = htonl(addr->address);
 247         return ipv4_is_loopback(a);
 248     } else {
 249         assert(addr->family == AF_UNSPEC);
 250         return 0;                      /* we don't know; assume not */
 251     }
 252 }
 253
 254 int sk_addrtype(SockAddr addr)
 255 {
 256     return (addr->family == AF_INET ? ADDRTYPE_IPV4 :
 257 #ifdef IPV6
 258             addr->family == AF_INET6 ? ADDRTYPE_IPV6 :
 259 #endif
 260             ADDRTYPE_NAME);
 261 }
 262
 263 void sk_addrcopy(SockAddr addr, char *buf)
 264 {
 265     assert(addr->family != AF_UNSPEC);
 266 #ifdef IPV6
 267     if (addr->family == AF_INET6) {
 268         memcpy(buf, (char*) addr->ai, 16);
 269     } else
 270 #endif
 271     if (addr->family == AF_INET) {
 272         struct in_addr a;
 273         a.s_addr = htonl(addr->address);
 274         memcpy(buf, (char*) &a.s_addr, 4);
 275     }
 276 }
 277
 278 void sk_addr_free(SockAddr addr)
 279 {
 280     sfree(addr);
 281 }
 282
 283 static Plug sk_tcp_plug(Socket sock, Plug p)
 284 {
 285     Actual_Socket s = (Actual_Socket) sock;
 286     Plug ret = s->plug;
 287     if (p)
 288         s->plug = p;
 289     return ret;
 290 }
 291
 292 static void sk_tcp_flush(Socket s)
 293 {
 294     /*
 295      * We send data to the socket as soon as we can anyway,
 296      * so we don't need to do anything here.  :-)
 297      */
 298 }
 299
 300 static void sk_tcp_close(Socket s);
 301 static int sk_tcp_write(Socket s, const char *data, int len);
 302 static int sk_tcp_write_oob(Socket s, const char *data, int len);
 303 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
 304 static void *sk_tcp_get_private_ptr(Socket s);
 305 static void sk_tcp_set_frozen(Socket s, int is_frozen);
 306 static char *sk_tcp_socket_error(Socket s);
 307
 308 Socket sk_register(void *sock, Plug plug)
 309 {
 310     static struct socket_function_table fn_table = {
 311         sk_tcp_plug,
 312         sk_tcp_close,
 313         sk_tcp_write,
 314         sk_tcp_write_oob,
 315         sk_tcp_flush,
 316         sk_tcp_set_private_ptr,
 317         sk_tcp_get_private_ptr,
 318         sk_tcp_set_frozen,
 319         sk_tcp_socket_error
 320     };
 321
 322     Actual_Socket ret;
 323
 324     /*
 325      * Create Socket structure.
 326      */
 327     ret = smalloc(sizeof(struct Socket_tag));
 328     ret->fn = &fn_table;
 329     ret->error = NULL;
 330     ret->plug = plug;
 331     bufchain_init(&ret->output_data);
 332     ret->writable = 1;                 /* to start with */
 333     ret->sending_oob = 0;
 334     ret->frozen = 1;
 335     ret->frozen_readable = 0;
 336     ret->localhost_only = 0;           /* unused, but best init anyway */
 337     ret->pending_error = 0;
 338     ret->oobpending = FALSE;
 339     ret->listener = 0;
 340
 341     ret->s = (int)sock;
 342
 343     if (ret->s < 0) {
 344         ret->error = error_string(errno);
 345         return (Socket) ret;
 346     }
 347
 348     ret->oobinline = 0;
 349
 350     add234(sktree, ret);
 351
 352     return (Socket) ret;
 353 }
 354
 355 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
 356               int nodelay, Plug plug)
 357 {
 358     static struct socket_function_table fn_table = {
 359         sk_tcp_plug,
 360         sk_tcp_close,
 361         sk_tcp_write,
 362         sk_tcp_write_oob,
 363         sk_tcp_flush,
 364         sk_tcp_set_private_ptr,
 365         sk_tcp_get_private_ptr,
 366         sk_tcp_set_frozen,
 367         sk_tcp_socket_error
 368     };
 369
 370     int s;
 371 #ifdef IPV6
 372     struct sockaddr_in6 a6;
 373 #endif
 374     struct sockaddr_in a;
 375     int err;
 376     Actual_Socket ret;
 377     short localport;
 378
 379     /*
 380      * Create Socket structure.
 381      */
 382     ret = smalloc(sizeof(struct Socket_tag));
 383     ret->fn = &fn_table;
 384     ret->error = NULL;
 385     ret->plug = plug;
 386     bufchain_init(&ret->output_data);
 387     ret->connected = 0;                /* to start with */
 388     ret->writable = 0;                 /* to start with */
 389     ret->sending_oob = 0;
 390     ret->frozen = 0;
 391     ret->frozen_readable = 0;
 392     ret->localhost_only = 0;           /* unused, but best init anyway */
 393     ret->pending_error = 0;
 394     ret->oobpending = FALSE;
 395     ret->listener = 0;
 396
 397     /*
 398      * Open socket.
 399      */
 400     assert(addr->family != AF_UNSPEC);
 401     s = socket(addr->family, SOCK_STREAM, 0);
 402     ret->s = s;
 403
 404     if (s < 0) {
 405         ret->error = error_string(errno);
 406         return (Socket) ret;
 407     }
 408
 409     ret->oobinline = oobinline;
 410     if (oobinline) {
 411         int b = TRUE;
 412         setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
 413     }
 414
 415     if (nodelay) {
 416         int b = TRUE;
 417         setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
 418     }
 419
 420     /*
 421      * Bind to local address.
 422      */
 423     if (privport)
 424         localport = 1023;              /* count from 1023 downwards */
 425     else
 426         localport = 0;                 /* just use port 0 (ie kernel picks) */
 427
 428     /* Loop round trying to bind */
 429     while (1) {
 430         int retcode;
 431
 432 #ifdef IPV6
 433         if (addr->family == AF_INET6) {
 434             memset(&a6, 0, sizeof(a6));
 435             a6.sin6_family = AF_INET6;
 436 /*a6.sin6_addr      = in6addr_any; *//* == 0 */
 437             a6.sin6_port = htons(localport);
 438         } else
 439 #endif
 440         {
 441             a.sin_family = AF_INET;
 442             a.sin_addr.s_addr = htonl(INADDR_ANY);
 443             a.sin_port = htons(localport);
 444         }
 445 #ifdef IPV6
 446         retcode = bind(s, (addr->family == AF_INET6 ?
 447                            (struct sockaddr *) &a6 :
 448                            (struct sockaddr *) &a),
 449                        (addr->family ==
 450                         AF_INET6 ? sizeof(a6) : sizeof(a)));
 451 #else
 452         retcode = bind(s, (struct sockaddr *) &a, sizeof(a));
 453 #endif
 454         if (retcode >= 0) {
 455             err = 0;
 456             break;                     /* done */
 457         } else {
 458             err = errno;
 459             if (err != EADDRINUSE)     /* failed, for a bad reason */
 460                 break;
 461         }
 462
 463         if (localport == 0)
 464             break;                     /* we're only looping once */
 465         localport--;
 466         if (localport == 0)
 467             break;                     /* we might have got to the end */
 468     }
 469
 470     if (err) {
 471         ret->error = error_string(err);
 472         return (Socket) ret;
 473     }
 474
 475     /*
 476      * Connect to remote address.
 477      */
 478 #ifdef IPV6
 479     if (addr->family == AF_INET6) {
 480         memset(&a, 0, sizeof(a));
 481         a6.sin6_family = AF_INET6;
 482         a6.sin6_port = htons((short) port);
 483         a6.sin6_addr =
 484             ((struct sockaddr_in6 *) addr->ai->ai_addr)->sin6_addr;
 485     } else
 486 #endif
 487     {
 488         a.sin_family = AF_INET;
 489         a.sin_addr.s_addr = htonl(addr->address);
 490         a.sin_port = htons((short) port);
 491     }
 492
 493     {
 494         int i = 1;
 495         ioctl(s, FIONBIO, &i);
 496     }
 497
 498     if ((
 499 #ifdef IPV6
 500             connect(s, ((addr->family == AF_INET6) ?
 501                         (struct sockaddr *) &a6 : (struct sockaddr *) &a),
 502                     (addr->family == AF_INET6) ? sizeof(a6) : sizeof(a))
 503 #else
 504             connect(s, (struct sockaddr *) &a, sizeof(a))
 505 #endif
 506         ) < 0) {
 507         if ( errno != EINPROGRESS ) {
 508             ret->error = error_string(errno);
 509             return (Socket) ret;
 510         }
 511     } else {
 512         /*
 513          * If we _don't_ get EWOULDBLOCK, the connect has completed
 514          * and we should set the socket as connected and writable.
 515          */
 516         ret->connected = 1;
 517         ret->writable = 1;
 518     }
 519
 520     add234(sktree, ret);
 521
 522     return (Socket) ret;
 523 }
 524
 525 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only)
 526 {
 527     static struct socket_function_table fn_table = {
 528         sk_tcp_plug,
 529         sk_tcp_close,
 530         sk_tcp_write,
 531         sk_tcp_write_oob,
 532         sk_tcp_flush,
 533         sk_tcp_set_private_ptr,
 534         sk_tcp_get_private_ptr,
 535         sk_tcp_set_frozen,
 536         sk_tcp_socket_error
 537     };
 538
 539     int s;
 540 #ifdef IPV6
 541     struct sockaddr_in6 a6;
 542 #endif
 543     struct sockaddr_in a;
 544     int err;
 545     Actual_Socket ret;
 546     int retcode;
 547     int on = 1;
 548
 549     /*
 550      * Create Socket structure.
 551      */
 552     ret = smalloc(sizeof(struct Socket_tag));
 553     ret->fn = &fn_table;
 554     ret->error = NULL;
 555     ret->plug = plug;
 556     bufchain_init(&ret->output_data);
 557     ret->writable = 0;                 /* to start with */
 558     ret->sending_oob = 0;
 559     ret->frozen = 0;
 560     ret->frozen_readable = 0;
 561     ret->localhost_only = local_host_only;
 562     ret->pending_error = 0;
 563     ret->oobpending = FALSE;
 564     ret->listener = 1;
 565
 566     /*
 567      * Open socket.
 568      */
 569     s = socket(AF_INET, SOCK_STREAM, 0);
 570     ret->s = s;
 571
 572     if (s < 0) {
 573         ret->error = error_string(errno);
 574         return (Socket) ret;
 575     }
 576
 577     ret->oobinline = 0;
 578
 579     setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
 580
 581 #ifdef IPV6
 582     if (addr->family == AF_INET6) {
 583         memset(&a6, 0, sizeof(a6));
 584         a6.sin6_family = AF_INET6;
 585         /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
 586          * know how to do it. :-) */
 587         if (local_host_only)
 588             a6.sin6_addr = in6addr_loopback;
 589         else
 590             a6.sin6_addr = in6addr_any;
 591         a6.sin6_port = htons(port);
 592     } else
 593 #endif
 594     {
 595         int got_addr = 0;
 596         a.sin_family = AF_INET;
 597
 598         /*
 599          * Bind to source address. First try an explicitly
 600          * specified one...
 601          */
 602         if (srcaddr) {
 603             a.sin_addr.s_addr = inet_addr(srcaddr);
 604             if (a.sin_addr.s_addr != INADDR_NONE) {
 605                 /* Override localhost_only with specified listen addr. */
 606                 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
 607                 got_addr = 1;
 608             }
 609         }
 610
 611         /*
 612          * ... and failing that, go with one of the standard ones.
 613          */
 614         if (!got_addr) {
 615             if (local_host_only)
 616                 a.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
 617             else
 618                 a.sin_addr.s_addr = htonl(INADDR_ANY);
 619         }
 620
 621         a.sin_port = htons((short)port);
 622     }
 623 #ifdef IPV6
 624     retcode = bind(s, (addr->family == AF_INET6 ?
 625                        (struct sockaddr *) &a6 :
 626                        (struct sockaddr *) &a),
 627                    (addr->family ==
 628                     AF_INET6 ? sizeof(a6) : sizeof(a)));
 629 #else
 630     retcode = bind(s, (struct sockaddr *) &a, sizeof(a));
 631 #endif
 632     if (retcode >= 0) {
 633         err = 0;
 634     } else {
 635         err = errno;
 636     }
 637
 638     if (err) {
 639         ret->error = error_string(err);
 640         return (Socket) ret;
 641     }
 642
 643
 644     if (listen(s, SOMAXCONN) < 0) {
 645         close(s);
 646         ret->error = error_string(errno);
 647         return (Socket) ret;
 648     }
 649
 650     add234(sktree, ret);
 651
 652     return (Socket) ret;
 653 }
 654
 655 static void sk_tcp_close(Socket sock)
 656 {
 657     Actual_Socket s = (Actual_Socket) sock;
 658
 659     del234(sktree, s);
 660     close(s->s);
 661     sfree(s);
 662 }
 663
 664 /*
 665  * The function which tries to send on a socket once it's deemed
 666  * writable.
 667  */
 668 void try_send(Actual_Socket s)
 669 {
 670     while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
 671         int nsent;
 672         int err;
 673         void *data;
 674         int len, urgentflag;
 675
 676         if (s->sending_oob) {
 677             urgentflag = MSG_OOB;
 678             len = s->sending_oob;
 679             data = &s->oobdata;
 680         } else {
 681             urgentflag = 0;
 682             bufchain_prefix(&s->output_data, &data, &len);
 683         }
 684         nsent = send(s->s, data, len, urgentflag);
 685         noise_ultralight(nsent);
 686         if (nsent <= 0) {
 687             err = (nsent < 0 ? errno : 0);
 688             if (err == EWOULDBLOCK) {
 689                 /*
 690                  * Perfectly normal: we've sent all we can for the moment.
 691                  */
 692                 s->writable = FALSE;
 693                 return;
 694             } else if (nsent == 0 ||
 695                        err == ECONNABORTED || err == ECONNRESET) {
 696                 /*
 697                  * If send() returns CONNABORTED or CONNRESET, we
 698                  * unfortunately can't just call plug_closing(),
 699                  * because it's quite likely that we're currently
 700                  * _in_ a call from the code we'd be calling back
 701                  * to, so we'd have to make half the SSH code
 702                  * reentrant. Instead we flag a pending error on
 703                  * the socket, to be dealt with (by calling
 704                  * plug_closing()) at some suitable future moment.
 705                  */
 706                 s->pending_error = err;
 707                 return;
 708             } else {
 709                 /* We're inside the Unix frontend here, so we know
 710                  * that the frontend handle is unnecessary. */
 711                 logevent(NULL, error_string(err));
 712                 fatalbox("%s", error_string(err));
 713             }
 714         } else {
 715             if (s->sending_oob) {
 716                 if (nsent < len) {
 717                     memmove(s->oobdata, s->oobdata+nsent, len-nsent);
 718                     s->sending_oob = len - nsent;
 719                 } else {
 720                     s->sending_oob = 0;
 721                 }
 722             } else {
 723                 bufchain_consume(&s->output_data, nsent);
 724             }
 725         }
 726     }
 727 }
 728
 729 static int sk_tcp_write(Socket sock, const char *buf, int len)
 730 {
 731     Actual_Socket s = (Actual_Socket) sock;
 732
 733     /*
 734      * Add the data to the buffer list on the socket.
 735      */
 736     bufchain_add(&s->output_data, buf, len);
 737
 738     /*
 739      * Now try sending from the start of the buffer list.
 740      */
 741     if (s->writable)
 742         try_send(s);
 743
 744     return bufchain_size(&s->output_data);
 745 }
 746
 747 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
 748 {
 749     Actual_Socket s = (Actual_Socket) sock;
 750
 751     /*
 752      * Replace the buffer list on the socket with the data.
 753      */
 754     bufchain_clear(&s->output_data);
 755     assert(len <= sizeof(s->oobdata));
 756     memcpy(s->oobdata, buf, len);
 757     s->sending_oob = len;
 758
 759     /*
 760      * Now try sending from the start of the buffer list.
 761      */
 762     if (s->writable)
 763         try_send(s);
 764
 765     return s->sending_oob;
 766 }
 767
 768 int select_result(int fd, int event)
 769 {
 770     int ret;
 771     int err;
 772     char buf[20480];                   /* nice big buffer for plenty of speed */
 773     Actual_Socket s;
 774     u_long atmark;
 775
 776     /* Find the Socket structure */
 777     s = find234(sktree, (void *) fd, cmpforsearch);
 778     if (!s)
 779         return 1;                      /* boggle */
 780
 781     noise_ultralight(event);
 782
 783     switch (event) {
 784       case 4:                          /* exceptional */
 785         if (!s->oobinline) {
 786             /*
 787              * On a non-oobinline socket, this indicates that we
 788              * can immediately perform an OOB read and get back OOB
 789              * data, which we will send to the back end with
 790              * type==2 (urgent data).
 791              */
 792             ret = recv(s->s, buf, sizeof(buf), MSG_OOB);
 793             noise_ultralight(ret);
 794             if (ret <= 0) {
 795                 char *str = (ret == 0 ? "Internal networking trouble" :
 796                              error_string(errno));
 797                 /* We're inside the Unix frontend here, so we know
 798                  * that the frontend handle is unnecessary. */
 799                 logevent(NULL, str);
 800                 fatalbox("%s", str);
 801             } else {
 802                 return plug_receive(s->plug, 2, buf, ret);
 803             }
 804             break;
 805         }
 806
 807         /*
 808          * If we reach here, this is an oobinline socket, which
 809          * means we should set s->oobpending and then deal with it
 810          * when we get called for the readability event (which
 811          * should also occur).
 812          */
 813         s->oobpending = TRUE;
 814         break;
 815       case 1:                          /* readable; also acceptance */
 816         if (s->listener) {
 817             /*
 818              * On a listening socket, the readability event means a
 819              * connection is ready to be accepted.
 820              */
 821             struct sockaddr_in isa;
 822             int addrlen = sizeof(struct sockaddr_in);
 823             int t;  /* socket of connection */
 824
 825             memset(&isa, 0, sizeof(struct sockaddr_in));
 826             err = 0;
 827             t = accept(s->s,(struct sockaddr *)&isa,&addrlen);
 828             if (t < 0) {
 829                 break;
 830             }
 831
 832             if (s->localhost_only && !ipv4_is_loopback(isa.sin_addr)) {
 833                 close(t);              /* someone let nonlocal through?! */
 834             } else if (plug_accepting(s->plug, (void*)t)) {
 835                 close(t);              /* denied or error */
 836             }
 837             break;
 838         }
 839
 840         /*
 841          * If we reach here, this is not a listening socket, so
 842          * readability really means readability.
 843          */
 844
 845         /* In the case the socket is still frozen, we don't even bother */
 846         if (s->frozen) {
 847             s->frozen_readable = 1;
 848             break;
 849         }
 850
 851         /*
 852          * We have received data on the socket. For an oobinline
 853          * socket, this might be data _before_ an urgent pointer,
 854          * in which case we send it to the back end with type==1
 855          * (data prior to urgent).
 856          */
 857         if (s->oobinline && s->oobpending) {
 858             atmark = 1;
 859             if (ioctl(s->s, SIOCATMARK, &atmark) == 0 && atmark)
 860                 s->oobpending = FALSE; /* clear this indicator */
 861         } else
 862             atmark = 1;
 863
 864         ret = recv(s->s, buf, s->oobpending ? 1 : sizeof(buf), 0);
 865         noise_ultralight(ret);
 866         if (ret < 0) {
 867             if (errno == EWOULDBLOCK) {
 868                 break;
 869             }
 870         }
 871         if (ret < 0) {
 872             return plug_closing(s->plug, error_string(errno), errno, 0);
 873         } else if (0 == ret) {
 874             return plug_closing(s->plug, NULL, 0, 0);
 875         } else {
 876             return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
 877         }
 878         break;
 879       case 2:                          /* writable */
 880         if (!s->connected) {
 881             /*
 882              * select() reports a socket as _writable_ when an
 883              * asynchronous connection is completed.
 884              */
 885             s->connected = s->writable = 1;
 886             break;
 887         } else {
 888             int bufsize_before, bufsize_after;
 889             s->writable = 1;
 890             bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
 891             try_send(s);
 892             bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
 893             if (bufsize_after < bufsize_before)
 894                 plug_sent(s->plug, bufsize_after);
 895         }
 896         break;
 897     }
 898
 899     return 1;
 900 }
 901
 902 /*
 903  * Deal with socket errors detected in try_send().
 904  */
 905 void net_pending_errors(void)
 906 {
 907     int i;
 908     Actual_Socket s;
 909
 910     /*
 911      * This might be a fiddly business, because it's just possible
 912      * that handling a pending error on one socket might cause
 913      * others to be closed. (I can't think of any reason this might
 914      * happen in current SSH implementation, but to maintain
 915      * generality of this network layer I'll assume the worst.)
 916      *
 917      * So what we'll do is search the socket list for _one_ socket
 918      * with a pending error, and then handle it, and then search
 919      * the list again _from the beginning_. Repeat until we make a
 920      * pass with no socket errors present. That way we are
 921      * protected against the socket list changing under our feet.
 922      */
 923
 924     do {
 925         for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
 926             if (s->pending_error) {
 927                 /*
 928                  * An error has occurred on this socket. Pass it to the
 929                  * plug.
 930                  */
 931                 plug_closing(s->plug, error_string(s->pending_error),
 932                              s->pending_error, 0);
 933                 break;
 934             }
 935         }
 936     } while (s);
 937 }
 938
 939 /*
 940  * Each socket abstraction contains a `void *' private field in
 941  * which the client can keep state.
 942  */
 943 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
 944 {
 945     Actual_Socket s = (Actual_Socket) sock;
 946     s->private_ptr = ptr;
 947 }
 948
 949 static void *sk_tcp_get_private_ptr(Socket sock)
 950 {
 951     Actual_Socket s = (Actual_Socket) sock;
 952     return s->private_ptr;
 953 }
 954
 955 /*
 956  * Special error values are returned from sk_namelookup and sk_new
 957  * if there's a problem. These functions extract an error message,
 958  * or return NULL if there's no problem.
 959  */
 960 char *sk_addr_error(SockAddr addr)
 961 {
 962     return addr->error;
 963 }
 964 static char *sk_tcp_socket_error(Socket sock)
 965 {
 966     Actual_Socket s = (Actual_Socket) sock;
 967     return s->error;
 968 }
 969
 970 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
 971 {
 972     Actual_Socket s = (Actual_Socket) sock;
 973     if (s->frozen == is_frozen)
 974         return;
 975     s->frozen = is_frozen;
 976     if (!is_frozen && s->frozen_readable) {
 977         char c;
 978         recv(s->s, &c, 1, MSG_PEEK);
 979     }
 980     s->frozen_readable = 0;
 981 }
 982
 983 /*
 984  * For Unix select()-based frontends: enumerate all sockets
 985  * currently active, and state whether we currently wish to receive
 986  * select events on them for reading, writing and exceptional
 987  * status.
 988  */
 989 static void set_rwx(Actual_Socket s, int *rwx)
 990 {
 991     int val = 0;
 992     if (!s->connected)
 993         val |= 2;                      /* write == connect */
 994     if (s->connected && !s->frozen)
 995         val |= 1 | 4;                  /* read, except */
 996     if (bufchain_size(&s->output_data))
 997         val |= 2;                      /* write */
 998     if (s->listener)
 999         val |= 1;                      /* read == accept */
1000     *rwx = val;
1001 }
1002
1003 int first_socket(int *state, int *rwx)
1004 {
1005     Actual_Socket s;
1006     *state = 0;
1007     s = index234(sktree, (*state)++);
1008     if (s)
1009         set_rwx(s, rwx);
1010     return s ? s->s : -1;
1011 }
1012
1013 int next_socket(int *state, int *rwx)
1014 {
1015     Actual_Socket s = index234(sktree, (*state)++);
1016     if (s)
1017         set_rwx(s, rwx);
1018     return s ? s->s : -1;
1019 }
1020
1021 int net_service_lookup(char *service)
1022 {
1023     struct servent *se;
1024     se = getservbyname(service, NULL);
1025     if (se != NULL)
1026         return ntohs(se->s_port);
1027     else
1028         return 0;
1029 }