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));
171 DECL_WINSOCK_FUNCTION(static, int, WSAIoctl,
172 (SOCKET, DWORD, LPVOID, DWORD, LPVOID, DWORD,
173 LPDWORD, LPWSAOVERLAPPED,
174 LPWSAOVERLAPPED_COMPLETION_ROUTINE));
176 static HMODULE winsock_module;
183 winsock_ver = MAKEWORD(2, 0);
184 winsock_module = LoadLibrary("WS2_32.DLL");
185 if (!winsock_module) {
186 winsock_module = LoadLibrary("WSOCK32.DLL");
187 winsock_ver = MAKEWORD(1, 1);
190 fatalbox("Unable to load any WinSock library");
192 GET_WINSOCK_FUNCTION(WSAAsyncSelect);
193 GET_WINSOCK_FUNCTION(WSAEventSelect);
194 GET_WINSOCK_FUNCTION(select);
195 GET_WINSOCK_FUNCTION(WSAGetLastError);
196 GET_WINSOCK_FUNCTION(WSAEnumNetworkEvents);
197 GET_WINSOCK_FUNCTION(WSAStartup);
198 GET_WINSOCK_FUNCTION(WSACleanup);
199 GET_WINSOCK_FUNCTION(closesocket);
200 GET_WINSOCK_FUNCTION(ntohl);
201 GET_WINSOCK_FUNCTION(htonl);
202 GET_WINSOCK_FUNCTION(htons);
203 GET_WINSOCK_FUNCTION(ntohs);
204 GET_WINSOCK_FUNCTION(gethostbyname);
205 GET_WINSOCK_FUNCTION(getservbyname);
206 GET_WINSOCK_FUNCTION(inet_addr);
207 GET_WINSOCK_FUNCTION(inet_ntoa);
208 GET_WINSOCK_FUNCTION(connect);
209 GET_WINSOCK_FUNCTION(bind);
210 GET_WINSOCK_FUNCTION(setsockopt);
211 GET_WINSOCK_FUNCTION(socket);
212 GET_WINSOCK_FUNCTION(listen);
213 GET_WINSOCK_FUNCTION(send);
214 GET_WINSOCK_FUNCTION(ioctlsocket);
215 GET_WINSOCK_FUNCTION(accept);
216 GET_WINSOCK_FUNCTION(recv);
217 GET_WINSOCK_FUNCTION(WSAIoctl);
219 if (p_WSAStartup(winsock_ver, &wsadata)) {
220 fatalbox("Unable to initialise WinSock");
222 if (LOBYTE(wsadata.wVersion) != LOBYTE(winsock_ver)) {
224 fatalbox("WinSock version is incompatible with %d.%d",
225 LOBYTE(winsock_ver), HIBYTE(winsock_ver));
228 sktree = newtree234(cmpfortree);
231 void sk_cleanup(void)
237 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
244 FreeLibrary(winsock_module);
247 char *winsock_error_string(int error)
251 return "Network error: Permission denied";
253 return "Network error: Address already in use";
254 case WSAEADDRNOTAVAIL:
255 return "Network error: Cannot assign requested address";
256 case WSAEAFNOSUPPORT:
258 "Network error: Address family not supported by protocol family";
260 return "Network error: Operation already in progress";
261 case WSAECONNABORTED:
262 return "Network error: Software caused connection abort";
263 case WSAECONNREFUSED:
264 return "Network error: Connection refused";
266 return "Network error: Connection reset by peer";
267 case WSAEDESTADDRREQ:
268 return "Network error: Destination address required";
270 return "Network error: Bad address";
272 return "Network error: Host is down";
273 case WSAEHOSTUNREACH:
274 return "Network error: No route to host";
276 return "Network error: Operation now in progress";
278 return "Network error: Interrupted function call";
280 return "Network error: Invalid argument";
282 return "Network error: Socket is already connected";
284 return "Network error: Too many open files";
286 return "Network error: Message too long";
288 return "Network error: Network is down";
290 return "Network error: Network dropped connection on reset";
292 return "Network error: Network is unreachable";
294 return "Network error: No buffer space available";
296 return "Network error: Bad protocol option";
298 return "Network error: Socket is not connected";
300 return "Network error: Socket operation on non-socket";
302 return "Network error: Operation not supported";
303 case WSAEPFNOSUPPORT:
304 return "Network error: Protocol family not supported";
306 return "Network error: Too many processes";
307 case WSAEPROTONOSUPPORT:
308 return "Network error: Protocol not supported";
310 return "Network error: Protocol wrong type for socket";
312 return "Network error: Cannot send after socket shutdown";
313 case WSAESOCKTNOSUPPORT:
314 return "Network error: Socket type not supported";
316 return "Network error: Connection timed out";
318 return "Network error: Resource temporarily unavailable";
320 return "Network error: Graceful shutdown in progress";
322 return "Unknown network error";
326 SockAddr sk_namelookup(const char *host, char **canonicalname)
328 SockAddr ret = snew(struct SockAddr_tag);
330 struct hostent *h = NULL;
333 /* Clear the structure and default to IPv4. */
334 memset(ret, 0, sizeof(struct SockAddr_tag));
335 ret->family = 0; /* We set this one when we have resolved the host. */
338 if ((a = p_inet_addr(host)) == (unsigned long) INADDR_NONE) {
341 /* Try to get the getaddrinfo() function from wship6.dll */
342 /* This way one doesn't need to have IPv6 dll's to use PuTTY and
343 * it will fallback to IPv4. */
344 typedef int (CALLBACK * FGETADDRINFO) (const char *nodename,
345 const char *servname,
346 const struct addrinfo *
348 struct addrinfo ** res);
349 FGETADDRINFO fGetAddrInfo = NULL;
351 HINSTANCE dllWSHIP6 = LoadLibrary("wship6.dll");
353 fGetAddrInfo = (FGETADDRINFO) GetProcAddress(dllWSHIP6,
357 * Use fGetAddrInfo when it's available (which usually also
358 * means IPv6 is installed...)
361 /*debug(("Resolving \"%s\" with getaddrinfo() (IPv4+IPv6 capable)...\n", host)); */
362 if (fGetAddrInfo(host, NULL, NULL, &ret->ai) == 0)
363 ret->family = ret->ai->ai_family;
368 * Otherwise use the IPv4-only gethostbyname...
369 * (NOTE: we don't use gethostbyname as a
372 if (ret->family == 0) {
373 /*debug(("Resolving \"%s\" with gethostbyname() (IPv4 only)...\n", host)); */
374 if ( (h = p_gethostbyname(host)) )
375 ret->family = AF_INET;
378 /*debug(("Done resolving...(family is %d) AF_INET = %d, AF_INET6 = %d\n", ret->family, AF_INET, AF_INET6)); */
380 if (ret->family == 0) {
381 DWORD err = p_WSAGetLastError();
382 ret->error = (err == WSAENETDOWN ? "Network is down" :
384 WSAHOST_NOT_FOUND ? "Host does not exist" : err
385 == WSATRY_AGAIN ? "Host not found" :
387 fGetAddrInfo ? "getaddrinfo: unknown error" :
389 "gethostbyname: unknown error");
393 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER |
394 FORMAT_MESSAGE_FROM_SYSTEM |
395 FORMAT_MESSAGE_IGNORE_INSERTS, NULL, err,
396 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
397 (LPTSTR) & lpMsgBuf, 0, NULL);
398 /*debug(("Error %ld: %s (h=%lx)\n", err, lpMsgBuf, h)); */
399 /* Free the buffer. */
407 /* If we got an address info use that... */
409 typedef int (CALLBACK * FGETNAMEINFO)
410 (const struct sockaddr FAR * sa, socklen_t salen,
411 char FAR * host, size_t hostlen, char FAR * serv,
412 size_t servlen, int flags);
413 FGETNAMEINFO fGetNameInfo = NULL;
415 /* Are we in IPv4 fallback mode? */
416 /* We put the IPv4 address into the a variable so we can further-on use the IPv4 code... */
417 if (ret->family == AF_INET)
419 (char *) &((SOCKADDR_IN *) ret->ai->
420 ai_addr)->sin_addr, sizeof(a));
422 /* Now let's find that canonicalname... */
425 (FGETNAMEINFO) GetProcAddress(dllWSHIP6,
428 ((struct sockaddr *) ret->ai->ai_addr,
430 AF_INET ? sizeof(SOCKADDR_IN) :
431 sizeof(SOCKADDR_IN6), realhost,
432 sizeof(realhost), NULL, 0, 0) != 0) {
433 strncpy(realhost, host, sizeof(realhost));
437 /* We used the IPv4-only gethostbyname()... */
441 memcpy(&a, h->h_addr, sizeof(a));
442 /* This way we are always sure the h->h_name is valid :) */
443 strncpy(realhost, h->h_name, sizeof(realhost));
447 FreeLibrary(dllWSHIP6);
451 * This must be a numeric IPv4 address because it caused a
452 * success return from inet_addr.
454 ret->family = AF_INET;
455 strncpy(realhost, host, sizeof(realhost));
457 ret->address = p_ntohl(a);
458 realhost[lenof(realhost)-1] = '\0';
459 *canonicalname = snewn(1+strlen(realhost), char);
460 strcpy(*canonicalname, realhost);
464 SockAddr sk_nonamelookup(const char *host)
466 SockAddr ret = snew(struct SockAddr_tag);
468 ret->family = AF_UNSPEC;
469 strncpy(ret->hostname, host, lenof(ret->hostname));
470 ret->hostname[lenof(ret->hostname)-1] = '\0';
474 void sk_getaddr(SockAddr addr, char *buf, int buflen)
477 if (addr->family == AF_INET6) {
478 FIXME; /* I don't know how to get a text form of an IPv6 address. */
481 if (addr->family == AF_INET) {
483 a.s_addr = p_htonl(addr->address);
484 strncpy(buf, p_inet_ntoa(a), buflen);
485 buf[buflen-1] = '\0';
487 assert(addr->family == AF_UNSPEC);
488 strncpy(buf, addr->hostname, buflen);
489 buf[buflen-1] = '\0';
493 int sk_hostname_is_local(char *name)
495 return !strcmp(name, "localhost");
498 static INTERFACE_INFO local_interfaces[16];
499 static int n_local_interfaces; /* 0=not yet, -1=failed, >0=number */
501 static int ipv4_is_local_addr(struct in_addr addr)
503 if (ipv4_is_loopback(addr))
504 return 1; /* loopback addresses are local */
505 if (!n_local_interfaces) {
506 SOCKET s = p_socket(AF_INET, SOCK_DGRAM, 0);
510 p_WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0,
511 local_interfaces, sizeof(local_interfaces),
512 &retbytes, NULL, NULL) == 0)
513 n_local_interfaces = retbytes / sizeof(INTERFACE_INFO);
515 logevent(NULL, "Unable to get list of local IP addresses");
517 if (n_local_interfaces > 0) {
519 for (i = 0; i < n_local_interfaces; i++) {
520 SOCKADDR_IN *address =
521 (SOCKADDR_IN *)&local_interfaces[i].iiAddress;
522 if (address->sin_addr.s_addr == addr.s_addr)
523 return 1; /* this address is local */
526 return 0; /* this address is not local */
529 int sk_address_is_local(SockAddr addr)
532 if (addr->family == AF_INET6) {
533 FIXME; /* someone who can compile for IPV6 had better do this bit */
536 if (addr->family == AF_INET) {
538 a.s_addr = p_htonl(addr->address);
539 return ipv4_is_local_addr(a);
541 assert(addr->family == AF_UNSPEC);
542 return 0; /* we don't know; assume not */
546 int sk_addrtype(SockAddr addr)
548 return (addr->family == AF_INET ? ADDRTYPE_IPV4 :
550 addr->family == AF_INET6 ? ADDRTYPE_IPV6 :
555 void sk_addrcopy(SockAddr addr, char *buf)
557 assert(addr->family != AF_UNSPEC);
559 if (addr->family == AF_INET6) {
560 memcpy(buf, (char*) addr->ai, 16);
563 if (addr->family == AF_INET) {
565 a.s_addr = p_htonl(addr->address);
566 memcpy(buf, (char*) &a.s_addr, 4);
570 void sk_addr_free(SockAddr addr)
575 static Plug sk_tcp_plug(Socket sock, Plug p)
577 Actual_Socket s = (Actual_Socket) sock;
584 static void sk_tcp_flush(Socket s)
587 * We send data to the socket as soon as we can anyway,
588 * so we don't need to do anything here. :-)
592 static void sk_tcp_close(Socket s);
593 static int sk_tcp_write(Socket s, const char *data, int len);
594 static int sk_tcp_write_oob(Socket s, const char *data, int len);
595 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
596 static void *sk_tcp_get_private_ptr(Socket s);
597 static void sk_tcp_set_frozen(Socket s, int is_frozen);
598 static const char *sk_tcp_socket_error(Socket s);
600 extern char *do_select(SOCKET skt, int startup);
602 Socket sk_register(void *sock, Plug plug)
604 static const struct socket_function_table fn_table = {
610 sk_tcp_set_private_ptr,
611 sk_tcp_get_private_ptr,
621 * Create Socket structure.
623 ret = snew(struct Socket_tag);
627 bufchain_init(&ret->output_data);
628 ret->writable = 1; /* to start with */
629 ret->sending_oob = 0;
631 ret->frozen_readable = 0;
632 ret->localhost_only = 0; /* unused, but best init anyway */
633 ret->pending_error = 0;
635 ret->s = (SOCKET)sock;
637 if (ret->s == INVALID_SOCKET) {
638 err = p_WSAGetLastError();
639 ret->error = winsock_error_string(err);
645 /* Set up a select mechanism. This could be an AsyncSelect on a
646 * window, or an EventSelect on an event object. */
647 errstr = do_select(ret->s, 1);
658 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
659 int nodelay, Plug plug)
661 static const struct socket_function_table fn_table = {
667 sk_tcp_set_private_ptr,
668 sk_tcp_get_private_ptr,
684 * Create Socket structure.
686 ret = snew(struct Socket_tag);
690 bufchain_init(&ret->output_data);
691 ret->connected = 0; /* to start with */
692 ret->writable = 0; /* to start with */
693 ret->sending_oob = 0;
695 ret->frozen_readable = 0;
696 ret->localhost_only = 0; /* unused, but best init anyway */
697 ret->pending_error = 0;
702 assert(addr->family != AF_UNSPEC);
703 s = p_socket(addr->family, SOCK_STREAM, 0);
706 if (s == INVALID_SOCKET) {
707 err = p_WSAGetLastError();
708 ret->error = winsock_error_string(err);
712 ret->oobinline = oobinline;
715 p_setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
720 p_setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
724 * Bind to local address.
727 localport = 1023; /* count from 1023 downwards */
729 localport = 0; /* just use port 0 (ie winsock picks) */
731 /* Loop round trying to bind */
736 if (addr->family == AF_INET6) {
737 memset(&a6, 0, sizeof(a6));
738 a6.sin6_family = AF_INET6;
739 /*a6.sin6_addr = in6addr_any; *//* == 0 */
740 a6.sin6_port = p_htons(localport);
744 a.sin_family = AF_INET;
745 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
746 a.sin_port = p_htons(localport);
749 retcode = p_bind(s, (addr->family == AF_INET6 ?
750 (struct sockaddr *) &a6 :
751 (struct sockaddr *) &a),
753 AF_INET6 ? sizeof(a6) : sizeof(a)));
755 retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
757 if (retcode != SOCKET_ERROR) {
761 err = p_WSAGetLastError();
762 if (err != WSAEADDRINUSE) /* failed, for a bad reason */
767 break; /* we're only looping once */
770 break; /* we might have got to the end */
774 ret->error = winsock_error_string(err);
779 * Connect to remote address.
782 if (addr->family == AF_INET6) {
783 memset(&a, 0, sizeof(a));
784 a6.sin6_family = AF_INET6;
785 a6.sin6_port = p_htons((short) port);
787 ((struct sockaddr_in6 *) addr->ai->ai_addr)->sin6_addr;
791 a.sin_family = AF_INET;
792 a.sin_addr.s_addr = p_htonl(addr->address);
793 a.sin_port = p_htons((short) port);
796 /* Set up a select mechanism. This could be an AsyncSelect on a
797 * window, or an EventSelect on an event object. */
798 errstr = do_select(s, 1);
806 p_connect(s, ((addr->family == AF_INET6) ?
807 (struct sockaddr *) &a6 : (struct sockaddr *) &a),
808 (addr->family == AF_INET6) ? sizeof(a6) : sizeof(a))
810 p_connect(s, (struct sockaddr *) &a, sizeof(a))
813 err = p_WSAGetLastError();
815 * We expect a potential EWOULDBLOCK here, because the
816 * chances are the front end has done a select for
817 * FD_CONNECT, so that connect() will complete
820 if ( err != WSAEWOULDBLOCK ) {
821 ret->error = winsock_error_string(err);
826 * If we _don't_ get EWOULDBLOCK, the connect has completed
827 * and we should set the socket as writable.
834 /* We're done with 'addr' now. */
840 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only)
842 static const struct socket_function_table fn_table = {
848 sk_tcp_set_private_ptr,
849 sk_tcp_get_private_ptr,
866 * Create Socket structure.
868 ret = snew(struct Socket_tag);
872 bufchain_init(&ret->output_data);
873 ret->writable = 0; /* to start with */
874 ret->sending_oob = 0;
876 ret->frozen_readable = 0;
877 ret->localhost_only = local_host_only;
878 ret->pending_error = 0;
883 s = p_socket(AF_INET, SOCK_STREAM, 0);
886 if (s == INVALID_SOCKET) {
887 err = p_WSAGetLastError();
888 ret->error = winsock_error_string(err);
894 p_setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
897 if (addr->family == AF_INET6) {
898 memset(&a6, 0, sizeof(a6));
899 a6.sin6_family = AF_INET6;
900 /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
901 * know how to do it. :-) */
903 a6.sin6_addr = in6addr_loopback;
905 a6.sin6_addr = in6addr_any;
906 a6.sin6_port = p_htons(port);
911 a.sin_family = AF_INET;
914 * Bind to source address. First try an explicitly
918 a.sin_addr.s_addr = p_inet_addr(srcaddr);
919 if (a.sin_addr.s_addr != INADDR_NONE) {
920 /* Override localhost_only with specified listen addr. */
921 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
927 * ... and failing that, go with one of the standard ones.
931 a.sin_addr.s_addr = p_htonl(INADDR_LOOPBACK);
933 a.sin_addr.s_addr = p_htonl(INADDR_ANY);
936 a.sin_port = p_htons((short)port);
939 retcode = p_bind(s, (addr->family == AF_INET6 ?
940 (struct sockaddr *) &a6 :
941 (struct sockaddr *) &a),
943 AF_INET6 ? sizeof(a6) : sizeof(a)));
945 retcode = p_bind(s, (struct sockaddr *) &a, sizeof(a));
947 if (retcode != SOCKET_ERROR) {
950 err = p_WSAGetLastError();
954 ret->error = winsock_error_string(err);
959 if (p_listen(s, SOMAXCONN) == SOCKET_ERROR) {
961 ret->error = winsock_error_string(err);
965 /* Set up a select mechanism. This could be an AsyncSelect on a
966 * window, or an EventSelect on an event object. */
967 errstr = do_select(s, 1);
978 static void sk_tcp_close(Socket sock)
980 extern char *do_select(SOCKET skt, int startup);
981 Actual_Socket s = (Actual_Socket) sock;
990 * The function which tries to send on a socket once it's deemed
993 void try_send(Actual_Socket s)
995 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1001 if (s->sending_oob) {
1002 urgentflag = MSG_OOB;
1003 len = s->sending_oob;
1007 bufchain_prefix(&s->output_data, &data, &len);
1009 nsent = p_send(s->s, data, len, urgentflag);
1010 noise_ultralight(nsent);
1012 err = (nsent < 0 ? p_WSAGetLastError() : 0);
1013 if ((err < WSABASEERR && nsent < 0) || err == WSAEWOULDBLOCK) {
1015 * Perfectly normal: we've sent all we can for the moment.
1017 * (Some WinSock send() implementations can return
1018 * <0 but leave no sensible error indication -
1019 * WSAGetLastError() is called but returns zero or
1020 * a small number - so we check that case and treat
1021 * it just like WSAEWOULDBLOCK.)
1023 s->writable = FALSE;
1025 } else if (nsent == 0 ||
1026 err == WSAECONNABORTED || err == WSAECONNRESET) {
1028 * If send() returns CONNABORTED or CONNRESET, we
1029 * unfortunately can't just call plug_closing(),
1030 * because it's quite likely that we're currently
1031 * _in_ a call from the code we'd be calling back
1032 * to, so we'd have to make half the SSH code
1033 * reentrant. Instead we flag a pending error on
1034 * the socket, to be dealt with (by calling
1035 * plug_closing()) at some suitable future moment.
1037 s->pending_error = err;
1040 /* We're inside the Windows frontend here, so we know
1041 * that the frontend handle is unnecessary. */
1042 logevent(NULL, winsock_error_string(err));
1043 fatalbox("%s", winsock_error_string(err));
1046 if (s->sending_oob) {
1048 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1049 s->sending_oob = len - nsent;
1054 bufchain_consume(&s->output_data, nsent);
1060 static int sk_tcp_write(Socket sock, const char *buf, int len)
1062 Actual_Socket s = (Actual_Socket) sock;
1065 * Add the data to the buffer list on the socket.
1067 bufchain_add(&s->output_data, buf, len);
1070 * Now try sending from the start of the buffer list.
1075 return bufchain_size(&s->output_data);
1078 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1080 Actual_Socket s = (Actual_Socket) sock;
1083 * Replace the buffer list on the socket with the data.
1085 bufchain_clear(&s->output_data);
1086 assert(len <= sizeof(s->oobdata));
1087 memcpy(s->oobdata, buf, len);
1088 s->sending_oob = len;
1091 * Now try sending from the start of the buffer list.
1096 return s->sending_oob;
1099 int select_result(WPARAM wParam, LPARAM lParam)
1103 char buf[20480]; /* nice big buffer for plenty of speed */
1107 /* wParam is the socket itself */
1110 return 1; /* boggle */
1112 s = find234(sktree, (void *) wParam, cmpforsearch);
1114 return 1; /* boggle */
1116 if ((err = WSAGETSELECTERROR(lParam)) != 0) {
1118 * An error has occurred on this socket. Pass it to the
1121 return plug_closing(s->plug, winsock_error_string(err), err, 0);
1124 noise_ultralight(lParam);
1126 switch (WSAGETSELECTEVENT(lParam)) {
1128 s->connected = s->writable = 1;
1131 /* In the case the socket is still frozen, we don't even bother */
1133 s->frozen_readable = 1;
1138 * We have received data on the socket. For an oobinline
1139 * socket, this might be data _before_ an urgent pointer,
1140 * in which case we send it to the back end with type==1
1141 * (data prior to urgent).
1145 p_ioctlsocket(s->s, SIOCATMARK, &atmark);
1147 * Avoid checking the return value from ioctlsocket(),
1148 * on the grounds that some WinSock wrappers don't
1149 * support it. If it does nothing, we get atmark==1,
1150 * which is equivalent to `no OOB pending', so the
1151 * effect will be to non-OOB-ify any OOB data.
1156 ret = p_recv(s->s, buf, sizeof(buf), 0);
1157 noise_ultralight(ret);
1159 err = p_WSAGetLastError();
1160 if (err == WSAEWOULDBLOCK) {
1165 return plug_closing(s->plug, winsock_error_string(err), err,
1167 } else if (0 == ret) {
1168 return plug_closing(s->plug, NULL, 0, 0);
1170 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1175 * This will only happen on a non-oobinline socket. It
1176 * indicates that we can immediately perform an OOB read
1177 * and get back OOB data, which we will send to the back
1178 * end with type==2 (urgent data).
1180 ret = p_recv(s->s, buf, sizeof(buf), MSG_OOB);
1181 noise_ultralight(ret);
1183 char *str = (ret == 0 ? "Internal networking trouble" :
1184 winsock_error_string(p_WSAGetLastError()));
1185 /* We're inside the Windows frontend here, so we know
1186 * that the frontend handle is unnecessary. */
1187 logevent(NULL, str);
1188 fatalbox("%s", str);
1190 return plug_receive(s->plug, 2, buf, ret);
1195 int bufsize_before, bufsize_after;
1197 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1199 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1200 if (bufsize_after < bufsize_before)
1201 plug_sent(s->plug, bufsize_after);
1205 /* Signal a close on the socket. First read any outstanding data. */
1208 ret = p_recv(s->s, buf, sizeof(buf), 0);
1210 err = p_WSAGetLastError();
1211 if (err == WSAEWOULDBLOCK)
1213 return plug_closing(s->plug, winsock_error_string(err),
1217 open &= plug_receive(s->plug, 0, buf, ret);
1219 open &= plug_closing(s->plug, NULL, 0, 0);
1225 struct sockaddr_in isa;
1226 int addrlen = sizeof(struct sockaddr_in);
1227 SOCKET t; /* socket of connection */
1229 memset(&isa, 0, sizeof(struct sockaddr_in));
1231 t = p_accept(s->s,(struct sockaddr *)&isa,&addrlen);
1232 if (t == INVALID_SOCKET)
1234 err = p_WSAGetLastError();
1235 if (err == WSATRY_AGAIN)
1239 if (s->localhost_only && !ipv4_is_local_addr(isa.sin_addr)) {
1240 p_closesocket(t); /* dodgy WinSock let nonlocal through */
1241 } else if (plug_accepting(s->plug, (void*)t)) {
1242 p_closesocket(t); /* denied or error */
1251 * Deal with socket errors detected in try_send().
1253 void net_pending_errors(void)
1259 * This might be a fiddly business, because it's just possible
1260 * that handling a pending error on one socket might cause
1261 * others to be closed. (I can't think of any reason this might
1262 * happen in current SSH implementation, but to maintain
1263 * generality of this network layer I'll assume the worst.)
1265 * So what we'll do is search the socket list for _one_ socket
1266 * with a pending error, and then handle it, and then search
1267 * the list again _from the beginning_. Repeat until we make a
1268 * pass with no socket errors present. That way we are
1269 * protected against the socket list changing under our feet.
1273 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1274 if (s->pending_error) {
1276 * An error has occurred on this socket. Pass it to the
1279 plug_closing(s->plug,
1280 winsock_error_string(s->pending_error),
1281 s->pending_error, 0);
1289 * Each socket abstraction contains a `void *' private field in
1290 * which the client can keep state.
1292 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1294 Actual_Socket s = (Actual_Socket) sock;
1295 s->private_ptr = ptr;
1298 static void *sk_tcp_get_private_ptr(Socket sock)
1300 Actual_Socket s = (Actual_Socket) sock;
1301 return s->private_ptr;
1305 * Special error values are returned from sk_namelookup and sk_new
1306 * if there's a problem. These functions extract an error message,
1307 * or return NULL if there's no problem.
1309 const char *sk_addr_error(SockAddr addr)
1313 static const char *sk_tcp_socket_error(Socket sock)
1315 Actual_Socket s = (Actual_Socket) sock;
1319 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1321 Actual_Socket s = (Actual_Socket) sock;
1322 if (s->frozen == is_frozen)
1324 s->frozen = is_frozen;
1325 if (!is_frozen && s->frozen_readable) {
1327 p_recv(s->s, &c, 1, MSG_PEEK);
1329 s->frozen_readable = 0;
1333 * For Plink: enumerate all sockets currently active.
1335 SOCKET first_socket(int *state)
1339 s = index234(sktree, (*state)++);
1340 return s ? s->s : INVALID_SOCKET;
1343 SOCKET next_socket(int *state)
1345 Actual_Socket s = index234(sktree, (*state)++);
1346 return s ? s->s : INVALID_SOCKET;
1349 int net_service_lookup(char *service)
1352 se = p_getservbyname(service, NULL);
1354 return p_ntohs(se->s_port);