src/src/exim.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2018 */
   6 /* See the file NOTICE for conditions of use and distribution. */
   7
   8
   9 /* Source files for exim all #include this header, which drags in everything
  10 that is needed. They don't all need everything, of course, but it's far too
  11 messy to have each one importing its own list, and anyway, most of them need
  12 most of these includes. */
  13
  14 #ifndef EXIM_H
  15 #define EXIM_H
  16
  17 /* Assume most systems have statfs() unless os.h undefines this macro */
  18
  19 #define HAVE_STATFS
  20
  21 /* Similarly, assume most systems have srandom() unless os.h undefines it.
  22 This call dates back at least as far as SUSv2. */
  23
  24 #define HAVE_SRANDOM
  25
  26 /* This is primarily for the Gnu C library; we define it before os.h so that
  27 os.h has a chance to hurriedly undef it, Just In Case.  We need C99 for some
  28 64-bit math support, and defining _ISOC99_SOURCE breaks <resolv.h> and friends.
  29 */
  30
  31 #define _GNU_SOURCE 1
  32
  33 /* First of all include the os-specific header, which might set things that
  34 are needed by any of the other headers, including system headers. */
  35
  36 #include "os.h"
  37
  38 /* If it didn't define os_find_running_interfaces, use the common function. */
  39
  40 #ifndef os_find_running_interfaces
  41 # define os_find_running_interfaces os_common_find_running_interfaces
  42 #endif
  43
  44 /* If it didn't define the base for "base 62" numbers, we really do use 62.
  45 This is the case for all real Unix and Unix-like OS. It's only Cygwin and
  46 Darwin, with their case-insensitive file systems, that can't use base 62 for
  47 making unique names. */
  48
  49 #ifndef BASE_62
  50 # define BASE_62 62
  51 #endif
  52
  53 /* The maximum value of localhost_number depends on the base being used */
  54
  55 #if BASE_62 == 62
  56 # define LOCALHOST_MAX  16
  57 #else
  58 # define LOCALHOST_MAX  10
  59 #endif
  60
  61 /* If not overridden by os.h, dynamic libraries have filenames ending .so */
  62 #ifndef DYNLIB_FN_EXT
  63 # define DYNLIB_FN_EXT "so"
  64 #endif
  65
  66 /* ANSI C standard includes */
  67
  68 #include <ctype.h>
  69 #include <locale.h>
  70 #include <math.h>
  71 #include <signal.h>
  72 #include <stdarg.h>
  73 #include <stddef.h>
  74 #include <stdio.h>
  75 #include <stdlib.h>
  76 #include <string.h>
  77 #include <time.h>
  78
  79 /* Unix includes */
  80
  81 #include <errno.h>
  82 #if defined(__svr4__) && defined(__sparc) && ! defined(__EXTENSIONS__)
  83 # define __EXTENSIONS__  /* so that SunOS 5 gets NGROUPS_MAX */
  84 # include <limits.h>
  85 # undef  __EXTENSIONS__
  86 #else
  87 # include <limits.h>
  88 #endif
  89
  90 #ifdef EXIM_HAVE_INOTIFY
  91 # include <sys/inotify.h>
  92 #endif
  93
  94 /* C99 integer types, figure out how to undo this if needed for older systems */
  95
  96 #include <inttypes.h>
  97
  98 /* Just in case some aged system doesn't define them... */
  99
 100 #ifndef INT_MAX
 101 # define INT_MAX 2147483647
 102 #endif
 103
 104 #ifndef INT_MIN
 105 # define INT_MIN (-INT_MAX - 1)
 106 #endif
 107
 108 #ifndef SHRT_MAX
 109 # define SHRT_MAX 32767
 110 #endif
 111
 112 #ifndef UCHAR_MAX
 113 # define UCHAR_MAX 255
 114 #endif
 115
 116
 117 /* To match int_eximarith_t.  Define in OS/os.h-<your-system> to override. */
 118 #ifndef EXIM_ARITH_MAX
 119 # define EXIM_ARITH_MAX ((int_eximarith_t)9223372036854775807LL)
 120 #endif
 121 #ifndef EXIM_ARITH_MIN
 122 # define EXIM_ARITH_MIN (-EXIM_ARITH_MAX - 1)
 123 #endif
 124
 125 /* Some systems have PATH_MAX and some have MAX_PATH_LEN. */
 126
 127 #ifndef PATH_MAX
 128 # ifdef MAX_PATH_LEN
 129 #  define PATH_MAX MAX_PATH_LEN
 130 # else
 131 #  define PATH_MAX 1024
 132 # endif
 133 #endif
 134
 135 #include <sys/types.h>
 136 #include <sys/file.h>
 137 #include <dirent.h>
 138 #include <netdb.h>
 139 #ifndef NO_POLL_H
 140 # include <poll.h>
 141 #endif
 142 #include <pwd.h>
 143 #include <grp.h>
 144 #include <syslog.h>
 145
 146 /* Not all systems have flock() available. Those that do must define LOCK_SH
 147 in sys/file.h. */
 148
 149 #ifndef LOCK_SH
 150 # define NO_FLOCK
 151 #endif
 152
 153 #ifndef NO_SYSEXITS        /* some OS don't have this */
 154 # include <sysexits.h>
 155 #endif
 156
 157 /* A few OS don't have socklen_t; their os.h files define EXIM_SOCKLEN_T to
 158 be size_t or whatever. We used to use SOCKLEN_T, but then it was discovered
 159 that this is used by the AIX include files. */
 160
 161 #ifndef EXIM_SOCKLEN_T
 162 # define EXIM_SOCKLEN_T socklen_t
 163 #endif
 164
 165 /* Ensure that the sysexits we reference are defined */
 166
 167 #ifndef EX_UNAVAILABLE
 168 # define EX_UNAVAILABLE 69        /* service unavailable; used for execv fail */
 169 #endif
 170 #ifndef EX_CANTCREAT
 171 # define EX_CANTCREAT   73        /* can't create file: treat as temporary */
 172 #endif
 173 #ifndef EX_TEMPFAIL
 174 # define EX_TEMPFAIL    75        /* temp failure; user is invited to retry */
 175 #endif
 176 #ifndef EX_CONFIG
 177 # define EX_CONFIG      78        /* configuration error */
 178 #endif
 179
 180 /* This one is not in any sysexits file that I've come across */
 181
 182 #define EX_EXECFAILED 127        /* execve() failed */
 183
 184
 185 #include <sys/time.h>
 186 #include <sys/param.h>
 187
 188 #ifndef NO_SYS_RESOURCE_H  /* QNX doesn't have this */
 189 # include <sys/resource.h>
 190 #endif
 191
 192 #include <sys/socket.h>
 193
 194 /* If we are on an IPv6 system, the macro AF_INET6 will have been defined in
 195 the sys/socket.h header. It is helpful to have this defined on an IPv4 system
 196 so that it can appear in the code, even if it is never actually used when
 197 the code is run. It saves some #ifdef occurrences. */
 198
 199 #ifndef AF_INET6
 200 # define AF_INET6 24
 201 #endif
 202
 203 #include <sys/ioctl.h>
 204
 205 /* The new standard is statvfs; some OS have statfs. For statvfs the block
 206 counts must be multiplied by the "fragment size" f_frsize to get the actual
 207 size. In other cases the value seems to be f_bsize (which is sometimes the only
 208 block size), so we use a macro to get that instead.
 209
 210 Also arrange to be able to cut it out altogether for way-out OS that don't have
 211 anything. I've indented a bit here to try to make the mess a bit more
 212 intelligible. Note that simply defining one name to be another when
 213 HAVE_SYS_STATVFS_H is not set will not work if the system has a statvfs macro
 214 or a macro with entries f_frsize and f_bsize. */
 215
 216 #ifdef HAVE_STATFS
 217   #ifdef HAVE_SYS_STATVFS_H
 218     #include <sys/statvfs.h>
 219     #define STATVFS statvfs
 220     #define F_FRSIZE f_frsize
 221   #else
 222     #define STATVFS statfs
 223     #define F_FRSIZE f_bsize
 224     #ifdef HAVE_SYS_VFS_H
 225       #include <sys/vfs.h>
 226       #ifdef HAVE_SYS_STATFS_H
 227       #include <sys/statfs.h>
 228       #endif
 229     #endif
 230     #ifdef HAVE_SYS_MOUNT_H
 231     #include <sys/mount.h>
 232     #endif
 233   #endif
 234
 235   /* Macros for the fields for the available space for non-superusers; define
 236   these only if the OS header has not. Not all OS have f_favail; those that
 237   are known to have it define F_FAVAIL as f_favail. The default is to use
 238   f_free. */
 239
 240   #ifndef F_BAVAIL
 241   # define F_BAVAIL f_bavail
 242   #endif
 243
 244   #ifndef F_FAVAIL
 245   # define F_FAVAIL f_ffree
 246   #endif
 247
 248   /* All the systems I've been able to look at seem to have F_FILES */
 249
 250   #ifndef F_FILES
 251   # define F_FILES  f_files
 252   #endif
 253
 254 #endif
 255
 256
 257 #ifndef  SIOCGIFCONF   /* HACK for SunOS 5 */
 258 # include <sys/sockio.h>
 259 #endif
 260
 261 #include <sys/stat.h>
 262 #include <sys/wait.h>
 263 #include <sys/utsname.h>
 264 #include <fcntl.h>
 265
 266 /* There's a shambles in IRIX6 - it defines EX_OK in unistd.h which conflicts
 267 with the definition in sysexits.h. Exim does not actually use this macro, so we
 268 just undefine it. It would be nice to be able to re-instate the definition from
 269 sysexits.h if there is no definition in unistd.h, but I do not think there is a
 270 way to do this in C because macro definitions are not scanned for other macros
 271 at definition time. [The code here used to assume they were, until I was
 272 disabused of the notion. Luckily, since EX_OK is not used, it didn't matter.] */
 273
 274 #ifdef EX_OK
 275 # undef EX_OK
 276 #endif
 277
 278 #include <unistd.h>
 279
 280 #include <utime.h>
 281 #ifndef NO_NET_IF_H
 282 # include <net/if.h>
 283 #endif
 284 #include <sys/un.h>
 285 #include <netinet/in.h>
 286 #include <netinet/tcp.h>
 287 #include <arpa/inet.h>
 288 #include <arpa/nameser.h>
 289
 290
 291 /* While IPv6 is still young the definitions of T_AAAA and T_A6 may not be
 292 included in arpa/nameser.h. Fudge them here. */
 293
 294 #ifndef T_AAAA
 295 #define T_AAAA 28
 296 #endif
 297
 298 #ifndef T_A6
 299 #define T_A6 38
 300 #endif
 301
 302 /* Ancient systems (e.g. SunOS4) don't appear to have T_TXT defined in their
 303 header files. I don't suppose they have T_SRV either. */
 304
 305 #ifndef T_TXT
 306 # define T_TXT 16
 307 #endif
 308
 309 #ifndef T_SRV
 310 # define T_SRV 33
 311 #endif
 312
 313 /* Many systems do not have T_SPF. */
 314
 315 #ifndef T_SPF
 316 # define T_SPF 99
 317 #endif
 318
 319 /* New TLSA record for DANE */
 320 #ifndef T_TLSA
 321 # define T_TLSA 52
 322 #endif
 323 #define MAX_TLSA_EXPANDED_SIZE 8192
 324
 325 /* It seems that some versions of arpa/nameser.h don't define *any* of the
 326 T_xxx macros, which seem to be non-standard nowadays. Just to be on the safe
 327 side, put in definitions for all the ones that Exim uses. */
 328
 329 #ifndef T_A
 330 # define T_A 1
 331 #endif
 332
 333 #ifndef T_CNAME
 334 # define T_CNAME 5
 335 #endif
 336
 337 #ifndef T_SOA
 338 # define T_SOA 6
 339 #endif
 340
 341 #ifndef T_MX
 342 # define T_MX 15
 343 #endif
 344
 345 #ifndef T_NS
 346 # define T_NS 2
 347 #endif
 348
 349 #ifndef T_PTR
 350 # define T_PTR 12
 351 #endif
 352
 353
 354 /* We define a few private types for special DNS lookups:
 355
 356  . T_ZNS gets the nameservers of the enclosing zone of a domain
 357
 358  . T_MXH gets the MX hostnames only (without their priorities)
 359
 360  . T_CSA gets the domain's Client SMTP Authorization SRV record
 361
 362  . T_ADDRESSES looks up both AAAA (or A6) and A records
 363
 364 If any of these names appear in the RRtype list at:
 365   <http://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml>
 366 then we should rename Exim's private type away from the conflict.
 367 */
 368
 369 #define T_ZNS (-1)
 370 #define T_MXH (-2)
 371 #define T_CSA (-3)
 372 #define T_ADDRESSES (-4)
 373
 374 /* The resolv.h header defines __P(x) on some Solaris 2.5.1 systems (without
 375 checking that it is already defined, in fact). This conflicts with other
 376 headers that behave likewise (see below), leading to compiler warnings. Arrange
 377 to undefine it if resolv.h defines it. */
 378
 379 #if defined(__P)
 380 # define __P_WAS_DEFINED_BEFORE_RESOLV
 381 #endif
 382
 383 #include <resolv.h>
 384
 385 #if defined(__P) && ! defined (__P_WAS_DEFINED_BEFORE_RESOLV)
 386 # undef __P
 387 #endif
 388
 389 /* If not defined by os.h, we do nothing special to push DNS resolver state
 390 back to be available by the classic resolver routines.  Also, provide
 391 prototype for our get routine, unless defined away. */
 392
 393 #ifndef os_put_dns_resolver_res
 394 # define os_put_dns_resolver_res(R) do {/**/} while(0)
 395 #endif
 396 #ifndef os_get_dns_resolver_res
 397 res_state os_get_dns_resolver_res(void);
 398 #endif
 399
 400 /* These three are to support the IP option logging code. Linux is
 401 different to everyone else and there are also other systems which don't
 402 have netinet/ip_var.h, so there's a general macro to control its inclusion. */
 403
 404 #include <netinet/in_systm.h>
 405 #include <netinet/ip.h>
 406
 407 #ifndef NO_IP_VAR_H
 408 # include <netinet/ip_var.h>
 409 #endif
 410
 411 /* Linux (and some others) uses a different type for the 2nd argument of
 412 iconv(). It's os.h file defines ICONV_ARG2_TYPE. For the rest, define a default
 413 here. */
 414
 415 #ifndef ICONV_ARG2_TYPE
 416 # define ICONV_ARG2_TYPE char **
 417 #endif
 418
 419 /* One OS uses a different type for the 5th argument of getsockopt */
 420
 421 #ifndef GETSOCKOPT_ARG5_TYPE
 422 # define GETSOCKOPT_ARG5_TYPE socklen_t *
 423 #endif
 424
 425 /* One operating system uses a different type for the 2nd argument of select().
 426 Its os.h file defines SELECT_ARG2_TYPE. For the rest, define a default here. */
 427
 428 #ifndef SELECT_ARG2_TYPE
 429 # define SELECT_ARG2_TYPE fd_set
 430 #endif
 431
 432 /* One operating system uses a different type for the 4th argument of
 433 dn_expand(). Its os.h file defines DN_EXPAND_ARG4_TYPE. For the rest, define a
 434 default here. */
 435
 436 #ifndef DN_EXPAND_ARG4_TYPE
 437 # define DN_EXPAND_ARG4_TYPE char *
 438 #endif
 439
 440 /* One operating system defines a different type for the yield of inet_addr().
 441 In Exim code, its value is always assigned to the s_addr members of address
 442 structures. Casting the yield to the type of s_addr should fix the problem,
 443 since the size of the data is correct. Just in case this ever has to be
 444 changed, use a macro for the type, and define it here so that it is possible to
 445 use different values for specific OS if ever necessary. */
 446
 447 #ifndef S_ADDR_TYPE
 448 # define S_ADDR_TYPE u_long
 449 #endif
 450
 451 /* (At least) one operating system (Solaris) defines a different type for the
 452 second argument of pam_converse() - the difference is the absence of "const".
 453 Its os.h file defines PAM_CONVERSE_ARG2_TYPE. For the rest, define a default
 454 here. */
 455
 456 #ifndef PAM_CONVERSE_ARG2_TYPE
 457 # define PAM_CONVERSE_ARG2_TYPE const struct pam_message
 458 #endif
 459
 460 /* One operating system (SunOS4) defines getc, ungetc, feof, and ferror as
 461 macros and not as functions. Exim needs them to be assignable functions. This
 462 flag gets set to cause this to be sorted out here. */
 463
 464 #ifdef FUDGE_GETC_AND_FRIENDS
 465 # undef getc
 466 extern int getc(FILE *);
 467 # undef ungetc
 468 extern int ungetc(int, FILE *);
 469 # undef feof
 470 extern int feof(FILE *);
 471 # undef ferror
 472 extern int ferror(FILE *);
 473 #endif
 474
 475 /* The header from the PCRE regex package */
 476
 477 #include <pcre.h>
 478
 479 /* Exim includes are in several files. Note that local_scan.h #includes
 480 config.h, mytypes.h, and store.h, so we don't need to mention them explicitly.
 481 */
 482
 483 #include "local_scan.h"
 484 #include "macros.h"
 485 #include "dbstuff.h"
 486 #include "structs.h"
 487 #include "blob.h"
 488 #include "globals.h"
 489 #include "hash.h"
 490 #include "functions.h"
 491 #include "dbfunctions.h"
 492 #include "osfunctions.h"
 493
 494 #ifdef EXPERIMENTAL_BRIGHTMAIL
 495 # include "bmi_spam.h"
 496 #endif
 497 #ifdef SUPPORT_SPF
 498 # include "spf.h"
 499 #endif
 500 #ifdef EXPERIMENTAL_SRS_ALT
 501 # include "srs.h"
 502 #endif
 503 #ifndef DISABLE_DKIM
 504 # include "dkim.h"
 505 #endif
 506 #ifdef SUPPORT_DMARC
 507 # include "dmarc.h"
 508 # include <opendmarc/dmarc.h>
 509 #endif
 510
 511 /* The following stuff must follow the inclusion of config.h because it
 512 requires various things that are set therein. */
 513
 514 #if HAVE_ICONV             /* Not all OS have this */
 515 # include <iconv.h>
 516 #endif
 517
 518 #if defined(USE_READLINE) || defined(EXPAND_DLFUNC) || defined (LOOKUP_MODULE_DIR)
 519 # include <dlfcn.h>
 520 #endif
 521
 522 #ifdef ENABLE_DISABLE_FSYNC
 523 # define EXIMfsync(f) (disable_fsync? 0 : fsync(f))
 524 #else
 525 # define EXIMfsync(f) fsync(f)
 526 #endif
 527
 528 /* Backward compatibility; LOOKUP_LSEARCH now includes all three */
 529
 530 #if (!defined LOOKUP_LSEARCH) && (defined LOOKUP_WILDLSEARCH || defined LOOKUP_NWILDLSEARCH)
 531 # define LOOKUP_LSEARCH yes
 532 #endif
 533
 534 /* Define a union to hold either an IPv4 or an IPv6 sockaddr structure; this
 535 simplifies some of the coding.  We include the sockaddr to reduce type-punning
 536 issues in C99. */
 537
 538 union sockaddr_46 {
 539   struct sockaddr_in v4;
 540   #if HAVE_IPV6
 541   struct sockaddr_in6 v6;
 542   #endif
 543   struct sockaddr v0;
 544 };
 545
 546 /* If DISABLE_TLS is defined, ensure that USE_GNUTLS is not defined
 547 so that if USE_GNUTLS *is* set, we can assume DISABLE_TLS is not set.
 548 Ditto USE_OPENSSL.
 549 Likewise, OSCP, AUTH_TLS and CERTNAMES cannot be supported. */
 550
 551 #ifdef DISABLE_TLS
 552 # undef USE_OPENSSL
 553 # undef USE_GNUTLS
 554 # ifndef DISABLE_OCSP
 555 #  define DISABLE_OCSP
 556 # endif
 557 # undef EXPERIMENTAL_CERTNAMES
 558 # undef AUTH_TLS
 559 #endif
 560
 561 /* If SPOOL_DIRECTORY, LOG_FILE_PATH or PID_FILE_PATH have not been defined,
 562 set them to the null string. */
 563
 564 #ifndef SPOOL_DIRECTORY
 565   #define SPOOL_DIRECTORY ""
 566 #endif
 567 #ifndef LOG_FILE_PATH
 568   #define LOG_FILE_PATH ""
 569 #endif
 570 #ifndef PID_FILE_PATH
 571   #define PID_FILE_PATH ""
 572 #endif
 573
 574 /* The EDQUOT error code isn't universally available, though it is widespread.
 575 There is a particular shambles in SunOS5, where it did not exist originally,
 576 but got installed with a particular patch for Solaris 2.4. There is a
 577 configuration variable for specifying what the system's "over quota" error is,
 578 which will end up in config.h if supplied in OS/Makefile-xxx. If it is not set,
 579 default to EDQUOT if it exists, otherwise ENOSPC. */
 580
 581 #ifndef ERRNO_QUOTA
 582 # ifdef  EDQUOT
 583 #  define ERRNO_QUOTA EDQUOT
 584 # else
 585 #  define ERRNO_QUOTA ENOSPC
 586 # endif
 587 #endif
 588
 589 /* DANE w/o DNSSEC is useless */
 590 #if defined(SUPPORT_DANE) && defined(DISABLE_DNSSEC)
 591 # error DANE support requires DNSSEC support
 592 #endif
 593
 594 /* Some platforms (FreeBSD, OpenBSD, Solaris) do not seem to define this */
 595
 596 #ifndef POLLRDHUP
 597 # define POLLRDHUP (POLLIN | POLLHUP)
 598 #endif
 599
 600 /* Some platforms (Darwin) have to define a larger limit on groups membership */
 601
 602 #ifndef EXIM_GROUPLIST_SIZE
 603 # define EXIM_GROUPLIST_SIZE NGROUPS_MAX
 604 #endif
 605
 606 #endif
 607 /* End of exim.h */