windows/winnet.c

   1 /*
   2  * Windows networking abstraction.
   3  *
   4  * For the IPv6 code in here I am indebted to Jeroen Massar and
   5  * unfix.org.
   6  */
   7
   8 #include <stdio.h>
   9 #include <stdlib.h>
  10 #include <assert.h>
  11
  12 #define DEFINE_PLUG_METHOD_MACROS
  13 #include "putty.h"
  14 #include "network.h"
  15 #include "tree234.h"
  16
  17 #include <ws2tcpip.h>
  18
  19 #ifndef NO_IPV6
  20 const struct in6_addr in6addr_any = IN6ADDR_ANY_INIT;
  21 const struct in6_addr in6addr_loopback = IN6ADDR_LOOPBACK_INIT;
  22 #endif
  23
  24 #define ipv4_is_loopback(addr) \
  25         ((p_ntohl(addr.s_addr) & 0xFF000000L) == 0x7F000000L)
  26
  27 /*
  28  * We used to typedef struct Socket_tag *Socket.
  29  *
  30  * Since we have made the networking abstraction slightly more
  31  * abstract, Socket no longer means a tcp socket (it could mean
  32  * an ssl socket).  So now we must use Actual_Socket when we know
  33  * we are talking about a tcp socket.
  34  */
  35 typedef struct Socket_tag *Actual_Socket;
  36
  37 /*
  38  * Mutable state that goes with a SockAddr: stores information
  39  * about where in the list of candidate IP(v*) addresses we've
  40  * currently got to.
  41  */
  42 typedef struct SockAddrStep_tag SockAddrStep;
  43 struct SockAddrStep_tag {
  44 #ifndef NO_IPV6
  45     struct addrinfo *ai;               /* steps along addr->ais */
  46 #endif
  47     int curraddr;
  48 };
  49
  50 struct Socket_tag {
  51     const struct socket_function_table *fn;
  52     /* the above variable absolutely *must* be the first in this structure */
  53     char *error;
  54     SOCKET s;
  55     Plug plug;
  56     void *private_ptr;
  57     bufchain output_data;
  58     int connected;
  59     int writable;
  60     int frozen; /* this causes readability notifications to be ignored */
  61     int frozen_readable; /* this means we missed at least one readability
  62                           * notification while we were frozen */
  63     int localhost_only;                /* for listening sockets */
  64     char oobdata[1];
  65     int sending_oob;
  66     int oobinline, nodelay, keepalive, privport;
  67     SockAddr addr;
  68     SockAddrStep step;
  69     int port;
  70     int pending_error;                 /* in case send() returns error */
  71     /*
  72      * We sometimes need pairs of Socket structures to be linked:
  73      * if we are listening on the same IPv6 and v4 port, for
  74      * example. So here we define `parent' and `child' pointers to
  75      * track this link.
  76      */
  77     Actual_Socket parent, child;
  78 };
  79
  80 struct SockAddr_tag {
  81     char *error;
  82     int resolved;
  83 #ifndef NO_IPV6
  84     struct addrinfo *ais;              /* Addresses IPv6 style. */
  85 #endif
  86     unsigned long *addresses;          /* Addresses IPv4 style. */
  87     int naddresses;
  88     char hostname[512];                /* Store an unresolved host name. */
  89 };
  90
  91 /*
  92  * Which address family this address belongs to. AF_INET for IPv4;
  93  * AF_INET6 for IPv6; AF_UNSPEC indicates that name resolution has
  94  * not been done and a simple host name is held in this SockAddr
  95  * structure.
  96  */
  97 #ifndef NO_IPV6
  98 #define SOCKADDR_FAMILY(addr, step) \
  99     (!(addr)->resolved ? AF_UNSPEC : \
 100      (step).ai ? (step).ai->ai_family : AF_INET)
 101 #else
 102 #define SOCKADDR_FAMILY(addr, step) \
 103     (!(addr)->resolved ? AF_UNSPEC : AF_INET)
 104 #endif
 105
 106 /*
 107  * Start a SockAddrStep structure to step through multiple
 108  * addresses.
 109  */
 110 #ifndef NO_IPV6
 111 #define START_STEP(addr, step) \
 112     ((step).ai = (addr)->ais, (step).curraddr = 0)
 113 #else
 114 #define START_STEP(addr, step) \
 115     ((step).curraddr = 0)
 116 #endif
 117
 118 static tree234 *sktree;
 119
 120 static int cmpfortree(void *av, void *bv)
 121 {
 122     Actual_Socket a = (Actual_Socket) av, b = (Actual_Socket) bv;
 123     unsigned long as = (unsigned long) a->s, bs = (unsigned long) b->s;
 124     if (as < bs)
 125         return -1;
 126     if (as > bs)
 127         return +1;
 128     if (a < b)
 129         return -1;
 130     if (a > b)
 131         return +1;
 132     return 0;
 133 }
 134
 135 static int cmpforsearch(void *av, void *bv)
 136 {
 137     Actual_Socket b = (Actual_Socket) bv;
 138     unsigned long as = (unsigned long) av, bs = (unsigned long) b->s;
 139     if (as < bs)
 140         return -1;
 141     if (as > bs)
 142         return +1;
 143     return 0;
 144 }
 145
 146 #define NOTHING
 147 #define DECL_WINSOCK_FUNCTION(linkage, rettype, name, params) \
 148     typedef rettype (WINAPI *t_##name) params; \
 149     linkage t_##name p_##name
 150 #define GET_WINSOCK_FUNCTION(module, name) \
 151     p_##name = module ? (t_##name) GetProcAddress(module, #name) : NULL
 152
 153 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAAsyncSelect,
 154                       (SOCKET, HWND, u_int, long));
 155 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAEventSelect, (SOCKET, WSAEVENT, long));
 156 DECL_WINSOCK_FUNCTION(NOTHING, int, select,
 157                       (int, fd_set FAR *, fd_set FAR *,
 158                        fd_set FAR *, const struct timeval FAR *));
 159 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAGetLastError, (void));
 160 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAEnumNetworkEvents,
 161                       (SOCKET, WSAEVENT, LPWSANETWORKEVENTS));
 162 DECL_WINSOCK_FUNCTION(static, int, WSAStartup, (WORD, LPWSADATA));
 163 DECL_WINSOCK_FUNCTION(static, int, WSACleanup, (void));
 164 DECL_WINSOCK_FUNCTION(static, int, closesocket, (SOCKET));
 165 DECL_WINSOCK_FUNCTION(static, u_long, ntohl, (u_long));
 166 DECL_WINSOCK_FUNCTION(static, u_long, htonl, (u_long));
 167 DECL_WINSOCK_FUNCTION(static, u_short, htons, (u_short));
 168 DECL_WINSOCK_FUNCTION(static, u_short, ntohs, (u_short));
 169 DECL_WINSOCK_FUNCTION(static, struct hostent FAR *, gethostbyname,
 170                       (const char FAR *));
 171 DECL_WINSOCK_FUNCTION(static, struct servent FAR *, getservbyname,
 172                       (const char FAR *, const char FAR *));
 173 DECL_WINSOCK_FUNCTION(static, unsigned long, inet_addr, (const char FAR *));
 174 DECL_WINSOCK_FUNCTION(static, char FAR *, inet_ntoa, (struct in_addr));
 175 DECL_WINSOCK_FUNCTION(static, int, connect,
 176                       (SOCKET, const struct sockaddr FAR *, int));
 177 DECL_WINSOCK_FUNCTION(static, int, bind,
 178                       (SOCKET, const struct sockaddr FAR *, int));
 179 DECL_WINSOCK_FUNCTION(static, int, setsockopt,
 180                       (SOCKET, int, int, const char FAR *, int));
 181 DECL_WINSOCK_FUNCTION(static, SOCKET, socket, (int, int, int));
 182 DECL_WINSOCK_FUNCTION(static, int, listen, (SOCKET, int));
 183 DECL_WINSOCK_FUNCTION(static, int, send, (SOCKET, const char FAR *, int, int));
 184 DECL_WINSOCK_FUNCTION(static, int, ioctlsocket,
 185                       (SOCKET, long, u_long FAR *));
 186 DECL_WINSOCK_FUNCTION(static, SOCKET, accept,
 187                       (SOCKET, struct sockaddr FAR *, int FAR *));
 188 DECL_WINSOCK_FUNCTION(static, int, recv, (SOCKET, char FAR *, int, int));
 189 DECL_WINSOCK_FUNCTION(static, int, WSAIoctl,
 190                       (SOCKET, DWORD, LPVOID, DWORD, LPVOID, DWORD,
 191                        LPDWORD, LPWSAOVERLAPPED,
 192                        LPWSAOVERLAPPED_COMPLETION_ROUTINE));
 193 #ifndef NO_IPV6
 194 DECL_WINSOCK_FUNCTION(static, int, getaddrinfo,
 195                       (const char *nodename, const char *servname,
 196                        const struct addrinfo *hints, struct addrinfo **res));
 197 DECL_WINSOCK_FUNCTION(static, void, freeaddrinfo, (struct addrinfo *res));
 198 DECL_WINSOCK_FUNCTION(static, int, getnameinfo,
 199                       (const struct sockaddr FAR * sa, socklen_t salen,
 200                        char FAR * host, size_t hostlen, char FAR * serv,
 201                        size_t servlen, int flags));
 202 DECL_WINSOCK_FUNCTION(static, char *, gai_strerror, (int ecode));
 203 DECL_WINSOCK_FUNCTION(static, int, WSAAddressToStringA,
 204                       (LPSOCKADDR, DWORD, LPWSAPROTOCOL_INFO,
 205                        LPTSTR, LPDWORD));
 206 #endif
 207
 208 static HMODULE winsock_module = NULL;
 209 static WSADATA wsadata;
 210 #ifndef NO_IPV6
 211 static HMODULE winsock2_module = NULL;
 212 static HMODULE wship6_module = NULL;
 213 #endif
 214
 215 int sk_startup(int hi, int lo)
 216 {
 217     WORD winsock_ver;
 218
 219     winsock_ver = MAKEWORD(hi, lo);
 220
 221     if (p_WSAStartup(winsock_ver, &wsadata)) {
 222         return FALSE;
 223     }
 224
 225     if (LOBYTE(wsadata.wVersion) != LOBYTE(winsock_ver)) {
 226         return FALSE;
 227     }
 228
 229 #ifdef NET_SETUP_DIAGNOSTICS
 230     {
 231         char buf[80];
 232         sprintf(buf, "Using WinSock %d.%d", hi, lo);
 233         logevent(NULL, buf);
 234     }
 235 #endif
 236     return TRUE;
 237 }
 238
 239 void sk_init(void)
 240 {
 241 #ifndef NO_IPV6
 242     winsock2_module =
 243 #endif
 244         winsock_module = LoadLibrary("WS2_32.DLL");
 245     if (!winsock_module) {
 246         winsock_module = LoadLibrary("WSOCK32.DLL");
 247     }
 248     if (!winsock_module)
 249         fatalbox("Unable to load any WinSock library");
 250
 251 #ifndef NO_IPV6
 252     /* Check if we have getaddrinfo in Winsock */
 253     if (GetProcAddress(winsock_module, "getaddrinfo") != NULL) {
 254 #ifdef NET_SETUP_DIAGNOSTICS
 255         logevent(NULL, "Native WinSock IPv6 support detected");
 256 #endif
 257         GET_WINSOCK_FUNCTION(winsock_module, getaddrinfo);
 258         GET_WINSOCK_FUNCTION(winsock_module, freeaddrinfo);
 259         GET_WINSOCK_FUNCTION(winsock_module, getnameinfo);
 260         GET_WINSOCK_FUNCTION(winsock_module, gai_strerror);
 261     } else {
 262         /* Fall back to wship6.dll for Windows 2000 */
 263         wship6_module = LoadLibrary("wship6.dll");
 264         if (wship6_module) {
 265 #ifdef NET_SETUP_DIAGNOSTICS
 266             logevent(NULL, "WSH IPv6 support detected");
 267 #endif
 268             GET_WINSOCK_FUNCTION(wship6_module, getaddrinfo);
 269             GET_WINSOCK_FUNCTION(wship6_module, freeaddrinfo);
 270             GET_WINSOCK_FUNCTION(wship6_module, getnameinfo);
 271             GET_WINSOCK_FUNCTION(wship6_module, gai_strerror);
 272         } else {
 273 #ifdef NET_SETUP_DIAGNOSTICS
 274             logevent(NULL, "No IPv6 support detected");
 275 #endif
 276         }
 277     }
 278     GET_WINSOCK_FUNCTION(winsock2_module, WSAAddressToStringA);
 279 #else
 280 #ifdef NET_SETUP_DIAGNOSTICS
 281     logevent(NULL, "PuTTY was built without IPv6 support");
 282 #endif
 283 #endif
 284
 285     GET_WINSOCK_FUNCTION(winsock_module, WSAAsyncSelect);
 286     GET_WINSOCK_FUNCTION(winsock_module, WSAEventSelect);
 287     GET_WINSOCK_FUNCTION(winsock_module, select);
 288     GET_WINSOCK_FUNCTION(winsock_module, WSAGetLastError);
 289     GET_WINSOCK_FUNCTION(winsock_module, WSAEnumNetworkEvents);
 290     GET_WINSOCK_FUNCTION(winsock_module, WSAStartup);
 291     GET_WINSOCK_FUNCTION(winsock_module, WSACleanup);
 292     GET_WINSOCK_FUNCTION(winsock_module, closesocket);
 293     GET_WINSOCK_FUNCTION(winsock_module, ntohl);
 294     GET_WINSOCK_FUNCTION(winsock_module, htonl);
 295     GET_WINSOCK_FUNCTION(winsock_module, htons);
 296     GET_WINSOCK_FUNCTION(winsock_module, ntohs);
 297     GET_WINSOCK_FUNCTION(winsock_module, gethostbyname);
 298     GET_WINSOCK_FUNCTION(winsock_module, getservbyname);
 299     GET_WINSOCK_FUNCTION(winsock_module, inet_addr);
 300     GET_WINSOCK_FUNCTION(winsock_module, inet_ntoa);
 301     GET_WINSOCK_FUNCTION(winsock_module, connect);
 302     GET_WINSOCK_FUNCTION(winsock_module, bind);
 303     GET_WINSOCK_FUNCTION(winsock_module, setsockopt);
 304     GET_WINSOCK_FUNCTION(winsock_module, socket);
 305     GET_WINSOCK_FUNCTION(winsock_module, listen);
 306     GET_WINSOCK_FUNCTION(winsock_module, send);
 307     GET_WINSOCK_FUNCTION(winsock_module, ioctlsocket);
 308     GET_WINSOCK_FUNCTION(winsock_module, accept);
 309     GET_WINSOCK_FUNCTION(winsock_module, recv);
 310     GET_WINSOCK_FUNCTION(winsock_module, WSAIoctl);
 311
 312     /* Try to get the best WinSock version we can get */
 313     if (!sk_startup(2,2) &&
 314         !sk_startup(2,0) &&
 315         !sk_startup(1,1)) {
 316         fatalbox("Unable to initialise WinSock");
 317     }
 318
 319     sktree = newtree234(cmpfortree);
 320 }
 321
 322 void sk_cleanup(void)
 323 {
 324     Actual_Socket s;
 325     int i;
 326
 327     if (sktree) {
 328         for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
 329             p_closesocket(s->s);
 330         }
 331         freetree234(sktree);
 332         sktree = NULL;
 333     }
 334
 335     p_WSACleanup();
 336     if (winsock_module)
 337         FreeLibrary(winsock_module);
 338 #ifndef NO_IPV6
 339     if (wship6_module)
 340         FreeLibrary(wship6_module);
 341 #endif
 342 }
 343
 344 char *winsock_error_string(int error)
 345 {
 346     switch (error) {
 347       case WSAEACCES:
 348         return "Network error: Permission denied";
 349       case WSAEADDRINUSE:
 350         return "Network error: Address already in use";
 351       case WSAEADDRNOTAVAIL:
 352         return "Network error: Cannot assign requested address";
 353       case WSAEAFNOSUPPORT:
 354         return
 355             "Network error: Address family not supported by protocol family";
 356       case WSAEALREADY:
 357         return "Network error: Operation already in progress";
 358       case WSAECONNABORTED:
 359         return "Network error: Software caused connection abort";
 360       case WSAECONNREFUSED:
 361         return "Network error: Connection refused";
 362       case WSAECONNRESET:
 363         return "Network error: Connection reset by peer";
 364       case WSAEDESTADDRREQ:
 365         return "Network error: Destination address required";
 366       case WSAEFAULT:
 367         return "Network error: Bad address";
 368       case WSAEHOSTDOWN:
 369         return "Network error: Host is down";
 370       case WSAEHOSTUNREACH:
 371         return "Network error: No route to host";
 372       case WSAEINPROGRESS:
 373         return "Network error: Operation now in progress";
 374       case WSAEINTR:
 375         return "Network error: Interrupted function call";
 376       case WSAEINVAL:
 377         return "Network error: Invalid argument";
 378       case WSAEISCONN:
 379         return "Network error: Socket is already connected";
 380       case WSAEMFILE:
 381         return "Network error: Too many open files";
 382       case WSAEMSGSIZE:
 383         return "Network error: Message too long";
 384       case WSAENETDOWN:
 385         return "Network error: Network is down";
 386       case WSAENETRESET:
 387         return "Network error: Network dropped connection on reset";
 388       case WSAENETUNREACH:
 389         return "Network error: Network is unreachable";
 390       case WSAENOBUFS:
 391         return "Network error: No buffer space available";
 392       case WSAENOPROTOOPT:
 393         return "Network error: Bad protocol option";
 394       case WSAENOTCONN:
 395         return "Network error: Socket is not connected";
 396       case WSAENOTSOCK:
 397         return "Network error: Socket operation on non-socket";
 398       case WSAEOPNOTSUPP:
 399         return "Network error: Operation not supported";
 400       case WSAEPFNOSUPPORT:
 401         return "Network error: Protocol family not supported";
 402       case WSAEPROCLIM:
 403         return "Network error: Too many processes";
 404       case WSAEPROTONOSUPPORT:
 405         return "Network error: Protocol not supported";
 406       case WSAEPROTOTYPE:
 407         return "Network error: Protocol wrong type for socket";
 408       case WSAESHUTDOWN:
 409         return "Network error: Cannot send after socket shutdown";
 410       case WSAESOCKTNOSUPPORT:
 411         return "Network error: Socket type not supported";
 412       case WSAETIMEDOUT:
 413         return "Network error: Connection timed out";
 414       case WSAEWOULDBLOCK:
 415         return "Network error: Resource temporarily unavailable";
 416       case WSAEDISCON:
 417         return "Network error: Graceful shutdown in progress";
 418       default:
 419         return "Unknown network error";
 420     }
 421 }
 422
 423 SockAddr sk_namelookup(const char *host, char **canonicalname,
 424                        int address_family)
 425 {
 426     SockAddr ret = snew(struct SockAddr_tag);
 427     unsigned long a;
 428     struct hostent *h = NULL;
 429     char realhost[8192];
 430     int hint_family;
 431     int err;
 432
 433     /* Default to IPv4. */
 434     hint_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
 435 #ifndef NO_IPV6
 436                    address_family == ADDRTYPE_IPV6 ? AF_INET6 :
 437 #endif
 438                    AF_UNSPEC);
 439
 440     /* Clear the structure and default to IPv4. */
 441     memset(ret, 0, sizeof(struct SockAddr_tag));
 442 #ifndef NO_IPV6
 443     ret->ais = NULL;
 444 #endif
 445     ret->addresses = NULL;
 446     ret->resolved = FALSE;
 447     *realhost = '\0';
 448
 449     if ((a = p_inet_addr(host)) == (unsigned long) INADDR_NONE) {
 450 #ifndef NO_IPV6
 451         /*
 452          * Use getaddrinfo when it's available
 453          */
 454         if (p_getaddrinfo) {
 455             struct addrinfo hints;
 456 #ifdef NET_SETUP_DIAGNOSTICS
 457             logevent(NULL, "Using getaddrinfo() for resolving");
 458 #endif
 459             memset(&hints, 0, sizeof(hints));
 460             hints.ai_family = hint_family;
 461             hints.ai_flags = AI_CANONNAME;
 462             if ((err = p_getaddrinfo(host, NULL, &hints, &ret->ais)) == 0)
 463                 ret->resolved = TRUE;
 464         } else
 465 #endif
 466         {
 467 #ifdef NET_SETUP_DIAGNOSTICS
 468             logevent(NULL, "Using gethostbyname() for resolving");
 469 #endif
 470             /*
 471              * Otherwise use the IPv4-only gethostbyname...
 472              * (NOTE: we don't use gethostbyname as a fallback!)
 473              */
 474             if ( (h = p_gethostbyname(host)) )
 475                 ret->resolved = TRUE;
 476             else
 477                 err = p_WSAGetLastError();
 478         }
 479
 480         if (!ret->resolved) {
 481             ret->error = (err == WSAENETDOWN ? "Network is down" :
 482                           err == WSAHOST_NOT_FOUND ? "Host does not exist" :
 483                           err == WSATRY_AGAIN ? "Host not found" :
 484 #ifndef NO_IPV6
 485                           p_getaddrinfo&&p_gai_strerror ? p_gai_strerror(err) :
 486 #endif
 487                           "gethostbyname: unknown error");
 488         } else {
 489             ret->error = NULL;
 490
 491 #ifndef NO_IPV6
 492             /* If we got an address info use that... */
 493             if (ret->ais) {
 494                 /* Are we in IPv4 fallback mode? */
 495                 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
 496                 if (ret->ais->ai_family == AF_INET)
 497                     memcpy(&a,
 498                            (char *) &((SOCKADDR_IN *) ret->ais->
 499                                       ai_addr)->sin_addr, sizeof(a));
 500
 501                 if (ret->ais->ai_canonname)
 502                     strncpy(realhost, ret->ais->ai_canonname, lenof(realhost));
 503                 else
 504                     strncpy(realhost, host, lenof(realhost));
 505             }
 506             /* We used the IPv4-only gethostbyname()... */
 507             else
 508 #endif
 509             {
 510                 int n;
 511                 for (n = 0; h->h_addr_list[n]; n++);
 512                 ret->addresses = snewn(n, unsigned long);
 513                 ret->naddresses = n;
 514                 for (n = 0; n < ret->naddresses; n++) {
 515                     memcpy(&a, h->h_addr_list[n], sizeof(a));
 516                     ret->addresses[n] = p_ntohl(a);
 517                 }
 518                 memcpy(&a, h->h_addr, sizeof(a));
 519                 /* This way we are always sure the h->h_name is valid :) */
 520                 strncpy(realhost, h->h_name, sizeof(realhost));
 521             }
 522         }
 523     } else {
 524         /*
 525          * This must be a numeric IPv4 address because it caused a
 526          * success return from inet_addr.
 527          */
 528         ret->addresses = snewn(1, unsigned long);
 529         ret->naddresses = 1;
 530         ret->addresses[0] = p_ntohl(a);
 531         ret->resolved = TRUE;
 532         strncpy(realhost, host, sizeof(realhost));
 533     }
 534     realhost[lenof(realhost)-1] = '\0';
 535     *canonicalname = snewn(1+strlen(realhost), char);
 536     strcpy(*canonicalname, realhost);
 537     return ret;
 538 }
 539
 540 SockAddr sk_nonamelookup(const char *host)
 541 {
 542     SockAddr ret = snew(struct SockAddr_tag);
 543     ret->error = NULL;
 544     ret->resolved = FALSE;
 545 #ifndef NO_IPV6
 546     ret->ais = NULL;
 547 #endif
 548     ret->addresses = NULL;
 549     ret->naddresses = 0;
 550     strncpy(ret->hostname, host, lenof(ret->hostname));
 551     ret->hostname[lenof(ret->hostname)-1] = '\0';
 552     return ret;
 553 }
 554
 555 int sk_nextaddr(SockAddr addr, SockAddrStep *step)
 556 {
 557 #ifndef NO_IPV6
 558     if (step->ai) {
 559         if (step->ai->ai_next) {
 560             step->ai = step->ai->ai_next;
 561             return TRUE;
 562         } else
 563             return FALSE;
 564     }
 565 #endif
 566     if (step->curraddr+1 < addr->naddresses) {
 567         step->curraddr++;
 568         return TRUE;
 569     } else {
 570         return FALSE;
 571     }
 572 }
 573
 574 void sk_getaddr(SockAddr addr, char *buf, int buflen)
 575 {
 576     SockAddrStep step;
 577     START_STEP(addr, step);
 578
 579 #ifndef NO_IPV6
 580     if (step.ai) {
 581         if (p_WSAAddressToStringA) {
 582             p_WSAAddressToStringA(step.ai->ai_addr, step.ai->ai_addrlen,
 583                                   NULL, buf, &buflen);
 584         } else
 585             strncpy(buf, "IPv6", buflen);
 586     } else
 587 #endif
 588     if (SOCKADDR_FAMILY(addr, step) == AF_INET) {
 589         struct in_addr a;
 590         assert(addr->addresses && step.curraddr < addr->naddresses);
 591         a.s_addr = p_htonl(addr->addresses[step.curraddr]);
 592         strncpy(buf, p_inet_ntoa(a), buflen);
 593         buf[buflen-1] = '\0';
 594     } else {
 595         strncpy(buf, addr->hostname, buflen);
 596         buf[buflen-1] = '\0';
 597     }
 598 }
 599
 600 int sk_hostname_is_local(char *name)
 601 {
 602     return !strcmp(name, "localhost");
 603 }
 604
 605 static INTERFACE_INFO local_interfaces[16];
 606 static int n_local_interfaces;       /* 0=not yet, -1=failed, >0=number */
 607
 608 static int ipv4_is_local_addr(struct in_addr addr)
 609 {
 610     if (ipv4_is_loopback(addr))
 611         return 1;                      /* loopback addresses are local */
 612     if (!n_local_interfaces) {
 613         SOCKET s = p_socket(AF_INET, SOCK_DGRAM, 0);
 614         DWORD retbytes;
 615
 616         if (p_WSAIoctl &&
 617             p_WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0,
 618                        local_interfaces, sizeof(local_interfaces),
 619                        &retbytes, NULL, NULL) == 0)
 620             n_local_interfaces = retbytes / sizeof(INTERFACE_INFO);
 621         else
 622             logevent(NULL, "Unable to get list of local IP addresses");
 623     }
 624     if (n_local_interfaces > 0) {
 625         int i;
 626         for (i = 0; i < n_local_interfaces; i++) {
 627             SOCKADDR_IN *address =
 628                 (SOCKADDR_IN *)&local_interfaces[i].iiAddress;
 629             if (address->sin_addr.s_addr == addr.s_addr)
 630                 return 1;              /* this address is local */
 631         }
 632     }
 633     return 0;                  /* this address is not local */
 634 }
 635
 636 int sk_address_is_local(SockAddr addr)
 637 {
 638     SockAddrStep step;
 639     int family;
 640     START_STEP(addr, step);
 641     family = SOCKADDR_FAMILY(addr, step);
 642
 643 #ifndef NO_IPV6
 644     if (family == AF_INET6) {
 645         return IN6_IS_ADDR_LOOPBACK((const struct in6_addr *)step.ai->ai_addr);
 646     } else
 647 #endif
 648     if (family == AF_INET) {
 649 #ifndef NO_IPV6
 650         if (step.ai) {
 651             return ipv4_is_local_addr(((struct sockaddr_in *)step.ai->ai_addr)
 652                                       ->sin_addr);
 653         } else
 654 #endif
 655         {
 656             struct in_addr a;
 657             assert(addr->addresses && step.curraddr < addr->naddresses);
 658             a.s_addr = p_htonl(addr->addresses[step.curraddr]);
 659             return ipv4_is_local_addr(a);
 660         }
 661     } else {
 662         assert(family == AF_UNSPEC);
 663         return 0;                      /* we don't know; assume not */
 664     }
 665 }
 666
 667 int sk_addrtype(SockAddr addr)
 668 {
 669     SockAddrStep step;
 670     int family;
 671     START_STEP(addr, step);
 672     family = SOCKADDR_FAMILY(addr, step);
 673
 674     return (family == AF_INET ? ADDRTYPE_IPV4 :
 675 #ifndef NO_IPV6
 676             family == AF_INET6 ? ADDRTYPE_IPV6 :
 677 #endif
 678             ADDRTYPE_NAME);
 679 }
 680
 681 void sk_addrcopy(SockAddr addr, char *buf)
 682 {
 683     SockAddrStep step;
 684     int family;
 685     START_STEP(addr, step);
 686     family = SOCKADDR_FAMILY(addr, step);
 687
 688     assert(family != AF_UNSPEC);
 689 #ifndef NO_IPV6
 690     if (step.ai) {
 691         if (family == AF_INET)
 692             memcpy(buf, &((struct sockaddr_in *)step.ai->ai_addr)->sin_addr,
 693                    sizeof(struct in_addr));
 694         else if (family == AF_INET6)
 695             memcpy(buf, &((struct sockaddr_in6 *)step.ai->ai_addr)->sin6_addr,
 696                    sizeof(struct in6_addr));
 697         else
 698             assert(FALSE);
 699     } else
 700 #endif
 701     if (family == AF_INET) {
 702         struct in_addr a;
 703         assert(addr->addresses && step.curraddr < addr->naddresses);
 704         a.s_addr = p_htonl(addr->addresses[step.curraddr]);
 705         memcpy(buf, (char*) &a.s_addr, 4);
 706     }
 707 }
 708
 709 void sk_addr_free(SockAddr addr)
 710 {
 711 #ifndef NO_IPV6
 712     if (addr->ais && p_freeaddrinfo)
 713         p_freeaddrinfo(addr->ais);
 714 #endif
 715     if (addr->addresses)
 716         sfree(addr->addresses);
 717     sfree(addr);
 718 }
 719
 720 static Plug sk_tcp_plug(Socket sock, Plug p)
 721 {
 722     Actual_Socket s = (Actual_Socket) sock;
 723     Plug ret = s->plug;
 724     if (p)
 725         s->plug = p;
 726     return ret;
 727 }
 728
 729 static void sk_tcp_flush(Socket s)
 730 {
 731     /*
 732      * We send data to the socket as soon as we can anyway,
 733      * so we don't need to do anything here.  :-)
 734      */
 735 }
 736
 737 static void sk_tcp_close(Socket s);
 738 static int sk_tcp_write(Socket s, const char *data, int len);
 739 static int sk_tcp_write_oob(Socket s, const char *data, int len);
 740 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
 741 static void *sk_tcp_get_private_ptr(Socket s);
 742 static void sk_tcp_set_frozen(Socket s, int is_frozen);
 743 static const char *sk_tcp_socket_error(Socket s);
 744
 745 extern char *do_select(SOCKET skt, int startup);
 746
 747 Socket sk_register(void *sock, Plug plug)
 748 {
 749     static const struct socket_function_table fn_table = {
 750         sk_tcp_plug,
 751         sk_tcp_close,
 752         sk_tcp_write,
 753         sk_tcp_write_oob,
 754         sk_tcp_flush,
 755         sk_tcp_set_private_ptr,
 756         sk_tcp_get_private_ptr,
 757         sk_tcp_set_frozen,
 758         sk_tcp_socket_error
 759     };
 760
 761     DWORD err;
 762     char *errstr;
 763     Actual_Socket ret;
 764
 765     /*
 766      * Create Socket structure.
 767      */
 768     ret = snew(struct Socket_tag);
 769     ret->fn = &fn_table;
 770     ret->error = NULL;
 771     ret->plug = plug;
 772     bufchain_init(&ret->output_data);
 773     ret->writable = 1;                 /* to start with */
 774     ret->sending_oob = 0;
 775     ret->frozen = 1;
 776     ret->frozen_readable = 0;
 777     ret->localhost_only = 0;           /* unused, but best init anyway */
 778     ret->pending_error = 0;
 779     ret->parent = ret->child = NULL;
 780     ret->addr = NULL;
 781
 782     ret->s = (SOCKET)sock;
 783
 784     if (ret->s == INVALID_SOCKET) {
 785         err = p_WSAGetLastError();
 786         ret->error = winsock_error_string(err);
 787         return (Socket) ret;
 788     }
 789
 790     ret->oobinline = 0;
 791
 792     /* Set up a select mechanism. This could be an AsyncSelect on a
 793      * window, or an EventSelect on an event object. */
 794     errstr = do_select(ret->s, 1);
 795     if (errstr) {
 796         ret->error = errstr;
 797         return (Socket) ret;
 798     }
 799
 800     add234(sktree, ret);
 801
 802     return (Socket) ret;
 803 }
 804
 805 static DWORD try_connect(Actual_Socket sock)
 806 {
 807     SOCKET s;
 808 #ifndef NO_IPV6
 809     SOCKADDR_IN6 a6;
 810 #endif
 811     SOCKADDR_IN a;
 812     DWORD err;
 813     char *errstr;
 814     short localport;
 815     int family;
 816
 817     if (sock->s != INVALID_SOCKET) {
 818         do_select(sock->s, 0);
 819         p_closesocket(sock->s);
 820     }
 821
 822     plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
 823
 824     /*
 825      * Open socket.
 826      */
 827     family = SOCKADDR_FAMILY(sock->addr, sock->step);
 828
 829     /*
 830      * Remove the socket from the tree before we overwrite its
 831      * internal socket id, because that forms part of the tree's
 832      * sorting criterion. We'll add it back before exiting this
 833      * function, whether we changed anything or not.
 834      */
 835     del234(sktree, sock);
 836
 837     s = p_socket(family, SOCK_STREAM, 0);
 838     sock->s = s;
 839
 840     if (s == INVALID_SOCKET) {
 841         err = p_WSAGetLastError();
 842         sock->error = winsock_error_string(err);
 843         goto ret;
 844     }
 845
 846     if (sock->oobinline) {
 847         BOOL b = TRUE;
 848         p_setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
 849     }
 850
 851     if (sock->nodelay) {
 852         BOOL b = TRUE;
 853         p_setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
 854     }
 855
 856     if (sock->keepalive) {
 857         BOOL b = TRUE;
 858         p_setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
 859     }
 860
 861     /*
 862      * Bind to local address.
 863      */
 864     if (sock->privport)
 865         localport = 1023;              /* count from 1023 downwards */
 866     else
 867         localport = 0;                 /* just use port 0 (ie winsock picks) */
 868
 869     /* Loop round trying to bind */
 870     while (1) {
 871         int sockcode;
 872
 873 #ifndef NO_IPV6
 874         if (family == AF_INET6) {
 875             memset(&a6, 0, sizeof(a6));
 876             a6.sin6_family = AF_INET6;
 877           /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
 878             a6.sin6_port = p_htons(localport);
 879         } else
 880 #endif
 881         {
 882             a.sin_family = AF_INET;
 883             a.sin_addr.s_addr = p_htonl(INADDR_ANY);
 884             a.sin_port = p_htons(localport);
 885         }
 886 #ifndef NO_IPV6
 887         sockcode = p_bind(s, (family == AF_INET6 ?
 888                               (struct sockaddr *) &a6 :
 889                               (struct sockaddr *) &a),
 890                           (family == AF_INET6 ? sizeof(a6) : sizeof(a)));
 891 #else
 892         sockcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
 893 #endif
 894         if (sockcode != SOCKET_ERROR) {
 895             err = 0;
 896             break;                     /* done */
 897         } else {
 898             err = p_WSAGetLastError();
 899             if (err != WSAEADDRINUSE)  /* failed, for a bad reason */
 900                 break;
 901         }
 902
 903         if (localport == 0)
 904             break;                     /* we're only looping once */
 905         localport--;
 906         if (localport == 0)
 907             break;                     /* we might have got to the end */
 908     }
 909
 910     if (err) {
 911         sock->error = winsock_error_string(err);
 912         goto ret;
 913     }
 914
 915     /*
 916      * Connect to remote address.
 917      */
 918 #ifndef NO_IPV6
 919     if (sock->step.ai) {
 920         if (family == AF_INET6) {
 921             a6.sin6_family = AF_INET6;
 922             a6.sin6_port = p_htons((short) sock->port);
 923             a6.sin6_addr =
 924                 ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_addr;
 925             a6.sin6_flowinfo = ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_flowinfo;
 926             a6.sin6_scope_id = ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_scope_id;
 927         } else {
 928             a.sin_family = AF_INET;
 929             a.sin_addr =
 930                 ((struct sockaddr_in *) sock->step.ai->ai_addr)->sin_addr;
 931             a.sin_port = p_htons((short) sock->port);
 932         }
 933     } else
 934 #endif
 935     {
 936         assert(sock->addr->addresses && sock->step.curraddr < sock->addr->naddresses);
 937         a.sin_family = AF_INET;
 938         a.sin_addr.s_addr = p_htonl(sock->addr->addresses[sock->step.curraddr]);
 939         a.sin_port = p_htons((short) sock->port);
 940     }
 941
 942     /* Set up a select mechanism. This could be an AsyncSelect on a
 943      * window, or an EventSelect on an event object. */
 944     errstr = do_select(s, 1);
 945     if (errstr) {
 946         sock->error = errstr;
 947         err = 1;
 948         goto ret;
 949     }
 950
 951     if ((
 952 #ifndef NO_IPV6
 953             p_connect(s,
 954                       ((family == AF_INET6) ? (struct sockaddr *) &a6 :
 955                        (struct sockaddr *) &a),
 956                       (family == AF_INET6) ? sizeof(a6) : sizeof(a))
 957 #else
 958             p_connect(s, (struct sockaddr *) &a, sizeof(a))
 959 #endif
 960         ) == SOCKET_ERROR) {
 961         err = p_WSAGetLastError();
 962         /*
 963          * We expect a potential EWOULDBLOCK here, because the
 964          * chances are the front end has done a select for
 965          * FD_CONNECT, so that connect() will complete
 966          * asynchronously.
 967          */
 968         if ( err != WSAEWOULDBLOCK ) {
 969             sock->error = winsock_error_string(err);
 970             goto ret;
 971         }
 972     } else {
 973         /*
 974          * If we _don't_ get EWOULDBLOCK, the connect has completed
 975          * and we should set the socket as writable.
 976          */
 977         sock->writable = 1;
 978     }
 979
 980     err = 0;
 981
 982     ret:
 983
 984     /*
 985      * No matter what happened, put the socket back in the tree.
 986      */
 987     add234(sktree, sock);
 988
 989     if (err)
 990         plug_log(sock->plug, 1, sock->addr, sock->port, sock->error, err);
 991     return err;
 992 }
 993
 994 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
 995               int nodelay, int keepalive, Plug plug)
 996 {
 997     static const struct socket_function_table fn_table = {
 998         sk_tcp_plug,
 999         sk_tcp_close,
1000         sk_tcp_write,
1001         sk_tcp_write_oob,
1002         sk_tcp_flush,
1003         sk_tcp_set_private_ptr,
1004         sk_tcp_get_private_ptr,
1005         sk_tcp_set_frozen,
1006         sk_tcp_socket_error
1007     };
1008
1009     Actual_Socket ret;
1010     DWORD err;
1011
1012     /*
1013      * Create Socket structure.
1014      */
1015     ret = snew(struct Socket_tag);
1016     ret->fn = &fn_table;
1017     ret->error = NULL;
1018     ret->plug = plug;
1019     bufchain_init(&ret->output_data);
1020     ret->connected = 0;                /* to start with */
1021     ret->writable = 0;                 /* to start with */
1022     ret->sending_oob = 0;
1023     ret->frozen = 0;
1024     ret->frozen_readable = 0;
1025     ret->localhost_only = 0;           /* unused, but best init anyway */
1026     ret->pending_error = 0;
1027     ret->parent = ret->child = NULL;
1028     ret->oobinline = oobinline;
1029     ret->nodelay = nodelay;
1030     ret->keepalive = keepalive;
1031     ret->privport = privport;
1032     ret->port = port;
1033     ret->addr = addr;
1034     START_STEP(ret->addr, ret->step);
1035     ret->s = INVALID_SOCKET;
1036
1037     err = 0;
1038     do {
1039         err = try_connect(ret);
1040     } while (err && sk_nextaddr(ret->addr, &ret->step));
1041
1042     return (Socket) ret;
1043 }
1044
1045 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only,
1046                       int orig_address_family)
1047 {
1048     static const struct socket_function_table fn_table = {
1049         sk_tcp_plug,
1050         sk_tcp_close,
1051         sk_tcp_write,
1052         sk_tcp_write_oob,
1053         sk_tcp_flush,
1054         sk_tcp_set_private_ptr,
1055         sk_tcp_get_private_ptr,
1056         sk_tcp_set_frozen,
1057         sk_tcp_socket_error
1058     };
1059
1060     SOCKET s;
1061 #ifndef NO_IPV6
1062     SOCKADDR_IN6 a6;
1063 #endif
1064     SOCKADDR_IN a;
1065
1066     DWORD err;
1067     char *errstr;
1068     Actual_Socket ret;
1069     int retcode;
1070     int on = 1;
1071
1072     int address_family;
1073
1074     /*
1075      * Create Socket structure.
1076      */
1077     ret = snew(struct Socket_tag);
1078     ret->fn = &fn_table;
1079     ret->error = NULL;
1080     ret->plug = plug;
1081     bufchain_init(&ret->output_data);
1082     ret->writable = 0;                 /* to start with */
1083     ret->sending_oob = 0;
1084     ret->frozen = 0;
1085     ret->frozen_readable = 0;
1086     ret->localhost_only = local_host_only;
1087     ret->pending_error = 0;
1088     ret->parent = ret->child = NULL;
1089     ret->addr = NULL;
1090
1091     /*
1092      * Translate address_family from platform-independent constants
1093      * into local reality.
1094      */
1095     address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
1096 #ifndef NO_IPV6
1097                       orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
1098 #endif
1099                       AF_UNSPEC);
1100
1101     /*
1102      * Our default, if passed the `don't care' value
1103      * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1104      * we will also set up a second socket listening on IPv6, but
1105      * the v4 one is primary since that ought to work even on
1106      * non-v6-supporting systems.
1107      */
1108     if (address_family == AF_UNSPEC) address_family = AF_INET;
1109
1110     /*
1111      * Open socket.
1112      */
1113     s = p_socket(address_family, SOCK_STREAM, 0);
1114     ret->s = s;
1115
1116     if (s == INVALID_SOCKET) {
1117         err = p_WSAGetLastError();
1118         ret->error = winsock_error_string(err);
1119         return (Socket) ret;
1120     }
1121
1122     ret->oobinline = 0;
1123
1124     p_setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
1125
1126 #ifndef NO_IPV6
1127         if (address_family == AF_INET6) {
1128             memset(&a6, 0, sizeof(a6));
1129             a6.sin6_family = AF_INET6;
1130             /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1131              * know how to do it. :-)
1132              * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1133              * Thus we need either a parser that understands [2001:db8::1]:80
1134              * style addresses and/or enhance this to understand hostnames too. */
1135             if (local_host_only)
1136                 a6.sin6_addr = in6addr_loopback;
1137             else
1138                 a6.sin6_addr = in6addr_any;
1139             a6.sin6_port = p_htons(port);
1140         } else
1141 #endif
1142         {
1143             int got_addr = 0;
1144             a.sin_family = AF_INET;
1145
1146             /*
1147              * Bind to source address. First try an explicitly
1148              * specified one...
1149              */
1150             if (srcaddr) {
1151                 a.sin_addr.s_addr = p_inet_addr(srcaddr);
1152                 if (a.sin_addr.s_addr != INADDR_NONE) {
1153                     /* Override localhost_only with specified listen addr. */
1154                     ret->localhost_only = ipv4_is_loopback(a.sin_addr);
1155                     got_addr = 1;
1156                 }
1157             }
1158
1159             /*
1160              * ... and failing that, go with one of the standard ones.
1161              */
1162             if (!got_addr) {
1163                 if (local_host_only)
1164                     a.sin_addr.s_addr = p_htonl(INADDR_LOOPBACK);
1165                 else
1166                     a.sin_addr.s_addr = p_htonl(INADDR_ANY);
1167             }
1168
1169             a.sin_port = p_htons((short)port);
1170         }
1171 #ifndef NO_IPV6
1172         retcode = p_bind(s, (address_family == AF_INET6 ?
1173                            (struct sockaddr *) &a6 :
1174                            (struct sockaddr *) &a),
1175                        (address_family ==
1176                         AF_INET6 ? sizeof(a6) : sizeof(a)));
1177 #else
1178         retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
1179 #endif
1180         if (retcode != SOCKET_ERROR) {
1181             err = 0;
1182         } else {
1183             err = p_WSAGetLastError();
1184         }
1185
1186     if (err) {
1187         p_closesocket(s);
1188         ret->error = winsock_error_string(err);
1189         return (Socket) ret;
1190     }
1191
1192
1193     if (p_listen(s, SOMAXCONN) == SOCKET_ERROR) {
1194         p_closesocket(s);
1195         ret->error = winsock_error_string(err);
1196         return (Socket) ret;
1197     }
1198
1199     /* Set up a select mechanism. This could be an AsyncSelect on a
1200      * window, or an EventSelect on an event object. */
1201     errstr = do_select(s, 1);
1202     if (errstr) {
1203         p_closesocket(s);
1204         ret->error = errstr;
1205         return (Socket) ret;
1206     }
1207
1208     add234(sktree, ret);
1209
1210 #ifndef NO_IPV6
1211     /*
1212      * If we were given ADDRTYPE_UNSPEC, we must also create an
1213      * IPv6 listening socket and link it to this one.
1214      */
1215     if (address_family == AF_INET && orig_address_family == ADDRTYPE_UNSPEC) {
1216         Actual_Socket other;
1217
1218         other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
1219                                                local_host_only, ADDRTYPE_IPV6);
1220
1221         if (other) {
1222             if (!other->error) {
1223                 other->parent = ret;
1224                 ret->child = other;
1225             } else {
1226                 sfree(other);
1227             }
1228         }
1229     }
1230 #endif
1231
1232     return (Socket) ret;
1233 }
1234
1235 static void sk_tcp_close(Socket sock)
1236 {
1237     extern char *do_select(SOCKET skt, int startup);
1238     Actual_Socket s = (Actual_Socket) sock;
1239
1240     if (s->child)
1241         sk_tcp_close((Socket)s->child);
1242
1243     del234(sktree, s);
1244     do_select(s->s, 0);
1245     p_closesocket(s->s);
1246     if (s->addr)
1247         sk_addr_free(s->addr);
1248     sfree(s);
1249 }
1250
1251 /*
1252  * The function which tries to send on a socket once it's deemed
1253  * writable.
1254  */
1255 void try_send(Actual_Socket s)
1256 {
1257     while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1258         int nsent;
1259         DWORD err;
1260         void *data;
1261         int len, urgentflag;
1262
1263         if (s->sending_oob) {
1264             urgentflag = MSG_OOB;
1265             len = s->sending_oob;
1266             data = &s->oobdata;
1267         } else {
1268             urgentflag = 0;
1269             bufchain_prefix(&s->output_data, &data, &len);
1270         }
1271         nsent = p_send(s->s, data, len, urgentflag);
1272         noise_ultralight(nsent);
1273         if (nsent <= 0) {
1274             err = (nsent < 0 ? p_WSAGetLastError() : 0);
1275             if ((err < WSABASEERR && nsent < 0) || err == WSAEWOULDBLOCK) {
1276                 /*
1277                  * Perfectly normal: we've sent all we can for the moment.
1278                  *
1279                  * (Some WinSock send() implementations can return
1280                  * <0 but leave no sensible error indication -
1281                  * WSAGetLastError() is called but returns zero or
1282                  * a small number - so we check that case and treat
1283                  * it just like WSAEWOULDBLOCK.)
1284                  */
1285                 s->writable = FALSE;
1286                 return;
1287             } else if (nsent == 0 ||
1288                        err == WSAECONNABORTED || err == WSAECONNRESET) {
1289                 /*
1290                  * If send() returns CONNABORTED or CONNRESET, we
1291                  * unfortunately can't just call plug_closing(),
1292                  * because it's quite likely that we're currently
1293                  * _in_ a call from the code we'd be calling back
1294                  * to, so we'd have to make half the SSH code
1295                  * reentrant. Instead we flag a pending error on
1296                  * the socket, to be dealt with (by calling
1297                  * plug_closing()) at some suitable future moment.
1298                  */
1299                 s->pending_error = err;
1300                 return;
1301             } else {
1302                 /* We're inside the Windows frontend here, so we know
1303                  * that the frontend handle is unnecessary. */
1304                 logevent(NULL, winsock_error_string(err));
1305                 fatalbox("%s", winsock_error_string(err));
1306             }
1307         } else {
1308             if (s->sending_oob) {
1309                 if (nsent < len) {
1310                     memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1311                     s->sending_oob = len - nsent;
1312                 } else {
1313                     s->sending_oob = 0;
1314                 }
1315             } else {
1316                 bufchain_consume(&s->output_data, nsent);
1317             }
1318         }
1319     }
1320 }
1321
1322 static int sk_tcp_write(Socket sock, const char *buf, int len)
1323 {
1324     Actual_Socket s = (Actual_Socket) sock;
1325
1326     /*
1327      * Add the data to the buffer list on the socket.
1328      */
1329     bufchain_add(&s->output_data, buf, len);
1330
1331     /*
1332      * Now try sending from the start of the buffer list.
1333      */
1334     if (s->writable)
1335         try_send(s);
1336
1337     return bufchain_size(&s->output_data);
1338 }
1339
1340 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1341 {
1342     Actual_Socket s = (Actual_Socket) sock;
1343
1344     /*
1345      * Replace the buffer list on the socket with the data.
1346      */
1347     bufchain_clear(&s->output_data);
1348     assert(len <= sizeof(s->oobdata));
1349     memcpy(s->oobdata, buf, len);
1350     s->sending_oob = len;
1351
1352     /*
1353      * Now try sending from the start of the buffer list.
1354      */
1355     if (s->writable)
1356         try_send(s);
1357
1358     return s->sending_oob;
1359 }
1360
1361 int select_result(WPARAM wParam, LPARAM lParam)
1362 {
1363     int ret, open;
1364     DWORD err;
1365     char buf[20480];                   /* nice big buffer for plenty of speed */
1366     Actual_Socket s;
1367     u_long atmark;
1368
1369     /* wParam is the socket itself */
1370
1371     if (wParam == 0)
1372         return 1;                      /* boggle */
1373
1374     s = find234(sktree, (void *) wParam, cmpforsearch);
1375     if (!s)
1376         return 1;                      /* boggle */
1377
1378     if ((err = WSAGETSELECTERROR(lParam)) != 0) {
1379         /*
1380          * An error has occurred on this socket. Pass it to the
1381          * plug.
1382          */
1383         if (s->addr) {
1384             plug_log(s->plug, 1, s->addr, s->port,
1385                      winsock_error_string(err), err);
1386             while (s->addr && sk_nextaddr(s->addr, &s->step)) {
1387                 err = try_connect(s);
1388             }
1389         }
1390         if (err != 0)
1391             return plug_closing(s->plug, winsock_error_string(err), err, 0);
1392         else
1393             return 1;
1394     }
1395
1396     noise_ultralight(lParam);
1397
1398     switch (WSAGETSELECTEVENT(lParam)) {
1399       case FD_CONNECT:
1400         s->connected = s->writable = 1;
1401         /*
1402          * Once a socket is connected, we can stop falling
1403          * back through the candidate addresses to connect
1404          * to.
1405          */
1406         if (s->addr) {
1407             sk_addr_free(s->addr);
1408             s->addr = NULL;
1409         }
1410         break;
1411       case FD_READ:
1412         /* In the case the socket is still frozen, we don't even bother */
1413         if (s->frozen) {
1414             s->frozen_readable = 1;
1415             break;
1416         }
1417
1418         /*
1419          * We have received data on the socket. For an oobinline
1420          * socket, this might be data _before_ an urgent pointer,
1421          * in which case we send it to the back end with type==1
1422          * (data prior to urgent).
1423          */
1424         if (s->oobinline) {
1425             atmark = 1;
1426             p_ioctlsocket(s->s, SIOCATMARK, &atmark);
1427             /*
1428              * Avoid checking the return value from ioctlsocket(),
1429              * on the grounds that some WinSock wrappers don't
1430              * support it. If it does nothing, we get atmark==1,
1431              * which is equivalent to `no OOB pending', so the
1432              * effect will be to non-OOB-ify any OOB data.
1433              */
1434         } else
1435             atmark = 1;
1436
1437         ret = p_recv(s->s, buf, sizeof(buf), 0);
1438         noise_ultralight(ret);
1439         if (ret < 0) {
1440             err = p_WSAGetLastError();
1441             if (err == WSAEWOULDBLOCK) {
1442                 break;
1443             }
1444         }
1445         if (ret < 0) {
1446             return plug_closing(s->plug, winsock_error_string(err), err,
1447                                 0);
1448         } else if (0 == ret) {
1449             return plug_closing(s->plug, NULL, 0, 0);
1450         } else {
1451             return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1452         }
1453         break;
1454       case FD_OOB:
1455         /*
1456          * This will only happen on a non-oobinline socket. It
1457          * indicates that we can immediately perform an OOB read
1458          * and get back OOB data, which we will send to the back
1459          * end with type==2 (urgent data).
1460          */
1461         ret = p_recv(s->s, buf, sizeof(buf), MSG_OOB);
1462         noise_ultralight(ret);
1463         if (ret <= 0) {
1464             char *str = (ret == 0 ? "Internal networking trouble" :
1465                          winsock_error_string(p_WSAGetLastError()));
1466             /* We're inside the Windows frontend here, so we know
1467              * that the frontend handle is unnecessary. */
1468             logevent(NULL, str);
1469             fatalbox("%s", str);
1470         } else {
1471             return plug_receive(s->plug, 2, buf, ret);
1472         }
1473         break;
1474       case FD_WRITE:
1475         {
1476             int bufsize_before, bufsize_after;
1477             s->writable = 1;
1478             bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1479             try_send(s);
1480             bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1481             if (bufsize_after < bufsize_before)
1482                 plug_sent(s->plug, bufsize_after);
1483         }
1484         break;
1485       case FD_CLOSE:
1486         /* Signal a close on the socket. First read any outstanding data. */
1487         open = 1;
1488         do {
1489             ret = p_recv(s->s, buf, sizeof(buf), 0);
1490             if (ret < 0) {
1491                 err = p_WSAGetLastError();
1492                 if (err == WSAEWOULDBLOCK)
1493                     break;
1494                 return plug_closing(s->plug, winsock_error_string(err),
1495                                     err, 0);
1496             } else {
1497                 if (ret)
1498                     open &= plug_receive(s->plug, 0, buf, ret);
1499                 else
1500                     open &= plug_closing(s->plug, NULL, 0, 0);
1501             }
1502         } while (ret > 0);
1503         return open;
1504        case FD_ACCEPT:
1505         {
1506 #ifdef NO_IPV6
1507             struct sockaddr_in isa;
1508 #else
1509             struct sockaddr_storage isa;
1510 #endif
1511             int addrlen = sizeof(isa);
1512             SOCKET t;  /* socket of connection */
1513
1514             memset(&isa, 0, sizeof(isa));
1515             err = 0;
1516             t = p_accept(s->s,(struct sockaddr *)&isa,&addrlen);
1517             if (t == INVALID_SOCKET)
1518             {
1519                 err = p_WSAGetLastError();
1520                 if (err == WSATRY_AGAIN)
1521                     break;
1522             }
1523 #ifndef NO_IPV6
1524             if (isa.ss_family == AF_INET &&
1525                 s->localhost_only &&
1526                 !ipv4_is_local_addr(((struct sockaddr_in *)&isa)->sin_addr))
1527 #else
1528             if (s->localhost_only && !ipv4_is_local_addr(isa.sin_addr))
1529 #endif
1530             {
1531                 p_closesocket(t);      /* dodgy WinSock let nonlocal through */
1532             } else if (plug_accepting(s->plug, (void*)t)) {
1533                 p_closesocket(t);      /* denied or error */
1534             }
1535         }
1536     }
1537
1538     return 1;
1539 }
1540
1541 /*
1542  * Deal with socket errors detected in try_send().
1543  */
1544 void net_pending_errors(void)
1545 {
1546     int i;
1547     Actual_Socket s;
1548
1549     /*
1550      * This might be a fiddly business, because it's just possible
1551      * that handling a pending error on one socket might cause
1552      * others to be closed. (I can't think of any reason this might
1553      * happen in current SSH implementation, but to maintain
1554      * generality of this network layer I'll assume the worst.)
1555      *
1556      * So what we'll do is search the socket list for _one_ socket
1557      * with a pending error, and then handle it, and then search
1558      * the list again _from the beginning_. Repeat until we make a
1559      * pass with no socket errors present. That way we are
1560      * protected against the socket list changing under our feet.
1561      */
1562
1563     do {
1564         for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1565             if (s->pending_error) {
1566                 /*
1567                  * An error has occurred on this socket. Pass it to the
1568                  * plug.
1569                  */
1570                 plug_closing(s->plug,
1571                              winsock_error_string(s->pending_error),
1572                              s->pending_error, 0);
1573                 break;
1574             }
1575         }
1576     } while (s);
1577 }
1578
1579 /*
1580  * Each socket abstraction contains a `void *' private field in
1581  * which the client can keep state.
1582  */
1583 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1584 {
1585     Actual_Socket s = (Actual_Socket) sock;
1586     s->private_ptr = ptr;
1587 }
1588
1589 static void *sk_tcp_get_private_ptr(Socket sock)
1590 {
1591     Actual_Socket s = (Actual_Socket) sock;
1592     return s->private_ptr;
1593 }
1594
1595 /*
1596  * Special error values are returned from sk_namelookup and sk_new
1597  * if there's a problem. These functions extract an error message,
1598  * or return NULL if there's no problem.
1599  */
1600 const char *sk_addr_error(SockAddr addr)
1601 {
1602     return addr->error;
1603 }
1604 static const char *sk_tcp_socket_error(Socket sock)
1605 {
1606     Actual_Socket s = (Actual_Socket) sock;
1607     return s->error;
1608 }
1609
1610 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1611 {
1612     Actual_Socket s = (Actual_Socket) sock;
1613     if (s->frozen == is_frozen)
1614         return;
1615     s->frozen = is_frozen;
1616     if (!is_frozen) {
1617         do_select(s->s, 1);
1618         if (s->frozen_readable) {
1619             char c;
1620             p_recv(s->s, &c, 1, MSG_PEEK);
1621         }
1622     }
1623     s->frozen_readable = 0;
1624 }
1625
1626 void socket_reselect_all(void)
1627 {
1628     Actual_Socket s;
1629     int i;
1630
1631     for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1632         if (!s->frozen)
1633             do_select(s->s, 1);
1634     }
1635 }
1636
1637 /*
1638  * For Plink: enumerate all sockets currently active.
1639  */
1640 SOCKET first_socket(int *state)
1641 {
1642     Actual_Socket s;
1643     *state = 0;
1644     s = index234(sktree, (*state)++);
1645     return s ? s->s : INVALID_SOCKET;
1646 }
1647
1648 SOCKET next_socket(int *state)
1649 {
1650     Actual_Socket s = index234(sktree, (*state)++);
1651     return s ? s->s : INVALID_SOCKET;
1652 }
1653
1654 extern int socket_writable(SOCKET skt)
1655 {
1656     Actual_Socket s = find234(sktree, (void *)skt, cmpforsearch);
1657
1658     if (s)
1659         return bufchain_size(&s->output_data) > 0;
1660     else
1661         return 0;
1662 }
1663
1664 int net_service_lookup(char *service)
1665 {
1666     struct servent *se;
1667     se = p_getservbyname(service, NULL);
1668     if (se != NULL)
1669         return p_ntohs(se->s_port);
1670     else
1671         return 0;
1672 }
1673
1674 SockAddr platform_get_x11_unix_address(const char *display, int displaynum,
1675                                        char **canonicalname)
1676 {
1677     SockAddr ret = snew(struct SockAddr_tag);
1678     memset(ret, 0, sizeof(struct SockAddr_tag));
1679     ret->error = "unix sockets not supported on this platform";
1680     return ret;
1681 }