2 * Windows networking abstraction.
4 * For the IPv6 code in here I am indebted to Jeroen Massar and
12 #define DEFINE_PLUG_METHOD_MACROS
20 const struct in6_addr in6addr_any
= IN6ADDR_ANY_INIT
;
21 const struct in6_addr in6addr_loopback
= IN6ADDR_LOOPBACK_INIT
;
24 #define ipv4_is_loopback(addr) \
25 ((p_ntohl(addr.s_addr) & 0xFF000000L) == 0x7F000000L)
28 * We used to typedef struct Socket_tag *Socket.
30 * Since we have made the networking abstraction slightly more
31 * abstract, Socket no longer means a tcp socket (it could mean
32 * an ssl socket). So now we must use Actual_Socket when we know
33 * we are talking about a tcp socket.
35 typedef struct Socket_tag
*Actual_Socket
;
38 const struct socket_function_table
*fn
;
39 /* the above variable absolutely *must* be the first in this structure */
47 int frozen
; /* this causes readability notifications to be ignored */
48 int frozen_readable
; /* this means we missed at least one readability
49 * notification while we were frozen */
50 int localhost_only
; /* for listening sockets */
53 int oobinline
, nodelay
, keepalive
, privport
;
56 int pending_error
; /* in case send() returns error */
58 * We sometimes need pairs of Socket structures to be linked:
59 * if we are listening on the same IPv6 and v4 port, for
60 * example. So here we define `parent' and `child' pointers to
63 Actual_Socket parent
, child
;
69 * Which address family this address belongs to. AF_INET for
70 * IPv4; AF_INET6 for IPv6; AF_UNSPEC indicates that name
71 * resolution has not been done and a simple host name is held
72 * in this SockAddr structure.
73 * The hostname field is also used when the hostname has both
74 * an IPv6 and IPv4 address and the IPv6 connection attempt
75 * fails. We then try the IPv4 address.
76 * This 'family' should become an option in the GUI and
77 * on the commandline for selecting a default protocol.
81 struct addrinfo
*ais
; /* Addresses IPv6 style. */
82 struct addrinfo
*ai
; /* steps along the linked list */
84 unsigned long *addresses
; /* Addresses IPv4 style. */
85 int naddresses
, curraddr
;
86 char hostname
[512]; /* Store an unresolved host name. */
89 static tree234
*sktree
;
91 static int cmpfortree(void *av
, void *bv
)
93 Actual_Socket a
= (Actual_Socket
) av
, b
= (Actual_Socket
) bv
;
94 unsigned long as
= (unsigned long) a
->s
, bs
= (unsigned long) b
->s
;
102 static int cmpforsearch(void *av
, void *bv
)
104 Actual_Socket b
= (Actual_Socket
) bv
;
105 unsigned long as
= (unsigned long) av
, bs
= (unsigned long) b
->s
;
114 #define DECL_WINSOCK_FUNCTION(linkage, rettype, name, params) \
115 typedef rettype (WINAPI *t_##name) params; \
116 linkage t_##name p_##name
117 #define GET_WINSOCK_FUNCTION(module, name) \
118 p_##name = module ? (t_##name) GetProcAddress(module, #name) : NULL
120 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAAsyncSelect
,
121 (SOCKET
, HWND
, u_int
, long));
122 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAEventSelect
, (SOCKET
, WSAEVENT
, long));
123 DECL_WINSOCK_FUNCTION(NOTHING
, int, select
,
124 (int, fd_set FAR
*, fd_set FAR
*,
125 fd_set FAR
*, const struct timeval FAR
*));
126 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAGetLastError
, (void));
127 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAEnumNetworkEvents
,
128 (SOCKET
, WSAEVENT
, LPWSANETWORKEVENTS
));
129 DECL_WINSOCK_FUNCTION(static, int, WSAStartup
, (WORD
, LPWSADATA
));
130 DECL_WINSOCK_FUNCTION(static, int, WSACleanup
, (void));
131 DECL_WINSOCK_FUNCTION(static, int, closesocket
, (SOCKET
));
132 DECL_WINSOCK_FUNCTION(static, u_long
, ntohl
, (u_long
));
133 DECL_WINSOCK_FUNCTION(static, u_long
, htonl
, (u_long
));
134 DECL_WINSOCK_FUNCTION(static, u_short
, htons
, (u_short
));
135 DECL_WINSOCK_FUNCTION(static, u_short
, ntohs
, (u_short
));
136 DECL_WINSOCK_FUNCTION(static, struct hostent FAR
*, gethostbyname
,
138 DECL_WINSOCK_FUNCTION(static, struct servent FAR
*, getservbyname
,
139 (const char FAR
*, const char FAR
*));
140 DECL_WINSOCK_FUNCTION(static, unsigned long, inet_addr
, (const char FAR
*));
141 DECL_WINSOCK_FUNCTION(static, char FAR
*, inet_ntoa
, (struct in_addr
));
142 DECL_WINSOCK_FUNCTION(static, int, connect
,
143 (SOCKET
, const struct sockaddr FAR
*, int));
144 DECL_WINSOCK_FUNCTION(static, int, bind
,
145 (SOCKET
, const struct sockaddr FAR
*, int));
146 DECL_WINSOCK_FUNCTION(static, int, setsockopt
,
147 (SOCKET
, int, int, const char FAR
*, int));
148 DECL_WINSOCK_FUNCTION(static, SOCKET
, socket
, (int, int, int));
149 DECL_WINSOCK_FUNCTION(static, int, listen
, (SOCKET
, int));
150 DECL_WINSOCK_FUNCTION(static, int, send
, (SOCKET
, const char FAR
*, int, int));
151 DECL_WINSOCK_FUNCTION(static, int, ioctlsocket
,
152 (SOCKET
, long, u_long FAR
*));
153 DECL_WINSOCK_FUNCTION(static, SOCKET
, accept
,
154 (SOCKET
, struct sockaddr FAR
*, int FAR
*));
155 DECL_WINSOCK_FUNCTION(static, int, recv
, (SOCKET
, char FAR
*, int, int));
156 DECL_WINSOCK_FUNCTION(static, int, WSAIoctl
,
157 (SOCKET
, DWORD
, LPVOID
, DWORD
, LPVOID
, DWORD
,
158 LPDWORD
, LPWSAOVERLAPPED
,
159 LPWSAOVERLAPPED_COMPLETION_ROUTINE
));
161 DECL_WINSOCK_FUNCTION(static, int, getaddrinfo
,
162 (const char *nodename
, const char *servname
,
163 const struct addrinfo
*hints
, struct addrinfo
**res
));
164 DECL_WINSOCK_FUNCTION(static, void, freeaddrinfo
, (struct addrinfo
*res
));
165 DECL_WINSOCK_FUNCTION(static, int, getnameinfo
,
166 (const struct sockaddr FAR
* sa
, socklen_t salen
,
167 char FAR
* host
, size_t hostlen
, char FAR
* serv
,
168 size_t servlen
, int flags
));
169 DECL_WINSOCK_FUNCTION(static, char *, gai_strerror
, (int ecode
));
170 DECL_WINSOCK_FUNCTION(static, int, WSAAddressToStringA
,
171 (LPSOCKADDR
, DWORD
, LPWSAPROTOCOL_INFO
,
175 static HMODULE winsock_module
= NULL
;
176 static WSADATA wsadata
;
178 static HMODULE winsock2_module
= NULL
;
179 static HMODULE wship6_module
= NULL
;
182 int sk_startup(int hi
, int lo
)
186 winsock_ver
= MAKEWORD(hi
, lo
);
188 if (p_WSAStartup(winsock_ver
, &wsadata
)) {
192 if (LOBYTE(wsadata
.wVersion
) != LOBYTE(winsock_ver
)) {
196 #ifdef NET_SETUP_DIAGNOSTICS
199 sprintf(buf
, "Using WinSock %d.%d", hi
, lo
);
208 winsock2_module
= winsock_module
= LoadLibrary("WS2_32.DLL");
209 if (!winsock_module
) {
210 winsock_module
= LoadLibrary("WSOCK32.DLL");
213 fatalbox("Unable to load any WinSock library");
216 /* Check if we have getaddrinfo in Winsock */
217 if (GetProcAddress(winsock_module
, "getaddrinfo") != NULL
) {
218 #ifdef NET_SETUP_DIAGNOSTICS
219 logevent(NULL
, "Native WinSock IPv6 support detected");
221 GET_WINSOCK_FUNCTION(winsock_module
, getaddrinfo
);
222 GET_WINSOCK_FUNCTION(winsock_module
, freeaddrinfo
);
223 GET_WINSOCK_FUNCTION(winsock_module
, getnameinfo
);
224 GET_WINSOCK_FUNCTION(winsock_module
, gai_strerror
);
226 /* Fall back to wship6.dll for Windows 2000 */
227 wship6_module
= LoadLibrary("wship6.dll");
229 #ifdef NET_SETUP_DIAGNOSTICS
230 logevent(NULL
, "WSH IPv6 support detected");
232 GET_WINSOCK_FUNCTION(wship6_module
, getaddrinfo
);
233 GET_WINSOCK_FUNCTION(wship6_module
, freeaddrinfo
);
234 GET_WINSOCK_FUNCTION(wship6_module
, getnameinfo
);
235 GET_WINSOCK_FUNCTION(wship6_module
, gai_strerror
);
237 #ifdef NET_SETUP_DIAGNOSTICS
238 logevent(NULL
, "No IPv6 support detected");
242 GET_WINSOCK_FUNCTION(winsock2_module
, WSAAddressToStringA
);
244 #ifdef NET_SETUP_DIAGNOSTICS
245 logevent(NULL
, "PuTTY was built without IPv6 support");
249 GET_WINSOCK_FUNCTION(winsock_module
, WSAAsyncSelect
);
250 GET_WINSOCK_FUNCTION(winsock_module
, WSAEventSelect
);
251 GET_WINSOCK_FUNCTION(winsock_module
, select
);
252 GET_WINSOCK_FUNCTION(winsock_module
, WSAGetLastError
);
253 GET_WINSOCK_FUNCTION(winsock_module
, WSAEnumNetworkEvents
);
254 GET_WINSOCK_FUNCTION(winsock_module
, WSAStartup
);
255 GET_WINSOCK_FUNCTION(winsock_module
, WSACleanup
);
256 GET_WINSOCK_FUNCTION(winsock_module
, closesocket
);
257 GET_WINSOCK_FUNCTION(winsock_module
, ntohl
);
258 GET_WINSOCK_FUNCTION(winsock_module
, htonl
);
259 GET_WINSOCK_FUNCTION(winsock_module
, htons
);
260 GET_WINSOCK_FUNCTION(winsock_module
, ntohs
);
261 GET_WINSOCK_FUNCTION(winsock_module
, gethostbyname
);
262 GET_WINSOCK_FUNCTION(winsock_module
, getservbyname
);
263 GET_WINSOCK_FUNCTION(winsock_module
, inet_addr
);
264 GET_WINSOCK_FUNCTION(winsock_module
, inet_ntoa
);
265 GET_WINSOCK_FUNCTION(winsock_module
, connect
);
266 GET_WINSOCK_FUNCTION(winsock_module
, bind
);
267 GET_WINSOCK_FUNCTION(winsock_module
, setsockopt
);
268 GET_WINSOCK_FUNCTION(winsock_module
, socket
);
269 GET_WINSOCK_FUNCTION(winsock_module
, listen
);
270 GET_WINSOCK_FUNCTION(winsock_module
, send
);
271 GET_WINSOCK_FUNCTION(winsock_module
, ioctlsocket
);
272 GET_WINSOCK_FUNCTION(winsock_module
, accept
);
273 GET_WINSOCK_FUNCTION(winsock_module
, recv
);
274 GET_WINSOCK_FUNCTION(winsock_module
, WSAIoctl
);
276 /* Try to get the best WinSock version we can get */
277 if (!sk_startup(2,2) &&
280 fatalbox("Unable to initialise WinSock");
283 sktree
= newtree234(cmpfortree
);
286 void sk_cleanup(void)
292 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
301 FreeLibrary(winsock_module
);
304 FreeLibrary(wship6_module
);
308 char *winsock_error_string(int error
)
312 return "Network error: Permission denied";
314 return "Network error: Address already in use";
315 case WSAEADDRNOTAVAIL
:
316 return "Network error: Cannot assign requested address";
317 case WSAEAFNOSUPPORT
:
319 "Network error: Address family not supported by protocol family";
321 return "Network error: Operation already in progress";
322 case WSAECONNABORTED
:
323 return "Network error: Software caused connection abort";
324 case WSAECONNREFUSED
:
325 return "Network error: Connection refused";
327 return "Network error: Connection reset by peer";
328 case WSAEDESTADDRREQ
:
329 return "Network error: Destination address required";
331 return "Network error: Bad address";
333 return "Network error: Host is down";
334 case WSAEHOSTUNREACH
:
335 return "Network error: No route to host";
337 return "Network error: Operation now in progress";
339 return "Network error: Interrupted function call";
341 return "Network error: Invalid argument";
343 return "Network error: Socket is already connected";
345 return "Network error: Too many open files";
347 return "Network error: Message too long";
349 return "Network error: Network is down";
351 return "Network error: Network dropped connection on reset";
353 return "Network error: Network is unreachable";
355 return "Network error: No buffer space available";
357 return "Network error: Bad protocol option";
359 return "Network error: Socket is not connected";
361 return "Network error: Socket operation on non-socket";
363 return "Network error: Operation not supported";
364 case WSAEPFNOSUPPORT
:
365 return "Network error: Protocol family not supported";
367 return "Network error: Too many processes";
368 case WSAEPROTONOSUPPORT
:
369 return "Network error: Protocol not supported";
371 return "Network error: Protocol wrong type for socket";
373 return "Network error: Cannot send after socket shutdown";
374 case WSAESOCKTNOSUPPORT
:
375 return "Network error: Socket type not supported";
377 return "Network error: Connection timed out";
379 return "Network error: Resource temporarily unavailable";
381 return "Network error: Graceful shutdown in progress";
383 return "Unknown network error";
387 SockAddr
sk_namelookup(const char *host
, char **canonicalname
,
390 SockAddr ret
= snew(struct SockAddr_tag
);
392 struct hostent
*h
= NULL
;
397 /* Clear the structure and default to IPv4. */
398 memset(ret
, 0, sizeof(struct SockAddr_tag
));
399 ret
->family
= (address_family
== ADDRTYPE_IPV4 ? AF_INET
:
401 address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
405 ret
->ai
= ret
->ais
= NULL
;
407 ret
->addresses
= NULL
;
408 ret_family
= AF_UNSPEC
;
411 if ((a
= p_inet_addr(host
)) == (unsigned long) INADDR_NONE
) {
414 * Use getaddrinfo when it's available
417 struct addrinfo hints
;
418 #ifdef NET_SETUP_DIAGNOSTICS
419 logevent(NULL
, "Using getaddrinfo() for resolving");
421 memset(&hints
, 0, sizeof(hints
));
422 hints
.ai_family
= ret
->family
;
423 hints
.ai_flags
= AI_CANONNAME
;
424 if ((err
= p_getaddrinfo(host
, NULL
, &hints
, &ret
->ais
)) == 0)
425 ret_family
= ret
->ais
->ai_family
;
430 #ifdef NET_SETUP_DIAGNOSTICS
431 logevent(NULL
, "Using gethostbyname() for resolving");
434 * Otherwise use the IPv4-only gethostbyname...
435 * (NOTE: we don't use gethostbyname as a fallback!)
437 if ( (h
= p_gethostbyname(host
)) )
438 ret_family
= AF_INET
;
440 err
= p_WSAGetLastError();
443 if (ret_family
== AF_UNSPEC
) {
444 ret
->error
= (err
== WSAENETDOWN ?
"Network is down" :
445 err
== WSAHOST_NOT_FOUND ?
"Host does not exist" :
446 err
== WSATRY_AGAIN ?
"Host not found" :
448 p_getaddrinfo
&&p_gai_strerror ?
p_gai_strerror(err
) :
450 "gethostbyname: unknown error");
453 ret
->family
= ret_family
;
456 /* If we got an address info use that... */
458 /* Are we in IPv4 fallback mode? */
459 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
460 if (ret
->family
== AF_INET
)
462 (char *) &((SOCKADDR_IN
*) ret
->ai
->
463 ai_addr
)->sin_addr
, sizeof(a
));
465 if (ret
->ai
->ai_canonname
)
466 strncpy(realhost
, ret
->ai
->ai_canonname
, lenof(realhost
));
468 strncpy(realhost
, host
, lenof(realhost
));
470 /* We used the IPv4-only gethostbyname()... */
475 for (n
= 0; h
->h_addr_list
[n
]; n
++);
476 ret
->addresses
= snewn(n
, unsigned long);
478 for (n
= 0; n
< ret
->naddresses
; n
++) {
479 memcpy(&a
, h
->h_addr_list
[n
], sizeof(a
));
480 ret
->addresses
[n
] = p_ntohl(a
);
483 memcpy(&a
, h
->h_addr
, sizeof(a
));
484 /* This way we are always sure the h->h_name is valid :) */
485 strncpy(realhost
, h
->h_name
, sizeof(realhost
));
490 * This must be a numeric IPv4 address because it caused a
491 * success return from inet_addr.
493 ret
->addresses
= snewn(1, unsigned long);
496 ret
->addresses
[0] = p_ntohl(a
);
497 ret
->family
= AF_INET
;
498 strncpy(realhost
, host
, sizeof(realhost
));
500 realhost
[lenof(realhost
)-1] = '\0';
501 *canonicalname
= snewn(1+strlen(realhost
), char);
502 strcpy(*canonicalname
, realhost
);
506 SockAddr
sk_nonamelookup(const char *host
)
508 SockAddr ret
= snew(struct SockAddr_tag
);
510 ret
->family
= AF_UNSPEC
;
512 ret
->ai
= ret
->ais
= NULL
;
514 ret
->addresses
= NULL
;
516 strncpy(ret
->hostname
, host
, lenof(ret
->hostname
));
517 ret
->hostname
[lenof(ret
->hostname
)-1] = '\0';
521 int sk_nextaddr(SockAddr addr
)
525 if (addr
->ai
->ai_next
) {
526 addr
->ai
= addr
->ai
->ai_next
;
527 addr
->family
= addr
->ai
->ai_family
;
533 if (addr
->curraddr
+1 < addr
->naddresses
) {
541 void sk_getaddr(SockAddr addr
, char *buf
, int buflen
)
545 if (p_WSAAddressToStringA
) {
546 p_WSAAddressToStringA(addr
->ai
->ai_addr
, addr
->ai
->ai_addrlen
,
549 strncpy(buf
, "IPv6", buflen
);
552 if (addr
->family
== AF_INET
) {
554 assert(addr
->addresses
&& addr
->curraddr
< addr
->naddresses
);
555 a
.s_addr
= p_htonl(addr
->addresses
[addr
->curraddr
]);
556 strncpy(buf
, p_inet_ntoa(a
), buflen
);
557 buf
[buflen
-1] = '\0';
559 strncpy(buf
, addr
->hostname
, buflen
);
560 buf
[buflen
-1] = '\0';
564 int sk_hostname_is_local(char *name
)
566 return !strcmp(name
, "localhost");
569 static INTERFACE_INFO local_interfaces
[16];
570 static int n_local_interfaces
; /* 0=not yet, -1=failed, >0=number */
572 static int ipv4_is_local_addr(struct in_addr addr
)
574 if (ipv4_is_loopback(addr
))
575 return 1; /* loopback addresses are local */
576 if (!n_local_interfaces
) {
577 SOCKET s
= p_socket(AF_INET
, SOCK_DGRAM
, 0);
581 p_WSAIoctl(s
, SIO_GET_INTERFACE_LIST
, NULL
, 0,
582 local_interfaces
, sizeof(local_interfaces
),
583 &retbytes
, NULL
, NULL
) == 0)
584 n_local_interfaces
= retbytes
/ sizeof(INTERFACE_INFO
);
586 logevent(NULL
, "Unable to get list of local IP addresses");
588 if (n_local_interfaces
> 0) {
590 for (i
= 0; i
< n_local_interfaces
; i
++) {
591 SOCKADDR_IN
*address
=
592 (SOCKADDR_IN
*)&local_interfaces
[i
].iiAddress
;
593 if (address
->sin_addr
.s_addr
== addr
.s_addr
)
594 return 1; /* this address is local */
597 return 0; /* this address is not local */
600 int sk_address_is_local(SockAddr addr
)
603 if (addr
->family
== AF_INET6
) {
604 return IN6_IS_ADDR_LOOPBACK((const struct in6_addr
*)addr
->ai
->ai_addr
);
607 if (addr
->family
== AF_INET
) {
610 return ipv4_is_local_addr(((struct sockaddr_in
*)addr
->ai
->ai_addr
)
616 assert(addr
->addresses
&& addr
->curraddr
< addr
->naddresses
);
617 a
.s_addr
= p_htonl(addr
->addresses
[addr
->curraddr
]);
618 return ipv4_is_local_addr(a
);
621 assert(addr
->family
== AF_UNSPEC
);
622 return 0; /* we don't know; assume not */
626 int sk_addrtype(SockAddr addr
)
628 return (addr
->family
== AF_INET ? ADDRTYPE_IPV4
:
630 addr
->family
== AF_INET6 ? ADDRTYPE_IPV6
:
635 void sk_addrcopy(SockAddr addr
, char *buf
)
637 assert(addr
->family
!= AF_UNSPEC
);
640 if (addr
->family
== AF_INET
)
641 memcpy(buf
, &((struct sockaddr_in
*)addr
->ai
->ai_addr
)->sin_addr
,
642 sizeof(struct in_addr
));
643 else if (addr
->family
== AF_INET6
)
644 memcpy(buf
, &((struct sockaddr_in6
*)addr
->ai
->ai_addr
)->sin6_addr
,
645 sizeof(struct in6_addr
));
650 if (addr
->family
== AF_INET
) {
652 assert(addr
->addresses
&& addr
->curraddr
< addr
->naddresses
);
653 a
.s_addr
= p_htonl(addr
->addresses
[addr
->curraddr
]);
654 memcpy(buf
, (char*) &a
.s_addr
, 4);
658 void sk_addr_free(SockAddr addr
)
661 if (addr
->ais
&& p_freeaddrinfo
)
662 p_freeaddrinfo(addr
->ais
);
665 sfree(addr
->addresses
);
669 static Plug
sk_tcp_plug(Socket sock
, Plug p
)
671 Actual_Socket s
= (Actual_Socket
) sock
;
678 static void sk_tcp_flush(Socket s
)
681 * We send data to the socket as soon as we can anyway,
682 * so we don't need to do anything here. :-)
686 static void sk_tcp_close(Socket s
);
687 static int sk_tcp_write(Socket s
, const char *data
, int len
);
688 static int sk_tcp_write_oob(Socket s
, const char *data
, int len
);
689 static void sk_tcp_set_private_ptr(Socket s
, void *ptr
);
690 static void *sk_tcp_get_private_ptr(Socket s
);
691 static void sk_tcp_set_frozen(Socket s
, int is_frozen
);
692 static const char *sk_tcp_socket_error(Socket s
);
694 extern char *do_select(SOCKET skt
, int startup
);
696 Socket
sk_register(void *sock
, Plug plug
)
698 static const struct socket_function_table fn_table
= {
704 sk_tcp_set_private_ptr
,
705 sk_tcp_get_private_ptr
,
715 * Create Socket structure.
717 ret
= snew(struct Socket_tag
);
721 bufchain_init(&ret
->output_data
);
722 ret
->writable
= 1; /* to start with */
723 ret
->sending_oob
= 0;
725 ret
->frozen_readable
= 0;
726 ret
->localhost_only
= 0; /* unused, but best init anyway */
727 ret
->pending_error
= 0;
728 ret
->parent
= ret
->child
= NULL
;
731 ret
->s
= (SOCKET
)sock
;
733 if (ret
->s
== INVALID_SOCKET
) {
734 err
= p_WSAGetLastError();
735 ret
->error
= winsock_error_string(err
);
741 /* Set up a select mechanism. This could be an AsyncSelect on a
742 * window, or an EventSelect on an event object. */
743 errstr
= do_select(ret
->s
, 1);
754 static DWORD
try_connect(Actual_Socket sock
)
766 if (sock
->s
!= INVALID_SOCKET
) {
767 do_select(sock
->s
, 0);
768 p_closesocket(sock
->s
);
771 plug_log(sock
->plug
, 0, sock
->addr
, sock
->port
, NULL
, 0);
777 /* Let's default to IPv6, this shouldn't hurt anybody
778 * If the stack supports IPv6 it will also allow IPv4 connections. */
779 if (sock
->addr
->ai
) {
780 family
= sock
->addr
->ai
->ai_family
;
784 /* Default to IPv4 */
788 s
= p_socket(family
, SOCK_STREAM
, 0);
791 if (s
== INVALID_SOCKET
) {
792 err
= p_WSAGetLastError();
793 sock
->error
= winsock_error_string(err
);
797 if (sock
->oobinline
) {
799 p_setsockopt(s
, SOL_SOCKET
, SO_OOBINLINE
, (void *) &b
, sizeof(b
));
804 p_setsockopt(s
, IPPROTO_TCP
, TCP_NODELAY
, (void *) &b
, sizeof(b
));
807 if (sock
->keepalive
) {
809 p_setsockopt(s
, SOL_SOCKET
, SO_KEEPALIVE
, (void *) &b
, sizeof(b
));
813 * Bind to local address.
816 localport
= 1023; /* count from 1023 downwards */
818 localport
= 0; /* just use port 0 (ie winsock picks) */
820 /* Loop round trying to bind */
825 if (family
== AF_INET6
) {
826 memset(&a6
, 0, sizeof(a6
));
827 a6
.sin6_family
= AF_INET6
;
828 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
829 a6
.sin6_port
= p_htons(localport
);
833 a
.sin_family
= AF_INET
;
834 a
.sin_addr
.s_addr
= p_htonl(INADDR_ANY
);
835 a
.sin_port
= p_htons(localport
);
838 sockcode
= p_bind(s
, (sock
->addr
->family
== AF_INET6 ?
839 (struct sockaddr
*) &a6
:
840 (struct sockaddr
*) &a
),
841 (sock
->addr
->family
==
842 AF_INET6 ?
sizeof(a6
) : sizeof(a
)));
844 sockcode
= p_bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
846 if (sockcode
!= SOCKET_ERROR
) {
850 err
= p_WSAGetLastError();
851 if (err
!= WSAEADDRINUSE
) /* failed, for a bad reason */
856 break; /* we're only looping once */
859 break; /* we might have got to the end */
863 sock
->error
= winsock_error_string(err
);
868 * Connect to remote address.
871 if (sock
->addr
->ai
) {
872 if (family
== AF_INET6
) {
873 a6
.sin6_family
= AF_INET6
;
874 a6
.sin6_port
= p_htons((short) sock
->port
);
876 ((struct sockaddr_in6
*) sock
->addr
->ai
->ai_addr
)->sin6_addr
;
877 a6
.sin6_flowinfo
= ((struct sockaddr_in6
*) sock
->addr
->ai
->ai_addr
)->sin6_flowinfo
;
878 a6
.sin6_scope_id
= ((struct sockaddr_in6
*) sock
->addr
->ai
->ai_addr
)->sin6_scope_id
;
880 a
.sin_family
= AF_INET
;
882 ((struct sockaddr_in
*) sock
->addr
->ai
->ai_addr
)->sin_addr
;
883 a
.sin_port
= p_htons((short) sock
->port
);
888 assert(sock
->addr
->addresses
&& sock
->addr
->curraddr
< sock
->addr
->naddresses
);
889 a
.sin_family
= AF_INET
;
890 a
.sin_addr
.s_addr
= p_htonl(sock
->addr
->addresses
[sock
->addr
->curraddr
]);
891 a
.sin_port
= p_htons((short) sock
->port
);
894 /* Set up a select mechanism. This could be an AsyncSelect on a
895 * window, or an EventSelect on an event object. */
896 errstr
= do_select(s
, 1);
898 sock
->error
= errstr
;
906 ((family
== AF_INET6
) ?
(struct sockaddr
*) &a6
:
907 (struct sockaddr
*) &a
),
908 (family
== AF_INET6
) ?
sizeof(a6
) : sizeof(a
))
910 p_connect(s
, (struct sockaddr
*) &a
, sizeof(a
))
913 err
= p_WSAGetLastError();
915 * We expect a potential EWOULDBLOCK here, because the
916 * chances are the front end has done a select for
917 * FD_CONNECT, so that connect() will complete
920 if ( err
!= WSAEWOULDBLOCK
) {
921 sock
->error
= winsock_error_string(err
);
926 * If we _don't_ get EWOULDBLOCK, the connect has completed
927 * and we should set the socket as writable.
932 add234(sktree
, sock
);
938 plug_log(sock
->plug
, 1, sock
->addr
, sock
->port
, sock
->error
, err
);
942 Socket
sk_new(SockAddr addr
, int port
, int privport
, int oobinline
,
943 int nodelay
, int keepalive
, Plug plug
)
945 static const struct socket_function_table fn_table
= {
951 sk_tcp_set_private_ptr
,
952 sk_tcp_get_private_ptr
,
961 * Create Socket structure.
963 ret
= snew(struct Socket_tag
);
967 bufchain_init(&ret
->output_data
);
968 ret
->connected
= 0; /* to start with */
969 ret
->writable
= 0; /* to start with */
970 ret
->sending_oob
= 0;
972 ret
->frozen_readable
= 0;
973 ret
->localhost_only
= 0; /* unused, but best init anyway */
974 ret
->pending_error
= 0;
975 ret
->parent
= ret
->child
= NULL
;
976 ret
->oobinline
= oobinline
;
977 ret
->nodelay
= nodelay
;
978 ret
->keepalive
= keepalive
;
979 ret
->privport
= privport
;
982 ret
->s
= INVALID_SOCKET
;
986 err
= try_connect(ret
);
987 } while (err
&& sk_nextaddr(ret
->addr
));
992 Socket
sk_newlistener(char *srcaddr
, int port
, Plug plug
, int local_host_only
,
993 int orig_address_family
)
995 static const struct socket_function_table fn_table
= {
1001 sk_tcp_set_private_ptr
,
1002 sk_tcp_get_private_ptr
,
1022 * Create Socket structure.
1024 ret
= snew(struct Socket_tag
);
1025 ret
->fn
= &fn_table
;
1028 bufchain_init(&ret
->output_data
);
1029 ret
->writable
= 0; /* to start with */
1030 ret
->sending_oob
= 0;
1032 ret
->frozen_readable
= 0;
1033 ret
->localhost_only
= local_host_only
;
1034 ret
->pending_error
= 0;
1035 ret
->parent
= ret
->child
= NULL
;
1039 * Translate address_family from platform-independent constants
1040 * into local reality.
1042 address_family
= (orig_address_family
== ADDRTYPE_IPV4 ? AF_INET
:
1044 orig_address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
1049 * Our default, if passed the `don't care' value
1050 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1051 * we will also set up a second socket listening on IPv6, but
1052 * the v4 one is primary since that ought to work even on
1053 * non-v6-supporting systems.
1055 if (address_family
== AF_UNSPEC
) address_family
= AF_INET
;
1060 s
= p_socket(address_family
, SOCK_STREAM
, 0);
1063 if (s
== INVALID_SOCKET
) {
1064 err
= p_WSAGetLastError();
1065 ret
->error
= winsock_error_string(err
);
1066 return (Socket
) ret
;
1071 p_setsockopt(s
, SOL_SOCKET
, SO_REUSEADDR
, (const char *)&on
, sizeof(on
));
1074 if (address_family
== AF_INET6
) {
1075 memset(&a6
, 0, sizeof(a6
));
1076 a6
.sin6_family
= AF_INET6
;
1077 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1078 * know how to do it. :-)
1079 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1080 * Thus we need either a parser that understands [2001:db8::1]:80
1081 * style addresses and/or enhance this to understand hostnames too. */
1082 if (local_host_only
)
1083 a6
.sin6_addr
= in6addr_loopback
;
1085 a6
.sin6_addr
= in6addr_any
;
1086 a6
.sin6_port
= p_htons(port
);
1091 a
.sin_family
= AF_INET
;
1094 * Bind to source address. First try an explicitly
1098 a
.sin_addr
.s_addr
= p_inet_addr(srcaddr
);
1099 if (a
.sin_addr
.s_addr
!= INADDR_NONE
) {
1100 /* Override localhost_only with specified listen addr. */
1101 ret
->localhost_only
= ipv4_is_loopback(a
.sin_addr
);
1107 * ... and failing that, go with one of the standard ones.
1110 if (local_host_only
)
1111 a
.sin_addr
.s_addr
= p_htonl(INADDR_LOOPBACK
);
1113 a
.sin_addr
.s_addr
= p_htonl(INADDR_ANY
);
1116 a
.sin_port
= p_htons((short)port
);
1119 retcode
= p_bind(s
, (address_family
== AF_INET6 ?
1120 (struct sockaddr
*) &a6
:
1121 (struct sockaddr
*) &a
),
1123 AF_INET6 ?
sizeof(a6
) : sizeof(a
)));
1125 retcode
= p_bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
1127 if (retcode
!= SOCKET_ERROR
) {
1130 err
= p_WSAGetLastError();
1135 ret
->error
= winsock_error_string(err
);
1136 return (Socket
) ret
;
1140 if (p_listen(s
, SOMAXCONN
) == SOCKET_ERROR
) {
1142 ret
->error
= winsock_error_string(err
);
1143 return (Socket
) ret
;
1146 /* Set up a select mechanism. This could be an AsyncSelect on a
1147 * window, or an EventSelect on an event object. */
1148 errstr
= do_select(s
, 1);
1151 ret
->error
= errstr
;
1152 return (Socket
) ret
;
1155 add234(sktree
, ret
);
1159 * If we were given ADDRTYPE_UNSPEC, we must also create an
1160 * IPv6 listening socket and link it to this one.
1162 if (address_family
== AF_INET
&& orig_address_family
== ADDRTYPE_UNSPEC
) {
1163 Actual_Socket other
;
1165 other
= (Actual_Socket
) sk_newlistener(srcaddr
, port
, plug
,
1166 local_host_only
, ADDRTYPE_IPV6
);
1169 if (!other
->error
) {
1170 other
->parent
= ret
;
1179 return (Socket
) ret
;
1182 static void sk_tcp_close(Socket sock
)
1184 extern char *do_select(SOCKET skt
, int startup
);
1185 Actual_Socket s
= (Actual_Socket
) sock
;
1188 sk_tcp_close((Socket
)s
->child
);
1192 p_closesocket(s
->s
);
1194 sk_addr_free(s
->addr
);
1199 * The function which tries to send on a socket once it's deemed
1202 void try_send(Actual_Socket s
)
1204 while (s
->sending_oob
|| bufchain_size(&s
->output_data
) > 0) {
1208 int len
, urgentflag
;
1210 if (s
->sending_oob
) {
1211 urgentflag
= MSG_OOB
;
1212 len
= s
->sending_oob
;
1216 bufchain_prefix(&s
->output_data
, &data
, &len
);
1218 nsent
= p_send(s
->s
, data
, len
, urgentflag
);
1219 noise_ultralight(nsent
);
1221 err
= (nsent
< 0 ?
p_WSAGetLastError() : 0);
1222 if ((err
< WSABASEERR
&& nsent
< 0) || err
== WSAEWOULDBLOCK
) {
1224 * Perfectly normal: we've sent all we can for the moment.
1226 * (Some WinSock send() implementations can return
1227 * <0 but leave no sensible error indication -
1228 * WSAGetLastError() is called but returns zero or
1229 * a small number - so we check that case and treat
1230 * it just like WSAEWOULDBLOCK.)
1232 s
->writable
= FALSE
;
1234 } else if (nsent
== 0 ||
1235 err
== WSAECONNABORTED
|| err
== WSAECONNRESET
) {
1237 * If send() returns CONNABORTED or CONNRESET, we
1238 * unfortunately can't just call plug_closing(),
1239 * because it's quite likely that we're currently
1240 * _in_ a call from the code we'd be calling back
1241 * to, so we'd have to make half the SSH code
1242 * reentrant. Instead we flag a pending error on
1243 * the socket, to be dealt with (by calling
1244 * plug_closing()) at some suitable future moment.
1246 s
->pending_error
= err
;
1249 /* We're inside the Windows frontend here, so we know
1250 * that the frontend handle is unnecessary. */
1251 logevent(NULL
, winsock_error_string(err
));
1252 fatalbox("%s", winsock_error_string(err
));
1255 if (s
->sending_oob
) {
1257 memmove(s
->oobdata
, s
->oobdata
+nsent
, len
-nsent
);
1258 s
->sending_oob
= len
- nsent
;
1263 bufchain_consume(&s
->output_data
, nsent
);
1269 static int sk_tcp_write(Socket sock
, const char *buf
, int len
)
1271 Actual_Socket s
= (Actual_Socket
) sock
;
1274 * Add the data to the buffer list on the socket.
1276 bufchain_add(&s
->output_data
, buf
, len
);
1279 * Now try sending from the start of the buffer list.
1284 return bufchain_size(&s
->output_data
);
1287 static int sk_tcp_write_oob(Socket sock
, const char *buf
, int len
)
1289 Actual_Socket s
= (Actual_Socket
) sock
;
1292 * Replace the buffer list on the socket with the data.
1294 bufchain_clear(&s
->output_data
);
1295 assert(len
<= sizeof(s
->oobdata
));
1296 memcpy(s
->oobdata
, buf
, len
);
1297 s
->sending_oob
= len
;
1300 * Now try sending from the start of the buffer list.
1305 return s
->sending_oob
;
1308 int select_result(WPARAM wParam
, LPARAM lParam
)
1312 char buf
[20480]; /* nice big buffer for plenty of speed */
1316 /* wParam is the socket itself */
1319 return 1; /* boggle */
1321 s
= find234(sktree
, (void *) wParam
, cmpforsearch
);
1323 return 1; /* boggle */
1325 if ((err
= WSAGETSELECTERROR(lParam
)) != 0) {
1327 * An error has occurred on this socket. Pass it to the
1331 plug_log(s
->plug
, 1, s
->addr
, s
->port
,
1332 winsock_error_string(err
), err
);
1333 while (s
->addr
&& sk_nextaddr(s
->addr
)) {
1334 err
= try_connect(s
);
1338 return plug_closing(s
->plug
, winsock_error_string(err
), err
, 0);
1343 noise_ultralight(lParam
);
1345 switch (WSAGETSELECTEVENT(lParam
)) {
1347 s
->connected
= s
->writable
= 1;
1349 * Once a socket is connected, we can stop falling
1350 * back through the candidate addresses to connect
1354 sk_addr_free(s
->addr
);
1359 /* In the case the socket is still frozen, we don't even bother */
1361 s
->frozen_readable
= 1;
1366 * We have received data on the socket. For an oobinline
1367 * socket, this might be data _before_ an urgent pointer,
1368 * in which case we send it to the back end with type==1
1369 * (data prior to urgent).
1373 p_ioctlsocket(s
->s
, SIOCATMARK
, &atmark
);
1375 * Avoid checking the return value from ioctlsocket(),
1376 * on the grounds that some WinSock wrappers don't
1377 * support it. If it does nothing, we get atmark==1,
1378 * which is equivalent to `no OOB pending', so the
1379 * effect will be to non-OOB-ify any OOB data.
1384 ret
= p_recv(s
->s
, buf
, sizeof(buf
), 0);
1385 noise_ultralight(ret
);
1387 err
= p_WSAGetLastError();
1388 if (err
== WSAEWOULDBLOCK
) {
1393 return plug_closing(s
->plug
, winsock_error_string(err
), err
,
1395 } else if (0 == ret
) {
1396 return plug_closing(s
->plug
, NULL
, 0, 0);
1398 return plug_receive(s
->plug
, atmark ?
0 : 1, buf
, ret
);
1403 * This will only happen on a non-oobinline socket. It
1404 * indicates that we can immediately perform an OOB read
1405 * and get back OOB data, which we will send to the back
1406 * end with type==2 (urgent data).
1408 ret
= p_recv(s
->s
, buf
, sizeof(buf
), MSG_OOB
);
1409 noise_ultralight(ret
);
1411 char *str
= (ret
== 0 ?
"Internal networking trouble" :
1412 winsock_error_string(p_WSAGetLastError()));
1413 /* We're inside the Windows frontend here, so we know
1414 * that the frontend handle is unnecessary. */
1415 logevent(NULL
, str
);
1416 fatalbox("%s", str
);
1418 return plug_receive(s
->plug
, 2, buf
, ret
);
1423 int bufsize_before
, bufsize_after
;
1425 bufsize_before
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1427 bufsize_after
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1428 if (bufsize_after
< bufsize_before
)
1429 plug_sent(s
->plug
, bufsize_after
);
1433 /* Signal a close on the socket. First read any outstanding data. */
1436 ret
= p_recv(s
->s
, buf
, sizeof(buf
), 0);
1438 err
= p_WSAGetLastError();
1439 if (err
== WSAEWOULDBLOCK
)
1441 return plug_closing(s
->plug
, winsock_error_string(err
),
1445 open
&= plug_receive(s
->plug
, 0, buf
, ret
);
1447 open
&= plug_closing(s
->plug
, NULL
, 0, 0);
1454 struct sockaddr_in isa
;
1456 struct sockaddr_storage isa
;
1458 int addrlen
= sizeof(isa
);
1459 SOCKET t
; /* socket of connection */
1461 memset(&isa
, 0, sizeof(isa
));
1463 t
= p_accept(s
->s
,(struct sockaddr
*)&isa
,&addrlen
);
1464 if (t
== INVALID_SOCKET
)
1466 err
= p_WSAGetLastError();
1467 if (err
== WSATRY_AGAIN
)
1471 if (isa
.ss_family
== AF_INET
&&
1472 s
->localhost_only
&&
1473 !ipv4_is_local_addr(((struct sockaddr_in
*)&isa
)->sin_addr
)) {
1475 if (s
->localhost_only
&& !ipv4_is_local_addr(isa
.sin_addr
)) {
1477 p_closesocket(t
); /* dodgy WinSock let nonlocal through */
1478 } else if (plug_accepting(s
->plug
, (void*)t
)) {
1479 p_closesocket(t
); /* denied or error */
1488 * Deal with socket errors detected in try_send().
1490 void net_pending_errors(void)
1496 * This might be a fiddly business, because it's just possible
1497 * that handling a pending error on one socket might cause
1498 * others to be closed. (I can't think of any reason this might
1499 * happen in current SSH implementation, but to maintain
1500 * generality of this network layer I'll assume the worst.)
1502 * So what we'll do is search the socket list for _one_ socket
1503 * with a pending error, and then handle it, and then search
1504 * the list again _from the beginning_. Repeat until we make a
1505 * pass with no socket errors present. That way we are
1506 * protected against the socket list changing under our feet.
1510 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
1511 if (s
->pending_error
) {
1513 * An error has occurred on this socket. Pass it to the
1516 plug_closing(s
->plug
,
1517 winsock_error_string(s
->pending_error
),
1518 s
->pending_error
, 0);
1526 * Each socket abstraction contains a `void *' private field in
1527 * which the client can keep state.
1529 static void sk_tcp_set_private_ptr(Socket sock
, void *ptr
)
1531 Actual_Socket s
= (Actual_Socket
) sock
;
1532 s
->private_ptr
= ptr
;
1535 static void *sk_tcp_get_private_ptr(Socket sock
)
1537 Actual_Socket s
= (Actual_Socket
) sock
;
1538 return s
->private_ptr
;
1542 * Special error values are returned from sk_namelookup and sk_new
1543 * if there's a problem. These functions extract an error message,
1544 * or return NULL if there's no problem.
1546 const char *sk_addr_error(SockAddr addr
)
1550 static const char *sk_tcp_socket_error(Socket sock
)
1552 Actual_Socket s
= (Actual_Socket
) sock
;
1556 static void sk_tcp_set_frozen(Socket sock
, int is_frozen
)
1558 Actual_Socket s
= (Actual_Socket
) sock
;
1559 if (s
->frozen
== is_frozen
)
1561 s
->frozen
= is_frozen
;
1564 if (s
->frozen_readable
) {
1566 p_recv(s
->s
, &c
, 1, MSG_PEEK
);
1569 s
->frozen_readable
= 0;
1573 * For Plink: enumerate all sockets currently active.
1575 SOCKET
first_socket(int *state
)
1579 s
= index234(sktree
, (*state
)++);
1580 return s ? s
->s
: INVALID_SOCKET
;
1583 SOCKET
next_socket(int *state
)
1585 Actual_Socket s
= index234(sktree
, (*state
)++);
1586 return s ? s
->s
: INVALID_SOCKET
;
1589 extern int socket_writable(SOCKET skt
)
1591 Actual_Socket s
= find234(sktree
, (void *)skt
, cmpforsearch
);
1594 return bufchain_size(&s
->output_data
) > 0;
1599 int net_service_lookup(char *service
)
1602 se
= p_getservbyname(service
, NULL
);
1604 return p_ntohs(se
->s_port
);
1609 SockAddr
platform_get_x11_unix_address(int displaynum
, char **canonicalname
)
1611 SockAddr ret
= snew(struct SockAddr_tag
);
1612 memset(ret
, 0, sizeof(struct SockAddr_tag
));
1613 ret
->error
= "unix sockets not supported on this platform";