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);
335 char *winsock_error_string(int error)
339 return "Network error: Permission denied";
341 return "Network error: Address already in use";
342 case WSAEADDRNOTAVAIL:
343 return "Network error: Cannot assign requested address";
344 case WSAEAFNOSUPPORT:
346 "Network error: Address family not supported by protocol family";
348 return "Network error: Operation already in progress";
349 case WSAECONNABORTED:
350 return "Network error: Software caused connection abort";
351 case WSAECONNREFUSED:
352 return "Network error: Connection refused";
354 return "Network error: Connection reset by peer";
355 case WSAEDESTADDRREQ:
356 return "Network error: Destination address required";
358 return "Network error: Bad address";
360 return "Network error: Host is down";
361 case WSAEHOSTUNREACH:
362 return "Network error: No route to host";
364 return "Network error: Operation now in progress";
366 return "Network error: Interrupted function call";
368 return "Network error: Invalid argument";
370 return "Network error: Socket is already connected";
372 return "Network error: Too many open files";
374 return "Network error: Message too long";
376 return "Network error: Network is down";
378 return "Network error: Network dropped connection on reset";
380 return "Network error: Network is unreachable";
382 return "Network error: No buffer space available";
384 return "Network error: Bad protocol option";
386 return "Network error: Socket is not connected";
388 return "Network error: Socket operation on non-socket";
390 return "Network error: Operation not supported";
391 case WSAEPFNOSUPPORT:
392 return "Network error: Protocol family not supported";
394 return "Network error: Too many processes";
395 case WSAEPROTONOSUPPORT:
396 return "Network error: Protocol not supported";
398 return "Network error: Protocol wrong type for socket";
400 return "Network error: Cannot send after socket shutdown";
401 case WSAESOCKTNOSUPPORT:
402 return "Network error: Socket type not supported";
404 return "Network error: Connection timed out";
406 return "Network error: Resource temporarily unavailable";
408 return "Network error: Graceful shutdown in progress";
410 return "Unknown network error";
414 SockAddr sk_namelookup(const char *host, char **canonicalname,
417 SockAddr ret = snew(struct SockAddr_tag);
422 /* Default to IPv4. */
423 hint_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
425 address_family == ADDRTYPE_IPV6 ? AF_INET6 :
429 /* Clear the structure and default to IPv4. */
430 memset(ret, 0, sizeof(struct SockAddr_tag));
434 ret->addresses = NULL;
435 ret->resolved = FALSE;
439 if ((a = p_inet_addr(host)) == (unsigned long) INADDR_NONE) {
440 struct hostent *h = NULL;
444 * Use getaddrinfo when it's available
447 struct addrinfo hints;
448 #ifdef NET_SETUP_DIAGNOSTICS
449 logevent(NULL, "Using getaddrinfo() for resolving");
451 memset(&hints, 0, sizeof(hints));
452 hints.ai_family = hint_family;
453 hints.ai_flags = AI_CANONNAME;
454 if ((err = p_getaddrinfo(host, NULL, &hints, &ret->ais)) == 0)
455 ret->resolved = TRUE;
459 #ifdef NET_SETUP_DIAGNOSTICS
460 logevent(NULL, "Using gethostbyname() for resolving");
463 * Otherwise use the IPv4-only gethostbyname...
464 * (NOTE: we don't use gethostbyname as a fallback!)
466 if ( (h = p_gethostbyname(host)) )
467 ret->resolved = TRUE;
469 err = p_WSAGetLastError();
472 if (!ret->resolved) {
473 ret->error = (err == WSAENETDOWN ? "Network is down" :
474 err == WSAHOST_NOT_FOUND ? "Host does not exist" :
475 err == WSATRY_AGAIN ? "Host not found" :
477 p_getaddrinfo&&p_gai_strerror ? p_gai_strerror(err) :
479 "gethostbyname: unknown error");
484 /* If we got an address info use that... */
486 /* Are we in IPv4 fallback mode? */
487 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
488 if (ret->ais->ai_family == AF_INET)
490 (char *) &((SOCKADDR_IN *) ret->ais->
491 ai_addr)->sin_addr, sizeof(a));
493 if (ret->ais->ai_canonname)
494 strncpy(realhost, ret->ais->ai_canonname, lenof(realhost));
496 strncpy(realhost, host, lenof(realhost));
498 /* We used the IPv4-only gethostbyname()... */
503 for (n = 0; h->h_addr_list[n]; n++);
504 ret->addresses = snewn(n, unsigned long);
506 for (n = 0; n < ret->naddresses; n++) {
507 memcpy(&a, h->h_addr_list[n], sizeof(a));
508 ret->addresses[n] = p_ntohl(a);
510 memcpy(&a, h->h_addr, sizeof(a));
511 /* This way we are always sure the h->h_name is valid :) */
512 strncpy(realhost, h->h_name, sizeof(realhost));
517 * This must be a numeric IPv4 address because it caused a
518 * success return from inet_addr.
520 ret->addresses = snewn(1, unsigned long);
522 ret->addresses[0] = p_ntohl(a);
523 ret->resolved = TRUE;
524 strncpy(realhost, host, sizeof(realhost));
526 realhost[lenof(realhost)-1] = '\0';
527 *canonicalname = snewn(1+strlen(realhost), char);
528 strcpy(*canonicalname, realhost);
532 SockAddr sk_nonamelookup(const char *host)
534 SockAddr ret = snew(struct SockAddr_tag);
536 ret->resolved = FALSE;
540 ret->addresses = NULL;
543 strncpy(ret->hostname, host, lenof(ret->hostname));
544 ret->hostname[lenof(ret->hostname)-1] = '\0';
548 int sk_nextaddr(SockAddr addr, SockAddrStep *step)
552 if (step->ai->ai_next) {
553 step->ai = step->ai->ai_next;
559 if (step->curraddr+1 < addr->naddresses) {
567 void sk_getaddr(SockAddr addr, char *buf, int buflen)
570 START_STEP(addr, step);
575 if (p_WSAAddressToStringA) {
576 DWORD dwbuflen = buflen;
577 err = p_WSAAddressToStringA(step.ai->ai_addr, step.ai->ai_addrlen,
578 NULL, buf, &dwbuflen);
582 strncpy(buf, addr->hostname, buflen);
584 strncpy(buf, "<unknown>", buflen);
585 buf[buflen-1] = '\0';
589 if (SOCKADDR_FAMILY(addr, step) == AF_INET) {
591 assert(addr->addresses && step.curraddr < addr->naddresses);
592 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
593 strncpy(buf, p_inet_ntoa(a), buflen);
594 buf[buflen-1] = '\0';
596 strncpy(buf, addr->hostname, buflen);
597 buf[buflen-1] = '\0';
601 int sk_hostname_is_local(char *name)
603 return !strcmp(name, "localhost") ||
604 !strcmp(name, "::1") ||
605 !strncmp(name, "127.", 4);
608 static INTERFACE_INFO local_interfaces[16];
609 static int n_local_interfaces; /* 0=not yet, -1=failed, >0=number */
611 static int ipv4_is_local_addr(struct in_addr addr)
613 if (ipv4_is_loopback(addr))
614 return 1; /* loopback addresses are local */
615 if (!n_local_interfaces) {
616 SOCKET s = p_socket(AF_INET, SOCK_DGRAM, 0);
620 p_WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0,
621 local_interfaces, sizeof(local_interfaces),
622 &retbytes, NULL, NULL) == 0)
623 n_local_interfaces = retbytes / sizeof(INTERFACE_INFO);
625 logevent(NULL, "Unable to get list of local IP addresses");
627 if (n_local_interfaces > 0) {
629 for (i = 0; i < n_local_interfaces; i++) {
630 SOCKADDR_IN *address =
631 (SOCKADDR_IN *)&local_interfaces[i].iiAddress;
632 if (address->sin_addr.s_addr == addr.s_addr)
633 return 1; /* this address is local */
636 return 0; /* this address is not local */
639 int sk_address_is_local(SockAddr addr)
643 START_STEP(addr, step);
644 family = SOCKADDR_FAMILY(addr, step);
647 if (family == AF_INET6) {
648 return IN6_IS_ADDR_LOOPBACK((const struct in6_addr *)step.ai->ai_addr);
651 if (family == AF_INET) {
654 return ipv4_is_local_addr(((struct sockaddr_in *)step.ai->ai_addr)
660 assert(addr->addresses && step.curraddr < addr->naddresses);
661 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
662 return ipv4_is_local_addr(a);
665 assert(family == AF_UNSPEC);
666 return 0; /* we don't know; assume not */
670 int sk_addrtype(SockAddr addr)
674 START_STEP(addr, step);
675 family = SOCKADDR_FAMILY(addr, step);
677 return (family == AF_INET ? ADDRTYPE_IPV4 :
679 family == AF_INET6 ? ADDRTYPE_IPV6 :
684 void sk_addrcopy(SockAddr addr, char *buf)
688 START_STEP(addr, step);
689 family = SOCKADDR_FAMILY(addr, step);
691 assert(family != AF_UNSPEC);
694 if (family == AF_INET)
695 memcpy(buf, &((struct sockaddr_in *)step.ai->ai_addr)->sin_addr,
696 sizeof(struct in_addr));
697 else if (family == AF_INET6)
698 memcpy(buf, &((struct sockaddr_in6 *)step.ai->ai_addr)->sin6_addr,
699 sizeof(struct in6_addr));
704 if (family == AF_INET) {
706 assert(addr->addresses && step.curraddr < addr->naddresses);
707 a.s_addr = p_htonl(addr->addresses[step.curraddr]);
708 memcpy(buf, (char*) &a.s_addr, 4);
712 void sk_addr_free(SockAddr addr)
714 if (--addr->refcount > 0)
717 if (addr->ais && p_freeaddrinfo)
718 p_freeaddrinfo(addr->ais);
721 sfree(addr->addresses);
725 SockAddr sk_addr_dup(SockAddr addr)
731 static Plug sk_tcp_plug(Socket sock, Plug p)
733 Actual_Socket s = (Actual_Socket) sock;
740 static void sk_tcp_flush(Socket s)
743 * We send data to the socket as soon as we can anyway,
744 * so we don't need to do anything here. :-)
748 static void sk_tcp_close(Socket s);
749 static int sk_tcp_write(Socket s, const char *data, int len);
750 static int sk_tcp_write_oob(Socket s, const char *data, int len);
751 static void sk_tcp_write_eof(Socket s);
752 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
753 static void *sk_tcp_get_private_ptr(Socket s);
754 static void sk_tcp_set_frozen(Socket s, int is_frozen);
755 static const char *sk_tcp_socket_error(Socket s);
757 extern char *do_select(SOCKET skt, int startup);
759 Socket sk_register(void *sock, Plug plug)
761 static const struct socket_function_table fn_table = {
768 sk_tcp_set_private_ptr,
769 sk_tcp_get_private_ptr,
779 * Create Socket structure.
781 ret = snew(struct Socket_tag);
785 bufchain_init(&ret->output_data);
786 ret->writable = 1; /* to start with */
787 ret->sending_oob = 0;
788 ret->outgoingeof = EOF_NO;
790 ret->frozen_readable = 0;
791 ret->localhost_only = 0; /* unused, but best init anyway */
792 ret->pending_error = 0;
793 ret->parent = ret->child = NULL;
796 ret->s = (SOCKET)sock;
798 if (ret->s == INVALID_SOCKET) {
799 err = p_WSAGetLastError();
800 ret->error = winsock_error_string(err);
806 /* Set up a select mechanism. This could be an AsyncSelect on a
807 * window, or an EventSelect on an event object. */
808 errstr = do_select(ret->s, 1);
819 static DWORD try_connect(Actual_Socket sock)
831 if (sock->s != INVALID_SOCKET) {
832 do_select(sock->s, 0);
833 p_closesocket(sock->s);
836 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
841 family = SOCKADDR_FAMILY(sock->addr, sock->step);
844 * Remove the socket from the tree before we overwrite its
845 * internal socket id, because that forms part of the tree's
846 * sorting criterion. We'll add it back before exiting this
847 * function, whether we changed anything or not.
849 del234(sktree, sock);
851 s = p_socket(family, SOCK_STREAM, 0);
854 if (s == INVALID_SOCKET) {
855 err = p_WSAGetLastError();
856 sock->error = winsock_error_string(err);
860 if (sock->oobinline) {
862 p_setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
867 p_setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
870 if (sock->keepalive) {
872 p_setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
876 * Bind to local address.
879 localport = 1023; /* count from 1023 downwards */
881 localport = 0; /* just use port 0 (ie winsock picks) */
883 /* Loop round trying to bind */
888 if (family == AF_INET6) {
889 memset(&a6, 0, sizeof(a6));
890 a6.sin6_family = AF_INET6;
891 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
892 a6.sin6_port = p_htons(localport);
896 a.sin_family = AF_INET;
897 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
898 a.sin_port = p_htons(localport);
901 sockcode = p_bind(s, (family == AF_INET6 ?
902 (struct sockaddr *) &a6 :
903 (struct sockaddr *) &a),
904 (family == AF_INET6 ? sizeof(a6) : sizeof(a)));
906 sockcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
908 if (sockcode != SOCKET_ERROR) {
912 err = p_WSAGetLastError();
913 if (err != WSAEADDRINUSE) /* failed, for a bad reason */
918 break; /* we're only looping once */
921 break; /* we might have got to the end */
925 sock->error = winsock_error_string(err);
930 * Connect to remote address.
934 if (family == AF_INET6) {
935 a6.sin6_family = AF_INET6;
936 a6.sin6_port = p_htons((short) sock->port);
938 ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_addr;
939 a6.sin6_flowinfo = ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_flowinfo;
940 a6.sin6_scope_id = ((struct sockaddr_in6 *) sock->step.ai->ai_addr)->sin6_scope_id;
942 a.sin_family = AF_INET;
944 ((struct sockaddr_in *) sock->step.ai->ai_addr)->sin_addr;
945 a.sin_port = p_htons((short) sock->port);
950 assert(sock->addr->addresses && sock->step.curraddr < sock->addr->naddresses);
951 a.sin_family = AF_INET;
952 a.sin_addr.s_addr = p_htonl(sock->addr->addresses[sock->step.curraddr]);
953 a.sin_port = p_htons((short) sock->port);
956 /* Set up a select mechanism. This could be an AsyncSelect on a
957 * window, or an EventSelect on an event object. */
958 errstr = do_select(s, 1);
960 sock->error = errstr;
968 ((family == AF_INET6) ? (struct sockaddr *) &a6 :
969 (struct sockaddr *) &a),
970 (family == AF_INET6) ? sizeof(a6) : sizeof(a))
972 p_connect(s, (struct sockaddr *) &a, sizeof(a))
975 err = p_WSAGetLastError();
977 * We expect a potential EWOULDBLOCK here, because the
978 * chances are the front end has done a select for
979 * FD_CONNECT, so that connect() will complete
982 if ( err != WSAEWOULDBLOCK ) {
983 sock->error = winsock_error_string(err);
988 * If we _don't_ get EWOULDBLOCK, the connect has completed
989 * and we should set the socket as writable.
999 * No matter what happened, put the socket back in the tree.
1001 add234(sktree, sock);
1004 plug_log(sock->plug, 1, sock->addr, sock->port, sock->error, err);
1008 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
1009 int nodelay, int keepalive, Plug plug)
1011 static const struct socket_function_table fn_table = {
1018 sk_tcp_set_private_ptr,
1019 sk_tcp_get_private_ptr,
1028 * Create Socket structure.
1030 ret = snew(struct Socket_tag);
1031 ret->fn = &fn_table;
1034 bufchain_init(&ret->output_data);
1035 ret->connected = 0; /* to start with */
1036 ret->writable = 0; /* to start with */
1037 ret->sending_oob = 0;
1038 ret->outgoingeof = EOF_NO;
1040 ret->frozen_readable = 0;
1041 ret->localhost_only = 0; /* unused, but best init anyway */
1042 ret->pending_error = 0;
1043 ret->parent = ret->child = NULL;
1044 ret->oobinline = oobinline;
1045 ret->nodelay = nodelay;
1046 ret->keepalive = keepalive;
1047 ret->privport = privport;
1050 START_STEP(ret->addr, ret->step);
1051 ret->s = INVALID_SOCKET;
1055 err = try_connect(ret);
1056 } while (err && sk_nextaddr(ret->addr, &ret->step));
1058 return (Socket) ret;
1061 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only,
1062 int orig_address_family)
1064 static const struct socket_function_table fn_table = {
1071 sk_tcp_set_private_ptr,
1072 sk_tcp_get_private_ptr,
1092 * Create Socket structure.
1094 ret = snew(struct Socket_tag);
1095 ret->fn = &fn_table;
1098 bufchain_init(&ret->output_data);
1099 ret->writable = 0; /* to start with */
1100 ret->sending_oob = 0;
1101 ret->outgoingeof = EOF_NO;
1103 ret->frozen_readable = 0;
1104 ret->localhost_only = local_host_only;
1105 ret->pending_error = 0;
1106 ret->parent = ret->child = NULL;
1110 * Translate address_family from platform-independent constants
1111 * into local reality.
1113 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
1115 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
1120 * Our default, if passed the `don't care' value
1121 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1122 * we will also set up a second socket listening on IPv6, but
1123 * the v4 one is primary since that ought to work even on
1124 * non-v6-supporting systems.
1126 if (address_family == AF_UNSPEC) address_family = AF_INET;
1131 s = p_socket(address_family, SOCK_STREAM, 0);
1134 if (s == INVALID_SOCKET) {
1135 err = p_WSAGetLastError();
1136 ret->error = winsock_error_string(err);
1137 return (Socket) ret;
1142 p_setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
1145 if (address_family == AF_INET6) {
1146 memset(&a6, 0, sizeof(a6));
1147 a6.sin6_family = AF_INET6;
1148 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1149 * know how to do it. :-)
1150 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1151 * Thus we need either a parser that understands [2001:db8::1]:80
1152 * style addresses and/or enhance this to understand hostnames too. */
1153 if (local_host_only)
1154 a6.sin6_addr = in6addr_loopback;
1156 a6.sin6_addr = in6addr_any;
1157 a6.sin6_port = p_htons(port);
1162 a.sin_family = AF_INET;
1165 * Bind to source address. First try an explicitly
1169 a.sin_addr.s_addr = p_inet_addr(srcaddr);
1170 if (a.sin_addr.s_addr != INADDR_NONE) {
1171 /* Override localhost_only with specified listen addr. */
1172 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
1178 * ... and failing that, go with one of the standard ones.
1181 if (local_host_only)
1182 a.sin_addr.s_addr = p_htonl(INADDR_LOOPBACK);
1184 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
1187 a.sin_port = p_htons((short)port);
1190 retcode = p_bind(s, (address_family == AF_INET6 ?
1191 (struct sockaddr *) &a6 :
1192 (struct sockaddr *) &a),
1194 AF_INET6 ? sizeof(a6) : sizeof(a)));
1196 retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
1198 if (retcode != SOCKET_ERROR) {
1201 err = p_WSAGetLastError();
1206 ret->error = winsock_error_string(err);
1207 return (Socket) ret;
1211 if (p_listen(s, SOMAXCONN) == SOCKET_ERROR) {
1213 ret->error = winsock_error_string(err);
1214 return (Socket) ret;
1217 /* Set up a select mechanism. This could be an AsyncSelect on a
1218 * window, or an EventSelect on an event object. */
1219 errstr = do_select(s, 1);
1222 ret->error = errstr;
1223 return (Socket) ret;
1226 add234(sktree, ret);
1230 * If we were given ADDRTYPE_UNSPEC, we must also create an
1231 * IPv6 listening socket and link it to this one.
1233 if (address_family == AF_INET && orig_address_family == ADDRTYPE_UNSPEC) {
1234 Actual_Socket other;
1236 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
1237 local_host_only, ADDRTYPE_IPV6);
1240 if (!other->error) {
1241 other->parent = ret;
1250 return (Socket) ret;
1253 static void sk_tcp_close(Socket sock)
1255 extern char *do_select(SOCKET skt, int startup);
1256 Actual_Socket s = (Actual_Socket) sock;
1259 sk_tcp_close((Socket)s->child);
1263 p_closesocket(s->s);
1265 sk_addr_free(s->addr);
1270 * The function which tries to send on a socket once it's deemed
1273 void try_send(Actual_Socket s)
1275 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1279 int len, urgentflag;
1281 if (s->sending_oob) {
1282 urgentflag = MSG_OOB;
1283 len = s->sending_oob;
1287 bufchain_prefix(&s->output_data, &data, &len);
1289 nsent = p_send(s->s, data, len, urgentflag);
1290 noise_ultralight(nsent);
1292 err = (nsent < 0 ? p_WSAGetLastError() : 0);
1293 if ((err < WSABASEERR && nsent < 0) || err == WSAEWOULDBLOCK) {
1295 * Perfectly normal: we've sent all we can for the moment.
1297 * (Some WinSock send() implementations can return
1298 * <0 but leave no sensible error indication -
1299 * WSAGetLastError() is called but returns zero or
1300 * a small number - so we check that case and treat
1301 * it just like WSAEWOULDBLOCK.)
1303 s->writable = FALSE;
1305 } else if (nsent == 0 ||
1306 err == WSAECONNABORTED || err == WSAECONNRESET) {
1308 * If send() returns CONNABORTED or CONNRESET, we
1309 * unfortunately can't just call plug_closing(),
1310 * because it's quite likely that we're currently
1311 * _in_ a call from the code we'd be calling back
1312 * to, so we'd have to make half the SSH code
1313 * reentrant. Instead we flag a pending error on
1314 * the socket, to be dealt with (by calling
1315 * plug_closing()) at some suitable future moment.
1317 s->pending_error = err;
1320 /* We're inside the Windows frontend here, so we know
1321 * that the frontend handle is unnecessary. */
1322 logevent(NULL, winsock_error_string(err));
1323 fatalbox("%s", winsock_error_string(err));
1326 if (s->sending_oob) {
1328 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1329 s->sending_oob = len - nsent;
1334 bufchain_consume(&s->output_data, nsent);
1340 * If we reach here, we've finished sending everything we might
1341 * have needed to send. Send EOF, if we need to.
1343 if (s->outgoingeof == EOF_PENDING) {
1344 p_shutdown(s->s, SD_SEND);
1345 s->outgoingeof = EOF_SENT;
1349 static int sk_tcp_write(Socket sock, const char *buf, int len)
1351 Actual_Socket s = (Actual_Socket) sock;
1353 assert(s->outgoingeof == EOF_NO);
1356 * Add the data to the buffer list on the socket.
1358 bufchain_add(&s->output_data, buf, len);
1361 * Now try sending from the start of the buffer list.
1366 return bufchain_size(&s->output_data);
1369 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1371 Actual_Socket s = (Actual_Socket) sock;
1373 assert(s->outgoingeof == EOF_NO);
1376 * Replace the buffer list on the socket with the data.
1378 bufchain_clear(&s->output_data);
1379 assert(len <= sizeof(s->oobdata));
1380 memcpy(s->oobdata, buf, len);
1381 s->sending_oob = len;
1384 * Now try sending from the start of the buffer list.
1389 return s->sending_oob;
1392 static void sk_tcp_write_eof(Socket sock)
1394 Actual_Socket s = (Actual_Socket) sock;
1396 assert(s->outgoingeof == EOF_NO);
1399 * Mark the socket as pending outgoing EOF.
1401 s->outgoingeof = EOF_PENDING;
1404 * Now try sending from the start of the buffer list.
1410 int select_result(WPARAM wParam, LPARAM lParam)
1414 char buf[20480]; /* nice big buffer for plenty of speed */
1418 /* wParam is the socket itself */
1421 return 1; /* boggle */
1423 s = find234(sktree, (void *) wParam, cmpforsearch);
1425 return 1; /* boggle */
1427 if ((err = WSAGETSELECTERROR(lParam)) != 0) {
1429 * An error has occurred on this socket. Pass it to the
1433 plug_log(s->plug, 1, s->addr, s->port,
1434 winsock_error_string(err), err);
1435 while (s->addr && sk_nextaddr(s->addr, &s->step)) {
1436 err = try_connect(s);
1440 return plug_closing(s->plug, winsock_error_string(err), err, 0);
1445 noise_ultralight(lParam);
1447 switch (WSAGETSELECTEVENT(lParam)) {
1449 s->connected = s->writable = 1;
1451 * Once a socket is connected, we can stop falling
1452 * back through the candidate addresses to connect
1456 sk_addr_free(s->addr);
1461 /* In the case the socket is still frozen, we don't even bother */
1463 s->frozen_readable = 1;
1468 * We have received data on the socket. For an oobinline
1469 * socket, this might be data _before_ an urgent pointer,
1470 * in which case we send it to the back end with type==1
1471 * (data prior to urgent).
1475 p_ioctlsocket(s->s, SIOCATMARK, &atmark);
1477 * Avoid checking the return value from ioctlsocket(),
1478 * on the grounds that some WinSock wrappers don't
1479 * support it. If it does nothing, we get atmark==1,
1480 * which is equivalent to `no OOB pending', so the
1481 * effect will be to non-OOB-ify any OOB data.
1486 ret = p_recv(s->s, buf, sizeof(buf), 0);
1487 noise_ultralight(ret);
1489 err = p_WSAGetLastError();
1490 if (err == WSAEWOULDBLOCK) {
1495 return plug_closing(s->plug, winsock_error_string(err), err,
1497 } else if (0 == ret) {
1498 return plug_closing(s->plug, NULL, 0, 0);
1500 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1505 * This will only happen on a non-oobinline socket. It
1506 * indicates that we can immediately perform an OOB read
1507 * and get back OOB data, which we will send to the back
1508 * end with type==2 (urgent data).
1510 ret = p_recv(s->s, buf, sizeof(buf), MSG_OOB);
1511 noise_ultralight(ret);
1513 char *str = (ret == 0 ? "Internal networking trouble" :
1514 winsock_error_string(p_WSAGetLastError()));
1515 /* We're inside the Windows frontend here, so we know
1516 * that the frontend handle is unnecessary. */
1517 logevent(NULL, str);
1518 fatalbox("%s", str);
1520 return plug_receive(s->plug, 2, buf, ret);
1525 int bufsize_before, bufsize_after;
1527 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1529 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1530 if (bufsize_after < bufsize_before)
1531 plug_sent(s->plug, bufsize_after);
1535 /* Signal a close on the socket. First read any outstanding data. */
1538 ret = p_recv(s->s, buf, sizeof(buf), 0);
1540 err = p_WSAGetLastError();
1541 if (err == WSAEWOULDBLOCK)
1543 return plug_closing(s->plug, winsock_error_string(err),
1547 open &= plug_receive(s->plug, 0, buf, ret);
1549 open &= plug_closing(s->plug, NULL, 0, 0);
1556 struct sockaddr_in isa;
1558 struct sockaddr_storage isa;
1560 int addrlen = sizeof(isa);
1561 SOCKET t; /* socket of connection */
1563 memset(&isa, 0, sizeof(isa));
1565 t = p_accept(s->s,(struct sockaddr *)&isa,&addrlen);
1566 if (t == INVALID_SOCKET)
1568 err = p_WSAGetLastError();
1569 if (err == WSATRY_AGAIN)
1573 if (isa.ss_family == AF_INET &&
1574 s->localhost_only &&
1575 !ipv4_is_local_addr(((struct sockaddr_in *)&isa)->sin_addr))
1577 if (s->localhost_only && !ipv4_is_local_addr(isa.sin_addr))
1580 p_closesocket(t); /* dodgy WinSock let nonlocal through */
1581 } else if (plug_accepting(s->plug, (void*)t)) {
1582 p_closesocket(t); /* denied or error */
1591 * Deal with socket errors detected in try_send().
1593 void net_pending_errors(void)
1599 * This might be a fiddly business, because it's just possible
1600 * that handling a pending error on one socket might cause
1601 * others to be closed. (I can't think of any reason this might
1602 * happen in current SSH implementation, but to maintain
1603 * generality of this network layer I'll assume the worst.)
1605 * So what we'll do is search the socket list for _one_ socket
1606 * with a pending error, and then handle it, and then search
1607 * the list again _from the beginning_. Repeat until we make a
1608 * pass with no socket errors present. That way we are
1609 * protected against the socket list changing under our feet.
1613 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1614 if (s->pending_error) {
1616 * An error has occurred on this socket. Pass it to the
1619 plug_closing(s->plug,
1620 winsock_error_string(s->pending_error),
1621 s->pending_error, 0);
1629 * Each socket abstraction contains a `void *' private field in
1630 * which the client can keep state.
1632 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1634 Actual_Socket s = (Actual_Socket) sock;
1635 s->private_ptr = ptr;
1638 static void *sk_tcp_get_private_ptr(Socket sock)
1640 Actual_Socket s = (Actual_Socket) sock;
1641 return s->private_ptr;
1645 * Special error values are returned from sk_namelookup and sk_new
1646 * if there's a problem. These functions extract an error message,
1647 * or return NULL if there's no problem.
1649 const char *sk_addr_error(SockAddr addr)
1653 static const char *sk_tcp_socket_error(Socket sock)
1655 Actual_Socket s = (Actual_Socket) sock;
1659 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1661 Actual_Socket s = (Actual_Socket) sock;
1662 if (s->frozen == is_frozen)
1664 s->frozen = is_frozen;
1667 if (s->frozen_readable) {
1669 p_recv(s->s, &c, 1, MSG_PEEK);
1672 s->frozen_readable = 0;
1675 void socket_reselect_all(void)
1680 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1687 * For Plink: enumerate all sockets currently active.
1689 SOCKET first_socket(int *state)
1693 s = index234(sktree, (*state)++);
1694 return s ? s->s : INVALID_SOCKET;
1697 SOCKET next_socket(int *state)
1699 Actual_Socket s = index234(sktree, (*state)++);
1700 return s ? s->s : INVALID_SOCKET;
1703 extern int socket_writable(SOCKET skt)
1705 Actual_Socket s = find234(sktree, (void *)skt, cmpforsearch);
1708 return bufchain_size(&s->output_data) > 0;
1713 int net_service_lookup(char *service)
1716 se = p_getservbyname(service, NULL);
1718 return p_ntohs(se->s_port);
1723 char *get_hostname(void)
1726 char *hostname = NULL;
1729 hostname = sresize(hostname, len, char);
1730 if (p_gethostname(hostname, len) < 0) {
1735 } while (strlen(hostname) >= (size_t)(len-1));
1739 SockAddr platform_get_x11_unix_address(const char *display, int displaynum,
1740 char **canonicalname)
1742 SockAddr ret = snew(struct SockAddr_tag);
1743 memset(ret, 0, sizeof(struct SockAddr_tag));
1744 ret->error = "unix sockets not supported on this platform";