51bd74bcb139b7626e754a3c2f4f5f350052e6ae
[users/jgh/exim.git] / src / src / ip.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
7
8 /* Functions for doing things with sockets. With the advent of IPv6 this has
9 got messier, so that it's worth pulling out the code into separate functions
10 that other parts of Exim can call, especially as there are now several
11 different places in the code where sockets are used. */
12
13
14 #include "exim.h"
15
16
17 /*************************************************
18 *             Create a socket                    *
19 *************************************************/
20
21 /* Socket creation happens in a number of places so it's packaged here for
22 convenience.
23
24 Arguments:
25   type       SOCK_DGRAM or SOCK_STREAM
26   af         AF_INET or AF_INET6
27
28 Returns:     socket number or -1 on failure
29 */
30
31 int
32 ip_socket(int type, int af)
33 {
34 int sock = socket(af, type, 0);
35 if (sock < 0)
36   log_write(0, LOG_MAIN, "IPv%c socket creation failed: %s",
37     (af == AF_INET6)? '6':'4', strerror(errno));
38 return sock;
39 }
40
41
42
43
44 #if HAVE_IPV6
45 /*************************************************
46 *      Convert printing address to numeric       *
47 *************************************************/
48
49 /* This function converts the textual form of an IP address into a numeric form
50 in an appropriate structure in an IPv6 environment. The getaddrinfo() function
51 can (apparently) handle more complicated addresses (e.g. those containing
52 scopes) than inet_pton() in some environments. We use hints to tell it that the
53 input must be a numeric address.
54
55 However, apparently some operating systems (or libraries) don't support
56 getaddrinfo(), so there is a build-time option to revert to inet_pton() (which
57 does not support scopes).
58
59 Arguments:
60   address     textual form of the address
61   addr        where to copy back the answer
62
63 Returns:      nothing - failure provokes a panic-die
64 */
65
66 static void
67 ip_addrinfo(const uschar *address, struct sockaddr_in6 *saddr)
68 {
69 #ifdef IPV6_USE_INET_PTON
70
71   if (inet_pton(AF_INET6, CCS address, &saddr->sin6_addr) != 1)
72     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "unable to parse \"%s\" as an "
73       "IP address", address);
74   saddr->sin6_family = AF_INET6;
75
76 #else
77
78   int rc;
79   struct addrinfo hints, *res;
80   memset(&hints, 0, sizeof(hints));
81   hints.ai_family = AF_INET6;
82   hints.ai_socktype = SOCK_STREAM;
83   hints.ai_flags = AI_NUMERICHOST;
84   if ((rc = getaddrinfo(CCS address, NULL, &hints, &res)) != 0 || res == NULL)
85     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "unable to parse \"%s\" as an "
86       "IP address: %s", address,
87       (rc == 0)? "NULL result returned" : gai_strerror(rc));
88   memcpy(saddr, res->ai_addr, res->ai_addrlen);
89   freeaddrinfo(res);
90
91 #endif
92 }
93 #endif  /* HAVE_IPV6 */
94
95
96 /*************************************************
97 *         Bind socket to interface and port      *
98 *************************************************/
99
100 int
101 ip_addr(void * sin_, int af, const uschar * address, int port)
102 {
103 union sockaddr_46 * sin = sin_;
104 memset(sin, 0, sizeof(*sin));
105
106 /* Setup code when using an IPv6 socket. The wildcard address is ":", to
107 ensure an IPv6 socket is used. */
108
109 #if HAVE_IPV6
110 if (af == AF_INET6)
111   {
112   if (address[0] == ':' && address[1] == 0)
113     {
114     sin->v6.sin6_family = AF_INET6;
115     sin->v6.sin6_addr = in6addr_any;
116     }
117   else
118     ip_addrinfo(address, &sin->v6);  /* Panic-dies on error */
119   sin->v6.sin6_port = htons(port);
120   return sizeof(sin->v6);
121   }
122 else
123 #else     /* HAVE_IPv6 */
124 af = af;  /* Avoid compiler warning */
125 #endif    /* HAVE_IPV6 */
126
127 /* Setup code when using IPv4 socket. The wildcard address is "". */
128
129   {
130   sin->v4.sin_family = AF_INET;
131   sin->v4.sin_port = htons(port);
132   sin->v4.sin_addr.s_addr = address[0] == 0
133     ? (S_ADDR_TYPE)INADDR_ANY
134     : (S_ADDR_TYPE)inet_addr(CS address);
135   return sizeof(sin->v4);
136   }
137 }
138
139
140
141 /* This function binds a socket to a local interface address and port. For a
142 wildcard IPv6 bind, the address is ":".
143
144 Arguments:
145   sock           the socket
146   af             AF_INET or AF_INET6 - the socket type
147   address        the IP address, in text form
148   port           the IP port (host order)
149
150 Returns:         the result of bind()
151 */
152
153 int
154 ip_bind(int sock, int af, uschar *address, int port)
155 {
156 union sockaddr_46 sin;
157 int s_len = ip_addr(&sin, af, address, port);
158 return bind(sock, (struct sockaddr *)&sin, s_len);
159 }
160
161
162
163 /*************************************************
164 *        Connect socket to remote host           *
165 *************************************************/
166
167 /* This function connects a socket to a remote address and port. The socket may
168 or may not have previously been bound to a local interface. The socket is not
169 closed, even in cases of error. It is expected that the calling function, which
170 created the socket, will be the one that closes it.
171
172 Arguments:
173   sock        the socket
174   af          AF_INET6 or AF_INET for the socket type
175   address     the remote address, in text form
176   port        the remote port
177   timeout     a timeout (zero for indefinite timeout)
178   fastopen    TRUE iff TCP_FASTOPEN can be used
179
180 Returns:      0 on success; -1 on failure, with errno set
181 */
182
183 int
184 ip_connect(int sock, int af, const uschar *address, int port, int timeout,
185   BOOL fastopen)
186 {
187 struct sockaddr_in s_in4;
188 struct sockaddr *s_ptr;
189 int s_len, rc, save_errno;
190
191 /* For an IPv6 address, use an IPv6 sockaddr structure. */
192
193 #if HAVE_IPV6
194 struct sockaddr_in6 s_in6;
195 if (af == AF_INET6)
196   {
197   memset(&s_in6, 0, sizeof(s_in6));
198   ip_addrinfo(address, &s_in6);   /* Panic-dies on error */
199   s_in6.sin6_port = htons(port);
200   s_ptr = (struct sockaddr *)&s_in6;
201   s_len = sizeof(s_in6);
202   }
203 else
204 #else     /* HAVE_IPV6 */
205 af = af;  /* Avoid compiler warning */
206 #endif    /* HAVE_IPV6 */
207
208 /* For an IPv4 address, use an IPv4 sockaddr structure, even on a system with
209 IPv6 support. */
210
211   {
212   memset(&s_in4, 0, sizeof(s_in4));
213   s_in4.sin_family = AF_INET;
214   s_in4.sin_port = htons(port);
215   s_in4.sin_addr.s_addr = (S_ADDR_TYPE)inet_addr(CCS address);
216   s_ptr = (struct sockaddr *)&s_in4;
217   s_len = sizeof(s_in4);
218   }
219
220 /* If no connection timeout is set, just call connect() without setting a
221 timer, thereby allowing the inbuilt OS timeout to operate. */
222
223 callout_address = string_sprintf("[%s]:%d", address, port);
224 sigalrm_seen = FALSE;
225 if (timeout > 0) alarm(timeout);
226
227 #if defined(TCP_FASTOPEN) && defined(MSG_FASTOPEN)
228 /* TCP Fast Open, if the system has a cookie from a previous call to
229 this peer, can send data in the SYN packet.  The peer can send data
230 before it gets our ACK of its SYN,ACK - the latter is useful for
231 the SMTP banner.  Is there any usage where the former might be?
232 We might extend the ip_connect() args for data if so.  For now,
233 connect in FASTOPEN mode but with zero data.
234 */
235
236 if (fastopen)
237   {
238   if (  (rc = sendto(sock, NULL, 0, MSG_FASTOPEN, s_ptr, s_len)) < 0
239      && errno == EOPNOTSUPP
240      )
241     {
242     DEBUG(D_transport)
243       debug_printf("Tried TCP Fast Open but apparently not enabled by sysctl\n");
244     rc = connect(sock, s_ptr, s_len);
245     }
246   }
247 else
248 #endif
249   rc = connect(sock, s_ptr, s_len);
250
251 save_errno = errno;
252 alarm(0);
253
254 /* There is a testing facility for simulating a connection timeout, as I
255 can't think of any other way of doing this. It converts a connection refused
256 into a timeout if the timeout is set to 999999. */
257
258 if (running_in_test_harness  && save_errno == ECONNREFUSED && timeout == 999999)
259   {
260   rc = -1;
261   save_errno = EINTR;
262   sigalrm_seen = TRUE;
263   }
264
265 /* Success */
266
267 if (rc >= 0)
268   return 0;
269
270 /* A failure whose error code is "Interrupted system call" is in fact
271 an externally applied timeout if the signal handler has been run. */
272
273 errno = save_errno == EINTR && sigalrm_seen ? ETIMEDOUT : save_errno;
274 return -1;
275 }
276
277
278
279 /*************************************************
280 *    Create connected socket to remote host      *
281 *************************************************/
282
283 /* Create a socket and connect to host (name or number, ipv6 ok)
284    at one of port-range.
285
286 Arguments:
287   type          SOCK_DGRAM or SOCK_STREAM
288   af            AF_INET6 or AF_INET for the socket type
289   address       the remote address, in text form
290   portlo,porthi the remote port range
291   timeout       a timeout
292   connhost      if not NULL, host_item filled in with connection details
293   errstr        pointer for allocated string on error
294
295 Return:
296   socket fd, or -1 on failure (having allocated an error string)
297 */
298 int
299 ip_connectedsocket(int type, const uschar * hostname, int portlo, int porthi,
300         int timeout, host_item * connhost, uschar ** errstr)
301 {
302 int namelen, port;
303 host_item shost;
304 host_item *h;
305 int af = 0, fd, fd4 = -1, fd6 = -1;
306 BOOL fastopen = tcp_fastopen_ok && type == SOCK_STREAM;
307
308 shost.next = NULL;
309 shost.address = NULL;
310 shost.port = portlo;
311 shost.mx = -1;
312
313 namelen = Ustrlen(hostname);
314
315 /* Anything enclosed in [] must be an IP address. */
316
317 if (hostname[0] == '[' &&
318     hostname[namelen - 1] == ']')
319   {
320   uschar * host = string_copyn(hostname+1, namelen-2);
321   if (string_is_ip_address(host, NULL) == 0)
322     {
323     *errstr = string_sprintf("malformed IP address \"%s\"", hostname);
324     return -1;
325     }
326   shost.name = shost.address = host;
327   }
328
329 /* Otherwise check for an unadorned IP address */
330
331 else if (string_is_ip_address(hostname, NULL) != 0)
332   shost.name = shost.address = string_copyn(hostname, namelen);
333
334 /* Otherwise lookup IP address(es) from the name */
335
336 else
337   {
338   shost.name = string_copyn(hostname, namelen);
339   if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE,
340       NULL, FALSE) != HOST_FOUND)
341     {
342     *errstr = string_sprintf("no IP address found for host %s", shost.name);
343     return -1;
344     }
345   }
346
347 /* Try to connect to the server - test each IP till one works */
348
349 for (h = &shost; h; h = h->next)
350   {
351   fd = Ustrchr(h->address, ':') != 0
352     ? fd6 < 0 ? (fd6 = ip_socket(type, af = AF_INET6)) : fd6
353     : fd4 < 0 ? (fd4 = ip_socket(type, af = AF_INET )) : fd4;
354
355   if (fd < 0)
356     {
357     *errstr = string_sprintf("failed to create socket: %s", strerror(errno));
358     goto bad;
359     }
360
361   for(port = portlo; port <= porthi; port++)
362     if (ip_connect(fd, af, h->address, port, timeout, fastopen) == 0)
363       {
364       if (fd != fd6) close(fd6);
365       if (fd != fd4) close(fd4);
366       if (connhost)
367         {
368         h->port = port;
369         *connhost = *h;
370         connhost->next = NULL;
371         }
372       return fd;
373       }
374   }
375
376 *errstr = string_sprintf("failed to connect to any address for %s: %s",
377   hostname, strerror(errno));
378
379 bad:
380   close(fd4); close(fd6); return -1;
381 }
382
383
384 int
385 ip_tcpsocket(const uschar * hostport, uschar ** errstr, int tmo)
386 {
387 int scan;
388 uschar hostname[256];
389 unsigned int portlow, porthigh;
390
391 /* extract host and port part */
392 scan = sscanf(CS hostport, "%255s %u-%u", hostname, &portlow, &porthigh);
393 if (scan != 3)
394   {
395   if (scan != 2)
396     {
397     *errstr = string_sprintf("invalid socket '%s'", hostport);
398     return -1;
399     }
400   porthigh = portlow;
401   }
402
403 return ip_connectedsocket(SOCK_STREAM, hostname, portlow, porthigh,
404                           tmo, NULL, errstr);
405 }
406
407 int
408 ip_unixsocket(const uschar * path, uschar ** errstr)
409 {
410 int sock;
411 struct sockaddr_un server;
412
413 if ((sock = socket(AF_UNIX, SOCK_STREAM, 0)) < 0)
414   {
415   *errstr = US"can't open UNIX socket.";
416   return -1;
417   }
418
419 callout_address = string_copy(path);
420 server.sun_family = AF_UNIX;
421 Ustrncpy(server.sun_path, path, sizeof(server.sun_path)-1);
422 server.sun_path[sizeof(server.sun_path)-1] = '\0';
423 if (connect(sock, (struct sockaddr *) &server, sizeof(server)) < 0)
424   {
425   int err = errno;
426   (void)close(sock);
427   *errstr = string_sprintf("unable to connect to UNIX socket (%s): %s",
428                 path, strerror(err));
429   return -1;
430   }
431 return sock;
432 }
433
434 int
435 ip_streamsocket(const uschar * spec, uschar ** errstr, int tmo)
436 {
437 return *spec == '/'
438   ? ip_unixsocket(spec, errstr) : ip_tcpsocket(spec, errstr, tmo);
439 }
440
441 /*************************************************
442 *         Set keepalive on a socket              *
443 *************************************************/
444
445 /* Can be called for both incoming and outgoing sockets.
446
447 Arguments:
448   sock       the socket
449   address    the remote host address, for failure logging
450   torf       true for outgoing connection, false for incoming
451
452 Returns:     nothing
453 */
454
455 void
456 ip_keepalive(int sock, const uschar *address, BOOL torf)
457 {
458 int fodder = 1;
459 if (setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE,
460     (uschar *)(&fodder), sizeof(fodder)) != 0)
461   log_write(0, LOG_MAIN, "setsockopt(SO_KEEPALIVE) on connection %s %s "
462     "failed: %s", torf? "to":"from", address, strerror(errno));
463 }
464
465
466
467 /*************************************************
468 *         Receive from a socket with timeout     *
469 *************************************************/
470
471 /*
472 Arguments:
473   fd          the file descriptor
474   timeout     the timeout, seconds
475 Returns:      TRUE => ready for i/o
476               FALSE => timed out, or other error
477 */
478 BOOL
479 fd_ready(int fd, int timeout)
480 {
481 fd_set select_inset;
482 time_t start_recv = time(NULL);
483 int time_left = timeout;
484 int rc;
485
486 if (time_left <= 0)
487   {
488   errno = ETIMEDOUT;
489   return FALSE;
490   }
491 /* Wait until the socket is ready */
492
493 do
494   {
495   struct timeval tv = { time_left, 0 };
496   FD_ZERO (&select_inset);
497   FD_SET (fd, &select_inset);
498
499   /*DEBUG(D_transport) debug_printf("waiting for data on fd\n");*/
500   rc = select(fd + 1, (SELECT_ARG2_TYPE *)&select_inset, NULL, NULL, &tv);
501
502   /* If some interrupt arrived, just retry. We presume this to be rare,
503   but it can happen (e.g. the SIGUSR1 signal sent by exiwhat causes
504   select() to exit).
505
506   Aug 2004: Somebody set up a cron job that ran exiwhat every 2 minutes, making
507   the interrupt not at all rare. Since the timeout is typically more than 2
508   minutes, the effect was to block the timeout completely. To prevent this
509   happening again, we do an explicit time test and adjust the timeout
510   accordingly */
511
512   if (rc < 0 && errno == EINTR)
513     {
514     DEBUG(D_transport) debug_printf("EINTR while waiting for socket data\n");
515
516     /* Watch out, 'continue' jumps to the condition, not to the loops top */
517     time_left = timeout - (time(NULL) - start_recv);
518     if (time_left > 0) continue;
519     }
520
521   if (rc <= 0)
522     {
523     errno = ETIMEDOUT;
524     return FALSE;
525     }
526
527   /* Checking the FD_ISSET is not enough, if we're interrupted, the
528   select_inset may still contain the 'input'. */
529   }
530 while (rc < 0 || !FD_ISSET(fd, &select_inset));
531 return TRUE;
532 }
533
534 /* The timeout is implemented using select(), and we loop to cover select()
535 getting interrupted, and the possibility of select() returning with a positive
536 result but no ready descriptor. Is this in fact possible?
537
538 Arguments:
539   sock        the socket
540   buffer      to read into
541   bufsize     the buffer size
542   timeout     the timeout
543
544 Returns:      > 0 => that much data read
545               <= 0 on error or EOF; errno set - zero for EOF
546 */
547
548 int
549 ip_recv(int sock, uschar *buffer, int buffsize, int timeout)
550 {
551 int rc;
552
553 if (!fd_ready(sock, timeout))
554   return -1;
555
556 /* The socket is ready, read from it (via TLS if it's active). On EOF (i.e.
557 close down of the connection), set errno to zero; otherwise leave it alone. */
558
559 #ifdef SUPPORT_TLS
560 if (tls_out.active == sock)
561   rc = tls_read(FALSE, buffer, buffsize);
562 else if (tls_in.active == sock)
563   rc = tls_read(TRUE, buffer, buffsize);
564 else
565 #endif
566   rc = recv(sock, buffer, buffsize, 0);
567
568 if (rc > 0) return rc;
569 if (rc == 0) errno = 0;
570 return -1;
571 }
572
573
574
575
576 /*************************************************
577 *    Lookup address family of potential socket   *
578 *************************************************/
579
580 /* Given a file-descriptor, check to see if it's a socket and, if so,
581 return the address family; detects IPv4 vs IPv6.  If not a socket then
582 return -1.
583
584 The value 0 is typically AF_UNSPEC, which should not be seen on a connected
585 fd.  If the return is -1, the errno will be from getsockname(); probably
586 ENOTSOCK or ECONNRESET.
587
588 Arguments:     socket-or-not fd
589 Returns:       address family or -1
590 */
591
592 int
593 ip_get_address_family(int fd)
594 {
595 struct sockaddr_storage ss;
596 socklen_t sslen = sizeof(ss);
597
598 if (getsockname(fd, (struct sockaddr *) &ss, &sslen) < 0)
599   return -1;
600
601 return (int) ss.ss_family;
602 }
603
604
605
606
607 /*************************************************
608 *       Lookup DSCP settings for a socket        *
609 *************************************************/
610
611 struct dscp_name_tableentry {
612   const uschar *name;
613   int value;
614 };
615 /* Keep both of these tables sorted! */
616 static struct dscp_name_tableentry dscp_table[] = {
617 #ifdef IPTOS_DSCP_AF11
618     { CUS"af11", IPTOS_DSCP_AF11 },
619     { CUS"af12", IPTOS_DSCP_AF12 },
620     { CUS"af13", IPTOS_DSCP_AF13 },
621     { CUS"af21", IPTOS_DSCP_AF21 },
622     { CUS"af22", IPTOS_DSCP_AF22 },
623     { CUS"af23", IPTOS_DSCP_AF23 },
624     { CUS"af31", IPTOS_DSCP_AF31 },
625     { CUS"af32", IPTOS_DSCP_AF32 },
626     { CUS"af33", IPTOS_DSCP_AF33 },
627     { CUS"af41", IPTOS_DSCP_AF41 },
628     { CUS"af42", IPTOS_DSCP_AF42 },
629     { CUS"af43", IPTOS_DSCP_AF43 },
630     { CUS"ef", IPTOS_DSCP_EF },
631 #endif
632 #ifdef IPTOS_LOWCOST
633     { CUS"lowcost", IPTOS_LOWCOST },
634 #endif
635     { CUS"lowdelay", IPTOS_LOWDELAY },
636 #ifdef IPTOS_MINCOST
637     { CUS"mincost", IPTOS_MINCOST },
638 #endif
639     { CUS"reliability", IPTOS_RELIABILITY },
640     { CUS"throughput", IPTOS_THROUGHPUT }
641 };
642 static int dscp_table_size =
643   sizeof(dscp_table) / sizeof(struct dscp_name_tableentry);
644
645 /* DSCP values change by protocol family, and so do the options used for
646 setsockopt(); this utility does all the lookups.  It takes an unexpanded
647 option string, expands it, strips off affix whitespace, then checks if it's
648 a number.  If all of what's left is a number, then that's how the option will
649 be parsed and success/failure is a range check.  If it's not all a number,
650 then it must be a supported keyword.
651
652 Arguments:
653   dscp_name   a string, so far unvalidated
654   af          address_family in use
655   level       setsockopt level to use
656   optname     setsockopt name to use
657   dscp_value  value for dscp_name
658
659 Returns: TRUE if okay to setsockopt(), else FALSE
660
661 *level and *optname may be set even if FALSE is returned
662 */
663
664 BOOL
665 dscp_lookup(const uschar *dscp_name, int af,
666     int *level, int *optname, int *dscp_value)
667 {
668 uschar *dscp_lookup, *p;
669 int first, last;
670 long rawlong;
671
672 if (af == AF_INET)
673   {
674   *level = IPPROTO_IP;
675   *optname = IP_TOS;
676   }
677 #if HAVE_IPV6 && defined(IPV6_TCLASS)
678 else if (af == AF_INET6)
679   {
680   *level = IPPROTO_IPV6;
681   *optname = IPV6_TCLASS;
682   }
683 #endif
684 else
685   {
686   DEBUG(D_transport)
687     debug_printf("Unhandled address family %d in dscp_lookup()\n", af);
688   return FALSE;
689   }
690 if (!dscp_name)
691   {
692   DEBUG(D_transport)
693     debug_printf("[empty DSCP]\n");
694   return FALSE;
695   }
696 dscp_lookup = expand_string(US dscp_name);
697 if (dscp_lookup == NULL || *dscp_lookup == '\0')
698   return FALSE;
699
700 p = dscp_lookup + Ustrlen(dscp_lookup) - 1;
701 while (isspace(*p)) *p-- = '\0';
702 while (isspace(*dscp_lookup) && dscp_lookup < p) dscp_lookup++;
703 if (*dscp_lookup == '\0')
704   return FALSE;
705
706 rawlong = Ustrtol(dscp_lookup, &p, 0);
707 if (p != dscp_lookup && *p == '\0')
708   {
709   /* We have six bits available, which will end up shifted to fit in 0xFC mask.
710   RFC 2597 defines the values unshifted. */
711   if (rawlong < 0 || rawlong > 0x3F)
712     {
713     DEBUG(D_transport)
714       debug_printf("DSCP value %ld out of range, ignored.\n", rawlong);
715     return FALSE;
716     }
717   *dscp_value = rawlong << 2;
718   return TRUE;
719   }
720
721 first = 0;
722 last = dscp_table_size;
723 while (last > first)
724   {
725   int middle = (first + last)/2;
726   int c = Ustrcmp(dscp_lookup, dscp_table[middle].name);
727   if (c == 0)
728     {
729     *dscp_value = dscp_table[middle].value;
730     return TRUE;
731     }
732   else if (c > 0)
733     first = middle + 1;
734   else
735     last = middle;
736   }
737 return FALSE;
738 }
739
740 void
741 dscp_list_to_stream(FILE *stream)
742 {
743 int i;
744 for (i=0; i < dscp_table_size; ++i)
745   fprintf(stream, "%s\n", dscp_table[i].name);
746 }
747
748
749 /* End of ip.c */
750 /* vi: aw ai sw=2
751 */