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, struct hostent FAR
*, gethostbyname
,
172 DECL_WINSOCK_FUNCTION(static, struct servent FAR
*, getservbyname
,
173 (const char FAR
*, const char FAR
*));
174 DECL_WINSOCK_FUNCTION(static, unsigned long, inet_addr
, (const char FAR
*));
175 DECL_WINSOCK_FUNCTION(static, char FAR
*, inet_ntoa
, (struct in_addr
));
176 DECL_WINSOCK_FUNCTION(static, int, connect
,
177 (SOCKET
, const struct sockaddr FAR
*, int));
178 DECL_WINSOCK_FUNCTION(static, int, bind
,
179 (SOCKET
, const struct sockaddr FAR
*, int));
180 DECL_WINSOCK_FUNCTION(static, int, setsockopt
,
181 (SOCKET
, int, int, const char FAR
*, int));
182 DECL_WINSOCK_FUNCTION(static, SOCKET
, socket
, (int, int, int));
183 DECL_WINSOCK_FUNCTION(static, int, listen
, (SOCKET
, int));
184 DECL_WINSOCK_FUNCTION(static, int, send
, (SOCKET
, const char FAR
*, int, int));
185 DECL_WINSOCK_FUNCTION(static, int, ioctlsocket
,
186 (SOCKET
, long, u_long FAR
*));
187 DECL_WINSOCK_FUNCTION(static, SOCKET
, accept
,
188 (SOCKET
, struct sockaddr FAR
*, int FAR
*));
189 DECL_WINSOCK_FUNCTION(static, int, recv
, (SOCKET
, char FAR
*, int, int));
190 DECL_WINSOCK_FUNCTION(static, int, WSAIoctl
,
191 (SOCKET
, DWORD
, LPVOID
, DWORD
, LPVOID
, DWORD
,
192 LPDWORD
, LPWSAOVERLAPPED
,
193 LPWSAOVERLAPPED_COMPLETION_ROUTINE
));
195 DECL_WINSOCK_FUNCTION(static, int, getaddrinfo
,
196 (const char *nodename
, const char *servname
,
197 const struct addrinfo
*hints
, struct addrinfo
**res
));
198 DECL_WINSOCK_FUNCTION(static, void, freeaddrinfo
, (struct addrinfo
*res
));
199 DECL_WINSOCK_FUNCTION(static, int, getnameinfo
,
200 (const struct sockaddr FAR
* sa
, socklen_t salen
,
201 char FAR
* host
, size_t hostlen
, char FAR
* serv
,
202 size_t servlen
, int flags
));
203 DECL_WINSOCK_FUNCTION(static, char *, gai_strerror
, (int ecode
));
204 DECL_WINSOCK_FUNCTION(static, int, WSAAddressToStringA
,
205 (LPSOCKADDR
, DWORD
, LPWSAPROTOCOL_INFO
,
209 static HMODULE winsock_module
= NULL
;
210 static WSADATA wsadata
;
212 static HMODULE winsock2_module
= NULL
;
213 static HMODULE wship6_module
= NULL
;
216 int sk_startup(int hi
, int lo
)
220 winsock_ver
= MAKEWORD(hi
, lo
);
222 if (p_WSAStartup(winsock_ver
, &wsadata
)) {
226 if (LOBYTE(wsadata
.wVersion
) != LOBYTE(winsock_ver
)) {
230 #ifdef NET_SETUP_DIAGNOSTICS
233 sprintf(buf
, "Using WinSock %d.%d", hi
, lo
);
245 winsock_module
= LoadLibrary("WS2_32.DLL");
246 if (!winsock_module
) {
247 winsock_module
= LoadLibrary("WSOCK32.DLL");
250 fatalbox("Unable to load any WinSock library");
253 /* Check if we have getaddrinfo in Winsock */
254 if (GetProcAddress(winsock_module
, "getaddrinfo") != NULL
) {
255 #ifdef NET_SETUP_DIAGNOSTICS
256 logevent(NULL
, "Native WinSock IPv6 support detected");
258 GET_WINSOCK_FUNCTION(winsock_module
, getaddrinfo
);
259 GET_WINSOCK_FUNCTION(winsock_module
, freeaddrinfo
);
260 GET_WINSOCK_FUNCTION(winsock_module
, getnameinfo
);
261 GET_WINSOCK_FUNCTION(winsock_module
, gai_strerror
);
263 /* Fall back to wship6.dll for Windows 2000 */
264 wship6_module
= LoadLibrary("wship6.dll");
266 #ifdef NET_SETUP_DIAGNOSTICS
267 logevent(NULL
, "WSH IPv6 support detected");
269 GET_WINSOCK_FUNCTION(wship6_module
, getaddrinfo
);
270 GET_WINSOCK_FUNCTION(wship6_module
, freeaddrinfo
);
271 GET_WINSOCK_FUNCTION(wship6_module
, getnameinfo
);
272 GET_WINSOCK_FUNCTION(wship6_module
, gai_strerror
);
274 #ifdef NET_SETUP_DIAGNOSTICS
275 logevent(NULL
, "No IPv6 support detected");
279 GET_WINSOCK_FUNCTION(winsock2_module
, WSAAddressToStringA
);
281 #ifdef NET_SETUP_DIAGNOSTICS
282 logevent(NULL
, "PuTTY was built without IPv6 support");
286 GET_WINSOCK_FUNCTION(winsock_module
, WSAAsyncSelect
);
287 GET_WINSOCK_FUNCTION(winsock_module
, WSAEventSelect
);
288 GET_WINSOCK_FUNCTION(winsock_module
, select
);
289 GET_WINSOCK_FUNCTION(winsock_module
, WSAGetLastError
);
290 GET_WINSOCK_FUNCTION(winsock_module
, WSAEnumNetworkEvents
);
291 GET_WINSOCK_FUNCTION(winsock_module
, WSAStartup
);
292 GET_WINSOCK_FUNCTION(winsock_module
, WSACleanup
);
293 GET_WINSOCK_FUNCTION(winsock_module
, closesocket
);
294 GET_WINSOCK_FUNCTION(winsock_module
, ntohl
);
295 GET_WINSOCK_FUNCTION(winsock_module
, htonl
);
296 GET_WINSOCK_FUNCTION(winsock_module
, htons
);
297 GET_WINSOCK_FUNCTION(winsock_module
, ntohs
);
298 GET_WINSOCK_FUNCTION(winsock_module
, gethostbyname
);
299 GET_WINSOCK_FUNCTION(winsock_module
, getservbyname
);
300 GET_WINSOCK_FUNCTION(winsock_module
, inet_addr
);
301 GET_WINSOCK_FUNCTION(winsock_module
, inet_ntoa
);
302 GET_WINSOCK_FUNCTION(winsock_module
, connect
);
303 GET_WINSOCK_FUNCTION(winsock_module
, bind
);
304 GET_WINSOCK_FUNCTION(winsock_module
, setsockopt
);
305 GET_WINSOCK_FUNCTION(winsock_module
, socket
);
306 GET_WINSOCK_FUNCTION(winsock_module
, listen
);
307 GET_WINSOCK_FUNCTION(winsock_module
, send
);
308 GET_WINSOCK_FUNCTION(winsock_module
, ioctlsocket
);
309 GET_WINSOCK_FUNCTION(winsock_module
, accept
);
310 GET_WINSOCK_FUNCTION(winsock_module
, recv
);
311 GET_WINSOCK_FUNCTION(winsock_module
, WSAIoctl
);
313 /* Try to get the best WinSock version we can get */
314 if (!sk_startup(2,2) &&
317 fatalbox("Unable to initialise WinSock");
320 sktree
= newtree234(cmpfortree
);
323 void sk_cleanup(void)
329 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
338 FreeLibrary(winsock_module
);
341 FreeLibrary(wship6_module
);
345 char *winsock_error_string(int error
)
349 return "Network error: Permission denied";
351 return "Network error: Address already in use";
352 case WSAEADDRNOTAVAIL
:
353 return "Network error: Cannot assign requested address";
354 case WSAEAFNOSUPPORT
:
356 "Network error: Address family not supported by protocol family";
358 return "Network error: Operation already in progress";
359 case WSAECONNABORTED
:
360 return "Network error: Software caused connection abort";
361 case WSAECONNREFUSED
:
362 return "Network error: Connection refused";
364 return "Network error: Connection reset by peer";
365 case WSAEDESTADDRREQ
:
366 return "Network error: Destination address required";
368 return "Network error: Bad address";
370 return "Network error: Host is down";
371 case WSAEHOSTUNREACH
:
372 return "Network error: No route to host";
374 return "Network error: Operation now in progress";
376 return "Network error: Interrupted function call";
378 return "Network error: Invalid argument";
380 return "Network error: Socket is already connected";
382 return "Network error: Too many open files";
384 return "Network error: Message too long";
386 return "Network error: Network is down";
388 return "Network error: Network dropped connection on reset";
390 return "Network error: Network is unreachable";
392 return "Network error: No buffer space available";
394 return "Network error: Bad protocol option";
396 return "Network error: Socket is not connected";
398 return "Network error: Socket operation on non-socket";
400 return "Network error: Operation not supported";
401 case WSAEPFNOSUPPORT
:
402 return "Network error: Protocol family not supported";
404 return "Network error: Too many processes";
405 case WSAEPROTONOSUPPORT
:
406 return "Network error: Protocol not supported";
408 return "Network error: Protocol wrong type for socket";
410 return "Network error: Cannot send after socket shutdown";
411 case WSAESOCKTNOSUPPORT
:
412 return "Network error: Socket type not supported";
414 return "Network error: Connection timed out";
416 return "Network error: Resource temporarily unavailable";
418 return "Network error: Graceful shutdown in progress";
420 return "Unknown network error";
424 SockAddr
sk_namelookup(const char *host
, char **canonicalname
,
427 SockAddr ret
= snew(struct SockAddr_tag
);
429 struct hostent
*h
= NULL
;
434 /* Default to IPv4. */
435 hint_family
= (address_family
== ADDRTYPE_IPV4 ? AF_INET
:
437 address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
441 /* Clear the structure and default to IPv4. */
442 memset(ret
, 0, sizeof(struct SockAddr_tag
));
446 ret
->addresses
= NULL
;
447 ret
->resolved
= FALSE
;
451 if ((a
= p_inet_addr(host
)) == (unsigned long) INADDR_NONE
) {
454 * Use getaddrinfo when it's available
457 struct addrinfo hints
;
458 #ifdef NET_SETUP_DIAGNOSTICS
459 logevent(NULL
, "Using getaddrinfo() for resolving");
461 memset(&hints
, 0, sizeof(hints
));
462 hints
.ai_family
= hint_family
;
463 hints
.ai_flags
= AI_CANONNAME
;
464 if ((err
= p_getaddrinfo(host
, NULL
, &hints
, &ret
->ais
)) == 0)
465 ret
->resolved
= TRUE
;
469 #ifdef NET_SETUP_DIAGNOSTICS
470 logevent(NULL
, "Using gethostbyname() for resolving");
473 * Otherwise use the IPv4-only gethostbyname...
474 * (NOTE: we don't use gethostbyname as a fallback!)
476 if ( (h
= p_gethostbyname(host
)) )
477 ret
->resolved
= TRUE
;
479 err
= p_WSAGetLastError();
482 if (!ret
->resolved
) {
483 ret
->error
= (err
== WSAENETDOWN ?
"Network is down" :
484 err
== WSAHOST_NOT_FOUND ?
"Host does not exist" :
485 err
== WSATRY_AGAIN ?
"Host not found" :
487 p_getaddrinfo
&&p_gai_strerror ?
p_gai_strerror(err
) :
489 "gethostbyname: unknown error");
494 /* If we got an address info use that... */
496 /* Are we in IPv4 fallback mode? */
497 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
498 if (ret
->ais
->ai_family
== AF_INET
)
500 (char *) &((SOCKADDR_IN
*) ret
->ais
->
501 ai_addr
)->sin_addr
, sizeof(a
));
503 if (ret
->ais
->ai_canonname
)
504 strncpy(realhost
, ret
->ais
->ai_canonname
, lenof(realhost
));
506 strncpy(realhost
, host
, lenof(realhost
));
508 /* We used the IPv4-only gethostbyname()... */
513 for (n
= 0; h
->h_addr_list
[n
]; n
++);
514 ret
->addresses
= snewn(n
, unsigned long);
516 for (n
= 0; n
< ret
->naddresses
; n
++) {
517 memcpy(&a
, h
->h_addr_list
[n
], sizeof(a
));
518 ret
->addresses
[n
] = p_ntohl(a
);
520 memcpy(&a
, h
->h_addr
, sizeof(a
));
521 /* This way we are always sure the h->h_name is valid :) */
522 strncpy(realhost
, h
->h_name
, sizeof(realhost
));
527 * This must be a numeric IPv4 address because it caused a
528 * success return from inet_addr.
530 ret
->addresses
= snewn(1, unsigned long);
532 ret
->addresses
[0] = p_ntohl(a
);
533 ret
->resolved
= TRUE
;
534 strncpy(realhost
, host
, sizeof(realhost
));
536 realhost
[lenof(realhost
)-1] = '\0';
537 *canonicalname
= snewn(1+strlen(realhost
), char);
538 strcpy(*canonicalname
, realhost
);
542 SockAddr
sk_nonamelookup(const char *host
)
544 SockAddr ret
= snew(struct SockAddr_tag
);
546 ret
->resolved
= FALSE
;
550 ret
->addresses
= NULL
;
553 strncpy(ret
->hostname
, host
, lenof(ret
->hostname
));
554 ret
->hostname
[lenof(ret
->hostname
)-1] = '\0';
558 int sk_nextaddr(SockAddr addr
, SockAddrStep
*step
)
562 if (step
->ai
->ai_next
) {
563 step
->ai
= step
->ai
->ai_next
;
569 if (step
->curraddr
+1 < addr
->naddresses
) {
577 void sk_getaddr(SockAddr addr
, char *buf
, int buflen
)
580 START_STEP(addr
, step
);
584 if (p_WSAAddressToStringA
) {
585 p_WSAAddressToStringA(step
.ai
->ai_addr
, step
.ai
->ai_addrlen
,
588 strncpy(buf
, "IPv6", buflen
);
591 if (SOCKADDR_FAMILY(addr
, step
) == AF_INET
) {
593 assert(addr
->addresses
&& step
.curraddr
< addr
->naddresses
);
594 a
.s_addr
= p_htonl(addr
->addresses
[step
.curraddr
]);
595 strncpy(buf
, p_inet_ntoa(a
), buflen
);
596 buf
[buflen
-1] = '\0';
598 strncpy(buf
, addr
->hostname
, buflen
);
599 buf
[buflen
-1] = '\0';
603 int sk_hostname_is_local(char *name
)
605 return !strcmp(name
, "localhost") ||
606 !strcmp(name
, "::1") ||
607 !strncmp(name
, "127.", 4);
610 static INTERFACE_INFO local_interfaces
[16];
611 static int n_local_interfaces
; /* 0=not yet, -1=failed, >0=number */
613 static int ipv4_is_local_addr(struct in_addr addr
)
615 if (ipv4_is_loopback(addr
))
616 return 1; /* loopback addresses are local */
617 if (!n_local_interfaces
) {
618 SOCKET s
= p_socket(AF_INET
, SOCK_DGRAM
, 0);
622 p_WSAIoctl(s
, SIO_GET_INTERFACE_LIST
, NULL
, 0,
623 local_interfaces
, sizeof(local_interfaces
),
624 &retbytes
, NULL
, NULL
) == 0)
625 n_local_interfaces
= retbytes
/ sizeof(INTERFACE_INFO
);
627 logevent(NULL
, "Unable to get list of local IP addresses");
629 if (n_local_interfaces
> 0) {
631 for (i
= 0; i
< n_local_interfaces
; i
++) {
632 SOCKADDR_IN
*address
=
633 (SOCKADDR_IN
*)&local_interfaces
[i
].iiAddress
;
634 if (address
->sin_addr
.s_addr
== addr
.s_addr
)
635 return 1; /* this address is local */
638 return 0; /* this address is not local */
641 int sk_address_is_local(SockAddr addr
)
645 START_STEP(addr
, step
);
646 family
= SOCKADDR_FAMILY(addr
, step
);
649 if (family
== AF_INET6
) {
650 return IN6_IS_ADDR_LOOPBACK((const struct in6_addr
*)step
.ai
->ai_addr
);
653 if (family
== AF_INET
) {
656 return ipv4_is_local_addr(((struct sockaddr_in
*)step
.ai
->ai_addr
)
662 assert(addr
->addresses
&& step
.curraddr
< addr
->naddresses
);
663 a
.s_addr
= p_htonl(addr
->addresses
[step
.curraddr
]);
664 return ipv4_is_local_addr(a
);
667 assert(family
== AF_UNSPEC
);
668 return 0; /* we don't know; assume not */
672 int sk_addrtype(SockAddr addr
)
676 START_STEP(addr
, step
);
677 family
= SOCKADDR_FAMILY(addr
, step
);
679 return (family
== AF_INET ? ADDRTYPE_IPV4
:
681 family
== AF_INET6 ? ADDRTYPE_IPV6
:
686 void sk_addrcopy(SockAddr addr
, char *buf
)
690 START_STEP(addr
, step
);
691 family
= SOCKADDR_FAMILY(addr
, step
);
693 assert(family
!= AF_UNSPEC
);
696 if (family
== AF_INET
)
697 memcpy(buf
, &((struct sockaddr_in
*)step
.ai
->ai_addr
)->sin_addr
,
698 sizeof(struct in_addr
));
699 else if (family
== AF_INET6
)
700 memcpy(buf
, &((struct sockaddr_in6
*)step
.ai
->ai_addr
)->sin6_addr
,
701 sizeof(struct in6_addr
));
706 if (family
== AF_INET
) {
708 assert(addr
->addresses
&& step
.curraddr
< addr
->naddresses
);
709 a
.s_addr
= p_htonl(addr
->addresses
[step
.curraddr
]);
710 memcpy(buf
, (char*) &a
.s_addr
, 4);
714 void sk_addr_free(SockAddr addr
)
716 if (--addr
->refcount
> 0)
719 if (addr
->ais
&& p_freeaddrinfo
)
720 p_freeaddrinfo(addr
->ais
);
723 sfree(addr
->addresses
);
727 SockAddr
sk_addr_dup(SockAddr addr
)
733 static Plug
sk_tcp_plug(Socket sock
, Plug p
)
735 Actual_Socket s
= (Actual_Socket
) sock
;
742 static void sk_tcp_flush(Socket s
)
745 * We send data to the socket as soon as we can anyway,
746 * so we don't need to do anything here. :-)
750 static void sk_tcp_close(Socket s
);
751 static int sk_tcp_write(Socket s
, const char *data
, int len
);
752 static int sk_tcp_write_oob(Socket s
, const char *data
, int len
);
753 static void sk_tcp_set_private_ptr(Socket s
, void *ptr
);
754 static void *sk_tcp_get_private_ptr(Socket s
);
755 static void sk_tcp_set_frozen(Socket s
, int is_frozen
);
756 static const char *sk_tcp_socket_error(Socket s
);
758 extern char *do_select(SOCKET skt
, int startup
);
760 Socket
sk_register(void *sock
, Plug plug
)
762 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;
789 ret
->frozen_readable
= 0;
790 ret
->localhost_only
= 0; /* unused, but best init anyway */
791 ret
->pending_error
= 0;
792 ret
->parent
= ret
->child
= NULL
;
795 ret
->s
= (SOCKET
)sock
;
797 if (ret
->s
== INVALID_SOCKET
) {
798 err
= p_WSAGetLastError();
799 ret
->error
= winsock_error_string(err
);
805 /* Set up a select mechanism. This could be an AsyncSelect on a
806 * window, or an EventSelect on an event object. */
807 errstr
= do_select(ret
->s
, 1);
818 static DWORD
try_connect(Actual_Socket sock
)
830 if (sock
->s
!= INVALID_SOCKET
) {
831 do_select(sock
->s
, 0);
832 p_closesocket(sock
->s
);
835 plug_log(sock
->plug
, 0, sock
->addr
, sock
->port
, NULL
, 0);
840 family
= SOCKADDR_FAMILY(sock
->addr
, sock
->step
);
843 * Remove the socket from the tree before we overwrite its
844 * internal socket id, because that forms part of the tree's
845 * sorting criterion. We'll add it back before exiting this
846 * function, whether we changed anything or not.
848 del234(sktree
, sock
);
850 s
= p_socket(family
, SOCK_STREAM
, 0);
853 if (s
== INVALID_SOCKET
) {
854 err
= p_WSAGetLastError();
855 sock
->error
= winsock_error_string(err
);
859 if (sock
->oobinline
) {
861 p_setsockopt(s
, SOL_SOCKET
, SO_OOBINLINE
, (void *) &b
, sizeof(b
));
866 p_setsockopt(s
, IPPROTO_TCP
, TCP_NODELAY
, (void *) &b
, sizeof(b
));
869 if (sock
->keepalive
) {
871 p_setsockopt(s
, SOL_SOCKET
, SO_KEEPALIVE
, (void *) &b
, sizeof(b
));
875 * Bind to local address.
878 localport
= 1023; /* count from 1023 downwards */
880 localport
= 0; /* just use port 0 (ie winsock picks) */
882 /* Loop round trying to bind */
887 if (family
== AF_INET6
) {
888 memset(&a6
, 0, sizeof(a6
));
889 a6
.sin6_family
= AF_INET6
;
890 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
891 a6
.sin6_port
= p_htons(localport
);
895 a
.sin_family
= AF_INET
;
896 a
.sin_addr
.s_addr
= p_htonl(INADDR_ANY
);
897 a
.sin_port
= p_htons(localport
);
900 sockcode
= p_bind(s
, (family
== AF_INET6 ?
901 (struct sockaddr
*) &a6
:
902 (struct sockaddr
*) &a
),
903 (family
== AF_INET6 ?
sizeof(a6
) : sizeof(a
)));
905 sockcode
= p_bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
907 if (sockcode
!= SOCKET_ERROR
) {
911 err
= p_WSAGetLastError();
912 if (err
!= WSAEADDRINUSE
) /* failed, for a bad reason */
917 break; /* we're only looping once */
920 break; /* we might have got to the end */
924 sock
->error
= winsock_error_string(err
);
929 * Connect to remote address.
933 if (family
== AF_INET6
) {
934 a6
.sin6_family
= AF_INET6
;
935 a6
.sin6_port
= p_htons((short) sock
->port
);
937 ((struct sockaddr_in6
*) sock
->step
.ai
->ai_addr
)->sin6_addr
;
938 a6
.sin6_flowinfo
= ((struct sockaddr_in6
*) sock
->step
.ai
->ai_addr
)->sin6_flowinfo
;
939 a6
.sin6_scope_id
= ((struct sockaddr_in6
*) sock
->step
.ai
->ai_addr
)->sin6_scope_id
;
941 a
.sin_family
= AF_INET
;
943 ((struct sockaddr_in
*) sock
->step
.ai
->ai_addr
)->sin_addr
;
944 a
.sin_port
= p_htons((short) sock
->port
);
949 assert(sock
->addr
->addresses
&& sock
->step
.curraddr
< sock
->addr
->naddresses
);
950 a
.sin_family
= AF_INET
;
951 a
.sin_addr
.s_addr
= p_htonl(sock
->addr
->addresses
[sock
->step
.curraddr
]);
952 a
.sin_port
= p_htons((short) sock
->port
);
955 /* Set up a select mechanism. This could be an AsyncSelect on a
956 * window, or an EventSelect on an event object. */
957 errstr
= do_select(s
, 1);
959 sock
->error
= errstr
;
967 ((family
== AF_INET6
) ?
(struct sockaddr
*) &a6
:
968 (struct sockaddr
*) &a
),
969 (family
== AF_INET6
) ?
sizeof(a6
) : sizeof(a
))
971 p_connect(s
, (struct sockaddr
*) &a
, sizeof(a
))
974 err
= p_WSAGetLastError();
976 * We expect a potential EWOULDBLOCK here, because the
977 * chances are the front end has done a select for
978 * FD_CONNECT, so that connect() will complete
981 if ( err
!= WSAEWOULDBLOCK
) {
982 sock
->error
= winsock_error_string(err
);
987 * If we _don't_ get EWOULDBLOCK, the connect has completed
988 * and we should set the socket as writable.
998 * No matter what happened, put the socket back in the tree.
1000 add234(sktree
, sock
);
1003 plug_log(sock
->plug
, 1, sock
->addr
, sock
->port
, sock
->error
, err
);
1007 Socket
sk_new(SockAddr addr
, int port
, int privport
, int oobinline
,
1008 int nodelay
, int keepalive
, Plug plug
)
1010 static const struct socket_function_table fn_table
= {
1016 sk_tcp_set_private_ptr
,
1017 sk_tcp_get_private_ptr
,
1026 * Create Socket structure.
1028 ret
= snew(struct Socket_tag
);
1029 ret
->fn
= &fn_table
;
1032 bufchain_init(&ret
->output_data
);
1033 ret
->connected
= 0; /* to start with */
1034 ret
->writable
= 0; /* to start with */
1035 ret
->sending_oob
= 0;
1037 ret
->frozen_readable
= 0;
1038 ret
->localhost_only
= 0; /* unused, but best init anyway */
1039 ret
->pending_error
= 0;
1040 ret
->parent
= ret
->child
= NULL
;
1041 ret
->oobinline
= oobinline
;
1042 ret
->nodelay
= nodelay
;
1043 ret
->keepalive
= keepalive
;
1044 ret
->privport
= privport
;
1047 START_STEP(ret
->addr
, ret
->step
);
1048 ret
->s
= INVALID_SOCKET
;
1052 err
= try_connect(ret
);
1053 } while (err
&& sk_nextaddr(ret
->addr
, &ret
->step
));
1055 return (Socket
) ret
;
1058 Socket
sk_newlistener(char *srcaddr
, int port
, Plug plug
, int local_host_only
,
1059 int orig_address_family
)
1061 static const struct socket_function_table fn_table
= {
1067 sk_tcp_set_private_ptr
,
1068 sk_tcp_get_private_ptr
,
1088 * Create Socket structure.
1090 ret
= snew(struct Socket_tag
);
1091 ret
->fn
= &fn_table
;
1094 bufchain_init(&ret
->output_data
);
1095 ret
->writable
= 0; /* to start with */
1096 ret
->sending_oob
= 0;
1098 ret
->frozen_readable
= 0;
1099 ret
->localhost_only
= local_host_only
;
1100 ret
->pending_error
= 0;
1101 ret
->parent
= ret
->child
= NULL
;
1105 * Translate address_family from platform-independent constants
1106 * into local reality.
1108 address_family
= (orig_address_family
== ADDRTYPE_IPV4 ? AF_INET
:
1110 orig_address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
1115 * Our default, if passed the `don't care' value
1116 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1117 * we will also set up a second socket listening on IPv6, but
1118 * the v4 one is primary since that ought to work even on
1119 * non-v6-supporting systems.
1121 if (address_family
== AF_UNSPEC
) address_family
= AF_INET
;
1126 s
= p_socket(address_family
, SOCK_STREAM
, 0);
1129 if (s
== INVALID_SOCKET
) {
1130 err
= p_WSAGetLastError();
1131 ret
->error
= winsock_error_string(err
);
1132 return (Socket
) ret
;
1137 p_setsockopt(s
, SOL_SOCKET
, SO_REUSEADDR
, (const char *)&on
, sizeof(on
));
1140 if (address_family
== AF_INET6
) {
1141 memset(&a6
, 0, sizeof(a6
));
1142 a6
.sin6_family
= AF_INET6
;
1143 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1144 * know how to do it. :-)
1145 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1146 * Thus we need either a parser that understands [2001:db8::1]:80
1147 * style addresses and/or enhance this to understand hostnames too. */
1148 if (local_host_only
)
1149 a6
.sin6_addr
= in6addr_loopback
;
1151 a6
.sin6_addr
= in6addr_any
;
1152 a6
.sin6_port
= p_htons(port
);
1157 a
.sin_family
= AF_INET
;
1160 * Bind to source address. First try an explicitly
1164 a
.sin_addr
.s_addr
= p_inet_addr(srcaddr
);
1165 if (a
.sin_addr
.s_addr
!= INADDR_NONE
) {
1166 /* Override localhost_only with specified listen addr. */
1167 ret
->localhost_only
= ipv4_is_loopback(a
.sin_addr
);
1173 * ... and failing that, go with one of the standard ones.
1176 if (local_host_only
)
1177 a
.sin_addr
.s_addr
= p_htonl(INADDR_LOOPBACK
);
1179 a
.sin_addr
.s_addr
= p_htonl(INADDR_ANY
);
1182 a
.sin_port
= p_htons((short)port
);
1185 retcode
= p_bind(s
, (address_family
== AF_INET6 ?
1186 (struct sockaddr
*) &a6
:
1187 (struct sockaddr
*) &a
),
1189 AF_INET6 ?
sizeof(a6
) : sizeof(a
)));
1191 retcode
= p_bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
1193 if (retcode
!= SOCKET_ERROR
) {
1196 err
= p_WSAGetLastError();
1201 ret
->error
= winsock_error_string(err
);
1202 return (Socket
) ret
;
1206 if (p_listen(s
, SOMAXCONN
) == SOCKET_ERROR
) {
1208 ret
->error
= winsock_error_string(err
);
1209 return (Socket
) ret
;
1212 /* Set up a select mechanism. This could be an AsyncSelect on a
1213 * window, or an EventSelect on an event object. */
1214 errstr
= do_select(s
, 1);
1217 ret
->error
= errstr
;
1218 return (Socket
) ret
;
1221 add234(sktree
, ret
);
1225 * If we were given ADDRTYPE_UNSPEC, we must also create an
1226 * IPv6 listening socket and link it to this one.
1228 if (address_family
== AF_INET
&& orig_address_family
== ADDRTYPE_UNSPEC
) {
1229 Actual_Socket other
;
1231 other
= (Actual_Socket
) sk_newlistener(srcaddr
, port
, plug
,
1232 local_host_only
, ADDRTYPE_IPV6
);
1235 if (!other
->error
) {
1236 other
->parent
= ret
;
1245 return (Socket
) ret
;
1248 static void sk_tcp_close(Socket sock
)
1250 extern char *do_select(SOCKET skt
, int startup
);
1251 Actual_Socket s
= (Actual_Socket
) sock
;
1254 sk_tcp_close((Socket
)s
->child
);
1258 p_closesocket(s
->s
);
1260 sk_addr_free(s
->addr
);
1265 * The function which tries to send on a socket once it's deemed
1268 void try_send(Actual_Socket s
)
1270 while (s
->sending_oob
|| bufchain_size(&s
->output_data
) > 0) {
1274 int len
, urgentflag
;
1276 if (s
->sending_oob
) {
1277 urgentflag
= MSG_OOB
;
1278 len
= s
->sending_oob
;
1282 bufchain_prefix(&s
->output_data
, &data
, &len
);
1284 nsent
= p_send(s
->s
, data
, len
, urgentflag
);
1285 noise_ultralight(nsent
);
1287 err
= (nsent
< 0 ?
p_WSAGetLastError() : 0);
1288 if ((err
< WSABASEERR
&& nsent
< 0) || err
== WSAEWOULDBLOCK
) {
1290 * Perfectly normal: we've sent all we can for the moment.
1292 * (Some WinSock send() implementations can return
1293 * <0 but leave no sensible error indication -
1294 * WSAGetLastError() is called but returns zero or
1295 * a small number - so we check that case and treat
1296 * it just like WSAEWOULDBLOCK.)
1298 s
->writable
= FALSE
;
1300 } else if (nsent
== 0 ||
1301 err
== WSAECONNABORTED
|| err
== WSAECONNRESET
) {
1303 * If send() returns CONNABORTED or CONNRESET, we
1304 * unfortunately can't just call plug_closing(),
1305 * because it's quite likely that we're currently
1306 * _in_ a call from the code we'd be calling back
1307 * to, so we'd have to make half the SSH code
1308 * reentrant. Instead we flag a pending error on
1309 * the socket, to be dealt with (by calling
1310 * plug_closing()) at some suitable future moment.
1312 s
->pending_error
= err
;
1315 /* We're inside the Windows frontend here, so we know
1316 * that the frontend handle is unnecessary. */
1317 logevent(NULL
, winsock_error_string(err
));
1318 fatalbox("%s", winsock_error_string(err
));
1321 if (s
->sending_oob
) {
1323 memmove(s
->oobdata
, s
->oobdata
+nsent
, len
-nsent
);
1324 s
->sending_oob
= len
- nsent
;
1329 bufchain_consume(&s
->output_data
, nsent
);
1335 static int sk_tcp_write(Socket sock
, const char *buf
, int len
)
1337 Actual_Socket s
= (Actual_Socket
) sock
;
1340 * Add the data to the buffer list on the socket.
1342 bufchain_add(&s
->output_data
, buf
, len
);
1345 * Now try sending from the start of the buffer list.
1350 return bufchain_size(&s
->output_data
);
1353 static int sk_tcp_write_oob(Socket sock
, const char *buf
, int len
)
1355 Actual_Socket s
= (Actual_Socket
) sock
;
1358 * Replace the buffer list on the socket with the data.
1360 bufchain_clear(&s
->output_data
);
1361 assert(len
<= sizeof(s
->oobdata
));
1362 memcpy(s
->oobdata
, buf
, len
);
1363 s
->sending_oob
= len
;
1366 * Now try sending from the start of the buffer list.
1371 return s
->sending_oob
;
1374 int select_result(WPARAM wParam
, LPARAM lParam
)
1378 char buf
[20480]; /* nice big buffer for plenty of speed */
1382 /* wParam is the socket itself */
1385 return 1; /* boggle */
1387 s
= find234(sktree
, (void *) wParam
, cmpforsearch
);
1389 return 1; /* boggle */
1391 if ((err
= WSAGETSELECTERROR(lParam
)) != 0) {
1393 * An error has occurred on this socket. Pass it to the
1397 plug_log(s
->plug
, 1, s
->addr
, s
->port
,
1398 winsock_error_string(err
), err
);
1399 while (s
->addr
&& sk_nextaddr(s
->addr
, &s
->step
)) {
1400 err
= try_connect(s
);
1404 return plug_closing(s
->plug
, winsock_error_string(err
), err
, 0);
1409 noise_ultralight(lParam
);
1411 switch (WSAGETSELECTEVENT(lParam
)) {
1413 s
->connected
= s
->writable
= 1;
1415 * Once a socket is connected, we can stop falling
1416 * back through the candidate addresses to connect
1420 sk_addr_free(s
->addr
);
1425 /* In the case the socket is still frozen, we don't even bother */
1427 s
->frozen_readable
= 1;
1432 * We have received data on the socket. For an oobinline
1433 * socket, this might be data _before_ an urgent pointer,
1434 * in which case we send it to the back end with type==1
1435 * (data prior to urgent).
1439 p_ioctlsocket(s
->s
, SIOCATMARK
, &atmark
);
1441 * Avoid checking the return value from ioctlsocket(),
1442 * on the grounds that some WinSock wrappers don't
1443 * support it. If it does nothing, we get atmark==1,
1444 * which is equivalent to `no OOB pending', so the
1445 * effect will be to non-OOB-ify any OOB data.
1450 ret
= p_recv(s
->s
, buf
, sizeof(buf
), 0);
1451 noise_ultralight(ret
);
1453 err
= p_WSAGetLastError();
1454 if (err
== WSAEWOULDBLOCK
) {
1459 return plug_closing(s
->plug
, winsock_error_string(err
), err
,
1461 } else if (0 == ret
) {
1462 return plug_closing(s
->plug
, NULL
, 0, 0);
1464 return plug_receive(s
->plug
, atmark ?
0 : 1, buf
, ret
);
1469 * This will only happen on a non-oobinline socket. It
1470 * indicates that we can immediately perform an OOB read
1471 * and get back OOB data, which we will send to the back
1472 * end with type==2 (urgent data).
1474 ret
= p_recv(s
->s
, buf
, sizeof(buf
), MSG_OOB
);
1475 noise_ultralight(ret
);
1477 char *str
= (ret
== 0 ?
"Internal networking trouble" :
1478 winsock_error_string(p_WSAGetLastError()));
1479 /* We're inside the Windows frontend here, so we know
1480 * that the frontend handle is unnecessary. */
1481 logevent(NULL
, str
);
1482 fatalbox("%s", str
);
1484 return plug_receive(s
->plug
, 2, buf
, ret
);
1489 int bufsize_before
, bufsize_after
;
1491 bufsize_before
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1493 bufsize_after
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1494 if (bufsize_after
< bufsize_before
)
1495 plug_sent(s
->plug
, bufsize_after
);
1499 /* Signal a close on the socket. First read any outstanding data. */
1502 ret
= p_recv(s
->s
, buf
, sizeof(buf
), 0);
1504 err
= p_WSAGetLastError();
1505 if (err
== WSAEWOULDBLOCK
)
1507 return plug_closing(s
->plug
, winsock_error_string(err
),
1511 open
&= plug_receive(s
->plug
, 0, buf
, ret
);
1513 open
&= plug_closing(s
->plug
, NULL
, 0, 0);
1520 struct sockaddr_in isa
;
1522 struct sockaddr_storage isa
;
1524 int addrlen
= sizeof(isa
);
1525 SOCKET t
; /* socket of connection */
1527 memset(&isa
, 0, sizeof(isa
));
1529 t
= p_accept(s
->s
,(struct sockaddr
*)&isa
,&addrlen
);
1530 if (t
== INVALID_SOCKET
)
1532 err
= p_WSAGetLastError();
1533 if (err
== WSATRY_AGAIN
)
1537 if (isa
.ss_family
== AF_INET
&&
1538 s
->localhost_only
&&
1539 !ipv4_is_local_addr(((struct sockaddr_in
*)&isa
)->sin_addr
))
1541 if (s
->localhost_only
&& !ipv4_is_local_addr(isa
.sin_addr
))
1544 p_closesocket(t
); /* dodgy WinSock let nonlocal through */
1545 } else if (plug_accepting(s
->plug
, (void*)t
)) {
1546 p_closesocket(t
); /* denied or error */
1555 * Deal with socket errors detected in try_send().
1557 void net_pending_errors(void)
1563 * This might be a fiddly business, because it's just possible
1564 * that handling a pending error on one socket might cause
1565 * others to be closed. (I can't think of any reason this might
1566 * happen in current SSH implementation, but to maintain
1567 * generality of this network layer I'll assume the worst.)
1569 * So what we'll do is search the socket list for _one_ socket
1570 * with a pending error, and then handle it, and then search
1571 * the list again _from the beginning_. Repeat until we make a
1572 * pass with no socket errors present. That way we are
1573 * protected against the socket list changing under our feet.
1577 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
1578 if (s
->pending_error
) {
1580 * An error has occurred on this socket. Pass it to the
1583 plug_closing(s
->plug
,
1584 winsock_error_string(s
->pending_error
),
1585 s
->pending_error
, 0);
1593 * Each socket abstraction contains a `void *' private field in
1594 * which the client can keep state.
1596 static void sk_tcp_set_private_ptr(Socket sock
, void *ptr
)
1598 Actual_Socket s
= (Actual_Socket
) sock
;
1599 s
->private_ptr
= ptr
;
1602 static void *sk_tcp_get_private_ptr(Socket sock
)
1604 Actual_Socket s
= (Actual_Socket
) sock
;
1605 return s
->private_ptr
;
1609 * Special error values are returned from sk_namelookup and sk_new
1610 * if there's a problem. These functions extract an error message,
1611 * or return NULL if there's no problem.
1613 const char *sk_addr_error(SockAddr addr
)
1617 static const char *sk_tcp_socket_error(Socket sock
)
1619 Actual_Socket s
= (Actual_Socket
) sock
;
1623 static void sk_tcp_set_frozen(Socket sock
, int is_frozen
)
1625 Actual_Socket s
= (Actual_Socket
) sock
;
1626 if (s
->frozen
== is_frozen
)
1628 s
->frozen
= is_frozen
;
1631 if (s
->frozen_readable
) {
1633 p_recv(s
->s
, &c
, 1, MSG_PEEK
);
1636 s
->frozen_readable
= 0;
1639 void socket_reselect_all(void)
1644 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
1651 * For Plink: enumerate all sockets currently active.
1653 SOCKET
first_socket(int *state
)
1657 s
= index234(sktree
, (*state
)++);
1658 return s ? s
->s
: INVALID_SOCKET
;
1661 SOCKET
next_socket(int *state
)
1663 Actual_Socket s
= index234(sktree
, (*state
)++);
1664 return s ? s
->s
: INVALID_SOCKET
;
1667 extern int socket_writable(SOCKET skt
)
1669 Actual_Socket s
= find234(sktree
, (void *)skt
, cmpforsearch
);
1672 return bufchain_size(&s
->output_data
) > 0;
1677 int net_service_lookup(char *service
)
1680 se
= p_getservbyname(service
, NULL
);
1682 return p_ntohs(se
->s_port
);
1687 SockAddr
platform_get_x11_unix_address(const char *display
, int displaynum
,
1688 char **canonicalname
)
1690 SockAddr ret
= snew(struct SockAddr_tag
);
1691 memset(ret
, 0, sizeof(struct SockAddr_tag
));
1692 ret
->error
= "unix sockets not supported on this platform";