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;
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;
85 struct addrinfo *ais; /* Addresses IPv6 style. */
87 unsigned long *addresses; /* Addresses IPv4 style. */
89 char hostname[512]; /* Store an unresolved host name. */
93 * Which address family this address belongs to. AF_INET for IPv4;
94 * AF_INET6 for IPv6; AF_UNSPEC indicates that name resolution has
95 * not been done and a simple host name is held in this SockAddr
99 #define SOCKADDR_FAMILY(addr, step) \
100 (!(addr)->resolved ? AF_UNSPEC : \
101 (step).ai ? (step).ai->ai_family : AF_INET)
103 #define SOCKADDR_FAMILY(addr, step) \
104 (!(addr)->resolved ? AF_UNSPEC : AF_INET)
108 * Start a SockAddrStep structure to step through multiple
112 #define START_STEP(addr, step) \
113 ((step).ai = (addr)->ais, (step).curraddr = 0)
115 #define START_STEP(addr, step) \
116 ((step).curraddr = 0)
119 static tree234 *sktree;
121 static int cmpfortree(void *av, void *bv)
123 Actual_Socket a = (Actual_Socket) av, b = (Actual_Socket) bv;
124 unsigned long as = (unsigned long) a->s, bs = (unsigned long) b->s;
136 static int cmpforsearch(void *av, void *bv)
138 Actual_Socket b = (Actual_Socket) bv;
139 unsigned long as = (unsigned long) av, bs = (unsigned long) b->s;
148 #define DECL_WINSOCK_FUNCTION(linkage, rettype, name, params) \
149 typedef rettype (WINAPI *t_##name) params; \
150 linkage t_##name p_##name
151 #define GET_WINSOCK_FUNCTION(module, name) \
152 p_##name = module ? (t_##name) GetProcAddress(module, #name) : NULL
154 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAAsyncSelect,
155 (SOCKET, HWND, u_int, long));
156 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAEventSelect, (SOCKET, WSAEVENT, long));
157 DECL_WINSOCK_FUNCTION(NOTHING, int, select,
158 (int, fd_set FAR *, fd_set FAR *,
159 fd_set FAR *, const struct timeval FAR *));
160 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAGetLastError, (void));
161 DECL_WINSOCK_FUNCTION(NOTHING, int, WSAEnumNetworkEvents,
162 (SOCKET, WSAEVENT, LPWSANETWORKEVENTS));
163 DECL_WINSOCK_FUNCTION(static, int, WSAStartup, (WORD, LPWSADATA));
164 DECL_WINSOCK_FUNCTION(static, int, WSACleanup, (void));
165 DECL_WINSOCK_FUNCTION(static, int, closesocket, (SOCKET));
166 DECL_WINSOCK_FUNCTION(static, u_long, ntohl, (u_long));
167 DECL_WINSOCK_FUNCTION(static, u_long, htonl, (u_long));
168 DECL_WINSOCK_FUNCTION(static, u_short, htons, (u_short));
169 DECL_WINSOCK_FUNCTION(static, u_short, ntohs, (u_short));
170 DECL_WINSOCK_FUNCTION(static, int, gethostname, (char *, int));
171 DECL_WINSOCK_FUNCTION(static, struct hostent FAR *, gethostbyname,
173 DECL_WINSOCK_FUNCTION(static, struct servent FAR *, getservbyname,
174 (const char FAR *, const char FAR *));
175 DECL_WINSOCK_FUNCTION(static, unsigned long, inet_addr, (const char FAR *));
176 DECL_WINSOCK_FUNCTION(static, char FAR *, inet_ntoa, (struct in_addr));
177 DECL_WINSOCK_FUNCTION(static, int, connect,
178 (SOCKET, const struct sockaddr FAR *, int));
179 DECL_WINSOCK_FUNCTION(static, int, bind,
180 (SOCKET, const struct sockaddr FAR *, int));
181 DECL_WINSOCK_FUNCTION(static, int, setsockopt,
182 (SOCKET, int, int, const char FAR *, int));
183 DECL_WINSOCK_FUNCTION(static, SOCKET, socket, (int, int, int));
184 DECL_WINSOCK_FUNCTION(static, int, listen, (SOCKET, int));
185 DECL_WINSOCK_FUNCTION(static, int, send, (SOCKET, const char FAR *, int, int));
186 DECL_WINSOCK_FUNCTION(static, int, ioctlsocket,
187 (SOCKET, long, u_long FAR *));
188 DECL_WINSOCK_FUNCTION(static, SOCKET, accept,
189 (SOCKET, struct sockaddr FAR *, int FAR *));
190 DECL_WINSOCK_FUNCTION(static, int, recv, (SOCKET, char FAR *, int, int));
191 DECL_WINSOCK_FUNCTION(static, int, WSAIoctl,
192 (SOCKET, DWORD, LPVOID, DWORD, LPVOID, DWORD,
193 LPDWORD, LPWSAOVERLAPPED,
194 LPWSAOVERLAPPED_COMPLETION_ROUTINE));
196 DECL_WINSOCK_FUNCTION(static, int, getaddrinfo,
197 (const char *nodename, const char *servname,
198 const struct addrinfo *hints, struct addrinfo **res));
199 DECL_WINSOCK_FUNCTION(static, void, freeaddrinfo, (struct addrinfo *res));
200 DECL_WINSOCK_FUNCTION(static, int, getnameinfo,
201 (const struct sockaddr FAR * sa, socklen_t salen,
202 char FAR * host, size_t hostlen, char FAR * serv,
203 size_t servlen, int flags));
204 DECL_WINSOCK_FUNCTION(static, char *, gai_strerror, (int ecode));
205 DECL_WINSOCK_FUNCTION(static, int, WSAAddressToStringA,
206 (LPSOCKADDR, DWORD, LPWSAPROTOCOL_INFO,
210 static HMODULE winsock_module = NULL;
211 static WSADATA wsadata;
213 static HMODULE winsock2_module = NULL;
214 static HMODULE wship6_module = NULL;
217 int sk_startup(int hi, int lo)
221 winsock_ver = MAKEWORD(hi, lo);
223 if (p_WSAStartup(winsock_ver, &wsadata)) {
227 if (LOBYTE(wsadata.wVersion) != LOBYTE(winsock_ver)) {
231 #ifdef NET_SETUP_DIAGNOSTICS
234 sprintf(buf, "Using WinSock %d.%d", hi, lo);
246 winsock_module = LoadLibrary("WS2_32.DLL");
247 if (!winsock_module) {
248 winsock_module = LoadLibrary("WSOCK32.DLL");
251 fatalbox("Unable to load any WinSock library");
254 /* Check if we have getaddrinfo in Winsock */
255 if (GetProcAddress(winsock_module, "getaddrinfo") != NULL) {
256 #ifdef NET_SETUP_DIAGNOSTICS
257 logevent(NULL, "Native WinSock IPv6 support detected");
259 GET_WINSOCK_FUNCTION(winsock_module, getaddrinfo);
260 GET_WINSOCK_FUNCTION(winsock_module, freeaddrinfo);
261 GET_WINSOCK_FUNCTION(winsock_module, getnameinfo);
262 GET_WINSOCK_FUNCTION(winsock_module, gai_strerror);
264 /* Fall back to wship6.dll for Windows 2000 */
265 wship6_module = LoadLibrary("wship6.dll");
267 #ifdef NET_SETUP_DIAGNOSTICS
268 logevent(NULL, "WSH IPv6 support detected");
270 GET_WINSOCK_FUNCTION(wship6_module, getaddrinfo);
271 GET_WINSOCK_FUNCTION(wship6_module, freeaddrinfo);
272 GET_WINSOCK_FUNCTION(wship6_module, getnameinfo);
273 GET_WINSOCK_FUNCTION(wship6_module, gai_strerror);
275 #ifdef NET_SETUP_DIAGNOSTICS
276 logevent(NULL, "No IPv6 support detected");
280 GET_WINSOCK_FUNCTION(winsock2_module, WSAAddressToStringA);
282 #ifdef NET_SETUP_DIAGNOSTICS
283 logevent(NULL, "PuTTY was built without IPv6 support");
287 GET_WINSOCK_FUNCTION(winsock_module, WSAAsyncSelect);
288 GET_WINSOCK_FUNCTION(winsock_module, WSAEventSelect);
289 GET_WINSOCK_FUNCTION(winsock_module, select);
290 GET_WINSOCK_FUNCTION(winsock_module, WSAGetLastError);
291 GET_WINSOCK_FUNCTION(winsock_module, WSAEnumNetworkEvents);
292 GET_WINSOCK_FUNCTION(winsock_module, WSAStartup);
293 GET_WINSOCK_FUNCTION(winsock_module, WSACleanup);
294 GET_WINSOCK_FUNCTION(winsock_module, closesocket);
295 GET_WINSOCK_FUNCTION(winsock_module, ntohl);
296 GET_WINSOCK_FUNCTION(winsock_module, htonl);
297 GET_WINSOCK_FUNCTION(winsock_module, htons);
298 GET_WINSOCK_FUNCTION(winsock_module, ntohs);
299 GET_WINSOCK_FUNCTION(winsock_module, gethostname);
300 GET_WINSOCK_FUNCTION(winsock_module, gethostbyname);
301 GET_WINSOCK_FUNCTION(winsock_module, getservbyname);
302 GET_WINSOCK_FUNCTION(winsock_module, inet_addr);
303 GET_WINSOCK_FUNCTION(winsock_module, inet_ntoa);
304 GET_WINSOCK_FUNCTION(winsock_module, connect);
305 GET_WINSOCK_FUNCTION(winsock_module, bind);
306 GET_WINSOCK_FUNCTION(winsock_module, setsockopt);
307 GET_WINSOCK_FUNCTION(winsock_module, socket);
308 GET_WINSOCK_FUNCTION(winsock_module, listen);
309 GET_WINSOCK_FUNCTION(winsock_module, send);
310 GET_WINSOCK_FUNCTION(winsock_module, ioctlsocket);
311 GET_WINSOCK_FUNCTION(winsock_module, accept);
312 GET_WINSOCK_FUNCTION(winsock_module, recv);
313 GET_WINSOCK_FUNCTION(winsock_module, WSAIoctl);
315 /* Try to get the best WinSock version we can get */
316 if (!sk_startup(2,2) &&
319 fatalbox("Unable to initialise WinSock");
322 sktree = newtree234(cmpfortree);
325 void sk_cleanup(void)
331 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
341 FreeLibrary(winsock_module);
344 FreeLibrary(wship6_module);
348 char *winsock_error_string(int error)
352 return "Network error: Permission denied";
354 return "Network error: Address already in use";
355 case WSAEADDRNOTAVAIL:
356 return "Network error: Cannot assign requested address";
357 case WSAEAFNOSUPPORT:
359 "Network error: Address family not supported by protocol family";
361 return "Network error: Operation already in progress";
362 case WSAECONNABORTED:
363 return "Network error: Software caused connection abort";
364 case WSAECONNREFUSED:
365 return "Network error: Connection refused";
367 return "Network error: Connection reset by peer";
368 case WSAEDESTADDRREQ:
369 return "Network error: Destination address required";
371 return "Network error: Bad address";
373 return "Network error: Host is down";
374 case WSAEHOSTUNREACH:
375 return "Network error: No route to host";
377 return "Network error: Operation now in progress";
379 return "Network error: Interrupted function call";
381 return "Network error: Invalid argument";
383 return "Network error: Socket is already connected";
385 return "Network error: Too many open files";
387 return "Network error: Message too long";
389 return "Network error: Network is down";
391 return "Network error: Network dropped connection on reset";
393 return "Network error: Network is unreachable";
395 return "Network error: No buffer space available";
397 return "Network error: Bad protocol option";
399 return "Network error: Socket is not connected";
401 return "Network error: Socket operation on non-socket";
403 return "Network error: Operation not supported";
404 case WSAEPFNOSUPPORT:
405 return "Network error: Protocol family not supported";
407 return "Network error: Too many processes";
408 case WSAEPROTONOSUPPORT:
409 return "Network error: Protocol not supported";
411 return "Network error: Protocol wrong type for socket";
413 return "Network error: Cannot send after socket shutdown";
414 case WSAESOCKTNOSUPPORT:
415 return "Network error: Socket type not supported";
417 return "Network error: Connection timed out";
419 return "Network error: Resource temporarily unavailable";
421 return "Network error: Graceful shutdown in progress";
423 return "Unknown network error";
427 SockAddr sk_namelookup(const char *host, char **canonicalname,
430 SockAddr ret = snew(struct SockAddr_tag);
435 /* Default to IPv4. */
436 hint_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
438 address_family == ADDRTYPE_IPV6 ? AF_INET6 :
442 /* Clear the structure and default to IPv4. */
443 memset(ret, 0, sizeof(struct SockAddr_tag));
447 ret->addresses = NULL;
448 ret->resolved = FALSE;
452 if ((a = p_inet_addr(host)) == (unsigned long) INADDR_NONE) {
453 struct hostent *h = NULL;
457 * Use getaddrinfo when it's available
460 struct addrinfo hints;
461 #ifdef NET_SETUP_DIAGNOSTICS
462 logevent(NULL, "Using getaddrinfo() for resolving");
464 memset(&hints, 0, sizeof(hints));
465 hints.ai_family = hint_family;
466 hints.ai_flags = AI_CANONNAME;
467 if ((err = p_getaddrinfo(host, NULL, &hints, &ret->ais)) == 0)
468 ret->resolved = TRUE;
472 #ifdef NET_SETUP_DIAGNOSTICS
473 logevent(NULL, "Using gethostbyname() for resolving");
476 * Otherwise use the IPv4-only gethostbyname...
477 * (NOTE: we don't use gethostbyname as a fallback!)
479 if ( (h = p_gethostbyname(host)) )
480 ret->resolved = TRUE;
482 err = p_WSAGetLastError();
485 if (!ret->resolved) {
486 ret->error = (err == WSAENETDOWN ? "Network is down" :
487 err == WSAHOST_NOT_FOUND ? "Host does not exist" :
488 err == WSATRY_AGAIN ? "Host not found" :
490 p_getaddrinfo&&p_gai_strerror ? p_gai_strerror(err) :
492 "gethostbyname: unknown error");
497 /* If we got an address info use that... */
499 /* Are we in IPv4 fallback mode? */
500 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
501 if (ret->ais->ai_family == AF_INET)
503 (char *) &((SOCKADDR_IN *) ret->ais->
504 ai_addr)->sin_addr, sizeof(a));
506 if (ret->ais->ai_canonname)
507 strncpy(realhost, ret->ais->ai_canonname, lenof(realhost));
509 strncpy(realhost, host, lenof(realhost));
511 /* We used the IPv4-only gethostbyname()... */
516 for (n = 0; h->h_addr_list[n]; n++);
517 ret->addresses = snewn(n, unsigned long);
519 for (n = 0; n < ret->naddresses; n++) {
520 memcpy(&a, h->h_addr_list[n], sizeof(a));
521 ret->addresses[n] = p_ntohl(a);
523 memcpy(&a, h->h_addr, sizeof(a));
524 /* This way we are always sure the h->h_name is valid :) */
525 strncpy(realhost, h->h_name, sizeof(realhost));
530 * This must be a numeric IPv4 address because it caused a
531 * success return from inet_addr.
533 ret->addresses = snewn(1, unsigned long);
535 ret->addresses[0] = p_ntohl(a);
536 ret->resolved = TRUE;
537 strncpy(realhost, host, sizeof(realhost));
539 realhost[lenof(realhost)-1] = '\0';
540 *canonicalname = snewn(1+strlen(realhost), char);
541 strcpy(*canonicalname, realhost);
545 SockAddr sk_nonamelookup(const char *host)
547 SockAddr ret = snew(struct SockAddr_tag);
549 ret->resolved = FALSE;
553 ret->addresses = NULL;
556 strncpy(ret->hostname, host, lenof(ret->hostname));
557 ret->hostname[lenof(ret->hostname)-1] = '\0';
561 int sk_nextaddr(SockAddr addr, SockAddrStep *step)
565 if (step->ai->ai_next) {
566 step->ai = step->ai->ai_next;
572 if (step->curraddr+1 < addr->naddresses) {
580 void sk_getaddr(SockAddr addr, char *buf, int buflen)
583 START_STEP(addr, step);
588 if (p_WSAAddressToStringA) {
589 DWORD dwbuflen = buflen;
590 err = p_WSAAddressToStringA(step.ai->ai_addr, step.ai->ai_addrlen,
591 NULL, buf, &dwbuflen);
595 strncpy(buf, addr->hostname, buflen);
597 strncpy(buf, "<unknown>", buflen);
598 buf[buflen-1] = '\0';
602 if (SOCKADDR_FAMILY(addr, step) == AF_INET) {
604 assert(addr->addresses && step.curraddr < addr->naddresses);
605 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
606 strncpy(buf, p_inet_ntoa(a), buflen);
607 buf[buflen-1] = '\0';
609 strncpy(buf, addr->hostname, buflen);
610 buf[buflen-1] = '\0';
614 int sk_hostname_is_local(char *name)
616 return !strcmp(name, "localhost") ||
617 !strcmp(name, "::1") ||
618 !strncmp(name, "127.", 4);
621 static INTERFACE_INFO local_interfaces[16];
622 static int n_local_interfaces; /* 0=not yet, -1=failed, >0=number */
624 static int ipv4_is_local_addr(struct in_addr addr)
626 if (ipv4_is_loopback(addr))
627 return 1; /* loopback addresses are local */
628 if (!n_local_interfaces) {
629 SOCKET s = p_socket(AF_INET, SOCK_DGRAM, 0);
633 p_WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0,
634 local_interfaces, sizeof(local_interfaces),
635 &retbytes, NULL, NULL) == 0)
636 n_local_interfaces = retbytes / sizeof(INTERFACE_INFO);
638 logevent(NULL, "Unable to get list of local IP addresses");
640 if (n_local_interfaces > 0) {
642 for (i = 0; i < n_local_interfaces; i++) {
643 SOCKADDR_IN *address =
644 (SOCKADDR_IN *)&local_interfaces[i].iiAddress;
645 if (address->sin_addr.s_addr == addr.s_addr)
646 return 1; /* this address is local */
649 return 0; /* this address is not local */
652 int sk_address_is_local(SockAddr addr)
656 START_STEP(addr, step);
657 family = SOCKADDR_FAMILY(addr, step);
660 if (family == AF_INET6) {
661 return IN6_IS_ADDR_LOOPBACK((const struct in6_addr *)step.ai->ai_addr);
664 if (family == AF_INET) {
667 return ipv4_is_local_addr(((struct sockaddr_in *)step.ai->ai_addr)
673 assert(addr->addresses && step.curraddr < addr->naddresses);
674 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
675 return ipv4_is_local_addr(a);
678 assert(family == AF_UNSPEC);
679 return 0; /* we don't know; assume not */
683 int sk_addrtype(SockAddr addr)
687 START_STEP(addr, step);
688 family = SOCKADDR_FAMILY(addr, step);
690 return (family == AF_INET ? ADDRTYPE_IPV4 :
692 family == AF_INET6 ? ADDRTYPE_IPV6 :
697 void sk_addrcopy(SockAddr addr, char *buf)
701 START_STEP(addr, step);
702 family = SOCKADDR_FAMILY(addr, step);
704 assert(family != AF_UNSPEC);
707 if (family == AF_INET)
708 memcpy(buf, &((struct sockaddr_in *)step.ai->ai_addr)->sin_addr,
709 sizeof(struct in_addr));
710 else if (family == AF_INET6)
711 memcpy(buf, &((struct sockaddr_in6 *)step.ai->ai_addr)->sin6_addr,
712 sizeof(struct in6_addr));
717 if (family == AF_INET) {
719 assert(addr->addresses && step.curraddr < addr->naddresses);
720 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
721 memcpy(buf, (char*) &a.s_addr, 4);
725 void sk_addr_free(SockAddr addr)
727 if (--addr->refcount > 0)
730 if (addr->ais && p_freeaddrinfo)
731 p_freeaddrinfo(addr->ais);
734 sfree(addr->addresses);
738 SockAddr sk_addr_dup(SockAddr addr)
744 static Plug sk_tcp_plug(Socket sock, Plug p)
746 Actual_Socket s = (Actual_Socket) sock;
753 static void sk_tcp_flush(Socket s)
756 * We send data to the socket as soon as we can anyway,
757 * so we don't need to do anything here. :-)
761 static void sk_tcp_close(Socket s);
762 static int sk_tcp_write(Socket s, const char *data, int len);
763 static int sk_tcp_write_oob(Socket s, const char *data, int len);
764 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
765 static void *sk_tcp_get_private_ptr(Socket s);
766 static void sk_tcp_set_frozen(Socket s, int is_frozen);
767 static const char *sk_tcp_socket_error(Socket s);
769 extern char *do_select(SOCKET skt, int startup);
771 Socket sk_register(void *sock, Plug plug)
773 static const struct socket_function_table fn_table = {
779 sk_tcp_set_private_ptr,
780 sk_tcp_get_private_ptr,
790 * Create Socket structure.
792 ret = snew(struct Socket_tag);
796 bufchain_init(&ret->output_data);
797 ret->writable = 1; /* to start with */
798 ret->sending_oob = 0;
800 ret->frozen_readable = 0;
801 ret->localhost_only = 0; /* unused, but best init anyway */
802 ret->pending_error = 0;
803 ret->parent = ret->child = NULL;
806 ret->s = (SOCKET)sock;
808 if (ret->s == INVALID_SOCKET) {
809 err = p_WSAGetLastError();
810 ret->error = winsock_error_string(err);
816 /* Set up a select mechanism. This could be an AsyncSelect on a
817 * window, or an EventSelect on an event object. */
818 errstr = do_select(ret->s, 1);
829 static DWORD try_connect(Actual_Socket sock)
841 if (sock->s != INVALID_SOCKET) {
842 do_select(sock->s, 0);
843 p_closesocket(sock->s);
846 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
851 family = SOCKADDR_FAMILY(sock->addr, sock->step);
854 * Remove the socket from the tree before we overwrite its
855 * internal socket id, because that forms part of the tree's
856 * sorting criterion. We'll add it back before exiting this
857 * function, whether we changed anything or not.
859 del234(sktree, sock);
861 s = p_socket(family, SOCK_STREAM, 0);
864 if (s == INVALID_SOCKET) {
865 err = p_WSAGetLastError();
866 sock->error = winsock_error_string(err);
870 if (sock->oobinline) {
872 p_setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
877 p_setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
880 if (sock->keepalive) {
882 p_setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
886 * Bind to local address.
889 localport = 1023; /* count from 1023 downwards */
891 localport = 0; /* just use port 0 (ie winsock picks) */
893 /* Loop round trying to bind */
898 if (family == AF_INET6) {
899 memset(&a6, 0, sizeof(a6));
900 a6.sin6_family = AF_INET6;
901 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
902 a6.sin6_port = p_htons(localport);
906 a.sin_family = AF_INET;
907 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
908 a.sin_port = p_htons(localport);
911 sockcode = p_bind(s, (family == AF_INET6 ?
912 (struct sockaddr *) &a6 :
913 (struct sockaddr *) &a),
914 (family == AF_INET6 ? sizeof(a6) : sizeof(a)));
916 sockcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
918 if (sockcode != SOCKET_ERROR) {
922 err = p_WSAGetLastError();
923 if (err != WSAEADDRINUSE) /* failed, for a bad reason */
928 break; /* we're only looping once */
931 break; /* we might have got to the end */
935 sock->error = winsock_error_string(err);
940 * Connect to remote address.
944 if (family == AF_INET6) {
945 a6.sin6_family = AF_INET6;
946 a6.sin6_port = p_htons((short) sock->port);
948 ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_addr;
949 a6.sin6_flowinfo = ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_flowinfo;
950 a6.sin6_scope_id = ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_scope_id;
952 a.sin_family = AF_INET;
954 ((struct sockaddr_in *) sock->step.ai->ai_addr)->sin_addr;
955 a.sin_port = p_htons((short) sock->port);
960 assert(sock->addr->addresses && sock->step.curraddr < sock->addr->naddresses);
961 a.sin_family = AF_INET;
962 a.sin_addr.s_addr = p_htonl(sock->addr->addresses[sock->step.curraddr]);
963 a.sin_port = p_htons((short) sock->port);
966 /* Set up a select mechanism. This could be an AsyncSelect on a
967 * window, or an EventSelect on an event object. */
968 errstr = do_select(s, 1);
970 sock->error = errstr;
978 ((family == AF_INET6) ? (struct sockaddr *) &a6 :
979 (struct sockaddr *) &a),
980 (family == AF_INET6) ? sizeof(a6) : sizeof(a))
982 p_connect(s, (struct sockaddr *) &a, sizeof(a))
985 err = p_WSAGetLastError();
987 * We expect a potential EWOULDBLOCK here, because the
988 * chances are the front end has done a select for
989 * FD_CONNECT, so that connect() will complete
992 if ( err != WSAEWOULDBLOCK ) {
993 sock->error = winsock_error_string(err);
998 * If we _don't_ get EWOULDBLOCK, the connect has completed
999 * and we should set the socket as writable.
1009 * No matter what happened, put the socket back in the tree.
1011 add234(sktree, sock);
1014 plug_log(sock->plug, 1, sock->addr, sock->port, sock->error, err);
1018 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
1019 int nodelay, int keepalive, Plug plug)
1021 static const struct socket_function_table fn_table = {
1027 sk_tcp_set_private_ptr,
1028 sk_tcp_get_private_ptr,
1037 * Create Socket structure.
1039 ret = snew(struct Socket_tag);
1040 ret->fn = &fn_table;
1043 bufchain_init(&ret->output_data);
1044 ret->connected = 0; /* to start with */
1045 ret->writable = 0; /* to start with */
1046 ret->sending_oob = 0;
1048 ret->frozen_readable = 0;
1049 ret->localhost_only = 0; /* unused, but best init anyway */
1050 ret->pending_error = 0;
1051 ret->parent = ret->child = NULL;
1052 ret->oobinline = oobinline;
1053 ret->nodelay = nodelay;
1054 ret->keepalive = keepalive;
1055 ret->privport = privport;
1058 START_STEP(ret->addr, ret->step);
1059 ret->s = INVALID_SOCKET;
1063 err = try_connect(ret);
1064 } while (err && sk_nextaddr(ret->addr, &ret->step));
1066 return (Socket) ret;
1069 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only,
1070 int orig_address_family)
1072 static const struct socket_function_table fn_table = {
1078 sk_tcp_set_private_ptr,
1079 sk_tcp_get_private_ptr,
1099 * Create Socket structure.
1101 ret = snew(struct Socket_tag);
1102 ret->fn = &fn_table;
1105 bufchain_init(&ret->output_data);
1106 ret->writable = 0; /* to start with */
1107 ret->sending_oob = 0;
1109 ret->frozen_readable = 0;
1110 ret->localhost_only = local_host_only;
1111 ret->pending_error = 0;
1112 ret->parent = ret->child = NULL;
1116 * Translate address_family from platform-independent constants
1117 * into local reality.
1119 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
1121 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
1126 * Our default, if passed the `don't care' value
1127 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1128 * we will also set up a second socket listening on IPv6, but
1129 * the v4 one is primary since that ought to work even on
1130 * non-v6-supporting systems.
1132 if (address_family == AF_UNSPEC) address_family = AF_INET;
1137 s = p_socket(address_family, SOCK_STREAM, 0);
1140 if (s == INVALID_SOCKET) {
1141 err = p_WSAGetLastError();
1142 ret->error = winsock_error_string(err);
1143 return (Socket) ret;
1148 p_setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
1151 if (address_family == AF_INET6) {
1152 memset(&a6, 0, sizeof(a6));
1153 a6.sin6_family = AF_INET6;
1154 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1155 * know how to do it. :-)
1156 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1157 * Thus we need either a parser that understands [2001:db8::1]:80
1158 * style addresses and/or enhance this to understand hostnames too. */
1159 if (local_host_only)
1160 a6.sin6_addr = in6addr_loopback;
1162 a6.sin6_addr = in6addr_any;
1163 a6.sin6_port = p_htons(port);
1168 a.sin_family = AF_INET;
1171 * Bind to source address. First try an explicitly
1175 a.sin_addr.s_addr = p_inet_addr(srcaddr);
1176 if (a.sin_addr.s_addr != INADDR_NONE) {
1177 /* Override localhost_only with specified listen addr. */
1178 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
1184 * ... and failing that, go with one of the standard ones.
1187 if (local_host_only)
1188 a.sin_addr.s_addr = p_htonl(INADDR_LOOPBACK);
1190 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
1193 a.sin_port = p_htons((short)port);
1196 retcode = p_bind(s, (address_family == AF_INET6 ?
1197 (struct sockaddr *) &a6 :
1198 (struct sockaddr *) &a),
1200 AF_INET6 ? sizeof(a6) : sizeof(a)));
1202 retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
1204 if (retcode != SOCKET_ERROR) {
1207 err = p_WSAGetLastError();
1212 ret->error = winsock_error_string(err);
1213 return (Socket) ret;
1217 if (p_listen(s, SOMAXCONN) == SOCKET_ERROR) {
1219 ret->error = winsock_error_string(err);
1220 return (Socket) ret;
1223 /* Set up a select mechanism. This could be an AsyncSelect on a
1224 * window, or an EventSelect on an event object. */
1225 errstr = do_select(s, 1);
1228 ret->error = errstr;
1229 return (Socket) ret;
1232 add234(sktree, ret);
1236 * If we were given ADDRTYPE_UNSPEC, we must also create an
1237 * IPv6 listening socket and link it to this one.
1239 if (address_family == AF_INET && orig_address_family == ADDRTYPE_UNSPEC) {
1240 Actual_Socket other;
1242 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
1243 local_host_only, ADDRTYPE_IPV6);
1246 if (!other->error) {
1247 other->parent = ret;
1256 return (Socket) ret;
1259 static void sk_tcp_close(Socket sock)
1261 extern char *do_select(SOCKET skt, int startup);
1262 Actual_Socket s = (Actual_Socket) sock;
1265 sk_tcp_close((Socket)s->child);
1269 p_closesocket(s->s);
1271 sk_addr_free(s->addr);
1276 * The function which tries to send on a socket once it's deemed
1279 void try_send(Actual_Socket s)
1281 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1285 int len, urgentflag;
1287 if (s->sending_oob) {
1288 urgentflag = MSG_OOB;
1289 len = s->sending_oob;
1293 bufchain_prefix(&s->output_data, &data, &len);
1295 nsent = p_send(s->s, data, len, urgentflag);
1296 noise_ultralight(nsent);
1298 err = (nsent < 0 ? p_WSAGetLastError() : 0);
1299 if ((err < WSABASEERR && nsent < 0) || err == WSAEWOULDBLOCK) {
1301 * Perfectly normal: we've sent all we can for the moment.
1303 * (Some WinSock send() implementations can return
1304 * <0 but leave no sensible error indication -
1305 * WSAGetLastError() is called but returns zero or
1306 * a small number - so we check that case and treat
1307 * it just like WSAEWOULDBLOCK.)
1309 s->writable = FALSE;
1311 } else if (nsent == 0 ||
1312 err == WSAECONNABORTED || err == WSAECONNRESET) {
1314 * If send() returns CONNABORTED or CONNRESET, we
1315 * unfortunately can't just call plug_closing(),
1316 * because it's quite likely that we're currently
1317 * _in_ a call from the code we'd be calling back
1318 * to, so we'd have to make half the SSH code
1319 * reentrant. Instead we flag a pending error on
1320 * the socket, to be dealt with (by calling
1321 * plug_closing()) at some suitable future moment.
1323 s->pending_error = err;
1326 /* We're inside the Windows frontend here, so we know
1327 * that the frontend handle is unnecessary. */
1328 logevent(NULL, winsock_error_string(err));
1329 fatalbox("%s", winsock_error_string(err));
1332 if (s->sending_oob) {
1334 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1335 s->sending_oob = len - nsent;
1340 bufchain_consume(&s->output_data, nsent);
1346 static int sk_tcp_write(Socket sock, const char *buf, int len)
1348 Actual_Socket s = (Actual_Socket) sock;
1351 * Add the data to the buffer list on the socket.
1353 bufchain_add(&s->output_data, buf, len);
1356 * Now try sending from the start of the buffer list.
1361 return bufchain_size(&s->output_data);
1364 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1366 Actual_Socket s = (Actual_Socket) sock;
1369 * Replace the buffer list on the socket with the data.
1371 bufchain_clear(&s->output_data);
1372 assert(len <= sizeof(s->oobdata));
1373 memcpy(s->oobdata, buf, len);
1374 s->sending_oob = len;
1377 * Now try sending from the start of the buffer list.
1382 return s->sending_oob;
1385 int select_result(WPARAM wParam, LPARAM lParam)
1389 char buf[20480]; /* nice big buffer for plenty of speed */
1393 /* wParam is the socket itself */
1396 return 1; /* boggle */
1398 s = find234(sktree, (void *) wParam, cmpforsearch);
1400 return 1; /* boggle */
1402 if ((err = WSAGETSELECTERROR(lParam)) != 0) {
1404 * An error has occurred on this socket. Pass it to the
1408 plug_log(s->plug, 1, s->addr, s->port,
1409 winsock_error_string(err), err);
1410 while (s->addr && sk_nextaddr(s->addr, &s->step)) {
1411 err = try_connect(s);
1415 return plug_closing(s->plug, winsock_error_string(err), err, 0);
1420 noise_ultralight(lParam);
1422 switch (WSAGETSELECTEVENT(lParam)) {
1424 s->connected = s->writable = 1;
1426 * Once a socket is connected, we can stop falling
1427 * back through the candidate addresses to connect
1431 sk_addr_free(s->addr);
1436 /* In the case the socket is still frozen, we don't even bother */
1438 s->frozen_readable = 1;
1443 * We have received data on the socket. For an oobinline
1444 * socket, this might be data _before_ an urgent pointer,
1445 * in which case we send it to the back end with type==1
1446 * (data prior to urgent).
1450 p_ioctlsocket(s->s, SIOCATMARK, &atmark);
1452 * Avoid checking the return value from ioctlsocket(),
1453 * on the grounds that some WinSock wrappers don't
1454 * support it. If it does nothing, we get atmark==1,
1455 * which is equivalent to `no OOB pending', so the
1456 * effect will be to non-OOB-ify any OOB data.
1461 ret = p_recv(s->s, buf, sizeof(buf), 0);
1462 noise_ultralight(ret);
1464 err = p_WSAGetLastError();
1465 if (err == WSAEWOULDBLOCK) {
1470 return plug_closing(s->plug, winsock_error_string(err), err,
1472 } else if (0 == ret) {
1473 return plug_closing(s->plug, NULL, 0, 0);
1475 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1480 * This will only happen on a non-oobinline socket. It
1481 * indicates that we can immediately perform an OOB read
1482 * and get back OOB data, which we will send to the back
1483 * end with type==2 (urgent data).
1485 ret = p_recv(s->s, buf, sizeof(buf), MSG_OOB);
1486 noise_ultralight(ret);
1488 char *str = (ret == 0 ? "Internal networking trouble" :
1489 winsock_error_string(p_WSAGetLastError()));
1490 /* We're inside the Windows frontend here, so we know
1491 * that the frontend handle is unnecessary. */
1492 logevent(NULL, str);
1493 fatalbox("%s", str);
1495 return plug_receive(s->plug, 2, buf, ret);
1500 int bufsize_before, bufsize_after;
1502 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1504 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1505 if (bufsize_after < bufsize_before)
1506 plug_sent(s->plug, bufsize_after);
1510 /* Signal a close on the socket. First read any outstanding data. */
1513 ret = p_recv(s->s, buf, sizeof(buf), 0);
1515 err = p_WSAGetLastError();
1516 if (err == WSAEWOULDBLOCK)
1518 return plug_closing(s->plug, winsock_error_string(err),
1522 open &= plug_receive(s->plug, 0, buf, ret);
1524 open &= plug_closing(s->plug, NULL, 0, 0);
1531 struct sockaddr_in isa;
1533 struct sockaddr_storage isa;
1535 int addrlen = sizeof(isa);
1536 SOCKET t; /* socket of connection */
1538 memset(&isa, 0, sizeof(isa));
1540 t = p_accept(s->s,(struct sockaddr *)&isa,&addrlen);
1541 if (t == INVALID_SOCKET)
1543 err = p_WSAGetLastError();
1544 if (err == WSATRY_AGAIN)
1548 if (isa.ss_family == AF_INET &&
1549 s->localhost_only &&
1550 !ipv4_is_local_addr(((struct sockaddr_in *)&isa)->sin_addr))
1552 if (s->localhost_only && !ipv4_is_local_addr(isa.sin_addr))
1555 p_closesocket(t); /* dodgy WinSock let nonlocal through */
1556 } else if (plug_accepting(s->plug, (void*)t)) {
1557 p_closesocket(t); /* denied or error */
1566 * Deal with socket errors detected in try_send().
1568 void net_pending_errors(void)
1574 * This might be a fiddly business, because it's just possible
1575 * that handling a pending error on one socket might cause
1576 * others to be closed. (I can't think of any reason this might
1577 * happen in current SSH implementation, but to maintain
1578 * generality of this network layer I'll assume the worst.)
1580 * So what we'll do is search the socket list for _one_ socket
1581 * with a pending error, and then handle it, and then search
1582 * the list again _from the beginning_. Repeat until we make a
1583 * pass with no socket errors present. That way we are
1584 * protected against the socket list changing under our feet.
1588 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1589 if (s->pending_error) {
1591 * An error has occurred on this socket. Pass it to the
1594 plug_closing(s->plug,
1595 winsock_error_string(s->pending_error),
1596 s->pending_error, 0);
1604 * Each socket abstraction contains a `void *' private field in
1605 * which the client can keep state.
1607 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1609 Actual_Socket s = (Actual_Socket) sock;
1610 s->private_ptr = ptr;
1613 static void *sk_tcp_get_private_ptr(Socket sock)
1615 Actual_Socket s = (Actual_Socket) sock;
1616 return s->private_ptr;
1620 * Special error values are returned from sk_namelookup and sk_new
1621 * if there's a problem. These functions extract an error message,
1622 * or return NULL if there's no problem.
1624 const char *sk_addr_error(SockAddr addr)
1628 static const char *sk_tcp_socket_error(Socket sock)
1630 Actual_Socket s = (Actual_Socket) sock;
1634 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1636 Actual_Socket s = (Actual_Socket) sock;
1637 if (s->frozen == is_frozen)
1639 s->frozen = is_frozen;
1642 if (s->frozen_readable) {
1644 p_recv(s->s, &c, 1, MSG_PEEK);
1647 s->frozen_readable = 0;
1650 void socket_reselect_all(void)
1655 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1662 * For Plink: enumerate all sockets currently active.
1664 SOCKET first_socket(int *state)
1668 s = index234(sktree, (*state)++);
1669 return s ? s->s : INVALID_SOCKET;
1672 SOCKET next_socket(int *state)
1674 Actual_Socket s = index234(sktree, (*state)++);
1675 return s ? s->s : INVALID_SOCKET;
1678 extern int socket_writable(SOCKET skt)
1680 Actual_Socket s = find234(sktree, (void *)skt, cmpforsearch);
1683 return bufchain_size(&s->output_data) > 0;
1688 int net_service_lookup(char *service)
1691 se = p_getservbyname(service, NULL);
1693 return p_ntohs(se->s_port);
1698 char *get_hostname(void)
1701 char *hostname = NULL;
1704 hostname = sresize(hostname, len, char);
1705 if (p_gethostname(hostname, len) < 0) {
1710 } while (strlen(hostname) >= len-1);
1714 SockAddr platform_get_x11_unix_address(const char *display, int displaynum,
1715 char **canonicalname)
1717 SockAddr ret = snew(struct SockAddr_tag);
1718 memset(ret, 0, sizeof(struct SockAddr_tag));
1719 ret->error = "unix sockets not supported on this platform";