2 * Windows networking abstraction.
4 * For the IPv6 code in here I am indebted to Jeroen Massar and
12 #define DEFINE_PLUG_METHOD_MACROS
20 const struct in6_addr in6addr_any
= IN6ADDR_ANY_INIT
;
21 const struct in6_addr in6addr_loopback
= IN6ADDR_LOOPBACK_INIT
;
24 #define ipv4_is_loopback(addr) \
25 ((p_ntohl(addr.s_addr) & 0xFF000000L) == 0x7F000000L)
28 * We used to typedef struct Socket_tag *Socket.
30 * Since we have made the networking abstraction slightly more
31 * abstract, Socket no longer means a tcp socket (it could mean
32 * an ssl socket). So now we must use Actual_Socket when we know
33 * we are talking about a tcp socket.
35 typedef struct Socket_tag
*Actual_Socket
;
38 * Mutable state that goes with a SockAddr: stores information
39 * about where in the list of candidate IP(v*) addresses we've
42 typedef struct SockAddrStep_tag SockAddrStep
;
43 struct SockAddrStep_tag
{
45 struct addrinfo
*ai
; /* steps along addr->ais */
51 const struct socket_function_table
*fn
;
52 /* the above variable absolutely *must* be the first in this structure */
60 int frozen
; /* this causes readability notifications to be ignored */
61 int frozen_readable
; /* this means we missed at least one readability
62 * notification while we were frozen */
63 int localhost_only
; /* for listening sockets */
66 int oobinline
, nodelay
, keepalive
, privport
;
70 int pending_error
; /* in case send() returns error */
72 * We sometimes need pairs of Socket structures to be linked:
73 * if we are listening on the same IPv6 and v4 port, for
74 * example. So here we define `parent' and `child' pointers to
77 Actual_Socket parent
, child
;
85 struct addrinfo
*ais
; /* Addresses IPv6 style. */
87 unsigned long *addresses
; /* Addresses IPv4 style. */
89 char hostname
[512]; /* Store an unresolved host name. */
93 * Which address family this address belongs to. AF_INET for IPv4;
94 * AF_INET6 for IPv6; AF_UNSPEC indicates that name resolution has
95 * not been done and a simple host name is held in this SockAddr
99 #define SOCKADDR_FAMILY(addr, step) \
100 (!(addr)->resolved ? AF_UNSPEC : \
101 (step).ai ? (step).ai->ai_family : AF_INET)
103 #define SOCKADDR_FAMILY(addr, step) \
104 (!(addr)->resolved ? AF_UNSPEC : AF_INET)
108 * Start a SockAddrStep structure to step through multiple
112 #define START_STEP(addr, step) \
113 ((step).ai = (addr)->ais, (step).curraddr = 0)
115 #define START_STEP(addr, step) \
116 ((step).curraddr = 0)
119 static tree234
*sktree
;
121 static int cmpfortree(void *av
, void *bv
)
123 Actual_Socket a
= (Actual_Socket
) av
, b
= (Actual_Socket
) bv
;
124 unsigned long as
= (unsigned long) a
->s
, bs
= (unsigned long) b
->s
;
136 static int cmpforsearch(void *av
, void *bv
)
138 Actual_Socket b
= (Actual_Socket
) bv
;
139 unsigned long as
= (unsigned long) av
, bs
= (unsigned long) b
->s
;
148 #define DECL_WINSOCK_FUNCTION(linkage, rettype, name, params) \
149 typedef rettype (WINAPI *t_##name) params; \
150 linkage t_##name p_##name
151 #define GET_WINSOCK_FUNCTION(module, name) \
152 p_##name = module ? (t_##name) GetProcAddress(module, #name) : NULL
154 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAAsyncSelect
,
155 (SOCKET
, HWND
, u_int
, long));
156 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAEventSelect
, (SOCKET
, WSAEVENT
, long));
157 DECL_WINSOCK_FUNCTION(NOTHING
, int, select
,
158 (int, fd_set FAR
*, fd_set FAR
*,
159 fd_set FAR
*, const struct timeval FAR
*));
160 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAGetLastError
, (void));
161 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAEnumNetworkEvents
,
162 (SOCKET
, WSAEVENT
, LPWSANETWORKEVENTS
));
163 DECL_WINSOCK_FUNCTION(static, int, WSAStartup
, (WORD
, LPWSADATA
));
164 DECL_WINSOCK_FUNCTION(static, int, WSACleanup
, (void));
165 DECL_WINSOCK_FUNCTION(static, int, closesocket
, (SOCKET
));
166 DECL_WINSOCK_FUNCTION(static, u_long
, ntohl
, (u_long
));
167 DECL_WINSOCK_FUNCTION(static, u_long
, htonl
, (u_long
));
168 DECL_WINSOCK_FUNCTION(static, u_short
, htons
, (u_short
));
169 DECL_WINSOCK_FUNCTION(static, u_short
, ntohs
, (u_short
));
170 DECL_WINSOCK_FUNCTION(static, int, gethostname
, (char *, int));
171 DECL_WINSOCK_FUNCTION(static, struct hostent FAR
*, gethostbyname
,
173 DECL_WINSOCK_FUNCTION(static, struct servent FAR
*, getservbyname
,
174 (const char FAR
*, const char FAR
*));
175 DECL_WINSOCK_FUNCTION(static, unsigned long, inet_addr
, (const char FAR
*));
176 DECL_WINSOCK_FUNCTION(static, char FAR
*, inet_ntoa
, (struct in_addr
));
177 DECL_WINSOCK_FUNCTION(static, int, connect
,
178 (SOCKET
, const struct sockaddr FAR
*, int));
179 DECL_WINSOCK_FUNCTION(static, int, bind
,
180 (SOCKET
, const struct sockaddr FAR
*, int));
181 DECL_WINSOCK_FUNCTION(static, int, setsockopt
,
182 (SOCKET
, int, int, const char FAR
*, int));
183 DECL_WINSOCK_FUNCTION(static, SOCKET
, socket
, (int, int, int));
184 DECL_WINSOCK_FUNCTION(static, int, listen
, (SOCKET
, int));
185 DECL_WINSOCK_FUNCTION(static, int, send
, (SOCKET
, const char FAR
*, int, int));
186 DECL_WINSOCK_FUNCTION(static, int, ioctlsocket
,
187 (SOCKET
, long, u_long FAR
*));
188 DECL_WINSOCK_FUNCTION(static, SOCKET
, accept
,
189 (SOCKET
, struct sockaddr FAR
*, int FAR
*));
190 DECL_WINSOCK_FUNCTION(static, int, recv
, (SOCKET
, char FAR
*, int, int));
191 DECL_WINSOCK_FUNCTION(static, int, WSAIoctl
,
192 (SOCKET
, DWORD
, LPVOID
, DWORD
, LPVOID
, DWORD
,
193 LPDWORD
, LPWSAOVERLAPPED
,
194 LPWSAOVERLAPPED_COMPLETION_ROUTINE
));
196 DECL_WINSOCK_FUNCTION(static, int, getaddrinfo
,
197 (const char *nodename
, const char *servname
,
198 const struct addrinfo
*hints
, struct addrinfo
**res
));
199 DECL_WINSOCK_FUNCTION(static, void, freeaddrinfo
, (struct addrinfo
*res
));
200 DECL_WINSOCK_FUNCTION(static, int, getnameinfo
,
201 (const struct sockaddr FAR
* sa
, socklen_t salen
,
202 char FAR
* host
, size_t hostlen
, char FAR
* serv
,
203 size_t servlen
, int flags
));
204 DECL_WINSOCK_FUNCTION(static, char *, gai_strerror
, (int ecode
));
205 DECL_WINSOCK_FUNCTION(static, int, WSAAddressToStringA
,
206 (LPSOCKADDR
, DWORD
, LPWSAPROTOCOL_INFO
,
210 static HMODULE winsock_module
= NULL
;
211 static WSADATA wsadata
;
213 static HMODULE winsock2_module
= NULL
;
214 static HMODULE wship6_module
= NULL
;
217 int sk_startup(int hi
, int lo
)
221 winsock_ver
= MAKEWORD(hi
, lo
);
223 if (p_WSAStartup(winsock_ver
, &wsadata
)) {
227 if (LOBYTE(wsadata
.wVersion
) != LOBYTE(winsock_ver
)) {
231 #ifdef NET_SETUP_DIAGNOSTICS
234 sprintf(buf
, "Using WinSock %d.%d", hi
, lo
);
246 winsock_module
= LoadLibrary("WS2_32.DLL");
247 if (!winsock_module
) {
248 winsock_module
= LoadLibrary("WSOCK32.DLL");
251 fatalbox("Unable to load any WinSock library");
254 /* Check if we have getaddrinfo in Winsock */
255 if (GetProcAddress(winsock_module
, "getaddrinfo") != NULL
) {
256 #ifdef NET_SETUP_DIAGNOSTICS
257 logevent(NULL
, "Native WinSock IPv6 support detected");
259 GET_WINSOCK_FUNCTION(winsock_module
, getaddrinfo
);
260 GET_WINSOCK_FUNCTION(winsock_module
, freeaddrinfo
);
261 GET_WINSOCK_FUNCTION(winsock_module
, getnameinfo
);
262 GET_WINSOCK_FUNCTION(winsock_module
, gai_strerror
);
264 /* Fall back to wship6.dll for Windows 2000 */
265 wship6_module
= LoadLibrary("wship6.dll");
267 #ifdef NET_SETUP_DIAGNOSTICS
268 logevent(NULL
, "WSH IPv6 support detected");
270 GET_WINSOCK_FUNCTION(wship6_module
, getaddrinfo
);
271 GET_WINSOCK_FUNCTION(wship6_module
, freeaddrinfo
);
272 GET_WINSOCK_FUNCTION(wship6_module
, getnameinfo
);
273 GET_WINSOCK_FUNCTION(wship6_module
, gai_strerror
);
275 #ifdef NET_SETUP_DIAGNOSTICS
276 logevent(NULL
, "No IPv6 support detected");
280 GET_WINSOCK_FUNCTION(winsock2_module
, WSAAddressToStringA
);
282 #ifdef NET_SETUP_DIAGNOSTICS
283 logevent(NULL
, "PuTTY was built without IPv6 support");
287 GET_WINSOCK_FUNCTION(winsock_module
, WSAAsyncSelect
);
288 GET_WINSOCK_FUNCTION(winsock_module
, WSAEventSelect
);
289 GET_WINSOCK_FUNCTION(winsock_module
, select
);
290 GET_WINSOCK_FUNCTION(winsock_module
, WSAGetLastError
);
291 GET_WINSOCK_FUNCTION(winsock_module
, WSAEnumNetworkEvents
);
292 GET_WINSOCK_FUNCTION(winsock_module
, WSAStartup
);
293 GET_WINSOCK_FUNCTION(winsock_module
, WSACleanup
);
294 GET_WINSOCK_FUNCTION(winsock_module
, closesocket
);
295 GET_WINSOCK_FUNCTION(winsock_module
, ntohl
);
296 GET_WINSOCK_FUNCTION(winsock_module
, htonl
);
297 GET_WINSOCK_FUNCTION(winsock_module
, htons
);
298 GET_WINSOCK_FUNCTION(winsock_module
, ntohs
);
299 GET_WINSOCK_FUNCTION(winsock_module
, gethostname
);
300 GET_WINSOCK_FUNCTION(winsock_module
, gethostbyname
);
301 GET_WINSOCK_FUNCTION(winsock_module
, getservbyname
);
302 GET_WINSOCK_FUNCTION(winsock_module
, inet_addr
);
303 GET_WINSOCK_FUNCTION(winsock_module
, inet_ntoa
);
304 GET_WINSOCK_FUNCTION(winsock_module
, connect
);
305 GET_WINSOCK_FUNCTION(winsock_module
, bind
);
306 GET_WINSOCK_FUNCTION(winsock_module
, setsockopt
);
307 GET_WINSOCK_FUNCTION(winsock_module
, socket
);
308 GET_WINSOCK_FUNCTION(winsock_module
, listen
);
309 GET_WINSOCK_FUNCTION(winsock_module
, send
);
310 GET_WINSOCK_FUNCTION(winsock_module
, ioctlsocket
);
311 GET_WINSOCK_FUNCTION(winsock_module
, accept
);
312 GET_WINSOCK_FUNCTION(winsock_module
, recv
);
313 GET_WINSOCK_FUNCTION(winsock_module
, WSAIoctl
);
315 /* Try to get the best WinSock version we can get */
316 if (!sk_startup(2,2) &&
319 fatalbox("Unable to initialise WinSock");
322 sktree
= newtree234(cmpfortree
);
325 void sk_cleanup(void)
331 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
340 FreeLibrary(winsock_module
);
343 FreeLibrary(wship6_module
);
347 char *winsock_error_string(int error
)
351 return "Network error: Permission denied";
353 return "Network error: Address already in use";
354 case WSAEADDRNOTAVAIL
:
355 return "Network error: Cannot assign requested address";
356 case WSAEAFNOSUPPORT
:
358 "Network error: Address family not supported by protocol family";
360 return "Network error: Operation already in progress";
361 case WSAECONNABORTED
:
362 return "Network error: Software caused connection abort";
363 case WSAECONNREFUSED
:
364 return "Network error: Connection refused";
366 return "Network error: Connection reset by peer";
367 case WSAEDESTADDRREQ
:
368 return "Network error: Destination address required";
370 return "Network error: Bad address";
372 return "Network error: Host is down";
373 case WSAEHOSTUNREACH
:
374 return "Network error: No route to host";
376 return "Network error: Operation now in progress";
378 return "Network error: Interrupted function call";
380 return "Network error: Invalid argument";
382 return "Network error: Socket is already connected";
384 return "Network error: Too many open files";
386 return "Network error: Message too long";
388 return "Network error: Network is down";
390 return "Network error: Network dropped connection on reset";
392 return "Network error: Network is unreachable";
394 return "Network error: No buffer space available";
396 return "Network error: Bad protocol option";
398 return "Network error: Socket is not connected";
400 return "Network error: Socket operation on non-socket";
402 return "Network error: Operation not supported";
403 case WSAEPFNOSUPPORT
:
404 return "Network error: Protocol family not supported";
406 return "Network error: Too many processes";
407 case WSAEPROTONOSUPPORT
:
408 return "Network error: Protocol not supported";
410 return "Network error: Protocol wrong type for socket";
412 return "Network error: Cannot send after socket shutdown";
413 case WSAESOCKTNOSUPPORT
:
414 return "Network error: Socket type not supported";
416 return "Network error: Connection timed out";
418 return "Network error: Resource temporarily unavailable";
420 return "Network error: Graceful shutdown in progress";
422 return "Unknown network error";
426 SockAddr
sk_namelookup(const char *host
, char **canonicalname
,
429 SockAddr ret
= snew(struct SockAddr_tag
);
431 struct hostent
*h
= NULL
;
436 /* Default to IPv4. */
437 hint_family
= (address_family
== ADDRTYPE_IPV4 ? AF_INET
:
439 address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
443 /* Clear the structure and default to IPv4. */
444 memset(ret
, 0, sizeof(struct SockAddr_tag
));
448 ret
->addresses
= NULL
;
449 ret
->resolved
= FALSE
;
453 if ((a
= p_inet_addr(host
)) == (unsigned long) INADDR_NONE
) {
456 * Use getaddrinfo when it's available
459 struct addrinfo hints
;
460 #ifdef NET_SETUP_DIAGNOSTICS
461 logevent(NULL
, "Using getaddrinfo() for resolving");
463 memset(&hints
, 0, sizeof(hints
));
464 hints
.ai_family
= hint_family
;
465 hints
.ai_flags
= AI_CANONNAME
;
466 if ((err
= p_getaddrinfo(host
, NULL
, &hints
, &ret
->ais
)) == 0)
467 ret
->resolved
= TRUE
;
471 #ifdef NET_SETUP_DIAGNOSTICS
472 logevent(NULL
, "Using gethostbyname() for resolving");
475 * Otherwise use the IPv4-only gethostbyname...
476 * (NOTE: we don't use gethostbyname as a fallback!)
478 if ( (h
= p_gethostbyname(host
)) )
479 ret
->resolved
= TRUE
;
481 err
= p_WSAGetLastError();
484 if (!ret
->resolved
) {
485 ret
->error
= (err
== WSAENETDOWN ?
"Network is down" :
486 err
== WSAHOST_NOT_FOUND ?
"Host does not exist" :
487 err
== WSATRY_AGAIN ?
"Host not found" :
489 p_getaddrinfo
&&p_gai_strerror ?
p_gai_strerror(err
) :
491 "gethostbyname: unknown error");
496 /* If we got an address info use that... */
498 /* Are we in IPv4 fallback mode? */
499 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
500 if (ret
->ais
->ai_family
== AF_INET
)
502 (char *) &((SOCKADDR_IN
*) ret
->ais
->
503 ai_addr
)->sin_addr
, sizeof(a
));
505 if (ret
->ais
->ai_canonname
)
506 strncpy(realhost
, ret
->ais
->ai_canonname
, lenof(realhost
));
508 strncpy(realhost
, host
, lenof(realhost
));
510 /* We used the IPv4-only gethostbyname()... */
515 for (n
= 0; h
->h_addr_list
[n
]; n
++);
516 ret
->addresses
= snewn(n
, unsigned long);
518 for (n
= 0; n
< ret
->naddresses
; n
++) {
519 memcpy(&a
, h
->h_addr_list
[n
], sizeof(a
));
520 ret
->addresses
[n
] = p_ntohl(a
);
522 memcpy(&a
, h
->h_addr
, sizeof(a
));
523 /* This way we are always sure the h->h_name is valid :) */
524 strncpy(realhost
, h
->h_name
, sizeof(realhost
));
529 * This must be a numeric IPv4 address because it caused a
530 * success return from inet_addr.
532 ret
->addresses
= snewn(1, unsigned long);
534 ret
->addresses
[0] = p_ntohl(a
);
535 ret
->resolved
= TRUE
;
536 strncpy(realhost
, host
, sizeof(realhost
));
538 realhost
[lenof(realhost
)-1] = '\0';
539 *canonicalname
= snewn(1+strlen(realhost
), char);
540 strcpy(*canonicalname
, realhost
);
544 SockAddr
sk_nonamelookup(const char *host
)
546 SockAddr ret
= snew(struct SockAddr_tag
);
548 ret
->resolved
= FALSE
;
552 ret
->addresses
= NULL
;
555 strncpy(ret
->hostname
, host
, lenof(ret
->hostname
));
556 ret
->hostname
[lenof(ret
->hostname
)-1] = '\0';
560 int sk_nextaddr(SockAddr addr
, SockAddrStep
*step
)
564 if (step
->ai
->ai_next
) {
565 step
->ai
= step
->ai
->ai_next
;
571 if (step
->curraddr
+1 < addr
->naddresses
) {
579 void sk_getaddr(SockAddr addr
, char *buf
, int buflen
)
582 START_STEP(addr
, step
);
586 if (p_WSAAddressToStringA
) {
587 p_WSAAddressToStringA(step
.ai
->ai_addr
, step
.ai
->ai_addrlen
,
590 strncpy(buf
, "IPv6", buflen
);
593 if (SOCKADDR_FAMILY(addr
, step
) == AF_INET
) {
595 assert(addr
->addresses
&& step
.curraddr
< addr
->naddresses
);
596 a
.s_addr
= p_htonl(addr
->addresses
[step
.curraddr
]);
597 strncpy(buf
, p_inet_ntoa(a
), buflen
);
598 buf
[buflen
-1] = '\0';
600 strncpy(buf
, addr
->hostname
, buflen
);
601 buf
[buflen
-1] = '\0';
605 int sk_hostname_is_local(char *name
)
607 return !strcmp(name
, "localhost") ||
608 !strcmp(name
, "::1") ||
609 !strncmp(name
, "127.", 4);
612 static INTERFACE_INFO local_interfaces
[16];
613 static int n_local_interfaces
; /* 0=not yet, -1=failed, >0=number */
615 static int ipv4_is_local_addr(struct in_addr addr
)
617 if (ipv4_is_loopback(addr
))
618 return 1; /* loopback addresses are local */
619 if (!n_local_interfaces
) {
620 SOCKET s
= p_socket(AF_INET
, SOCK_DGRAM
, 0);
624 p_WSAIoctl(s
, SIO_GET_INTERFACE_LIST
, NULL
, 0,
625 local_interfaces
, sizeof(local_interfaces
),
626 &retbytes
, NULL
, NULL
) == 0)
627 n_local_interfaces
= retbytes
/ sizeof(INTERFACE_INFO
);
629 logevent(NULL
, "Unable to get list of local IP addresses");
631 if (n_local_interfaces
> 0) {
633 for (i
= 0; i
< n_local_interfaces
; i
++) {
634 SOCKADDR_IN
*address
=
635 (SOCKADDR_IN
*)&local_interfaces
[i
].iiAddress
;
636 if (address
->sin_addr
.s_addr
== addr
.s_addr
)
637 return 1; /* this address is local */
640 return 0; /* this address is not local */
643 int sk_address_is_local(SockAddr addr
)
647 START_STEP(addr
, step
);
648 family
= SOCKADDR_FAMILY(addr
, step
);
651 if (family
== AF_INET6
) {
652 return IN6_IS_ADDR_LOOPBACK((const struct in6_addr
*)step
.ai
->ai_addr
);
655 if (family
== AF_INET
) {
658 return ipv4_is_local_addr(((struct sockaddr_in
*)step
.ai
->ai_addr
)
664 assert(addr
->addresses
&& step
.curraddr
< addr
->naddresses
);
665 a
.s_addr
= p_htonl(addr
->addresses
[step
.curraddr
]);
666 return ipv4_is_local_addr(a
);
669 assert(family
== AF_UNSPEC
);
670 return 0; /* we don't know; assume not */
674 int sk_addrtype(SockAddr addr
)
678 START_STEP(addr
, step
);
679 family
= SOCKADDR_FAMILY(addr
, step
);
681 return (family
== AF_INET ? ADDRTYPE_IPV4
:
683 family
== AF_INET6 ? ADDRTYPE_IPV6
:
688 void sk_addrcopy(SockAddr addr
, char *buf
)
692 START_STEP(addr
, step
);
693 family
= SOCKADDR_FAMILY(addr
, step
);
695 assert(family
!= AF_UNSPEC
);
698 if (family
== AF_INET
)
699 memcpy(buf
, &((struct sockaddr_in
*)step
.ai
->ai_addr
)->sin_addr
,
700 sizeof(struct in_addr
));
701 else if (family
== AF_INET6
)
702 memcpy(buf
, &((struct sockaddr_in6
*)step
.ai
->ai_addr
)->sin6_addr
,
703 sizeof(struct in6_addr
));
708 if (family
== AF_INET
) {
710 assert(addr
->addresses
&& step
.curraddr
< addr
->naddresses
);
711 a
.s_addr
= p_htonl(addr
->addresses
[step
.curraddr
]);
712 memcpy(buf
, (char*) &a
.s_addr
, 4);
716 void sk_addr_free(SockAddr addr
)
718 if (--addr
->refcount
> 0)
721 if (addr
->ais
&& p_freeaddrinfo
)
722 p_freeaddrinfo(addr
->ais
);
725 sfree(addr
->addresses
);
729 SockAddr
sk_addr_dup(SockAddr addr
)
735 static Plug
sk_tcp_plug(Socket sock
, Plug p
)
737 Actual_Socket s
= (Actual_Socket
) sock
;
744 static void sk_tcp_flush(Socket s
)
747 * We send data to the socket as soon as we can anyway,
748 * so we don't need to do anything here. :-)
752 static void sk_tcp_close(Socket s
);
753 static int sk_tcp_write(Socket s
, const char *data
, int len
);
754 static int sk_tcp_write_oob(Socket s
, const char *data
, int len
);
755 static void sk_tcp_set_private_ptr(Socket s
, void *ptr
);
756 static void *sk_tcp_get_private_ptr(Socket s
);
757 static void sk_tcp_set_frozen(Socket s
, int is_frozen
);
758 static const char *sk_tcp_socket_error(Socket s
);
760 extern char *do_select(SOCKET skt
, int startup
);
762 Socket
sk_register(void *sock
, Plug plug
)
764 static const struct socket_function_table fn_table
= {
770 sk_tcp_set_private_ptr
,
771 sk_tcp_get_private_ptr
,
781 * Create Socket structure.
783 ret
= snew(struct Socket_tag
);
787 bufchain_init(&ret
->output_data
);
788 ret
->writable
= 1; /* to start with */
789 ret
->sending_oob
= 0;
791 ret
->frozen_readable
= 0;
792 ret
->localhost_only
= 0; /* unused, but best init anyway */
793 ret
->pending_error
= 0;
794 ret
->parent
= ret
->child
= NULL
;
797 ret
->s
= (SOCKET
)sock
;
799 if (ret
->s
== INVALID_SOCKET
) {
800 err
= p_WSAGetLastError();
801 ret
->error
= winsock_error_string(err
);
807 /* Set up a select mechanism. This could be an AsyncSelect on a
808 * window, or an EventSelect on an event object. */
809 errstr
= do_select(ret
->s
, 1);
820 static DWORD
try_connect(Actual_Socket sock
)
832 if (sock
->s
!= INVALID_SOCKET
) {
833 do_select(sock
->s
, 0);
834 p_closesocket(sock
->s
);
837 plug_log(sock
->plug
, 0, sock
->addr
, sock
->port
, NULL
, 0);
842 family
= SOCKADDR_FAMILY(sock
->addr
, sock
->step
);
845 * Remove the socket from the tree before we overwrite its
846 * internal socket id, because that forms part of the tree's
847 * sorting criterion. We'll add it back before exiting this
848 * function, whether we changed anything or not.
850 del234(sktree
, sock
);
852 s
= p_socket(family
, SOCK_STREAM
, 0);
855 if (s
== INVALID_SOCKET
) {
856 err
= p_WSAGetLastError();
857 sock
->error
= winsock_error_string(err
);
861 if (sock
->oobinline
) {
863 p_setsockopt(s
, SOL_SOCKET
, SO_OOBINLINE
, (void *) &b
, sizeof(b
));
868 p_setsockopt(s
, IPPROTO_TCP
, TCP_NODELAY
, (void *) &b
, sizeof(b
));
871 if (sock
->keepalive
) {
873 p_setsockopt(s
, SOL_SOCKET
, SO_KEEPALIVE
, (void *) &b
, sizeof(b
));
877 * Bind to local address.
880 localport
= 1023; /* count from 1023 downwards */
882 localport
= 0; /* just use port 0 (ie winsock picks) */
884 /* Loop round trying to bind */
889 if (family
== AF_INET6
) {
890 memset(&a6
, 0, sizeof(a6
));
891 a6
.sin6_family
= AF_INET6
;
892 /*a6.sin6_addr = in6addr_any; */ /* == 0 done by memset() */
893 a6
.sin6_port
= p_htons(localport
);
897 a
.sin_family
= AF_INET
;
898 a
.sin_addr
.s_addr
= p_htonl(INADDR_ANY
);
899 a
.sin_port
= p_htons(localport
);
902 sockcode
= p_bind(s
, (family
== AF_INET6 ?
903 (struct sockaddr
*) &a6
:
904 (struct sockaddr
*) &a
),
905 (family
== AF_INET6 ?
sizeof(a6
) : sizeof(a
)));
907 sockcode
= p_bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
909 if (sockcode
!= SOCKET_ERROR
) {
913 err
= p_WSAGetLastError();
914 if (err
!= WSAEADDRINUSE
) /* failed, for a bad reason */
919 break; /* we're only looping once */
922 break; /* we might have got to the end */
926 sock
->error
= winsock_error_string(err
);
931 * Connect to remote address.
935 if (family
== AF_INET6
) {
936 a6
.sin6_family
= AF_INET6
;
937 a6
.sin6_port
= p_htons((short) sock
->port
);
939 ((struct sockaddr_in6
*) sock
->step
.ai
->ai_addr
)->sin6_addr
;
940 a6
.sin6_flowinfo
= ((struct sockaddr_in6
*) sock
->step
.ai
->ai_addr
)->sin6_flowinfo
;
941 a6
.sin6_scope_id
= ((struct sockaddr_in6
*) sock
->step
.ai
->ai_addr
)->sin6_scope_id
;
943 a
.sin_family
= AF_INET
;
945 ((struct sockaddr_in
*) sock
->step
.ai
->ai_addr
)->sin_addr
;
946 a
.sin_port
= p_htons((short) sock
->port
);
951 assert(sock
->addr
->addresses
&& sock
->step
.curraddr
< sock
->addr
->naddresses
);
952 a
.sin_family
= AF_INET
;
953 a
.sin_addr
.s_addr
= p_htonl(sock
->addr
->addresses
[sock
->step
.curraddr
]);
954 a
.sin_port
= p_htons((short) sock
->port
);
957 /* Set up a select mechanism. This could be an AsyncSelect on a
958 * window, or an EventSelect on an event object. */
959 errstr
= do_select(s
, 1);
961 sock
->error
= errstr
;
969 ((family
== AF_INET6
) ?
(struct sockaddr
*) &a6
:
970 (struct sockaddr
*) &a
),
971 (family
== AF_INET6
) ?
sizeof(a6
) : sizeof(a
))
973 p_connect(s
, (struct sockaddr
*) &a
, sizeof(a
))
976 err
= p_WSAGetLastError();
978 * We expect a potential EWOULDBLOCK here, because the
979 * chances are the front end has done a select for
980 * FD_CONNECT, so that connect() will complete
983 if ( err
!= WSAEWOULDBLOCK
) {
984 sock
->error
= winsock_error_string(err
);
989 * If we _don't_ get EWOULDBLOCK, the connect has completed
990 * and we should set the socket as writable.
1000 * No matter what happened, put the socket back in the tree.
1002 add234(sktree
, sock
);
1005 plug_log(sock
->plug
, 1, sock
->addr
, sock
->port
, sock
->error
, err
);
1009 Socket
sk_new(SockAddr addr
, int port
, int privport
, int oobinline
,
1010 int nodelay
, int keepalive
, Plug plug
)
1012 static const struct socket_function_table fn_table
= {
1018 sk_tcp_set_private_ptr
,
1019 sk_tcp_get_private_ptr
,
1028 * Create Socket structure.
1030 ret
= snew(struct Socket_tag
);
1031 ret
->fn
= &fn_table
;
1034 bufchain_init(&ret
->output_data
);
1035 ret
->connected
= 0; /* to start with */
1036 ret
->writable
= 0; /* to start with */
1037 ret
->sending_oob
= 0;
1039 ret
->frozen_readable
= 0;
1040 ret
->localhost_only
= 0; /* unused, but best init anyway */
1041 ret
->pending_error
= 0;
1042 ret
->parent
= ret
->child
= NULL
;
1043 ret
->oobinline
= oobinline
;
1044 ret
->nodelay
= nodelay
;
1045 ret
->keepalive
= keepalive
;
1046 ret
->privport
= privport
;
1049 START_STEP(ret
->addr
, ret
->step
);
1050 ret
->s
= INVALID_SOCKET
;
1054 err
= try_connect(ret
);
1055 } while (err
&& sk_nextaddr(ret
->addr
, &ret
->step
));
1057 return (Socket
) ret
;
1060 Socket
sk_newlistener(char *srcaddr
, int port
, Plug plug
, int local_host_only
,
1061 int orig_address_family
)
1063 static const struct socket_function_table fn_table
= {
1069 sk_tcp_set_private_ptr
,
1070 sk_tcp_get_private_ptr
,
1090 * Create Socket structure.
1092 ret
= snew(struct Socket_tag
);
1093 ret
->fn
= &fn_table
;
1096 bufchain_init(&ret
->output_data
);
1097 ret
->writable
= 0; /* to start with */
1098 ret
->sending_oob
= 0;
1100 ret
->frozen_readable
= 0;
1101 ret
->localhost_only
= local_host_only
;
1102 ret
->pending_error
= 0;
1103 ret
->parent
= ret
->child
= NULL
;
1107 * Translate address_family from platform-independent constants
1108 * into local reality.
1110 address_family
= (orig_address_family
== ADDRTYPE_IPV4 ? AF_INET
:
1112 orig_address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
1117 * Our default, if passed the `don't care' value
1118 * ADDRTYPE_UNSPEC, is to listen on IPv4. If IPv6 is supported,
1119 * we will also set up a second socket listening on IPv6, but
1120 * the v4 one is primary since that ought to work even on
1121 * non-v6-supporting systems.
1123 if (address_family
== AF_UNSPEC
) address_family
= AF_INET
;
1128 s
= p_socket(address_family
, SOCK_STREAM
, 0);
1131 if (s
== INVALID_SOCKET
) {
1132 err
= p_WSAGetLastError();
1133 ret
->error
= winsock_error_string(err
);
1134 return (Socket
) ret
;
1139 p_setsockopt(s
, SOL_SOCKET
, SO_REUSEADDR
, (const char *)&on
, sizeof(on
));
1142 if (address_family
== AF_INET6
) {
1143 memset(&a6
, 0, sizeof(a6
));
1144 a6
.sin6_family
= AF_INET6
;
1145 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
1146 * know how to do it. :-)
1147 * (jeroen:) saddr is specified as an address.. eg 2001:db8::1
1148 * Thus we need either a parser that understands [2001:db8::1]:80
1149 * style addresses and/or enhance this to understand hostnames too. */
1150 if (local_host_only
)
1151 a6
.sin6_addr
= in6addr_loopback
;
1153 a6
.sin6_addr
= in6addr_any
;
1154 a6
.sin6_port
= p_htons(port
);
1159 a
.sin_family
= AF_INET
;
1162 * Bind to source address. First try an explicitly
1166 a
.sin_addr
.s_addr
= p_inet_addr(srcaddr
);
1167 if (a
.sin_addr
.s_addr
!= INADDR_NONE
) {
1168 /* Override localhost_only with specified listen addr. */
1169 ret
->localhost_only
= ipv4_is_loopback(a
.sin_addr
);
1175 * ... and failing that, go with one of the standard ones.
1178 if (local_host_only
)
1179 a
.sin_addr
.s_addr
= p_htonl(INADDR_LOOPBACK
);
1181 a
.sin_addr
.s_addr
= p_htonl(INADDR_ANY
);
1184 a
.sin_port
= p_htons((short)port
);
1187 retcode
= p_bind(s
, (address_family
== AF_INET6 ?
1188 (struct sockaddr
*) &a6
:
1189 (struct sockaddr
*) &a
),
1191 AF_INET6 ?
sizeof(a6
) : sizeof(a
)));
1193 retcode
= p_bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
1195 if (retcode
!= SOCKET_ERROR
) {
1198 err
= p_WSAGetLastError();
1203 ret
->error
= winsock_error_string(err
);
1204 return (Socket
) ret
;
1208 if (p_listen(s
, SOMAXCONN
) == SOCKET_ERROR
) {
1210 ret
->error
= winsock_error_string(err
);
1211 return (Socket
) ret
;
1214 /* Set up a select mechanism. This could be an AsyncSelect on a
1215 * window, or an EventSelect on an event object. */
1216 errstr
= do_select(s
, 1);
1219 ret
->error
= errstr
;
1220 return (Socket
) ret
;
1223 add234(sktree
, ret
);
1227 * If we were given ADDRTYPE_UNSPEC, we must also create an
1228 * IPv6 listening socket and link it to this one.
1230 if (address_family
== AF_INET
&& orig_address_family
== ADDRTYPE_UNSPEC
) {
1231 Actual_Socket other
;
1233 other
= (Actual_Socket
) sk_newlistener(srcaddr
, port
, plug
,
1234 local_host_only
, ADDRTYPE_IPV6
);
1237 if (!other
->error
) {
1238 other
->parent
= ret
;
1247 return (Socket
) ret
;
1250 static void sk_tcp_close(Socket sock
)
1252 extern char *do_select(SOCKET skt
, int startup
);
1253 Actual_Socket s
= (Actual_Socket
) sock
;
1256 sk_tcp_close((Socket
)s
->child
);
1260 p_closesocket(s
->s
);
1262 sk_addr_free(s
->addr
);
1267 * The function which tries to send on a socket once it's deemed
1270 void try_send(Actual_Socket s
)
1272 while (s
->sending_oob
|| bufchain_size(&s
->output_data
) > 0) {
1276 int len
, urgentflag
;
1278 if (s
->sending_oob
) {
1279 urgentflag
= MSG_OOB
;
1280 len
= s
->sending_oob
;
1284 bufchain_prefix(&s
->output_data
, &data
, &len
);
1286 nsent
= p_send(s
->s
, data
, len
, urgentflag
);
1287 noise_ultralight(nsent
);
1289 err
= (nsent
< 0 ?
p_WSAGetLastError() : 0);
1290 if ((err
< WSABASEERR
&& nsent
< 0) || err
== WSAEWOULDBLOCK
) {
1292 * Perfectly normal: we've sent all we can for the moment.
1294 * (Some WinSock send() implementations can return
1295 * <0 but leave no sensible error indication -
1296 * WSAGetLastError() is called but returns zero or
1297 * a small number - so we check that case and treat
1298 * it just like WSAEWOULDBLOCK.)
1300 s
->writable
= FALSE
;
1302 } else if (nsent
== 0 ||
1303 err
== WSAECONNABORTED
|| err
== WSAECONNRESET
) {
1305 * If send() returns CONNABORTED or CONNRESET, we
1306 * unfortunately can't just call plug_closing(),
1307 * because it's quite likely that we're currently
1308 * _in_ a call from the code we'd be calling back
1309 * to, so we'd have to make half the SSH code
1310 * reentrant. Instead we flag a pending error on
1311 * the socket, to be dealt with (by calling
1312 * plug_closing()) at some suitable future moment.
1314 s
->pending_error
= err
;
1317 /* We're inside the Windows frontend here, so we know
1318 * that the frontend handle is unnecessary. */
1319 logevent(NULL
, winsock_error_string(err
));
1320 fatalbox("%s", winsock_error_string(err
));
1323 if (s
->sending_oob
) {
1325 memmove(s
->oobdata
, s
->oobdata
+nsent
, len
-nsent
);
1326 s
->sending_oob
= len
- nsent
;
1331 bufchain_consume(&s
->output_data
, nsent
);
1337 static int sk_tcp_write(Socket sock
, const char *buf
, int len
)
1339 Actual_Socket s
= (Actual_Socket
) sock
;
1342 * Add the data to the buffer list on the socket.
1344 bufchain_add(&s
->output_data
, buf
, len
);
1347 * Now try sending from the start of the buffer list.
1352 return bufchain_size(&s
->output_data
);
1355 static int sk_tcp_write_oob(Socket sock
, const char *buf
, int len
)
1357 Actual_Socket s
= (Actual_Socket
) sock
;
1360 * Replace the buffer list on the socket with the data.
1362 bufchain_clear(&s
->output_data
);
1363 assert(len
<= sizeof(s
->oobdata
));
1364 memcpy(s
->oobdata
, buf
, len
);
1365 s
->sending_oob
= len
;
1368 * Now try sending from the start of the buffer list.
1373 return s
->sending_oob
;
1376 int select_result(WPARAM wParam
, LPARAM lParam
)
1380 char buf
[20480]; /* nice big buffer for plenty of speed */
1384 /* wParam is the socket itself */
1387 return 1; /* boggle */
1389 s
= find234(sktree
, (void *) wParam
, cmpforsearch
);
1391 return 1; /* boggle */
1393 if ((err
= WSAGETSELECTERROR(lParam
)) != 0) {
1395 * An error has occurred on this socket. Pass it to the
1399 plug_log(s
->plug
, 1, s
->addr
, s
->port
,
1400 winsock_error_string(err
), err
);
1401 while (s
->addr
&& sk_nextaddr(s
->addr
, &s
->step
)) {
1402 err
= try_connect(s
);
1406 return plug_closing(s
->plug
, winsock_error_string(err
), err
, 0);
1411 noise_ultralight(lParam
);
1413 switch (WSAGETSELECTEVENT(lParam
)) {
1415 s
->connected
= s
->writable
= 1;
1417 * Once a socket is connected, we can stop falling
1418 * back through the candidate addresses to connect
1422 sk_addr_free(s
->addr
);
1427 /* In the case the socket is still frozen, we don't even bother */
1429 s
->frozen_readable
= 1;
1434 * We have received data on the socket. For an oobinline
1435 * socket, this might be data _before_ an urgent pointer,
1436 * in which case we send it to the back end with type==1
1437 * (data prior to urgent).
1441 p_ioctlsocket(s
->s
, SIOCATMARK
, &atmark
);
1443 * Avoid checking the return value from ioctlsocket(),
1444 * on the grounds that some WinSock wrappers don't
1445 * support it. If it does nothing, we get atmark==1,
1446 * which is equivalent to `no OOB pending', so the
1447 * effect will be to non-OOB-ify any OOB data.
1452 ret
= p_recv(s
->s
, buf
, sizeof(buf
), 0);
1453 noise_ultralight(ret
);
1455 err
= p_WSAGetLastError();
1456 if (err
== WSAEWOULDBLOCK
) {
1461 return plug_closing(s
->plug
, winsock_error_string(err
), err
,
1463 } else if (0 == ret
) {
1464 return plug_closing(s
->plug
, NULL
, 0, 0);
1466 return plug_receive(s
->plug
, atmark ?
0 : 1, buf
, ret
);
1471 * This will only happen on a non-oobinline socket. It
1472 * indicates that we can immediately perform an OOB read
1473 * and get back OOB data, which we will send to the back
1474 * end with type==2 (urgent data).
1476 ret
= p_recv(s
->s
, buf
, sizeof(buf
), MSG_OOB
);
1477 noise_ultralight(ret
);
1479 char *str
= (ret
== 0 ?
"Internal networking trouble" :
1480 winsock_error_string(p_WSAGetLastError()));
1481 /* We're inside the Windows frontend here, so we know
1482 * that the frontend handle is unnecessary. */
1483 logevent(NULL
, str
);
1484 fatalbox("%s", str
);
1486 return plug_receive(s
->plug
, 2, buf
, ret
);
1491 int bufsize_before
, bufsize_after
;
1493 bufsize_before
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1495 bufsize_after
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1496 if (bufsize_after
< bufsize_before
)
1497 plug_sent(s
->plug
, bufsize_after
);
1501 /* Signal a close on the socket. First read any outstanding data. */
1504 ret
= p_recv(s
->s
, buf
, sizeof(buf
), 0);
1506 err
= p_WSAGetLastError();
1507 if (err
== WSAEWOULDBLOCK
)
1509 return plug_closing(s
->plug
, winsock_error_string(err
),
1513 open
&= plug_receive(s
->plug
, 0, buf
, ret
);
1515 open
&= plug_closing(s
->plug
, NULL
, 0, 0);
1522 struct sockaddr_in isa
;
1524 struct sockaddr_storage isa
;
1526 int addrlen
= sizeof(isa
);
1527 SOCKET t
; /* socket of connection */
1529 memset(&isa
, 0, sizeof(isa
));
1531 t
= p_accept(s
->s
,(struct sockaddr
*)&isa
,&addrlen
);
1532 if (t
== INVALID_SOCKET
)
1534 err
= p_WSAGetLastError();
1535 if (err
== WSATRY_AGAIN
)
1539 if (isa
.ss_family
== AF_INET
&&
1540 s
->localhost_only
&&
1541 !ipv4_is_local_addr(((struct sockaddr_in
*)&isa
)->sin_addr
))
1543 if (s
->localhost_only
&& !ipv4_is_local_addr(isa
.sin_addr
))
1546 p_closesocket(t
); /* dodgy WinSock let nonlocal through */
1547 } else if (plug_accepting(s
->plug
, (void*)t
)) {
1548 p_closesocket(t
); /* denied or error */
1557 * Deal with socket errors detected in try_send().
1559 void net_pending_errors(void)
1565 * This might be a fiddly business, because it's just possible
1566 * that handling a pending error on one socket might cause
1567 * others to be closed. (I can't think of any reason this might
1568 * happen in current SSH implementation, but to maintain
1569 * generality of this network layer I'll assume the worst.)
1571 * So what we'll do is search the socket list for _one_ socket
1572 * with a pending error, and then handle it, and then search
1573 * the list again _from the beginning_. Repeat until we make a
1574 * pass with no socket errors present. That way we are
1575 * protected against the socket list changing under our feet.
1579 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
1580 if (s
->pending_error
) {
1582 * An error has occurred on this socket. Pass it to the
1585 plug_closing(s
->plug
,
1586 winsock_error_string(s
->pending_error
),
1587 s
->pending_error
, 0);
1595 * Each socket abstraction contains a `void *' private field in
1596 * which the client can keep state.
1598 static void sk_tcp_set_private_ptr(Socket sock
, void *ptr
)
1600 Actual_Socket s
= (Actual_Socket
) sock
;
1601 s
->private_ptr
= ptr
;
1604 static void *sk_tcp_get_private_ptr(Socket sock
)
1606 Actual_Socket s
= (Actual_Socket
) sock
;
1607 return s
->private_ptr
;
1611 * Special error values are returned from sk_namelookup and sk_new
1612 * if there's a problem. These functions extract an error message,
1613 * or return NULL if there's no problem.
1615 const char *sk_addr_error(SockAddr addr
)
1619 static const char *sk_tcp_socket_error(Socket sock
)
1621 Actual_Socket s
= (Actual_Socket
) sock
;
1625 static void sk_tcp_set_frozen(Socket sock
, int is_frozen
)
1627 Actual_Socket s
= (Actual_Socket
) sock
;
1628 if (s
->frozen
== is_frozen
)
1630 s
->frozen
= is_frozen
;
1633 if (s
->frozen_readable
) {
1635 p_recv(s
->s
, &c
, 1, MSG_PEEK
);
1638 s
->frozen_readable
= 0;
1641 void socket_reselect_all(void)
1646 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
1653 * For Plink: enumerate all sockets currently active.
1655 SOCKET
first_socket(int *state
)
1659 s
= index234(sktree
, (*state
)++);
1660 return s ? s
->s
: INVALID_SOCKET
;
1663 SOCKET
next_socket(int *state
)
1665 Actual_Socket s
= index234(sktree
, (*state
)++);
1666 return s ? s
->s
: INVALID_SOCKET
;
1669 extern int socket_writable(SOCKET skt
)
1671 Actual_Socket s
= find234(sktree
, (void *)skt
, cmpforsearch
);
1674 return bufchain_size(&s
->output_data
) > 0;
1679 int net_service_lookup(char *service
)
1682 se
= p_getservbyname(service
, NULL
);
1684 return p_ntohs(se
->s_port
);
1689 char *get_hostname(void)
1692 char *hostname
= NULL
;
1695 hostname
= sresize(hostname
, len
, char);
1696 if (p_gethostname(hostname
, len
) < 0) {
1701 } while (strlen(hostname
) >= len
-1);
1705 SockAddr
platform_get_x11_unix_address(const char *display
, int displaynum
,
1706 char **canonicalname
)
1708 SockAddr ret
= snew(struct SockAddr_tag
);
1709 memset(ret
, 0, sizeof(struct SockAddr_tag
));
1710 ret
->error
= "unix sockets not supported on this platform";