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 */
60 int frozen; /* this causes readability notifications to be ignored */
61 int frozen_readable; /* this means we missed at least one readability
62 * notification while we were frozen */
63 int localhost_only; /* for listening sockets */
66 int oobinline, nodelay, keepalive, privport;
67 enum { EOF_NO, EOF_PENDING, EOF_SENT } outgoingeof;
71 int pending_error; /* in case send() returns error */
73 * We sometimes need pairs of Socket structures to be linked:
74 * if we are listening on the same IPv6 and v4 port, for
75 * example. So here we define `parent' and `child' pointers to
78 Actual_Socket parent, child;
86 struct addrinfo *ais; /* Addresses IPv6 style. */
88 unsigned long *addresses; /* Addresses IPv4 style. */
90 char hostname[512]; /* Store an unresolved host name. */
94 * Which address family this address belongs to. AF_INET for IPv4;
95 * AF_INET6 for IPv6; AF_UNSPEC indicates that name resolution has
96 * not been done and a simple host name is held in this SockAddr
100 #define SOCKADDR_FAMILY(addr, step) \
101 (!(addr)->resolved ? AF_UNSPEC : \
102 (step).ai ? (step).ai->ai_family : AF_INET)
104 #define SOCKADDR_FAMILY(addr, step) \
105 (!(addr)->resolved ? AF_UNSPEC : AF_INET)
109 * Start a SockAddrStep structure to step through multiple
113 #define START_STEP(addr, step) \
114 ((step).ai = (addr)->ais, (step).curraddr = 0)
116 #define START_STEP(addr, step) \
117 ((step).curraddr = 0)
120 static tree234 *sktree;
122 static int cmpfortree(void *av, void *bv)
124 Actual_Socket a = (Actual_Socket) av, b = (Actual_Socket) bv;
125 unsigned long as = (unsigned long) a->s, bs = (unsigned long) b->s;
137 static int cmpforsearch(void *av, void *bv)
139 Actual_Socket b = (Actual_Socket) bv;
140 unsigned long as = (unsigned long) av, bs = (unsigned long) b->s;
148 DECL_WINDOWS_FUNCTION(static, int, WSAStartup, (WORD, LPWSADATA));
149 DECL_WINDOWS_FUNCTION(static, int, WSACleanup, (void));
150 DECL_WINDOWS_FUNCTION(static, int, closesocket, (SOCKET));
151 DECL_WINDOWS_FUNCTION(static, u_long, ntohl, (u_long));
152 DECL_WINDOWS_FUNCTION(static, u_long, htonl, (u_long));
153 DECL_WINDOWS_FUNCTION(static, u_short, htons, (u_short));
154 DECL_WINDOWS_FUNCTION(static, u_short, ntohs, (u_short));
155 DECL_WINDOWS_FUNCTION(static, int, gethostname, (char *, int));
156 DECL_WINDOWS_FUNCTION(static, struct hostent FAR *, gethostbyname,
158 DECL_WINDOWS_FUNCTION(static, struct servent FAR *, getservbyname,
159 (const char FAR *, const char FAR *));
160 DECL_WINDOWS_FUNCTION(static, unsigned long, inet_addr, (const char FAR *));
161 DECL_WINDOWS_FUNCTION(static, char FAR *, inet_ntoa, (struct in_addr));
162 DECL_WINDOWS_FUNCTION(static, int, connect,
163 (SOCKET, const struct sockaddr FAR *, int));
164 DECL_WINDOWS_FUNCTION(static, int, bind,
165 (SOCKET, const struct sockaddr FAR *, int));
166 DECL_WINDOWS_FUNCTION(static, int, setsockopt,
167 (SOCKET, int, int, const char FAR *, int));
168 DECL_WINDOWS_FUNCTION(static, SOCKET, socket, (int, int, int));
169 DECL_WINDOWS_FUNCTION(static, int, listen, (SOCKET, int));
170 DECL_WINDOWS_FUNCTION(static, int, send, (SOCKET, const char FAR *, int, int));
171 DECL_WINDOWS_FUNCTION(static, int, shutdown, (SOCKET, int));
172 DECL_WINDOWS_FUNCTION(static, int, ioctlsocket,
173 (SOCKET, long, u_long FAR *));
174 DECL_WINDOWS_FUNCTION(static, SOCKET, accept,
175 (SOCKET, struct sockaddr FAR *, int FAR *));
176 DECL_WINDOWS_FUNCTION(static, int, recv, (SOCKET, char FAR *, int, int));
177 DECL_WINDOWS_FUNCTION(static, int, WSAIoctl,
178 (SOCKET, DWORD, LPVOID, DWORD, LPVOID, DWORD,
179 LPDWORD, LPWSAOVERLAPPED,
180 LPWSAOVERLAPPED_COMPLETION_ROUTINE));
182 DECL_WINDOWS_FUNCTION(static, int, getaddrinfo,
183 (const char *nodename, const char *servname,
184 const struct addrinfo *hints, struct addrinfo **res));
185 DECL_WINDOWS_FUNCTION(static, void, freeaddrinfo, (struct addrinfo *res));
186 DECL_WINDOWS_FUNCTION(static, int, getnameinfo,
187 (const struct sockaddr FAR * sa, socklen_t salen,
188 char FAR * host, size_t hostlen, char FAR * serv,
189 size_t servlen, int flags));
190 DECL_WINDOWS_FUNCTION(static, char *, gai_strerror, (int ecode));
191 DECL_WINDOWS_FUNCTION(static, int, WSAAddressToStringA,
192 (LPSOCKADDR, DWORD, LPWSAPROTOCOL_INFO,
196 static HMODULE winsock_module = NULL;
197 static WSADATA wsadata;
199 static HMODULE winsock2_module = NULL;
200 static HMODULE wship6_module = NULL;
203 int sk_startup(int hi, int lo)
207 winsock_ver = MAKEWORD(hi, lo);
209 if (p_WSAStartup(winsock_ver, &wsadata)) {
213 if (LOBYTE(wsadata.wVersion) != LOBYTE(winsock_ver)) {
217 #ifdef NET_SETUP_DIAGNOSTICS
220 sprintf(buf, "Using WinSock %d.%d", hi, lo);
232 winsock_module = load_system32_dll("ws2_32.dll");
233 if (!winsock_module) {
234 winsock_module = load_system32_dll("wsock32.dll");
237 fatalbox("Unable to load any WinSock library");
240 /* Check if we have getaddrinfo in Winsock */
241 if (GetProcAddress(winsock_module, "getaddrinfo") != NULL) {
242 #ifdef NET_SETUP_DIAGNOSTICS
243 logevent(NULL, "Native WinSock IPv6 support detected");
245 GET_WINDOWS_FUNCTION(winsock_module, getaddrinfo);
246 GET_WINDOWS_FUNCTION(winsock_module, freeaddrinfo);
247 GET_WINDOWS_FUNCTION(winsock_module, getnameinfo);
248 GET_WINDOWS_FUNCTION(winsock_module, gai_strerror);
250 /* Fall back to wship6.dll for Windows 2000 */
251 wship6_module = load_system32_dll("wship6.dll");
253 #ifdef NET_SETUP_DIAGNOSTICS
254 logevent(NULL, "WSH IPv6 support detected");
256 GET_WINDOWS_FUNCTION(wship6_module, getaddrinfo);
257 GET_WINDOWS_FUNCTION(wship6_module, freeaddrinfo);
258 GET_WINDOWS_FUNCTION(wship6_module, getnameinfo);
259 GET_WINDOWS_FUNCTION(wship6_module, gai_strerror);
261 #ifdef NET_SETUP_DIAGNOSTICS
262 logevent(NULL, "No IPv6 support detected");
266 GET_WINDOWS_FUNCTION(winsock2_module, WSAAddressToStringA);
268 #ifdef NET_SETUP_DIAGNOSTICS
269 logevent(NULL, "PuTTY was built without IPv6 support");
273 GET_WINDOWS_FUNCTION(winsock_module, WSAAsyncSelect);
274 GET_WINDOWS_FUNCTION(winsock_module, WSAEventSelect);
275 GET_WINDOWS_FUNCTION(winsock_module, select);
276 GET_WINDOWS_FUNCTION(winsock_module, WSAGetLastError);
277 GET_WINDOWS_FUNCTION(winsock_module, WSAEnumNetworkEvents);
278 GET_WINDOWS_FUNCTION(winsock_module, WSAStartup);
279 GET_WINDOWS_FUNCTION(winsock_module, WSACleanup);
280 GET_WINDOWS_FUNCTION(winsock_module, closesocket);
281 GET_WINDOWS_FUNCTION(winsock_module, ntohl);
282 GET_WINDOWS_FUNCTION(winsock_module, htonl);
283 GET_WINDOWS_FUNCTION(winsock_module, htons);
284 GET_WINDOWS_FUNCTION(winsock_module, ntohs);
285 GET_WINDOWS_FUNCTION(winsock_module, gethostname);
286 GET_WINDOWS_FUNCTION(winsock_module, gethostbyname);
287 GET_WINDOWS_FUNCTION(winsock_module, getservbyname);
288 GET_WINDOWS_FUNCTION(winsock_module, inet_addr);
289 GET_WINDOWS_FUNCTION(winsock_module, inet_ntoa);
290 GET_WINDOWS_FUNCTION(winsock_module, connect);
291 GET_WINDOWS_FUNCTION(winsock_module, bind);
292 GET_WINDOWS_FUNCTION(winsock_module, setsockopt);
293 GET_WINDOWS_FUNCTION(winsock_module, socket);
294 GET_WINDOWS_FUNCTION(winsock_module, listen);
295 GET_WINDOWS_FUNCTION(winsock_module, send);
296 GET_WINDOWS_FUNCTION(winsock_module, shutdown);
297 GET_WINDOWS_FUNCTION(winsock_module, ioctlsocket);
298 GET_WINDOWS_FUNCTION(winsock_module, accept);
299 GET_WINDOWS_FUNCTION(winsock_module, recv);
300 GET_WINDOWS_FUNCTION(winsock_module, WSAIoctl);
302 /* Try to get the best WinSock version we can get */
303 if (!sk_startup(2,2) &&
306 fatalbox("Unable to initialise WinSock");
309 sktree = newtree234(cmpfortree);
312 void sk_cleanup(void)
318 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
328 FreeLibrary(winsock_module);
331 FreeLibrary(wship6_module);
340 static int errstring_find(void *av, void *bv)
343 struct errstring *b = (struct errstring *)bv;
350 static int errstring_compare(void *av, void *bv)
352 struct errstring *a = (struct errstring *)av;
353 return errstring_find(&a->error, bv);
356 static tree234 *errstrings = NULL;
358 char *winsock_error_string(int error)
360 const char prefix[] = "Network error: ";
361 struct errstring *es;
364 * Error codes we know about and have historically had reasonably
365 * sensible error messages for.
369 return "Network error: Permission denied";
371 return "Network error: Address already in use";
372 case WSAEADDRNOTAVAIL:
373 return "Network error: Cannot assign requested address";
374 case WSAEAFNOSUPPORT:
376 "Network error: Address family not supported by protocol family";
378 return "Network error: Operation already in progress";
379 case WSAECONNABORTED:
380 return "Network error: Software caused connection abort";
381 case WSAECONNREFUSED:
382 return "Network error: Connection refused";
384 return "Network error: Connection reset by peer";
385 case WSAEDESTADDRREQ:
386 return "Network error: Destination address required";
388 return "Network error: Bad address";
390 return "Network error: Host is down";
391 case WSAEHOSTUNREACH:
392 return "Network error: No route to host";
394 return "Network error: Operation now in progress";
396 return "Network error: Interrupted function call";
398 return "Network error: Invalid argument";
400 return "Network error: Socket is already connected";
402 return "Network error: Too many open files";
404 return "Network error: Message too long";
406 return "Network error: Network is down";
408 return "Network error: Network dropped connection on reset";
410 return "Network error: Network is unreachable";
412 return "Network error: No buffer space available";
414 return "Network error: Bad protocol option";
416 return "Network error: Socket is not connected";
418 return "Network error: Socket operation on non-socket";
420 return "Network error: Operation not supported";
421 case WSAEPFNOSUPPORT:
422 return "Network error: Protocol family not supported";
424 return "Network error: Too many processes";
425 case WSAEPROTONOSUPPORT:
426 return "Network error: Protocol not supported";
428 return "Network error: Protocol wrong type for socket";
430 return "Network error: Cannot send after socket shutdown";
431 case WSAESOCKTNOSUPPORT:
432 return "Network error: Socket type not supported";
434 return "Network error: Connection timed out";
436 return "Network error: Resource temporarily unavailable";
438 return "Network error: Graceful shutdown in progress";
442 * Generic code to handle any other error.
444 * Slightly nasty hack here: we want to return a static string
445 * which the caller will never have to worry about freeing, but on
446 * the other hand if we call FormatMessage to get it then it will
447 * want to either allocate a buffer or write into one we own.
449 * So what we do is to maintain a tree234 of error strings we've
450 * already used. New ones are allocated from the heap, but then
451 * put in this tree and kept forever.
455 errstrings = newtree234(errstring_compare);
457 es = find234(errstrings, &error, errstring_find);
460 int bufsize, bufused;
462 es = snew(struct errstring);
464 /* maximum size for FormatMessage is 64K */
465 bufsize = 65535 + sizeof(prefix);
466 es->text = snewn(bufsize, char);
467 strcpy(es->text, prefix);
468 bufused = strlen(es->text);
469 if (!FormatMessage((FORMAT_MESSAGE_FROM_SYSTEM |
470 FORMAT_MESSAGE_IGNORE_INSERTS), NULL, error,
471 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
472 es->text + bufused, bufsize - bufused, NULL)) {
473 sprintf(es->text + bufused,
474 "Windows error code %d (and FormatMessage returned %d)",
475 error, GetLastError());
477 int len = strlen(es->text);
478 if (len > 0 && es->text[len-1] == '\n')
479 es->text[len-1] = '\0';
481 es->text = sresize(es->text, strlen(es->text) + 1, char);
482 add234(errstrings, es);
488 SockAddr sk_namelookup(const char *host, char **canonicalname,
491 SockAddr ret = snew(struct SockAddr_tag);
496 /* Default to IPv4. */
497 hint_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
499 address_family == ADDRTYPE_IPV6 ? AF_INET6 :
503 /* Clear the structure and default to IPv4. */
504 memset(ret, 0, sizeof(struct SockAddr_tag));
508 ret->addresses = NULL;
509 ret->resolved = FALSE;
513 if ((a = p_inet_addr(host)) == (unsigned long) INADDR_NONE) {
514 struct hostent *h = NULL;
518 * Use getaddrinfo when it's available
521 struct addrinfo hints;
522 #ifdef NET_SETUP_DIAGNOSTICS
523 logevent(NULL, "Using getaddrinfo() for resolving");
525 memset(&hints, 0, sizeof(hints));
526 hints.ai_family = hint_family;
527 hints.ai_flags = AI_CANONNAME;
528 if ((err = p_getaddrinfo(host, NULL, &hints, &ret->ais)) == 0)
529 ret->resolved = TRUE;
533 #ifdef NET_SETUP_DIAGNOSTICS
534 logevent(NULL, "Using gethostbyname() for resolving");
537 * Otherwise use the IPv4-only gethostbyname...
538 * (NOTE: we don't use gethostbyname as a fallback!)
540 if ( (h = p_gethostbyname(host)) )
541 ret->resolved = TRUE;
543 err = p_WSAGetLastError();
546 if (!ret->resolved) {
547 ret->error = (err == WSAENETDOWN ? "Network is down" :
548 err == WSAHOST_NOT_FOUND ? "Host does not exist" :
549 err == WSATRY_AGAIN ? "Host not found" :
551 p_getaddrinfo&&p_gai_strerror ? p_gai_strerror(err) :
553 "gethostbyname: unknown error");
558 /* If we got an address info use that... */
560 /* Are we in IPv4 fallback mode? */
561 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
562 if (ret->ais->ai_family == AF_INET)
564 (char *) &((SOCKADDR_IN *) ret->ais->
565 ai_addr)->sin_addr, sizeof(a));
567 if (ret->ais->ai_canonname)
568 strncpy(realhost, ret->ais->ai_canonname, lenof(realhost));
570 strncpy(realhost, host, lenof(realhost));
572 /* We used the IPv4-only gethostbyname()... */
577 for (n = 0; h->h_addr_list[n]; n++);
578 ret->addresses = snewn(n, unsigned long);
580 for (n = 0; n < ret->naddresses; n++) {
581 memcpy(&a, h->h_addr_list[n], sizeof(a));
582 ret->addresses[n] = p_ntohl(a);
584 memcpy(&a, h->h_addr, sizeof(a));
585 /* This way we are always sure the h->h_name is valid :) */
586 strncpy(realhost, h->h_name, sizeof(realhost));
591 * This must be a numeric IPv4 address because it caused a
592 * success return from inet_addr.
594 ret->addresses = snewn(1, unsigned long);
596 ret->addresses[0] = p_ntohl(a);
597 ret->resolved = TRUE;
598 strncpy(realhost, host, sizeof(realhost));
600 realhost[lenof(realhost)-1] = '\0';
601 *canonicalname = snewn(1+strlen(realhost), char);
602 strcpy(*canonicalname, realhost);
606 SockAddr sk_nonamelookup(const char *host)
608 SockAddr ret = snew(struct SockAddr_tag);
610 ret->resolved = FALSE;
614 ret->addresses = NULL;
617 strncpy(ret->hostname, host, lenof(ret->hostname));
618 ret->hostname[lenof(ret->hostname)-1] = '\0';
622 int sk_nextaddr(SockAddr addr, SockAddrStep *step)
626 if (step->ai->ai_next) {
627 step->ai = step->ai->ai_next;
633 if (step->curraddr+1 < addr->naddresses) {
641 void sk_getaddr(SockAddr addr, char *buf, int buflen)
644 START_STEP(addr, step);
649 if (p_WSAAddressToStringA) {
650 DWORD dwbuflen = buflen;
651 err = p_WSAAddressToStringA(step.ai->ai_addr, step.ai->ai_addrlen,
652 NULL, buf, &dwbuflen);
656 strncpy(buf, addr->hostname, buflen);
658 strncpy(buf, "<unknown>", buflen);
659 buf[buflen-1] = '\0';
663 if (SOCKADDR_FAMILY(addr, step) == AF_INET) {
665 assert(addr->addresses && step.curraddr < addr->naddresses);
666 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
667 strncpy(buf, p_inet_ntoa(a), buflen);
668 buf[buflen-1] = '\0';
670 strncpy(buf, addr->hostname, buflen);
671 buf[buflen-1] = '\0';
675 int sk_hostname_is_local(char *name)
677 return !strcmp(name, "localhost") ||
678 !strcmp(name, "::1") ||
679 !strncmp(name, "127.", 4);
682 static INTERFACE_INFO local_interfaces[16];
683 static int n_local_interfaces; /* 0=not yet, -1=failed, >0=number */
685 static int ipv4_is_local_addr(struct in_addr addr)
687 if (ipv4_is_loopback(addr))
688 return 1; /* loopback addresses are local */
689 if (!n_local_interfaces) {
690 SOCKET s = p_socket(AF_INET, SOCK_DGRAM, 0);
694 p_WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0,
695 local_interfaces, sizeof(local_interfaces),
696 &retbytes, NULL, NULL) == 0)
697 n_local_interfaces = retbytes / sizeof(INTERFACE_INFO);
699 logevent(NULL, "Unable to get list of local IP addresses");
701 if (n_local_interfaces > 0) {
703 for (i = 0; i < n_local_interfaces; i++) {
704 SOCKADDR_IN *address =
705 (SOCKADDR_IN *)&local_interfaces[i].iiAddress;
706 if (address->sin_addr.s_addr == addr.s_addr)
707 return 1; /* this address is local */
710 return 0; /* this address is not local */
713 int sk_address_is_local(SockAddr addr)
717 START_STEP(addr, step);
718 family = SOCKADDR_FAMILY(addr, step);
721 if (family == AF_INET6) {
722 return IN6_IS_ADDR_LOOPBACK(&((const struct sockaddr_in6 *)step.ai->ai_addr)->sin6_addr);
725 if (family == AF_INET) {
728 return ipv4_is_local_addr(((struct sockaddr_in *)step.ai->ai_addr)
734 assert(addr->addresses && step.curraddr < addr->naddresses);
735 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
736 return ipv4_is_local_addr(a);
739 assert(family == AF_UNSPEC);
740 return 0; /* we don't know; assume not */
744 int sk_address_is_special_local(SockAddr addr)
746 return 0; /* no Unix-domain socket analogue here */
749 int sk_addrtype(SockAddr addr)
753 START_STEP(addr, step);
754 family = SOCKADDR_FAMILY(addr, step);
756 return (family == AF_INET ? ADDRTYPE_IPV4 :
758 family == AF_INET6 ? ADDRTYPE_IPV6 :
763 void sk_addrcopy(SockAddr addr, char *buf)
767 START_STEP(addr, step);
768 family = SOCKADDR_FAMILY(addr, step);
770 assert(family != AF_UNSPEC);
773 if (family == AF_INET)
774 memcpy(buf, &((struct sockaddr_in *)step.ai->ai_addr)->sin_addr,
775 sizeof(struct in_addr));
776 else if (family == AF_INET6)
777 memcpy(buf, &((struct sockaddr_in6 *)step.ai->ai_addr)->sin6_addr,
778 sizeof(struct in6_addr));
783 if (family == AF_INET) {
785 assert(addr->addresses && step.curraddr < addr->naddresses);
786 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
787 memcpy(buf, (char*) &a.s_addr, 4);
791 void sk_addr_free(SockAddr addr)
793 if (--addr->refcount > 0)
796 if (addr->ais && p_freeaddrinfo)
797 p_freeaddrinfo(addr->ais);
800 sfree(addr->addresses);
804 SockAddr sk_addr_dup(SockAddr addr)
810 static Plug sk_tcp_plug(Socket sock, Plug p)
812 Actual_Socket s = (Actual_Socket) sock;
819 static void sk_tcp_flush(Socket s)
822 * We send data to the socket as soon as we can anyway,
823 * so we don't need to do anything here. :-)
827 static void sk_tcp_close(Socket s);
828 static int sk_tcp_write(Socket s, const char *data, int len);
829 static int sk_tcp_write_oob(Socket s, const char *data, int len);
830 static void sk_tcp_write_eof(Socket s);
831 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
832 static void *sk_tcp_get_private_ptr(Socket s);
833 static void sk_tcp_set_frozen(Socket s, int is_frozen);
834 static const char *sk_tcp_socket_error(Socket s);
836 extern char *do_select(SOCKET skt, int startup);
838 Socket sk_register(void *sock, Plug plug)
840 static const struct socket_function_table fn_table = {
847 sk_tcp_set_private_ptr,
848 sk_tcp_get_private_ptr,
858 * Create Socket structure.
860 ret = snew(struct Socket_tag);
864 bufchain_init(&ret->output_data);
865 ret->writable = 1; /* to start with */
866 ret->sending_oob = 0;
867 ret->outgoingeof = EOF_NO;
869 ret->frozen_readable = 0;
870 ret->localhost_only = 0; /* unused, but best init anyway */
871 ret->pending_error = 0;
872 ret->parent = ret->child = NULL;
875 ret->s = (SOCKET)sock;
877 if (ret->s == INVALID_SOCKET) {
878 err = p_WSAGetLastError();
879 ret->error = winsock_error_string(err);
885 /* Set up a select mechanism. This could be an AsyncSelect on a
886 * window, or an EventSelect on an event object. */
887 errstr = do_select(ret->s, 1);
898 static DWORD try_connect(Actual_Socket sock)
910 if (sock->s != INVALID_SOCKET) {
911 do_select(sock->s, 0);
912 p_closesocket(sock->s);
915 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
920 family = SOCKADDR_FAMILY(sock->addr, sock->step);
923 * Remove the socket from the tree before we overwrite its
924 * internal socket id, because that forms part of the tree's
925 * sorting criterion. We'll add it back before exiting this
926 * function, whether we changed anything or not.
928 del234(sktree, sock);
930 s = p_socket(family, SOCK_STREAM, 0);
933 if (s == INVALID_SOCKET) {
934 err = p_WSAGetLastError();
935 sock->error = winsock_error_string(err);
939 if (sock->oobinline) {
941 p_setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
946 p_setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
949 if (sock->keepalive) {
951 p_setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
955 * Bind to local address.
958 localport = 1023; /* count from 1023 downwards */
960 localport = 0; /* just use port 0 (ie winsock picks) */
962 /* Loop round trying to bind */
967 if (family == AF_INET6) {
968 memset(&a6, 0, sizeof(a6));
969 a6.sin6_family = AF_INET6;
970 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
971 a6.sin6_port = p_htons(localport);
975 a.sin_family = AF_INET;
976 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
977 a.sin_port = p_htons(localport);
980 sockcode = p_bind(s, (family == AF_INET6 ?
981 (struct sockaddr *) &a6 :
982 (struct sockaddr *) &a),
983 (family == AF_INET6 ? sizeof(a6) : sizeof(a)));
985 sockcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
987 if (sockcode != SOCKET_ERROR) {
991 err = p_WSAGetLastError();
992 if (err != WSAEADDRINUSE) /* failed, for a bad reason */
997 break; /* we're only looping once */
1000 break; /* we might have got to the end */
1004 sock->error = winsock_error_string(err);
1009 * Connect to remote address.
1012 if (sock->step.ai) {
1013 if (family == AF_INET6) {
1014 a6.sin6_family = AF_INET6;
1015 a6.sin6_port = p_htons((short) sock->port);
1017 ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_addr;
1018 a6.sin6_flowinfo = ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_flowinfo;
1019 a6.sin6_scope_id = ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_scope_id;
1021 a.sin_family = AF_INET;
1023 ((struct sockaddr_in *) sock->step.ai->ai_addr)->sin_addr;
1024 a.sin_port = p_htons((short) sock->port);
1029 assert(sock->addr->addresses && sock->step.curraddr < sock->addr->naddresses);
1030 a.sin_family = AF_INET;
1031 a.sin_addr.s_addr = p_htonl(sock->addr->addresses[sock->step.curraddr]);
1032 a.sin_port = p_htons((short) sock->port);
1035 /* Set up a select mechanism. This could be an AsyncSelect on a
1036 * window, or an EventSelect on an event object. */
1037 errstr = do_select(s, 1);
1039 sock->error = errstr;
1047 ((family == AF_INET6) ? (struct sockaddr *) &a6 :
1048 (struct sockaddr *) &a),
1049 (family == AF_INET6) ? sizeof(a6) : sizeof(a))
1051 p_connect(s, (struct sockaddr *) &a, sizeof(a))
1053 ) == SOCKET_ERROR) {
1054 err = p_WSAGetLastError();
1056 * We expect a potential EWOULDBLOCK here, because the
1057 * chances are the front end has done a select for
1058 * FD_CONNECT, so that connect() will complete
1061 if ( err != WSAEWOULDBLOCK ) {
1062 sock->error = winsock_error_string(err);
1067 * If we _don't_ get EWOULDBLOCK, the connect has completed
1068 * and we should set the socket as writable.
1078 * No matter what happened, put the socket back in the tree.
1080 add234(sktree, sock);
1083 plug_log(sock->plug, 1, sock->addr, sock->port, sock->error, err);
1087 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
1088 int nodelay, int keepalive, Plug plug)
1090 static const struct socket_function_table fn_table = {
1097 sk_tcp_set_private_ptr,
1098 sk_tcp_get_private_ptr,
1107 * Create Socket structure.
1109 ret = snew(struct Socket_tag);
1110 ret->fn = &fn_table;
1113 bufchain_init(&ret->output_data);
1114 ret->connected = 0; /* to start with */
1115 ret->writable = 0; /* to start with */
1116 ret->sending_oob = 0;
1117 ret->outgoingeof = EOF_NO;
1119 ret->frozen_readable = 0;
1120 ret->localhost_only = 0; /* unused, but best init anyway */
1121 ret->pending_error = 0;
1122 ret->parent = ret->child = NULL;
1123 ret->oobinline = oobinline;
1124 ret->nodelay = nodelay;
1125 ret->keepalive = keepalive;
1126 ret->privport = privport;
1129 START_STEP(ret->addr, ret->step);
1130 ret->s = INVALID_SOCKET;
1134 err = try_connect(ret);
1135 } while (err && sk_nextaddr(ret->addr, &ret->step));
1137 return (Socket) ret;
1140 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only,
1141 int orig_address_family)
1143 static const struct socket_function_table fn_table = {
1150 sk_tcp_set_private_ptr,
1151 sk_tcp_get_private_ptr,
1171 * Create Socket structure.
1173 ret = snew(struct Socket_tag);
1174 ret->fn = &fn_table;
1177 bufchain_init(&ret->output_data);
1178 ret->writable = 0; /* to start with */
1179 ret->sending_oob = 0;
1180 ret->outgoingeof = EOF_NO;
1182 ret->frozen_readable = 0;
1183 ret->localhost_only = local_host_only;
1184 ret->pending_error = 0;
1185 ret->parent = ret->child = NULL;
1189 * Translate address_family from platform-independent constants
1190 * into local reality.
1192 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
1194 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
1199 * Our default, if passed the `don't care' value
1200 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1201 * we will also set up a second socket listening on IPv6, but
1202 * the v4 one is primary since that ought to work even on
1203 * non-v6-supporting systems.
1205 if (address_family == AF_UNSPEC) address_family = AF_INET;
1210 s = p_socket(address_family, SOCK_STREAM, 0);
1213 if (s == INVALID_SOCKET) {
1214 err = p_WSAGetLastError();
1215 ret->error = winsock_error_string(err);
1216 return (Socket) ret;
1221 p_setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
1224 if (address_family == AF_INET6) {
1225 memset(&a6, 0, sizeof(a6));
1226 a6.sin6_family = AF_INET6;
1227 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1228 * know how to do it. :-)
1229 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1230 * Thus we need either a parser that understands [2001:db8::1]:80
1231 * style addresses and/or enhance this to understand hostnames too. */
1232 if (local_host_only)
1233 a6.sin6_addr = in6addr_loopback;
1235 a6.sin6_addr = in6addr_any;
1236 a6.sin6_port = p_htons(port);
1241 a.sin_family = AF_INET;
1244 * Bind to source address. First try an explicitly
1248 a.sin_addr.s_addr = p_inet_addr(srcaddr);
1249 if (a.sin_addr.s_addr != INADDR_NONE) {
1250 /* Override localhost_only with specified listen addr. */
1251 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
1257 * ... and failing that, go with one of the standard ones.
1260 if (local_host_only)
1261 a.sin_addr.s_addr = p_htonl(INADDR_LOOPBACK);
1263 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
1266 a.sin_port = p_htons((short)port);
1269 retcode = p_bind(s, (address_family == AF_INET6 ?
1270 (struct sockaddr *) &a6 :
1271 (struct sockaddr *) &a),
1273 AF_INET6 ? sizeof(a6) : sizeof(a)));
1275 retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
1277 if (retcode != SOCKET_ERROR) {
1280 err = p_WSAGetLastError();
1285 ret->error = winsock_error_string(err);
1286 return (Socket) ret;
1290 if (p_listen(s, SOMAXCONN) == SOCKET_ERROR) {
1292 ret->error = winsock_error_string(p_WSAGetLastError());
1293 return (Socket) ret;
1296 /* Set up a select mechanism. This could be an AsyncSelect on a
1297 * window, or an EventSelect on an event object. */
1298 errstr = do_select(s, 1);
1301 ret->error = errstr;
1302 return (Socket) ret;
1305 add234(sktree, ret);
1309 * If we were given ADDRTYPE_UNSPEC, we must also create an
1310 * IPv6 listening socket and link it to this one.
1312 if (address_family == AF_INET && orig_address_family == ADDRTYPE_UNSPEC) {
1313 Actual_Socket other;
1315 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
1316 local_host_only, ADDRTYPE_IPV6);
1319 if (!other->error) {
1320 other->parent = ret;
1329 return (Socket) ret;
1332 static void sk_tcp_close(Socket sock)
1334 extern char *do_select(SOCKET skt, int startup);
1335 Actual_Socket s = (Actual_Socket) sock;
1338 sk_tcp_close((Socket)s->child);
1342 p_closesocket(s->s);
1344 sk_addr_free(s->addr);
1349 * The function which tries to send on a socket once it's deemed
1352 void try_send(Actual_Socket s)
1354 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1358 int len, urgentflag;
1360 if (s->sending_oob) {
1361 urgentflag = MSG_OOB;
1362 len = s->sending_oob;
1366 bufchain_prefix(&s->output_data, &data, &len);
1368 nsent = p_send(s->s, data, len, urgentflag);
1369 noise_ultralight(nsent);
1371 err = (nsent < 0 ? p_WSAGetLastError() : 0);
1372 if ((err < WSABASEERR && nsent < 0) || err == WSAEWOULDBLOCK) {
1374 * Perfectly normal: we've sent all we can for the moment.
1376 * (Some WinSock send() implementations can return
1377 * <0 but leave no sensible error indication -
1378 * WSAGetLastError() is called but returns zero or
1379 * a small number - so we check that case and treat
1380 * it just like WSAEWOULDBLOCK.)
1382 s->writable = FALSE;
1384 } else if (nsent == 0 ||
1385 err == WSAECONNABORTED || err == WSAECONNRESET) {
1387 * If send() returns CONNABORTED or CONNRESET, we
1388 * unfortunately can't just call plug_closing(),
1389 * because it's quite likely that we're currently
1390 * _in_ a call from the code we'd be calling back
1391 * to, so we'd have to make half the SSH code
1392 * reentrant. Instead we flag a pending error on
1393 * the socket, to be dealt with (by calling
1394 * plug_closing()) at some suitable future moment.
1396 s->pending_error = err;
1399 /* We're inside the Windows frontend here, so we know
1400 * that the frontend handle is unnecessary. */
1401 logevent(NULL, winsock_error_string(err));
1402 fatalbox("%s", winsock_error_string(err));
1405 if (s->sending_oob) {
1407 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1408 s->sending_oob = len - nsent;
1413 bufchain_consume(&s->output_data, nsent);
1419 * If we reach here, we've finished sending everything we might
1420 * have needed to send. Send EOF, if we need to.
1422 if (s->outgoingeof == EOF_PENDING) {
1423 p_shutdown(s->s, SD_SEND);
1424 s->outgoingeof = EOF_SENT;
1428 static int sk_tcp_write(Socket sock, const char *buf, int len)
1430 Actual_Socket s = (Actual_Socket) sock;
1432 assert(s->outgoingeof == EOF_NO);
1435 * Add the data to the buffer list on the socket.
1437 bufchain_add(&s->output_data, buf, len);
1440 * Now try sending from the start of the buffer list.
1445 return bufchain_size(&s->output_data);
1448 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1450 Actual_Socket s = (Actual_Socket) sock;
1452 assert(s->outgoingeof == EOF_NO);
1455 * Replace the buffer list on the socket with the data.
1457 bufchain_clear(&s->output_data);
1458 assert(len <= sizeof(s->oobdata));
1459 memcpy(s->oobdata, buf, len);
1460 s->sending_oob = len;
1463 * Now try sending from the start of the buffer list.
1468 return s->sending_oob;
1471 static void sk_tcp_write_eof(Socket sock)
1473 Actual_Socket s = (Actual_Socket) sock;
1475 assert(s->outgoingeof == EOF_NO);
1478 * Mark the socket as pending outgoing EOF.
1480 s->outgoingeof = EOF_PENDING;
1483 * Now try sending from the start of the buffer list.
1489 int select_result(WPARAM wParam, LPARAM lParam)
1493 char buf[20480]; /* nice big buffer for plenty of speed */
1497 /* wParam is the socket itself */
1500 return 1; /* boggle */
1502 s = find234(sktree, (void *) wParam, cmpforsearch);
1504 return 1; /* boggle */
1506 if ((err = WSAGETSELECTERROR(lParam)) != 0) {
1508 * An error has occurred on this socket. Pass it to the
1512 plug_log(s->plug, 1, s->addr, s->port,
1513 winsock_error_string(err), err);
1514 while (s->addr && sk_nextaddr(s->addr, &s->step)) {
1515 err = try_connect(s);
1519 return plug_closing(s->plug, winsock_error_string(err), err, 0);
1524 noise_ultralight(lParam);
1526 switch (WSAGETSELECTEVENT(lParam)) {
1528 s->connected = s->writable = 1;
1530 * Once a socket is connected, we can stop falling
1531 * back through the candidate addresses to connect
1535 sk_addr_free(s->addr);
1540 /* In the case the socket is still frozen, we don't even bother */
1542 s->frozen_readable = 1;
1547 * We have received data on the socket. For an oobinline
1548 * socket, this might be data _before_ an urgent pointer,
1549 * in which case we send it to the back end with type==1
1550 * (data prior to urgent).
1554 p_ioctlsocket(s->s, SIOCATMARK, &atmark);
1556 * Avoid checking the return value from ioctlsocket(),
1557 * on the grounds that some WinSock wrappers don't
1558 * support it. If it does nothing, we get atmark==1,
1559 * which is equivalent to `no OOB pending', so the
1560 * effect will be to non-OOB-ify any OOB data.
1565 ret = p_recv(s->s, buf, sizeof(buf), 0);
1566 noise_ultralight(ret);
1568 err = p_WSAGetLastError();
1569 if (err == WSAEWOULDBLOCK) {
1574 return plug_closing(s->plug, winsock_error_string(err), err,
1576 } else if (0 == ret) {
1577 return plug_closing(s->plug, NULL, 0, 0);
1579 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1584 * This will only happen on a non-oobinline socket. It
1585 * indicates that we can immediately perform an OOB read
1586 * and get back OOB data, which we will send to the back
1587 * end with type==2 (urgent data).
1589 ret = p_recv(s->s, buf, sizeof(buf), MSG_OOB);
1590 noise_ultralight(ret);
1592 char *str = (ret == 0 ? "Internal networking trouble" :
1593 winsock_error_string(p_WSAGetLastError()));
1594 /* We're inside the Windows frontend here, so we know
1595 * that the frontend handle is unnecessary. */
1596 logevent(NULL, str);
1597 fatalbox("%s", str);
1599 return plug_receive(s->plug, 2, buf, ret);
1604 int bufsize_before, bufsize_after;
1606 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1608 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1609 if (bufsize_after < bufsize_before)
1610 plug_sent(s->plug, bufsize_after);
1614 /* Signal a close on the socket. First read any outstanding data. */
1617 ret = p_recv(s->s, buf, sizeof(buf), 0);
1619 err = p_WSAGetLastError();
1620 if (err == WSAEWOULDBLOCK)
1622 return plug_closing(s->plug, winsock_error_string(err),
1626 open &= plug_receive(s->plug, 0, buf, ret);
1628 open &= plug_closing(s->plug, NULL, 0, 0);
1635 struct sockaddr_in isa;
1637 struct sockaddr_storage isa;
1639 int addrlen = sizeof(isa);
1640 SOCKET t; /* socket of connection */
1642 memset(&isa, 0, sizeof(isa));
1644 t = p_accept(s->s,(struct sockaddr *)&isa,&addrlen);
1645 if (t == INVALID_SOCKET)
1647 err = p_WSAGetLastError();
1648 if (err == WSATRY_AGAIN)
1652 if (isa.ss_family == AF_INET &&
1653 s->localhost_only &&
1654 !ipv4_is_local_addr(((struct sockaddr_in *)&isa)->sin_addr))
1656 if (s->localhost_only && !ipv4_is_local_addr(isa.sin_addr))
1659 p_closesocket(t); /* dodgy WinSock let nonlocal through */
1660 } else if (plug_accepting(s->plug, (void*)t)) {
1661 p_closesocket(t); /* denied or error */
1670 * Deal with socket errors detected in try_send().
1672 void net_pending_errors(void)
1678 * This might be a fiddly business, because it's just possible
1679 * that handling a pending error on one socket might cause
1680 * others to be closed. (I can't think of any reason this might
1681 * happen in current SSH implementation, but to maintain
1682 * generality of this network layer I'll assume the worst.)
1684 * So what we'll do is search the socket list for _one_ socket
1685 * with a pending error, and then handle it, and then search
1686 * the list again _from the beginning_. Repeat until we make a
1687 * pass with no socket errors present. That way we are
1688 * protected against the socket list changing under our feet.
1692 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1693 if (s->pending_error) {
1695 * An error has occurred on this socket. Pass it to the
1698 plug_closing(s->plug,
1699 winsock_error_string(s->pending_error),
1700 s->pending_error, 0);
1708 * Each socket abstraction contains a `void *' private field in
1709 * which the client can keep state.
1711 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1713 Actual_Socket s = (Actual_Socket) sock;
1714 s->private_ptr = ptr;
1717 static void *sk_tcp_get_private_ptr(Socket sock)
1719 Actual_Socket s = (Actual_Socket) sock;
1720 return s->private_ptr;
1724 * Special error values are returned from sk_namelookup and sk_new
1725 * if there's a problem. These functions extract an error message,
1726 * or return NULL if there's no problem.
1728 const char *sk_addr_error(SockAddr addr)
1732 static const char *sk_tcp_socket_error(Socket sock)
1734 Actual_Socket s = (Actual_Socket) sock;
1738 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1740 Actual_Socket s = (Actual_Socket) sock;
1741 if (s->frozen == is_frozen)
1743 s->frozen = is_frozen;
1746 if (s->frozen_readable) {
1748 p_recv(s->s, &c, 1, MSG_PEEK);
1751 s->frozen_readable = 0;
1754 void socket_reselect_all(void)
1759 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1766 * For Plink: enumerate all sockets currently active.
1768 SOCKET first_socket(int *state)
1772 s = index234(sktree, (*state)++);
1773 return s ? s->s : INVALID_SOCKET;
1776 SOCKET next_socket(int *state)
1778 Actual_Socket s = index234(sktree, (*state)++);
1779 return s ? s->s : INVALID_SOCKET;
1782 extern int socket_writable(SOCKET skt)
1784 Actual_Socket s = find234(sktree, (void *)skt, cmpforsearch);
1787 return bufchain_size(&s->output_data) > 0;
1792 int net_service_lookup(char *service)
1795 se = p_getservbyname(service, NULL);
1797 return p_ntohs(se->s_port);
1802 char *get_hostname(void)
1805 char *hostname = NULL;
1808 hostname = sresize(hostname, len, char);
1809 if (p_gethostname(hostname, len) < 0) {
1814 } while (strlen(hostname) >= (size_t)(len-1));
1818 SockAddr platform_get_x11_unix_address(const char *display, int displaynum,
1819 char **canonicalname)
1821 SockAddr ret = snew(struct SockAddr_tag);
1822 memset(ret, 0, sizeof(struct SockAddr_tag));
1823 ret->error = "unix sockets not supported on this platform";