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