contrib/putty/WINDOWS/WINNET.C

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