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