Overhaul of client-side XDM-AUTHORIZATION-1:
[u/mdw/putty] / unix / uxnet.c
CommitLineData
c5e438ec 1/*
2 * Unix networking abstraction.
3 */
4
5#include <stdio.h>
6#include <stdlib.h>
7#include <assert.h>
8#include <errno.h>
9#include <fcntl.h>
10#include <unistd.h>
11#include <sys/types.h>
12#include <sys/socket.h>
13#include <sys/ioctl.h>
14#include <arpa/inet.h>
15#include <netinet/in.h>
16#include <netinet/tcp.h>
17#include <netdb.h>
fc0f17db 18#include <sys/un.h>
c5e438ec 19
20#define DEFINE_PLUG_METHOD_MACROS
21#include "putty.h"
22#include "network.h"
23#include "tree234.h"
24
fc0f17db 25#ifndef X11_UNIX_PATH
26# define X11_UNIX_PATH "/tmp/.X11-unix/X"
27#endif
28
c5e438ec 29struct Socket_tag {
30 struct socket_function_table *fn;
31 /* the above variable absolutely *must* be the first in this structure */
cbe2d68f 32 const char *error;
c5e438ec 33 int s;
34 Plug plug;
35 void *private_ptr;
36 bufchain output_data;
37 int connected;
38 int writable;
39 int frozen; /* this causes readability notifications to be ignored */
40 int frozen_readable; /* this means we missed at least one readability
41 * notification while we were frozen */
42 int localhost_only; /* for listening sockets */
43 char oobdata[1];
44 int sending_oob;
45 int oobpending; /* is there OOB data available to read? */
46 int oobinline;
47 int pending_error; /* in case send() returns error */
48 int listener;
7555d6a5 49 int nodelay, keepalive; /* for connect()-type sockets */
50 int privport, port; /* and again */
51 SockAddr addr;
c5e438ec 52};
53
54/*
55 * We used to typedef struct Socket_tag *Socket.
56 *
57 * Since we have made the networking abstraction slightly more
58 * abstract, Socket no longer means a tcp socket (it could mean
59 * an ssl socket). So now we must use Actual_Socket when we know
60 * we are talking about a tcp socket.
61 */
62typedef struct Socket_tag *Actual_Socket;
63
64struct SockAddr_tag {
cbe2d68f 65 const char *error;
b7a189f3 66 /*
67 * Which address family this address belongs to. AF_INET for
68 * IPv4; AF_INET6 for IPv6; AF_UNSPEC indicates that name
69 * resolution has not been done and a simple host name is held
70 * in this SockAddr structure.
71 */
c5e438ec 72 int family;
05581745 73#ifndef NO_IPV6
7555d6a5 74 struct addrinfo *ais; /* Addresses IPv6 style. */
75 struct addrinfo *ai; /* steps along the linked list */
792c5eb5 76#else
7555d6a5 77 unsigned long *addresses; /* Addresses IPv4 style. */
78 int naddresses, curraddr;
c5e438ec 79#endif
b7a189f3 80 char hostname[512]; /* Store an unresolved host name. */
c5e438ec 81};
82
83static tree234 *sktree;
84
0ff9ea38 85static void uxsel_tell(Actual_Socket s);
86
c5e438ec 87static int cmpfortree(void *av, void *bv)
88{
89 Actual_Socket a = (Actual_Socket) av, b = (Actual_Socket) bv;
90 int as = a->s, bs = b->s;
91 if (as < bs)
92 return -1;
93 if (as > bs)
94 return +1;
95 return 0;
96}
97
98static int cmpforsearch(void *av, void *bv)
99{
100 Actual_Socket b = (Actual_Socket) bv;
f7f9fb5c 101 int as = *(int *)av, bs = b->s;
c5e438ec 102 if (as < bs)
103 return -1;
104 if (as > bs)
105 return +1;
106 return 0;
107}
108
109void sk_init(void)
110{
111 sktree = newtree234(cmpfortree);
112}
113
114void sk_cleanup(void)
115{
116 Actual_Socket s;
117 int i;
118
119 if (sktree) {
120 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
121 close(s->s);
122 }
123 }
124}
125
05581745 126SockAddr sk_namelookup(const char *host, char **canonicalname, int address_family)
c5e438ec 127{
3d88e64d 128 SockAddr ret = snew(struct SockAddr_tag);
05581745 129#ifndef NO_IPV6
792c5eb5 130 struct addrinfo hints;
131 int err;
132#else
c5e438ec 133 unsigned long a;
134 struct hostent *h = NULL;
7555d6a5 135 int n;
792c5eb5 136#endif
c5e438ec 137 char realhost[8192];
138
139 /* Clear the structure and default to IPv4. */
140 memset(ret, 0, sizeof(struct SockAddr_tag));
141 ret->family = 0; /* We set this one when we have resolved the host. */
142 *realhost = '\0';
143 ret->error = NULL;
144
05581745 145#ifndef NO_IPV6
792c5eb5 146 hints.ai_flags = AI_CANONNAME;
81b34354 147 hints.ai_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
148 address_family == ADDRTYPE_IPV6 ? AF_INET6 :
149 AF_UNSPEC);
150 hints.ai_socktype = SOCK_STREAM;
792c5eb5 151 hints.ai_protocol = 0;
152 hints.ai_addrlen = 0;
153 hints.ai_addr = NULL;
154 hints.ai_canonname = NULL;
155 hints.ai_next = NULL;
7555d6a5 156 err = getaddrinfo(host, NULL, &hints, &ret->ais);
157 ret->ai = ret->ais;
792c5eb5 158 if (err != 0) {
159 ret->error = gai_strerror(err);
160 return ret;
161 }
162 ret->family = ret->ai->ai_family;
163 *realhost = '\0';
164 if (ret->ai->ai_canonname != NULL)
165 strncat(realhost, ret->ai->ai_canonname, sizeof(realhost) - 1);
166 else
167 strncat(realhost, host, sizeof(realhost) - 1);
168#else
72e22079 169 if ((a = inet_addr(host)) == (unsigned long)(in_addr_t)(-1)) {
792c5eb5 170 /*
171 * Otherwise use the IPv4-only gethostbyname... (NOTE:
172 * we don't use gethostbyname as a fallback!)
173 */
174 if (ret->family == 0) {
7555d6a5 175 /*debug(("Resolving \"%s\" with gethostbyname() (IPv4 only)...\n", host)); */
176 if ( (h = gethostbyname(host)) )
177 ret->family = AF_INET;
792c5eb5 178 }
179 if (ret->family == 0) {
7555d6a5 180 ret->error = (h_errno == HOST_NOT_FOUND ||
181 h_errno == NO_DATA ||
182 h_errno == NO_ADDRESS ? "Host does not exist" :
183 h_errno == TRY_AGAIN ?
184 "Temporary name service failure" :
185 "gethostbyname: unknown error");
186 return ret;
c5e438ec 187 }
792c5eb5 188 /* This way we are always sure the h->h_name is valid :) */
189 strncpy(realhost, h->h_name, sizeof(realhost));
7555d6a5 190 for (n = 0; h->h_addr_list[n]; n++);
191 ret->addresses = snewn(n, unsigned long);
192 ret->naddresses = n;
193 for (n = 0; n < ret->naddresses; n++) {
194 memcpy(&a, h->h_addr_list[n], sizeof(a));
195 ret->addresses[n] = ntohl(a);
196 }
c5e438ec 197 } else {
198 /*
199 * This must be a numeric IPv4 address because it caused a
200 * success return from inet_addr.
201 */
202 ret->family = AF_INET;
203 strncpy(realhost, host, sizeof(realhost));
7555d6a5 204 ret->addresses = snew(unsigned long);
205 ret->naddresses = 1;
206 ret->addresses[0] = ntohl(a);
207 ret->curraddr = 0;
c5e438ec 208 }
792c5eb5 209#endif
c5e438ec 210 realhost[lenof(realhost)-1] = '\0';
3d88e64d 211 *canonicalname = snewn(1+strlen(realhost), char);
c5e438ec 212 strcpy(*canonicalname, realhost);
213 return ret;
214}
215
e8fa8f62 216SockAddr sk_nonamelookup(const char *host)
b7a189f3 217{
3d88e64d 218 SockAddr ret = snew(struct SockAddr_tag);
ab0873ab 219 ret->error = NULL;
b7a189f3 220 ret->family = AF_UNSPEC;
221 strncpy(ret->hostname, host, lenof(ret->hostname));
222 ret->hostname[lenof(ret->hostname)-1] = '\0';
e14d27a1 223#ifndef NO_IPV6
7555d6a5 224 ret->ais = NULL;
225#else
226 ret->addresses = NULL;
e14d27a1 227#endif
b7a189f3 228 return ret;
229}
230
7555d6a5 231static int sk_nextaddr(SockAddr addr)
232{
233#ifndef NO_IPV6
234 if (addr->ai->ai_next) {
235 addr->ai = addr->ai->ai_next;
236 addr->family = addr->ai->ai_family;
237 return TRUE;
238 } else
239 return FALSE;
240#else
241 if (addr->curraddr+1 < addr->naddresses) {
242 addr->curraddr++;
243 return TRUE;
244 } else {
245 return FALSE;
246 }
247#endif
248}
249
c5e438ec 250void sk_getaddr(SockAddr addr, char *buf, int buflen)
251{
792c5eb5 252
253 if (addr->family == AF_UNSPEC) {
254 strncpy(buf, addr->hostname, buflen);
255 buf[buflen-1] = '\0';
256 } else {
05581745 257#ifndef NO_IPV6
792c5eb5 258 if (getnameinfo(addr->ai->ai_addr, addr->ai->ai_addrlen, buf, buflen,
259 NULL, 0, NI_NUMERICHOST) != 0) {
260 buf[0] = '\0';
261 strncat(buf, "<unknown>", buflen - 1);
262 }
263#else
c5e438ec 264 struct in_addr a;
792c5eb5 265 assert(addr->family == AF_INET);
7555d6a5 266 a.s_addr = htonl(addr->addresses[addr->curraddr]);
c5e438ec 267 strncpy(buf, inet_ntoa(a), buflen);
b7a189f3 268 buf[buflen-1] = '\0';
792c5eb5 269#endif
c5e438ec 270 }
c5e438ec 271}
272
b804e1e5 273int sk_hostname_is_local(char *name)
274{
275 return !strcmp(name, "localhost");
276}
277
147d3370 278#define ipv4_is_loopback(addr) \
279 (((addr).s_addr & htonl(0xff000000)) == htonl(0x7f000000))
280
281static int sockaddr_is_loopback(struct sockaddr *sa)
282{
283 struct sockaddr_in *sin;
284#ifndef NO_IPV6
285 struct sockaddr_in6 *sin6;
286#endif
287
288 switch (sa->sa_family) {
289 case AF_INET:
290 sin = (struct sockaddr_in *)sa;
291 return ipv4_is_loopback(sin->sin_addr);
292#ifndef NO_IPV6
293 case AF_INET6:
294 sin6 = (struct sockaddr_in6 *)sa;
295 return IN6_IS_ADDR_LOOPBACK(&sin6->sin6_addr);
296#endif
297 case AF_LOCAL:
298 return TRUE;
299 default:
300 return FALSE;
301 }
302}
303
b804e1e5 304int sk_address_is_local(SockAddr addr)
305{
792c5eb5 306
307 if (addr->family == AF_UNSPEC)
308 return 0; /* we don't know; assume not */
309 else {
05581745 310#ifndef NO_IPV6
147d3370 311 return sockaddr_is_loopback(addr->ai->ai_addr);
792c5eb5 312#else
b804e1e5 313 struct in_addr a;
792c5eb5 314 assert(addr->family == AF_INET);
7555d6a5 315 a.s_addr = htonl(addr->addresses[addr->curraddr]);
b804e1e5 316 return ipv4_is_loopback(a);
792c5eb5 317#endif
b804e1e5 318 }
b804e1e5 319}
320
c5e438ec 321int sk_addrtype(SockAddr addr)
322{
b7a189f3 323 return (addr->family == AF_INET ? ADDRTYPE_IPV4 :
05581745 324#ifndef NO_IPV6
b7a189f3 325 addr->family == AF_INET6 ? ADDRTYPE_IPV6 :
326#endif
327 ADDRTYPE_NAME);
c5e438ec 328}
329
330void sk_addrcopy(SockAddr addr, char *buf)
331{
792c5eb5 332
05581745 333#ifndef NO_IPV6
792c5eb5 334 if (addr->family == AF_INET)
335 memcpy(buf, &((struct sockaddr_in *)addr->ai->ai_addr)->sin_addr,
336 sizeof(struct in_addr));
337 else if (addr->family == AF_INET6)
338 memcpy(buf, &((struct sockaddr_in6 *)addr->ai->ai_addr)->sin6_addr,
339 sizeof(struct in6_addr));
340 else
341 assert(FALSE);
342#else
343 struct in_addr a;
344
345 assert(addr->family == AF_INET);
7555d6a5 346 a.s_addr = htonl(addr->addresses[addr->curraddr]);
792c5eb5 347 memcpy(buf, (char*) &a.s_addr, 4);
c5e438ec 348#endif
c5e438ec 349}
350
351void sk_addr_free(SockAddr addr)
352{
792c5eb5 353
05581745 354#ifndef NO_IPV6
7555d6a5 355 if (addr->ais != NULL)
356 freeaddrinfo(addr->ais);
357#else
358 sfree(addr->addresses);
792c5eb5 359#endif
c5e438ec 360 sfree(addr);
361}
362
363static Plug sk_tcp_plug(Socket sock, Plug p)
364{
365 Actual_Socket s = (Actual_Socket) sock;
366 Plug ret = s->plug;
367 if (p)
368 s->plug = p;
369 return ret;
370}
371
372static void sk_tcp_flush(Socket s)
373{
374 /*
375 * We send data to the socket as soon as we can anyway,
376 * so we don't need to do anything here. :-)
377 */
378}
379
380static void sk_tcp_close(Socket s);
e0e7dff8 381static int sk_tcp_write(Socket s, const char *data, int len);
382static int sk_tcp_write_oob(Socket s, const char *data, int len);
c5e438ec 383static void sk_tcp_set_private_ptr(Socket s, void *ptr);
384static void *sk_tcp_get_private_ptr(Socket s);
385static void sk_tcp_set_frozen(Socket s, int is_frozen);
cbe2d68f 386static const char *sk_tcp_socket_error(Socket s);
c5e438ec 387
2f92b717 388static struct socket_function_table tcp_fn_table = {
389 sk_tcp_plug,
390 sk_tcp_close,
391 sk_tcp_write,
392 sk_tcp_write_oob,
393 sk_tcp_flush,
394 sk_tcp_set_private_ptr,
395 sk_tcp_get_private_ptr,
396 sk_tcp_set_frozen,
397 sk_tcp_socket_error
398};
399
f7f9fb5c 400Socket sk_register(OSSocket sockfd, Plug plug)
c5e438ec 401{
c5e438ec 402 Actual_Socket ret;
403
404 /*
405 * Create Socket structure.
406 */
3d88e64d 407 ret = snew(struct Socket_tag);
2f92b717 408 ret->fn = &tcp_fn_table;
c5e438ec 409 ret->error = NULL;
410 ret->plug = plug;
411 bufchain_init(&ret->output_data);
412 ret->writable = 1; /* to start with */
413 ret->sending_oob = 0;
414 ret->frozen = 1;
415 ret->frozen_readable = 0;
416 ret->localhost_only = 0; /* unused, but best init anyway */
417 ret->pending_error = 0;
418 ret->oobpending = FALSE;
419 ret->listener = 0;
7555d6a5 420 ret->addr = NULL;
c5e438ec 421
f7f9fb5c 422 ret->s = sockfd;
c5e438ec 423
424 if (ret->s < 0) {
7555d6a5 425 ret->error = strerror(errno);
c5e438ec 426 return (Socket) ret;
427 }
428
429 ret->oobinline = 0;
430
0ff9ea38 431 uxsel_tell(ret);
c5e438ec 432 add234(sktree, ret);
433
434 return (Socket) ret;
435}
436
7555d6a5 437static int try_connect(Actual_Socket sock)
c5e438ec 438{
c5e438ec 439 int s;
05581745 440#ifndef NO_IPV6
c5e438ec 441 struct sockaddr_in6 a6;
442#endif
443 struct sockaddr_in a;
fc0f17db 444 struct sockaddr_un au;
445 const struct sockaddr *sa;
7555d6a5 446 int err = 0;
c5e438ec 447 short localport;
fc0f17db 448 int fl, salen;
c5e438ec 449
7555d6a5 450 if (sock->s >= 0)
451 close(sock->s);
452
453 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
c5e438ec 454
455 /*
456 * Open socket.
457 */
7555d6a5 458 assert(sock->addr->family != AF_UNSPEC);
459 s = socket(sock->addr->family, SOCK_STREAM, 0);
460 sock->s = s;
c5e438ec 461
462 if (s < 0) {
7555d6a5 463 err = errno;
464 goto ret;
c5e438ec 465 }
466
7555d6a5 467 if (sock->oobinline) {
c5e438ec 468 int b = TRUE;
469 setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
470 }
471
7555d6a5 472 if (sock->nodelay) {
c5e438ec 473 int b = TRUE;
474 setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
475 }
476
7555d6a5 477 if (sock->keepalive) {
79bf227b 478 int b = TRUE;
479 setsockopt(s, SOL_SOCKET, SO_KEEPALIVE, (void *) &b, sizeof(b));
480 }
481
c5e438ec 482 /*
483 * Bind to local address.
484 */
7555d6a5 485 if (sock->privport)
c5e438ec 486 localport = 1023; /* count from 1023 downwards */
487 else
488 localport = 0; /* just use port 0 (ie kernel picks) */
489
d2c29274 490 /* BSD IP stacks need sockaddr_in zeroed before filling in */
491 memset(&a,'\0',sizeof(struct sockaddr_in));
05581745 492#ifndef NO_IPV6
d2c29274 493 memset(&a6,'\0',sizeof(struct sockaddr_in6));
494#endif
fc0f17db 495
496 /* We don't try to bind to a local address for UNIX domain sockets. (Why
497 * do we bother doing the bind when localport == 0 anyway?) */
7555d6a5 498 if(sock->addr->family != AF_UNIX) {
fc0f17db 499 /* Loop round trying to bind */
500 while (1) {
501 int retcode;
c5e438ec 502
05581745 503#ifndef NO_IPV6
7555d6a5 504 if (sock->addr->family == AF_INET6) {
fc0f17db 505 /* XXX use getaddrinfo to get a local address? */
506 a6.sin6_family = AF_INET6;
507 a6.sin6_addr = in6addr_any;
508 a6.sin6_port = htons(localport);
509 retcode = bind(s, (struct sockaddr *) &a6, sizeof(a6));
510 } else
c5e438ec 511#endif
fc0f17db 512 {
7555d6a5 513 assert(sock->addr->family == AF_INET);
fc0f17db 514 a.sin_family = AF_INET;
515 a.sin_addr.s_addr = htonl(INADDR_ANY);
516 a.sin_port = htons(localport);
517 retcode = bind(s, (struct sockaddr *) &a, sizeof(a));
518 }
519 if (retcode >= 0) {
520 err = 0;
521 break; /* done */
522 } else {
523 err = errno;
524 if (err != EADDRINUSE) /* failed, for a bad reason */
525 break;
526 }
527
528 if (localport == 0)
529 break; /* we're only looping once */
530 localport--;
531 if (localport == 0)
532 break; /* we might have got to the end */
c5e438ec 533 }
fc0f17db 534
7555d6a5 535 if (err)
536 goto ret;
c5e438ec 537 }
538
539 /*
540 * Connect to remote address.
541 */
7555d6a5 542 switch(sock->addr->family) {
05581745 543#ifndef NO_IPV6
fc0f17db 544 case AF_INET:
545 /* XXX would be better to have got getaddrinfo() to fill in the port. */
7555d6a5 546 ((struct sockaddr_in *)sock->addr->ai->ai_addr)->sin_port =
547 htons(sock->port);
548 sa = (const struct sockaddr *)sock->addr->ai->ai_addr;
549 salen = sock->addr->ai->ai_addrlen;
fc0f17db 550 break;
551 case AF_INET6:
7555d6a5 552 ((struct sockaddr_in *)sock->addr->ai->ai_addr)->sin_port =
553 htons(sock->port);
554 sa = (const struct sockaddr *)sock->addr->ai->ai_addr;
555 salen = sock->addr->ai->ai_addrlen;
fc0f17db 556 break;
792c5eb5 557#else
fc0f17db 558 case AF_INET:
559 a.sin_family = AF_INET;
7555d6a5 560 a.sin_addr.s_addr = htonl(sock->addr->addresses[sock->addr->curraddr]);
561 a.sin_port = htons((short) sock->port);
fc0f17db 562 sa = (const struct sockaddr *)&a;
563 salen = sizeof a;
564 break;
792c5eb5 565#endif
fc0f17db 566 case AF_UNIX:
7555d6a5 567 assert(sock->port == 0); /* to catch confused people */
568 assert(strlen(sock->addr->hostname) < sizeof au.sun_path);
fc0f17db 569 memset(&au, 0, sizeof au);
570 au.sun_family = AF_UNIX;
7555d6a5 571 strcpy(au.sun_path, sock->addr->hostname);
fc0f17db 572 sa = (const struct sockaddr *)&au;
573 salen = sizeof au;
574 break;
575
576 default:
577 assert(0 && "unknown address family");
578 }
4b70e70e 579
580 fl = fcntl(s, F_GETFL);
581 if (fl != -1)
582 fcntl(s, F_SETFL, fl | O_NONBLOCK);
051dd789 583
fc0f17db 584 if ((connect(s, sa, salen)) < 0) {
051dd789 585 if ( errno != EINPROGRESS ) {
7555d6a5 586 err = errno;
587 goto ret;
c5e438ec 588 }
589 } else {
590 /*
591 * If we _don't_ get EWOULDBLOCK, the connect has completed
592 * and we should set the socket as connected and writable.
593 */
7555d6a5 594 sock->connected = 1;
595 sock->writable = 1;
c5e438ec 596 }
597
7555d6a5 598 uxsel_tell(sock);
599 add234(sktree, sock);
600
601 ret:
602 if (err)
603 plug_log(sock->plug, 1, sock->addr, sock->port, strerror(err), err);
604 return err;
605}
606
607Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
608 int nodelay, int keepalive, Plug plug)
609{
610 Actual_Socket ret;
611 int err;
612
613 /*
614 * Create Socket structure.
615 */
616 ret = snew(struct Socket_tag);
617 ret->fn = &tcp_fn_table;
618 ret->error = NULL;
619 ret->plug = plug;
620 bufchain_init(&ret->output_data);
621 ret->connected = 0; /* to start with */
622 ret->writable = 0; /* to start with */
623 ret->sending_oob = 0;
624 ret->frozen = 0;
625 ret->frozen_readable = 0;
626 ret->localhost_only = 0; /* unused, but best init anyway */
627 ret->pending_error = 0;
628 ret->oobpending = FALSE;
629 ret->listener = 0;
630 ret->addr = addr;
631 ret->s = -1;
632 ret->oobinline = oobinline;
633 ret->nodelay = nodelay;
634 ret->keepalive = keepalive;
635 ret->privport = privport;
636 ret->port = port;
637
638 err = 0;
639 do {
640 err = try_connect(ret);
641 } while (err && sk_nextaddr(ret->addr));
c5e438ec 642
7555d6a5 643 if (err)
644 ret->error = strerror(err);
f85e6f6e 645
c5e438ec 646 return (Socket) ret;
647}
648
05581745 649Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only, int address_family)
c5e438ec 650{
c5e438ec 651 int s;
05581745 652#ifndef NO_IPV6
792c5eb5 653 struct addrinfo hints, *ai;
654 char portstr[6];
adb18b94 655 struct sockaddr_in6 a6;
792c5eb5 656#endif
adb18b94 657 struct sockaddr *addr;
658 int addrlen;
c5e438ec 659 struct sockaddr_in a;
c5e438ec 660 Actual_Socket ret;
661 int retcode;
662 int on = 1;
663
664 /*
665 * Create Socket structure.
666 */
3d88e64d 667 ret = snew(struct Socket_tag);
2f92b717 668 ret->fn = &tcp_fn_table;
c5e438ec 669 ret->error = NULL;
670 ret->plug = plug;
671 bufchain_init(&ret->output_data);
672 ret->writable = 0; /* to start with */
673 ret->sending_oob = 0;
674 ret->frozen = 0;
675 ret->frozen_readable = 0;
676 ret->localhost_only = local_host_only;
677 ret->pending_error = 0;
678 ret->oobpending = FALSE;
679 ret->listener = 1;
7555d6a5 680 ret->addr = NULL;
c5e438ec 681
682 /*
05581745 683 * Translate address_family from platform-independent constants
684 * into local reality.
685 */
686 address_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
687 address_family == ADDRTYPE_IPV6 ? AF_INET6 : AF_UNSPEC);
688
689#ifndef NO_IPV6
690 /* Let's default to IPv6.
691 * If the stack doesn't support IPv6, we will fall back to IPv4. */
692 if (address_family == AF_UNSPEC) address_family = AF_INET6;
693#else
694 /* No other choice, default to IPv4 */
695 if (address_family == AF_UNSPEC) address_family = AF_INET;
696#endif
697
698 /*
c5e438ec 699 * Open socket.
700 */
05581745 701 s = socket(address_family, SOCK_STREAM, 0);
702
703 /* If the host doesn't support IPv6 try fallback to IPv4. */
704 if (s < 0 && address_family == AF_INET6) {
705 address_family = AF_INET;
706 s = socket(address_family, SOCK_STREAM, 0);
707 }
c5e438ec 708
709 if (s < 0) {
7555d6a5 710 ret->error = strerror(errno);
c5e438ec 711 return (Socket) ret;
712 }
713
714 ret->oobinline = 0;
715
716 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
717
adb18b94 718 retcode = -1;
719 addr = NULL; addrlen = -1; /* placate optimiser */
720
721 if (srcaddr != NULL) {
05581745 722#ifndef NO_IPV6
adb18b94 723 hints.ai_flags = AI_NUMERICHOST;
724 hints.ai_family = address_family;
d5474756 725 hints.ai_socktype = SOCK_STREAM;
adb18b94 726 hints.ai_protocol = 0;
727 hints.ai_addrlen = 0;
728 hints.ai_addr = NULL;
729 hints.ai_canonname = NULL;
730 hints.ai_next = NULL;
062af27b 731 assert(port >= 0 && port <= 99999);
adb18b94 732 sprintf(portstr, "%d", port);
733 retcode = getaddrinfo(srcaddr, portstr, &hints, &ai);
7f8c817c 734 if (retcode == 0) {
ca9892ae 735 addr = ai->ai_addr;
736 addrlen = ai->ai_addrlen;
737 }
adb18b94 738#else
739 memset(&a,'\0',sizeof(struct sockaddr_in));
740 a.sin_family = AF_INET;
741 a.sin_port = htons(port);
742 a.sin_addr.s_addr = inet_addr(srcaddr);
743 if (a.sin_addr.s_addr != (in_addr_t)(-1)) {
744 /* Override localhost_only with specified listen addr. */
745 ret->localhost_only = ipv4_is_loopback(a.sin_addr);
746 got_addr = 1;
747 }
748 addr = (struct sockaddr *)a;
749 addrlen = sizeof(a);
750 retcode = 0;
792c5eb5 751#endif
adb18b94 752 }
6ee9b735 753
adb18b94 754 if (retcode != 0) {
755#ifndef NO_IPV6
756 if (address_family == AF_INET6) {
757 memset(&a6,'\0',sizeof(struct sockaddr_in6));
758 a6.sin6_family = AF_INET6;
759 a6.sin6_port = htons(port);
760 if (local_host_only)
761 a6.sin6_addr = in6addr_loopback;
762 else
763 a6.sin6_addr = in6addr_any;
764 addr = (struct sockaddr *)&a6;
765 addrlen = sizeof(a6);
766 } else
767#endif
768 {
769 memset(&a,'\0',sizeof(struct sockaddr_in));
770 a.sin_family = AF_INET;
771 a.sin_port = htons(port);
6ee9b735 772 if (local_host_only)
773 a.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
774 else
775 a.sin_addr.s_addr = htonl(INADDR_ANY);
adb18b94 776 addr = (struct sockaddr *)&a;
777 addrlen = sizeof(a);
778 }
c5e438ec 779 }
780
adb18b94 781 retcode = bind(s, addr, addrlen);
782 if (retcode < 0) {
783 close(s);
7555d6a5 784 ret->error = strerror(errno);
c5e438ec 785 return (Socket) ret;
786 }
787
c5e438ec 788 if (listen(s, SOMAXCONN) < 0) {
789 close(s);
7555d6a5 790 ret->error = strerror(errno);
c5e438ec 791 return (Socket) ret;
792 }
793
adb18b94 794 ret->s = s;
795
0ff9ea38 796 uxsel_tell(ret);
c5e438ec 797 add234(sktree, ret);
798
799 return (Socket) ret;
800}
801
802static void sk_tcp_close(Socket sock)
803{
804 Actual_Socket s = (Actual_Socket) sock;
805
0ff9ea38 806 uxsel_del(s->s);
c5e438ec 807 del234(sktree, s);
808 close(s->s);
7555d6a5 809 if (s->addr)
810 sk_addr_free(s->addr);
c5e438ec 811 sfree(s);
812}
813
0a4022a1 814#define PUT_32BIT_MSB_FIRST(cp, value) ( \
815 (cp)[0] = (char)((value) >> 24), \
816 (cp)[1] = (char)((value) >> 16), \
817 (cp)[2] = (char)((value) >> 8), \
818 (cp)[3] = (char)(value) )
819
820#define PUT_16BIT_MSB_FIRST(cp, value) ( \
821 (cp)[0] = (char)((value) >> 8), \
822 (cp)[1] = (char)(value) )
823
824void *sk_getxdmdata(void *sock, int *lenp)
2f92b717 825{
826 Actual_Socket s = (Actual_Socket) sock;
0a4022a1 827#ifdef NO_IPV6
2f92b717 828 struct sockaddr_in addr;
0a4022a1 829#else
830 struct sockaddr_storage addr;
831 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)&addr;
832#endif
833 struct sockaddr *sa = (struct sockaddr *)&addr;
834 struct sockaddr_in *sin = (struct sockaddr_in *)&addr;
2f92b717 835 socklen_t addrlen;
0a4022a1 836 char *buf;
837 static unsigned int unix_addr = 0xFFFFFFFF;
2f92b717 838
839 /*
840 * We must check that this socket really _is_ an Actual_Socket.
841 */
842 if (s->fn != &tcp_fn_table)
0a4022a1 843 return NULL; /* failure */
2f92b717 844
2f92b717 845 addrlen = sizeof(addr);
0a4022a1 846 if (getsockname(s->s, sa, &addrlen) < 0)
847 return NULL;
848 switch(sa->sa_family) {
fc0f17db 849 case AF_INET:
0a4022a1 850 *lenp = 6;
851 buf = snewn(*lenp, char);
852 PUT_32BIT_MSB_FIRST(buf, ntohl(sin->sin_addr.s_addr));
853 PUT_16BIT_MSB_FIRST(buf+4, ntohs(sin->sin_port));
fc0f17db 854 break;
0a4022a1 855#ifndef NO_IPV6
856 case AF_INET6:
857 *lenp = 6;
858 buf = snewn(*lenp, char);
859 if (IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr)) {
860 memcpy(buf, sin6->sin6_addr.s6_addr + 12, 4);
861 PUT_16BIT_MSB_FIRST(buf+4, ntohs(sin6->sin6_port));
862 } else
863 /* This is stupid, but it's what XLib does. */
864 memset(buf, 0, 6);
865 break;
866#endif
fc0f17db 867 case AF_UNIX:
0a4022a1 868 *lenp = 6;
869 buf = snewn(*lenp, char);
870 PUT_32BIT_MSB_FIRST(buf, unix_addr--);
871 PUT_16BIT_MSB_FIRST(buf+4, getpid());
fc0f17db 872 break;
2f92b717 873
fc0f17db 874 /* XXX IPV6 */
875
876 default:
0a4022a1 877 return NULL;
fc0f17db 878 }
2f92b717 879
0a4022a1 880 return buf;
2f92b717 881}
882
c5e438ec 883/*
884 * The function which tries to send on a socket once it's deemed
885 * writable.
886 */
887void try_send(Actual_Socket s)
888{
889 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
890 int nsent;
891 int err;
892 void *data;
893 int len, urgentflag;
894
895 if (s->sending_oob) {
896 urgentflag = MSG_OOB;
897 len = s->sending_oob;
898 data = &s->oobdata;
899 } else {
900 urgentflag = 0;
901 bufchain_prefix(&s->output_data, &data, &len);
902 }
903 nsent = send(s->s, data, len, urgentflag);
904 noise_ultralight(nsent);
905 if (nsent <= 0) {
906 err = (nsent < 0 ? errno : 0);
907 if (err == EWOULDBLOCK) {
908 /*
909 * Perfectly normal: we've sent all we can for the moment.
910 */
911 s->writable = FALSE;
912 return;
913 } else if (nsent == 0 ||
914 err == ECONNABORTED || err == ECONNRESET) {
915 /*
916 * If send() returns CONNABORTED or CONNRESET, we
917 * unfortunately can't just call plug_closing(),
918 * because it's quite likely that we're currently
919 * _in_ a call from the code we'd be calling back
920 * to, so we'd have to make half the SSH code
921 * reentrant. Instead we flag a pending error on
922 * the socket, to be dealt with (by calling
923 * plug_closing()) at some suitable future moment.
924 */
925 s->pending_error = err;
926 return;
927 } else {
928 /* We're inside the Unix frontend here, so we know
929 * that the frontend handle is unnecessary. */
7555d6a5 930 logevent(NULL, strerror(err));
931 fatalbox("%s", strerror(err));
c5e438ec 932 }
933 } else {
934 if (s->sending_oob) {
935 if (nsent < len) {
936 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
937 s->sending_oob = len - nsent;
938 } else {
939 s->sending_oob = 0;
940 }
941 } else {
942 bufchain_consume(&s->output_data, nsent);
943 }
944 }
945 }
0ff9ea38 946 uxsel_tell(s);
c5e438ec 947}
948
e0e7dff8 949static int sk_tcp_write(Socket sock, const char *buf, int len)
c5e438ec 950{
951 Actual_Socket s = (Actual_Socket) sock;
952
953 /*
954 * Add the data to the buffer list on the socket.
955 */
956 bufchain_add(&s->output_data, buf, len);
957
958 /*
959 * Now try sending from the start of the buffer list.
960 */
961 if (s->writable)
962 try_send(s);
963
c2a71b0d 964 /*
965 * Update the select() status to correctly reflect whether or
966 * not we should be selecting for write.
967 */
968 uxsel_tell(s);
969
c5e438ec 970 return bufchain_size(&s->output_data);
971}
972
e0e7dff8 973static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
c5e438ec 974{
975 Actual_Socket s = (Actual_Socket) sock;
976
977 /*
978 * Replace the buffer list on the socket with the data.
979 */
980 bufchain_clear(&s->output_data);
981 assert(len <= sizeof(s->oobdata));
982 memcpy(s->oobdata, buf, len);
983 s->sending_oob = len;
984
985 /*
986 * Now try sending from the start of the buffer list.
987 */
988 if (s->writable)
989 try_send(s);
990
c2a71b0d 991 /*
992 * Update the select() status to correctly reflect whether or
993 * not we should be selecting for write.
994 */
995 uxsel_tell(s);
996
c5e438ec 997 return s->sending_oob;
998}
999
0ff9ea38 1000static int net_select_result(int fd, int event)
c5e438ec 1001{
1002 int ret;
c5e438ec 1003 char buf[20480]; /* nice big buffer for plenty of speed */
1004 Actual_Socket s;
1005 u_long atmark;
1006
1007 /* Find the Socket structure */
f7f9fb5c 1008 s = find234(sktree, &fd, cmpforsearch);
c5e438ec 1009 if (!s)
1010 return 1; /* boggle */
1011
1012 noise_ultralight(event);
1013
1014 switch (event) {
c5e438ec 1015 case 4: /* exceptional */
1016 if (!s->oobinline) {
1017 /*
1018 * On a non-oobinline socket, this indicates that we
1019 * can immediately perform an OOB read and get back OOB
1020 * data, which we will send to the back end with
1021 * type==2 (urgent data).
1022 */
1023 ret = recv(s->s, buf, sizeof(buf), MSG_OOB);
1024 noise_ultralight(ret);
1025 if (ret <= 0) {
cbe2d68f 1026 const char *str = (ret == 0 ? "Internal networking trouble" :
7555d6a5 1027 strerror(errno));
c5e438ec 1028 /* We're inside the Unix frontend here, so we know
1029 * that the frontend handle is unnecessary. */
1030 logevent(NULL, str);
1031 fatalbox("%s", str);
1032 } else {
7555d6a5 1033 /*
1034 * Receiving actual data on a socket means we can
1035 * stop falling back through the candidate
1036 * addresses to connect to.
1037 */
1038 if (s->addr) {
1039 sk_addr_free(s->addr);
1040 s->addr = NULL;
1041 }
c5e438ec 1042 return plug_receive(s->plug, 2, buf, ret);
1043 }
1044 break;
1045 }
1046
1047 /*
1048 * If we reach here, this is an oobinline socket, which
56e5b2db 1049 * means we should set s->oobpending and then deal with it
1050 * when we get called for the readability event (which
1051 * should also occur).
c5e438ec 1052 */
1053 s->oobpending = TRUE;
56e5b2db 1054 break;
c5e438ec 1055 case 1: /* readable; also acceptance */
1056 if (s->listener) {
1057 /*
1058 * On a listening socket, the readability event means a
1059 * connection is ready to be accepted.
1060 */
19a4130c 1061#ifdef NO_IPV6
1062 struct sockaddr_in ss;
1063#else
1064 struct sockaddr_storage ss;
1065#endif
1066 socklen_t addrlen = sizeof(ss);
c5e438ec 1067 int t; /* socket of connection */
1068
19a4130c 1069 memset(&ss, 0, addrlen);
1070 t = accept(s->s, (struct sockaddr *)&ss, &addrlen);
c5e438ec 1071 if (t < 0) {
1072 break;
1073 }
1074
19a4130c 1075 if (s->localhost_only &&
1076 !sockaddr_is_loopback((struct sockaddr *)&ss)) {
c5e438ec 1077 close(t); /* someone let nonlocal through?! */
f7f9fb5c 1078 } else if (plug_accepting(s->plug, t)) {
c5e438ec 1079 close(t); /* denied or error */
1080 }
1081 break;
1082 }
1083
1084 /*
1085 * If we reach here, this is not a listening socket, so
1086 * readability really means readability.
1087 */
1088
1089 /* In the case the socket is still frozen, we don't even bother */
1090 if (s->frozen) {
1091 s->frozen_readable = 1;
1092 break;
1093 }
1094
1095 /*
1096 * We have received data on the socket. For an oobinline
1097 * socket, this might be data _before_ an urgent pointer,
1098 * in which case we send it to the back end with type==1
1099 * (data prior to urgent).
1100 */
1101 if (s->oobinline && s->oobpending) {
1102 atmark = 1;
1103 if (ioctl(s->s, SIOCATMARK, &atmark) == 0 && atmark)
1104 s->oobpending = FALSE; /* clear this indicator */
1105 } else
1106 atmark = 1;
1107
56e5b2db 1108 ret = recv(s->s, buf, s->oobpending ? 1 : sizeof(buf), 0);
c5e438ec 1109 noise_ultralight(ret);
1110 if (ret < 0) {
1111 if (errno == EWOULDBLOCK) {
1112 break;
1113 }
1114 }
1115 if (ret < 0) {
7555d6a5 1116 /*
1117 * An error at this point _might_ be an error reported
1118 * by a non-blocking connect(). So before we return a
1119 * panic status to the user, let's just see whether
1120 * that's the case.
1121 */
1122 int err = errno;
1123 if (s->addr) {
1124 plug_log(s->plug, 1, s->addr, s->port, strerror(err), err);
1125 while (s->addr && sk_nextaddr(s->addr)) {
1126 err = try_connect(s);
1127 }
1128 }
1129 if (err != 0)
1130 return plug_closing(s->plug, strerror(err), err, 0);
c5e438ec 1131 } else if (0 == ret) {
1132 return plug_closing(s->plug, NULL, 0, 0);
1133 } else {
7555d6a5 1134 /*
1135 * Receiving actual data on a socket means we can
1136 * stop falling back through the candidate
1137 * addresses to connect to.
1138 */
1139 if (s->addr) {
1140 sk_addr_free(s->addr);
1141 s->addr = NULL;
1142 }
c5e438ec 1143 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1144 }
1145 break;
1146 case 2: /* writable */
051dd789 1147 if (!s->connected) {
1148 /*
1149 * select() reports a socket as _writable_ when an
1150 * asynchronous connection is completed.
1151 */
1152 s->connected = s->writable = 1;
0ff9ea38 1153 uxsel_tell(s);
051dd789 1154 break;
1155 } else {
c5e438ec 1156 int bufsize_before, bufsize_after;
1157 s->writable = 1;
1158 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1159 try_send(s);
1160 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1161 if (bufsize_after < bufsize_before)
1162 plug_sent(s->plug, bufsize_after);
1163 }
1164 break;
1165 }
1166
1167 return 1;
1168}
1169
1170/*
1171 * Deal with socket errors detected in try_send().
1172 */
1173void net_pending_errors(void)
1174{
1175 int i;
1176 Actual_Socket s;
1177
1178 /*
1179 * This might be a fiddly business, because it's just possible
1180 * that handling a pending error on one socket might cause
1181 * others to be closed. (I can't think of any reason this might
1182 * happen in current SSH implementation, but to maintain
1183 * generality of this network layer I'll assume the worst.)
1184 *
1185 * So what we'll do is search the socket list for _one_ socket
1186 * with a pending error, and then handle it, and then search
1187 * the list again _from the beginning_. Repeat until we make a
1188 * pass with no socket errors present. That way we are
1189 * protected against the socket list changing under our feet.
1190 */
1191
1192 do {
1193 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
1194 if (s->pending_error) {
1195 /*
1196 * An error has occurred on this socket. Pass it to the
1197 * plug.
1198 */
7555d6a5 1199 plug_closing(s->plug, strerror(s->pending_error),
c5e438ec 1200 s->pending_error, 0);
1201 break;
1202 }
1203 }
1204 } while (s);
1205}
1206
1207/*
1208 * Each socket abstraction contains a `void *' private field in
1209 * which the client can keep state.
1210 */
1211static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1212{
1213 Actual_Socket s = (Actual_Socket) sock;
1214 s->private_ptr = ptr;
1215}
1216
1217static void *sk_tcp_get_private_ptr(Socket sock)
1218{
1219 Actual_Socket s = (Actual_Socket) sock;
1220 return s->private_ptr;
1221}
1222
1223/*
1224 * Special error values are returned from sk_namelookup and sk_new
1225 * if there's a problem. These functions extract an error message,
1226 * or return NULL if there's no problem.
1227 */
cbe2d68f 1228const char *sk_addr_error(SockAddr addr)
c5e438ec 1229{
1230 return addr->error;
1231}
cbe2d68f 1232static const char *sk_tcp_socket_error(Socket sock)
c5e438ec 1233{
1234 Actual_Socket s = (Actual_Socket) sock;
1235 return s->error;
1236}
1237
1238static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1239{
1240 Actual_Socket s = (Actual_Socket) sock;
1241 if (s->frozen == is_frozen)
1242 return;
1243 s->frozen = is_frozen;
1244 if (!is_frozen && s->frozen_readable) {
1245 char c;
1246 recv(s->s, &c, 1, MSG_PEEK);
1247 }
1248 s->frozen_readable = 0;
0ff9ea38 1249 uxsel_tell(s);
c5e438ec 1250}
1251
0ff9ea38 1252static void uxsel_tell(Actual_Socket s)
c5e438ec 1253{
0ff9ea38 1254 int rwx = 0;
051dd789 1255 if (!s->connected)
0ff9ea38 1256 rwx |= 2; /* write == connect */
c5e438ec 1257 if (s->connected && !s->frozen)
0ff9ea38 1258 rwx |= 1 | 4; /* read, except */
c5e438ec 1259 if (bufchain_size(&s->output_data))
0ff9ea38 1260 rwx |= 2; /* write */
c5e438ec 1261 if (s->listener)
0ff9ea38 1262 rwx |= 1; /* read == accept */
1263 uxsel_set(s->s, rwx, net_select_result);
c5e438ec 1264}
1265
1266int net_service_lookup(char *service)
1267{
1268 struct servent *se;
1269 se = getservbyname(service, NULL);
1270 if (se != NULL)
1271 return ntohs(se->s_port);
1272 else
1273 return 0;
1274}
fc0f17db 1275
1276SockAddr platform_get_x11_unix_address(int displaynum, char **canonicalname)
1277{
1278 SockAddr ret = snew(struct SockAddr_tag);
1279 int n;
1280
1281 memset(ret, 0, sizeof *ret);
1282 ret->family = AF_UNIX;
1283 n = snprintf(ret->hostname, sizeof ret->hostname,
1284 "%s%d", X11_UNIX_PATH, displaynum);
1285 if(n < 0)
1286 ret->error = "snprintf failed";
1287 else if(n >= sizeof ret->hostname)
1288 ret->error = "X11 UNIX name too long";
1289 else
1290 *canonicalname = dupstr(ret->hostname);
7555d6a5 1291#ifndef NO_IPV6
1292 ret->ais = NULL;
1293#else
1294 ret->addresses = NULL;
1295#endif
fc0f17db 1296 return ret;
1297}