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 * Mutable state that goes with a SockAddr: stores information
39 * about where in the list of candidate IP(v*) addresses we've
42 typedef struct SockAddrStep_tag SockAddrStep;
43 struct SockAddrStep_tag {
45 struct addrinfo *ai; /* steps along addr->ais */
51 const struct socket_function_table *fn;
52 /* the above variable absolutely *must* be the first in this structure */
59 int frozen; /* this causes readability notifications to be ignored */
60 int frozen_readable; /* this means we missed at least one readability
61 * notification while we were frozen */
62 int localhost_only; /* for listening sockets */
65 int oobinline, nodelay, keepalive, privport;
66 enum { EOF_NO, EOF_PENDING, EOF_SENT } outgoingeof;
70 int pending_error; /* in case send() returns error */
72 * We sometimes need pairs of Socket structures to be linked:
73 * if we are listening on the same IPv6 and v4 port, for
74 * example. So here we define `parent' and `child' pointers to
77 Actual_Socket parent, child;
84 int namedpipe; /* indicates that this SockAddr is phony, holding a Windows
85 * named pipe pathname instead of a network address */
87 struct addrinfo *ais; /* Addresses IPv6 style. */
89 unsigned long *addresses; /* Addresses IPv4 style. */
91 char hostname[512]; /* Store an unresolved host name. */
95 * Which address family this address belongs to. AF_INET for IPv4;
96 * AF_INET6 for IPv6; AF_UNSPEC indicates that name resolution has
97 * not been done and a simple host name is held in this SockAddr
101 #define SOCKADDR_FAMILY(addr, step) \
102 (!(addr)->resolved ? AF_UNSPEC : \
103 (step).ai ? (step).ai->ai_family : AF_INET)
105 #define SOCKADDR_FAMILY(addr, step) \
106 (!(addr)->resolved ? AF_UNSPEC : AF_INET)
110 * Start a SockAddrStep structure to step through multiple
114 #define START_STEP(addr, step) \
115 ((step).ai = (addr)->ais, (step).curraddr = 0)
117 #define START_STEP(addr, step) \
118 ((step).curraddr = 0)
121 static tree234 *sktree;
123 static int cmpfortree(void *av, void *bv)
125 Actual_Socket a = (Actual_Socket) av, b = (Actual_Socket) bv;
126 unsigned long as = (unsigned long) a->s, bs = (unsigned long) b->s;
138 static int cmpforsearch(void *av, void *bv)
140 Actual_Socket b = (Actual_Socket) bv;
141 unsigned long as = (unsigned long) av, bs = (unsigned long) b->s;
149 DECL_WINDOWS_FUNCTION(static, int, WSAStartup, (WORD, LPWSADATA));
150 DECL_WINDOWS_FUNCTION(static, int, WSACleanup, (void));
151 DECL_WINDOWS_FUNCTION(static, int, closesocket, (SOCKET));
152 DECL_WINDOWS_FUNCTION(static, u_long, ntohl, (u_long));
153 DECL_WINDOWS_FUNCTION(static, u_long, htonl, (u_long));
154 DECL_WINDOWS_FUNCTION(static, u_short, htons, (u_short));
155 DECL_WINDOWS_FUNCTION(static, u_short, ntohs, (u_short));
156 DECL_WINDOWS_FUNCTION(static, int, gethostname, (char *, int));
157 DECL_WINDOWS_FUNCTION(static, struct hostent FAR *, gethostbyname,
159 DECL_WINDOWS_FUNCTION(static, struct servent FAR *, getservbyname,
160 (const char FAR *, const char FAR *));
161 DECL_WINDOWS_FUNCTION(static, unsigned long, inet_addr, (const char FAR *));
162 DECL_WINDOWS_FUNCTION(static, char FAR *, inet_ntoa, (struct in_addr));
163 DECL_WINDOWS_FUNCTION(static, int, connect,
164 (SOCKET, const struct sockaddr FAR *, int));
165 DECL_WINDOWS_FUNCTION(static, int, bind,
166 (SOCKET, const struct sockaddr FAR *, int));
167 DECL_WINDOWS_FUNCTION(static, int, setsockopt,
168 (SOCKET, int, int, const char FAR *, int));
169 DECL_WINDOWS_FUNCTION(static, SOCKET, socket, (int, int, int));
170 DECL_WINDOWS_FUNCTION(static, int, listen, (SOCKET, int));
171 DECL_WINDOWS_FUNCTION(static, int, send, (SOCKET, const char FAR *, int, int));
172 DECL_WINDOWS_FUNCTION(static, int, shutdown, (SOCKET, int));
173 DECL_WINDOWS_FUNCTION(static, int, ioctlsocket,
174 (SOCKET, long, u_long FAR *));
175 DECL_WINDOWS_FUNCTION(static, SOCKET, accept,
176 (SOCKET, struct sockaddr FAR *, int FAR *));
177 DECL_WINDOWS_FUNCTION(static, int, recv, (SOCKET, char FAR *, int, int));
178 DECL_WINDOWS_FUNCTION(static, int, WSAIoctl,
179 (SOCKET, DWORD, LPVOID, DWORD, LPVOID, DWORD,
180 LPDWORD, LPWSAOVERLAPPED,
181 LPWSAOVERLAPPED_COMPLETION_ROUTINE));
183 DECL_WINDOWS_FUNCTION(static, int, getaddrinfo,
184 (const char *nodename, const char *servname,
185 const struct addrinfo *hints, struct addrinfo **res));
186 DECL_WINDOWS_FUNCTION(static, void, freeaddrinfo, (struct addrinfo *res));
187 DECL_WINDOWS_FUNCTION(static, int, getnameinfo,
188 (const struct sockaddr FAR * sa, socklen_t salen,
189 char FAR * host, size_t hostlen, char FAR * serv,
190 size_t servlen, int flags));
191 DECL_WINDOWS_FUNCTION(static, char *, gai_strerror, (int ecode));
192 DECL_WINDOWS_FUNCTION(static, int, WSAAddressToStringA,
193 (LPSOCKADDR, DWORD, LPWSAPROTOCOL_INFO,
197 static HMODULE winsock_module = NULL;
198 static WSADATA wsadata;
200 static HMODULE winsock2_module = NULL;
201 static HMODULE wship6_module = NULL;
204 int sk_startup(int hi, int lo)
208 winsock_ver = MAKEWORD(hi, lo);
210 if (p_WSAStartup(winsock_ver, &wsadata)) {
214 if (LOBYTE(wsadata.wVersion) != LOBYTE(winsock_ver)) {
218 #ifdef NET_SETUP_DIAGNOSTICS
221 sprintf(buf, "Using WinSock %d.%d", hi, lo);
233 winsock_module = load_system32_dll("ws2_32.dll");
234 if (!winsock_module) {
235 winsock_module = load_system32_dll("wsock32.dll");
238 fatalbox("Unable to load any WinSock library");
241 /* Check if we have getaddrinfo in Winsock */
242 if (GetProcAddress(winsock_module, "getaddrinfo") != NULL) {
243 #ifdef NET_SETUP_DIAGNOSTICS
244 logevent(NULL, "Native WinSock IPv6 support detected");
246 GET_WINDOWS_FUNCTION(winsock_module, getaddrinfo);
247 GET_WINDOWS_FUNCTION(winsock_module, freeaddrinfo);
248 GET_WINDOWS_FUNCTION(winsock_module, getnameinfo);
249 GET_WINDOWS_FUNCTION(winsock_module, gai_strerror);
251 /* Fall back to wship6.dll for Windows 2000 */
252 wship6_module = load_system32_dll("wship6.dll");
254 #ifdef NET_SETUP_DIAGNOSTICS
255 logevent(NULL, "WSH IPv6 support detected");
257 GET_WINDOWS_FUNCTION(wship6_module, getaddrinfo);
258 GET_WINDOWS_FUNCTION(wship6_module, freeaddrinfo);
259 GET_WINDOWS_FUNCTION(wship6_module, getnameinfo);
260 GET_WINDOWS_FUNCTION(wship6_module, gai_strerror);
262 #ifdef NET_SETUP_DIAGNOSTICS
263 logevent(NULL, "No IPv6 support detected");
267 GET_WINDOWS_FUNCTION(winsock2_module, WSAAddressToStringA);
269 #ifdef NET_SETUP_DIAGNOSTICS
270 logevent(NULL, "PuTTY was built without IPv6 support");
274 GET_WINDOWS_FUNCTION(winsock_module, WSAAsyncSelect);
275 GET_WINDOWS_FUNCTION(winsock_module, WSAEventSelect);
276 GET_WINDOWS_FUNCTION(winsock_module, select);
277 GET_WINDOWS_FUNCTION(winsock_module, WSAGetLastError);
278 GET_WINDOWS_FUNCTION(winsock_module, WSAEnumNetworkEvents);
279 GET_WINDOWS_FUNCTION(winsock_module, WSAStartup);
280 GET_WINDOWS_FUNCTION(winsock_module, WSACleanup);
281 GET_WINDOWS_FUNCTION(winsock_module, closesocket);
282 GET_WINDOWS_FUNCTION(winsock_module, ntohl);
283 GET_WINDOWS_FUNCTION(winsock_module, htonl);
284 GET_WINDOWS_FUNCTION(winsock_module, htons);
285 GET_WINDOWS_FUNCTION(winsock_module, ntohs);
286 GET_WINDOWS_FUNCTION(winsock_module, gethostname);
287 GET_WINDOWS_FUNCTION(winsock_module, gethostbyname);
288 GET_WINDOWS_FUNCTION(winsock_module, getservbyname);
289 GET_WINDOWS_FUNCTION(winsock_module, inet_addr);
290 GET_WINDOWS_FUNCTION(winsock_module, inet_ntoa);
291 GET_WINDOWS_FUNCTION(winsock_module, connect);
292 GET_WINDOWS_FUNCTION(winsock_module, bind);
293 GET_WINDOWS_FUNCTION(winsock_module, setsockopt);
294 GET_WINDOWS_FUNCTION(winsock_module, socket);
295 GET_WINDOWS_FUNCTION(winsock_module, listen);
296 GET_WINDOWS_FUNCTION(winsock_module, send);
297 GET_WINDOWS_FUNCTION(winsock_module, shutdown);
298 GET_WINDOWS_FUNCTION(winsock_module, ioctlsocket);
299 GET_WINDOWS_FUNCTION(winsock_module, accept);
300 GET_WINDOWS_FUNCTION(winsock_module, recv);
301 GET_WINDOWS_FUNCTION(winsock_module, WSAIoctl);
303 /* Try to get the best WinSock version we can get */
304 if (!sk_startup(2,2) &&
307 fatalbox("Unable to initialise WinSock");
310 sktree = newtree234(cmpfortree);
313 void sk_cleanup(void)
319 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
329 FreeLibrary(winsock_module);
332 FreeLibrary(wship6_module);
341 static int errstring_find(void *av, void *bv)
344 struct errstring *b = (struct errstring *)bv;
351 static int errstring_compare(void *av, void *bv)
353 struct errstring *a = (struct errstring *)av;
354 return errstring_find(&a->error, bv);
357 static tree234 *errstrings = NULL;
359 char *winsock_error_string(int error)
361 const char prefix[] = "Network error: ";
362 struct errstring *es;
365 * Error codes we know about and have historically had reasonably
366 * sensible error messages for.
370 return "Network error: Permission denied";
372 return "Network error: Address already in use";
373 case WSAEADDRNOTAVAIL:
374 return "Network error: Cannot assign requested address";
375 case WSAEAFNOSUPPORT:
377 "Network error: Address family not supported by protocol family";
379 return "Network error: Operation already in progress";
380 case WSAECONNABORTED:
381 return "Network error: Software caused connection abort";
382 case WSAECONNREFUSED:
383 return "Network error: Connection refused";
385 return "Network error: Connection reset by peer";
386 case WSAEDESTADDRREQ:
387 return "Network error: Destination address required";
389 return "Network error: Bad address";
391 return "Network error: Host is down";
392 case WSAEHOSTUNREACH:
393 return "Network error: No route to host";
395 return "Network error: Operation now in progress";
397 return "Network error: Interrupted function call";
399 return "Network error: Invalid argument";
401 return "Network error: Socket is already connected";
403 return "Network error: Too many open files";
405 return "Network error: Message too long";
407 return "Network error: Network is down";
409 return "Network error: Network dropped connection on reset";
411 return "Network error: Network is unreachable";
413 return "Network error: No buffer space available";
415 return "Network error: Bad protocol option";
417 return "Network error: Socket is not connected";
419 return "Network error: Socket operation on non-socket";
421 return "Network error: Operation not supported";
422 case WSAEPFNOSUPPORT:
423 return "Network error: Protocol family not supported";
425 return "Network error: Too many processes";
426 case WSAEPROTONOSUPPORT:
427 return "Network error: Protocol not supported";
429 return "Network error: Protocol wrong type for socket";
431 return "Network error: Cannot send after socket shutdown";
432 case WSAESOCKTNOSUPPORT:
433 return "Network error: Socket type not supported";
435 return "Network error: Connection timed out";
437 return "Network error: Resource temporarily unavailable";
439 return "Network error: Graceful shutdown in progress";
443 * Generic code to handle any other error.
445 * Slightly nasty hack here: we want to return a static string
446 * which the caller will never have to worry about freeing, but on
447 * the other hand if we call FormatMessage to get it then it will
448 * want to either allocate a buffer or write into one we own.
450 * So what we do is to maintain a tree234 of error strings we've
451 * already used. New ones are allocated from the heap, but then
452 * put in this tree and kept forever.
456 errstrings = newtree234(errstring_compare);
458 es = find234(errstrings, &error, errstring_find);
461 int bufsize, bufused;
463 es = snew(struct errstring);
465 /* maximum size for FormatMessage is 64K */
466 bufsize = 65535 + sizeof(prefix);
467 es->text = snewn(bufsize, char);
468 strcpy(es->text, prefix);
469 bufused = strlen(es->text);
470 if (!FormatMessage((FORMAT_MESSAGE_FROM_SYSTEM |
471 FORMAT_MESSAGE_IGNORE_INSERTS), NULL, error,
472 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
473 es->text + bufused, bufsize - bufused, NULL)) {
474 sprintf(es->text + bufused,
475 "Windows error code %d (and FormatMessage returned %d)",
476 error, GetLastError());
478 int len = strlen(es->text);
479 if (len > 0 && es->text[len-1] == '\n')
480 es->text[len-1] = '\0';
482 es->text = sresize(es->text, strlen(es->text) + 1, char);
483 add234(errstrings, es);
489 SockAddr sk_namelookup(const char *host, char **canonicalname,
492 SockAddr ret = snew(struct SockAddr_tag);
497 /* Default to IPv4. */
498 hint_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
500 address_family == ADDRTYPE_IPV6 ? AF_INET6 :
504 /* Clear the structure and default to IPv4. */
505 memset(ret, 0, sizeof(struct SockAddr_tag));
509 ret->namedpipe = FALSE;
510 ret->addresses = NULL;
511 ret->resolved = FALSE;
515 if ((a = p_inet_addr(host)) == (unsigned long) INADDR_NONE) {
516 struct hostent *h = NULL;
520 * Use getaddrinfo when it's available
523 struct addrinfo hints;
524 #ifdef NET_SETUP_DIAGNOSTICS
525 logevent(NULL, "Using getaddrinfo() for resolving");
527 memset(&hints, 0, sizeof(hints));
528 hints.ai_family = hint_family;
529 hints.ai_flags = AI_CANONNAME;
531 /* strip [] on IPv6 address literals */
532 char *trimmed_host = host_strduptrim(host);
533 err = p_getaddrinfo(trimmed_host, NULL, &hints, &ret->ais);
537 ret->resolved = TRUE;
541 #ifdef NET_SETUP_DIAGNOSTICS
542 logevent(NULL, "Using gethostbyname() for resolving");
545 * Otherwise use the IPv4-only gethostbyname...
546 * (NOTE: we don't use gethostbyname as a fallback!)
548 if ( (h = p_gethostbyname(host)) )
549 ret->resolved = TRUE;
551 err = p_WSAGetLastError();
554 if (!ret->resolved) {
555 ret->error = (err == WSAENETDOWN ? "Network is down" :
556 err == WSAHOST_NOT_FOUND ? "Host does not exist" :
557 err == WSATRY_AGAIN ? "Host not found" :
559 p_getaddrinfo&&p_gai_strerror ? p_gai_strerror(err) :
561 "gethostbyname: unknown error");
566 /* If we got an address info use that... */
568 /* Are we in IPv4 fallback mode? */
569 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
570 if (ret->ais->ai_family == AF_INET)
572 (char *) &((SOCKADDR_IN *) ret->ais->
573 ai_addr)->sin_addr, sizeof(a));
575 if (ret->ais->ai_canonname)
576 strncpy(realhost, ret->ais->ai_canonname, lenof(realhost));
578 strncpy(realhost, host, lenof(realhost));
580 /* We used the IPv4-only gethostbyname()... */
585 for (n = 0; h->h_addr_list[n]; n++);
586 ret->addresses = snewn(n, unsigned long);
588 for (n = 0; n < ret->naddresses; n++) {
589 memcpy(&a, h->h_addr_list[n], sizeof(a));
590 ret->addresses[n] = p_ntohl(a);
592 memcpy(&a, h->h_addr, sizeof(a));
593 /* This way we are always sure the h->h_name is valid :) */
594 strncpy(realhost, h->h_name, sizeof(realhost));
599 * This must be a numeric IPv4 address because it caused a
600 * success return from inet_addr.
602 ret->addresses = snewn(1, unsigned long);
604 ret->addresses[0] = p_ntohl(a);
605 ret->resolved = TRUE;
606 strncpy(realhost, host, sizeof(realhost));
608 realhost[lenof(realhost)-1] = '\0';
609 *canonicalname = snewn(1+strlen(realhost), char);
610 strcpy(*canonicalname, realhost);
614 SockAddr sk_nonamelookup(const char *host)
616 SockAddr ret = snew(struct SockAddr_tag);
618 ret->resolved = FALSE;
622 ret->namedpipe = FALSE;
623 ret->addresses = NULL;
626 strncpy(ret->hostname, host, lenof(ret->hostname));
627 ret->hostname[lenof(ret->hostname)-1] = '\0';
631 SockAddr sk_namedpipe_addr(const char *pipename)
633 SockAddr ret = snew(struct SockAddr_tag);
635 ret->resolved = FALSE;
639 ret->namedpipe = TRUE;
640 ret->addresses = NULL;
643 strncpy(ret->hostname, pipename, lenof(ret->hostname));
644 ret->hostname[lenof(ret->hostname)-1] = '\0';
648 int sk_nextaddr(SockAddr addr, SockAddrStep *step)
652 if (step->ai->ai_next) {
653 step->ai = step->ai->ai_next;
659 if (step->curraddr+1 < addr->naddresses) {
667 void sk_getaddr(SockAddr addr, char *buf, int buflen)
670 START_STEP(addr, step);
675 if (p_WSAAddressToStringA) {
676 DWORD dwbuflen = buflen;
677 err = p_WSAAddressToStringA(step.ai->ai_addr, step.ai->ai_addrlen,
678 NULL, buf, &dwbuflen);
682 strncpy(buf, addr->hostname, buflen);
684 strncpy(buf, "<unknown>", buflen);
685 buf[buflen-1] = '\0';
689 if (SOCKADDR_FAMILY(addr, step) == AF_INET) {
691 assert(addr->addresses && step.curraddr < addr->naddresses);
692 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
693 strncpy(buf, p_inet_ntoa(a), buflen);
694 buf[buflen-1] = '\0';
696 strncpy(buf, addr->hostname, buflen);
697 buf[buflen-1] = '\0';
701 int sk_addr_needs_port(SockAddr addr)
703 return addr->namedpipe ? FALSE : TRUE;
706 int sk_hostname_is_local(const char *name)
708 return !strcmp(name, "localhost") ||
709 !strcmp(name, "::1") ||
710 !strncmp(name, "127.", 4);
713 static INTERFACE_INFO local_interfaces[16];
714 static int n_local_interfaces; /* 0=not yet, -1=failed, >0=number */
716 static int ipv4_is_local_addr(struct in_addr addr)
718 if (ipv4_is_loopback(addr))
719 return 1; /* loopback addresses are local */
720 if (!n_local_interfaces) {
721 SOCKET s = p_socket(AF_INET, SOCK_DGRAM, 0);
725 p_WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0,
726 local_interfaces, sizeof(local_interfaces),
727 &retbytes, NULL, NULL) == 0)
728 n_local_interfaces = retbytes / sizeof(INTERFACE_INFO);
730 logevent(NULL, "Unable to get list of local IP addresses");
732 if (n_local_interfaces > 0) {
734 for (i = 0; i < n_local_interfaces; i++) {
735 SOCKADDR_IN *address =
736 (SOCKADDR_IN *)&local_interfaces[i].iiAddress;
737 if (address->sin_addr.s_addr == addr.s_addr)
738 return 1; /* this address is local */
741 return 0; /* this address is not local */
744 int sk_address_is_local(SockAddr addr)
748 START_STEP(addr, step);
749 family = SOCKADDR_FAMILY(addr, step);
752 if (family == AF_INET6) {
753 return IN6_IS_ADDR_LOOPBACK(&((const struct sockaddr_in6 *)step.ai->ai_addr)->sin6_addr);
756 if (family == AF_INET) {
759 return ipv4_is_local_addr(((struct sockaddr_in *)step.ai->ai_addr)
765 assert(addr->addresses && step.curraddr < addr->naddresses);
766 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
767 return ipv4_is_local_addr(a);
770 assert(family == AF_UNSPEC);
771 return 0; /* we don't know; assume not */
775 int sk_address_is_special_local(SockAddr addr)
777 return 0; /* no Unix-domain socket analogue here */
780 int sk_addrtype(SockAddr addr)
784 START_STEP(addr, step);
785 family = SOCKADDR_FAMILY(addr, step);
787 return (family == AF_INET ? ADDRTYPE_IPV4 :
789 family == AF_INET6 ? ADDRTYPE_IPV6 :
794 void sk_addrcopy(SockAddr addr, char *buf)
798 START_STEP(addr, step);
799 family = SOCKADDR_FAMILY(addr, step);
801 assert(family != AF_UNSPEC);
804 if (family == AF_INET)
805 memcpy(buf, &((struct sockaddr_in *)step.ai->ai_addr)->sin_addr,
806 sizeof(struct in_addr));
807 else if (family == AF_INET6)
808 memcpy(buf, &((struct sockaddr_in6 *)step.ai->ai_addr)->sin6_addr,
809 sizeof(struct in6_addr));
814 if (family == AF_INET) {
816 assert(addr->addresses && step.curraddr < addr->naddresses);
817 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
818 memcpy(buf, (char*) &a.s_addr, 4);
822 void sk_addr_free(SockAddr addr)
824 if (--addr->refcount > 0)
827 if (addr->ais && p_freeaddrinfo)
828 p_freeaddrinfo(addr->ais);
831 sfree(addr->addresses);
835 SockAddr sk_addr_dup(SockAddr addr)
841 static Plug sk_tcp_plug(Socket sock, Plug p)
843 Actual_Socket s = (Actual_Socket) sock;
850 static void sk_tcp_flush(Socket s)
853 * We send data to the socket as soon as we can anyway,
854 * so we don't need to do anything here. :-)
858 static void sk_tcp_close(Socket s);
859 static int sk_tcp_write(Socket s, const char *data, int len);
860 static int sk_tcp_write_oob(Socket s, const char *data, int len);
861 static void sk_tcp_write_eof(Socket s);
862 static void sk_tcp_set_frozen(Socket s, int is_frozen);
863 static const char *sk_tcp_socket_error(Socket s);
865 extern char *do_select(SOCKET skt, int startup);
867 static Socket sk_tcp_accept(accept_ctx_t ctx, Plug plug)
869 static const struct socket_function_table fn_table = {
885 * Create Socket structure.
887 ret = snew(struct Socket_tag);
891 bufchain_init(&ret->output_data);
892 ret->writable = 1; /* to start with */
893 ret->sending_oob = 0;
894 ret->outgoingeof = EOF_NO;
896 ret->frozen_readable = 0;
897 ret->localhost_only = 0; /* unused, but best init anyway */
898 ret->pending_error = 0;
899 ret->parent = ret->child = NULL;
902 ret->s = (SOCKET)ctx.p;
904 if (ret->s == INVALID_SOCKET) {
905 err = p_WSAGetLastError();
906 ret->error = winsock_error_string(err);
912 /* Set up a select mechanism. This could be an AsyncSelect on a
913 * window, or an EventSelect on an event object. */
914 errstr = do_select(ret->s, 1);
925 static DWORD try_connect(Actual_Socket sock)
937 if (sock->s != INVALID_SOCKET) {
938 do_select(sock->s, 0);
939 p_closesocket(sock->s);
942 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
947 family = SOCKADDR_FAMILY(sock->addr, sock->step);
950 * Remove the socket from the tree before we overwrite its
951 * internal socket id, because that forms part of the tree's
952 * sorting criterion. We'll add it back before exiting this
953 * function, whether we changed anything or not.
955 del234(sktree, sock);
957 s = p_socket(family, SOCK_STREAM, 0);
960 if (s == INVALID_SOCKET) {
961 err = p_WSAGetLastError();
962 sock->error = winsock_error_string(err);
966 if (sock->oobinline) {
968 p_setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
973 p_setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
976 if (sock->keepalive) {
978 p_setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
982 * Bind to local address.
985 localport = 1023; /* count from 1023 downwards */
987 localport = 0; /* just use port 0 (ie winsock picks) */
989 /* Loop round trying to bind */
994 if (family == AF_INET6) {
995 memset(&a6, 0, sizeof(a6));
996 a6.sin6_family = AF_INET6;
997 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
998 a6.sin6_port = p_htons(localport);
1002 a.sin_family = AF_INET;
1003 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
1004 a.sin_port = p_htons(localport);
1007 sockcode = p_bind(s, (family == AF_INET6 ?
1008 (struct sockaddr *) &a6 :
1009 (struct sockaddr *) &a),
1010 (family == AF_INET6 ? sizeof(a6) : sizeof(a)));
1012 sockcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
1014 if (sockcode != SOCKET_ERROR) {
1018 err = p_WSAGetLastError();
1019 if (err != WSAEADDRINUSE) /* failed, for a bad reason */
1024 break; /* we're only looping once */
1027 break; /* we might have got to the end */
1031 sock->error = winsock_error_string(err);
1036 * Connect to remote address.
1039 if (sock->step.ai) {
1040 if (family == AF_INET6) {
1041 a6.sin6_family = AF_INET6;
1042 a6.sin6_port = p_htons((short) sock->port);
1044 ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_addr;
1045 a6.sin6_flowinfo = ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_flowinfo;
1046 a6.sin6_scope_id = ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_scope_id;
1048 a.sin_family = AF_INET;
1050 ((struct sockaddr_in *) sock->step.ai->ai_addr)->sin_addr;
1051 a.sin_port = p_htons((short) sock->port);
1056 assert(sock->addr->addresses && sock->step.curraddr < sock->addr->naddresses);
1057 a.sin_family = AF_INET;
1058 a.sin_addr.s_addr = p_htonl(sock->addr->addresses[sock->step.curraddr]);
1059 a.sin_port = p_htons((short) sock->port);
1062 /* Set up a select mechanism. This could be an AsyncSelect on a
1063 * window, or an EventSelect on an event object. */
1064 errstr = do_select(s, 1);
1066 sock->error = errstr;
1074 ((family == AF_INET6) ? (struct sockaddr *) &a6 :
1075 (struct sockaddr *) &a),
1076 (family == AF_INET6) ? sizeof(a6) : sizeof(a))
1078 p_connect(s, (struct sockaddr *) &a, sizeof(a))
1080 ) == SOCKET_ERROR) {
1081 err = p_WSAGetLastError();
1083 * We expect a potential EWOULDBLOCK here, because the
1084 * chances are the front end has done a select for
1085 * FD_CONNECT, so that connect() will complete
1088 if ( err != WSAEWOULDBLOCK ) {
1089 sock->error = winsock_error_string(err);
1094 * If we _don't_ get EWOULDBLOCK, the connect has completed
1095 * and we should set the socket as writable.
1105 * No matter what happened, put the socket back in the tree.
1107 add234(sktree, sock);
1110 plug_log(sock->plug, 1, sock->addr, sock->port, sock->error, err);
1114 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
1115 int nodelay, int keepalive, Plug plug)
1117 static const struct socket_function_table fn_table = {
1132 * Create Socket structure.
1134 ret = snew(struct Socket_tag);
1135 ret->fn = &fn_table;
1138 bufchain_init(&ret->output_data);
1139 ret->connected = 0; /* to start with */
1140 ret->writable = 0; /* to start with */
1141 ret->sending_oob = 0;
1142 ret->outgoingeof = EOF_NO;
1144 ret->frozen_readable = 0;
1145 ret->localhost_only = 0; /* unused, but best init anyway */
1146 ret->pending_error = 0;
1147 ret->parent = ret->child = NULL;
1148 ret->oobinline = oobinline;
1149 ret->nodelay = nodelay;
1150 ret->keepalive = keepalive;
1151 ret->privport = privport;
1154 START_STEP(ret->addr, ret->step);
1155 ret->s = INVALID_SOCKET;
1159 err = try_connect(ret);
1160 } while (err && sk_nextaddr(ret->addr, &ret->step));
1162 return (Socket) ret;
1165 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only,
1166 int orig_address_family)
1168 static const struct socket_function_table fn_table = {
1194 * Create Socket structure.
1196 ret = snew(struct Socket_tag);
1197 ret->fn = &fn_table;
1200 bufchain_init(&ret->output_data);
1201 ret->writable = 0; /* to start with */
1202 ret->sending_oob = 0;
1203 ret->outgoingeof = EOF_NO;
1205 ret->frozen_readable = 0;
1206 ret->localhost_only = local_host_only;
1207 ret->pending_error = 0;
1208 ret->parent = ret->child = NULL;
1212 * Translate address_family from platform-independent constants
1213 * into local reality.
1215 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
1217 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
1222 * Our default, if passed the `don't care' value
1223 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1224 * we will also set up a second socket listening on IPv6, but
1225 * the v4 one is primary since that ought to work even on
1226 * non-v6-supporting systems.
1228 if (address_family == AF_UNSPEC) address_family = AF_INET;
1233 s = p_socket(address_family, SOCK_STREAM, 0);
1236 if (s == INVALID_SOCKET) {
1237 err = p_WSAGetLastError();
1238 ret->error = winsock_error_string(err);
1239 return (Socket) ret;
1244 p_setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
1247 if (address_family == AF_INET6) {
1248 memset(&a6, 0, sizeof(a6));
1249 a6.sin6_family = AF_INET6;
1250 if (local_host_only)
1251 a6.sin6_addr = in6addr_loopback;
1253 a6.sin6_addr = in6addr_any;
1254 if (srcaddr != NULL && p_getaddrinfo) {
1255 struct addrinfo hints;
1256 struct addrinfo *ai;
1259 memset(&hints, 0, sizeof(hints));
1260 hints.ai_family = AF_INET6;
1263 /* strip [] on IPv6 address literals */
1264 char *trimmed_addr = host_strduptrim(srcaddr);
1265 err = p_getaddrinfo(trimmed_addr, NULL, &hints, &ai);
1266 sfree(trimmed_addr);
1268 if (err == 0 && ai->ai_family == AF_INET6) {
1270 ((struct sockaddr_in6 *)ai->ai_addr)->sin6_addr;
1273 a6.sin6_port = p_htons(port);
1278 a.sin_family = AF_INET;
1281 * Bind to source address. First try an explicitly
1285 a.sin_addr.s_addr = p_inet_addr(srcaddr);
1286 if (a.sin_addr.s_addr != INADDR_NONE) {
1287 /* Override localhost_only with specified listen addr. */
1288 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
1294 * ... and failing that, go with one of the standard ones.
1297 if (local_host_only)
1298 a.sin_addr.s_addr = p_htonl(INADDR_LOOPBACK);
1300 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
1303 a.sin_port = p_htons((short)port);
1306 retcode = p_bind(s, (address_family == AF_INET6 ?
1307 (struct sockaddr *) &a6 :
1308 (struct sockaddr *) &a),
1310 AF_INET6 ? sizeof(a6) : sizeof(a)));
1312 retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
1314 if (retcode != SOCKET_ERROR) {
1317 err = p_WSAGetLastError();
1322 ret->error = winsock_error_string(err);
1323 return (Socket) ret;
1327 if (p_listen(s, SOMAXCONN) == SOCKET_ERROR) {
1329 ret->error = winsock_error_string(p_WSAGetLastError());
1330 return (Socket) ret;
1333 /* Set up a select mechanism. This could be an AsyncSelect on a
1334 * window, or an EventSelect on an event object. */
1335 errstr = do_select(s, 1);
1338 ret->error = errstr;
1339 return (Socket) ret;
1342 add234(sktree, ret);
1346 * If we were given ADDRTYPE_UNSPEC, we must also create an
1347 * IPv6 listening socket and link it to this one.
1349 if (address_family == AF_INET && orig_address_family == ADDRTYPE_UNSPEC) {
1350 Actual_Socket other;
1352 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
1353 local_host_only, ADDRTYPE_IPV6);
1356 if (!other->error) {
1357 other->parent = ret;
1366 return (Socket) ret;
1369 static void sk_tcp_close(Socket sock)
1371 extern char *do_select(SOCKET skt, int startup);
1372 Actual_Socket s = (Actual_Socket) sock;
1375 sk_tcp_close((Socket)s->child);
1379 p_closesocket(s->s);
1381 sk_addr_free(s->addr);
1386 * Deal with socket errors detected in try_send().
1388 static void socket_error_callback(void *vs)
1390 Actual_Socket s = (Actual_Socket)vs;
1393 * Just in case other socket work has caused this socket to vanish
1394 * or become somehow non-erroneous before this callback arrived...
1396 if (!find234(sktree, s, NULL) || !s->pending_error)
1400 * An error has occurred on this socket. Pass it to the plug.
1402 plug_closing(s->plug, winsock_error_string(s->pending_error),
1403 s->pending_error, 0);
1407 * The function which tries to send on a socket once it's deemed
1410 void try_send(Actual_Socket s)
1412 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1416 int len, urgentflag;
1418 if (s->sending_oob) {
1419 urgentflag = MSG_OOB;
1420 len = s->sending_oob;
1424 bufchain_prefix(&s->output_data, &data, &len);
1426 nsent = p_send(s->s, data, len, urgentflag);
1427 noise_ultralight(nsent);
1429 err = (nsent < 0 ? p_WSAGetLastError() : 0);
1430 if ((err < WSABASEERR && nsent < 0) || err == WSAEWOULDBLOCK) {
1432 * Perfectly normal: we've sent all we can for the moment.
1434 * (Some WinSock send() implementations can return
1435 * <0 but leave no sensible error indication -
1436 * WSAGetLastError() is called but returns zero or
1437 * a small number - so we check that case and treat
1438 * it just like WSAEWOULDBLOCK.)
1440 s->writable = FALSE;
1442 } else if (nsent == 0 ||
1443 err == WSAECONNABORTED || err == WSAECONNRESET) {
1445 * If send() returns CONNABORTED or CONNRESET, we
1446 * unfortunately can't just call plug_closing(),
1447 * because it's quite likely that we're currently
1448 * _in_ a call from the code we'd be calling back
1449 * to, so we'd have to make half the SSH code
1450 * reentrant. Instead we flag a pending error on
1451 * the socket, to be dealt with (by calling
1452 * plug_closing()) at some suitable future moment.
1454 s->pending_error = err;
1455 queue_toplevel_callback(socket_error_callback, s);
1458 /* We're inside the Windows frontend here, so we know
1459 * that the frontend handle is unnecessary. */
1460 logevent(NULL, winsock_error_string(err));
1461 fatalbox("%s", winsock_error_string(err));
1464 if (s->sending_oob) {
1466 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1467 s->sending_oob = len - nsent;
1472 bufchain_consume(&s->output_data, nsent);
1478 * If we reach here, we've finished sending everything we might
1479 * have needed to send. Send EOF, if we need to.
1481 if (s->outgoingeof == EOF_PENDING) {
1482 p_shutdown(s->s, SD_SEND);
1483 s->outgoingeof = EOF_SENT;
1487 static int sk_tcp_write(Socket sock, const char *buf, int len)
1489 Actual_Socket s = (Actual_Socket) sock;
1491 assert(s->outgoingeof == EOF_NO);
1494 * Add the data to the buffer list on the socket.
1496 bufchain_add(&s->output_data, buf, len);
1499 * Now try sending from the start of the buffer list.
1504 return bufchain_size(&s->output_data);
1507 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1509 Actual_Socket s = (Actual_Socket) sock;
1511 assert(s->outgoingeof == EOF_NO);
1514 * Replace the buffer list on the socket with the data.
1516 bufchain_clear(&s->output_data);
1517 assert(len <= sizeof(s->oobdata));
1518 memcpy(s->oobdata, buf, len);
1519 s->sending_oob = len;
1522 * Now try sending from the start of the buffer list.
1527 return s->sending_oob;
1530 static void sk_tcp_write_eof(Socket sock)
1532 Actual_Socket s = (Actual_Socket) sock;
1534 assert(s->outgoingeof == EOF_NO);
1537 * Mark the socket as pending outgoing EOF.
1539 s->outgoingeof = EOF_PENDING;
1542 * Now try sending from the start of the buffer list.
1548 int select_result(WPARAM wParam, LPARAM lParam)
1552 char buf[20480]; /* nice big buffer for plenty of speed */
1556 /* wParam is the socket itself */
1559 return 1; /* boggle */
1561 s = find234(sktree, (void *) wParam, cmpforsearch);
1563 return 1; /* boggle */
1565 if ((err = WSAGETSELECTERROR(lParam)) != 0) {
1567 * An error has occurred on this socket. Pass it to the
1571 plug_log(s->plug, 1, s->addr, s->port,
1572 winsock_error_string(err), err);
1573 while (s->addr && sk_nextaddr(s->addr, &s->step)) {
1574 err = try_connect(s);
1578 return plug_closing(s->plug, winsock_error_string(err), err, 0);
1583 noise_ultralight(lParam);
1585 switch (WSAGETSELECTEVENT(lParam)) {
1587 s->connected = s->writable = 1;
1589 * Once a socket is connected, we can stop falling
1590 * back through the candidate addresses to connect
1594 sk_addr_free(s->addr);
1599 /* In the case the socket is still frozen, we don't even bother */
1601 s->frozen_readable = 1;
1606 * We have received data on the socket. For an oobinline
1607 * socket, this might be data _before_ an urgent pointer,
1608 * in which case we send it to the back end with type==1
1609 * (data prior to urgent).
1613 p_ioctlsocket(s->s, SIOCATMARK, &atmark);
1615 * Avoid checking the return value from ioctlsocket(),
1616 * on the grounds that some WinSock wrappers don't
1617 * support it. If it does nothing, we get atmark==1,
1618 * which is equivalent to `no OOB pending', so the
1619 * effect will be to non-OOB-ify any OOB data.
1624 ret = p_recv(s->s, buf, sizeof(buf), 0);
1625 noise_ultralight(ret);
1627 err = p_WSAGetLastError();
1628 if (err == WSAEWOULDBLOCK) {
1633 return plug_closing(s->plug, winsock_error_string(err), err,
1635 } else if (0 == ret) {
1636 return plug_closing(s->plug, NULL, 0, 0);
1638 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1643 * This will only happen on a non-oobinline socket. It
1644 * indicates that we can immediately perform an OOB read
1645 * and get back OOB data, which we will send to the back
1646 * end with type==2 (urgent data).
1648 ret = p_recv(s->s, buf, sizeof(buf), MSG_OOB);
1649 noise_ultralight(ret);
1651 char *str = (ret == 0 ? "Internal networking trouble" :
1652 winsock_error_string(p_WSAGetLastError()));
1653 /* We're inside the Windows frontend here, so we know
1654 * that the frontend handle is unnecessary. */
1655 logevent(NULL, str);
1656 fatalbox("%s", str);
1658 return plug_receive(s->plug, 2, buf, ret);
1663 int bufsize_before, bufsize_after;
1665 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1667 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1668 if (bufsize_after < bufsize_before)
1669 plug_sent(s->plug, bufsize_after);
1673 /* Signal a close on the socket. First read any outstanding data. */
1676 ret = p_recv(s->s, buf, sizeof(buf), 0);
1678 err = p_WSAGetLastError();
1679 if (err == WSAEWOULDBLOCK)
1681 return plug_closing(s->plug, winsock_error_string(err),
1685 open &= plug_receive(s->plug, 0, buf, ret);
1687 open &= plug_closing(s->plug, NULL, 0, 0);
1694 struct sockaddr_in isa;
1696 struct sockaddr_storage isa;
1698 int addrlen = sizeof(isa);
1699 SOCKET t; /* socket of connection */
1702 memset(&isa, 0, sizeof(isa));
1704 t = p_accept(s->s,(struct sockaddr *)&isa,&addrlen);
1705 if (t == INVALID_SOCKET)
1707 err = p_WSAGetLastError();
1708 if (err == WSATRY_AGAIN)
1715 if (isa.ss_family == AF_INET &&
1716 s->localhost_only &&
1717 !ipv4_is_local_addr(((struct sockaddr_in *)&isa)->sin_addr))
1719 if (s->localhost_only && !ipv4_is_local_addr(isa.sin_addr))
1722 p_closesocket(t); /* dodgy WinSock let nonlocal through */
1723 } else if (plug_accepting(s->plug, sk_tcp_accept, actx)) {
1724 p_closesocket(t); /* denied or error */
1733 * Special error values are returned from sk_namelookup and sk_new
1734 * if there's a problem. These functions extract an error message,
1735 * or return NULL if there's no problem.
1737 const char *sk_addr_error(SockAddr addr)
1741 static const char *sk_tcp_socket_error(Socket sock)
1743 Actual_Socket s = (Actual_Socket) sock;
1747 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1749 Actual_Socket s = (Actual_Socket) sock;
1750 if (s->frozen == is_frozen)
1752 s->frozen = is_frozen;
1755 if (s->frozen_readable) {
1757 p_recv(s->s, &c, 1, MSG_PEEK);
1760 s->frozen_readable = 0;
1763 void socket_reselect_all(void)
1768 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1775 * For Plink: enumerate all sockets currently active.
1777 SOCKET first_socket(int *state)
1781 s = index234(sktree, (*state)++);
1782 return s ? s->s : INVALID_SOCKET;
1785 SOCKET next_socket(int *state)
1787 Actual_Socket s = index234(sktree, (*state)++);
1788 return s ? s->s : INVALID_SOCKET;
1791 extern int socket_writable(SOCKET skt)
1793 Actual_Socket s = find234(sktree, (void *)skt, cmpforsearch);
1796 return bufchain_size(&s->output_data) > 0;
1801 int net_service_lookup(char *service)
1804 se = p_getservbyname(service, NULL);
1806 return p_ntohs(se->s_port);
1811 char *get_hostname(void)
1814 char *hostname = NULL;
1817 hostname = sresize(hostname, len, char);
1818 if (p_gethostname(hostname, len) < 0) {
1823 } while (strlen(hostname) >= (size_t)(len-1));
1827 SockAddr platform_get_x11_unix_address(const char *display, int displaynum,
1828 char **canonicalname)
1830 SockAddr ret = snew(struct SockAddr_tag);
1831 memset(ret, 0, sizeof(struct SockAddr_tag));
1832 ret->error = "unix sockets not supported on this platform";