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 = (t_##name) GetProcAddress(module, #name)
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));
171 static HMODULE winsock_module;
173 static HMODULE wship6_module;
181 winsock_ver = MAKEWORD(2, 0);
182 winsock_module = LoadLibrary("WS2_32.DLL");
183 if (!winsock_module) {
184 winsock_module = LoadLibrary("WSOCK32.DLL");
185 winsock_ver = MAKEWORD(1, 1);
188 fatalbox("Unable to load any WinSock library");
191 wship6_module = LoadLibrary("wship6.dll");
193 GET_WINSOCK_FUNCTION(wship6_module, getaddrinfo);
194 GET_WINSOCK_FUNCTION(wship6_module, freeaddrinfo);
195 GET_WINSOCK_FUNCTION(wship6_module, getnameinfo);
199 GET_WINSOCK_FUNCTION(winsock_module, WSAAsyncSelect);
200 GET_WINSOCK_FUNCTION(winsock_module, WSAEventSelect);
201 GET_WINSOCK_FUNCTION(winsock_module, select);
202 GET_WINSOCK_FUNCTION(winsock_module, WSAGetLastError);
203 GET_WINSOCK_FUNCTION(winsock_module, WSAEnumNetworkEvents);
204 GET_WINSOCK_FUNCTION(winsock_module, WSAStartup);
205 GET_WINSOCK_FUNCTION(winsock_module, WSACleanup);
206 GET_WINSOCK_FUNCTION(winsock_module, closesocket);
207 GET_WINSOCK_FUNCTION(winsock_module, ntohl);
208 GET_WINSOCK_FUNCTION(winsock_module, htonl);
209 GET_WINSOCK_FUNCTION(winsock_module, htons);
210 GET_WINSOCK_FUNCTION(winsock_module, ntohs);
211 GET_WINSOCK_FUNCTION(winsock_module, gethostbyname);
212 GET_WINSOCK_FUNCTION(winsock_module, getservbyname);
213 GET_WINSOCK_FUNCTION(winsock_module, inet_addr);
214 GET_WINSOCK_FUNCTION(winsock_module, inet_ntoa);
215 GET_WINSOCK_FUNCTION(winsock_module, connect);
216 GET_WINSOCK_FUNCTION(winsock_module, bind);
217 GET_WINSOCK_FUNCTION(winsock_module, setsockopt);
218 GET_WINSOCK_FUNCTION(winsock_module, socket);
219 GET_WINSOCK_FUNCTION(winsock_module, listen);
220 GET_WINSOCK_FUNCTION(winsock_module, send);
221 GET_WINSOCK_FUNCTION(winsock_module, ioctlsocket);
222 GET_WINSOCK_FUNCTION(winsock_module, accept);
223 GET_WINSOCK_FUNCTION(winsock_module, recv);
224 GET_WINSOCK_FUNCTION(winsock_module, WSAIoctl);
226 if (p_WSAStartup(winsock_ver, &wsadata)) {
227 fatalbox("Unable to initialise WinSock");
229 if (LOBYTE(wsadata.wVersion) != LOBYTE(winsock_ver)) {
231 fatalbox("WinSock version is incompatible with %d.%d",
232 LOBYTE(winsock_ver), HIBYTE(winsock_ver));
235 sktree = newtree234(cmpfortree);
238 void sk_cleanup(void)
244 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
253 FreeLibrary(winsock_module);
255 FreeLibrary(wship6_module);
258 char *winsock_error_string(int error)
262 return "Network error: Permission denied";
264 return "Network error: Address already in use";
265 case WSAEADDRNOTAVAIL:
266 return "Network error: Cannot assign requested address";
267 case WSAEAFNOSUPPORT:
269 "Network error: Address family not supported by protocol family";
271 return "Network error: Operation already in progress";
272 case WSAECONNABORTED:
273 return "Network error: Software caused connection abort";
274 case WSAECONNREFUSED:
275 return "Network error: Connection refused";
277 return "Network error: Connection reset by peer";
278 case WSAEDESTADDRREQ:
279 return "Network error: Destination address required";
281 return "Network error: Bad address";
283 return "Network error: Host is down";
284 case WSAEHOSTUNREACH:
285 return "Network error: No route to host";
287 return "Network error: Operation now in progress";
289 return "Network error: Interrupted function call";
291 return "Network error: Invalid argument";
293 return "Network error: Socket is already connected";
295 return "Network error: Too many open files";
297 return "Network error: Message too long";
299 return "Network error: Network is down";
301 return "Network error: Network dropped connection on reset";
303 return "Network error: Network is unreachable";
305 return "Network error: No buffer space available";
307 return "Network error: Bad protocol option";
309 return "Network error: Socket is not connected";
311 return "Network error: Socket operation on non-socket";
313 return "Network error: Operation not supported";
314 case WSAEPFNOSUPPORT:
315 return "Network error: Protocol family not supported";
317 return "Network error: Too many processes";
318 case WSAEPROTONOSUPPORT:
319 return "Network error: Protocol not supported";
321 return "Network error: Protocol wrong type for socket";
323 return "Network error: Cannot send after socket shutdown";
324 case WSAESOCKTNOSUPPORT:
325 return "Network error: Socket type not supported";
327 return "Network error: Connection timed out";
329 return "Network error: Resource temporarily unavailable";
331 return "Network error: Graceful shutdown in progress";
333 return "Unknown network error";
337 SockAddr sk_namelookup(const char *host, char **canonicalname,
340 SockAddr ret = snew(struct SockAddr_tag);
342 struct hostent *h = NULL;
347 /* Clear the structure and default to IPv4. */
348 memset(ret, 0, sizeof(struct SockAddr_tag));
349 ret->family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
351 address_family == ADDRTYPE_IPV6 ? AF_INET6 :
354 ret_family = AF_UNSPEC;
357 if ((a = p_inet_addr(host)) == (unsigned long) INADDR_NONE) {
360 * Use getaddrinfo when it's available
363 struct addrinfo hints;
364 memset(&hints, 0, sizeof(hints));
365 hints.ai_family = ret->family;
366 if ((err = p_getaddrinfo(host, NULL, &hints, &ret->ais)) == 0)
367 ret_family = ret->ais->ai_family;
373 * Otherwise use the IPv4-only gethostbyname...
374 * (NOTE: we don't use gethostbyname as a fallback!)
376 if ( (h = p_gethostbyname(host)) )
377 ret_family = AF_INET;
379 err = p_WSAGetLastError();
382 if (ret_family == AF_UNSPEC) {
383 ret->error = (err == WSAENETDOWN ? "Network is down" :
384 err == WSAHOST_NOT_FOUND ? "Host does not exist" :
385 err == WSATRY_AGAIN ? "Host not found" :
387 p_getaddrinfo ? "getaddrinfo: unknown error" :
389 "gethostbyname: unknown error");
392 ret->family = ret_family;
395 /* If we got an address info use that... */
397 /* Are we in IPv4 fallback mode? */
398 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
399 if (ret->family == AF_INET)
401 (char *) &((SOCKADDR_IN *) ret->ai->
402 ai_addr)->sin_addr, sizeof(a));
404 /* Now let's find that canonicalname... */
407 ((struct sockaddr *) ret->ai->ai_addr,
409 AF_INET ? sizeof(SOCKADDR_IN) :
410 sizeof(SOCKADDR_IN6), realhost,
411 sizeof(realhost), NULL, 0, 0) != 0) {
412 strncpy(realhost, host, sizeof(realhost));
416 /* We used the IPv4-only gethostbyname()... */
421 for (n = 0; h->h_addr_list[n]; n++);
422 ret->addresses = snewn(n, unsigned long);
424 for (n = 0; n < ret->naddresses; n++) {
425 memcpy(&a, h->h_addr_list[n], sizeof(a));
426 ret->addresses[n] = p_ntohl(a);
429 memcpy(&a, h->h_addr, sizeof(a));
430 /* This way we are always sure the h->h_name is valid :) */
431 strncpy(realhost, h->h_name, sizeof(realhost));
436 * This must be a numeric IPv4 address because it caused a
437 * success return from inet_addr.
439 ret->addresses = snewn(1, unsigned long);
442 ret->addresses[0] = p_ntohl(a);
443 ret->family = AF_INET;
444 strncpy(realhost, host, sizeof(realhost));
446 realhost[lenof(realhost)-1] = '\0';
447 *canonicalname = snewn(1+strlen(realhost), char);
448 strcpy(*canonicalname, realhost);
452 SockAddr sk_nonamelookup(const char *host)
454 SockAddr ret = snew(struct SockAddr_tag);
456 ret->family = AF_UNSPEC;
457 strncpy(ret->hostname, host, lenof(ret->hostname));
458 ret->hostname[lenof(ret->hostname)-1] = '\0';
462 int sk_nextaddr(SockAddr addr)
466 if (addr->ai->ai_next) {
467 addr->ai = addr->ai->ai_next;
468 addr->family = addr->ai->ai_family;
474 if (addr->curraddr+1 < addr->naddresses) {
482 void sk_getaddr(SockAddr addr, char *buf, int buflen)
486 /* Try to get the WSAAddressToStringA() function from wship6.dll */
487 /* This way one doesn't need to have IPv6 dll's to use PuTTY and
488 * it will fallback to IPv4. */
489 typedef int (CALLBACK * FADDRTOSTR) (LPSOCKADDR lpsaAddress,
490 DWORD dwAddressLength,
491 LPWSAPROTOCOL_INFO lpProtocolInfo,
492 OUT LPTSTR lpszAddressString,
493 IN OUT LPDWORD lpdwAddressStringLength
495 FADDRTOSTR fAddrToStr = NULL;
497 HINSTANCE dllWS2 = LoadLibrary("ws2_32.dll");
499 fAddrToStr = (FADDRTOSTR)GetProcAddress(dllWS2,
500 "WSAAddressToStringA");
502 fAddrToStr(addr->ai->ai_addr, addr->ai->ai_addrlen,
505 else strncpy(buf, "IPv6", buflen);
510 if (addr->family == AF_INET) {
512 assert(addr->addresses && addr->curraddr < addr->naddresses);
513 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
514 strncpy(buf, p_inet_ntoa(a), buflen);
515 buf[buflen-1] = '\0';
517 strncpy(buf, addr->hostname, buflen);
518 buf[buflen-1] = '\0';
522 int sk_hostname_is_local(char *name)
524 return !strcmp(name, "localhost");
527 static INTERFACE_INFO local_interfaces[16];
528 static int n_local_interfaces; /* 0=not yet, -1=failed, >0=number */
530 static int ipv4_is_local_addr(struct in_addr addr)
532 if (ipv4_is_loopback(addr))
533 return 1; /* loopback addresses are local */
534 if (!n_local_interfaces) {
535 SOCKET s = p_socket(AF_INET, SOCK_DGRAM, 0);
539 p_WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0,
540 local_interfaces, sizeof(local_interfaces),
541 &retbytes, NULL, NULL) == 0)
542 n_local_interfaces = retbytes / sizeof(INTERFACE_INFO);
544 logevent(NULL, "Unable to get list of local IP addresses");
546 if (n_local_interfaces > 0) {
548 for (i = 0; i < n_local_interfaces; i++) {
549 SOCKADDR_IN *address =
550 (SOCKADDR_IN *)&local_interfaces[i].iiAddress;
551 if (address->sin_addr.s_addr == addr.s_addr)
552 return 1; /* this address is local */
555 return 0; /* this address is not local */
558 int sk_address_is_local(SockAddr addr)
561 if (addr->family == AF_INET6) {
562 return IN6_IS_ADDR_LOOPBACK((const struct in6_addr *)addr->ai->ai_addr);
565 if (addr->family == AF_INET) {
567 assert(addr->addresses && addr->curraddr < addr->naddresses);
568 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
569 return ipv4_is_local_addr(a);
571 assert(addr->family == AF_UNSPEC);
572 return 0; /* we don't know; assume not */
576 int sk_addrtype(SockAddr addr)
578 return (addr->family == AF_INET ? ADDRTYPE_IPV4 :
580 addr->family == AF_INET6 ? ADDRTYPE_IPV6 :
585 void sk_addrcopy(SockAddr addr, char *buf)
587 assert(addr->family != AF_UNSPEC);
590 if (addr->family == AF_INET)
591 memcpy(buf, &((struct sockaddr_in *)addr->ai->ai_addr)->sin_addr,
592 sizeof(struct in_addr));
593 else if (addr->family == AF_INET6)
594 memcpy(buf, &((struct sockaddr_in6 *)addr->ai->ai_addr)->sin6_addr,
595 sizeof(struct in6_addr));
600 if (addr->family == AF_INET) {
602 assert(addr->addresses && addr->curraddr < addr->naddresses);
603 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
604 memcpy(buf, (char*) &a.s_addr, 4);
608 void sk_addr_free(SockAddr addr)
611 if (addr->ais && p_freeaddrinfo)
612 p_freeaddrinfo(addr->ais);
615 sfree(addr->addresses);
619 static Plug sk_tcp_plug(Socket sock, Plug p)
621 Actual_Socket s = (Actual_Socket) sock;
628 static void sk_tcp_flush(Socket s)
631 * We send data to the socket as soon as we can anyway,
632 * so we don't need to do anything here. :-)
636 static void sk_tcp_close(Socket s);
637 static int sk_tcp_write(Socket s, const char *data, int len);
638 static int sk_tcp_write_oob(Socket s, const char *data, int len);
639 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
640 static void *sk_tcp_get_private_ptr(Socket s);
641 static void sk_tcp_set_frozen(Socket s, int is_frozen);
642 static const char *sk_tcp_socket_error(Socket s);
644 extern char *do_select(SOCKET skt, int startup);
646 Socket sk_register(void *sock, Plug plug)
648 static const struct socket_function_table fn_table = {
654 sk_tcp_set_private_ptr,
655 sk_tcp_get_private_ptr,
665 * Create Socket structure.
667 ret = snew(struct Socket_tag);
671 bufchain_init(&ret->output_data);
672 ret->writable = 1; /* to start with */
673 ret->sending_oob = 0;
675 ret->frozen_readable = 0;
676 ret->localhost_only = 0; /* unused, but best init anyway */
677 ret->pending_error = 0;
678 ret->parent = ret->child = NULL;
681 ret->s = (SOCKET)sock;
683 if (ret->s == INVALID_SOCKET) {
684 err = p_WSAGetLastError();
685 ret->error = winsock_error_string(err);
691 /* Set up a select mechanism. This could be an AsyncSelect on a
692 * window, or an EventSelect on an event object. */
693 errstr = do_select(ret->s, 1);
704 static DWORD try_connect(Actual_Socket sock)
716 if (sock->s != INVALID_SOCKET) {
717 do_select(sock->s, 0);
718 p_closesocket(sock->s);
721 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
727 /* Let's default to IPv6, this shouldn't hurt anybody
728 * If the stack supports IPv6 it will also allow IPv4 connections. */
729 if (sock->addr->ai) {
730 family = sock->addr->ai->ai_family;
734 /* Default to IPv4 */
738 s = p_socket(family, SOCK_STREAM, 0);
741 if (s == INVALID_SOCKET) {
742 err = p_WSAGetLastError();
743 sock->error = winsock_error_string(err);
747 if (sock->oobinline) {
749 p_setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
754 p_setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
757 if (sock->keepalive) {
759 p_setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
763 * Bind to local address.
766 localport = 1023; /* count from 1023 downwards */
768 localport = 0; /* just use port 0 (ie winsock picks) */
770 /* Loop round trying to bind */
775 if (family == AF_INET6) {
776 memset(&a6, 0, sizeof(a6));
777 a6.sin6_family = AF_INET6;
778 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
779 a6.sin6_port = p_htons(localport);
783 a.sin_family = AF_INET;
784 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
785 a.sin_port = p_htons(localport);
788 sockcode = p_bind(s, (sock->addr->family == AF_INET6 ?
789 (struct sockaddr *) &a6 :
790 (struct sockaddr *) &a),
791 (sock->addr->family ==
792 AF_INET6 ? sizeof(a6) : sizeof(a)));
794 sockcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
796 if (sockcode != SOCKET_ERROR) {
800 err = p_WSAGetLastError();
801 if (err != WSAEADDRINUSE) /* failed, for a bad reason */
806 break; /* we're only looping once */
809 break; /* we might have got to the end */
813 sock->error = winsock_error_string(err);
818 * Connect to remote address.
821 if (sock->addr->ai) {
822 if (family == AF_INET6) {
823 a6.sin6_family = AF_INET6;
824 a6.sin6_port = p_htons((short) sock->port);
826 ((struct sockaddr_in6 *) sock->addr->ai->ai_addr)->sin6_addr;
828 a.sin_family = AF_INET;
830 ((struct sockaddr_in *) sock->addr->ai->ai_addr)->sin_addr;
831 a.sin_port = p_htons((short) sock->port);
836 assert(sock->addr->addresses && sock->addr->curraddr < sock->addr->naddresses);
837 a.sin_family = AF_INET;
838 a.sin_addr.s_addr = p_htonl(sock->addr->addresses[sock->addr->curraddr]);
839 a.sin_port = p_htons((short) sock->port);
842 /* Set up a select mechanism. This could be an AsyncSelect on a
843 * window, or an EventSelect on an event object. */
844 errstr = do_select(s, 1);
846 sock->error = errstr;
854 ((family == AF_INET6) ? (struct sockaddr *) &a6 :
855 (struct sockaddr *) &a),
856 (family == AF_INET6) ? sizeof(a6) : sizeof(a))
858 p_connect(s, (struct sockaddr *) &a, sizeof(a))
861 err = p_WSAGetLastError();
863 * We expect a potential EWOULDBLOCK here, because the
864 * chances are the front end has done a select for
865 * FD_CONNECT, so that connect() will complete
868 if ( err != WSAEWOULDBLOCK ) {
869 sock->error = winsock_error_string(err);
874 * If we _don't_ get EWOULDBLOCK, the connect has completed
875 * and we should set the socket as writable.
880 add234(sktree, sock);
886 plug_log(sock->plug, 1, sock->addr, sock->port, sock->error, err);
890 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
891 int nodelay, int keepalive, Plug plug)
893 static const struct socket_function_table fn_table = {
899 sk_tcp_set_private_ptr,
900 sk_tcp_get_private_ptr,
909 * Create Socket structure.
911 ret = snew(struct Socket_tag);
915 bufchain_init(&ret->output_data);
916 ret->connected = 0; /* to start with */
917 ret->writable = 0; /* to start with */
918 ret->sending_oob = 0;
920 ret->frozen_readable = 0;
921 ret->localhost_only = 0; /* unused, but best init anyway */
922 ret->pending_error = 0;
923 ret->parent = ret->child = NULL;
924 ret->oobinline = oobinline;
925 ret->nodelay = nodelay;
926 ret->keepalive = keepalive;
927 ret->privport = privport;
930 ret->s = INVALID_SOCKET;
934 err = try_connect(ret);
935 } while (err && sk_nextaddr(ret->addr));
940 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only,
941 int orig_address_family)
943 static const struct socket_function_table fn_table = {
949 sk_tcp_set_private_ptr,
950 sk_tcp_get_private_ptr,
970 * Create Socket structure.
972 ret = snew(struct Socket_tag);
976 bufchain_init(&ret->output_data);
977 ret->writable = 0; /* to start with */
978 ret->sending_oob = 0;
980 ret->frozen_readable = 0;
981 ret->localhost_only = local_host_only;
982 ret->pending_error = 0;
983 ret->parent = ret->child = NULL;
987 * Translate address_family from platform-independent constants
988 * into local reality.
990 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
992 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
997 * Our default, if passed the `don't care' value
998 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
999 * we will also set up a second socket listening on IPv6, but
1000 * the v4 one is primary since that ought to work even on
1001 * non-v6-supporting systems.
1003 if (address_family == AF_UNSPEC) address_family = AF_INET;
1008 s = p_socket(address_family, SOCK_STREAM, 0);
1011 if (s == INVALID_SOCKET) {
1012 err = p_WSAGetLastError();
1013 ret->error = winsock_error_string(err);
1014 return (Socket) ret;
1019 p_setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
1022 if (address_family == AF_INET6) {
1023 memset(&a6, 0, sizeof(a6));
1024 a6.sin6_family = AF_INET6;
1025 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1026 * know how to do it. :-)
1027 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1028 * Thus we need either a parser that understands [2001:db8::1]:80
1029 * style addresses and/or enhance this to understand hostnames too. */
1030 if (local_host_only)
1031 a6.sin6_addr = in6addr_loopback;
1033 a6.sin6_addr = in6addr_any;
1034 a6.sin6_port = p_htons(port);
1039 a.sin_family = AF_INET;
1042 * Bind to source address. First try an explicitly
1046 a.sin_addr.s_addr = p_inet_addr(srcaddr);
1047 if (a.sin_addr.s_addr != INADDR_NONE) {
1048 /* Override localhost_only with specified listen addr. */
1049 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
1055 * ... and failing that, go with one of the standard ones.
1058 if (local_host_only)
1059 a.sin_addr.s_addr = p_htonl(INADDR_LOOPBACK);
1061 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
1064 a.sin_port = p_htons((short)port);
1067 retcode = p_bind(s, (address_family == AF_INET6 ?
1068 (struct sockaddr *) &a6 :
1069 (struct sockaddr *) &a),
1071 AF_INET6 ? sizeof(a6) : sizeof(a)));
1073 retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
1075 if (retcode != SOCKET_ERROR) {
1078 err = p_WSAGetLastError();
1083 ret->error = winsock_error_string(err);
1084 return (Socket) ret;
1088 if (p_listen(s, SOMAXCONN) == SOCKET_ERROR) {
1090 ret->error = winsock_error_string(err);
1091 return (Socket) ret;
1094 /* Set up a select mechanism. This could be an AsyncSelect on a
1095 * window, or an EventSelect on an event object. */
1096 errstr = do_select(s, 1);
1099 ret->error = errstr;
1100 return (Socket) ret;
1103 add234(sktree, ret);
1107 * If we were given ADDRTYPE_UNSPEC, we must also create an
1108 * IPv6 listening socket and link it to this one.
1110 if (address_family == AF_INET && orig_address_family == ADDRTYPE_UNSPEC) {
1111 Actual_Socket other;
1113 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
1114 local_host_only, ADDRTYPE_IPV6);
1117 if (!other->error) {
1118 other->parent = ret;
1127 return (Socket) ret;
1130 static void sk_tcp_close(Socket sock)
1132 extern char *do_select(SOCKET skt, int startup);
1133 Actual_Socket s = (Actual_Socket) sock;
1136 sk_tcp_close((Socket)s->child);
1140 p_closesocket(s->s);
1142 sk_addr_free(s->addr);
1147 * The function which tries to send on a socket once it's deemed
1150 void try_send(Actual_Socket s)
1152 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1156 int len, urgentflag;
1158 if (s->sending_oob) {
1159 urgentflag = MSG_OOB;
1160 len = s->sending_oob;
1164 bufchain_prefix(&s->output_data, &data, &len);
1166 nsent = p_send(s->s, data, len, urgentflag);
1167 noise_ultralight(nsent);
1169 err = (nsent < 0 ? p_WSAGetLastError() : 0);
1170 if ((err < WSABASEERR && nsent < 0) || err == WSAEWOULDBLOCK) {
1172 * Perfectly normal: we've sent all we can for the moment.
1174 * (Some WinSock send() implementations can return
1175 * <0 but leave no sensible error indication -
1176 * WSAGetLastError() is called but returns zero or
1177 * a small number - so we check that case and treat
1178 * it just like WSAEWOULDBLOCK.)
1180 s->writable = FALSE;
1182 } else if (nsent == 0 ||
1183 err == WSAECONNABORTED || err == WSAECONNRESET) {
1185 * If send() returns CONNABORTED or CONNRESET, we
1186 * unfortunately can't just call plug_closing(),
1187 * because it's quite likely that we're currently
1188 * _in_ a call from the code we'd be calling back
1189 * to, so we'd have to make half the SSH code
1190 * reentrant. Instead we flag a pending error on
1191 * the socket, to be dealt with (by calling
1192 * plug_closing()) at some suitable future moment.
1194 s->pending_error = err;
1197 /* We're inside the Windows frontend here, so we know
1198 * that the frontend handle is unnecessary. */
1199 logevent(NULL, winsock_error_string(err));
1200 fatalbox("%s", winsock_error_string(err));
1203 if (s->sending_oob) {
1205 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1206 s->sending_oob = len - nsent;
1211 bufchain_consume(&s->output_data, nsent);
1217 static int sk_tcp_write(Socket sock, const char *buf, int len)
1219 Actual_Socket s = (Actual_Socket) sock;
1222 * Add the data to the buffer list on the socket.
1224 bufchain_add(&s->output_data, buf, len);
1227 * Now try sending from the start of the buffer list.
1232 return bufchain_size(&s->output_data);
1235 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1237 Actual_Socket s = (Actual_Socket) sock;
1240 * Replace the buffer list on the socket with the data.
1242 bufchain_clear(&s->output_data);
1243 assert(len <= sizeof(s->oobdata));
1244 memcpy(s->oobdata, buf, len);
1245 s->sending_oob = len;
1248 * Now try sending from the start of the buffer list.
1253 return s->sending_oob;
1256 int select_result(WPARAM wParam, LPARAM lParam)
1260 char buf[20480]; /* nice big buffer for plenty of speed */
1264 /* wParam is the socket itself */
1267 return 1; /* boggle */
1269 s = find234(sktree, (void *) wParam, cmpforsearch);
1271 return 1; /* boggle */
1273 if ((err = WSAGETSELECTERROR(lParam)) != 0) {
1275 * An error has occurred on this socket. Pass it to the
1279 plug_log(s->plug, 1, s->addr, s->port,
1280 winsock_error_string(err), err);
1281 while (s->addr && sk_nextaddr(s->addr)) {
1282 err = try_connect(s);
1286 return plug_closing(s->plug, winsock_error_string(err), err, 0);
1291 noise_ultralight(lParam);
1293 switch (WSAGETSELECTEVENT(lParam)) {
1295 s->connected = s->writable = 1;
1297 * Once a socket is connected, we can stop falling
1298 * back through the candidate addresses to connect
1302 sk_addr_free(s->addr);
1307 /* In the case the socket is still frozen, we don't even bother */
1309 s->frozen_readable = 1;
1314 * We have received data on the socket. For an oobinline
1315 * socket, this might be data _before_ an urgent pointer,
1316 * in which case we send it to the back end with type==1
1317 * (data prior to urgent).
1321 p_ioctlsocket(s->s, SIOCATMARK, &atmark);
1323 * Avoid checking the return value from ioctlsocket(),
1324 * on the grounds that some WinSock wrappers don't
1325 * support it. If it does nothing, we get atmark==1,
1326 * which is equivalent to `no OOB pending', so the
1327 * effect will be to non-OOB-ify any OOB data.
1332 ret = p_recv(s->s, buf, sizeof(buf), 0);
1333 noise_ultralight(ret);
1335 err = p_WSAGetLastError();
1336 if (err == WSAEWOULDBLOCK) {
1341 return plug_closing(s->plug, winsock_error_string(err), err,
1343 } else if (0 == ret) {
1344 return plug_closing(s->plug, NULL, 0, 0);
1346 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1351 * This will only happen on a non-oobinline socket. It
1352 * indicates that we can immediately perform an OOB read
1353 * and get back OOB data, which we will send to the back
1354 * end with type==2 (urgent data).
1356 ret = p_recv(s->s, buf, sizeof(buf), MSG_OOB);
1357 noise_ultralight(ret);
1359 char *str = (ret == 0 ? "Internal networking trouble" :
1360 winsock_error_string(p_WSAGetLastError()));
1361 /* We're inside the Windows frontend here, so we know
1362 * that the frontend handle is unnecessary. */
1363 logevent(NULL, str);
1364 fatalbox("%s", str);
1366 return plug_receive(s->plug, 2, buf, ret);
1371 int bufsize_before, bufsize_after;
1373 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1375 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1376 if (bufsize_after < bufsize_before)
1377 plug_sent(s->plug, bufsize_after);
1381 /* Signal a close on the socket. First read any outstanding data. */
1384 ret = p_recv(s->s, buf, sizeof(buf), 0);
1386 err = p_WSAGetLastError();
1387 if (err == WSAEWOULDBLOCK)
1389 return plug_closing(s->plug, winsock_error_string(err),
1393 open &= plug_receive(s->plug, 0, buf, ret);
1395 open &= plug_closing(s->plug, NULL, 0, 0);
1402 struct sockaddr_in isa;
1404 struct sockaddr_storage isa;
1406 int addrlen = sizeof(isa);
1407 SOCKET t; /* socket of connection */
1409 memset(&isa, 0, sizeof(isa));
1411 t = p_accept(s->s,(struct sockaddr *)&isa,&addrlen);
1412 if (t == INVALID_SOCKET)
1414 err = p_WSAGetLastError();
1415 if (err == WSATRY_AGAIN)
1419 if (isa.ss_family == AF_INET &&
1420 s->localhost_only &&
1421 !ipv4_is_local_addr(((struct sockaddr_in *)&isa)->sin_addr)) {
1423 if (s->localhost_only && !ipv4_is_local_addr(isa.sin_addr)) {
1425 p_closesocket(t); /* dodgy WinSock let nonlocal through */
1426 } else if (plug_accepting(s->plug, (void*)t)) {
1427 p_closesocket(t); /* denied or error */
1436 * Deal with socket errors detected in try_send().
1438 void net_pending_errors(void)
1444 * This might be a fiddly business, because it's just possible
1445 * that handling a pending error on one socket might cause
1446 * others to be closed. (I can't think of any reason this might
1447 * happen in current SSH implementation, but to maintain
1448 * generality of this network layer I'll assume the worst.)
1450 * So what we'll do is search the socket list for _one_ socket
1451 * with a pending error, and then handle it, and then search
1452 * the list again _from the beginning_. Repeat until we make a
1453 * pass with no socket errors present. That way we are
1454 * protected against the socket list changing under our feet.
1458 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1459 if (s->pending_error) {
1461 * An error has occurred on this socket. Pass it to the
1464 plug_closing(s->plug,
1465 winsock_error_string(s->pending_error),
1466 s->pending_error, 0);
1474 * Each socket abstraction contains a `void *' private field in
1475 * which the client can keep state.
1477 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1479 Actual_Socket s = (Actual_Socket) sock;
1480 s->private_ptr = ptr;
1483 static void *sk_tcp_get_private_ptr(Socket sock)
1485 Actual_Socket s = (Actual_Socket) sock;
1486 return s->private_ptr;
1490 * Special error values are returned from sk_namelookup and sk_new
1491 * if there's a problem. These functions extract an error message,
1492 * or return NULL if there's no problem.
1494 const char *sk_addr_error(SockAddr addr)
1498 static const char *sk_tcp_socket_error(Socket sock)
1500 Actual_Socket s = (Actual_Socket) sock;
1504 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1506 Actual_Socket s = (Actual_Socket) sock;
1507 if (s->frozen == is_frozen)
1509 s->frozen = is_frozen;
1510 if (!is_frozen && s->frozen_readable) {
1512 p_recv(s->s, &c, 1, MSG_PEEK);
1514 s->frozen_readable = 0;
1518 * For Plink: enumerate all sockets currently active.
1520 SOCKET first_socket(int *state)
1524 s = index234(sktree, (*state)++);
1525 return s ? s->s : INVALID_SOCKET;
1528 SOCKET next_socket(int *state)
1530 Actual_Socket s = index234(sktree, (*state)++);
1531 return s ? s->s : INVALID_SOCKET;
1534 extern int socket_writable(SOCKET skt)
1536 Actual_Socket s = find234(sktree, (void *)skt, cmpforsearch);
1539 return bufchain_size(&s->output_data) > 0;
1544 int net_service_lookup(char *service)
1547 se = p_getservbyname(service, NULL);
1549 return p_ntohs(se->s_port);
1554 SockAddr platform_get_x11_unix_address(int displaynum, char **canonicalname)
1556 SockAddr ret = snew(struct SockAddr_tag);
1557 memset(ret, 0, sizeof(struct SockAddr_tag));
1558 ret->error = "unix sockets not supported on this platform";