1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2021 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
11 /* Source files for exim all #include this header, which drags in everything
12 that is needed. They don't all need everything, of course, but it's far too
13 messy to have each one importing its own list, and anyway, most of them need
14 most of these includes. */
19 /* Assume most systems have statfs() unless os.h undefines this macro */
23 /* Similarly, assume most systems have srandom() unless os.h undefines it.
24 This call dates back at least as far as SUSv2. */
28 /* This is primarily for the Gnu C library; we define it before os.h so that
29 os.h has a chance to hurriedly undef it, Just In Case. We need C99 for some
30 64-bit math support, and defining _ISOC99_SOURCE breaks <resolv.h> and friends.
35 /* First of all include the os-specific header, which might set things that
36 are needed by any of the other headers, including system headers. */
40 /* If it didn't define os_find_running_interfaces, use the common function. */
42 #ifndef os_find_running_interfaces
43 # define os_find_running_interfaces os_common_find_running_interfaces
46 /* If it didn't define the base for "base 62" numbers, we really do use 62.
47 This is the case for all real Unix and Unix-like OS. It's only Cygwin and
48 Darwin, with their case-insensitive file systems, that can't use base 62 for
49 making unique names. */
55 /* The maximum value of localhost_number depends on the base being used */
58 # define LOCALHOST_MAX 16
60 # define LOCALHOST_MAX 10
63 /* If not overridden by os.h, dynamic libraries have filenames ending .so */
65 # define DYNLIB_FN_EXT "so"
68 /* ANSI C standard includes */
84 #if defined(__svr4__) && defined(__sparc) && ! defined(__EXTENSIONS__)
85 # define __EXTENSIONS__ /* so that SunOS 5 gets NGROUPS_MAX */
87 # undef __EXTENSIONS__
92 #ifdef EXIM_HAVE_INOTIFY
93 # include <sys/inotify.h>
95 #ifdef EXIM_HAVE_KEVENT
96 # include <sys/event.h>
99 /* C99 integer types, figure out how to undo this if needed for older systems */
101 #include <inttypes.h>
103 /* Just in case some aged system doesn't define them... */
106 # define INT_MAX 2147483647
110 # define INT_MIN (-INT_MAX - 1)
114 # define SHRT_MAX 32767
118 # define UCHAR_MAX 255
122 /* To match int_eximarith_t. Define in OS/os.h-<your-system> to override. */
123 #ifndef EXIM_ARITH_MAX
124 # define EXIM_ARITH_MAX ((int_eximarith_t)9223372036854775807LL)
126 #ifndef EXIM_ARITH_MIN
127 # define EXIM_ARITH_MIN (-EXIM_ARITH_MAX - 1)
130 /* Some systems have PATH_MAX and some have MAX_PATH_LEN. */
134 # define PATH_MAX MAX_PATH_LEN
136 # define PATH_MAX 1024
140 /* RFC 5321 specifies that the maximum length of a local-part is 64 octets
141 and the maximum length of a domain is 255 octets, but then also defines
142 the maximum length of a forward/reverse path as 256 not 64+1+255.
143 For an IP address, the maximum is 45 without a scope and we don't work
144 with scoped addresses, so go with that. (IPv6 with mapped IPv4).
146 A hostname maximum length is in practice the same as the domainname, for
147 the same core reasons (maximum length of a DNS name), but the semantics
148 are different and seeing "DOMAIN" in source is confusing when talking about
149 hostnames; so we define a second macro. We'll use RFC 2181 as the reference
152 There is no known (to me) specification on the maximum length of a human name
153 in email addresses and we should be careful about imposing such a limit on
154 received email, but in terms of limiting what untrusted callers specify, or
155 local generation, having a limit makes sense. Err on the side of generosity.
157 For a display mail address, we have a human name, an email in brackets,
158 possibly some (Comments), so it needs to be at least 512+3 and some more to
159 avoid extraneous errors.
160 Since the sane SMTP line length limit is 998, constraining such parameters to
161 be 1024 seems generous and unlikely to spuriously reject legitimate
164 The driver name is a name of a router/transport/authenticator etc in the
165 configuration file. We also use this for some other short strings, such
167 Also TLS ciphersuite name (no real known limit since the protocols use
168 integers, but max seen in reality is 45 octets).
170 RFC 1413 gives us the 512 limit on IDENT protocol userids.
173 #define EXIM_EMAILADDR_MAX 256
174 #define EXIM_LOCALPART_MAX 64
175 #define EXIM_DOMAINNAME_MAX 255
176 #define EXIM_IPADDR_MAX 45
177 #define EXIM_HOSTNAME_MAX 255
178 #define EXIM_HUMANNAME_MAX 256
179 #define EXIM_DISPLAYMAIL_MAX 1024
180 #define EXIM_DRIVERNAME_MAX 64
181 #define EXIM_CIPHERNAME_MAX 64
182 #define EXIM_IDENTUSER_MAX 512
185 #include <sys/types.h>
186 #include <sys/file.h>
196 /* Not all systems have flock() available. Those that do must define LOCK_SH
203 #ifndef NO_SYSEXITS /* some OS don't have this */
204 # include <sysexits.h>
207 /* A few OS don't have socklen_t; their os.h files define EXIM_SOCKLEN_T to
208 be size_t or whatever. We used to use SOCKLEN_T, but then it was discovered
209 that this is used by the AIX include files. */
211 #ifndef EXIM_SOCKLEN_T
212 # define EXIM_SOCKLEN_T socklen_t
215 /* Ensure that the sysexits we reference are defined */
217 #ifndef EX_UNAVAILABLE
218 # define EX_UNAVAILABLE 69 /* service unavailable; used for execv fail */
221 # define EX_CANTCREAT 73 /* can't create file: treat as temporary */
224 # define EX_TEMPFAIL 75 /* temp failure; user is invited to retry */
227 # define EX_CONFIG 78 /* configuration error */
230 /* This one is not in any sysexits file that I've come across */
232 #define EX_EXECFAILED 127 /* execve() failed */
235 #include <sys/time.h>
236 #include <sys/param.h>
238 #ifndef NO_SYS_RESOURCE_H /* QNX doesn't have this */
239 # include <sys/resource.h>
242 #include <sys/socket.h>
244 /* If we are on an IPv6 system, the macro AF_INET6 will have been defined in
245 the sys/socket.h header. It is helpful to have this defined on an IPv4 system
246 so that it can appear in the code, even if it is never actually used when
247 the code is run. It saves some #ifdef occurrences. */
253 #include <sys/ioctl.h>
255 /* The new standard is statvfs; some OS have statfs. For statvfs the block
256 counts must be multiplied by the "fragment size" f_frsize to get the actual
257 size. In other cases the value seems to be f_bsize (which is sometimes the only
258 block size), so we use a macro to get that instead.
260 Also arrange to be able to cut it out altogether for way-out OS that don't have
261 anything. I've indented a bit here to try to make the mess a bit more
262 intelligible. Note that simply defining one name to be another when
263 HAVE_SYS_STATVFS_H is not set will not work if the system has a statvfs macro
264 or a macro with entries f_frsize and f_bsize. */
267 #ifdef HAVE_SYS_STATVFS_H
268 #include <sys/statvfs.h>
269 #define STATVFS statvfs
270 #define F_FRSIZE f_frsize
272 #define STATVFS statfs
273 #define F_FRSIZE f_bsize
274 #ifdef HAVE_SYS_VFS_H
276 #ifdef HAVE_SYS_STATFS_H
277 #include <sys/statfs.h>
280 #ifdef HAVE_SYS_MOUNT_H
281 #include <sys/mount.h>
285 /* Macros for the fields for the available space for non-superusers; define
286 these only if the OS header has not. Not all OS have f_favail; those that
287 are known to have it define F_FAVAIL as f_favail. The default is to use
291 # define F_BAVAIL f_bavail
295 # define F_FAVAIL f_ffree
298 /* All the systems I've been able to look at seem to have F_FILES */
301 # define F_FILES f_files
307 #ifndef SIOCGIFCONF /* HACK for SunOS 5 */
308 # include <sys/sockio.h>
311 #include <sys/stat.h>
312 #include <sys/wait.h>
313 #include <sys/utsname.h>
316 /* There's a shambles in IRIX6 - it defines EX_OK in unistd.h which conflicts
317 with the definition in sysexits.h. Exim does not actually use this macro, so we
318 just undefine it. It would be nice to be able to re-instate the definition from
319 sysexits.h if there is no definition in unistd.h, but I do not think there is a
320 way to do this in C because macro definitions are not scanned for other macros
321 at definition time. [The code here used to assume they were, until I was
322 disabused of the notion. Luckily, since EX_OK is not used, it didn't matter.] */
335 #include <netinet/in.h>
336 #include <netinet/tcp.h>
337 #include <arpa/inet.h>
338 #include <arpa/nameser.h>
341 /* While IPv6 is still young the definitions of T_AAAA and T_A6 may not be
342 included in arpa/nameser.h. Fudge them here. */
352 /* Ancient systems (e.g. SunOS4) don't appear to have T_TXT defined in their
353 header files. I don't suppose they have T_SRV either. */
363 /* Many systems do not have T_SPF. */
369 /* New TLSA record for DANE */
373 #define MAX_TLSA_EXPANDED_SIZE 8192
375 /* It seems that some versions of arpa/nameser.h don't define *any* of the
376 T_xxx macros, which seem to be non-standard nowadays. Just to be on the safe
377 side, put in definitions for all the ones that Exim uses. */
404 /* We define a few private types for special DNS lookups:
406 . T_ZNS gets the nameservers of the enclosing zone of a domain
408 . T_MXH gets the MX hostnames only (without their priorities)
410 . T_CSA gets the domain's Client SMTP Authorization SRV record
412 . T_ADDRESSES looks up both AAAA (or A6) and A records
414 If any of these names appear in the RRtype list at:
415 <http://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml>
416 then we should rename Exim's private type away from the conflict.
422 #define T_ADDRESSES (-4)
424 /* The resolv.h header defines __P(x) on some Solaris 2.5.1 systems (without
425 checking that it is already defined, in fact). This conflicts with other
426 headers that behave likewise (see below), leading to compiler warnings. Arrange
427 to undefine it if resolv.h defines it. */
430 # define __P_WAS_DEFINED_BEFORE_RESOLV
435 #if defined(__P) && ! defined (__P_WAS_DEFINED_BEFORE_RESOLV)
439 /* If not defined by os.h, we do nothing special to push DNS resolver state
440 back to be available by the classic resolver routines. Also, provide
441 prototype for our get routine, unless defined away. */
443 #ifndef os_put_dns_resolver_res
444 # define os_put_dns_resolver_res(R) do {/**/} while(0)
446 #ifndef os_get_dns_resolver_res
447 res_state os_get_dns_resolver_res(void);
450 /* These three are to support the IP option logging code. Linux is
451 different to everyone else and there are also other systems which don't
452 have netinet/ip_var.h, so there's a general macro to control its inclusion. */
454 #include <netinet/in_systm.h>
455 #include <netinet/ip.h>
458 # include <netinet/ip_var.h>
461 /* Linux (and some others) uses a different type for the 2nd argument of
462 iconv(). It's os.h file defines ICONV_ARG2_TYPE. For the rest, define a default
465 #ifndef ICONV_ARG2_TYPE
466 # define ICONV_ARG2_TYPE char **
469 /* One OS uses a different type for the 5th argument of getsockopt */
471 #ifndef GETSOCKOPT_ARG5_TYPE
472 # define GETSOCKOPT_ARG5_TYPE socklen_t *
475 /* One operating system uses a different type for the 2nd argument of select().
476 Its os.h file defines SELECT_ARG2_TYPE. For the rest, define a default here. */
478 #ifndef SELECT_ARG2_TYPE
479 # define SELECT_ARG2_TYPE fd_set
482 /* One operating system uses a different type for the 4th argument of
483 dn_expand(). Its os.h file defines DN_EXPAND_ARG4_TYPE. For the rest, define a
486 #ifndef DN_EXPAND_ARG4_TYPE
487 # define DN_EXPAND_ARG4_TYPE char *
490 /* One operating system defines a different type for the yield of inet_addr().
491 In Exim code, its value is always assigned to the s_addr members of address
492 structures. Casting the yield to the type of s_addr should fix the problem,
493 since the size of the data is correct. Just in case this ever has to be
494 changed, use a macro for the type, and define it here so that it is possible to
495 use different values for specific OS if ever necessary. */
498 # define S_ADDR_TYPE u_long
501 /* (At least) one operating system (Solaris) defines a different type for the
502 second argument of pam_converse() - the difference is the absence of "const".
503 Its os.h file defines PAM_CONVERSE_ARG2_TYPE. For the rest, define a default
506 #ifndef PAM_CONVERSE_ARG2_TYPE
507 # define PAM_CONVERSE_ARG2_TYPE const struct pam_message
510 /* One operating system (SunOS4) defines getc, ungetc, feof, and ferror as
511 macros and not as functions. Exim needs them to be assignable functions. This
512 flag gets set to cause this to be sorted out here. */
514 #ifdef FUDGE_GETC_AND_FRIENDS
516 extern int getc(FILE *);
518 extern int ungetc(int, FILE *);
520 extern int feof(FILE *);
522 extern int ferror(FILE *);
525 /* The header from the PCRE regex package */
527 #define PCRE2_CODE_UNIT_WIDTH 8
530 /* Exim includes are in several files. Note that local_scan.h #includes
531 config.h, mytypes.h, and store.h, so we don't need to mention them explicitly.
534 #include "local_scan.h"
537 #include "hintsdb_structs.h"
542 #include "functions.h"
543 #include "dbfunctions.h"
544 #include "osfunctions.h"
546 #ifdef EXPERIMENTAL_BRIGHTMAIL
547 # include "bmi_spam.h"
557 # include <opendmarc/dmarc.h>
560 /* The following stuff must follow the inclusion of config.h because it
561 requires various things that are set therein. */
563 #if HAVE_ICONV /* Not all OS have this */
567 #if defined(USE_READLINE) || defined(EXPAND_DLFUNC) || defined (LOOKUP_MODULE_DIR)
571 #ifdef ENABLE_DISABLE_FSYNC
572 # define EXIMfsync(f) (disable_fsync ? 0 : fsync(f))
574 # define EXIMfsync(f) fsync(f)
577 /* Backward compatibility; LOOKUP_LSEARCH now includes all three */
579 #if (!defined LOOKUP_LSEARCH) && (defined LOOKUP_WILDLSEARCH || defined LOOKUP_NWILDLSEARCH)
580 # define LOOKUP_LSEARCH yes
583 /* Define a union to hold either an IPv4 or an IPv6 sockaddr structure; this
584 simplifies some of the coding. We include the sockaddr to reduce type-punning
588 struct sockaddr_in v4;
590 struct sockaddr_in6 v6;
595 /* If DISABLE_TLS is defined, ensure that USE_GNUTLS is not defined
596 so that if USE_GNUTLS *is* set, we can assume DISABLE_TLS is not set.
598 Likewise, OSCP, AUTH_TLS and CERTNAMES cannot be supported. */
603 # ifndef DISABLE_OCSP
604 # define DISABLE_OCSP
606 # undef EXPERIMENTAL_CERTNAMES
610 /* If SPOOL_DIRECTORY, LOG_FILE_PATH or PID_FILE_PATH have not been defined,
611 set them to the null string. */
613 #ifndef SPOOL_DIRECTORY
614 #define SPOOL_DIRECTORY ""
616 #ifndef LOG_FILE_PATH
617 #define LOG_FILE_PATH ""
619 #ifndef PID_FILE_PATH
620 #define PID_FILE_PATH ""
623 /* The EDQUOT error code isn't universally available, though it is widespread.
624 There is a particular shambles in SunOS5, where it did not exist originally,
625 but got installed with a particular patch for Solaris 2.4. There is a
626 configuration variable for specifying what the system's "over quota" error is,
627 which will end up in config.h if supplied in OS/Makefile-xxx. If it is not set,
628 default to EDQUOT if it exists, otherwise ENOSPC. */
632 # define ERRNO_QUOTA EDQUOT
634 # define ERRNO_QUOTA ENOSPC
638 /* DANE w/o DNSSEC is useless */
639 #if defined(SUPPORT_DANE) && defined(DISABLE_DNSSEC)
640 # error DANE support requires DNSSEC support
643 /* Some platforms (FreeBSD, OpenBSD, Solaris) do not seem to define this */
646 # define POLLRDHUP (POLLIN | POLLHUP)
649 /* Some platforms (Darwin) have to define a larger limit on groups membership */
651 #ifndef EXIM_GROUPLIST_SIZE
652 # define EXIM_GROUPLIST_SIZE NGROUPS_MAX
655 /* Linux has TCP_CORK, FreeBSD has TCP_NOPUSH; they do pretty much the same */
658 # define EXIM_TCP_CORK TCP_CORK
659 #elif defined(TCP_NOPUSH)
660 # define EXIM_TCP_CORK TCP_NOPUSH
663 /* LibreSSL seems to not push out the SMTP response to QUIT with our usual
664 handling which is trying to get the client to FIN first so that the server does
665 not get the TIME_WAIT */
667 #if !defined(DISABLE_TLS) && defined(USE_OPENSSL) && defined(LIBRESSL_VERSION_NUMBER)
668 # define SERVERSIDE_CLOSE_NOWAIT