winnet.c

   1 /*
   2  * Windows networking abstraction.
   3  *
   4  * Due to this clean abstraction it was possible
   5  * to easily implement IPv6 support :)
   6  *
   7  * IPv6 patch 1 (27 October 2000) Jeroen Massar <jeroen@unfix.org>
   8  *  - Preliminary hacked IPv6 support.
   9  *    - Connecting to IPv6 address (eg fec0:4242:4242:100:2d0:b7ff:fe8f:5d42) works.
  10  *    - Connecting to IPv6 hostname (eg heaven.ipv6.unfix.org) works.
  11  *  - Compiles as either IPv4 or IPv6.
  12  *
  13  * IPv6 patch 2 (29 October 2000) Jeroen Massar <jeroen@unfix.org>
  14  *  - When compiled as IPv6 it also allows connecting to IPv4 hosts.
  15  *  - Added some more documentation.
  16  *
  17  * IPv6 patch 3 (18 November 2000) Jeroen Massar <jeroen@unfix.org>
  18  *  - It now supports dynamically loading the IPv6 resolver dll's.
  19  *    This way we should be able to distribute one (1) binary
  20  *    which supports both IPv4 and IPv6.
  21  *  - getaddrinfo() and getnameinfo() are loaded dynamicaly if possible.
  22  *  - in6addr_any is defined in this file so we don't need to link to wship6.lib
  23  *  - The patch is now more unified so that we can still
  24  *    remove all IPv6 support by undef'ing IPV6.
  25  *    But where it fallsback to IPv4 it uses the IPv4 code which is already in place...
  26  *  - Canonical name resolving works.
  27  *
  28  * IPv6 patch 4 (07 January 2001) Jeroen Massar <jeroen@unfix.org>
  29  *  - patch against CVS of today, will be submitted to the bugs list
  30  *    as a 'cvs diff -u' on Simon's request...
  31  *
  32  */
  33
  34 /*
  35  * Define IPV6 to have IPv6 on-the-fly-loading support.
  36  * This means that one doesn't have to have an IPv6 stack to use it.
  37  * But if an IPv6 stack is found it is used with a fallback to IPv4.
  38  */
  39 /* #define IPV6 1 */
  40
  41 #ifdef IPV6
  42 #include <winsock2.h>
  43 #include <ws2tcpip.h>
  44 #include <tpipv6.h>
  45 #else
  46 #include <winsock.h>
  47 #endif
  48 #include <windows.h>
  49 #include <stdio.h>
  50 #include <stdlib.h>
  51
  52 #include "putty.h"
  53 #include "network.h"
  54 #include "tree234.h"
  55
  56 #define BUFFER_GRANULE 512
  57
  58 struct Socket_tag {
  59     char *error;
  60     SOCKET s;
  61     sk_receiver_t receiver;
  62     void *private_ptr;
  63     struct buffer *head, *tail;
  64     int writable;
  65     int in_oob, sending_oob;
  66 };
  67
  68 struct SockAddr_tag {
  69     char *error;
  70     /* address family this belongs to, AF_INET for IPv4, AF_INET6 for IPv6. */
  71     int family;
  72     unsigned long address;             /* Address IPv4 style. */
  73 #ifdef IPV6
  74     struct addrinfo *ai;               /* Address IPv6 style. */
  75 #endif
  76     /*
  77      * We need to have this lengthy enough to hold *any* hostname
  78      * (including IPv6 reverse...)
  79      */
  80     char realhost[8192];
  81 };
  82
  83 struct buffer {
  84     struct buffer *next;
  85     int buflen, bufpos;
  86     char buf[BUFFER_GRANULE];
  87 };
  88
  89 static tree234 *sktree;
  90
  91 static int cmpfortree(void *av, void *bv) {
  92     Socket a = (Socket)av, b = (Socket)bv;
  93     unsigned long as = (unsigned long)a->s, bs = (unsigned long)b->s;
  94     if (as < bs) return -1;
  95     if (as > bs) return +1;
  96     return 0;
  97 }
  98
  99 static int cmpforsearch(void *av, void *bv) {
 100     Socket b = (Socket)bv;
 101     unsigned long as = (unsigned long)av, bs = (unsigned long)b->s;
 102     if (as < bs) return -1;
 103     if (as > bs) return +1;
 104     return 0;
 105 }
 106
 107 void sk_init(void) {
 108     sktree = newtree234(cmpfortree);
 109 }
 110
 111 char *winsock_error_string(int error) {
 112     switch (error) {
 113       case WSAEACCES: return "Network error: Permission denied";
 114       case WSAEADDRINUSE: return "Network error: Address already in use";
 115       case WSAEADDRNOTAVAIL: return "Network error: Cannot assign requested address";
 116       case WSAEAFNOSUPPORT: return "Network error: Address family not supported by protocol family";
 117       case WSAEALREADY: return "Network error: Operation already in progress";
 118       case WSAECONNABORTED: return "Network error: Software caused connection abort";
 119       case WSAECONNREFUSED: return "Network error: Connection refused";
 120       case WSAECONNRESET: return "Network error: Connection reset by peer";
 121       case WSAEDESTADDRREQ: return "Network error: Destination address required";
 122       case WSAEFAULT: return "Network error: Bad address";
 123       case WSAEHOSTDOWN: return "Network error: Host is down";
 124       case WSAEHOSTUNREACH: return "Network error: No route to host";
 125       case WSAEINPROGRESS: return "Network error: Operation now in progress";
 126       case WSAEINTR: return "Network error: Interrupted function call";
 127       case WSAEINVAL: return "Network error: Invalid argument";
 128       case WSAEISCONN: return "Network error: Socket is already connected";
 129       case WSAEMFILE: return "Network error: Too many open files";
 130       case WSAEMSGSIZE: return "Network error: Message too long";
 131       case WSAENETDOWN: return "Network error: Network is down";
 132       case WSAENETRESET: return "Network error: Network dropped connection on reset";
 133       case WSAENETUNREACH: return "Network error: Network is unreachable";
 134       case WSAENOBUFS: return "Network error: No buffer space available";
 135       case WSAENOPROTOOPT: return "Network error: Bad protocol option";
 136       case WSAENOTCONN: return "Network error: Socket is not connected";
 137       case WSAENOTSOCK: return "Network error: Socket operation on non-socket";
 138       case WSAEOPNOTSUPP: return "Network error: Operation not supported";
 139       case WSAEPFNOSUPPORT: return "Network error: Protocol family not supported";
 140       case WSAEPROCLIM: return "Network error: Too many processes";
 141       case WSAEPROTONOSUPPORT: return "Network error: Protocol not supported";
 142       case WSAEPROTOTYPE: return "Network error: Protocol wrong type for socket";
 143       case WSAESHUTDOWN: return "Network error: Cannot send after socket shutdown";
 144       case WSAESOCKTNOSUPPORT: return "Network error: Socket type not supported";
 145       case WSAETIMEDOUT: return "Network error: Connection timed out";
 146       case WSAEWOULDBLOCK: return "Network error: Resource temporarily unavailable";
 147       case WSAEDISCON: return "Network error: Graceful shutdown in progress";
 148       default: return "Unknown network error";
 149     }
 150 }
 151
 152 SockAddr sk_namelookup(char *host, char **canonicalname)
 153 {
 154     SockAddr ret = smalloc(sizeof(struct SockAddr_tag));
 155     unsigned long a;
 156     struct hostent *h = NULL;
 157
 158     /* Clear the structure and default to IPv4. */
 159     memset(ret, 0, sizeof(struct SockAddr_tag));
 160     ret->family = 0;                   /* We set this one when we have resolved the host. */
 161     *canonicalname = ret->realhost;    /* This makes sure we always have a hostname to return. */
 162
 163     if ( (a = inet_addr(host)) == (unsigned long) INADDR_NONE)
 164     {
 165 #ifdef IPV6
 166
 167         /* Try to get the getaddrinfo() function from wship6.dll */
 168         /* This way one doesn't need to have IPv6 dll's to use PuTTY and
 169          * it will fallback to IPv4. */
 170         typedef int (CALLBACK* FGETADDRINFO)(const char *nodename,
 171                                              const char *servname,
 172                                              const struct addrinfo *hints,
 173                                              struct addrinfo **res);
 174         FGETADDRINFO fGetAddrInfo = NULL;
 175
 176         HINSTANCE dllWSHIP6 = LoadLibrary("wship6.dll");
 177         if (dllWSHIP6)
 178             fGetAddrInfo = (FGETADDRINFO)GetProcAddress(dllWSHIP6,
 179                                                         "getaddrinfo");
 180
 181         /*
 182          * Use fGetAddrInfo when it's available (which usually also
 183          * means IPv6 is installed...)
 184          */
 185         if (fGetAddrInfo)
 186         {
 187             /*debug(("Resolving \"%s\" with getaddrinfo()  (IPv4+IPv6 capable)...\n", host)); */
 188             if (fGetAddrInfo(host, NULL, NULL, &ret->ai) == 0)
 189                 ret->family = ret->ai->ai_family;
 190         }
 191         else
 192 #endif
 193             /*
 194              * Otherwise use the IPv4-only gethostbyname...
 195              * (NOTE: we don't use gethostbyname as a
 196              * fallback!)
 197              */
 198             if (ret->family == 0)
 199         {
 200             /*debug(("Resolving \"%s\" with gethostbyname() (IPv4 only)...\n", host)); */
 201             if (h = gethostbyname(host)) ret->family = AF_INET;
 202         }
 203         /*debug(("Done resolving...(family is %d) AF_INET = %d, AF_INET6 = %d\n", ret->family, AF_INET, AF_INET6)); */
 204
 205         if (ret->family == 0)
 206         {
 207             DWORD err = WSAGetLastError();
 208             ret->error = (err == WSAENETDOWN ? "Network is down" :
 209                           err == WSAHOST_NOT_FOUND ? "Host does not exist" :
 210                           err == WSATRY_AGAIN ? "Host not found" :
 211 #ifdef IPV6
 212                           fGetAddrInfo ? "getaddrinfo: unknown error" :
 213 #endif
 214                           "gethostbyname: unknown error");
 215 #ifdef DEBUG
 216             {
 217                 LPVOID lpMsgBuf;
 218                 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, err, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPTSTR)&lpMsgBuf,     0,      NULL);
 219                 debug(("Error %ld: %s (h=%lx)\n", err, lpMsgBuf, h));
 220                 /* Free the buffer. */
 221                 LocalFree(lpMsgBuf);
 222             }
 223 #endif
 224         }
 225         else
 226         {
 227             ret->error = NULL;
 228
 229 #ifdef IPV6
 230             /* If we got an address info use that... */
 231             if (ret->ai)
 232             {
 233                 typedef int (CALLBACK* FGETNAMEINFO)
 234                     (const struct sockaddr FAR *sa, socklen_t salen,
 235                      char FAR * host, size_t hostlen, char FAR * serv,
 236                      size_t servlen, int flags);
 237                 FGETNAMEINFO fGetNameInfo = NULL;
 238
 239                 /* Are we in IPv4 fallback mode? */
 240                 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
 241                 if (ret->family == AF_INET)
 242                     memcpy(&a, (char *)&((SOCKADDR_IN *)ret->ai->ai_addr)->sin_addr, sizeof(a));
 243
 244                 /* Now let's find that canonicalname... */
 245                 if ((dllWSHIP6) && (fGetNameInfo = (FGETNAMEINFO)GetProcAddress(dllWSHIP6, "getnameinfo")))
 246                 {
 247                     if (fGetNameInfo((struct sockaddr *)ret->ai->ai_addr,
 248                                      ret->family == AF_INET ?
 249                                      sizeof(SOCKADDR_IN) :
 250                                      sizeof(SOCKADDR_IN6), ret->realhost,
 251                                      sizeof(ret->realhost), NULL,
 252                                      0, 0) != 0)
 253                     {
 254                         strncpy(ret->realhost, host,
 255                                 sizeof(ret->realhost));
 256                     }
 257                 }
 258             }
 259             /* We used the IPv4-only gethostbyname()... */
 260             else
 261             {
 262 #endif
 263                 memcpy(&a, h->h_addr, sizeof(a));
 264                 /* This way we are always sure the h->h_name is valid :) */
 265                 strncpy(ret->realhost, h->h_name, sizeof(ret->realhost));
 266 #ifdef IPV6
 267             }
 268 #endif
 269         }
 270 #ifdef IPV6
 271         FreeLibrary(dllWSHIP6);
 272 #endif
 273     }
 274     else
 275     {
 276         *canonicalname = host;
 277     }
 278     ret->address = ntohl(a);
 279     return ret;
 280 }
 281
 282 void sk_addr_free(SockAddr addr) {
 283     sfree(addr);
 284 }
 285
 286 Socket sk_new(SockAddr addr, int port, sk_receiver_t receiver) {
 287     SOCKET s;
 288 #ifdef IPV6
 289     SOCKADDR_IN6 a6;
 290 #endif
 291     SOCKADDR_IN a;
 292     DWORD err;
 293     char *errstr;
 294     Socket ret;
 295     extern char *do_select(SOCKET skt, int startup);
 296
 297     /*
 298      * Create Socket structure.
 299      */
 300     ret = smalloc(sizeof(struct Socket_tag));
 301     ret->error = NULL;
 302     ret->receiver = receiver;
 303     ret->head = ret->tail = NULL;
 304     ret->writable = 1;                 /* to start with */
 305     ret->in_oob = FALSE;
 306     ret->sending_oob = 0;
 307
 308     /*
 309      * Open socket.
 310      */
 311     s = socket(addr->family, SOCK_STREAM, 0);
 312     ret->s = s;
 313
 314     if (s == INVALID_SOCKET) {
 315         err = WSAGetLastError();
 316         ret->error = winsock_error_string(err);
 317         return ret;
 318     }
 319
 320     /*
 321      * Bind to local address.
 322      */
 323 #ifdef IPV6
 324     if (addr->family == AF_INET6)
 325     {
 326         memset(&a6,0,sizeof(a6));
 327         a6.sin6_family  = AF_INET6;
 328         /*a6.sin6_addr  = in6addr_any;*/                        /* == 0 */
 329         a6.sin6_port    = htons(0);
 330     }
 331     else
 332     {
 333 #endif
 334         a.sin_family = AF_INET;
 335         a.sin_addr.s_addr = htonl(INADDR_ANY);
 336         a.sin_port = htons(0);
 337 #ifdef IPV6
 338     }
 339     if (bind (s, (addr->family == AF_INET6) ? (struct sockaddr *)&a6 : (struct sockaddr *)&a, (addr->family == AF_INET6) ? sizeof(a6) : sizeof(a)) == SOCKET_ERROR)
 340 #else
 341         if (bind (s, (struct sockaddr *)&a, sizeof(a)) == SOCKET_ERROR)
 342 #endif
 343     {
 344         err = WSAGetLastError();
 345         ret->error = winsock_error_string(err);
 346         return ret;
 347     }
 348
 349     /*
 350      * Connect to remote address.
 351      */
 352 #ifdef IPV6
 353     if (addr->family == AF_INET6)
 354     {
 355         memset(&a,0,sizeof(a));
 356         a6.sin6_family = AF_INET6;
 357         a6.sin6_port = htons((short)port);
 358         a6.sin6_addr = ((struct sockaddr_in6 *)addr->ai->ai_addr)->sin6_addr;
 359     }
 360     else
 361     {
 362 #endif
 363         a.sin_family = AF_INET;
 364         a.sin_addr.s_addr = htonl(addr->address);
 365         a.sin_port = htons((short)port);
 366 #ifdef IPV6
 367     }
 368     if (connect (s, (addr->family == AF_INET6) ? (struct sockaddr *)&a6 : (struct sockaddr *)&a, (addr->family == AF_INET6) ? sizeof(a6) : sizeof(a)) == SOCKET_ERROR)
 369 #else
 370         if (connect (s, (struct sockaddr *)&a, sizeof(a)) == SOCKET_ERROR)
 371 #endif
 372     {
 373         err = WSAGetLastError();
 374         ret->error = winsock_error_string(err);
 375         return ret;
 376     }
 377
 378     /* Set up a select mechanism. This could be an AsyncSelect on a
 379      * window, or an EventSelect on an event object. */
 380     errstr = do_select(s, 1);
 381     if (errstr) {
 382         ret->error = errstr;
 383         return ret;
 384     }
 385
 386     add234(sktree, ret);
 387
 388     return ret;
 389 }
 390
 391 void sk_close(Socket s) {
 392     del234(sktree, s);
 393     do_select(s->s, 0);
 394     closesocket(s->s);
 395     sfree(s);
 396 }
 397
 398 /*
 399  * The function which tries to send on a socket once it's deemed
 400  * writable.
 401  */
 402 void try_send(Socket s) {
 403     while (s->head) {
 404         int nsent;
 405         DWORD err;
 406         int len, urgentflag;
 407
 408         if (s->sending_oob) {
 409             urgentflag = MSG_OOB;
 410             len = s->sending_oob;
 411         } else {
 412             urgentflag = 0;
 413             len = s->head->buflen - s->head->bufpos;
 414         }
 415
 416         nsent = send(s->s, s->head->buf + s->head->bufpos, len, urgentflag);
 417         noise_ultralight(nsent);
 418         if (nsent <= 0) {
 419             err = (nsent < 0 ? WSAGetLastError() : 0);
 420             if (err == WSAEWOULDBLOCK) {
 421                 /* Perfectly normal: we've sent all we can for the moment. */
 422                 s->writable = FALSE;
 423                 return;
 424             } else if (nsent == 0 ||
 425                        err == WSAECONNABORTED ||
 426                        err == WSAECONNRESET) {
 427                 /*
 428                  * FIXME. This will have to be done better when we
 429                  * start managing multiple sockets (e.g. SSH port
 430                  * forwarding), because if we get CONNRESET while
 431                  * trying to write a particular forwarded socket
 432                  * then it isn't necessarily the end of the world.
 433                  * Ideally I'd like to pass the error code back to
 434                  * somewhere the next select_result() will see it,
 435                  * but that might be hard. Perhaps I should pass it
 436                  * back to be queued in the Windows front end bit.
 437                  */
 438                 fatalbox(winsock_error_string(err));
 439             } else {
 440                 fatalbox(winsock_error_string(err));
 441             }
 442         } else {
 443             s->head->bufpos += nsent;
 444             if (s->sending_oob)
 445                 s->sending_oob -= nsent;
 446             if (s->head->bufpos >= s->head->buflen) {
 447                 struct buffer *tmp = s->head;
 448                 s->head = tmp->next;
 449                 sfree(tmp);
 450                 if (!s->head)
 451                     s->tail = NULL;
 452             }
 453         }
 454     }
 455 }
 456
 457 void sk_write(Socket s, char *buf, int len) {
 458     /*
 459      * Add the data to the buffer list on the socket.
 460      */
 461     if (s->tail && s->tail->buflen < BUFFER_GRANULE) {
 462         int copylen = min(len, BUFFER_GRANULE - s->tail->buflen);
 463         memcpy(s->tail->buf + s->tail->buflen, buf, copylen);
 464         buf += copylen;
 465         len -= copylen;
 466         s->tail->buflen += copylen;
 467     }
 468     while (len > 0) {
 469         int grainlen = min(len, BUFFER_GRANULE);
 470         struct buffer *newbuf;
 471         newbuf = smalloc(sizeof(struct buffer));
 472         newbuf->bufpos = 0;
 473         newbuf->buflen = grainlen;
 474         memcpy(newbuf->buf, buf, grainlen);
 475         buf += grainlen;
 476         len -= grainlen;
 477         if (s->tail)
 478             s->tail->next = newbuf;
 479         else
 480             s->head = s->tail = newbuf;
 481         newbuf->next = NULL;
 482         s->tail = newbuf;
 483     }
 484
 485     /*
 486      * Now try sending from the start of the buffer list.
 487      */
 488     if (s->writable)
 489         try_send(s);
 490 }
 491
 492 void sk_write_oob(Socket s, char *buf, int len) {
 493     /*
 494      * Replace the buffer list on the socket with the data.
 495      */
 496     if (!s->head) {
 497         s->head = smalloc(sizeof(struct buffer));
 498     } else {
 499         struct buffer *walk = s->head->next;
 500         while (walk) {
 501             struct buffer *tmp = walk;
 502             walk = tmp->next;
 503             sfree(tmp);
 504         }
 505     }
 506     s->head->next = NULL;
 507     s->tail = s->head;
 508     s->head->buflen = len;
 509     memcpy(s->head->buf, buf, len);
 510
 511     /*
 512      * Set the Urgent marker.
 513      */
 514     s->sending_oob = len;
 515
 516     /*
 517      * Now try sending from the start of the buffer list.
 518      */
 519     if (s->writable)
 520         try_send(s);
 521 }
 522
 523 int select_result(WPARAM wParam, LPARAM lParam) {
 524     int ret;
 525     DWORD err;
 526     char buf[BUFFER_GRANULE];
 527     Socket s;
 528     u_long atmark;
 529
 530     /* wParam is the socket itself */
 531     s = find234(sktree, (void *)wParam, cmpforsearch);
 532     if (!s)
 533         return 1;                      /* boggle */
 534
 535     if ((err = WSAGETSELECTERROR(lParam)) != 0) {
 536         fatalbox(winsock_error_string(err));
 537     }
 538
 539     noise_ultralight(lParam);
 540
 541     switch (WSAGETSELECTEVENT(lParam)) {
 542       case FD_READ:
 543         ret = recv(s->s, buf, sizeof(buf), 0);
 544         if (ret < 0) {
 545             err = WSAGetLastError();
 546             if (err == WSAEWOULDBLOCK) {
 547                 break;
 548             }
 549         }
 550         if (ret < 0) {
 551             fatalbox(winsock_error_string(err));
 552         } else {
 553             int type = s->in_oob ? 2 : 0;
 554             s->in_oob = FALSE;
 555             return s->receiver(s, type, buf, ret);
 556         }
 557         break;
 558       case FD_OOB:
 559         /*
 560          * Read all data up to the OOB marker, and send it to the
 561          * receiver with urgent==1 (OOB pending).
 562          */
 563         atmark = 1;
 564         s->in_oob = TRUE;
 565         /* Some WinSock wrappers don't support this call, so we
 566          * deliberately don't check the return value. If the call
 567          * fails and does nothing, we will get back atmark==1,
 568          * which is good enough to keep going at least. */
 569         ioctlsocket(s->s, SIOCATMARK, &atmark);
 570         ret = recv(s->s, buf, sizeof(buf), MSG_OOB);
 571         noise_ultralight(ret);
 572         if (ret <= 0) {
 573             fatalbox(ret == 0 ? "Internal networking trouble" :
 574                      winsock_error_string(WSAGetLastError()));
 575         } else {
 576             return s->receiver(s, atmark ? 2 : 1, buf, ret);
 577         }
 578         break;
 579       case FD_WRITE:
 580         s->writable = 1;
 581         try_send(s);
 582         break;
 583       case FD_CLOSE:
 584         /* Signal a close on the socket. */
 585         return s->receiver(s, 0, NULL, 0);
 586         break;
 587     }
 588
 589     return 1;
 590 }
 591
 592 /*
 593  * Each socket abstraction contains a `void *' private field in
 594  * which the client can keep state.
 595  */
 596 void sk_set_private_ptr(Socket s, void *ptr) {
 597     s->private_ptr = ptr;
 598 }
 599 void *sk_get_private_ptr(Socket s) {
 600     return s->private_ptr;
 601 }
 602
 603 /*
 604  * Special error values are returned from sk_namelookup and sk_new
 605  * if there's a problem. These functions extract an error message,
 606  * or return NULL if there's no problem.
 607  */
 608 char *sk_addr_error(SockAddr addr) {
 609     return addr->error;
 610 }
 611 char *sk_socket_error(Socket s) {
 612     return s->error;
 613 }
 614
 615 /*
 616  * For Plink: enumerate all sockets currently active.
 617  */
 618 SOCKET first_socket(enum234 *e) {
 619     Socket s = first234(sktree, e);
 620     return s ? s->s : INVALID_SOCKET;
 621 }
 622 SOCKET next_socket(enum234 *e) {
 623     Socket s = next234(e);
 624     return s ? s->s : INVALID_SOCKET;
 625 }