2 * Windows networking abstraction.
4 * For the IPv6 code in here I am indebted to Jeroen Massar and
12 #define DEFINE_PLUG_METHOD_MACROS
20 const struct in6_addr in6addr_any = IN6ADDR_ANY_INIT;
21 const struct in6_addr in6addr_loopback = IN6ADDR_LOOPBACK_INIT;
24 #define ipv4_is_loopback(addr) \
25 ((p_ntohl(addr.s_addr) & 0xFF000000L) == 0x7F000000L)
28 * We used to typedef struct Socket_tag *Socket.
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.
35 typedef struct Socket_tag *Actual_Socket;
38 const struct socket_function_table *fn;
39 /* the above variable absolutely *must* be the first in this structure */
47 int frozen; /* this causes readability notifications to be ignored */
48 int frozen_readable; /* this means we missed at least one readability
49 * notification while we were frozen */
50 int localhost_only; /* for listening sockets */
53 int oobinline, nodelay, keepalive, privport;
56 int pending_error; /* in case send() returns error */
58 * We sometimes need pairs of Socket structures to be linked:
59 * if we are listening on the same IPv6 and v4 port, for
60 * example. So here we define `parent' and `child' pointers to
63 Actual_Socket parent, child;
69 * Which address family this address belongs to. AF_INET for
70 * IPv4; AF_INET6 for IPv6; AF_UNSPEC indicates that name
71 * resolution has not been done and a simple host name is held
72 * in this SockAddr structure.
73 * The hostname field is also used when the hostname has both
74 * an IPv6 and IPv4 address and the IPv6 connection attempt
75 * fails. We then try the IPv4 address.
76 * This 'family' should become an option in the GUI and
77 * on the commandline for selecting a default protocol.
81 struct addrinfo *ais; /* Addresses IPv6 style. */
82 struct addrinfo *ai; /* steps along the linked list */
84 unsigned long *addresses; /* Addresses IPv4 style. */
85 int naddresses, curraddr;
86 char hostname[512]; /* Store an unresolved host name. */
89 static tree234 *sktree;
91 static int cmpfortree(void *av, void *bv)
93 Actual_Socket a = (Actual_Socket) av, b = (Actual_Socket) bv;
94 unsigned long as = (unsigned long) a->s, bs = (unsigned long) b->s;
102 static int cmpforsearch(void *av, void *bv)
104 Actual_Socket b = (Actual_Socket) bv;
105 unsigned long as = (unsigned long) av, bs = (unsigned long) b->s;
114 #define DECL_WINSOCK_FUNCTION(linkage, rettype, name, params) \
115 typedef rettype (WINAPI *t_##name) params; \
116 linkage t_##name p_##name
117 #define GET_WINSOCK_FUNCTION(module, name) \
118 p_##name = module ? (t_##name) GetProcAddress(module, #name) : NULL
120 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAAsyncSelect,
121 (SOCKET, HWND, u_int, long));
122 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAEventSelect, (SOCKET, WSAEVENT, long));
123 DECL_WINSOCK_FUNCTION(NOTHING, int, select,
124 (int, fd_set FAR *, fd_set FAR *,
125 fd_set FAR *, const struct timeval FAR *));
126 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAGetLastError, (void));
127 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAEnumNetworkEvents,
128 (SOCKET, WSAEVENT, LPWSANETWORKEVENTS));
129 DECL_WINSOCK_FUNCTION(static, int, WSAStartup, (WORD, LPWSADATA));
130 DECL_WINSOCK_FUNCTION(static, int, WSACleanup, (void));
131 DECL_WINSOCK_FUNCTION(static, int, closesocket, (SOCKET));
132 DECL_WINSOCK_FUNCTION(static, u_long, ntohl, (u_long));
133 DECL_WINSOCK_FUNCTION(static, u_long, htonl, (u_long));
134 DECL_WINSOCK_FUNCTION(static, u_short, htons, (u_short));
135 DECL_WINSOCK_FUNCTION(static, u_short, ntohs, (u_short));
136 DECL_WINSOCK_FUNCTION(static, struct hostent FAR *, gethostbyname,
138 DECL_WINSOCK_FUNCTION(static, struct servent FAR *, getservbyname,
139 (const char FAR *, const char FAR *));
140 DECL_WINSOCK_FUNCTION(static, unsigned long, inet_addr, (const char FAR *));
141 DECL_WINSOCK_FUNCTION(static, char FAR *, inet_ntoa, (struct in_addr));
142 DECL_WINSOCK_FUNCTION(static, int, connect,
143 (SOCKET, const struct sockaddr FAR *, int));
144 DECL_WINSOCK_FUNCTION(static, int, bind,
145 (SOCKET, const struct sockaddr FAR *, int));
146 DECL_WINSOCK_FUNCTION(static, int, setsockopt,
147 (SOCKET, int, int, const char FAR *, int));
148 DECL_WINSOCK_FUNCTION(static, SOCKET, socket, (int, int, int));
149 DECL_WINSOCK_FUNCTION(static, int, listen, (SOCKET, int));
150 DECL_WINSOCK_FUNCTION(static, int, send, (SOCKET, const char FAR *, int, int));
151 DECL_WINSOCK_FUNCTION(static, int, ioctlsocket,
152 (SOCKET, long, u_long FAR *));
153 DECL_WINSOCK_FUNCTION(static, SOCKET, accept,
154 (SOCKET, struct sockaddr FAR *, int FAR *));
155 DECL_WINSOCK_FUNCTION(static, int, recv, (SOCKET, char FAR *, int, int));
156 DECL_WINSOCK_FUNCTION(static, int, WSAIoctl,
157 (SOCKET, DWORD, LPVOID, DWORD, LPVOID, DWORD,
158 LPDWORD, LPWSAOVERLAPPED,
159 LPWSAOVERLAPPED_COMPLETION_ROUTINE));
161 DECL_WINSOCK_FUNCTION(static, int, getaddrinfo,
162 (const char *nodename, const char *servname,
163 const struct addrinfo *hints, struct addrinfo **res));
164 DECL_WINSOCK_FUNCTION(static, void, freeaddrinfo, (struct addrinfo *res));
165 DECL_WINSOCK_FUNCTION(static, int, getnameinfo,
166 (const struct sockaddr FAR * sa, socklen_t salen,
167 char FAR * host, size_t hostlen, char FAR * serv,
168 size_t servlen, int flags));
169 DECL_WINSOCK_FUNCTION(static, char *, gai_strerror, (int ecode));
170 DECL_WINSOCK_FUNCTION(static, int, WSAAddressToStringA,
171 (LPSOCKADDR, DWORD, LPWSAPROTOCOL_INFO,
175 static HMODULE winsock_module = NULL;
176 static WSADATA wsadata;
178 static HMODULE winsock2_module = NULL;
179 static HMODULE wship6_module = NULL;
182 int sk_startup(int hi, int lo)
186 winsock_ver = MAKEWORD(hi, lo);
188 if (p_WSAStartup(winsock_ver, &wsadata)) {
192 if (LOBYTE(wsadata.wVersion) != LOBYTE(winsock_ver)) {
196 #ifdef NET_SETUP_DIAGNOSTICS
199 sprintf(buf, "Using WinSock %d.%d", hi, lo);
211 winsock_module = LoadLibrary("WS2_32.DLL");
212 if (!winsock_module) {
213 winsock_module = LoadLibrary("WSOCK32.DLL");
216 fatalbox("Unable to load any WinSock library");
219 /* Check if we have getaddrinfo in Winsock */
220 if (GetProcAddress(winsock_module, "getaddrinfo") != NULL) {
221 #ifdef NET_SETUP_DIAGNOSTICS
222 logevent(NULL, "Native WinSock IPv6 support detected");
224 GET_WINSOCK_FUNCTION(winsock_module, getaddrinfo);
225 GET_WINSOCK_FUNCTION(winsock_module, freeaddrinfo);
226 GET_WINSOCK_FUNCTION(winsock_module, getnameinfo);
227 GET_WINSOCK_FUNCTION(winsock_module, gai_strerror);
229 /* Fall back to wship6.dll for Windows 2000 */
230 wship6_module = LoadLibrary("wship6.dll");
232 #ifdef NET_SETUP_DIAGNOSTICS
233 logevent(NULL, "WSH IPv6 support detected");
235 GET_WINSOCK_FUNCTION(wship6_module, getaddrinfo);
236 GET_WINSOCK_FUNCTION(wship6_module, freeaddrinfo);
237 GET_WINSOCK_FUNCTION(wship6_module, getnameinfo);
238 GET_WINSOCK_FUNCTION(wship6_module, gai_strerror);
240 #ifdef NET_SETUP_DIAGNOSTICS
241 logevent(NULL, "No IPv6 support detected");
245 GET_WINSOCK_FUNCTION(winsock2_module, WSAAddressToStringA);
247 #ifdef NET_SETUP_DIAGNOSTICS
248 logevent(NULL, "PuTTY was built without IPv6 support");
252 GET_WINSOCK_FUNCTION(winsock_module, WSAAsyncSelect);
253 GET_WINSOCK_FUNCTION(winsock_module, WSAEventSelect);
254 GET_WINSOCK_FUNCTION(winsock_module, select);
255 GET_WINSOCK_FUNCTION(winsock_module, WSAGetLastError);
256 GET_WINSOCK_FUNCTION(winsock_module, WSAEnumNetworkEvents);
257 GET_WINSOCK_FUNCTION(winsock_module, WSAStartup);
258 GET_WINSOCK_FUNCTION(winsock_module, WSACleanup);
259 GET_WINSOCK_FUNCTION(winsock_module, closesocket);
260 GET_WINSOCK_FUNCTION(winsock_module, ntohl);
261 GET_WINSOCK_FUNCTION(winsock_module, htonl);
262 GET_WINSOCK_FUNCTION(winsock_module, htons);
263 GET_WINSOCK_FUNCTION(winsock_module, ntohs);
264 GET_WINSOCK_FUNCTION(winsock_module, gethostbyname);
265 GET_WINSOCK_FUNCTION(winsock_module, getservbyname);
266 GET_WINSOCK_FUNCTION(winsock_module, inet_addr);
267 GET_WINSOCK_FUNCTION(winsock_module, inet_ntoa);
268 GET_WINSOCK_FUNCTION(winsock_module, connect);
269 GET_WINSOCK_FUNCTION(winsock_module, bind);
270 GET_WINSOCK_FUNCTION(winsock_module, setsockopt);
271 GET_WINSOCK_FUNCTION(winsock_module, socket);
272 GET_WINSOCK_FUNCTION(winsock_module, listen);
273 GET_WINSOCK_FUNCTION(winsock_module, send);
274 GET_WINSOCK_FUNCTION(winsock_module, ioctlsocket);
275 GET_WINSOCK_FUNCTION(winsock_module, accept);
276 GET_WINSOCK_FUNCTION(winsock_module, recv);
277 GET_WINSOCK_FUNCTION(winsock_module, WSAIoctl);
279 /* Try to get the best WinSock version we can get */
280 if (!sk_startup(2,2) &&
283 fatalbox("Unable to initialise WinSock");
286 sktree = newtree234(cmpfortree);
289 void sk_cleanup(void)
295 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
304 FreeLibrary(winsock_module);
307 FreeLibrary(wship6_module);
311 char *winsock_error_string(int error)
315 return "Network error: Permission denied";
317 return "Network error: Address already in use";
318 case WSAEADDRNOTAVAIL:
319 return "Network error: Cannot assign requested address";
320 case WSAEAFNOSUPPORT:
322 "Network error: Address family not supported by protocol family";
324 return "Network error: Operation already in progress";
325 case WSAECONNABORTED:
326 return "Network error: Software caused connection abort";
327 case WSAECONNREFUSED:
328 return "Network error: Connection refused";
330 return "Network error: Connection reset by peer";
331 case WSAEDESTADDRREQ:
332 return "Network error: Destination address required";
334 return "Network error: Bad address";
336 return "Network error: Host is down";
337 case WSAEHOSTUNREACH:
338 return "Network error: No route to host";
340 return "Network error: Operation now in progress";
342 return "Network error: Interrupted function call";
344 return "Network error: Invalid argument";
346 return "Network error: Socket is already connected";
348 return "Network error: Too many open files";
350 return "Network error: Message too long";
352 return "Network error: Network is down";
354 return "Network error: Network dropped connection on reset";
356 return "Network error: Network is unreachable";
358 return "Network error: No buffer space available";
360 return "Network error: Bad protocol option";
362 return "Network error: Socket is not connected";
364 return "Network error: Socket operation on non-socket";
366 return "Network error: Operation not supported";
367 case WSAEPFNOSUPPORT:
368 return "Network error: Protocol family not supported";
370 return "Network error: Too many processes";
371 case WSAEPROTONOSUPPORT:
372 return "Network error: Protocol not supported";
374 return "Network error: Protocol wrong type for socket";
376 return "Network error: Cannot send after socket shutdown";
377 case WSAESOCKTNOSUPPORT:
378 return "Network error: Socket type not supported";
380 return "Network error: Connection timed out";
382 return "Network error: Resource temporarily unavailable";
384 return "Network error: Graceful shutdown in progress";
386 return "Unknown network error";
390 SockAddr sk_namelookup(const char *host, char **canonicalname,
393 SockAddr ret = snew(struct SockAddr_tag);
395 struct hostent *h = NULL;
400 /* Clear the structure and default to IPv4. */
401 memset(ret, 0, sizeof(struct SockAddr_tag));
402 ret->family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
404 address_family == ADDRTYPE_IPV6 ? AF_INET6 :
408 ret->ai = ret->ais = NULL;
410 ret->addresses = NULL;
411 ret_family = AF_UNSPEC;
414 if ((a = p_inet_addr(host)) == (unsigned long) INADDR_NONE) {
417 * Use getaddrinfo when it's available
420 struct addrinfo hints;
421 #ifdef NET_SETUP_DIAGNOSTICS
422 logevent(NULL, "Using getaddrinfo() for resolving");
424 memset(&hints, 0, sizeof(hints));
425 hints.ai_family = ret->family;
426 hints.ai_flags = AI_CANONNAME;
427 if ((err = p_getaddrinfo(host, NULL, &hints, &ret->ais)) == 0)
428 ret_family = ret->ais->ai_family;
433 #ifdef NET_SETUP_DIAGNOSTICS
434 logevent(NULL, "Using gethostbyname() for resolving");
437 * Otherwise use the IPv4-only gethostbyname...
438 * (NOTE: we don't use gethostbyname as a fallback!)
440 if ( (h = p_gethostbyname(host)) )
441 ret_family = AF_INET;
443 err = p_WSAGetLastError();
446 if (ret_family == AF_UNSPEC) {
447 ret->error = (err == WSAENETDOWN ? "Network is down" :
448 err == WSAHOST_NOT_FOUND ? "Host does not exist" :
449 err == WSATRY_AGAIN ? "Host not found" :
451 p_getaddrinfo&&p_gai_strerror ? p_gai_strerror(err) :
453 "gethostbyname: unknown error");
456 ret->family = ret_family;
459 /* If we got an address info use that... */
461 /* Are we in IPv4 fallback mode? */
462 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
463 if (ret->family == AF_INET)
465 (char *) &((SOCKADDR_IN *) ret->ai->
466 ai_addr)->sin_addr, sizeof(a));
468 if (ret->ai->ai_canonname)
469 strncpy(realhost, ret->ai->ai_canonname, lenof(realhost));
471 strncpy(realhost, host, lenof(realhost));
473 /* We used the IPv4-only gethostbyname()... */
478 for (n = 0; h->h_addr_list[n]; n++);
479 ret->addresses = snewn(n, unsigned long);
481 for (n = 0; n < ret->naddresses; n++) {
482 memcpy(&a, h->h_addr_list[n], sizeof(a));
483 ret->addresses[n] = p_ntohl(a);
486 memcpy(&a, h->h_addr, sizeof(a));
487 /* This way we are always sure the h->h_name is valid :) */
488 strncpy(realhost, h->h_name, sizeof(realhost));
493 * This must be a numeric IPv4 address because it caused a
494 * success return from inet_addr.
496 ret->addresses = snewn(1, unsigned long);
499 ret->addresses[0] = p_ntohl(a);
500 ret->family = AF_INET;
501 strncpy(realhost, host, sizeof(realhost));
503 realhost[lenof(realhost)-1] = '\0';
504 *canonicalname = snewn(1+strlen(realhost), char);
505 strcpy(*canonicalname, realhost);
509 SockAddr sk_nonamelookup(const char *host)
511 SockAddr ret = snew(struct SockAddr_tag);
513 ret->family = AF_UNSPEC;
515 ret->ai = ret->ais = NULL;
517 ret->addresses = NULL;
519 strncpy(ret->hostname, host, lenof(ret->hostname));
520 ret->hostname[lenof(ret->hostname)-1] = '\0';
524 int sk_nextaddr(SockAddr addr)
528 if (addr->ai->ai_next) {
529 addr->ai = addr->ai->ai_next;
530 addr->family = addr->ai->ai_family;
536 if (addr->curraddr+1 < addr->naddresses) {
544 void sk_getaddr(SockAddr addr, char *buf, int buflen)
548 if (p_WSAAddressToStringA) {
549 p_WSAAddressToStringA(addr->ai->ai_addr, addr->ai->ai_addrlen,
552 strncpy(buf, "IPv6", buflen);
555 if (addr->family == AF_INET) {
557 assert(addr->addresses && addr->curraddr < addr->naddresses);
558 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
559 strncpy(buf, p_inet_ntoa(a), buflen);
560 buf[buflen-1] = '\0';
562 strncpy(buf, addr->hostname, buflen);
563 buf[buflen-1] = '\0';
567 int sk_hostname_is_local(char *name)
569 return !strcmp(name, "localhost");
572 static INTERFACE_INFO local_interfaces[16];
573 static int n_local_interfaces; /* 0=not yet, -1=failed, >0=number */
575 static int ipv4_is_local_addr(struct in_addr addr)
577 if (ipv4_is_loopback(addr))
578 return 1; /* loopback addresses are local */
579 if (!n_local_interfaces) {
580 SOCKET s = p_socket(AF_INET, SOCK_DGRAM, 0);
584 p_WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0,
585 local_interfaces, sizeof(local_interfaces),
586 &retbytes, NULL, NULL) == 0)
587 n_local_interfaces = retbytes / sizeof(INTERFACE_INFO);
589 logevent(NULL, "Unable to get list of local IP addresses");
591 if (n_local_interfaces > 0) {
593 for (i = 0; i < n_local_interfaces; i++) {
594 SOCKADDR_IN *address =
595 (SOCKADDR_IN *)&local_interfaces[i].iiAddress;
596 if (address->sin_addr.s_addr == addr.s_addr)
597 return 1; /* this address is local */
600 return 0; /* this address is not local */
603 int sk_address_is_local(SockAddr addr)
606 if (addr->family == AF_INET6) {
607 return IN6_IS_ADDR_LOOPBACK((const struct in6_addr *)addr->ai->ai_addr);
610 if (addr->family == AF_INET) {
613 return ipv4_is_local_addr(((struct sockaddr_in *)addr->ai->ai_addr)
619 assert(addr->addresses && addr->curraddr < addr->naddresses);
620 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
621 return ipv4_is_local_addr(a);
624 assert(addr->family == AF_UNSPEC);
625 return 0; /* we don't know; assume not */
629 int sk_addrtype(SockAddr addr)
631 return (addr->family == AF_INET ? ADDRTYPE_IPV4 :
633 addr->family == AF_INET6 ? ADDRTYPE_IPV6 :
638 void sk_addrcopy(SockAddr addr, char *buf)
640 assert(addr->family != AF_UNSPEC);
643 if (addr->family == AF_INET)
644 memcpy(buf, &((struct sockaddr_in *)addr->ai->ai_addr)->sin_addr,
645 sizeof(struct in_addr));
646 else if (addr->family == AF_INET6)
647 memcpy(buf, &((struct sockaddr_in6 *)addr->ai->ai_addr)->sin6_addr,
648 sizeof(struct in6_addr));
653 if (addr->family == AF_INET) {
655 assert(addr->addresses && addr->curraddr < addr->naddresses);
656 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
657 memcpy(buf, (char*) &a.s_addr, 4);
661 void sk_addr_free(SockAddr addr)
664 if (addr->ais && p_freeaddrinfo)
665 p_freeaddrinfo(addr->ais);
668 sfree(addr->addresses);
672 static Plug sk_tcp_plug(Socket sock, Plug p)
674 Actual_Socket s = (Actual_Socket) sock;
681 static void sk_tcp_flush(Socket s)
684 * We send data to the socket as soon as we can anyway,
685 * so we don't need to do anything here. :-)
689 static void sk_tcp_close(Socket s);
690 static int sk_tcp_write(Socket s, const char *data, int len);
691 static int sk_tcp_write_oob(Socket s, const char *data, int len);
692 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
693 static void *sk_tcp_get_private_ptr(Socket s);
694 static void sk_tcp_set_frozen(Socket s, int is_frozen);
695 static const char *sk_tcp_socket_error(Socket s);
697 extern char *do_select(SOCKET skt, int startup);
699 Socket sk_register(void *sock, Plug plug)
701 static const struct socket_function_table fn_table = {
707 sk_tcp_set_private_ptr,
708 sk_tcp_get_private_ptr,
718 * Create Socket structure.
720 ret = snew(struct Socket_tag);
724 bufchain_init(&ret->output_data);
725 ret->writable = 1; /* to start with */
726 ret->sending_oob = 0;
728 ret->frozen_readable = 0;
729 ret->localhost_only = 0; /* unused, but best init anyway */
730 ret->pending_error = 0;
731 ret->parent = ret->child = NULL;
734 ret->s = (SOCKET)sock;
736 if (ret->s == INVALID_SOCKET) {
737 err = p_WSAGetLastError();
738 ret->error = winsock_error_string(err);
744 /* Set up a select mechanism. This could be an AsyncSelect on a
745 * window, or an EventSelect on an event object. */
746 errstr = do_select(ret->s, 1);
757 static DWORD try_connect(Actual_Socket sock)
769 if (sock->s != INVALID_SOCKET) {
770 do_select(sock->s, 0);
771 p_closesocket(sock->s);
774 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
780 /* Let's default to IPv6, this shouldn't hurt anybody
781 * If the stack supports IPv6 it will also allow IPv4 connections. */
782 if (sock->addr->ai) {
783 family = sock->addr->ai->ai_family;
787 /* Default to IPv4 */
791 s = p_socket(family, SOCK_STREAM, 0);
794 if (s == INVALID_SOCKET) {
795 err = p_WSAGetLastError();
796 sock->error = winsock_error_string(err);
800 if (sock->oobinline) {
802 p_setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
807 p_setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
810 if (sock->keepalive) {
812 p_setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
816 * Bind to local address.
819 localport = 1023; /* count from 1023 downwards */
821 localport = 0; /* just use port 0 (ie winsock picks) */
823 /* Loop round trying to bind */
828 if (family == AF_INET6) {
829 memset(&a6, 0, sizeof(a6));
830 a6.sin6_family = AF_INET6;
831 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
832 a6.sin6_port = p_htons(localport);
836 a.sin_family = AF_INET;
837 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
838 a.sin_port = p_htons(localport);
841 sockcode = p_bind(s, (sock->addr->family == AF_INET6 ?
842 (struct sockaddr *) &a6 :
843 (struct sockaddr *) &a),
844 (sock->addr->family ==
845 AF_INET6 ? sizeof(a6) : sizeof(a)));
847 sockcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
849 if (sockcode != SOCKET_ERROR) {
853 err = p_WSAGetLastError();
854 if (err != WSAEADDRINUSE) /* failed, for a bad reason */
859 break; /* we're only looping once */
862 break; /* we might have got to the end */
866 sock->error = winsock_error_string(err);
871 * Connect to remote address.
874 if (sock->addr->ai) {
875 if (family == AF_INET6) {
876 a6.sin6_family = AF_INET6;
877 a6.sin6_port = p_htons((short) sock->port);
879 ((struct sockaddr_in6 *) sock->addr->ai->ai_addr)->sin6_addr;
880 a6.sin6_flowinfo = ((struct sockaddr_in6 *) sock->addr->ai->ai_addr)->sin6_flowinfo;
881 a6.sin6_scope_id = ((struct sockaddr_in6 *) sock->addr->ai->ai_addr)->sin6_scope_id;
883 a.sin_family = AF_INET;
885 ((struct sockaddr_in *) sock->addr->ai->ai_addr)->sin_addr;
886 a.sin_port = p_htons((short) sock->port);
891 assert(sock->addr->addresses && sock->addr->curraddr < sock->addr->naddresses);
892 a.sin_family = AF_INET;
893 a.sin_addr.s_addr = p_htonl(sock->addr->addresses[sock->addr->curraddr]);
894 a.sin_port = p_htons((short) sock->port);
897 /* Set up a select mechanism. This could be an AsyncSelect on a
898 * window, or an EventSelect on an event object. */
899 errstr = do_select(s, 1);
901 sock->error = errstr;
909 ((family == AF_INET6) ? (struct sockaddr *) &a6 :
910 (struct sockaddr *) &a),
911 (family == AF_INET6) ? sizeof(a6) : sizeof(a))
913 p_connect(s, (struct sockaddr *) &a, sizeof(a))
916 err = p_WSAGetLastError();
918 * We expect a potential EWOULDBLOCK here, because the
919 * chances are the front end has done a select for
920 * FD_CONNECT, so that connect() will complete
923 if ( err != WSAEWOULDBLOCK ) {
924 sock->error = winsock_error_string(err);
929 * If we _don't_ get EWOULDBLOCK, the connect has completed
930 * and we should set the socket as writable.
935 add234(sktree, sock);
941 plug_log(sock->plug, 1, sock->addr, sock->port, sock->error, err);
945 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
946 int nodelay, int keepalive, Plug plug)
948 static const struct socket_function_table fn_table = {
954 sk_tcp_set_private_ptr,
955 sk_tcp_get_private_ptr,
964 * Create Socket structure.
966 ret = snew(struct Socket_tag);
970 bufchain_init(&ret->output_data);
971 ret->connected = 0; /* to start with */
972 ret->writable = 0; /* to start with */
973 ret->sending_oob = 0;
975 ret->frozen_readable = 0;
976 ret->localhost_only = 0; /* unused, but best init anyway */
977 ret->pending_error = 0;
978 ret->parent = ret->child = NULL;
979 ret->oobinline = oobinline;
980 ret->nodelay = nodelay;
981 ret->keepalive = keepalive;
982 ret->privport = privport;
985 ret->s = INVALID_SOCKET;
989 err = try_connect(ret);
990 } while (err && sk_nextaddr(ret->addr));
995 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only,
996 int orig_address_family)
998 static const struct socket_function_table fn_table = {
1004 sk_tcp_set_private_ptr,
1005 sk_tcp_get_private_ptr,
1025 * Create Socket structure.
1027 ret = snew(struct Socket_tag);
1028 ret->fn = &fn_table;
1031 bufchain_init(&ret->output_data);
1032 ret->writable = 0; /* to start with */
1033 ret->sending_oob = 0;
1035 ret->frozen_readable = 0;
1036 ret->localhost_only = local_host_only;
1037 ret->pending_error = 0;
1038 ret->parent = ret->child = NULL;
1042 * Translate address_family from platform-independent constants
1043 * into local reality.
1045 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
1047 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
1052 * Our default, if passed the `don't care' value
1053 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1054 * we will also set up a second socket listening on IPv6, but
1055 * the v4 one is primary since that ought to work even on
1056 * non-v6-supporting systems.
1058 if (address_family == AF_UNSPEC) address_family = AF_INET;
1063 s = p_socket(address_family, SOCK_STREAM, 0);
1066 if (s == INVALID_SOCKET) {
1067 err = p_WSAGetLastError();
1068 ret->error = winsock_error_string(err);
1069 return (Socket) ret;
1074 p_setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
1077 if (address_family == AF_INET6) {
1078 memset(&a6, 0, sizeof(a6));
1079 a6.sin6_family = AF_INET6;
1080 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1081 * know how to do it. :-)
1082 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1083 * Thus we need either a parser that understands [2001:db8::1]:80
1084 * style addresses and/or enhance this to understand hostnames too. */
1085 if (local_host_only)
1086 a6.sin6_addr = in6addr_loopback;
1088 a6.sin6_addr = in6addr_any;
1089 a6.sin6_port = p_htons(port);
1094 a.sin_family = AF_INET;
1097 * Bind to source address. First try an explicitly
1101 a.sin_addr.s_addr = p_inet_addr(srcaddr);
1102 if (a.sin_addr.s_addr != INADDR_NONE) {
1103 /* Override localhost_only with specified listen addr. */
1104 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
1110 * ... and failing that, go with one of the standard ones.
1113 if (local_host_only)
1114 a.sin_addr.s_addr = p_htonl(INADDR_LOOPBACK);
1116 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
1119 a.sin_port = p_htons((short)port);
1122 retcode = p_bind(s, (address_family == AF_INET6 ?
1123 (struct sockaddr *) &a6 :
1124 (struct sockaddr *) &a),
1126 AF_INET6 ? sizeof(a6) : sizeof(a)));
1128 retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
1130 if (retcode != SOCKET_ERROR) {
1133 err = p_WSAGetLastError();
1138 ret->error = winsock_error_string(err);
1139 return (Socket) ret;
1143 if (p_listen(s, SOMAXCONN) == SOCKET_ERROR) {
1145 ret->error = winsock_error_string(err);
1146 return (Socket) ret;
1149 /* Set up a select mechanism. This could be an AsyncSelect on a
1150 * window, or an EventSelect on an event object. */
1151 errstr = do_select(s, 1);
1154 ret->error = errstr;
1155 return (Socket) ret;
1158 add234(sktree, ret);
1162 * If we were given ADDRTYPE_UNSPEC, we must also create an
1163 * IPv6 listening socket and link it to this one.
1165 if (address_family == AF_INET && orig_address_family == ADDRTYPE_UNSPEC) {
1166 Actual_Socket other;
1168 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
1169 local_host_only, ADDRTYPE_IPV6);
1172 if (!other->error) {
1173 other->parent = ret;
1182 return (Socket) ret;
1185 static void sk_tcp_close(Socket sock)
1187 extern char *do_select(SOCKET skt, int startup);
1188 Actual_Socket s = (Actual_Socket) sock;
1191 sk_tcp_close((Socket)s->child);
1195 p_closesocket(s->s);
1197 sk_addr_free(s->addr);
1202 * The function which tries to send on a socket once it's deemed
1205 void try_send(Actual_Socket s)
1207 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1211 int len, urgentflag;
1213 if (s->sending_oob) {
1214 urgentflag = MSG_OOB;
1215 len = s->sending_oob;
1219 bufchain_prefix(&s->output_data, &data, &len);
1221 nsent = p_send(s->s, data, len, urgentflag);
1222 noise_ultralight(nsent);
1224 err = (nsent < 0 ? p_WSAGetLastError() : 0);
1225 if ((err < WSABASEERR && nsent < 0) || err == WSAEWOULDBLOCK) {
1227 * Perfectly normal: we've sent all we can for the moment.
1229 * (Some WinSock send() implementations can return
1230 * <0 but leave no sensible error indication -
1231 * WSAGetLastError() is called but returns zero or
1232 * a small number - so we check that case and treat
1233 * it just like WSAEWOULDBLOCK.)
1235 s->writable = FALSE;
1237 } else if (nsent == 0 ||
1238 err == WSAECONNABORTED || err == WSAECONNRESET) {
1240 * If send() returns CONNABORTED or CONNRESET, we
1241 * unfortunately can't just call plug_closing(),
1242 * because it's quite likely that we're currently
1243 * _in_ a call from the code we'd be calling back
1244 * to, so we'd have to make half the SSH code
1245 * reentrant. Instead we flag a pending error on
1246 * the socket, to be dealt with (by calling
1247 * plug_closing()) at some suitable future moment.
1249 s->pending_error = err;
1252 /* We're inside the Windows frontend here, so we know
1253 * that the frontend handle is unnecessary. */
1254 logevent(NULL, winsock_error_string(err));
1255 fatalbox("%s", winsock_error_string(err));
1258 if (s->sending_oob) {
1260 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1261 s->sending_oob = len - nsent;
1266 bufchain_consume(&s->output_data, nsent);
1272 static int sk_tcp_write(Socket sock, const char *buf, int len)
1274 Actual_Socket s = (Actual_Socket) sock;
1277 * Add the data to the buffer list on the socket.
1279 bufchain_add(&s->output_data, buf, len);
1282 * Now try sending from the start of the buffer list.
1287 return bufchain_size(&s->output_data);
1290 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1292 Actual_Socket s = (Actual_Socket) sock;
1295 * Replace the buffer list on the socket with the data.
1297 bufchain_clear(&s->output_data);
1298 assert(len <= sizeof(s->oobdata));
1299 memcpy(s->oobdata, buf, len);
1300 s->sending_oob = len;
1303 * Now try sending from the start of the buffer list.
1308 return s->sending_oob;
1311 int select_result(WPARAM wParam, LPARAM lParam)
1315 char buf[20480]; /* nice big buffer for plenty of speed */
1319 /* wParam is the socket itself */
1322 return 1; /* boggle */
1324 s = find234(sktree, (void *) wParam, cmpforsearch);
1326 return 1; /* boggle */
1328 if ((err = WSAGETSELECTERROR(lParam)) != 0) {
1330 * An error has occurred on this socket. Pass it to the
1334 plug_log(s->plug, 1, s->addr, s->port,
1335 winsock_error_string(err), err);
1336 while (s->addr && sk_nextaddr(s->addr)) {
1337 err = try_connect(s);
1341 return plug_closing(s->plug, winsock_error_string(err), err, 0);
1346 noise_ultralight(lParam);
1348 switch (WSAGETSELECTEVENT(lParam)) {
1350 s->connected = s->writable = 1;
1352 * Once a socket is connected, we can stop falling
1353 * back through the candidate addresses to connect
1357 sk_addr_free(s->addr);
1362 /* In the case the socket is still frozen, we don't even bother */
1364 s->frozen_readable = 1;
1369 * We have received data on the socket. For an oobinline
1370 * socket, this might be data _before_ an urgent pointer,
1371 * in which case we send it to the back end with type==1
1372 * (data prior to urgent).
1376 p_ioctlsocket(s->s, SIOCATMARK, &atmark);
1378 * Avoid checking the return value from ioctlsocket(),
1379 * on the grounds that some WinSock wrappers don't
1380 * support it. If it does nothing, we get atmark==1,
1381 * which is equivalent to `no OOB pending', so the
1382 * effect will be to non-OOB-ify any OOB data.
1387 ret = p_recv(s->s, buf, sizeof(buf), 0);
1388 noise_ultralight(ret);
1390 err = p_WSAGetLastError();
1391 if (err == WSAEWOULDBLOCK) {
1396 return plug_closing(s->plug, winsock_error_string(err), err,
1398 } else if (0 == ret) {
1399 return plug_closing(s->plug, NULL, 0, 0);
1401 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1406 * This will only happen on a non-oobinline socket. It
1407 * indicates that we can immediately perform an OOB read
1408 * and get back OOB data, which we will send to the back
1409 * end with type==2 (urgent data).
1411 ret = p_recv(s->s, buf, sizeof(buf), MSG_OOB);
1412 noise_ultralight(ret);
1414 char *str = (ret == 0 ? "Internal networking trouble" :
1415 winsock_error_string(p_WSAGetLastError()));
1416 /* We're inside the Windows frontend here, so we know
1417 * that the frontend handle is unnecessary. */
1418 logevent(NULL, str);
1419 fatalbox("%s", str);
1421 return plug_receive(s->plug, 2, buf, ret);
1426 int bufsize_before, bufsize_after;
1428 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1430 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1431 if (bufsize_after < bufsize_before)
1432 plug_sent(s->plug, bufsize_after);
1436 /* Signal a close on the socket. First read any outstanding data. */
1439 ret = p_recv(s->s, buf, sizeof(buf), 0);
1441 err = p_WSAGetLastError();
1442 if (err == WSAEWOULDBLOCK)
1444 return plug_closing(s->plug, winsock_error_string(err),
1448 open &= plug_receive(s->plug, 0, buf, ret);
1450 open &= plug_closing(s->plug, NULL, 0, 0);
1457 struct sockaddr_in isa;
1459 struct sockaddr_storage isa;
1461 int addrlen = sizeof(isa);
1462 SOCKET t; /* socket of connection */
1464 memset(&isa, 0, sizeof(isa));
1466 t = p_accept(s->s,(struct sockaddr *)&isa,&addrlen);
1467 if (t == INVALID_SOCKET)
1469 err = p_WSAGetLastError();
1470 if (err == WSATRY_AGAIN)
1474 if (isa.ss_family == AF_INET &&
1475 s->localhost_only &&
1476 !ipv4_is_local_addr(((struct sockaddr_in *)&isa)->sin_addr))
1478 if (s->localhost_only && !ipv4_is_local_addr(isa.sin_addr))
1481 p_closesocket(t); /* dodgy WinSock let nonlocal through */
1482 } else if (plug_accepting(s->plug, (void*)t)) {
1483 p_closesocket(t); /* denied or error */
1492 * Deal with socket errors detected in try_send().
1494 void net_pending_errors(void)
1500 * This might be a fiddly business, because it's just possible
1501 * that handling a pending error on one socket might cause
1502 * others to be closed. (I can't think of any reason this might
1503 * happen in current SSH implementation, but to maintain
1504 * generality of this network layer I'll assume the worst.)
1506 * So what we'll do is search the socket list for _one_ socket
1507 * with a pending error, and then handle it, and then search
1508 * the list again _from the beginning_. Repeat until we make a
1509 * pass with no socket errors present. That way we are
1510 * protected against the socket list changing under our feet.
1514 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1515 if (s->pending_error) {
1517 * An error has occurred on this socket. Pass it to the
1520 plug_closing(s->plug,
1521 winsock_error_string(s->pending_error),
1522 s->pending_error, 0);
1530 * Each socket abstraction contains a `void *' private field in
1531 * which the client can keep state.
1533 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1535 Actual_Socket s = (Actual_Socket) sock;
1536 s->private_ptr = ptr;
1539 static void *sk_tcp_get_private_ptr(Socket sock)
1541 Actual_Socket s = (Actual_Socket) sock;
1542 return s->private_ptr;
1546 * Special error values are returned from sk_namelookup and sk_new
1547 * if there's a problem. These functions extract an error message,
1548 * or return NULL if there's no problem.
1550 const char *sk_addr_error(SockAddr addr)
1554 static const char *sk_tcp_socket_error(Socket sock)
1556 Actual_Socket s = (Actual_Socket) sock;
1560 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1562 Actual_Socket s = (Actual_Socket) sock;
1563 if (s->frozen == is_frozen)
1565 s->frozen = is_frozen;
1568 if (s->frozen_readable) {
1570 p_recv(s->s, &c, 1, MSG_PEEK);
1573 s->frozen_readable = 0;
1576 void socket_reselect_all(void)
1581 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1588 * For Plink: enumerate all sockets currently active.
1590 SOCKET first_socket(int *state)
1594 s = index234(sktree, (*state)++);
1595 return s ? s->s : INVALID_SOCKET;
1598 SOCKET next_socket(int *state)
1600 Actual_Socket s = index234(sktree, (*state)++);
1601 return s ? s->s : INVALID_SOCKET;
1604 extern int socket_writable(SOCKET skt)
1606 Actual_Socket s = find234(sktree, (void *)skt, cmpforsearch);
1609 return bufchain_size(&s->output_data) > 0;
1614 int net_service_lookup(char *service)
1617 se = p_getservbyname(service, NULL);
1619 return p_ntohs(se->s_port);
1624 SockAddr platform_get_x11_unix_address(int displaynum, char **canonicalname)
1626 SockAddr ret = snew(struct SockAddr_tag);
1627 memset(ret, 0, sizeof(struct SockAddr_tag));
1628 ret->error = "unix sockets not supported on this platform";