2 * Windows networking abstraction.
4 * Due to this clean abstraction it was possible
5 * to easily implement IPv6 support :)
7 * IPv6 patch 1 (27 October 2000) Jeroen Massar <jeroen@unfix.org>
8 * - Preliminary hacked IPv6 support.
9 * - Connecting to IPv6 address (eg fec0:4242:4242:100:2d0:b7ff:fe8f:5d42) works.
10 * - Connecting to IPv6 hostname (eg heaven.ipv6.unfix.org) works.
11 * - Compiles as either IPv4 or IPv6.
13 * IPv6 patch 2 (29 October 2000) Jeroen Massar <jeroen@unfix.org>
14 * - When compiled as IPv6 it also allows connecting to IPv4 hosts.
15 * - Added some more documentation.
17 * IPv6 patch 3 (18 November 2000) Jeroen Massar <jeroen@unfix.org>
18 * - It now supports dynamically loading the IPv6 resolver dll's.
19 * This way we should be able to distribute one (1) binary
20 * which supports both IPv4 and IPv6.
21 * - getaddrinfo() and getnameinfo() are loaded dynamicaly if possible.
22 * - in6addr_any is defined in this file so we don't need to link to wship6.lib
23 * - The patch is now more unified so that we can still
24 * remove all IPv6 support by undef'ing IPV6.
25 * But where it fallsback to IPv4 it uses the IPv4 code which is already in place...
26 * - Canonical name resolving works.
28 * IPv6 patch 4 (07 January 2001) Jeroen Massar <jeroen@unfix.org>
29 * - patch against CVS of today, will be submitted to the bugs list
30 * as a 'cvs diff -u' on Simon's request...
35 * Define IPV6 to have IPv6 on-the-fly-loading support.
36 * This means that one doesn't have to have an IPv6 stack to use it.
37 * But if an IPv6 stack is found it is used with a fallback to IPv4.
45 #define DEFINE_PLUG_METHOD_MACROS
55 #define ipv4_is_loopback(addr) \
56 ((p_ntohl(addr.s_addr) & 0xFF000000L) == 0x7F000000L)
59 const struct socket_function_table
*fn
;
60 /* the above variable absolutely *must* be the first in this structure */
68 int frozen
; /* this causes readability notifications to be ignored */
69 int frozen_readable
; /* this means we missed at least one readability
70 * notification while we were frozen */
71 int localhost_only
; /* for listening sockets */
75 int pending_error
; /* in case send() returns error */
79 * We used to typedef struct Socket_tag *Socket.
81 * Since we have made the networking abstraction slightly more
82 * abstract, Socket no longer means a tcp socket (it could mean
83 * an ssl socket). So now we must use Actual_Socket when we know
84 * we are talking about a tcp socket.
86 typedef struct Socket_tag
*Actual_Socket
;
91 * Which address family this address belongs to. AF_INET for
92 * IPv4; AF_INET6 for IPv6; AF_UNSPEC indicates that name
93 * resolution has not been done and a simple host name is held
94 * in this SockAddr structure.
97 unsigned long address
; /* Address IPv4 style. */
99 struct addrinfo
*ai
; /* Address IPv6 style. */
101 char hostname
[512]; /* Store an unresolved host name. */
104 static tree234
*sktree
;
106 static int cmpfortree(void *av
, void *bv
)
108 Actual_Socket a
= (Actual_Socket
) av
, b
= (Actual_Socket
) bv
;
109 unsigned long as
= (unsigned long) a
->s
, bs
= (unsigned long) b
->s
;
117 static int cmpforsearch(void *av
, void *bv
)
119 Actual_Socket b
= (Actual_Socket
) bv
;
120 unsigned long as
= (unsigned long) av
, bs
= (unsigned long) b
->s
;
129 #define DECL_WINSOCK_FUNCTION(linkage, rettype, name, params) \
130 typedef rettype (WINAPI *t_##name) params; \
131 linkage t_##name p_##name
132 #define GET_WINSOCK_FUNCTION(name) \
133 p_##name = (t_##name) GetProcAddress(winsock_module, #name)
135 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAAsyncSelect
,
136 (SOCKET
, HWND
, u_int
, long));
137 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAEventSelect
, (SOCKET
, WSAEVENT
, long));
138 DECL_WINSOCK_FUNCTION(NOTHING
, int, select
,
139 (int, fd_set FAR
*, fd_set FAR
*,
140 fd_set FAR
*, const struct timeval FAR
*));
141 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAGetLastError
, (void));
142 DECL_WINSOCK_FUNCTION(NOTHING
, int, WSAEnumNetworkEvents
,
143 (SOCKET
, WSAEVENT
, LPWSANETWORKEVENTS
));
144 DECL_WINSOCK_FUNCTION(static, int, WSAStartup
, (WORD
, LPWSADATA
));
145 DECL_WINSOCK_FUNCTION(static, int, WSACleanup
, (void));
146 DECL_WINSOCK_FUNCTION(static, int, closesocket
, (SOCKET
));
147 DECL_WINSOCK_FUNCTION(static, u_long
, ntohl
, (u_long
));
148 DECL_WINSOCK_FUNCTION(static, u_long
, htonl
, (u_long
));
149 DECL_WINSOCK_FUNCTION(static, u_short
, htons
, (u_short
));
150 DECL_WINSOCK_FUNCTION(static, u_short
, ntohs
, (u_short
));
151 DECL_WINSOCK_FUNCTION(static, struct hostent FAR
*, gethostbyname
,
153 DECL_WINSOCK_FUNCTION(static, struct servent FAR
*, getservbyname
,
154 (const char FAR
*, const char FAR
*));
155 DECL_WINSOCK_FUNCTION(static, unsigned long, inet_addr
, (const char FAR
*));
156 DECL_WINSOCK_FUNCTION(static, char FAR
*, inet_ntoa
, (struct in_addr
));
157 DECL_WINSOCK_FUNCTION(static, int, connect
,
158 (SOCKET
, const struct sockaddr FAR
*, int));
159 DECL_WINSOCK_FUNCTION(static, int, bind
,
160 (SOCKET
, const struct sockaddr FAR
*, int));
161 DECL_WINSOCK_FUNCTION(static, int, setsockopt
,
162 (SOCKET
, int, int, const char FAR
*, int));
163 DECL_WINSOCK_FUNCTION(static, SOCKET
, socket
, (int, int, int));
164 DECL_WINSOCK_FUNCTION(static, int, listen
, (SOCKET
, int));
165 DECL_WINSOCK_FUNCTION(static, int, send
, (SOCKET
, const char FAR
*, int, int));
166 DECL_WINSOCK_FUNCTION(static, int, ioctlsocket
,
167 (SOCKET
, long, u_long FAR
*));
168 DECL_WINSOCK_FUNCTION(static, SOCKET
, accept
,
169 (SOCKET
, struct sockaddr FAR
*, int FAR
*));
170 DECL_WINSOCK_FUNCTION(static, int, recv
, (SOCKET
, char FAR
*, int, int));
172 static HMODULE winsock_module
;
179 winsock_ver
= MAKEWORD(2, 0);
180 winsock_module
= LoadLibrary("WS2_32.DLL");
181 if (!winsock_module
) {
182 winsock_module
= LoadLibrary("WSOCK32.DLL");
183 winsock_ver
= MAKEWORD(1, 1);
186 fatalbox("Unable to load any WinSock library");
188 GET_WINSOCK_FUNCTION(WSAAsyncSelect
);
189 GET_WINSOCK_FUNCTION(WSAEventSelect
);
190 GET_WINSOCK_FUNCTION(select
);
191 GET_WINSOCK_FUNCTION(WSAGetLastError
);
192 GET_WINSOCK_FUNCTION(WSAEnumNetworkEvents
);
193 GET_WINSOCK_FUNCTION(WSAStartup
);
194 GET_WINSOCK_FUNCTION(WSACleanup
);
195 GET_WINSOCK_FUNCTION(closesocket
);
196 GET_WINSOCK_FUNCTION(ntohl
);
197 GET_WINSOCK_FUNCTION(htonl
);
198 GET_WINSOCK_FUNCTION(htons
);
199 GET_WINSOCK_FUNCTION(ntohs
);
200 GET_WINSOCK_FUNCTION(gethostbyname
);
201 GET_WINSOCK_FUNCTION(getservbyname
);
202 GET_WINSOCK_FUNCTION(inet_addr
);
203 GET_WINSOCK_FUNCTION(inet_ntoa
);
204 GET_WINSOCK_FUNCTION(connect
);
205 GET_WINSOCK_FUNCTION(bind
);
206 GET_WINSOCK_FUNCTION(setsockopt
);
207 GET_WINSOCK_FUNCTION(socket
);
208 GET_WINSOCK_FUNCTION(listen
);
209 GET_WINSOCK_FUNCTION(send
);
210 GET_WINSOCK_FUNCTION(ioctlsocket
);
211 GET_WINSOCK_FUNCTION(accept
);
212 GET_WINSOCK_FUNCTION(recv
);
214 if (p_WSAStartup(winsock_ver
, &wsadata
)) {
215 fatalbox("Unable to initialise WinSock");
217 if (LOBYTE(wsadata
.wVersion
) != LOBYTE(winsock_ver
)) {
219 fatalbox("WinSock version is incompatible with %d.%d",
220 LOBYTE(winsock_ver
), HIBYTE(winsock_ver
));
223 sktree
= newtree234(cmpfortree
);
226 void sk_cleanup(void)
232 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
239 FreeLibrary(winsock_module
);
242 char *winsock_error_string(int error
)
246 return "Network error: Permission denied";
248 return "Network error: Address already in use";
249 case WSAEADDRNOTAVAIL
:
250 return "Network error: Cannot assign requested address";
251 case WSAEAFNOSUPPORT
:
253 "Network error: Address family not supported by protocol family";
255 return "Network error: Operation already in progress";
256 case WSAECONNABORTED
:
257 return "Network error: Software caused connection abort";
258 case WSAECONNREFUSED
:
259 return "Network error: Connection refused";
261 return "Network error: Connection reset by peer";
262 case WSAEDESTADDRREQ
:
263 return "Network error: Destination address required";
265 return "Network error: Bad address";
267 return "Network error: Host is down";
268 case WSAEHOSTUNREACH
:
269 return "Network error: No route to host";
271 return "Network error: Operation now in progress";
273 return "Network error: Interrupted function call";
275 return "Network error: Invalid argument";
277 return "Network error: Socket is already connected";
279 return "Network error: Too many open files";
281 return "Network error: Message too long";
283 return "Network error: Network is down";
285 return "Network error: Network dropped connection on reset";
287 return "Network error: Network is unreachable";
289 return "Network error: No buffer space available";
291 return "Network error: Bad protocol option";
293 return "Network error: Socket is not connected";
295 return "Network error: Socket operation on non-socket";
297 return "Network error: Operation not supported";
298 case WSAEPFNOSUPPORT
:
299 return "Network error: Protocol family not supported";
301 return "Network error: Too many processes";
302 case WSAEPROTONOSUPPORT
:
303 return "Network error: Protocol not supported";
305 return "Network error: Protocol wrong type for socket";
307 return "Network error: Cannot send after socket shutdown";
308 case WSAESOCKTNOSUPPORT
:
309 return "Network error: Socket type not supported";
311 return "Network error: Connection timed out";
313 return "Network error: Resource temporarily unavailable";
315 return "Network error: Graceful shutdown in progress";
317 return "Unknown network error";
321 SockAddr
sk_namelookup(const char *host
, char **canonicalname
)
323 SockAddr ret
= snew(struct SockAddr_tag
);
325 struct hostent
*h
= NULL
;
328 /* Clear the structure and default to IPv4. */
329 memset(ret
, 0, sizeof(struct SockAddr_tag
));
330 ret
->family
= 0; /* We set this one when we have resolved the host. */
333 if ((a
= p_inet_addr(host
)) == (unsigned long) INADDR_NONE
) {
336 /* Try to get the getaddrinfo() function from wship6.dll */
337 /* This way one doesn't need to have IPv6 dll's to use PuTTY and
338 * it will fallback to IPv4. */
339 typedef int (CALLBACK
* FGETADDRINFO
) (const char *nodename
,
340 const char *servname
,
341 const struct addrinfo
*
343 struct addrinfo
** res
);
344 FGETADDRINFO fGetAddrInfo
= NULL
;
346 HINSTANCE dllWSHIP6
= LoadLibrary("wship6.dll");
348 fGetAddrInfo
= (FGETADDRINFO
) GetProcAddress(dllWSHIP6
,
352 * Use fGetAddrInfo when it's available (which usually also
353 * means IPv6 is installed...)
356 /*debug(("Resolving \"%s\" with getaddrinfo() (IPv4+IPv6 capable)...\n", host)); */
357 if (fGetAddrInfo(host
, NULL
, NULL
, &ret
->ai
) == 0)
358 ret
->family
= ret
->ai
->ai_family
;
363 * Otherwise use the IPv4-only gethostbyname...
364 * (NOTE: we don't use gethostbyname as a
367 if (ret
->family
== 0) {
368 /*debug(("Resolving \"%s\" with gethostbyname() (IPv4 only)...\n", host)); */
369 if ( (h
= p_gethostbyname(host
)) )
370 ret
->family
= AF_INET
;
373 /*debug(("Done resolving...(family is %d) AF_INET = %d, AF_INET6 = %d\n", ret->family, AF_INET, AF_INET6)); */
375 if (ret
->family
== 0) {
376 DWORD err
= p_WSAGetLastError();
377 ret
->error
= (err
== WSAENETDOWN ?
"Network is down" :
379 WSAHOST_NOT_FOUND ?
"Host does not exist" : err
380 == WSATRY_AGAIN ?
"Host not found" :
382 fGetAddrInfo ?
"getaddrinfo: unknown error" :
384 "gethostbyname: unknown error");
388 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
|
389 FORMAT_MESSAGE_FROM_SYSTEM
|
390 FORMAT_MESSAGE_IGNORE_INSERTS
, NULL
, err
,
391 MAKELANGID(LANG_NEUTRAL
, SUBLANG_DEFAULT
),
392 (LPTSTR
) & lpMsgBuf
, 0, NULL
);
393 /*debug(("Error %ld: %s (h=%lx)\n", err, lpMsgBuf, h)); */
394 /* Free the buffer. */
402 /* If we got an address info use that... */
404 typedef int (CALLBACK
* FGETNAMEINFO
)
405 (const struct sockaddr FAR
* sa
, socklen_t salen
,
406 char FAR
* host
, size_t hostlen
, char FAR
* serv
,
407 size_t servlen
, int flags
);
408 FGETNAMEINFO fGetNameInfo
= NULL
;
410 /* Are we in IPv4 fallback mode? */
411 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
412 if (ret
->family
== AF_INET
)
414 (char *) &((SOCKADDR_IN
*) ret
->ai
->
415 ai_addr
)->sin_addr
, sizeof(a
));
417 /* Now let's find that canonicalname... */
420 (FGETNAMEINFO
) GetProcAddress(dllWSHIP6
,
423 ((struct sockaddr
*) ret
->ai
->ai_addr
,
425 AF_INET ?
sizeof(SOCKADDR_IN
) :
426 sizeof(SOCKADDR_IN6
), realhost
,
427 sizeof(realhost
), NULL
, 0, 0) != 0) {
428 strncpy(realhost
, host
, sizeof(realhost
));
432 /* We used the IPv4-only gethostbyname()... */
436 memcpy(&a
, h
->h_addr
, sizeof(a
));
437 /* This way we are always sure the h->h_name is valid :) */
438 strncpy(realhost
, h
->h_name
, sizeof(realhost
));
442 FreeLibrary(dllWSHIP6
);
446 * This must be a numeric IPv4 address because it caused a
447 * success return from inet_addr.
449 ret
->family
= AF_INET
;
450 strncpy(realhost
, host
, sizeof(realhost
));
452 ret
->address
= p_ntohl(a
);
453 realhost
[lenof(realhost
)-1] = '\0';
454 *canonicalname
= snewn(1+strlen(realhost
), char);
455 strcpy(*canonicalname
, realhost
);
459 SockAddr
sk_nonamelookup(const char *host
)
461 SockAddr ret
= snew(struct SockAddr_tag
);
463 ret
->family
= AF_UNSPEC
;
464 strncpy(ret
->hostname
, host
, lenof(ret
->hostname
));
465 ret
->hostname
[lenof(ret
->hostname
)-1] = '\0';
469 void sk_getaddr(SockAddr addr
, char *buf
, int buflen
)
472 if (addr
->family
== AF_INET6
) {
473 FIXME
; /* I don't know how to get a text form of an IPv6 address. */
476 if (addr
->family
== AF_INET
) {
478 a
.s_addr
= p_htonl(addr
->address
);
479 strncpy(buf
, p_inet_ntoa(a
), buflen
);
480 buf
[buflen
-1] = '\0';
482 assert(addr
->family
== AF_UNSPEC
);
483 strncpy(buf
, addr
->hostname
, buflen
);
484 buf
[buflen
-1] = '\0';
488 int sk_hostname_is_local(char *name
)
490 return !strcmp(name
, "localhost");
493 int sk_address_is_local(SockAddr addr
)
496 if (addr
->family
== AF_INET6
) {
497 FIXME
; /* someone who can compile for IPV6 had better do this bit */
500 if (addr
->family
== AF_INET
) {
502 a
.s_addr
= p_htonl(addr
->address
);
503 return ipv4_is_loopback(a
);
505 assert(addr
->family
== AF_UNSPEC
);
506 return 0; /* we don't know; assume not */
510 int sk_addrtype(SockAddr addr
)
512 return (addr
->family
== AF_INET ? ADDRTYPE_IPV4
:
514 addr
->family
== AF_INET6 ? ADDRTYPE_IPV6
:
519 void sk_addrcopy(SockAddr addr
, char *buf
)
521 assert(addr
->family
!= AF_UNSPEC
);
523 if (addr
->family
== AF_INET6
) {
524 memcpy(buf
, (char*) addr
->ai
, 16);
527 if (addr
->family
== AF_INET
) {
529 a
.s_addr
= p_htonl(addr
->address
);
530 memcpy(buf
, (char*) &a
.s_addr
, 4);
534 void sk_addr_free(SockAddr addr
)
539 static Plug
sk_tcp_plug(Socket sock
, Plug p
)
541 Actual_Socket s
= (Actual_Socket
) sock
;
548 static void sk_tcp_flush(Socket s
)
551 * We send data to the socket as soon as we can anyway,
552 * so we don't need to do anything here. :-)
556 static void sk_tcp_close(Socket s
);
557 static int sk_tcp_write(Socket s
, const char *data
, int len
);
558 static int sk_tcp_write_oob(Socket s
, const char *data
, int len
);
559 static void sk_tcp_set_private_ptr(Socket s
, void *ptr
);
560 static void *sk_tcp_get_private_ptr(Socket s
);
561 static void sk_tcp_set_frozen(Socket s
, int is_frozen
);
562 static const char *sk_tcp_socket_error(Socket s
);
564 extern char *do_select(SOCKET skt
, int startup
);
566 Socket
sk_register(void *sock
, Plug plug
)
568 static const struct socket_function_table fn_table
= {
574 sk_tcp_set_private_ptr
,
575 sk_tcp_get_private_ptr
,
585 * Create Socket structure.
587 ret
= snew(struct Socket_tag
);
591 bufchain_init(&ret
->output_data
);
592 ret
->writable
= 1; /* to start with */
593 ret
->sending_oob
= 0;
595 ret
->frozen_readable
= 0;
596 ret
->localhost_only
= 0; /* unused, but best init anyway */
597 ret
->pending_error
= 0;
599 ret
->s
= (SOCKET
)sock
;
601 if (ret
->s
== INVALID_SOCKET
) {
602 err
= p_WSAGetLastError();
603 ret
->error
= winsock_error_string(err
);
609 /* Set up a select mechanism. This could be an AsyncSelect on a
610 * window, or an EventSelect on an event object. */
611 errstr
= do_select(ret
->s
, 1);
622 Socket
sk_new(SockAddr addr
, int port
, int privport
, int oobinline
,
623 int nodelay
, Plug plug
)
625 static const struct socket_function_table fn_table
= {
631 sk_tcp_set_private_ptr
,
632 sk_tcp_get_private_ptr
,
648 * Create Socket structure.
650 ret
= snew(struct Socket_tag
);
654 bufchain_init(&ret
->output_data
);
655 ret
->connected
= 0; /* to start with */
656 ret
->writable
= 0; /* to start with */
657 ret
->sending_oob
= 0;
659 ret
->frozen_readable
= 0;
660 ret
->localhost_only
= 0; /* unused, but best init anyway */
661 ret
->pending_error
= 0;
666 assert(addr
->family
!= AF_UNSPEC
);
667 s
= p_socket(addr
->family
, SOCK_STREAM
, 0);
670 if (s
== INVALID_SOCKET
) {
671 err
= p_WSAGetLastError();
672 ret
->error
= winsock_error_string(err
);
676 ret
->oobinline
= oobinline
;
679 p_setsockopt(s
, SOL_SOCKET
, SO_OOBINLINE
, (void *) &b
, sizeof(b
));
684 p_setsockopt(s
, IPPROTO_TCP
, TCP_NODELAY
, (void *) &b
, sizeof(b
));
688 * Bind to local address.
691 localport
= 1023; /* count from 1023 downwards */
693 localport
= 0; /* just use port 0 (ie winsock picks) */
695 /* Loop round trying to bind */
700 if (addr
->family
== AF_INET6
) {
701 memset(&a6
, 0, sizeof(a6
));
702 a6
.sin6_family
= AF_INET6
;
703 /*a6.sin6_addr = in6addr_any; *//* == 0 */
704 a6
.sin6_port
= p_htons(localport
);
708 a
.sin_family
= AF_INET
;
709 a
.sin_addr
.s_addr
= p_htonl(INADDR_ANY
);
710 a
.sin_port
= p_htons(localport
);
713 retcode
= p_bind(s
, (addr
->family
== AF_INET6 ?
714 (struct sockaddr
*) &a6
:
715 (struct sockaddr
*) &a
),
717 AF_INET6 ?
sizeof(a6
) : sizeof(a
)));
719 retcode
= p_bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
721 if (retcode
!= SOCKET_ERROR
) {
725 err
= p_WSAGetLastError();
726 if (err
!= WSAEADDRINUSE
) /* failed, for a bad reason */
731 break; /* we're only looping once */
734 break; /* we might have got to the end */
738 ret
->error
= winsock_error_string(err
);
743 * Connect to remote address.
746 if (addr
->family
== AF_INET6
) {
747 memset(&a
, 0, sizeof(a
));
748 a6
.sin6_family
= AF_INET6
;
749 a6
.sin6_port
= p_htons((short) port
);
751 ((struct sockaddr_in6
*) addr
->ai
->ai_addr
)->sin6_addr
;
755 a
.sin_family
= AF_INET
;
756 a
.sin_addr
.s_addr
= p_htonl(addr
->address
);
757 a
.sin_port
= p_htons((short) port
);
760 /* Set up a select mechanism. This could be an AsyncSelect on a
761 * window, or an EventSelect on an event object. */
762 errstr
= do_select(s
, 1);
770 p_connect(s
, ((addr
->family
== AF_INET6
) ?
771 (struct sockaddr
*) &a6
: (struct sockaddr
*) &a
),
772 (addr
->family
== AF_INET6
) ?
sizeof(a6
) : sizeof(a
))
774 p_connect(s
, (struct sockaddr
*) &a
, sizeof(a
))
777 err
= p_WSAGetLastError();
779 * We expect a potential EWOULDBLOCK here, because the
780 * chances are the front end has done a select for
781 * FD_CONNECT, so that connect() will complete
784 if ( err
!= WSAEWOULDBLOCK
) {
785 ret
->error
= winsock_error_string(err
);
790 * If we _don't_ get EWOULDBLOCK, the connect has completed
791 * and we should set the socket as writable.
798 /* We're done with 'addr' now. */
804 Socket
sk_newlistener(char *srcaddr
, int port
, Plug plug
, int local_host_only
)
806 static const struct socket_function_table fn_table
= {
812 sk_tcp_set_private_ptr
,
813 sk_tcp_get_private_ptr
,
830 * Create Socket structure.
832 ret
= snew(struct Socket_tag
);
836 bufchain_init(&ret
->output_data
);
837 ret
->writable
= 0; /* to start with */
838 ret
->sending_oob
= 0;
840 ret
->frozen_readable
= 0;
841 ret
->localhost_only
= local_host_only
;
842 ret
->pending_error
= 0;
847 s
= p_socket(AF_INET
, SOCK_STREAM
, 0);
850 if (s
== INVALID_SOCKET
) {
851 err
= p_WSAGetLastError();
852 ret
->error
= winsock_error_string(err
);
858 p_setsockopt(s
, SOL_SOCKET
, SO_REUSEADDR
, (const char *)&on
, sizeof(on
));
861 if (addr
->family
== AF_INET6
) {
862 memset(&a6
, 0, sizeof(a6
));
863 a6
.sin6_family
= AF_INET6
;
864 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
865 * know how to do it. :-) */
867 a6
.sin6_addr
= in6addr_loopback
;
869 a6
.sin6_addr
= in6addr_any
;
870 a6
.sin6_port
= p_htons(port
);
875 a
.sin_family
= AF_INET
;
878 * Bind to source address. First try an explicitly
882 a
.sin_addr
.s_addr
= p_inet_addr(srcaddr
);
883 if (a
.sin_addr
.s_addr
!= INADDR_NONE
) {
884 /* Override localhost_only with specified listen addr. */
885 ret
->localhost_only
= ipv4_is_loopback(a
.sin_addr
);
891 * ... and failing that, go with one of the standard ones.
895 a
.sin_addr
.s_addr
= p_htonl(INADDR_LOOPBACK
);
897 a
.sin_addr
.s_addr
= p_htonl(INADDR_ANY
);
900 a
.sin_port
= p_htons((short)port
);
903 retcode
= p_bind(s
, (addr
->family
== AF_INET6 ?
904 (struct sockaddr
*) &a6
:
905 (struct sockaddr
*) &a
),
907 AF_INET6 ?
sizeof(a6
) : sizeof(a
)));
909 retcode
= p_bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
911 if (retcode
!= SOCKET_ERROR
) {
914 err
= p_WSAGetLastError();
918 ret
->error
= winsock_error_string(err
);
923 if (p_listen(s
, SOMAXCONN
) == SOCKET_ERROR
) {
925 ret
->error
= winsock_error_string(err
);
929 /* Set up a select mechanism. This could be an AsyncSelect on a
930 * window, or an EventSelect on an event object. */
931 errstr
= do_select(s
, 1);
942 static void sk_tcp_close(Socket sock
)
944 extern char *do_select(SOCKET skt
, int startup
);
945 Actual_Socket s
= (Actual_Socket
) sock
;
954 * The function which tries to send on a socket once it's deemed
957 void try_send(Actual_Socket s
)
959 while (s
->sending_oob
|| bufchain_size(&s
->output_data
) > 0) {
965 if (s
->sending_oob
) {
966 urgentflag
= MSG_OOB
;
967 len
= s
->sending_oob
;
971 bufchain_prefix(&s
->output_data
, &data
, &len
);
973 nsent
= p_send(s
->s
, data
, len
, urgentflag
);
974 noise_ultralight(nsent
);
976 err
= (nsent
< 0 ?
p_WSAGetLastError() : 0);
977 if ((err
< WSABASEERR
&& nsent
< 0) || err
== WSAEWOULDBLOCK
) {
979 * Perfectly normal: we've sent all we can for the moment.
981 * (Some WinSock send() implementations can return
982 * <0 but leave no sensible error indication -
983 * WSAGetLastError() is called but returns zero or
984 * a small number - so we check that case and treat
985 * it just like WSAEWOULDBLOCK.)
989 } else if (nsent
== 0 ||
990 err
== WSAECONNABORTED
|| err
== WSAECONNRESET
) {
992 * If send() returns CONNABORTED or CONNRESET, we
993 * unfortunately can't just call plug_closing(),
994 * because it's quite likely that we're currently
995 * _in_ a call from the code we'd be calling back
996 * to, so we'd have to make half the SSH code
997 * reentrant. Instead we flag a pending error on
998 * the socket, to be dealt with (by calling
999 * plug_closing()) at some suitable future moment.
1001 s
->pending_error
= err
;
1004 /* We're inside the Windows frontend here, so we know
1005 * that the frontend handle is unnecessary. */
1006 logevent(NULL
, winsock_error_string(err
));
1007 fatalbox("%s", winsock_error_string(err
));
1010 if (s
->sending_oob
) {
1012 memmove(s
->oobdata
, s
->oobdata
+nsent
, len
-nsent
);
1013 s
->sending_oob
= len
- nsent
;
1018 bufchain_consume(&s
->output_data
, nsent
);
1024 static int sk_tcp_write(Socket sock
, const char *buf
, int len
)
1026 Actual_Socket s
= (Actual_Socket
) sock
;
1029 * Add the data to the buffer list on the socket.
1031 bufchain_add(&s
->output_data
, buf
, len
);
1034 * Now try sending from the start of the buffer list.
1039 return bufchain_size(&s
->output_data
);
1042 static int sk_tcp_write_oob(Socket sock
, const char *buf
, int len
)
1044 Actual_Socket s
= (Actual_Socket
) sock
;
1047 * Replace the buffer list on the socket with the data.
1049 bufchain_clear(&s
->output_data
);
1050 assert(len
<= sizeof(s
->oobdata
));
1051 memcpy(s
->oobdata
, buf
, len
);
1052 s
->sending_oob
= len
;
1055 * Now try sending from the start of the buffer list.
1060 return s
->sending_oob
;
1063 int select_result(WPARAM wParam
, LPARAM lParam
)
1067 char buf
[20480]; /* nice big buffer for plenty of speed */
1071 /* wParam is the socket itself */
1074 return 1; /* boggle */
1076 s
= find234(sktree
, (void *) wParam
, cmpforsearch
);
1078 return 1; /* boggle */
1080 if ((err
= WSAGETSELECTERROR(lParam
)) != 0) {
1082 * An error has occurred on this socket. Pass it to the
1085 return plug_closing(s
->plug
, winsock_error_string(err
), err
, 0);
1088 noise_ultralight(lParam
);
1090 switch (WSAGETSELECTEVENT(lParam
)) {
1092 s
->connected
= s
->writable
= 1;
1095 /* In the case the socket is still frozen, we don't even bother */
1097 s
->frozen_readable
= 1;
1102 * We have received data on the socket. For an oobinline
1103 * socket, this might be data _before_ an urgent pointer,
1104 * in which case we send it to the back end with type==1
1105 * (data prior to urgent).
1109 p_ioctlsocket(s
->s
, SIOCATMARK
, &atmark
);
1111 * Avoid checking the return value from ioctlsocket(),
1112 * on the grounds that some WinSock wrappers don't
1113 * support it. If it does nothing, we get atmark==1,
1114 * which is equivalent to `no OOB pending', so the
1115 * effect will be to non-OOB-ify any OOB data.
1120 ret
= p_recv(s
->s
, buf
, sizeof(buf
), 0);
1121 noise_ultralight(ret
);
1123 err
= p_WSAGetLastError();
1124 if (err
== WSAEWOULDBLOCK
) {
1129 return plug_closing(s
->plug
, winsock_error_string(err
), err
,
1131 } else if (0 == ret
) {
1132 return plug_closing(s
->plug
, NULL
, 0, 0);
1134 return plug_receive(s
->plug
, atmark ?
0 : 1, buf
, ret
);
1139 * This will only happen on a non-oobinline socket. It
1140 * indicates that we can immediately perform an OOB read
1141 * and get back OOB data, which we will send to the back
1142 * end with type==2 (urgent data).
1144 ret
= p_recv(s
->s
, buf
, sizeof(buf
), MSG_OOB
);
1145 noise_ultralight(ret
);
1147 char *str
= (ret
== 0 ?
"Internal networking trouble" :
1148 winsock_error_string(p_WSAGetLastError()));
1149 /* We're inside the Windows frontend here, so we know
1150 * that the frontend handle is unnecessary. */
1151 logevent(NULL
, str
);
1152 fatalbox("%s", str
);
1154 return plug_receive(s
->plug
, 2, buf
, ret
);
1159 int bufsize_before
, bufsize_after
;
1161 bufsize_before
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1163 bufsize_after
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1164 if (bufsize_after
< bufsize_before
)
1165 plug_sent(s
->plug
, bufsize_after
);
1169 /* Signal a close on the socket. First read any outstanding data. */
1172 ret
= p_recv(s
->s
, buf
, sizeof(buf
), 0);
1174 err
= p_WSAGetLastError();
1175 if (err
== WSAEWOULDBLOCK
)
1177 return plug_closing(s
->plug
, winsock_error_string(err
),
1181 open
&= plug_receive(s
->plug
, 0, buf
, ret
);
1183 open
&= plug_closing(s
->plug
, NULL
, 0, 0);
1189 struct sockaddr_in isa
;
1190 int addrlen
= sizeof(struct sockaddr_in
);
1191 SOCKET t
; /* socket of connection */
1193 memset(&isa
, 0, sizeof(struct sockaddr_in
));
1195 t
= p_accept(s
->s
,(struct sockaddr
*)&isa
,&addrlen
);
1196 if (t
== INVALID_SOCKET
)
1198 err
= p_WSAGetLastError();
1199 if (err
== WSATRY_AGAIN
)
1203 if (s
->localhost_only
&& !ipv4_is_loopback(isa
.sin_addr
)) {
1204 p_closesocket(t
); /* dodgy WinSock let nonlocal through */
1205 } else if (plug_accepting(s
->plug
, (void*)t
)) {
1206 p_closesocket(t
); /* denied or error */
1215 * Deal with socket errors detected in try_send().
1217 void net_pending_errors(void)
1223 * This might be a fiddly business, because it's just possible
1224 * that handling a pending error on one socket might cause
1225 * others to be closed. (I can't think of any reason this might
1226 * happen in current SSH implementation, but to maintain
1227 * generality of this network layer I'll assume the worst.)
1229 * So what we'll do is search the socket list for _one_ socket
1230 * with a pending error, and then handle it, and then search
1231 * the list again _from the beginning_. Repeat until we make a
1232 * pass with no socket errors present. That way we are
1233 * protected against the socket list changing under our feet.
1237 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
1238 if (s
->pending_error
) {
1240 * An error has occurred on this socket. Pass it to the
1243 plug_closing(s
->plug
,
1244 winsock_error_string(s
->pending_error
),
1245 s
->pending_error
, 0);
1253 * Each socket abstraction contains a `void *' private field in
1254 * which the client can keep state.
1256 static void sk_tcp_set_private_ptr(Socket sock
, void *ptr
)
1258 Actual_Socket s
= (Actual_Socket
) sock
;
1259 s
->private_ptr
= ptr
;
1262 static void *sk_tcp_get_private_ptr(Socket sock
)
1264 Actual_Socket s
= (Actual_Socket
) sock
;
1265 return s
->private_ptr
;
1269 * Special error values are returned from sk_namelookup and sk_new
1270 * if there's a problem. These functions extract an error message,
1271 * or return NULL if there's no problem.
1273 const char *sk_addr_error(SockAddr addr
)
1277 static const char *sk_tcp_socket_error(Socket sock
)
1279 Actual_Socket s
= (Actual_Socket
) sock
;
1283 static void sk_tcp_set_frozen(Socket sock
, int is_frozen
)
1285 Actual_Socket s
= (Actual_Socket
) sock
;
1286 if (s
->frozen
== is_frozen
)
1288 s
->frozen
= is_frozen
;
1289 if (!is_frozen
&& s
->frozen_readable
) {
1291 p_recv(s
->s
, &c
, 1, MSG_PEEK
);
1293 s
->frozen_readable
= 0;
1297 * For Plink: enumerate all sockets currently active.
1299 SOCKET
first_socket(int *state
)
1303 s
= index234(sktree
, (*state
)++);
1304 return s ? s
->s
: INVALID_SOCKET
;
1307 SOCKET
next_socket(int *state
)
1309 Actual_Socket s
= index234(sktree
, (*state
)++);
1310 return s ? s
->s
: INVALID_SOCKET
;
1313 int net_service_lookup(char *service
)
1316 se
= p_getservbyname(service
, NULL
);
1318 return p_ntohs(se
->s_port
);