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
;
84 struct addrinfo
*ais
; /* Addresses IPv6 style. */
86 unsigned long *addresses
; /* Addresses IPv4 style. */
88 char hostname
[512]; /* Store an unresolved host name. */
92 * Which address family this address belongs to. AF_INET for IPv4;
93 * AF_INET6 for IPv6; AF_UNSPEC indicates that name resolution has
94 * not been done and a simple host name is held in this SockAddr
98 #define SOCKADDR_FAMILY(addr, step) \
99 (!(addr)->resolved ? AF_UNSPEC : \
100 (step).ai ? (step).ai->ai_family : AF_INET)
102 #define SOCKADDR_FAMILY(addr, step) \
103 (!(addr)->resolved ? AF_UNSPEC : AF_INET)
107 * Start a SockAddrStep structure to step through multiple
111 #define START_STEP(addr, step) \
112 ((step).ai = (addr)->ais, (step).curraddr = 0)
114 #define START_STEP(addr, step) \
115 ((step).curraddr = 0)
118 static tree234
*sktree
;
120 static int cmpfortree(void *av
, void *bv
)
122 Actual_Socket a
= (Actual_Socket
) av
, b
= (Actual_Socket
) bv
;
123 unsigned long as
= (unsigned long) a
->s
, bs
= (unsigned long) b
->s
;
135 static int cmpforsearch(void *av
, void *bv
)
137 Actual_Socket b
= (Actual_Socket
) bv
;
138 unsigned long as
= (unsigned long) av
, bs
= (unsigned long) b
->s
;
147 #define DECL_WINSOCK_FUNCTION(linkage, rettype, name, params) \
148 typedef rettype (WINAPI *t_##name) params; \
149 linkage t_##name p_##name
150 #define GET_WINSOCK_FUNCTION(module, name) \
151 p_##name = module ? (t_##name) GetProcAddress(module, #name) : NULL
153 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAAsyncSelect
,
154 (SOCKET
, HWND
, u_int
, long));
155 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAEventSelect
, (SOCKET
, WSAEVENT
, long));
156 DECL_WINSOCK_FUNCTION(NOTHING
, int, select
,
157 (int, fd_set FAR
*, fd_set FAR
*,
158 fd_set FAR
*, const struct timeval FAR
*));
159 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAGetLastError
, (void));
160 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAEnumNetworkEvents
,
161 (SOCKET
, WSAEVENT
, LPWSANETWORKEVENTS
));
162 DECL_WINSOCK_FUNCTION(static, int, WSAStartup
, (WORD
, LPWSADATA
));
163 DECL_WINSOCK_FUNCTION(static, int, WSACleanup
, (void));
164 DECL_WINSOCK_FUNCTION(static, int, closesocket
, (SOCKET
));
165 DECL_WINSOCK_FUNCTION(static, u_long
, ntohl
, (u_long
));
166 DECL_WINSOCK_FUNCTION(static, u_long
, htonl
, (u_long
));
167 DECL_WINSOCK_FUNCTION(static, u_short
, htons
, (u_short
));
168 DECL_WINSOCK_FUNCTION(static, u_short
, ntohs
, (u_short
));
169 DECL_WINSOCK_FUNCTION(static, struct hostent FAR
*, gethostbyname
,
171 DECL_WINSOCK_FUNCTION(static, struct servent FAR
*, getservbyname
,
172 (const char FAR
*, const char FAR
*));
173 DECL_WINSOCK_FUNCTION(static, unsigned long, inet_addr
, (const char FAR
*));
174 DECL_WINSOCK_FUNCTION(static, char FAR
*, inet_ntoa
, (struct in_addr
));
175 DECL_WINSOCK_FUNCTION(static, int, connect
,
176 (SOCKET
, const struct sockaddr FAR
*, int));
177 DECL_WINSOCK_FUNCTION(static, int, bind
,
178 (SOCKET
, const struct sockaddr FAR
*, int));
179 DECL_WINSOCK_FUNCTION(static, int, setsockopt
,
180 (SOCKET
, int, int, const char FAR
*, int));
181 DECL_WINSOCK_FUNCTION(static, SOCKET
, socket
, (int, int, int));
182 DECL_WINSOCK_FUNCTION(static, int, listen
, (SOCKET
, int));
183 DECL_WINSOCK_FUNCTION(static, int, send
, (SOCKET
, const char FAR
*, int, int));
184 DECL_WINSOCK_FUNCTION(static, int, ioctlsocket
,
185 (SOCKET
, long, u_long FAR
*));
186 DECL_WINSOCK_FUNCTION(static, SOCKET
, accept
,
187 (SOCKET
, struct sockaddr FAR
*, int FAR
*));
188 DECL_WINSOCK_FUNCTION(static, int, recv
, (SOCKET
, char FAR
*, int, int));
189 DECL_WINSOCK_FUNCTION(static, int, WSAIoctl
,
190 (SOCKET
, DWORD
, LPVOID
, DWORD
, LPVOID
, DWORD
,
191 LPDWORD
, LPWSAOVERLAPPED
,
192 LPWSAOVERLAPPED_COMPLETION_ROUTINE
));
194 DECL_WINSOCK_FUNCTION(static, int, getaddrinfo
,
195 (const char *nodename
, const char *servname
,
196 const struct addrinfo
*hints
, struct addrinfo
**res
));
197 DECL_WINSOCK_FUNCTION(static, void, freeaddrinfo
, (struct addrinfo
*res
));
198 DECL_WINSOCK_FUNCTION(static, int, getnameinfo
,
199 (const struct sockaddr FAR
* sa
, socklen_t salen
,
200 char FAR
* host
, size_t hostlen
, char FAR
* serv
,
201 size_t servlen
, int flags
));
202 DECL_WINSOCK_FUNCTION(static, char *, gai_strerror
, (int ecode
));
203 DECL_WINSOCK_FUNCTION(static, int, WSAAddressToStringA
,
204 (LPSOCKADDR
, DWORD
, LPWSAPROTOCOL_INFO
,
208 static HMODULE winsock_module
= NULL
;
209 static WSADATA wsadata
;
211 static HMODULE winsock2_module
= NULL
;
212 static HMODULE wship6_module
= NULL
;
215 int sk_startup(int hi
, int lo
)
219 winsock_ver
= MAKEWORD(hi
, lo
);
221 if (p_WSAStartup(winsock_ver
, &wsadata
)) {
225 if (LOBYTE(wsadata
.wVersion
) != LOBYTE(winsock_ver
)) {
229 #ifdef NET_SETUP_DIAGNOSTICS
232 sprintf(buf
, "Using WinSock %d.%d", hi
, lo
);
244 winsock_module
= LoadLibrary("WS2_32.DLL");
245 if (!winsock_module
) {
246 winsock_module
= LoadLibrary("WSOCK32.DLL");
249 fatalbox("Unable to load any WinSock library");
252 /* Check if we have getaddrinfo in Winsock */
253 if (GetProcAddress(winsock_module
, "getaddrinfo") != NULL
) {
254 #ifdef NET_SETUP_DIAGNOSTICS
255 logevent(NULL
, "Native WinSock IPv6 support detected");
257 GET_WINSOCK_FUNCTION(winsock_module
, getaddrinfo
);
258 GET_WINSOCK_FUNCTION(winsock_module
, freeaddrinfo
);
259 GET_WINSOCK_FUNCTION(winsock_module
, getnameinfo
);
260 GET_WINSOCK_FUNCTION(winsock_module
, gai_strerror
);
262 /* Fall back to wship6.dll for Windows 2000 */
263 wship6_module
= LoadLibrary("wship6.dll");
265 #ifdef NET_SETUP_DIAGNOSTICS
266 logevent(NULL
, "WSH IPv6 support detected");
268 GET_WINSOCK_FUNCTION(wship6_module
, getaddrinfo
);
269 GET_WINSOCK_FUNCTION(wship6_module
, freeaddrinfo
);
270 GET_WINSOCK_FUNCTION(wship6_module
, getnameinfo
);
271 GET_WINSOCK_FUNCTION(wship6_module
, gai_strerror
);
273 #ifdef NET_SETUP_DIAGNOSTICS
274 logevent(NULL
, "No IPv6 support detected");
278 GET_WINSOCK_FUNCTION(winsock2_module
, WSAAddressToStringA
);
280 #ifdef NET_SETUP_DIAGNOSTICS
281 logevent(NULL
, "PuTTY was built without IPv6 support");
285 GET_WINSOCK_FUNCTION(winsock_module
, WSAAsyncSelect
);
286 GET_WINSOCK_FUNCTION(winsock_module
, WSAEventSelect
);
287 GET_WINSOCK_FUNCTION(winsock_module
, select
);
288 GET_WINSOCK_FUNCTION(winsock_module
, WSAGetLastError
);
289 GET_WINSOCK_FUNCTION(winsock_module
, WSAEnumNetworkEvents
);
290 GET_WINSOCK_FUNCTION(winsock_module
, WSAStartup
);
291 GET_WINSOCK_FUNCTION(winsock_module
, WSACleanup
);
292 GET_WINSOCK_FUNCTION(winsock_module
, closesocket
);
293 GET_WINSOCK_FUNCTION(winsock_module
, ntohl
);
294 GET_WINSOCK_FUNCTION(winsock_module
, htonl
);
295 GET_WINSOCK_FUNCTION(winsock_module
, htons
);
296 GET_WINSOCK_FUNCTION(winsock_module
, ntohs
);
297 GET_WINSOCK_FUNCTION(winsock_module
, gethostbyname
);
298 GET_WINSOCK_FUNCTION(winsock_module
, getservbyname
);
299 GET_WINSOCK_FUNCTION(winsock_module
, inet_addr
);
300 GET_WINSOCK_FUNCTION(winsock_module
, inet_ntoa
);
301 GET_WINSOCK_FUNCTION(winsock_module
, connect
);
302 GET_WINSOCK_FUNCTION(winsock_module
, bind
);
303 GET_WINSOCK_FUNCTION(winsock_module
, setsockopt
);
304 GET_WINSOCK_FUNCTION(winsock_module
, socket
);
305 GET_WINSOCK_FUNCTION(winsock_module
, listen
);
306 GET_WINSOCK_FUNCTION(winsock_module
, send
);
307 GET_WINSOCK_FUNCTION(winsock_module
, ioctlsocket
);
308 GET_WINSOCK_FUNCTION(winsock_module
, accept
);
309 GET_WINSOCK_FUNCTION(winsock_module
, recv
);
310 GET_WINSOCK_FUNCTION(winsock_module
, WSAIoctl
);
312 /* Try to get the best WinSock version we can get */
313 if (!sk_startup(2,2) &&
316 fatalbox("Unable to initialise WinSock");
319 sktree
= newtree234(cmpfortree
);
322 void sk_cleanup(void)
328 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
337 FreeLibrary(winsock_module
);
340 FreeLibrary(wship6_module
);
344 char *winsock_error_string(int error
)
348 return "Network error: Permission denied";
350 return "Network error: Address already in use";
351 case WSAEADDRNOTAVAIL
:
352 return "Network error: Cannot assign requested address";
353 case WSAEAFNOSUPPORT
:
355 "Network error: Address family not supported by protocol family";
357 return "Network error: Operation already in progress";
358 case WSAECONNABORTED
:
359 return "Network error: Software caused connection abort";
360 case WSAECONNREFUSED
:
361 return "Network error: Connection refused";
363 return "Network error: Connection reset by peer";
364 case WSAEDESTADDRREQ
:
365 return "Network error: Destination address required";
367 return "Network error: Bad address";
369 return "Network error: Host is down";
370 case WSAEHOSTUNREACH
:
371 return "Network error: No route to host";
373 return "Network error: Operation now in progress";
375 return "Network error: Interrupted function call";
377 return "Network error: Invalid argument";
379 return "Network error: Socket is already connected";
381 return "Network error: Too many open files";
383 return "Network error: Message too long";
385 return "Network error: Network is down";
387 return "Network error: Network dropped connection on reset";
389 return "Network error: Network is unreachable";
391 return "Network error: No buffer space available";
393 return "Network error: Bad protocol option";
395 return "Network error: Socket is not connected";
397 return "Network error: Socket operation on non-socket";
399 return "Network error: Operation not supported";
400 case WSAEPFNOSUPPORT
:
401 return "Network error: Protocol family not supported";
403 return "Network error: Too many processes";
404 case WSAEPROTONOSUPPORT
:
405 return "Network error: Protocol not supported";
407 return "Network error: Protocol wrong type for socket";
409 return "Network error: Cannot send after socket shutdown";
410 case WSAESOCKTNOSUPPORT
:
411 return "Network error: Socket type not supported";
413 return "Network error: Connection timed out";
415 return "Network error: Resource temporarily unavailable";
417 return "Network error: Graceful shutdown in progress";
419 return "Unknown network error";
423 SockAddr
sk_namelookup(const char *host
, char **canonicalname
,
426 SockAddr ret
= snew(struct SockAddr_tag
);
428 struct hostent
*h
= NULL
;
433 /* Default to IPv4. */
434 hint_family
= (address_family
== ADDRTYPE_IPV4 ? AF_INET
:
436 address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
440 /* Clear the structure and default to IPv4. */
441 memset(ret
, 0, sizeof(struct SockAddr_tag
));
445 ret
->addresses
= NULL
;
446 ret
->resolved
= FALSE
;
449 if ((a
= p_inet_addr(host
)) == (unsigned long) INADDR_NONE
) {
452 * Use getaddrinfo when it's available
455 struct addrinfo hints
;
456 #ifdef NET_SETUP_DIAGNOSTICS
457 logevent(NULL
, "Using getaddrinfo() for resolving");
459 memset(&hints
, 0, sizeof(hints
));
460 hints
.ai_family
= hint_family
;
461 hints
.ai_flags
= AI_CANONNAME
;
462 if ((err
= p_getaddrinfo(host
, NULL
, &hints
, &ret
->ais
)) == 0)
463 ret
->resolved
= TRUE
;
467 #ifdef NET_SETUP_DIAGNOSTICS
468 logevent(NULL
, "Using gethostbyname() for resolving");
471 * Otherwise use the IPv4-only gethostbyname...
472 * (NOTE: we don't use gethostbyname as a fallback!)
474 if ( (h
= p_gethostbyname(host
)) )
475 ret
->resolved
= TRUE
;
477 err
= p_WSAGetLastError();
480 if (!ret
->resolved
) {
481 ret
->error
= (err
== WSAENETDOWN ?
"Network is down" :
482 err
== WSAHOST_NOT_FOUND ?
"Host does not exist" :
483 err
== WSATRY_AGAIN ?
"Host not found" :
485 p_getaddrinfo
&&p_gai_strerror ?
p_gai_strerror(err
) :
487 "gethostbyname: unknown error");
492 /* If we got an address info use that... */
494 /* Are we in IPv4 fallback mode? */
495 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
496 if (ret
->ais
->ai_family
== AF_INET
)
498 (char *) &((SOCKADDR_IN
*) ret
->ais
->
499 ai_addr
)->sin_addr
, sizeof(a
));
501 if (ret
->ais
->ai_canonname
)
502 strncpy(realhost
, ret
->ais
->ai_canonname
, lenof(realhost
));
504 strncpy(realhost
, host
, lenof(realhost
));
506 /* We used the IPv4-only gethostbyname()... */
511 for (n
= 0; h
->h_addr_list
[n
]; n
++);
512 ret
->addresses
= snewn(n
, unsigned long);
514 for (n
= 0; n
< ret
->naddresses
; n
++) {
515 memcpy(&a
, h
->h_addr_list
[n
], sizeof(a
));
516 ret
->addresses
[n
] = p_ntohl(a
);
518 memcpy(&a
, h
->h_addr
, sizeof(a
));
519 /* This way we are always sure the h->h_name is valid :) */
520 strncpy(realhost
, h
->h_name
, sizeof(realhost
));
525 * This must be a numeric IPv4 address because it caused a
526 * success return from inet_addr.
528 ret
->addresses
= snewn(1, unsigned long);
530 ret
->addresses
[0] = p_ntohl(a
);
531 ret
->resolved
= TRUE
;
532 strncpy(realhost
, host
, sizeof(realhost
));
534 realhost
[lenof(realhost
)-1] = '\0';
535 *canonicalname
= snewn(1+strlen(realhost
), char);
536 strcpy(*canonicalname
, realhost
);
540 SockAddr
sk_nonamelookup(const char *host
)
542 SockAddr ret
= snew(struct SockAddr_tag
);
544 ret
->resolved
= FALSE
;
548 ret
->addresses
= NULL
;
550 strncpy(ret
->hostname
, host
, lenof(ret
->hostname
));
551 ret
->hostname
[lenof(ret
->hostname
)-1] = '\0';
555 int sk_nextaddr(SockAddr addr
, SockAddrStep
*step
)
559 if (step
->ai
->ai_next
) {
560 step
->ai
= step
->ai
->ai_next
;
566 if (step
->curraddr
+1 < addr
->naddresses
) {
574 void sk_getaddr(SockAddr addr
, char *buf
, int buflen
)
577 START_STEP(addr
, step
);
581 if (p_WSAAddressToStringA
) {
582 p_WSAAddressToStringA(step
.ai
->ai_addr
, step
.ai
->ai_addrlen
,
585 strncpy(buf
, "IPv6", buflen
);
588 if (SOCKADDR_FAMILY(addr
, step
) == AF_INET
) {
590 assert(addr
->addresses
&& step
.curraddr
< addr
->naddresses
);
591 a
.s_addr
= p_htonl(addr
->addresses
[step
.curraddr
]);
592 strncpy(buf
, p_inet_ntoa(a
), buflen
);
593 buf
[buflen
-1] = '\0';
595 strncpy(buf
, addr
->hostname
, buflen
);
596 buf
[buflen
-1] = '\0';
600 int sk_hostname_is_local(char *name
)
602 return !strcmp(name
, "localhost");
605 static INTERFACE_INFO local_interfaces
[16];
606 static int n_local_interfaces
; /* 0=not yet, -1=failed, >0=number */
608 static int ipv4_is_local_addr(struct in_addr addr
)
610 if (ipv4_is_loopback(addr
))
611 return 1; /* loopback addresses are local */
612 if (!n_local_interfaces
) {
613 SOCKET s
= p_socket(AF_INET
, SOCK_DGRAM
, 0);
617 p_WSAIoctl(s
, SIO_GET_INTERFACE_LIST
, NULL
, 0,
618 local_interfaces
, sizeof(local_interfaces
),
619 &retbytes
, NULL
, NULL
) == 0)
620 n_local_interfaces
= retbytes
/ sizeof(INTERFACE_INFO
);
622 logevent(NULL
, "Unable to get list of local IP addresses");
624 if (n_local_interfaces
> 0) {
626 for (i
= 0; i
< n_local_interfaces
; i
++) {
627 SOCKADDR_IN
*address
=
628 (SOCKADDR_IN
*)&local_interfaces
[i
].iiAddress
;
629 if (address
->sin_addr
.s_addr
== addr
.s_addr
)
630 return 1; /* this address is local */
633 return 0; /* this address is not local */
636 int sk_address_is_local(SockAddr addr
)
640 START_STEP(addr
, step
);
641 family
= SOCKADDR_FAMILY(addr
, step
);
644 if (family
== AF_INET6
) {
645 return IN6_IS_ADDR_LOOPBACK((const struct in6_addr
*)step
.ai
->ai_addr
);
648 if (family
== AF_INET
) {
651 return ipv4_is_local_addr(((struct sockaddr_in
*)step
.ai
->ai_addr
)
657 assert(addr
->addresses
&& step
.curraddr
< addr
->naddresses
);
658 a
.s_addr
= p_htonl(addr
->addresses
[step
.curraddr
]);
659 return ipv4_is_local_addr(a
);
662 assert(family
== AF_UNSPEC
);
663 return 0; /* we don't know; assume not */
667 int sk_addrtype(SockAddr addr
)
671 START_STEP(addr
, step
);
672 family
= SOCKADDR_FAMILY(addr
, step
);
674 return (family
== AF_INET ? ADDRTYPE_IPV4
:
676 family
== AF_INET6 ? ADDRTYPE_IPV6
:
681 void sk_addrcopy(SockAddr addr
, char *buf
)
685 START_STEP(addr
, step
);
686 family
= SOCKADDR_FAMILY(addr
, step
);
688 assert(family
!= AF_UNSPEC
);
691 if (family
== AF_INET
)
692 memcpy(buf
, &((struct sockaddr_in
*)step
.ai
->ai_addr
)->sin_addr
,
693 sizeof(struct in_addr
));
694 else if (family
== AF_INET6
)
695 memcpy(buf
, &((struct sockaddr_in6
*)step
.ai
->ai_addr
)->sin6_addr
,
696 sizeof(struct in6_addr
));
701 if (family
== AF_INET
) {
703 assert(addr
->addresses
&& step
.curraddr
< addr
->naddresses
);
704 a
.s_addr
= p_htonl(addr
->addresses
[step
.curraddr
]);
705 memcpy(buf
, (char*) &a
.s_addr
, 4);
709 void sk_addr_free(SockAddr addr
)
712 if (addr
->ais
&& p_freeaddrinfo
)
713 p_freeaddrinfo(addr
->ais
);
716 sfree(addr
->addresses
);
720 static Plug
sk_tcp_plug(Socket sock
, Plug p
)
722 Actual_Socket s
= (Actual_Socket
) sock
;
729 static void sk_tcp_flush(Socket s
)
732 * We send data to the socket as soon as we can anyway,
733 * so we don't need to do anything here. :-)
737 static void sk_tcp_close(Socket s
);
738 static int sk_tcp_write(Socket s
, const char *data
, int len
);
739 static int sk_tcp_write_oob(Socket s
, const char *data
, int len
);
740 static void sk_tcp_set_private_ptr(Socket s
, void *ptr
);
741 static void *sk_tcp_get_private_ptr(Socket s
);
742 static void sk_tcp_set_frozen(Socket s
, int is_frozen
);
743 static const char *sk_tcp_socket_error(Socket s
);
745 extern char *do_select(SOCKET skt
, int startup
);
747 Socket
sk_register(void *sock
, Plug plug
)
749 static const struct socket_function_table fn_table
= {
755 sk_tcp_set_private_ptr
,
756 sk_tcp_get_private_ptr
,
766 * Create Socket structure.
768 ret
= snew(struct Socket_tag
);
772 bufchain_init(&ret
->output_data
);
773 ret
->writable
= 1; /* to start with */
774 ret
->sending_oob
= 0;
776 ret
->frozen_readable
= 0;
777 ret
->localhost_only
= 0; /* unused, but best init anyway */
778 ret
->pending_error
= 0;
779 ret
->parent
= ret
->child
= NULL
;
782 ret
->s
= (SOCKET
)sock
;
784 if (ret
->s
== INVALID_SOCKET
) {
785 err
= p_WSAGetLastError();
786 ret
->error
= winsock_error_string(err
);
792 /* Set up a select mechanism. This could be an AsyncSelect on a
793 * window, or an EventSelect on an event object. */
794 errstr
= do_select(ret
->s
, 1);
805 static DWORD
try_connect(Actual_Socket sock
)
817 if (sock
->s
!= INVALID_SOCKET
) {
818 do_select(sock
->s
, 0);
819 p_closesocket(sock
->s
);
822 plug_log(sock
->plug
, 0, sock
->addr
, sock
->port
, NULL
, 0);
827 family
= SOCKADDR_FAMILY(sock
->addr
, sock
->step
);
830 * Remove the socket from the tree before we overwrite its
831 * internal socket id, because that forms part of the tree's
832 * sorting criterion. We'll add it back before exiting this
833 * function, whether we changed anything or not.
835 del234(sktree
, sock
);
837 s
= p_socket(family
, SOCK_STREAM
, 0);
840 if (s
== INVALID_SOCKET
) {
841 err
= p_WSAGetLastError();
842 sock
->error
= winsock_error_string(err
);
846 if (sock
->oobinline
) {
848 p_setsockopt(s
, SOL_SOCKET
, SO_OOBINLINE
, (void *) &b
, sizeof(b
));
853 p_setsockopt(s
, IPPROTO_TCP
, TCP_NODELAY
, (void *) &b
, sizeof(b
));
856 if (sock
->keepalive
) {
858 p_setsockopt(s
, SOL_SOCKET
, SO_KEEPALIVE
, (void *) &b
, sizeof(b
));
862 * Bind to local address.
865 localport
= 1023; /* count from 1023 downwards */
867 localport
= 0; /* just use port 0 (ie winsock picks) */
869 /* Loop round trying to bind */
874 if (family
== AF_INET6
) {
875 memset(&a6
, 0, sizeof(a6
));
876 a6
.sin6_family
= AF_INET6
;
877 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
878 a6
.sin6_port
= p_htons(localport
);
882 a
.sin_family
= AF_INET
;
883 a
.sin_addr
.s_addr
= p_htonl(INADDR_ANY
);
884 a
.sin_port
= p_htons(localport
);
887 sockcode
= p_bind(s
, (family
== AF_INET6 ?
888 (struct sockaddr
*) &a6
:
889 (struct sockaddr
*) &a
),
890 (family
== AF_INET6 ?
sizeof(a6
) : sizeof(a
)));
892 sockcode
= p_bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
894 if (sockcode
!= SOCKET_ERROR
) {
898 err
= p_WSAGetLastError();
899 if (err
!= WSAEADDRINUSE
) /* failed, for a bad reason */
904 break; /* we're only looping once */
907 break; /* we might have got to the end */
911 sock
->error
= winsock_error_string(err
);
916 * Connect to remote address.
920 if (family
== AF_INET6
) {
921 a6
.sin6_family
= AF_INET6
;
922 a6
.sin6_port
= p_htons((short) sock
->port
);
924 ((struct sockaddr_in6
*) sock
->step
.ai
->ai_addr
)->sin6_addr
;
925 a6
.sin6_flowinfo
= ((struct sockaddr_in6
*) sock
->step
.ai
->ai_addr
)->sin6_flowinfo
;
926 a6
.sin6_scope_id
= ((struct sockaddr_in6
*) sock
->step
.ai
->ai_addr
)->sin6_scope_id
;
928 a
.sin_family
= AF_INET
;
930 ((struct sockaddr_in
*) sock
->step
.ai
->ai_addr
)->sin_addr
;
931 a
.sin_port
= p_htons((short) sock
->port
);
936 assert(sock
->addr
->addresses
&& sock
->step
.curraddr
< sock
->addr
->naddresses
);
937 a
.sin_family
= AF_INET
;
938 a
.sin_addr
.s_addr
= p_htonl(sock
->addr
->addresses
[sock
->step
.curraddr
]);
939 a
.sin_port
= p_htons((short) sock
->port
);
942 /* Set up a select mechanism. This could be an AsyncSelect on a
943 * window, or an EventSelect on an event object. */
944 errstr
= do_select(s
, 1);
946 sock
->error
= errstr
;
954 ((family
== AF_INET6
) ?
(struct sockaddr
*) &a6
:
955 (struct sockaddr
*) &a
),
956 (family
== AF_INET6
) ?
sizeof(a6
) : sizeof(a
))
958 p_connect(s
, (struct sockaddr
*) &a
, sizeof(a
))
961 err
= p_WSAGetLastError();
963 * We expect a potential EWOULDBLOCK here, because the
964 * chances are the front end has done a select for
965 * FD_CONNECT, so that connect() will complete
968 if ( err
!= WSAEWOULDBLOCK
) {
969 sock
->error
= winsock_error_string(err
);
974 * If we _don't_ get EWOULDBLOCK, the connect has completed
975 * and we should set the socket as writable.
985 * No matter what happened, put the socket back in the tree.
987 add234(sktree
, sock
);
990 plug_log(sock
->plug
, 1, sock
->addr
, sock
->port
, sock
->error
, err
);
994 Socket
sk_new(SockAddr addr
, int port
, int privport
, int oobinline
,
995 int nodelay
, int keepalive
, Plug plug
)
997 static const struct socket_function_table fn_table
= {
1003 sk_tcp_set_private_ptr
,
1004 sk_tcp_get_private_ptr
,
1013 * Create Socket structure.
1015 ret
= snew(struct Socket_tag
);
1016 ret
->fn
= &fn_table
;
1019 bufchain_init(&ret
->output_data
);
1020 ret
->connected
= 0; /* to start with */
1021 ret
->writable
= 0; /* to start with */
1022 ret
->sending_oob
= 0;
1024 ret
->frozen_readable
= 0;
1025 ret
->localhost_only
= 0; /* unused, but best init anyway */
1026 ret
->pending_error
= 0;
1027 ret
->parent
= ret
->child
= NULL
;
1028 ret
->oobinline
= oobinline
;
1029 ret
->nodelay
= nodelay
;
1030 ret
->keepalive
= keepalive
;
1031 ret
->privport
= privport
;
1034 START_STEP(ret
->addr
, ret
->step
);
1035 ret
->s
= INVALID_SOCKET
;
1039 err
= try_connect(ret
);
1040 } while (err
&& sk_nextaddr(ret
->addr
, &ret
->step
));
1042 return (Socket
) ret
;
1045 Socket
sk_newlistener(char *srcaddr
, int port
, Plug plug
, int local_host_only
,
1046 int orig_address_family
)
1048 static const struct socket_function_table fn_table
= {
1054 sk_tcp_set_private_ptr
,
1055 sk_tcp_get_private_ptr
,
1075 * Create Socket structure.
1077 ret
= snew(struct Socket_tag
);
1078 ret
->fn
= &fn_table
;
1081 bufchain_init(&ret
->output_data
);
1082 ret
->writable
= 0; /* to start with */
1083 ret
->sending_oob
= 0;
1085 ret
->frozen_readable
= 0;
1086 ret
->localhost_only
= local_host_only
;
1087 ret
->pending_error
= 0;
1088 ret
->parent
= ret
->child
= NULL
;
1092 * Translate address_family from platform-independent constants
1093 * into local reality.
1095 address_family
= (orig_address_family
== ADDRTYPE_IPV4 ? AF_INET
:
1097 orig_address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
1102 * Our default, if passed the `don't care' value
1103 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1104 * we will also set up a second socket listening on IPv6, but
1105 * the v4 one is primary since that ought to work even on
1106 * non-v6-supporting systems.
1108 if (address_family
== AF_UNSPEC
) address_family
= AF_INET
;
1113 s
= p_socket(address_family
, SOCK_STREAM
, 0);
1116 if (s
== INVALID_SOCKET
) {
1117 err
= p_WSAGetLastError();
1118 ret
->error
= winsock_error_string(err
);
1119 return (Socket
) ret
;
1124 p_setsockopt(s
, SOL_SOCKET
, SO_REUSEADDR
, (const char *)&on
, sizeof(on
));
1127 if (address_family
== AF_INET6
) {
1128 memset(&a6
, 0, sizeof(a6
));
1129 a6
.sin6_family
= AF_INET6
;
1130 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1131 * know how to do it. :-)
1132 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1133 * Thus we need either a parser that understands [2001:db8::1]:80
1134 * style addresses and/or enhance this to understand hostnames too. */
1135 if (local_host_only
)
1136 a6
.sin6_addr
= in6addr_loopback
;
1138 a6
.sin6_addr
= in6addr_any
;
1139 a6
.sin6_port
= p_htons(port
);
1144 a
.sin_family
= AF_INET
;
1147 * Bind to source address. First try an explicitly
1151 a
.sin_addr
.s_addr
= p_inet_addr(srcaddr
);
1152 if (a
.sin_addr
.s_addr
!= INADDR_NONE
) {
1153 /* Override localhost_only with specified listen addr. */
1154 ret
->localhost_only
= ipv4_is_loopback(a
.sin_addr
);
1160 * ... and failing that, go with one of the standard ones.
1163 if (local_host_only
)
1164 a
.sin_addr
.s_addr
= p_htonl(INADDR_LOOPBACK
);
1166 a
.sin_addr
.s_addr
= p_htonl(INADDR_ANY
);
1169 a
.sin_port
= p_htons((short)port
);
1172 retcode
= p_bind(s
, (address_family
== AF_INET6 ?
1173 (struct sockaddr
*) &a6
:
1174 (struct sockaddr
*) &a
),
1176 AF_INET6 ?
sizeof(a6
) : sizeof(a
)));
1178 retcode
= p_bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
1180 if (retcode
!= SOCKET_ERROR
) {
1183 err
= p_WSAGetLastError();
1188 ret
->error
= winsock_error_string(err
);
1189 return (Socket
) ret
;
1193 if (p_listen(s
, SOMAXCONN
) == SOCKET_ERROR
) {
1195 ret
->error
= winsock_error_string(err
);
1196 return (Socket
) ret
;
1199 /* Set up a select mechanism. This could be an AsyncSelect on a
1200 * window, or an EventSelect on an event object. */
1201 errstr
= do_select(s
, 1);
1204 ret
->error
= errstr
;
1205 return (Socket
) ret
;
1208 add234(sktree
, ret
);
1212 * If we were given ADDRTYPE_UNSPEC, we must also create an
1213 * IPv6 listening socket and link it to this one.
1215 if (address_family
== AF_INET
&& orig_address_family
== ADDRTYPE_UNSPEC
) {
1216 Actual_Socket other
;
1218 other
= (Actual_Socket
) sk_newlistener(srcaddr
, port
, plug
,
1219 local_host_only
, ADDRTYPE_IPV6
);
1222 if (!other
->error
) {
1223 other
->parent
= ret
;
1232 return (Socket
) ret
;
1235 static void sk_tcp_close(Socket sock
)
1237 extern char *do_select(SOCKET skt
, int startup
);
1238 Actual_Socket s
= (Actual_Socket
) sock
;
1241 sk_tcp_close((Socket
)s
->child
);
1245 p_closesocket(s
->s
);
1247 sk_addr_free(s
->addr
);
1252 * The function which tries to send on a socket once it's deemed
1255 void try_send(Actual_Socket s
)
1257 while (s
->sending_oob
|| bufchain_size(&s
->output_data
) > 0) {
1261 int len
, urgentflag
;
1263 if (s
->sending_oob
) {
1264 urgentflag
= MSG_OOB
;
1265 len
= s
->sending_oob
;
1269 bufchain_prefix(&s
->output_data
, &data
, &len
);
1271 nsent
= p_send(s
->s
, data
, len
, urgentflag
);
1272 noise_ultralight(nsent
);
1274 err
= (nsent
< 0 ?
p_WSAGetLastError() : 0);
1275 if ((err
< WSABASEERR
&& nsent
< 0) || err
== WSAEWOULDBLOCK
) {
1277 * Perfectly normal: we've sent all we can for the moment.
1279 * (Some WinSock send() implementations can return
1280 * <0 but leave no sensible error indication -
1281 * WSAGetLastError() is called but returns zero or
1282 * a small number - so we check that case and treat
1283 * it just like WSAEWOULDBLOCK.)
1285 s
->writable
= FALSE
;
1287 } else if (nsent
== 0 ||
1288 err
== WSAECONNABORTED
|| err
== WSAECONNRESET
) {
1290 * If send() returns CONNABORTED or CONNRESET, we
1291 * unfortunately can't just call plug_closing(),
1292 * because it's quite likely that we're currently
1293 * _in_ a call from the code we'd be calling back
1294 * to, so we'd have to make half the SSH code
1295 * reentrant. Instead we flag a pending error on
1296 * the socket, to be dealt with (by calling
1297 * plug_closing()) at some suitable future moment.
1299 s
->pending_error
= err
;
1302 /* We're inside the Windows frontend here, so we know
1303 * that the frontend handle is unnecessary. */
1304 logevent(NULL
, winsock_error_string(err
));
1305 fatalbox("%s", winsock_error_string(err
));
1308 if (s
->sending_oob
) {
1310 memmove(s
->oobdata
, s
->oobdata
+nsent
, len
-nsent
);
1311 s
->sending_oob
= len
- nsent
;
1316 bufchain_consume(&s
->output_data
, nsent
);
1322 static int sk_tcp_write(Socket sock
, const char *buf
, int len
)
1324 Actual_Socket s
= (Actual_Socket
) sock
;
1327 * Add the data to the buffer list on the socket.
1329 bufchain_add(&s
->output_data
, buf
, len
);
1332 * Now try sending from the start of the buffer list.
1337 return bufchain_size(&s
->output_data
);
1340 static int sk_tcp_write_oob(Socket sock
, const char *buf
, int len
)
1342 Actual_Socket s
= (Actual_Socket
) sock
;
1345 * Replace the buffer list on the socket with the data.
1347 bufchain_clear(&s
->output_data
);
1348 assert(len
<= sizeof(s
->oobdata
));
1349 memcpy(s
->oobdata
, buf
, len
);
1350 s
->sending_oob
= len
;
1353 * Now try sending from the start of the buffer list.
1358 return s
->sending_oob
;
1361 int select_result(WPARAM wParam
, LPARAM lParam
)
1365 char buf
[20480]; /* nice big buffer for plenty of speed */
1369 /* wParam is the socket itself */
1372 return 1; /* boggle */
1374 s
= find234(sktree
, (void *) wParam
, cmpforsearch
);
1376 return 1; /* boggle */
1378 if ((err
= WSAGETSELECTERROR(lParam
)) != 0) {
1380 * An error has occurred on this socket. Pass it to the
1384 plug_log(s
->plug
, 1, s
->addr
, s
->port
,
1385 winsock_error_string(err
), err
);
1386 while (s
->addr
&& sk_nextaddr(s
->addr
, &s
->step
)) {
1387 err
= try_connect(s
);
1391 return plug_closing(s
->plug
, winsock_error_string(err
), err
, 0);
1396 noise_ultralight(lParam
);
1398 switch (WSAGETSELECTEVENT(lParam
)) {
1400 s
->connected
= s
->writable
= 1;
1402 * Once a socket is connected, we can stop falling
1403 * back through the candidate addresses to connect
1407 sk_addr_free(s
->addr
);
1412 /* In the case the socket is still frozen, we don't even bother */
1414 s
->frozen_readable
= 1;
1419 * We have received data on the socket. For an oobinline
1420 * socket, this might be data _before_ an urgent pointer,
1421 * in which case we send it to the back end with type==1
1422 * (data prior to urgent).
1426 p_ioctlsocket(s
->s
, SIOCATMARK
, &atmark
);
1428 * Avoid checking the return value from ioctlsocket(),
1429 * on the grounds that some WinSock wrappers don't
1430 * support it. If it does nothing, we get atmark==1,
1431 * which is equivalent to `no OOB pending', so the
1432 * effect will be to non-OOB-ify any OOB data.
1437 ret
= p_recv(s
->s
, buf
, sizeof(buf
), 0);
1438 noise_ultralight(ret
);
1440 err
= p_WSAGetLastError();
1441 if (err
== WSAEWOULDBLOCK
) {
1446 return plug_closing(s
->plug
, winsock_error_string(err
), err
,
1448 } else if (0 == ret
) {
1449 return plug_closing(s
->plug
, NULL
, 0, 0);
1451 return plug_receive(s
->plug
, atmark ?
0 : 1, buf
, ret
);
1456 * This will only happen on a non-oobinline socket. It
1457 * indicates that we can immediately perform an OOB read
1458 * and get back OOB data, which we will send to the back
1459 * end with type==2 (urgent data).
1461 ret
= p_recv(s
->s
, buf
, sizeof(buf
), MSG_OOB
);
1462 noise_ultralight(ret
);
1464 char *str
= (ret
== 0 ?
"Internal networking trouble" :
1465 winsock_error_string(p_WSAGetLastError()));
1466 /* We're inside the Windows frontend here, so we know
1467 * that the frontend handle is unnecessary. */
1468 logevent(NULL
, str
);
1469 fatalbox("%s", str
);
1471 return plug_receive(s
->plug
, 2, buf
, ret
);
1476 int bufsize_before
, bufsize_after
;
1478 bufsize_before
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1480 bufsize_after
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1481 if (bufsize_after
< bufsize_before
)
1482 plug_sent(s
->plug
, bufsize_after
);
1486 /* Signal a close on the socket. First read any outstanding data. */
1489 ret
= p_recv(s
->s
, buf
, sizeof(buf
), 0);
1491 err
= p_WSAGetLastError();
1492 if (err
== WSAEWOULDBLOCK
)
1494 return plug_closing(s
->plug
, winsock_error_string(err
),
1498 open
&= plug_receive(s
->plug
, 0, buf
, ret
);
1500 open
&= plug_closing(s
->plug
, NULL
, 0, 0);
1507 struct sockaddr_in isa
;
1509 struct sockaddr_storage isa
;
1511 int addrlen
= sizeof(isa
);
1512 SOCKET t
; /* socket of connection */
1514 memset(&isa
, 0, sizeof(isa
));
1516 t
= p_accept(s
->s
,(struct sockaddr
*)&isa
,&addrlen
);
1517 if (t
== INVALID_SOCKET
)
1519 err
= p_WSAGetLastError();
1520 if (err
== WSATRY_AGAIN
)
1524 if (isa
.ss_family
== AF_INET
&&
1525 s
->localhost_only
&&
1526 !ipv4_is_local_addr(((struct sockaddr_in
*)&isa
)->sin_addr
))
1528 if (s
->localhost_only
&& !ipv4_is_local_addr(isa
.sin_addr
))
1531 p_closesocket(t
); /* dodgy WinSock let nonlocal through */
1532 } else if (plug_accepting(s
->plug
, (void*)t
)) {
1533 p_closesocket(t
); /* denied or error */
1542 * Deal with socket errors detected in try_send().
1544 void net_pending_errors(void)
1550 * This might be a fiddly business, because it's just possible
1551 * that handling a pending error on one socket might cause
1552 * others to be closed. (I can't think of any reason this might
1553 * happen in current SSH implementation, but to maintain
1554 * generality of this network layer I'll assume the worst.)
1556 * So what we'll do is search the socket list for _one_ socket
1557 * with a pending error, and then handle it, and then search
1558 * the list again _from the beginning_. Repeat until we make a
1559 * pass with no socket errors present. That way we are
1560 * protected against the socket list changing under our feet.
1564 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
1565 if (s
->pending_error
) {
1567 * An error has occurred on this socket. Pass it to the
1570 plug_closing(s
->plug
,
1571 winsock_error_string(s
->pending_error
),
1572 s
->pending_error
, 0);
1580 * Each socket abstraction contains a `void *' private field in
1581 * which the client can keep state.
1583 static void sk_tcp_set_private_ptr(Socket sock
, void *ptr
)
1585 Actual_Socket s
= (Actual_Socket
) sock
;
1586 s
->private_ptr
= ptr
;
1589 static void *sk_tcp_get_private_ptr(Socket sock
)
1591 Actual_Socket s
= (Actual_Socket
) sock
;
1592 return s
->private_ptr
;
1596 * Special error values are returned from sk_namelookup and sk_new
1597 * if there's a problem. These functions extract an error message,
1598 * or return NULL if there's no problem.
1600 const char *sk_addr_error(SockAddr addr
)
1604 static const char *sk_tcp_socket_error(Socket sock
)
1606 Actual_Socket s
= (Actual_Socket
) sock
;
1610 static void sk_tcp_set_frozen(Socket sock
, int is_frozen
)
1612 Actual_Socket s
= (Actual_Socket
) sock
;
1613 if (s
->frozen
== is_frozen
)
1615 s
->frozen
= is_frozen
;
1618 if (s
->frozen_readable
) {
1620 p_recv(s
->s
, &c
, 1, MSG_PEEK
);
1623 s
->frozen_readable
= 0;
1626 void socket_reselect_all(void)
1631 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
1638 * For Plink: enumerate all sockets currently active.
1640 SOCKET
first_socket(int *state
)
1644 s
= index234(sktree
, (*state
)++);
1645 return s ? s
->s
: INVALID_SOCKET
;
1648 SOCKET
next_socket(int *state
)
1650 Actual_Socket s
= index234(sktree
, (*state
)++);
1651 return s ? s
->s
: INVALID_SOCKET
;
1654 extern int socket_writable(SOCKET skt
)
1656 Actual_Socket s
= find234(sktree
, (void *)skt
, cmpforsearch
);
1659 return bufchain_size(&s
->output_data
) > 0;
1664 int net_service_lookup(char *service
)
1667 se
= p_getservbyname(service
, NULL
);
1669 return p_ntohs(se
->s_port
);
1674 SockAddr
platform_get_x11_unix_address(const char *display
, int displaynum
,
1675 char **canonicalname
)
1677 SockAddr ret
= snew(struct SockAddr_tag
);
1678 memset(ret
, 0, sizeof(struct SockAddr_tag
));
1679 ret
->error
= "unix sockets not supported on this platform";