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 :
357 ret->ai = ret->ais = NULL;
359 ret_family = AF_UNSPEC;
362 if ((a = p_inet_addr(host)) == (unsigned long) INADDR_NONE) {
365 * Use getaddrinfo when it's available
368 struct addrinfo hints;
369 memset(&hints, 0, sizeof(hints));
370 hints.ai_family = ret->family;
371 if ((err = p_getaddrinfo(host, NULL, &hints, &ret->ais)) == 0)
372 ret_family = ret->ais->ai_family;
378 * Otherwise use the IPv4-only gethostbyname...
379 * (NOTE: we don't use gethostbyname as a fallback!)
381 if ( (h = p_gethostbyname(host)) )
382 ret_family = AF_INET;
384 err = p_WSAGetLastError();
387 if (ret_family == AF_UNSPEC) {
388 ret->error = (err == WSAENETDOWN ? "Network is down" :
389 err == WSAHOST_NOT_FOUND ? "Host does not exist" :
390 err == WSATRY_AGAIN ? "Host not found" :
392 p_getaddrinfo ? "getaddrinfo: unknown error" :
394 "gethostbyname: unknown error");
397 ret->family = ret_family;
400 /* If we got an address info use that... */
402 /* Are we in IPv4 fallback mode? */
403 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
404 if (ret->family == AF_INET)
406 (char *) &((SOCKADDR_IN *) ret->ai->
407 ai_addr)->sin_addr, sizeof(a));
409 /* Now let's find that canonicalname... */
412 ((struct sockaddr *) ret->ai->ai_addr,
414 AF_INET ? sizeof(SOCKADDR_IN) :
415 sizeof(SOCKADDR_IN6), realhost,
416 sizeof(realhost), NULL, 0, 0) != 0) {
417 strncpy(realhost, host, sizeof(realhost));
421 /* We used the IPv4-only gethostbyname()... */
426 for (n = 0; h->h_addr_list[n]; n++);
427 ret->addresses = snewn(n, unsigned long);
429 for (n = 0; n < ret->naddresses; n++) {
430 memcpy(&a, h->h_addr_list[n], sizeof(a));
431 ret->addresses[n] = p_ntohl(a);
434 memcpy(&a, h->h_addr, sizeof(a));
435 /* This way we are always sure the h->h_name is valid :) */
436 strncpy(realhost, h->h_name, sizeof(realhost));
441 * This must be a numeric IPv4 address because it caused a
442 * success return from inet_addr.
444 ret->addresses = snewn(1, unsigned long);
447 ret->addresses[0] = p_ntohl(a);
448 ret->family = AF_INET;
449 strncpy(realhost, host, sizeof(realhost));
451 realhost[lenof(realhost)-1] = '\0';
452 *canonicalname = snewn(1+strlen(realhost), char);
453 strcpy(*canonicalname, realhost);
457 SockAddr sk_nonamelookup(const char *host)
459 SockAddr ret = snew(struct SockAddr_tag);
461 ret->family = AF_UNSPEC;
463 ret->ai = ret->ais = NULL;
466 strncpy(ret->hostname, host, lenof(ret->hostname));
467 ret->hostname[lenof(ret->hostname)-1] = '\0';
471 int sk_nextaddr(SockAddr addr)
475 if (addr->ai->ai_next) {
476 addr->ai = addr->ai->ai_next;
477 addr->family = addr->ai->ai_family;
483 if (addr->curraddr+1 < addr->naddresses) {
491 void sk_getaddr(SockAddr addr, char *buf, int buflen)
495 /* Try to get the WSAAddressToStringA() function from wship6.dll */
496 /* This way one doesn't need to have IPv6 dll's to use PuTTY and
497 * it will fallback to IPv4. */
498 typedef int (CALLBACK * FADDRTOSTR) (LPSOCKADDR lpsaAddress,
499 DWORD dwAddressLength,
500 LPWSAPROTOCOL_INFO lpProtocolInfo,
501 OUT LPTSTR lpszAddressString,
502 IN OUT LPDWORD lpdwAddressStringLength
504 FADDRTOSTR fAddrToStr = NULL;
506 HINSTANCE dllWS2 = LoadLibrary("ws2_32.dll");
508 fAddrToStr = (FADDRTOSTR)GetProcAddress(dllWS2,
509 "WSAAddressToStringA");
511 fAddrToStr(addr->ai->ai_addr, addr->ai->ai_addrlen,
514 else strncpy(buf, "IPv6", buflen);
519 if (addr->family == AF_INET) {
521 assert(addr->addresses && addr->curraddr < addr->naddresses);
522 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
523 strncpy(buf, p_inet_ntoa(a), buflen);
524 buf[buflen-1] = '\0';
526 strncpy(buf, addr->hostname, buflen);
527 buf[buflen-1] = '\0';
531 int sk_hostname_is_local(char *name)
533 return !strcmp(name, "localhost");
536 static INTERFACE_INFO local_interfaces[16];
537 static int n_local_interfaces; /* 0=not yet, -1=failed, >0=number */
539 static int ipv4_is_local_addr(struct in_addr addr)
541 if (ipv4_is_loopback(addr))
542 return 1; /* loopback addresses are local */
543 if (!n_local_interfaces) {
544 SOCKET s = p_socket(AF_INET, SOCK_DGRAM, 0);
548 p_WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0,
549 local_interfaces, sizeof(local_interfaces),
550 &retbytes, NULL, NULL) == 0)
551 n_local_interfaces = retbytes / sizeof(INTERFACE_INFO);
553 logevent(NULL, "Unable to get list of local IP addresses");
555 if (n_local_interfaces > 0) {
557 for (i = 0; i < n_local_interfaces; i++) {
558 SOCKADDR_IN *address =
559 (SOCKADDR_IN *)&local_interfaces[i].iiAddress;
560 if (address->sin_addr.s_addr == addr.s_addr)
561 return 1; /* this address is local */
564 return 0; /* this address is not local */
567 int sk_address_is_local(SockAddr addr)
570 if (addr->family == AF_INET6) {
571 return IN6_IS_ADDR_LOOPBACK((const struct in6_addr *)addr->ai->ai_addr);
574 if (addr->family == AF_INET) {
577 return ipv4_is_local_addr(((struct sockaddr_in *)addr->ai->ai_addr)
583 assert(addr->addresses && addr->curraddr < addr->naddresses);
584 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
585 return ipv4_is_local_addr(a);
588 assert(addr->family == AF_UNSPEC);
589 return 0; /* we don't know; assume not */
593 int sk_addrtype(SockAddr addr)
595 return (addr->family == AF_INET ? ADDRTYPE_IPV4 :
597 addr->family == AF_INET6 ? ADDRTYPE_IPV6 :
602 void sk_addrcopy(SockAddr addr, char *buf)
604 assert(addr->family != AF_UNSPEC);
607 if (addr->family == AF_INET)
608 memcpy(buf, &((struct sockaddr_in *)addr->ai->ai_addr)->sin_addr,
609 sizeof(struct in_addr));
610 else if (addr->family == AF_INET6)
611 memcpy(buf, &((struct sockaddr_in6 *)addr->ai->ai_addr)->sin6_addr,
612 sizeof(struct in6_addr));
617 if (addr->family == AF_INET) {
619 assert(addr->addresses && addr->curraddr < addr->naddresses);
620 a.s_addr = p_htonl(addr->addresses[addr->curraddr]);
621 memcpy(buf, (char*) &a.s_addr, 4);
625 void sk_addr_free(SockAddr addr)
628 if (addr->ais && p_freeaddrinfo)
629 p_freeaddrinfo(addr->ais);
632 sfree(addr->addresses);
636 static Plug sk_tcp_plug(Socket sock, Plug p)
638 Actual_Socket s = (Actual_Socket) sock;
645 static void sk_tcp_flush(Socket s)
648 * We send data to the socket as soon as we can anyway,
649 * so we don't need to do anything here. :-)
653 static void sk_tcp_close(Socket s);
654 static int sk_tcp_write(Socket s, const char *data, int len);
655 static int sk_tcp_write_oob(Socket s, const char *data, int len);
656 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
657 static void *sk_tcp_get_private_ptr(Socket s);
658 static void sk_tcp_set_frozen(Socket s, int is_frozen);
659 static const char *sk_tcp_socket_error(Socket s);
661 extern char *do_select(SOCKET skt, int startup);
663 Socket sk_register(void *sock, Plug plug)
665 static const struct socket_function_table fn_table = {
671 sk_tcp_set_private_ptr,
672 sk_tcp_get_private_ptr,
682 * Create Socket structure.
684 ret = snew(struct Socket_tag);
688 bufchain_init(&ret->output_data);
689 ret->writable = 1; /* to start with */
690 ret->sending_oob = 0;
692 ret->frozen_readable = 0;
693 ret->localhost_only = 0; /* unused, but best init anyway */
694 ret->pending_error = 0;
695 ret->parent = ret->child = NULL;
698 ret->s = (SOCKET)sock;
700 if (ret->s == INVALID_SOCKET) {
701 err = p_WSAGetLastError();
702 ret->error = winsock_error_string(err);
708 /* Set up a select mechanism. This could be an AsyncSelect on a
709 * window, or an EventSelect on an event object. */
710 errstr = do_select(ret->s, 1);
721 static DWORD try_connect(Actual_Socket sock)
733 if (sock->s != INVALID_SOCKET) {
734 do_select(sock->s, 0);
735 p_closesocket(sock->s);
738 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
744 /* Let's default to IPv6, this shouldn't hurt anybody
745 * If the stack supports IPv6 it will also allow IPv4 connections. */
746 if (sock->addr->ai) {
747 family = sock->addr->ai->ai_family;
751 /* Default to IPv4 */
755 s = p_socket(family, SOCK_STREAM, 0);
758 if (s == INVALID_SOCKET) {
759 err = p_WSAGetLastError();
760 sock->error = winsock_error_string(err);
764 if (sock->oobinline) {
766 p_setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
771 p_setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
774 if (sock->keepalive) {
776 p_setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
780 * Bind to local address.
783 localport = 1023; /* count from 1023 downwards */
785 localport = 0; /* just use port 0 (ie winsock picks) */
787 /* Loop round trying to bind */
792 if (family == AF_INET6) {
793 memset(&a6, 0, sizeof(a6));
794 a6.sin6_family = AF_INET6;
795 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
796 a6.sin6_port = p_htons(localport);
800 a.sin_family = AF_INET;
801 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
802 a.sin_port = p_htons(localport);
805 sockcode = p_bind(s, (sock->addr->family == AF_INET6 ?
806 (struct sockaddr *) &a6 :
807 (struct sockaddr *) &a),
808 (sock->addr->family ==
809 AF_INET6 ? sizeof(a6) : sizeof(a)));
811 sockcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
813 if (sockcode != SOCKET_ERROR) {
817 err = p_WSAGetLastError();
818 if (err != WSAEADDRINUSE) /* failed, for a bad reason */
823 break; /* we're only looping once */
826 break; /* we might have got to the end */
830 sock->error = winsock_error_string(err);
835 * Connect to remote address.
838 if (sock->addr->ai) {
839 if (family == AF_INET6) {
840 a6.sin6_family = AF_INET6;
841 a6.sin6_port = p_htons((short) sock->port);
843 ((struct sockaddr_in6 *) sock->addr->ai->ai_addr)->sin6_addr;
845 a.sin_family = AF_INET;
847 ((struct sockaddr_in *) sock->addr->ai->ai_addr)->sin_addr;
848 a.sin_port = p_htons((short) sock->port);
853 assert(sock->addr->addresses && sock->addr->curraddr < sock->addr->naddresses);
854 a.sin_family = AF_INET;
855 a.sin_addr.s_addr = p_htonl(sock->addr->addresses[sock->addr->curraddr]);
856 a.sin_port = p_htons((short) sock->port);
859 /* Set up a select mechanism. This could be an AsyncSelect on a
860 * window, or an EventSelect on an event object. */
861 errstr = do_select(s, 1);
863 sock->error = errstr;
871 ((family == AF_INET6) ? (struct sockaddr *) &a6 :
872 (struct sockaddr *) &a),
873 (family == AF_INET6) ? sizeof(a6) : sizeof(a))
875 p_connect(s, (struct sockaddr *) &a, sizeof(a))
878 err = p_WSAGetLastError();
880 * We expect a potential EWOULDBLOCK here, because the
881 * chances are the front end has done a select for
882 * FD_CONNECT, so that connect() will complete
885 if ( err != WSAEWOULDBLOCK ) {
886 sock->error = winsock_error_string(err);
891 * If we _don't_ get EWOULDBLOCK, the connect has completed
892 * and we should set the socket as writable.
897 add234(sktree, sock);
903 plug_log(sock->plug, 1, sock->addr, sock->port, sock->error, err);
907 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
908 int nodelay, int keepalive, Plug plug)
910 static const struct socket_function_table fn_table = {
916 sk_tcp_set_private_ptr,
917 sk_tcp_get_private_ptr,
926 * Create Socket structure.
928 ret = snew(struct Socket_tag);
932 bufchain_init(&ret->output_data);
933 ret->connected = 0; /* to start with */
934 ret->writable = 0; /* to start with */
935 ret->sending_oob = 0;
937 ret->frozen_readable = 0;
938 ret->localhost_only = 0; /* unused, but best init anyway */
939 ret->pending_error = 0;
940 ret->parent = ret->child = NULL;
941 ret->oobinline = oobinline;
942 ret->nodelay = nodelay;
943 ret->keepalive = keepalive;
944 ret->privport = privport;
947 ret->s = INVALID_SOCKET;
951 err = try_connect(ret);
952 } while (err && sk_nextaddr(ret->addr));
957 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only,
958 int orig_address_family)
960 static const struct socket_function_table fn_table = {
966 sk_tcp_set_private_ptr,
967 sk_tcp_get_private_ptr,
987 * Create Socket structure.
989 ret = snew(struct Socket_tag);
993 bufchain_init(&ret->output_data);
994 ret->writable = 0; /* to start with */
995 ret->sending_oob = 0;
997 ret->frozen_readable = 0;
998 ret->localhost_only = local_host_only;
999 ret->pending_error = 0;
1000 ret->parent = ret->child = NULL;
1004 * Translate address_family from platform-independent constants
1005 * into local reality.
1007 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
1009 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
1014 * Our default, if passed the `don't care' value
1015 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1016 * we will also set up a second socket listening on IPv6, but
1017 * the v4 one is primary since that ought to work even on
1018 * non-v6-supporting systems.
1020 if (address_family == AF_UNSPEC) address_family = AF_INET;
1025 s = p_socket(address_family, SOCK_STREAM, 0);
1028 if (s == INVALID_SOCKET) {
1029 err = p_WSAGetLastError();
1030 ret->error = winsock_error_string(err);
1031 return (Socket) ret;
1036 p_setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
1039 if (address_family == AF_INET6) {
1040 memset(&a6, 0, sizeof(a6));
1041 a6.sin6_family = AF_INET6;
1042 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1043 * know how to do it. :-)
1044 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1045 * Thus we need either a parser that understands [2001:db8::1]:80
1046 * style addresses and/or enhance this to understand hostnames too. */
1047 if (local_host_only)
1048 a6.sin6_addr = in6addr_loopback;
1050 a6.sin6_addr = in6addr_any;
1051 a6.sin6_port = p_htons(port);
1056 a.sin_family = AF_INET;
1059 * Bind to source address. First try an explicitly
1063 a.sin_addr.s_addr = p_inet_addr(srcaddr);
1064 if (a.sin_addr.s_addr != INADDR_NONE) {
1065 /* Override localhost_only with specified listen addr. */
1066 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
1072 * ... and failing that, go with one of the standard ones.
1075 if (local_host_only)
1076 a.sin_addr.s_addr = p_htonl(INADDR_LOOPBACK);
1078 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
1081 a.sin_port = p_htons((short)port);
1084 retcode = p_bind(s, (address_family == AF_INET6 ?
1085 (struct sockaddr *) &a6 :
1086 (struct sockaddr *) &a),
1088 AF_INET6 ? sizeof(a6) : sizeof(a)));
1090 retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
1092 if (retcode != SOCKET_ERROR) {
1095 err = p_WSAGetLastError();
1100 ret->error = winsock_error_string(err);
1101 return (Socket) ret;
1105 if (p_listen(s, SOMAXCONN) == SOCKET_ERROR) {
1107 ret->error = winsock_error_string(err);
1108 return (Socket) ret;
1111 /* Set up a select mechanism. This could be an AsyncSelect on a
1112 * window, or an EventSelect on an event object. */
1113 errstr = do_select(s, 1);
1116 ret->error = errstr;
1117 return (Socket) ret;
1120 add234(sktree, ret);
1124 * If we were given ADDRTYPE_UNSPEC, we must also create an
1125 * IPv6 listening socket and link it to this one.
1127 if (address_family == AF_INET && orig_address_family == ADDRTYPE_UNSPEC) {
1128 Actual_Socket other;
1130 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
1131 local_host_only, ADDRTYPE_IPV6);
1134 if (!other->error) {
1135 other->parent = ret;
1144 return (Socket) ret;
1147 static void sk_tcp_close(Socket sock)
1149 extern char *do_select(SOCKET skt, int startup);
1150 Actual_Socket s = (Actual_Socket) sock;
1153 sk_tcp_close((Socket)s->child);
1157 p_closesocket(s->s);
1159 sk_addr_free(s->addr);
1164 * The function which tries to send on a socket once it's deemed
1167 void try_send(Actual_Socket s)
1169 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1173 int len, urgentflag;
1175 if (s->sending_oob) {
1176 urgentflag = MSG_OOB;
1177 len = s->sending_oob;
1181 bufchain_prefix(&s->output_data, &data, &len);
1183 nsent = p_send(s->s, data, len, urgentflag);
1184 noise_ultralight(nsent);
1186 err = (nsent < 0 ? p_WSAGetLastError() : 0);
1187 if ((err < WSABASEERR && nsent < 0) || err == WSAEWOULDBLOCK) {
1189 * Perfectly normal: we've sent all we can for the moment.
1191 * (Some WinSock send() implementations can return
1192 * <0 but leave no sensible error indication -
1193 * WSAGetLastError() is called but returns zero or
1194 * a small number - so we check that case and treat
1195 * it just like WSAEWOULDBLOCK.)
1197 s->writable = FALSE;
1199 } else if (nsent == 0 ||
1200 err == WSAECONNABORTED || err == WSAECONNRESET) {
1202 * If send() returns CONNABORTED or CONNRESET, we
1203 * unfortunately can't just call plug_closing(),
1204 * because it's quite likely that we're currently
1205 * _in_ a call from the code we'd be calling back
1206 * to, so we'd have to make half the SSH code
1207 * reentrant. Instead we flag a pending error on
1208 * the socket, to be dealt with (by calling
1209 * plug_closing()) at some suitable future moment.
1211 s->pending_error = err;
1214 /* We're inside the Windows frontend here, so we know
1215 * that the frontend handle is unnecessary. */
1216 logevent(NULL, winsock_error_string(err));
1217 fatalbox("%s", winsock_error_string(err));
1220 if (s->sending_oob) {
1222 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1223 s->sending_oob = len - nsent;
1228 bufchain_consume(&s->output_data, nsent);
1234 static int sk_tcp_write(Socket sock, const char *buf, int len)
1236 Actual_Socket s = (Actual_Socket) sock;
1239 * Add the data to the buffer list on the socket.
1241 bufchain_add(&s->output_data, buf, len);
1244 * Now try sending from the start of the buffer list.
1249 return bufchain_size(&s->output_data);
1252 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1254 Actual_Socket s = (Actual_Socket) sock;
1257 * Replace the buffer list on the socket with the data.
1259 bufchain_clear(&s->output_data);
1260 assert(len <= sizeof(s->oobdata));
1261 memcpy(s->oobdata, buf, len);
1262 s->sending_oob = len;
1265 * Now try sending from the start of the buffer list.
1270 return s->sending_oob;
1273 int select_result(WPARAM wParam, LPARAM lParam)
1277 char buf[20480]; /* nice big buffer for plenty of speed */
1281 /* wParam is the socket itself */
1284 return 1; /* boggle */
1286 s = find234(sktree, (void *) wParam, cmpforsearch);
1288 return 1; /* boggle */
1290 if ((err = WSAGETSELECTERROR(lParam)) != 0) {
1292 * An error has occurred on this socket. Pass it to the
1296 plug_log(s->plug, 1, s->addr, s->port,
1297 winsock_error_string(err), err);
1298 while (s->addr && sk_nextaddr(s->addr)) {
1299 err = try_connect(s);
1303 return plug_closing(s->plug, winsock_error_string(err), err, 0);
1308 noise_ultralight(lParam);
1310 switch (WSAGETSELECTEVENT(lParam)) {
1312 s->connected = s->writable = 1;
1314 * Once a socket is connected, we can stop falling
1315 * back through the candidate addresses to connect
1319 sk_addr_free(s->addr);
1324 /* In the case the socket is still frozen, we don't even bother */
1326 s->frozen_readable = 1;
1331 * We have received data on the socket. For an oobinline
1332 * socket, this might be data _before_ an urgent pointer,
1333 * in which case we send it to the back end with type==1
1334 * (data prior to urgent).
1338 p_ioctlsocket(s->s, SIOCATMARK, &atmark);
1340 * Avoid checking the return value from ioctlsocket(),
1341 * on the grounds that some WinSock wrappers don't
1342 * support it. If it does nothing, we get atmark==1,
1343 * which is equivalent to `no OOB pending', so the
1344 * effect will be to non-OOB-ify any OOB data.
1349 ret = p_recv(s->s, buf, sizeof(buf), 0);
1350 noise_ultralight(ret);
1352 err = p_WSAGetLastError();
1353 if (err == WSAEWOULDBLOCK) {
1358 return plug_closing(s->plug, winsock_error_string(err), err,
1360 } else if (0 == ret) {
1361 return plug_closing(s->plug, NULL, 0, 0);
1363 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1368 * This will only happen on a non-oobinline socket. It
1369 * indicates that we can immediately perform an OOB read
1370 * and get back OOB data, which we will send to the back
1371 * end with type==2 (urgent data).
1373 ret = p_recv(s->s, buf, sizeof(buf), MSG_OOB);
1374 noise_ultralight(ret);
1376 char *str = (ret == 0 ? "Internal networking trouble" :
1377 winsock_error_string(p_WSAGetLastError()));
1378 /* We're inside the Windows frontend here, so we know
1379 * that the frontend handle is unnecessary. */
1380 logevent(NULL, str);
1381 fatalbox("%s", str);
1383 return plug_receive(s->plug, 2, buf, ret);
1388 int bufsize_before, bufsize_after;
1390 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1392 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1393 if (bufsize_after < bufsize_before)
1394 plug_sent(s->plug, bufsize_after);
1398 /* Signal a close on the socket. First read any outstanding data. */
1401 ret = p_recv(s->s, buf, sizeof(buf), 0);
1403 err = p_WSAGetLastError();
1404 if (err == WSAEWOULDBLOCK)
1406 return plug_closing(s->plug, winsock_error_string(err),
1410 open &= plug_receive(s->plug, 0, buf, ret);
1412 open &= plug_closing(s->plug, NULL, 0, 0);
1419 struct sockaddr_in isa;
1421 struct sockaddr_storage isa;
1423 int addrlen = sizeof(isa);
1424 SOCKET t; /* socket of connection */
1426 memset(&isa, 0, sizeof(isa));
1428 t = p_accept(s->s,(struct sockaddr *)&isa,&addrlen);
1429 if (t == INVALID_SOCKET)
1431 err = p_WSAGetLastError();
1432 if (err == WSATRY_AGAIN)
1436 if (isa.ss_family == AF_INET &&
1437 s->localhost_only &&
1438 !ipv4_is_local_addr(((struct sockaddr_in *)&isa)->sin_addr)) {
1440 if (s->localhost_only && !ipv4_is_local_addr(isa.sin_addr)) {
1442 p_closesocket(t); /* dodgy WinSock let nonlocal through */
1443 } else if (plug_accepting(s->plug, (void*)t)) {
1444 p_closesocket(t); /* denied or error */
1453 * Deal with socket errors detected in try_send().
1455 void net_pending_errors(void)
1461 * This might be a fiddly business, because it's just possible
1462 * that handling a pending error on one socket might cause
1463 * others to be closed. (I can't think of any reason this might
1464 * happen in current SSH implementation, but to maintain
1465 * generality of this network layer I'll assume the worst.)
1467 * So what we'll do is search the socket list for _one_ socket
1468 * with a pending error, and then handle it, and then search
1469 * the list again _from the beginning_. Repeat until we make a
1470 * pass with no socket errors present. That way we are
1471 * protected against the socket list changing under our feet.
1475 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1476 if (s->pending_error) {
1478 * An error has occurred on this socket. Pass it to the
1481 plug_closing(s->plug,
1482 winsock_error_string(s->pending_error),
1483 s->pending_error, 0);
1491 * Each socket abstraction contains a `void *' private field in
1492 * which the client can keep state.
1494 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1496 Actual_Socket s = (Actual_Socket) sock;
1497 s->private_ptr = ptr;
1500 static void *sk_tcp_get_private_ptr(Socket sock)
1502 Actual_Socket s = (Actual_Socket) sock;
1503 return s->private_ptr;
1507 * Special error values are returned from sk_namelookup and sk_new
1508 * if there's a problem. These functions extract an error message,
1509 * or return NULL if there's no problem.
1511 const char *sk_addr_error(SockAddr addr)
1515 static const char *sk_tcp_socket_error(Socket sock)
1517 Actual_Socket s = (Actual_Socket) sock;
1521 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1523 Actual_Socket s = (Actual_Socket) sock;
1524 if (s->frozen == is_frozen)
1526 s->frozen = is_frozen;
1529 if (s->frozen_readable) {
1531 p_recv(s->s, &c, 1, MSG_PEEK);
1534 s->frozen_readable = 0;
1538 * For Plink: enumerate all sockets currently active.
1540 SOCKET first_socket(int *state)
1544 s = index234(sktree, (*state)++);
1545 return s ? s->s : INVALID_SOCKET;
1548 SOCKET next_socket(int *state)
1550 Actual_Socket s = index234(sktree, (*state)++);
1551 return s ? s->s : INVALID_SOCKET;
1554 extern int socket_writable(SOCKET skt)
1556 Actual_Socket s = find234(sktree, (void *)skt, cmpforsearch);
1559 return bufchain_size(&s->output_data) > 0;
1564 int net_service_lookup(char *service)
1567 se = p_getservbyname(service, NULL);
1569 return p_ntohs(se->s_port);
1574 SockAddr platform_get_x11_unix_address(int displaynum, char **canonicalname)
1576 SockAddr ret = snew(struct SockAddr_tag);
1577 memset(ret, 0, sizeof(struct SockAddr_tag));
1578 ret->error = "unix sockets not supported on this platform";