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);
256 FreeLibrary(wship6_module);
260 char *winsock_error_string(int error)
264 return "Network error: Permission denied";
266 return "Network error: Address already in use";
267 case WSAEADDRNOTAVAIL:
268 return "Network error: Cannot assign requested address";
269 case WSAEAFNOSUPPORT:
271 "Network error: Address family not supported by protocol family";
273 return "Network error: Operation already in progress";
274 case WSAECONNABORTED:
275 return "Network error: Software caused connection abort";
276 case WSAECONNREFUSED:
277 return "Network error: Connection refused";
279 return "Network error: Connection reset by peer";
280 case WSAEDESTADDRREQ:
281 return "Network error: Destination address required";
283 return "Network error: Bad address";
285 return "Network error: Host is down";
286 case WSAEHOSTUNREACH:
287 return "Network error: No route to host";
289 return "Network error: Operation now in progress";
291 return "Network error: Interrupted function call";
293 return "Network error: Invalid argument";
295 return "Network error: Socket is already connected";
297 return "Network error: Too many open files";
299 return "Network error: Message too long";
301 return "Network error: Network is down";
303 return "Network error: Network dropped connection on reset";
305 return "Network error: Network is unreachable";
307 return "Network error: No buffer space available";
309 return "Network error: Bad protocol option";
311 return "Network error: Socket is not connected";
313 return "Network error: Socket operation on non-socket";
315 return "Network error: Operation not supported";
316 case WSAEPFNOSUPPORT:
317 return "Network error: Protocol family not supported";
319 return "Network error: Too many processes";
320 case WSAEPROTONOSUPPORT:
321 return "Network error: Protocol not supported";
323 return "Network error: Protocol wrong type for socket";
325 return "Network error: Cannot send after socket shutdown";
326 case WSAESOCKTNOSUPPORT:
327 return "Network error: Socket type not supported";
329 return "Network error: Connection timed out";
331 return "Network error: Resource temporarily unavailable";
333 return "Network error: Graceful shutdown in progress";
335 return "Unknown network error";
339 SockAddr sk_namelookup(const char *host, char **canonicalname,
342 SockAddr ret = snew(struct SockAddr_tag);
344 struct hostent *h = NULL;
349 /* Clear the structure and default to IPv4. */
350 memset(ret, 0, sizeof(struct SockAddr_tag));
351 ret->family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
353 address_family == ADDRTYPE_IPV6 ? AF_INET6 :
356 ret_family = AF_UNSPEC;
359 if ((a = p_inet_addr(host)) == (unsigned long) INADDR_NONE) {
362 * Use getaddrinfo when it's available
365 struct addrinfo hints;
366 memset(&hints, 0, sizeof(hints));
367 hints.ai_family = ret->family;
368 if ((err = p_getaddrinfo(host, NULL, &hints, &ret->ais)) == 0)
369 ret_family = ret->ais->ai_family;
375 * Otherwise use the IPv4-only gethostbyname...
376 * (NOTE: we don't use gethostbyname as a fallback!)
378 if ( (h = p_gethostbyname(host)) )
379 ret_family = AF_INET;
381 err = p_WSAGetLastError();
384 if (ret_family == AF_UNSPEC) {
385 ret->error = (err == WSAENETDOWN ? "Network is down" :
386 err == WSAHOST_NOT_FOUND ? "Host does not exist" :
387 err == WSATRY_AGAIN ? "Host not found" :
389 p_getaddrinfo ? "getaddrinfo: unknown error" :
391 "gethostbyname: unknown error");
394 ret->family = ret_family;
397 /* If we got an address info use that... */
399 /* Are we in IPv4 fallback mode? */
400 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
401 if (ret->family == AF_INET)
403 (char *) &((SOCKADDR_IN *) ret->ai->
404 ai_addr)->sin_addr, sizeof(a));
406 /* Now let's find that canonicalname... */
409 ((struct sockaddr *) ret->ai->ai_addr,
411 AF_INET ? sizeof(SOCKADDR_IN) :
412 sizeof(SOCKADDR_IN6), realhost,
413 sizeof(realhost), NULL, 0, 0) != 0) {
414 strncpy(realhost, host, sizeof(realhost));
418 /* We used the IPv4-only gethostbyname()... */
423 for (n = 0; h->h_addr_list[n]; n++);
424 ret->addresses = snewn(n, unsigned long);
426 for (n = 0; n < ret->naddresses; n++) {
427 memcpy(&a, h->h_addr_list[n], sizeof(a));
428 ret->addresses[n] = p_ntohl(a);
431 memcpy(&a, h->h_addr, sizeof(a));
432 /* This way we are always sure the h->h_name is valid :) */
433 strncpy(realhost, h->h_name, sizeof(realhost));
438 * This must be a numeric IPv4 address because it caused a
439 * success return from inet_addr.
441 ret->addresses = snewn(1, unsigned long);
444 ret->addresses[0] = p_ntohl(a);
445 ret->family = AF_INET;
446 strncpy(realhost, host, sizeof(realhost));
448 realhost[lenof(realhost)-1] = '\0';
449 *canonicalname = snewn(1+strlen(realhost), char);
450 strcpy(*canonicalname, realhost);
454 SockAddr sk_nonamelookup(const char *host)
456 SockAddr ret = snew(struct SockAddr_tag);
458 ret->family = AF_UNSPEC;
459 strncpy(ret->hostname, host, lenof(ret->hostname));
460 ret->hostname[lenof(ret->hostname)-1] = '\0';
464 int sk_nextaddr(SockAddr addr)
468 if (addr->ai->ai_next) {
469 addr->ai = addr->ai->ai_next;
470 addr->family = addr->ai->ai_family;
476 if (addr->curraddr+1 < addr->naddresses) {
484 void sk_getaddr(SockAddr addr, char *buf, int buflen)
488 /* Try to get the WSAAddressToStringA() function from wship6.dll */
489 /* This way one doesn't need to have IPv6 dll's to use PuTTY and
490 * it will fallback to IPv4. */
491 typedef int (CALLBACK * FADDRTOSTR) (LPSOCKADDR lpsaAddress,
492 DWORD dwAddressLength,
493 LPWSAPROTOCOL_INFO lpProtocolInfo,
494 OUT LPTSTR lpszAddressString,
495 IN OUT LPDWORD lpdwAddressStringLength
497 FADDRTOSTR fAddrToStr = NULL;
499 HINSTANCE dllWS2 = LoadLibrary("ws2_32.dll");
501 fAddrToStr = (FADDRTOSTR)GetProcAddress(dllWS2,
502 "WSAAddressToStringA");
504 fAddrToStr(addr->ai->ai_addr, addr->ai->ai_addrlen,
507 else strncpy(buf, "IPv6", buflen);
512 if (addr->family == AF_INET) {
514 assert(addr->addresses && addr->curraddr < addr->naddresses);
515 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
516 strncpy(buf, p_inet_ntoa(a), buflen);
517 buf[buflen-1] = '\0';
519 strncpy(buf, addr->hostname, buflen);
520 buf[buflen-1] = '\0';
524 int sk_hostname_is_local(char *name)
526 return !strcmp(name, "localhost");
529 static INTERFACE_INFO local_interfaces[16];
530 static int n_local_interfaces; /* 0=not yet, -1=failed, >0=number */
532 static int ipv4_is_local_addr(struct in_addr addr)
534 if (ipv4_is_loopback(addr))
535 return 1; /* loopback addresses are local */
536 if (!n_local_interfaces) {
537 SOCKET s = p_socket(AF_INET, SOCK_DGRAM, 0);
541 p_WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0,
542 local_interfaces, sizeof(local_interfaces),
543 &retbytes, NULL, NULL) == 0)
544 n_local_interfaces = retbytes / sizeof(INTERFACE_INFO);
546 logevent(NULL, "Unable to get list of local IP addresses");
548 if (n_local_interfaces > 0) {
550 for (i = 0; i < n_local_interfaces; i++) {
551 SOCKADDR_IN *address =
552 (SOCKADDR_IN *)&local_interfaces[i].iiAddress;
553 if (address->sin_addr.s_addr == addr.s_addr)
554 return 1; /* this address is local */
557 return 0; /* this address is not local */
560 int sk_address_is_local(SockAddr addr)
563 if (addr->family == AF_INET6) {
564 return IN6_IS_ADDR_LOOPBACK((const struct in6_addr *)addr->ai->ai_addr);
567 if (addr->family == AF_INET) {
569 assert(addr->addresses && addr->curraddr < addr->naddresses);
570 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
571 return ipv4_is_local_addr(a);
573 assert(addr->family == AF_UNSPEC);
574 return 0; /* we don't know; assume not */
578 int sk_addrtype(SockAddr addr)
580 return (addr->family == AF_INET ? ADDRTYPE_IPV4 :
582 addr->family == AF_INET6 ? ADDRTYPE_IPV6 :
587 void sk_addrcopy(SockAddr addr, char *buf)
589 assert(addr->family != AF_UNSPEC);
592 if (addr->family == AF_INET)
593 memcpy(buf, &((struct sockaddr_in *)addr->ai->ai_addr)->sin_addr,
594 sizeof(struct in_addr));
595 else if (addr->family == AF_INET6)
596 memcpy(buf, &((struct sockaddr_in6 *)addr->ai->ai_addr)->sin6_addr,
597 sizeof(struct in6_addr));
602 if (addr->family == AF_INET) {
604 assert(addr->addresses && addr->curraddr < addr->naddresses);
605 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
606 memcpy(buf, (char*) &a.s_addr, 4);
610 void sk_addr_free(SockAddr addr)
613 if (addr->ais && p_freeaddrinfo)
614 p_freeaddrinfo(addr->ais);
617 sfree(addr->addresses);
621 static Plug sk_tcp_plug(Socket sock, Plug p)
623 Actual_Socket s = (Actual_Socket) sock;
630 static void sk_tcp_flush(Socket s)
633 * We send data to the socket as soon as we can anyway,
634 * so we don't need to do anything here. :-)
638 static void sk_tcp_close(Socket s);
639 static int sk_tcp_write(Socket s, const char *data, int len);
640 static int sk_tcp_write_oob(Socket s, const char *data, int len);
641 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
642 static void *sk_tcp_get_private_ptr(Socket s);
643 static void sk_tcp_set_frozen(Socket s, int is_frozen);
644 static const char *sk_tcp_socket_error(Socket s);
646 extern char *do_select(SOCKET skt, int startup);
648 Socket sk_register(void *sock, Plug plug)
650 static const struct socket_function_table fn_table = {
656 sk_tcp_set_private_ptr,
657 sk_tcp_get_private_ptr,
667 * Create Socket structure.
669 ret = snew(struct Socket_tag);
673 bufchain_init(&ret->output_data);
674 ret->writable = 1; /* to start with */
675 ret->sending_oob = 0;
677 ret->frozen_readable = 0;
678 ret->localhost_only = 0; /* unused, but best init anyway */
679 ret->pending_error = 0;
680 ret->parent = ret->child = NULL;
683 ret->s = (SOCKET)sock;
685 if (ret->s == INVALID_SOCKET) {
686 err = p_WSAGetLastError();
687 ret->error = winsock_error_string(err);
693 /* Set up a select mechanism. This could be an AsyncSelect on a
694 * window, or an EventSelect on an event object. */
695 errstr = do_select(ret->s, 1);
706 static DWORD try_connect(Actual_Socket sock)
718 if (sock->s != INVALID_SOCKET) {
719 do_select(sock->s, 0);
720 p_closesocket(sock->s);
723 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
729 /* Let's default to IPv6, this shouldn't hurt anybody
730 * If the stack supports IPv6 it will also allow IPv4 connections. */
731 if (sock->addr->ai) {
732 family = sock->addr->ai->ai_family;
736 /* Default to IPv4 */
740 s = p_socket(family, SOCK_STREAM, 0);
743 if (s == INVALID_SOCKET) {
744 err = p_WSAGetLastError();
745 sock->error = winsock_error_string(err);
749 if (sock->oobinline) {
751 p_setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
756 p_setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
759 if (sock->keepalive) {
761 p_setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
765 * Bind to local address.
768 localport = 1023; /* count from 1023 downwards */
770 localport = 0; /* just use port 0 (ie winsock picks) */
772 /* Loop round trying to bind */
777 if (family == AF_INET6) {
778 memset(&a6, 0, sizeof(a6));
779 a6.sin6_family = AF_INET6;
780 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
781 a6.sin6_port = p_htons(localport);
785 a.sin_family = AF_INET;
786 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
787 a.sin_port = p_htons(localport);
790 sockcode = p_bind(s, (sock->addr->family == AF_INET6 ?
791 (struct sockaddr *) &a6 :
792 (struct sockaddr *) &a),
793 (sock->addr->family ==
794 AF_INET6 ? sizeof(a6) : sizeof(a)));
796 sockcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
798 if (sockcode != SOCKET_ERROR) {
802 err = p_WSAGetLastError();
803 if (err != WSAEADDRINUSE) /* failed, for a bad reason */
808 break; /* we're only looping once */
811 break; /* we might have got to the end */
815 sock->error = winsock_error_string(err);
820 * Connect to remote address.
823 if (sock->addr->ai) {
824 if (family == AF_INET6) {
825 a6.sin6_family = AF_INET6;
826 a6.sin6_port = p_htons((short) sock->port);
828 ((struct sockaddr_in6 *) sock->addr->ai->ai_addr)->sin6_addr;
830 a.sin_family = AF_INET;
832 ((struct sockaddr_in *) sock->addr->ai->ai_addr)->sin_addr;
833 a.sin_port = p_htons((short) sock->port);
838 assert(sock->addr->addresses && sock->addr->curraddr < sock->addr->naddresses);
839 a.sin_family = AF_INET;
840 a.sin_addr.s_addr = p_htonl(sock->addr->addresses[sock->addr->curraddr]);
841 a.sin_port = p_htons((short) sock->port);
844 /* Set up a select mechanism. This could be an AsyncSelect on a
845 * window, or an EventSelect on an event object. */
846 errstr = do_select(s, 1);
848 sock->error = errstr;
856 ((family == AF_INET6) ? (struct sockaddr *) &a6 :
857 (struct sockaddr *) &a),
858 (family == AF_INET6) ? sizeof(a6) : sizeof(a))
860 p_connect(s, (struct sockaddr *) &a, sizeof(a))
863 err = p_WSAGetLastError();
865 * We expect a potential EWOULDBLOCK here, because the
866 * chances are the front end has done a select for
867 * FD_CONNECT, so that connect() will complete
870 if ( err != WSAEWOULDBLOCK ) {
871 sock->error = winsock_error_string(err);
876 * If we _don't_ get EWOULDBLOCK, the connect has completed
877 * and we should set the socket as writable.
882 add234(sktree, sock);
888 plug_log(sock->plug, 1, sock->addr, sock->port, sock->error, err);
892 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
893 int nodelay, int keepalive, Plug plug)
895 static const struct socket_function_table fn_table = {
901 sk_tcp_set_private_ptr,
902 sk_tcp_get_private_ptr,
911 * Create Socket structure.
913 ret = snew(struct Socket_tag);
917 bufchain_init(&ret->output_data);
918 ret->connected = 0; /* to start with */
919 ret->writable = 0; /* to start with */
920 ret->sending_oob = 0;
922 ret->frozen_readable = 0;
923 ret->localhost_only = 0; /* unused, but best init anyway */
924 ret->pending_error = 0;
925 ret->parent = ret->child = NULL;
926 ret->oobinline = oobinline;
927 ret->nodelay = nodelay;
928 ret->keepalive = keepalive;
929 ret->privport = privport;
932 ret->s = INVALID_SOCKET;
936 err = try_connect(ret);
937 } while (err && sk_nextaddr(ret->addr));
942 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only,
943 int orig_address_family)
945 static const struct socket_function_table fn_table = {
951 sk_tcp_set_private_ptr,
952 sk_tcp_get_private_ptr,
972 * Create Socket structure.
974 ret = snew(struct Socket_tag);
978 bufchain_init(&ret->output_data);
979 ret->writable = 0; /* to start with */
980 ret->sending_oob = 0;
982 ret->frozen_readable = 0;
983 ret->localhost_only = local_host_only;
984 ret->pending_error = 0;
985 ret->parent = ret->child = NULL;
989 * Translate address_family from platform-independent constants
990 * into local reality.
992 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
994 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
999 * Our default, if passed the `don't care' value
1000 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1001 * we will also set up a second socket listening on IPv6, but
1002 * the v4 one is primary since that ought to work even on
1003 * non-v6-supporting systems.
1005 if (address_family == AF_UNSPEC) address_family = AF_INET;
1010 s = p_socket(address_family, SOCK_STREAM, 0);
1013 if (s == INVALID_SOCKET) {
1014 err = p_WSAGetLastError();
1015 ret->error = winsock_error_string(err);
1016 return (Socket) ret;
1021 p_setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
1024 if (address_family == AF_INET6) {
1025 memset(&a6, 0, sizeof(a6));
1026 a6.sin6_family = AF_INET6;
1027 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1028 * know how to do it. :-)
1029 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1030 * Thus we need either a parser that understands [2001:db8::1]:80
1031 * style addresses and/or enhance this to understand hostnames too. */
1032 if (local_host_only)
1033 a6.sin6_addr = in6addr_loopback;
1035 a6.sin6_addr = in6addr_any;
1036 a6.sin6_port = p_htons(port);
1041 a.sin_family = AF_INET;
1044 * Bind to source address. First try an explicitly
1048 a.sin_addr.s_addr = p_inet_addr(srcaddr);
1049 if (a.sin_addr.s_addr != INADDR_NONE) {
1050 /* Override localhost_only with specified listen addr. */
1051 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
1057 * ... and failing that, go with one of the standard ones.
1060 if (local_host_only)
1061 a.sin_addr.s_addr = p_htonl(INADDR_LOOPBACK);
1063 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
1066 a.sin_port = p_htons((short)port);
1069 retcode = p_bind(s, (address_family == AF_INET6 ?
1070 (struct sockaddr *) &a6 :
1071 (struct sockaddr *) &a),
1073 AF_INET6 ? sizeof(a6) : sizeof(a)));
1075 retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
1077 if (retcode != SOCKET_ERROR) {
1080 err = p_WSAGetLastError();
1085 ret->error = winsock_error_string(err);
1086 return (Socket) ret;
1090 if (p_listen(s, SOMAXCONN) == SOCKET_ERROR) {
1092 ret->error = winsock_error_string(err);
1093 return (Socket) ret;
1096 /* Set up a select mechanism. This could be an AsyncSelect on a
1097 * window, or an EventSelect on an event object. */
1098 errstr = do_select(s, 1);
1101 ret->error = errstr;
1102 return (Socket) ret;
1105 add234(sktree, ret);
1109 * If we were given ADDRTYPE_UNSPEC, we must also create an
1110 * IPv6 listening socket and link it to this one.
1112 if (address_family == AF_INET && orig_address_family == ADDRTYPE_UNSPEC) {
1113 Actual_Socket other;
1115 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
1116 local_host_only, ADDRTYPE_IPV6);
1119 if (!other->error) {
1120 other->parent = ret;
1129 return (Socket) ret;
1132 static void sk_tcp_close(Socket sock)
1134 extern char *do_select(SOCKET skt, int startup);
1135 Actual_Socket s = (Actual_Socket) sock;
1138 sk_tcp_close((Socket)s->child);
1142 p_closesocket(s->s);
1144 sk_addr_free(s->addr);
1149 * The function which tries to send on a socket once it's deemed
1152 void try_send(Actual_Socket s)
1154 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1158 int len, urgentflag;
1160 if (s->sending_oob) {
1161 urgentflag = MSG_OOB;
1162 len = s->sending_oob;
1166 bufchain_prefix(&s->output_data, &data, &len);
1168 nsent = p_send(s->s, data, len, urgentflag);
1169 noise_ultralight(nsent);
1171 err = (nsent < 0 ? p_WSAGetLastError() : 0);
1172 if ((err < WSABASEERR && nsent < 0) || err == WSAEWOULDBLOCK) {
1174 * Perfectly normal: we've sent all we can for the moment.
1176 * (Some WinSock send() implementations can return
1177 * <0 but leave no sensible error indication -
1178 * WSAGetLastError() is called but returns zero or
1179 * a small number - so we check that case and treat
1180 * it just like WSAEWOULDBLOCK.)
1182 s->writable = FALSE;
1184 } else if (nsent == 0 ||
1185 err == WSAECONNABORTED || err == WSAECONNRESET) {
1187 * If send() returns CONNABORTED or CONNRESET, we
1188 * unfortunately can't just call plug_closing(),
1189 * because it's quite likely that we're currently
1190 * _in_ a call from the code we'd be calling back
1191 * to, so we'd have to make half the SSH code
1192 * reentrant. Instead we flag a pending error on
1193 * the socket, to be dealt with (by calling
1194 * plug_closing()) at some suitable future moment.
1196 s->pending_error = err;
1199 /* We're inside the Windows frontend here, so we know
1200 * that the frontend handle is unnecessary. */
1201 logevent(NULL, winsock_error_string(err));
1202 fatalbox("%s", winsock_error_string(err));
1205 if (s->sending_oob) {
1207 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1208 s->sending_oob = len - nsent;
1213 bufchain_consume(&s->output_data, nsent);
1219 static int sk_tcp_write(Socket sock, const char *buf, int len)
1221 Actual_Socket s = (Actual_Socket) sock;
1224 * Add the data to the buffer list on the socket.
1226 bufchain_add(&s->output_data, buf, len);
1229 * Now try sending from the start of the buffer list.
1234 return bufchain_size(&s->output_data);
1237 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1239 Actual_Socket s = (Actual_Socket) sock;
1242 * Replace the buffer list on the socket with the data.
1244 bufchain_clear(&s->output_data);
1245 assert(len <= sizeof(s->oobdata));
1246 memcpy(s->oobdata, buf, len);
1247 s->sending_oob = len;
1250 * Now try sending from the start of the buffer list.
1255 return s->sending_oob;
1258 int select_result(WPARAM wParam, LPARAM lParam)
1262 char buf[20480]; /* nice big buffer for plenty of speed */
1266 /* wParam is the socket itself */
1269 return 1; /* boggle */
1271 s = find234(sktree, (void *) wParam, cmpforsearch);
1273 return 1; /* boggle */
1275 if ((err = WSAGETSELECTERROR(lParam)) != 0) {
1277 * An error has occurred on this socket. Pass it to the
1281 plug_log(s->plug, 1, s->addr, s->port,
1282 winsock_error_string(err), err);
1283 while (s->addr && sk_nextaddr(s->addr)) {
1284 err = try_connect(s);
1288 return plug_closing(s->plug, winsock_error_string(err), err, 0);
1293 noise_ultralight(lParam);
1295 switch (WSAGETSELECTEVENT(lParam)) {
1297 s->connected = s->writable = 1;
1299 * Once a socket is connected, we can stop falling
1300 * back through the candidate addresses to connect
1304 sk_addr_free(s->addr);
1309 /* In the case the socket is still frozen, we don't even bother */
1311 s->frozen_readable = 1;
1316 * We have received data on the socket. For an oobinline
1317 * socket, this might be data _before_ an urgent pointer,
1318 * in which case we send it to the back end with type==1
1319 * (data prior to urgent).
1323 p_ioctlsocket(s->s, SIOCATMARK, &atmark);
1325 * Avoid checking the return value from ioctlsocket(),
1326 * on the grounds that some WinSock wrappers don't
1327 * support it. If it does nothing, we get atmark==1,
1328 * which is equivalent to `no OOB pending', so the
1329 * effect will be to non-OOB-ify any OOB data.
1334 ret = p_recv(s->s, buf, sizeof(buf), 0);
1335 noise_ultralight(ret);
1337 err = p_WSAGetLastError();
1338 if (err == WSAEWOULDBLOCK) {
1343 return plug_closing(s->plug, winsock_error_string(err), err,
1345 } else if (0 == ret) {
1346 return plug_closing(s->plug, NULL, 0, 0);
1348 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1353 * This will only happen on a non-oobinline socket. It
1354 * indicates that we can immediately perform an OOB read
1355 * and get back OOB data, which we will send to the back
1356 * end with type==2 (urgent data).
1358 ret = p_recv(s->s, buf, sizeof(buf), MSG_OOB);
1359 noise_ultralight(ret);
1361 char *str = (ret == 0 ? "Internal networking trouble" :
1362 winsock_error_string(p_WSAGetLastError()));
1363 /* We're inside the Windows frontend here, so we know
1364 * that the frontend handle is unnecessary. */
1365 logevent(NULL, str);
1366 fatalbox("%s", str);
1368 return plug_receive(s->plug, 2, buf, ret);
1373 int bufsize_before, bufsize_after;
1375 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1377 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1378 if (bufsize_after < bufsize_before)
1379 plug_sent(s->plug, bufsize_after);
1383 /* Signal a close on the socket. First read any outstanding data. */
1386 ret = p_recv(s->s, buf, sizeof(buf), 0);
1388 err = p_WSAGetLastError();
1389 if (err == WSAEWOULDBLOCK)
1391 return plug_closing(s->plug, winsock_error_string(err),
1395 open &= plug_receive(s->plug, 0, buf, ret);
1397 open &= plug_closing(s->plug, NULL, 0, 0);
1404 struct sockaddr_in isa;
1406 struct sockaddr_storage isa;
1408 int addrlen = sizeof(isa);
1409 SOCKET t; /* socket of connection */
1411 memset(&isa, 0, sizeof(isa));
1413 t = p_accept(s->s,(struct sockaddr *)&isa,&addrlen);
1414 if (t == INVALID_SOCKET)
1416 err = p_WSAGetLastError();
1417 if (err == WSATRY_AGAIN)
1421 if (isa.ss_family == AF_INET &&
1422 s->localhost_only &&
1423 !ipv4_is_local_addr(((struct sockaddr_in *)&isa)->sin_addr)) {
1425 if (s->localhost_only && !ipv4_is_local_addr(isa.sin_addr)) {
1427 p_closesocket(t); /* dodgy WinSock let nonlocal through */
1428 } else if (plug_accepting(s->plug, (void*)t)) {
1429 p_closesocket(t); /* denied or error */
1438 * Deal with socket errors detected in try_send().
1440 void net_pending_errors(void)
1446 * This might be a fiddly business, because it's just possible
1447 * that handling a pending error on one socket might cause
1448 * others to be closed. (I can't think of any reason this might
1449 * happen in current SSH implementation, but to maintain
1450 * generality of this network layer I'll assume the worst.)
1452 * So what we'll do is search the socket list for _one_ socket
1453 * with a pending error, and then handle it, and then search
1454 * the list again _from the beginning_. Repeat until we make a
1455 * pass with no socket errors present. That way we are
1456 * protected against the socket list changing under our feet.
1460 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1461 if (s->pending_error) {
1463 * An error has occurred on this socket. Pass it to the
1466 plug_closing(s->plug,
1467 winsock_error_string(s->pending_error),
1468 s->pending_error, 0);
1476 * Each socket abstraction contains a `void *' private field in
1477 * which the client can keep state.
1479 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1481 Actual_Socket s = (Actual_Socket) sock;
1482 s->private_ptr = ptr;
1485 static void *sk_tcp_get_private_ptr(Socket sock)
1487 Actual_Socket s = (Actual_Socket) sock;
1488 return s->private_ptr;
1492 * Special error values are returned from sk_namelookup and sk_new
1493 * if there's a problem. These functions extract an error message,
1494 * or return NULL if there's no problem.
1496 const char *sk_addr_error(SockAddr addr)
1500 static const char *sk_tcp_socket_error(Socket sock)
1502 Actual_Socket s = (Actual_Socket) sock;
1506 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1508 Actual_Socket s = (Actual_Socket) sock;
1509 if (s->frozen == is_frozen)
1511 s->frozen = is_frozen;
1512 if (!is_frozen && s->frozen_readable) {
1514 p_recv(s->s, &c, 1, MSG_PEEK);
1516 s->frozen_readable = 0;
1520 * For Plink: enumerate all sockets currently active.
1522 SOCKET first_socket(int *state)
1526 s = index234(sktree, (*state)++);
1527 return s ? s->s : INVALID_SOCKET;
1530 SOCKET next_socket(int *state)
1532 Actual_Socket s = index234(sktree, (*state)++);
1533 return s ? s->s : INVALID_SOCKET;
1536 extern int socket_writable(SOCKET skt)
1538 Actual_Socket s = find234(sktree, (void *)skt, cmpforsearch);
1541 return bufchain_size(&s->output_data) > 0;
1546 int net_service_lookup(char *service)
1549 se = p_getservbyname(service, NULL);
1551 return p_ntohs(se->s_port);
1556 SockAddr platform_get_x11_unix_address(int displaynum, char **canonicalname)
1558 SockAddr ret = snew(struct SockAddr_tag);
1559 memset(ret, 0, sizeof(struct SockAddr_tag));
1560 ret->error = "unix sockets not supported on this platform";