X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/8523533c08c018ac4b750b0e0fab6cfe611e8a49..1d28cc061677bd07d9bed48dd84bd5c590247043:/src/src/EDITME diff --git a/src/src/EDITME b/src/src/EDITME index aefed22ce..625df18f5 100644 --- a/src/src/EDITME +++ b/src/src/EDITME @@ -1,8 +1,8 @@ -# $Cambridge: exim/src/src/EDITME,v 1.5 2004/12/16 15:11:47 tom Exp $ - ################################################## # The Exim mail transport agent # ################################################## +# Copyright (c) The Exim Maintainers 2022 +# SPDX-License-Identifier: GPL-2.0-or-later # This is the template for Exim's main build-time configuration file. It # contains settings that are independent of any operating system. These are @@ -14,11 +14,12 @@ # Exim distribution directory before running the "make" command. # Things that depend on the operating system have default settings in -# OS/Makefile-Default, but these are overridden for some OS by files called -# called OS/Makefile-. You can further override these by creating files -# called Local/Makefile-, where "" stands for the name of your -# operating system - look at the names in the OS directory to see which names -# are recognized. +# OS/Makefile-Default, but these are overridden for some OS by files +# called OS/Makefile-. You can further override these settings by +# creating files Local/Makefile-, and Local/Makefile-. +# The suffix "" stands for the name of your operating system - look +# at the names in the OS directory to see which names are recognized, +# and "" is the content of the environment variable "build". # However, if you are building Exim for a single OS only, you don't need to # worry about setting up Local/Makefile-. Any build-time configuration @@ -131,8 +132,7 @@ CONFIGURE_FILE=/usr/exim/configure # group that is used for Exim processes when they no longer need to be root. In # particular, this applies when receiving messages and when doing remote # deliveries. (Local deliveries run as various non-root users, typically as the -# owner of a local mailbox.) Specifying these values as root is very strongly -# discouraged. +# owner of a local mailbox.) Specifying these values as root is not supported. EXIM_USER= @@ -180,15 +180,128 @@ SPOOL_DIRECTORY=/var/spool/exim +############################################################################### +# TLS # +############################################################################### +# Exim is built by default to support the SMTP STARTTLS command, which implements +# Transport Layer Security using SSL (Secure Sockets Layer). This requires you +# must install the OpenSSL library package or the GnuTLS library. Exim contains +# no cryptographic code of its own. + +# If you are running Exim as a (TLS) server, just building it with TLS support +# is all you need to do, as tls_advertise_hosts is set to '*' by +# default. But you are advised to create a suiteable certificate, and tell +# Exim about it by means of the tls_certificate and tls_privatekey run +# time options, otherwise Exim will create a self signed certificate on +# the fly. If you are running Exim only as a (TLS) client, building it with +# TLS support is all you need to do. +# +# If you are using pkg-config then you should not need to worry where +# the libraries and headers are installed, as the pkg-config .pc +# specification should include all -L/-I information necessary. +# Enabling the USE_*_PC options should be sufficient. If not using +# pkg-config, then you have to specify the libraries, and you might +# need to specify the locations too. + +# Uncomment the following lines if you want +# to build Exim without any TLS support (either OpenSSL or GnuTLS): +# DISABLE_TLS=yes +# Unless you do this, you must define one of USE_OPENSSL or USE_GNUTLS +# below. + +# If you are building with TLS, the library configuration must be done: + +# Uncomment this if you are using OpenSSL +# USE_OPENSSL=yes +# Uncomment one of these settings if you are using OpenSSL; pkg-config vs not +# and an optional location. +# USE_OPENSSL_PC=openssl +# TLS_LIBS=-lssl -lcrypto +# TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto + +# Uncomment this if you are using GnuTLS +# USE_GNUTLS=yes +# Uncomment one of these settings if you are using GnuTLS; pkg-config vs not +# and an optional location. If you disable SUPPORT_DANE below, you +# can remove the gnutls-dane references here. Earlier versions of GnuTLS +# required libtasn1 and libgrypt also; add if needed. +# USE_GNUTLS_PC=gnutls gnutls-dane +# TLS_LIBS=-lgnutls -lgnutls-dane +# TLS_LIBS=-L/usr/local/gnu/lib -lgnutls -ltasn1 -lgcrypt -lgnutls-dane + +# If using GnuTLS older than 2.10 and using pkg-config then note that Exim's +# build process will require libgcrypt-config to exist in your $PATH. A +# version that old is likely to become unsupported by Exim in 2017. + +# The security fix we provide with the gnutls_allow_auto_pkcs11 option +# (4.82 PP/09) introduces a compatibility regression. The symbol is +# not available if GnuTLS is build without p11-kit (--without-p11-kit +# configure option). In this case use AVOID_GNUTLS_PKCS11=yes when +# building Exim. +# AVOID_GNUTLS_PKCS11=yes + +# If you are running Exim as a server, note that just building it with TLS +# support is not all you need to do. You also need to set up a suitable +# certificate, and tell Exim about it by means of the tls_certificate +# and tls_privatekey run time options. You also need to set tls_advertise_hosts +# to specify the hosts to which Exim advertises TLS support. On the other hand, +# if you are running Exim only as a client, building it with TLS support +# is all you need to do. + +# If you are using pkg-config then you should not need to worry where the +# libraries and headers are installed, as the pkg-config .pc specification +# should include all -L/-I information necessary. If not using pkg-config +# then you might need to specify the locations too. + +# Additional libraries and include files are required for both OpenSSL and +# GnuTLS. The TLS_LIBS settings above assume that the libraries are installed +# with all your other libraries. If they are in a special directory, you may +# need something like + +# TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto + +# or + +# TLS_LIBS=-L/opt/gnu/lib -lgnutls -ltasn1 -lgcrypt -lgnutls-dane +# If not using DANE under GnuTLS we can lose one library +# TLS_LIBS=-L/opt/gnu/lib -lgnutls -ltasn1 -lgcrypt + +# TLS_LIBS is included only on the command for linking Exim itself, not on any +# auxiliary programs. If the include files are not in a standard place, you can +# set TLS_INCLUDE to specify where they are, for example: + +# TLS_INCLUDE=-I/usr/local/openssl/include/ +# or +# TLS_INCLUDE=-I/opt/gnu/include + +# You don't need to set TLS_INCLUDE if the relevant directories are already +# specified in INCLUDE. + + +# Uncomment the following line to remove support for TLS Resumption +# DISABLE_TLS_RESUME=yes + + ############################################################################### # THESE ARE THINGS YOU PROBABLY WANT TO SPECIFY # ############################################################################### +# If you need extra header file search paths on all compiles, put the -I +# options in INCLUDE. If you want the extra searches only for certain +# parts of the build, see more specific xxx_INCLUDE variables below. + +# INCLUDE=-I/example/include + # You need to specify some routers and transports if you want the Exim that you # are building to be capable of delivering mail. You almost certainly need at # least one type of lookup. You should consider whether you want to build # the Exim monitor or not. +# If you need to override how pkg-config finds configuration files for +# installed software, then you can set that here; wildcards will be expanded. + +# PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig : /opt/*/lib/pkgconfig + #------------------------------------------------------------------------------ # These settings determine which individual router drivers are included in the @@ -243,6 +356,27 @@ TRANSPORT_SMTP=yes # SUPPORT_MBX=yes +#------------------------------------------------------------------------------ +# See below for dynamic lookup modules. +# +# If not using package management but using this anyway, then think about how +# you perform upgrades and revert them. You should consider the benefit of +# embedding the Exim version number into LOOKUP_MODULE_DIR, so that you can +# maintain two concurrent sets of modules. +# +# *BEWARE*: ability to modify the files in LOOKUP_MODULE_DIR is equivalent to +# the ability to modify the Exim binary, which is often setuid root! The Exim +# developers only intend this functionality be used by OS software packagers +# and we suggest that such packagings' integrity checks should be paranoid +# about the permissions of the directory and the files within. + +# LOOKUP_MODULE_DIR=/usr/lib/exim/lookups/ + +# To build a module dynamically, you'll need to define CFLAGS_DYNAMIC for +# your platform. Eg: +# CFLAGS_DYNAMIC=-shared -rdynamic +# CFLAGS_DYNAMIC=-shared -rdynamic -fPIC + #------------------------------------------------------------------------------ # These settings determine which file and database lookup methods are included # in the binary. See the manual chapter entitled "File and database lookups" @@ -251,21 +385,49 @@ TRANSPORT_SMTP=yes # LOOKUP_DNSDB does *not* refer to general mail routing using the DNS. It is # for the specialist case of using the DNS as a general database facility (not # common). +# If set to "2" instead of "yes" then the corresponding lookup will be +# built as a module and must be installed into LOOKUP_MODULE_DIR. You need to +# add -export-dynamic -rdynamic to EXTRALIBS. You may also need to add -ldl to +# EXTRALIBS so that dlopen() is available to Exim. You need to define +# LOOKUP_MODULE_DIR above so the exim binary actually loads dynamic lookup +# modules. +# Also, instead of adding all the libraries/includes to LOOKUP_INCLUDE and +# LOOKUP_LIBS, add them to the respective LOOKUP_*_INCLUDE and LOOKUP_*_LIBS +# (where * is the name as given here in this list). That ensures that only +# the dynamic library and not the exim binary will be linked against the +# library. +# NOTE: LDAP cannot be built as a module! +# +# For Redis you need to have hiredis installed on your system +# (https://github.com/redis/hiredis). +# Depending on where it is installed you may have to edit the CFLAGS +# (often += -I/usr/local/include) and LDFLAGS (-lhiredis) lines. + +# If your system has pkg-config then the _INCLUDE/_LIBS setting can be +# handled for you automatically by also defining the _PC variable to reference +# the name of the pkg-config package, if such is available. LOOKUP_DBM=yes LOOKUP_LSEARCH=yes +LOOKUP_DNSDB=yes # LOOKUP_CDB=yes -# LOOKUP_DNSDB=yes # LOOKUP_DSEARCH=yes # LOOKUP_IBASE=yes +# LOOKUP_JSON=yes # LOOKUP_LDAP=yes +# LOOKUP_LMDB=yes + # LOOKUP_MYSQL=yes +# LOOKUP_MYSQL_PC=mariadb # LOOKUP_NIS=yes # LOOKUP_NISPLUS=yes # LOOKUP_ORACLE=yes # LOOKUP_PASSWD=yes # LOOKUP_PGSQL=yes +# LOOKUP_REDIS=yes +# LOOKUP_SQLITE=yes +# LOOKUP_SQLITE_PC=sqlite3 # LOOKUP_WHOSON=yes # These two settings are obsolete; all three lookups are compiled when @@ -276,6 +438,9 @@ LOOKUP_LSEARCH=yes # LOOKUP_NWILDLSEARCH=yes +# Some platforms may need this for LOOKUP_NIS: +# LIBS += -lnsl + #------------------------------------------------------------------------------ # If you have set LOOKUP_LDAP=yes, you should set LDAP_LIB_TYPE to indicate # which LDAP library you have. Unfortunately, though most of their functions @@ -293,26 +458,63 @@ LOOKUP_LSEARCH=yes # Michigan (OpenLDAP 1) library. +#------------------------------------------------------------------------------ +# The PCRE2 library is required for Exim. There is no longer an embedded +# version of the PCRE library included with the source code, instead you +# must use a system library or build your own copy of PCRE2. +# In either case you must specify the library link info here. If the +# PCRE2 header files are not in the standard search path you must also +# modify the INCLUDE path (above) +# +# Use PCRE_CONFIG to query the pcre-config command (first found in $PATH) +# to find the include files and libraries, else use PCRE_LIBS and set INCLUDE +# too if needed. + +PCRE2_CONFIG=yes +# PCRE_LIBS=-lpcre2 + + +#------------------------------------------------------------------------------ +# Comment out the following line to remove DANE support. +# Note: DANE support requires DNSSEC support (the default) and +# SUPPORT_TLS (the default). For DANE under GnuTLS we need an additional +# library. See TLS_LIBS or USE_GNUTLS_PC below. + +SUPPORT_DANE=yes + #------------------------------------------------------------------------------ # Additional libraries and include directories may be required for some # lookup styles (e.g. LDAP, MYSQL or PGSQL). LOOKUP_LIBS is included only on # the command for linking Exim itself, not on any auxiliary programs. You # don't need to set LOOKUP_INCLUDE if the relevant directories are already # specified in INCLUDE. The settings below are just examples; -lpq is for -# PostgreSQL, -lgds is for Interbase. +# PostgreSQL, -lgds is for Interbase, -lsqlite3 is for SQLite, -lhiredis +# is for Redis, -ljansson for JSON. +# +# You do not need to use this for any lookup information added via pkg-config. # LOOKUP_INCLUDE=-I /usr/local/ldap/include -I /usr/local/mysql/include -I /usr/local/pgsql/include -# LOOKUP_LIBS=-L/usr/local/lib -lldap -llber -lmysqlclient -lpq -lgds +# LOOKUP_INCLUDE +=-I /usr/local/include +# LOOKUP_LIBS=-L/usr/local/lib -lldap -llber -lmysqlclient -lpq -lgds -lsqlite3 -llmdb + +#------------------------------------------------------------------------------ +# If you included LOOKUP_LMDB above you will need the library. Depending +# on where installed you may also need an include directory +# +# LOOKUP_INCLUDE += -I/usr/local/include +# LOOKUP_LIBS += -llmdb + #------------------------------------------------------------------------------ # Compiling the Exim monitor: If you want to compile the Exim monitor, a # program that requires an X11 display, then EXIM_MONITOR should be set to the -# value "eximon.bin". Comment out this setting to disable compilation of the +# value "eximon.bin". De-comment this setting to enable compilation of the # monitor. The locations of various X11 directories for libraries and include # files are defaulted in the OS/Makefile-Default file, but can be overridden in # local OS-specific make files. -EXIM_MONITOR=eximon.bin +# EXIM_MONITOR=eximon.bin + #------------------------------------------------------------------------------ # Compiling Exim with content scanning support: If you want to compile Exim @@ -321,44 +523,117 @@ EXIM_MONITOR=eximon.bin # and the MIME ACL. Please read the documentation to learn more about these # features. -#WITH_CONTENT_SCAN=yes +# WITH_CONTENT_SCAN=yes -# If you want to use the deprecated "demime" condition in the DATA ACL, -# uncomment the line below. Doing so will also explicitly turn on the -# WITH_CONTENT_SCAN option. If possible, use the MIME ACL instead of -# the "demime" condition. +# If you have content scanning you may wish to only include some of the scanner +# interfaces. Uncomment any of these lines to remove that code. + +# DISABLE_MAL_FFROTD=yes +# DISABLE_MAL_FFROT6D=yes +# DISABLE_MAL_DRWEB=yes +# DISABLE_MAL_FSECURE=yes +# DISABLE_MAL_SOPHIE=yes +# DISABLE_MAL_CLAM=yes +# DISABLE_MAL_AVAST=yes +# DISABLE_MAL_SOCK=yes +# DISABLE_MAL_CMDLINE=yes + +# These scanners are claimed to be no longer existent. + +DISABLE_MAL_AVE=yes +DISABLE_MAL_KAV=yes +DISABLE_MAL_MKS=yes + + +#------------------------------------------------------------------------------ +# If built with TLS, Exim includes code to support DKIM (DomainKeys Identified +# Mail, RFC4871) signing and verification. Verification of signatures is +# turned on by default. See the spec for information on conditionally +# disabling it. To disable the inclusion of the entire feature, set +# DISABLE_DKIM to "yes" + +# DISABLE_DKIM=yes + +#------------------------------------------------------------------------------ +# Uncomment the following line to remove Per-Recipient-Data-Response support. + +# DISABLE_PRDR=yes + +#------------------------------------------------------------------------------ +# Uncomment the following line to remove OCSP stapling support in TLS, +# from Exim. Note it can only be supported when built with +# GnuTLS 3.1.3 or later, or OpenSSL + +# DISABLE_OCSP=yes + +#------------------------------------------------------------------------------ +# By default, Exim has support for checking the AD bit in a DNS response, to +# determine if DNSSEC validation was successful. If your system libraries +# do not support that bit, then set DISABLE_DNSSEC to "yes" +# Note: DNSSEC is required for DANE support. + +# DISABLE_DNSSEC=yes + +# To disable support for Events set DISABLE_EVENT to "yes" +# DISABLE_EVENT=yes + + +# Uncomment this line to remove support for early pipelining, per +# https://datatracker.ietf.org/doc/draft-harris-early-pipe/ +# DISABLE_PIPE_CONNECT=yes + + +# Uncomment the following to remove the fast-ramp two-phase-queue-run support +# DISABLE_QUEUE_RAMP=yes + +# Uncomment the following lines to add SRS (Sender Rewriting Scheme) support +# using only native facilities. +# SUPPORT_SRS=yes -#WITH_OLD_DEMIME=yes #------------------------------------------------------------------------------ # Compiling Exim with experimental features. These are documented in # experimental-spec.txt. "Experimental" means that the way these features are -# implemented may still change. Backward compatability is not guaranteed. - -# Uncomment the following lines to add SPF support. You need to have libspf2 -# installed on your system (www.libspf2.org). Depending on where it is installed -# you may have to edit the CFLAGS and LDFLAGS lines. -#EXPERIMENTAL_SPF=yes -#CFLAGS += -I/usr/local/include -#LDFLAGS += -lspf2 +# implemented may still change. Backward compatibility is not guaranteed. + +# Uncomment the following line to add support for talking to dccifd. This +# defaults the socket path to /usr/local/dcc/var/dccifd. +# This support also requires WITH_CONTENT_SCAN enabled. + +# EXPERIMENTAL_DCC=yes + +# Uncomment the following line to add DMARC checking capability, implemented +# using libopendmarc libraries. You must have SPF and DKIM support enabled also. +# SUPPORT_DMARC=yes +# CFLAGS += -I/usr/local/include +# LDFLAGS += -lopendmarc +# Uncomment the following if you need to change the default. You can +# override it at runtime (main config option dmarc_tld_file) +# DMARC_TLD_FILE=/etc/exim/opendmarc.tlds +# +# Library version libopendmarc-1.4.1-1.fc33.x86_64 (on Fedora 33) is known broken; +# 1.3.2-3 works. It seems that the OpenDMARC project broke their API. +# Use this option if you need to build with an old library (1.3.x) +# DMARC_API=100300 -# Uncommend the following lines to add SRS (Sender rewriting scheme) support. -# You need to have libsrs_alt installed on your system (srs.mirtol.com). -# Depending on where it is installed you may have to edit the CFLAGS and -# LDFLAGS lines. -#EXPERIMENTAL_SRS=yes -#CFLAGS += -I/usr/local/include -#LDFLAGS += -lsrs_alt +# Uncomment the following line to add ARC (Authenticated Received Chain) +# support. You must have SPF and DKIM support enabled also. +# EXPERIMENTAL_ARC=yes -# Uncommend the following lines to add Brightmail AntiSpam support. You need +# Uncomment the following lines to add Brightmail AntiSpam support. You need # to have the Brightmail client SDK installed. Please check the experimental # documentation for implementation details. You need to edit the CFLAGS and # LDFLAGS lines. -#EXPERIMENTAL_BRIGHTMAIL=yes -#CFLAGS += -I/opt/brightmail/bsdk-6.0/include -#LDFLAGS += -lxml2 -lbmiclient_single -L/opt/brightmail/bsdk-6.0/lib +# EXPERIMENTAL_BRIGHTMAIL=yes +# CFLAGS += -I/opt/brightmail/bsdk-6.0/include +# LDFLAGS += -lxml2_single -lbmiclient_single -L/opt/brightmail/bsdk-6.0/lib +# Uncomment the following to include extra information in fail DSN message (bounces) +# EXPERIMENTAL_DSN_INFO=yes + +# Uncomment the following line to add queuefile transport support +# EXPERIMENTAL_QUEUEFILE=yes ############################################################################### # THESE ARE THINGS YOU MIGHT WANT TO SPECIFY # @@ -387,14 +662,13 @@ FIXED_NEVER_USERS=root #------------------------------------------------------------------------------ -# By default, Exim insists that its configuration file be owned either by root -# or by the Exim user. You can specify one additional permitted owner here. +# By default, Exim insists that its configuration file be owned by root. You +# can specify one additional permitted owner here. # CONFIGURE_OWNER= # If the configuration file is group-writeable, Exim insists by default that it -# is owned by root or the Exim user. You can specify one additional permitted -# group owner here. +# is owned by root. You can specify one additional permitted group owner here. # CONFIGURE_GROUP= @@ -416,32 +690,31 @@ FIXED_NEVER_USERS=root #------------------------------------------------------------------------------ # The -C option allows Exim to be run with an alternate runtime configuration -# file. When this is used by root or the Exim user, root privilege is retained -# by the binary (for any other caller, it is dropped). You can restrict the -# location of alternate configurations by defining a prefix below. Any file -# used with -C must then start with this prefix (except that /dev/null is also -# permitted if the caller is root, because that is used in the install script). -# If the prefix specifies a directory that is owned by root, a compromise of -# the Exim account does not permit arbitrary alternate configurations to be -# used. The prefix can be more restrictive than just a directory (the second -# example). +# file. When this is used by root, root privilege is retained by the binary +# (for any other caller including the Exim user, it is dropped). You can +# restrict the location of alternate configurations by defining a prefix below. +# Any file used with -C must then start with this prefix (except that /dev/null +# is also permitted if the caller is root, because that is used in the install +# script). If the prefix specifies a directory that is owned by root, a +# compromise of the Exim account does not permit arbitrary alternate +# configurations to be used. The prefix can be more restrictive than just a +# directory (the second example). # ALT_CONFIG_PREFIX=/some/directory/ # ALT_CONFIG_PREFIX=/some/directory/exim.conf- #------------------------------------------------------------------------------ -# If you uncomment the following line, only root may use the -C or -D options -# without losing root privilege. The -C option specifies an alternate runtime -# configuration file, and the -D option changes macro values in the runtime -# configuration. Uncommenting this line restricts what can be done with these -# options. A call to receive a message (either one-off or via a daemon) cannot -# successfully continue to deliver it, because the re-exec of Exim to regain -# root privilege will fail, owing to the use of -C or -D by the Exim user. -# However, you can still use -C for testing (as root) if you do separate Exim -# calls for receiving a message and subsequently delivering it. +# When a user other than root uses the -C option to override the configuration +# file (including the Exim user when re-executing Exim to regain root +# privileges for local message delivery), this will normally cause Exim to +# drop root privileges. The TRUSTED_CONFIG_LIST option, specifies a file which +# contains a list of trusted configuration filenames, one per line. If the -C +# option is used by the Exim user or by the user specified in the +# CONFIGURE_OWNER setting, to specify a configuration file which is listed in +# the TRUSTED_CONFIG_LIST file, then root privileges are not dropped by Exim. -# ALT_CONFIG_ROOT_ONLY=yes +# TRUSTED_CONFIG_LIST=/usr/exim/trusted_configs #------------------------------------------------------------------------------ @@ -452,6 +725,31 @@ FIXED_NEVER_USERS=root # DISABLE_D_OPTION=yes +#------------------------------------------------------------------------------ +# By contrast, you might be maintaining a system which relies upon the ability +# to override values with -D and assumes that these will be passed through to +# the delivery processes. As of Exim 4.73, this is no longer the case by +# default. Going forward, we strongly recommend that you use a shim Exim +# configuration file owned by root stored under TRUSTED_CONFIG_LIST. +# That shim can set macros before .include'ing your main configuration file. +# +# As a strictly transient measure to ease migration to 4.73, the +# WHITELIST_D_MACROS value defines a colon-separated list of macro-names +# which are permitted to be overridden from the command-line which will be +# honoured by the Exim user. So these are macros that can persist to delivery +# time. +# Examples might be -DTLS or -DSPOOL=/some/dir. The values on the +# command-line are filtered to only permit: [A-Za-z0-9_/.-]* +# +# This option is highly likely to be removed in a future release. It exists +# only to make 4.73 as easy as possible to migrate to. If you use it, we +# encourage you to schedule time to rework your configuration to not depend +# upon it. Most people should not need to use this. +# +# By default, no macros are whitelisted for -D usage. + +# WHITELIST_D_MACROS=TLS:SPOOL + #------------------------------------------------------------------------------ # Exim has support for the AUTH (authentication) extension of the SMTP # protocol, as defined by RFC 2554. If you don't know what SMTP authentication @@ -463,16 +761,34 @@ FIXED_NEVER_USERS=root # AUTH_CRAM_MD5=yes # AUTH_CYRUS_SASL=yes +# AUTH_DOVECOT=yes +# AUTH_EXTERNAL=yes +# AUTH_GSASL=yes +# AUTH_GSASL_PC=libgsasl +# AUTH_HEIMDAL_GSSAPI=yes +# AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi +# AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi heimdal-krb5 # AUTH_PLAINTEXT=yes # AUTH_SPA=yes +# AUTH_TLS=yes +# Heimdal through 1.5 required pkg-config 'heimdal-gssapi'; Heimdal 7.1 +# requires multiple pkg-config files to work with Exim, so the second example +# above is needed. #------------------------------------------------------------------------------ # If you specified AUTH_CYRUS_SASL above, you should ensure that you have the # Cyrus SASL library installed before trying to build Exim, and you probably -# want to uncomment the following line: +# want to uncomment the first line below. +# Similarly for GNU SASL, unless pkg-config is used via AUTH_GSASL_PC. +# Ditto for AUTH_HEIMDAL_GSSAPI(_PC). # AUTH_LIBS=-lsasl2 +# AUTH_LIBS=-lgsasl +# AUTH_LIBS=-lgssapi -lheimntlm -lkrb5 -lhx509 -lcom_err -lhcrypto -lasn1 -lwind -lroken -lcrypt + +# If using AUTH_GSASL with SCRAM methods, you should also be defining +# SUPPORT_I18N to get standards-conformant support of utf8 normalization. #------------------------------------------------------------------------------ @@ -514,6 +830,13 @@ HEADERS_CHARSET="ISO-8859-1" # # but of course there may need to be other things in CFLAGS and EXTRALIBS_EXIM # as well. +# +# nb: FreeBSD as of 4.89 defines LIBICONV_PLUG to pick up the system iconv +# more reliably. If you explicitly want the libiconv Port then as well +# as adding -liconv you'll want to unset LIBICONV_PLUG. If you actually need +# this, let us know, but for now the Exim Maintainers are assuming that this +# is uncommon and so you'll need to edit OS/os.h-FreeBSD yourself to remove +# the define. #------------------------------------------------------------------------------ @@ -523,7 +846,7 @@ HEADERS_CHARSET="ISO-8859-1" # configuration of an authenticator for use with SMTP AUTH.) At least one # operating system has an extended function called crypt16(), which uses up to # 16 characters of a password (the normal crypt() uses only the first 8). Exim -# supports the use of crypt16() as well as crypt(). +# supports the use of crypt16() as well as crypt() but note the warning below. # You can always indicate a crypt16-encrypted password by preceding it with # "{crypt16}". If you want the default handling (without any preceding @@ -535,57 +858,23 @@ HEADERS_CHARSET="ISO-8859-1" # an encrypted password with "{crypt}". For more details, see the description # of the "crypteq" condition in the manual chapter on string expansions. -# Since most operating systems do not include a crypt16() function (yet?), Exim -# has one of its own, which it uses unless HAVE_CRYPT16 is defined. Normally, -# that will be set in an OS-specific Makefile for the OS that have such a -# function, so you should not need to bother with it. - - -#------------------------------------------------------------------------------ -# Exim can be built to support the SMTP STARTTLS command, which implements -# Transport Layer Security using SSL (Secure Sockets Layer). To do this, you -# must install the OpenSSL library package or the GnuTLS library. Exim contains -# no cryptographic code of its own. Uncomment the following lines if you want -# to build Exim with TLS support. If you don't know what this is all about, -# leave these settings commented out. - -# This setting is required for any TLS support (either OpenSSL or GnuTLS) -# SUPPORT_TLS=yes - -# Uncomment this setting if you are using OpenSSL -# TLS_LIBS=-lssl -lcrypto - -# Uncomment these settings if you are using GnuTLS -# USE_GNUTLS=yes -# TLS_LIBS=-lgnutls -ltasn1 -lgcrypt +# Some operating systems do not include a crypt16() function, so Exim has one +# of its own, which it uses unless HAVE_CRYPT16 is defined. Normally, that will +# be set in an OS-specific Makefile for the OS that have such a function, so +# you should not need to bother with it. -# If you are running Exim as a server, note that just building it with TLS -# support is not all you need to do. You also need to set up a suitable -# certificate, and tell Exim about it by means of the tls_certificate -# and tls_privatekey run time options. You also need to set tls_advertise_hosts -# to specify the hosts to which Exim advertises TLS support. On the other hand, -# if you are running Exim only as a client, building it with TLS support -# is all you need to do. - -# Additional libraries and include files are required for both OpenSSL and -# GnuTLS. The TLS_LIBS settings above assume that the libraries are installed -# with all your other libraries. If they are in a special directory, you may -# need something like - -# TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto -# or -# TLS_LIBS=-L/opt/gnu/lib -lgnutls -ltasn1 -lgcrypt - -# TLS_LIBS is included only on the command for linking Exim itself, not on any -# auxiliary programs. If the include files are not in a standard place, you can -# set TLS_INCLUDE to specify where they are, for example: - -# TLS_INCLUDE=-I/usr/local/openssl/include/ -# or -# TLS_INCLUDE=-I/opt/gnu/include - -# You don't need to set TLS_INCLUDE if the relevant directories are already -# specified in INCLUDE. +# *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** +# It turns out that the above is not entirely accurate. As well as crypt16() +# there is a function called bigcrypt() that some operating systems have. This +# may or may not use the same algorithm, and both of them may be different to +# Exim's built-in crypt16() that is used unless HAVE_CRYPT16 is defined. +# +# However, since there is now a move away from the traditional crypt() +# functions towards using SHA1 and other algorithms, tidying up this area of +# Exim is seen as very low priority. In practice, if you need to, you can +# define DEFAULT_CRYPT to the name of any function that has the same interface +# as the traditional crypt() function. +# *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** #------------------------------------------------------------------------------ @@ -596,7 +885,7 @@ HEADERS_CHARSET="ISO-8859-1" # with the extension "texinfo" in the doc directory. You may find that the # version number of the texinfo files is different to your Exim version number, # because the main documentation isn't updated as often as the code. For -# example, if you have Exim version 4.43, the source tarball upacks into a +# example, if you have Exim version 4.43, the source tarball unpacks into a # directory called exim-4.43, but the texinfo tarball unpacks into exim-4.40. # In this case, move the contents of exim-4.40/doc into exim-4.43/doc after you # have unpacked them. Then set INFO_DIRECTORY to the location of your info @@ -674,9 +963,15 @@ COMPRESS_SUFFIX=gz # If the exigrep utility is fed compressed log files, it tries to uncompress # them using this command. +# Leave it empty to enforce autodetection at runtime: +# ZCAT_COMMAND= +# +# Omit the path if you want to use your system's PATH: +# ZCAT_COMMAND=zcat +# +# Or specify the full pathname: ZCAT_COMMAND=/usr/bin/zcat - #------------------------------------------------------------------------------ # Compiling in support for embedded Perl: If you want to be able to # use Perl code in Exim's string manipulation language and you have Perl @@ -686,6 +981,16 @@ ZCAT_COMMAND=/usr/bin/zcat # EXIM_PERL=perl.o +#------------------------------------------------------------------------------ +# Support for dynamically-loaded string expansion functions via ${dlfunc. If +# you are using gcc the dynamically-loaded object must be compiled with the +# -shared option, and you will need to add -export-dynamic to EXTRALIBS so +# that the local_scan API is made available by the linker. You may also need +# to add -ldl to EXTRALIBS so that dlopen() is available to Exim. + +# EXPAND_DLFUNC=yes + + #------------------------------------------------------------------------------ # Exim has support for PAM (Pluggable Authentication Modules), a facility # which is available in the latest releases of Solaris and in some GNU/Linux @@ -699,6 +1004,46 @@ ZCAT_COMMAND=/usr/bin/zcat # GNU/Linux -ldl is also needed. +#------------------------------------------------------------------------------ +# Proxying. +# +# If you may want to use outbound (client-side) proxying, using Socks5, +# uncomment the line below. + +# SUPPORT_SOCKS=yes + +# If you may want to use inbound (server-side) proxying, using Proxy Protocol, +# uncomment the line below. + +# SUPPORT_PROXY=yes + + +#------------------------------------------------------------------------------ +# Internationalisation. +# +# Uncomment the following to include Internationalisation features. This is the +# SMTPUTF8 ESMTP extension, and associated facilities for handling UTF8 domain +# and localparts, per RFC 3490 (IDNA2003). +# You need to have the IDN library installed. +# If you want IDNA2008 mappings per RFCs 5890, 6530 and 6533, you additionally +# need libidn2 and SUPPORT_I18N_2008. + +# SUPPORT_I18N=yes +# LDFLAGS += -lidn +# SUPPORT_I18N_2008=yes +# LDFLAGS += -lidn -lidn2 + + +#------------------------------------------------------------------------------ +# Uncomment the following lines to add SPF support. You need to have libspf2 +# installed on your system (www.libspf2.org). Depending on where it is installed +# you may have to edit the CFLAGS and LDFLAGS lines. + +# SUPPORT_SPF=yes +# CFLAGS += -I/usr/local/include +# LDFLAGS += -lspf2 + + #------------------------------------------------------------------------------ # Support for authentication via Radius is also available. The Exim support, # which is intended for use in conjunction with the SMTP AUTH facilities, @@ -710,17 +1055,24 @@ ZCAT_COMMAND=/usr/bin/zcat # If you have set RADIUS_CONFIG_FILE, you should also set one of these to # indicate which RADIUS library is used: -# -# RADIUSCLIENT is the radiusclient library; you probably need to add -# -libradiusclient to EXTRALIBS -# -# RADLIB is the Radius library that comes with FreeBSD (the header file is -# called radlib.h); you probably need to add -lradius to EXTRALIBS # RADIUS_LIB_TYPE=RADIUSCLIENT +# RADIUS_LIB_TYPE=RADIUSCLIENTNEW # RADIUS_LIB_TYPE=RADLIB -# If you don't set one of these, Exim assumes the radiusclient library. +# RADIUSCLIENT is the radiusclient library; you probably need to add +# -lradiusclient to EXTRALIBS. +# +# The API for the radiusclient library was changed at release 0.4.0. +# Unfortunately, the header file does not define a version number that clients +# can use to support both the old and new APIs. If you are using version 0.4.0 +# or later of the radiusclient library, you should use RADIUSCLIENTNEW. +# +# RADLIB is the Radius library that comes with FreeBSD (the header file is +# called radlib.h); you probably need to add -lradius to EXTRALIBS. +# +# If you do not set RADIUS_LIB_TYPE, Exim assumes the radiusclient library, +# using the original API. #------------------------------------------------------------------------------ @@ -734,7 +1086,7 @@ ZCAT_COMMAND=/usr/bin/zcat # There is no need to install all of SASL on your system. You just need to run # ./configure --with-pwcheck, cd to the pwcheck directory within the sources, # make and make install. You must create the socket directory (default -# /var/pwcheck) and chown it to exim's user and group. Once you have installed +# /var/pwcheck) and chown it to Exim's user and group. Once you have installed # pwcheck, you should arrange for it to be started by root at boot time. # CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck @@ -742,7 +1094,7 @@ ZCAT_COMMAND=/usr/bin/zcat #------------------------------------------------------------------------------ # Support for authentication via the Cyrus SASL saslauthd daemon is available. -# The Exim support, which is intented for use in conjunction with the SMTP AUTH +# The Exim support, which is intended for use in conjunction with the SMTP AUTH # facilities, is included only when requested by setting the following # parameter to the location of the saslauthd daemon's socket. # @@ -750,7 +1102,7 @@ ZCAT_COMMAND=/usr/bin/zcat # ./configure --with-saslauthd (and any other options you need, for example, to # select or deselect authentication mechanisms), cd to the saslauthd directory # within the sources, make and make install. You must create the socket -# directory (default /var/state/saslauthd) and chown it to exim's user and +# directory (default /var/state/saslauthd) and chown it to Exim's user and # group. Once you have installed saslauthd, you should arrange for it to be # started by root at boot time. @@ -773,6 +1125,13 @@ ZCAT_COMMAND=/usr/bin/zcat # # but of course there may need to be other things in CFLAGS and EXTRALIBS_EXIM # as well. +# +# To use a name other than exim in the tcpwrappers config file, +# e.g. if you're running multiple daemons with different access lists, +# or multiple MTAs with the same access list, define +# TCP_WRAPPERS_DAEMON_NAME accordingly +# +# TCP_WRAPPERS_DAEMON_NAME="exim" #------------------------------------------------------------------------------ @@ -816,7 +1175,22 @@ SYSTEM_ALIASES_FILE=/etc/aliases # USE_READLINE=yes +# You may need to add -ldl to EXTRALIBS when you set USE_READLINE=yes. +# Note that this option adds to the size of the Exim binary, because the +# dynamic loading library is not otherwise included. +# If libreadline is not in the normal library paths, then because Exim is +# setuid you'll need to ensure that the correct directory is stamped into +# the binary so that dlopen will find it. +# Eg, on macOS/Darwin with a third-party install of libreadline, perhaps: + +# EXTRALIBS_EXIM+=-Wl,-rpath,/usr/local/opt/readline/lib + + +#------------------------------------------------------------------------------ +# Uncomment this setting to include IPv6 support. + +# HAVE_IPV6=yes ############################################################################### # THINGS YOU ALMOST NEVER NEED TO MENTION # @@ -839,8 +1213,10 @@ SYSTEM_ALIASES_FILE=/etc/aliases # CHOWN_COMMAND=/usr/bin/chown # CHGRP_COMMAND=/usr/bin/chgrp +# CHMOD_COMMAND=/usr/bin/chmod # MV_COMMAND=/bin/mv # RM_COMMAND=/bin/rm +# TOUCH_COMMAND=/usr/bin/touch # PERL_COMMAND=/usr/bin/perl @@ -860,9 +1236,11 @@ SYSTEM_ALIASES_FILE=/etc/aliases # files, and thus be influenced by the value of TMPDIR. For this reason, when # Exim starts, it checks the environment for TMPDIR, and if it finds it is set, # it replaces the value with what is defined here. Commenting this setting -# suppresses the check altogether. +# suppresses the check altogether. Older installations call this macro +# just TMPDIR, but this has side effects at build time. At runtime +# TMPDIR is checked as before. -TMPDIR="/tmp" +EXIM_TMPDIR="/tmp" #------------------------------------------------------------------------------ @@ -894,7 +1272,7 @@ TMPDIR="/tmp" # to handle the different cases. If CONFIGURE_FILE_USE_EUID is defined, then # Exim will first look for a configuration file whose name is that defined # by CONFIGURE_FILE, with the effective uid tacked on the end, separated by -# a period (for eximple, /usr/exim/configure.0). If this file does not exist, +# a period (for example, /usr/exim/configure.0). If this file does not exist, # then the bare configuration file name is tried. In the case when both # CONFIGURE_FILE_USE_EUID and CONFIGURE_FILE_USE_NODE are set, four files # are tried: .., ., ., and . @@ -1030,6 +1408,12 @@ TMPDIR="/tmp" # PERL_LIBS= +#------------------------------------------------------------------------------ +# If you wish to disable valgrind in the binary, define NVALGRIND=1. +# This should not be needed. + +# NVALGRIND=1 + #------------------------------------------------------------------------------ # Identifying the daemon: When an Exim daemon starts up, it writes its pid # (process id) to a file so that it can easily be identified. The path of the @@ -1070,4 +1454,49 @@ TMPDIR="/tmp" # SUPPORT_MOVE_FROZEN_MESSAGES=yes + +#------------------------------------------------------------------------------ +# Expanding match_* second parameters: BE CAREFUL IF ENABLING THIS! +# It has proven too easy in practice for administrators to configure security +# problems into their Exim install, by treating match_domain{}{} and friends +# as a form of string comparison, where the second string comes from untrusted +# data. Because these options take lists, which can include lookup;LOOKUPDATA +# style elements, a foe can then cause Exim to, eg, execute an arbitrary MySQL +# query, dropping tables. +# From Exim 4.77 onwards, the second parameter is not expanded; it can still +# be a list literal, or a macro, or a named list reference. There is also +# the new expansion condition "inlisti" which does expand the second parameter, +# but treats it as a list of strings; also, there's "eqi" which is probably +# what is normally wanted. +# +# If you really need to have the old behaviour, know what you are doing and +# will not complain if your system is compromised as a result of doing so, then +# uncomment this option to get the old behaviour back. + +# EXPAND_LISTMATCH_RHS=yes + +#------------------------------------------------------------------------------ +# Disabling the use of fsync(): DO NOT UNCOMMENT THE FOLLOWING LINE unless you +# really, really, really know what you are doing. And even then, think again. +# You should never uncomment this when compiling a binary for distribution. +# Use it only when compiling Exim for your own use. +# +# Uncommenting this line enables the use of a runtime option called +# disable_fsync, which can be used to stop Exim using fsync() to ensure that +# files are written to disc before proceeding. When this is disabled, crashes +# and hardware problems such as power outages can cause data to be lost. This +# feature should only be used in very exceptional circumstances. YOU HAVE BEEN +# WARNED. + +# ENABLE_DISABLE_FSYNC=yes + +#------------------------------------------------------------------------------ +# For development, add this to include code to time various stages and report. +# CFLAGS += -DMEASURE_TIMING + +# For a very slightly smaller build, for constrained systems, uncomment this. +# The feature involved is purely for debugging. + +# DISABLE_CLIENT_CMD_LOG=yes + # End of EDITME for Exim 4.