src/src/readconf.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2018 */
   6 /* Copyright (c) The Exim Maintainers 2020 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8
   9 /* Functions for reading the configuration file, and for displaying
  10 overall configuration values. Thanks to Brian Candler for the original
  11 implementation of the conditional .ifdef etc. */
  12
  13 #include "exim.h"
  14
  15 #ifdef MACRO_PREDEF
  16 # include "macro_predef.h"
  17 #endif
  18
  19 #define READCONF_DEBUG  if (FALSE)      /* Change to TRUE to enable */
  20
  21
  22 static uschar * syslog_facility_str;
  23 static void fn_smtp_receive_timeout(const uschar *, const uschar *, unsigned);
  24
  25 /*************************************************
  26 *           Main configuration options           *
  27 *************************************************/
  28
  29 /* The list of options that can be set in the main configuration file. This
  30 must be in alphabetic order because it is searched by binary chop. */
  31
  32 static optionlist optionlist_config[] = {
  33   { "*set_exim_group",          opt_bool|opt_hidden, {&exim_gid_set} },
  34   { "*set_exim_user",           opt_bool|opt_hidden, {&exim_uid_set} },
  35   { "*set_system_filter_group", opt_bool|opt_hidden, {&system_filter_gid_set} },
  36   { "*set_system_filter_user",  opt_bool|opt_hidden, {&system_filter_uid_set} },
  37   { "accept_8bitmime",          opt_bool,        {&accept_8bitmime} },
  38   { "acl_not_smtp",             opt_stringptr,   {&acl_not_smtp} },
  39 #ifdef WITH_CONTENT_SCAN
  40   { "acl_not_smtp_mime",        opt_stringptr,   {&acl_not_smtp_mime} },
  41 #endif
  42   { "acl_not_smtp_start",       opt_stringptr,   {&acl_not_smtp_start} },
  43   { "acl_smtp_auth",            opt_stringptr,   {&acl_smtp_auth} },
  44   { "acl_smtp_connect",         opt_stringptr,   {&acl_smtp_connect} },
  45   { "acl_smtp_data",            opt_stringptr,   {&acl_smtp_data} },
  46 #ifndef DISABLE_PRDR
  47   { "acl_smtp_data_prdr",       opt_stringptr,   {&acl_smtp_data_prdr} },
  48 #endif
  49 #ifndef DISABLE_DKIM
  50   { "acl_smtp_dkim",            opt_stringptr,   {&acl_smtp_dkim} },
  51 #endif
  52   { "acl_smtp_etrn",            opt_stringptr,   {&acl_smtp_etrn} },
  53   { "acl_smtp_expn",            opt_stringptr,   {&acl_smtp_expn} },
  54   { "acl_smtp_helo",            opt_stringptr,   {&acl_smtp_helo} },
  55   { "acl_smtp_mail",            opt_stringptr,   {&acl_smtp_mail} },
  56   { "acl_smtp_mailauth",        opt_stringptr,   {&acl_smtp_mailauth} },
  57 #ifdef WITH_CONTENT_SCAN
  58   { "acl_smtp_mime",            opt_stringptr,   {&acl_smtp_mime} },
  59 #endif
  60   { "acl_smtp_notquit",         opt_stringptr,   {&acl_smtp_notquit} },
  61   { "acl_smtp_predata",         opt_stringptr,   {&acl_smtp_predata} },
  62   { "acl_smtp_quit",            opt_stringptr,   {&acl_smtp_quit} },
  63   { "acl_smtp_rcpt",            opt_stringptr,   {&acl_smtp_rcpt} },
  64 #ifndef DISABLE_TLS
  65   { "acl_smtp_starttls",        opt_stringptr,   {&acl_smtp_starttls} },
  66 #endif
  67   { "acl_smtp_vrfy",            opt_stringptr,   {&acl_smtp_vrfy} },
  68   { "add_environment",          opt_stringptr,   {&add_environment} },
  69   { "admin_groups",             opt_gidlist,     {&admin_groups} },
  70   { "allow_domain_literals",    opt_bool,        {&allow_domain_literals} },
  71   { "allow_mx_to_ip",           opt_bool,        {&allow_mx_to_ip} },
  72   { "allow_utf8_domains",       opt_bool,        {&allow_utf8_domains} },
  73   { "auth_advertise_hosts",     opt_stringptr,   {&auth_advertise_hosts} },
  74   { "auto_thaw",                opt_time,        {&auto_thaw} },
  75 #ifdef WITH_CONTENT_SCAN
  76   { "av_scanner",               opt_stringptr,   {&av_scanner} },
  77 #endif
  78   { "bi_command",               opt_stringptr,   {&bi_command} },
  79 #ifdef EXPERIMENTAL_BRIGHTMAIL
  80   { "bmi_config_file",          opt_stringptr,   {&bmi_config_file} },
  81 #endif
  82   { "bounce_message_file",      opt_stringptr,   {&bounce_message_file} },
  83   { "bounce_message_text",      opt_stringptr,   {&bounce_message_text} },
  84   { "bounce_return_body",       opt_bool,        {&bounce_return_body} },
  85   { "bounce_return_linesize_limit", opt_mkint,   {&bounce_return_linesize_limit} },
  86   { "bounce_return_message",    opt_bool,        {&bounce_return_message} },
  87   { "bounce_return_size_limit", opt_mkint,       {&bounce_return_size_limit} },
  88   { "bounce_sender_authentication",opt_stringptr,{&bounce_sender_authentication} },
  89   { "callout_domain_negative_expire", opt_time,  {&callout_cache_domain_negative_expire} },
  90   { "callout_domain_positive_expire", opt_time,  {&callout_cache_domain_positive_expire} },
  91   { "callout_negative_expire",  opt_time,        {&callout_cache_negative_expire} },
  92   { "callout_positive_expire",  opt_time,        {&callout_cache_positive_expire} },
  93   { "callout_random_local_part",opt_stringptr,   {&callout_random_local_part} },
  94   { "check_log_inodes",         opt_int,         {&check_log_inodes} },
  95   { "check_log_space",          opt_Kint,        {&check_log_space} },
  96   { "check_rfc2047_length",     opt_bool,        {&check_rfc2047_length} },
  97   { "check_spool_inodes",       opt_int,         {&check_spool_inodes} },
  98   { "check_spool_space",        opt_Kint,        {&check_spool_space} },
  99   { "chunking_advertise_hosts", opt_stringptr,   {&chunking_advertise_hosts} },
 100   { "commandline_checks_require_admin", opt_bool,{&commandline_checks_require_admin} },
 101   { "daemon_smtp_port",         opt_stringptr|opt_hidden, {&daemon_smtp_port} },
 102   { "daemon_smtp_ports",        opt_stringptr,   {&daemon_smtp_port} },
 103   { "daemon_startup_retries",   opt_int,         {&daemon_startup_retries} },
 104   { "daemon_startup_sleep",     opt_time,        {&daemon_startup_sleep} },
 105 #ifdef EXPERIMENTAL_DCC
 106   { "dcc_direct_add_header",    opt_bool,        {&dcc_direct_add_header} },
 107   { "dccifd_address",           opt_stringptr,   {&dccifd_address} },
 108   { "dccifd_options",           opt_stringptr,   {&dccifd_options} },
 109 #endif
 110   { "debug_store",              opt_bool,        {&debug_store} },
 111   { "delay_warning",            opt_timelist,    {&delay_warning} },
 112   { "delay_warning_condition",  opt_stringptr,   {&delay_warning_condition} },
 113   { "deliver_drop_privilege",   opt_bool,        {&deliver_drop_privilege} },
 114   { "deliver_queue_load_max",   opt_fixed,       {&deliver_queue_load_max} },
 115   { "delivery_date_remove",     opt_bool,        {&delivery_date_remove} },
 116 #ifdef ENABLE_DISABLE_FSYNC
 117   { "disable_fsync",            opt_bool,        {&disable_fsync} },
 118 #endif
 119   { "disable_ipv6",             opt_bool,        {&disable_ipv6} },
 120 #ifndef DISABLE_DKIM
 121   { "dkim_verify_hashes",       opt_stringptr,   {&dkim_verify_hashes} },
 122   { "dkim_verify_keytypes",     opt_stringptr,   {&dkim_verify_keytypes} },
 123   { "dkim_verify_min_keysizes", opt_stringptr,   {&dkim_verify_min_keysizes} },
 124   { "dkim_verify_minimal",      opt_bool,        {&dkim_verify_minimal} },
 125   { "dkim_verify_signers",      opt_stringptr,   {&dkim_verify_signers} },
 126 #endif
 127 #ifdef SUPPORT_DMARC
 128   { "dmarc_forensic_sender",    opt_stringptr,   {&dmarc_forensic_sender} },
 129   { "dmarc_history_file",       opt_stringptr,   {&dmarc_history_file} },
 130   { "dmarc_tld_file",           opt_stringptr,   {&dmarc_tld_file} },
 131 #endif
 132   { "dns_again_means_nonexist", opt_stringptr,   {&dns_again_means_nonexist} },
 133   { "dns_check_names_pattern",  opt_stringptr,   {&check_dns_names_pattern} },
 134   { "dns_cname_loops",          opt_int,         {&dns_cname_loops} },
 135   { "dns_csa_search_limit",     opt_int,         {&dns_csa_search_limit} },
 136   { "dns_csa_use_reverse",      opt_bool,        {&dns_csa_use_reverse} },
 137   { "dns_dnssec_ok",            opt_int,         {&dns_dnssec_ok} },
 138   { "dns_ipv4_lookup",          opt_stringptr,   {&dns_ipv4_lookup} },
 139   { "dns_retrans",              opt_time,        {&dns_retrans} },
 140   { "dns_retry",                opt_int,         {&dns_retry} },
 141   { "dns_trust_aa",             opt_stringptr,   {&dns_trust_aa} },
 142   { "dns_use_edns0",            opt_int,         {&dns_use_edns0} },
 143  /* This option is now a no-op, retained for compatibility */
 144   { "drop_cr",                  opt_bool,        {&drop_cr} },
 145 /*********************************************************/
 146   { "dsn_advertise_hosts",      opt_stringptr,   {&dsn_advertise_hosts} },
 147   { "dsn_from",                 opt_stringptr,   {&dsn_from} },
 148   { "envelope_to_remove",       opt_bool,        {&envelope_to_remove} },
 149   { "errors_copy",              opt_stringptr,   {&errors_copy} },
 150   { "errors_reply_to",          opt_stringptr,   {&errors_reply_to} },
 151 #ifndef DISABLE_EVENT
 152   { "event_action",             opt_stringptr,   {&event_action} },
 153 #endif
 154   { "exim_group",               opt_gid,         {&exim_gid} },
 155   { "exim_path",                opt_stringptr,   {&exim_path} },
 156   { "exim_user",                opt_uid,         {&exim_uid} },
 157   { "exim_version",             opt_stringptr,   {&version_string} },
 158   { "extra_local_interfaces",   opt_stringptr,   {&extra_local_interfaces} },
 159   { "extract_addresses_remove_arguments", opt_bool, {&extract_addresses_remove_arguments} },
 160   { "finduser_retries",         opt_int,         {&finduser_retries} },
 161   { "freeze_tell",              opt_stringptr,   {&freeze_tell} },
 162   { "gecos_name",               opt_stringptr,   {&gecos_name} },
 163   { "gecos_pattern",            opt_stringptr,   {&gecos_pattern} },
 164 #ifndef DISABLE_TLS
 165   { "gnutls_allow_auto_pkcs11", opt_bool,        {&gnutls_allow_auto_pkcs11} },
 166   { "gnutls_compat_mode",       opt_bool,        {&gnutls_compat_mode} },
 167 #endif
 168   { "header_line_maxsize",      opt_int,         {&header_line_maxsize} },
 169   { "header_maxsize",           opt_int,         {&header_maxsize} },
 170   { "headers_charset",          opt_stringptr,   {&headers_charset} },
 171   { "helo_accept_junk_hosts",   opt_stringptr,   {&helo_accept_junk_hosts} },
 172   { "helo_allow_chars",         opt_stringptr,   {&helo_allow_chars} },
 173   { "helo_lookup_domains",      opt_stringptr,   {&helo_lookup_domains} },
 174   { "helo_try_verify_hosts",    opt_stringptr,   {&helo_try_verify_hosts} },
 175   { "helo_verify_hosts",        opt_stringptr,   {&helo_verify_hosts} },
 176   { "hold_domains",             opt_stringptr,   {&hold_domains} },
 177   { "host_lookup",              opt_stringptr,   {&host_lookup} },
 178   { "host_lookup_order",        opt_stringptr,   {&host_lookup_order} },
 179   { "host_reject_connection",   opt_stringptr,   {&host_reject_connection} },
 180   { "hosts_connection_nolog",   opt_stringptr,   {&hosts_connection_nolog} },
 181 #ifdef SUPPORT_PROXY
 182   { "hosts_proxy",              opt_stringptr,   {&hosts_proxy} },
 183 #endif
 184   { "hosts_treat_as_local",     opt_stringptr,   {&hosts_treat_as_local} },
 185 #ifdef LOOKUP_IBASE
 186   { "ibase_servers",            opt_stringptr,   {&ibase_servers} },
 187 #endif
 188   { "ignore_bounce_errors_after", opt_time,      {&ignore_bounce_errors_after} },
 189   { "ignore_fromline_hosts",    opt_stringptr,   {&ignore_fromline_hosts} },
 190   { "ignore_fromline_local",    opt_bool,        {&ignore_fromline_local} },
 191   { "keep_environment",         opt_stringptr,   {&keep_environment} },
 192   { "keep_malformed",           opt_time,        {&keep_malformed} },
 193 #ifdef LOOKUP_LDAP
 194   { "ldap_ca_cert_dir",         opt_stringptr,   {&eldap_ca_cert_dir} },
 195   { "ldap_ca_cert_file",        opt_stringptr,   {&eldap_ca_cert_file} },
 196   { "ldap_cert_file",           opt_stringptr,   {&eldap_cert_file} },
 197   { "ldap_cert_key",            opt_stringptr,   {&eldap_cert_key} },
 198   { "ldap_cipher_suite",        opt_stringptr,   {&eldap_cipher_suite} },
 199   { "ldap_default_servers",     opt_stringptr,   {&eldap_default_servers} },
 200   { "ldap_require_cert",        opt_stringptr,   {&eldap_require_cert} },
 201   { "ldap_start_tls",           opt_bool,        {&eldap_start_tls} },
 202   { "ldap_version",             opt_int,         {&eldap_version} },
 203 #endif
 204   { "local_from_check",         opt_bool,        {&local_from_check} },
 205   { "local_from_prefix",        opt_stringptr,   {&local_from_prefix} },
 206   { "local_from_suffix",        opt_stringptr,   {&local_from_suffix} },
 207   { "local_interfaces",         opt_stringptr,   {&local_interfaces} },
 208 #ifdef HAVE_LOCAL_SCAN
 209   { "local_scan_timeout",       opt_time,        {&local_scan_timeout} },
 210 #endif
 211   { "local_sender_retain",      opt_bool,        {&local_sender_retain} },
 212   { "localhost_number",         opt_stringptr,   {&host_number_string} },
 213   { "log_file_path",            opt_stringptr,   {&log_file_path} },
 214   { "log_selector",             opt_stringptr,   {&log_selector_string} },
 215   { "log_timezone",             opt_bool,        {&log_timezone} },
 216   { "lookup_open_max",          opt_int,         {&lookup_open_max} },
 217   { "max_username_length",      opt_int,         {&max_username_length} },
 218   { "message_body_newlines",    opt_bool,        {&message_body_newlines} },
 219   { "message_body_visible",     opt_mkint,       {&message_body_visible} },
 220   { "message_id_header_domain", opt_stringptr,   {&message_id_domain} },
 221   { "message_id_header_text",   opt_stringptr,   {&message_id_text} },
 222   { "message_logs",             opt_bool,        {&message_logs} },
 223   { "message_size_limit",       opt_stringptr,   {&message_size_limit} },
 224 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
 225   { "move_frozen_messages",     opt_bool,        {&move_frozen_messages} },
 226 #endif
 227   { "mua_wrapper",              opt_bool,        {&mua_wrapper} },
 228 #ifdef LOOKUP_MYSQL
 229   { "mysql_servers",            opt_stringptr,   {&mysql_servers} },
 230 #endif
 231   { "never_users",              opt_uidlist,     {&never_users} },
 232   { "notifier_socket",          opt_stringptr,   {&notifier_socket} },
 233 #ifndef DISABLE_TLS
 234   { "openssl_options",          opt_stringptr,   {&openssl_options} },
 235 #endif
 236 #ifdef LOOKUP_ORACLE
 237   { "oracle_servers",           opt_stringptr,   {&oracle_servers} },
 238 #endif
 239   { "percent_hack_domains",     opt_stringptr,   {&percent_hack_domains} },
 240 #ifdef EXIM_PERL
 241   { "perl_at_start",            opt_bool,        {&opt_perl_at_start} },
 242   { "perl_startup",             opt_stringptr,   {&opt_perl_startup} },
 243   { "perl_taintmode",           opt_bool,        {&opt_perl_taintmode} },
 244 #endif
 245 #ifdef LOOKUP_PGSQL
 246   { "pgsql_servers",            opt_stringptr,   {&pgsql_servers} },
 247 #endif
 248   { "pid_file_path",            opt_stringptr,   {&pid_file_path} },
 249   { "pipelining_advertise_hosts", opt_stringptr, {&pipelining_advertise_hosts} },
 250 #ifndef DISABLE_PIPE_CONNECT
 251   { "pipelining_connect_advertise_hosts", opt_stringptr,
 252                                                  {&pipe_connect_advertise_hosts} },
 253 #endif
 254 #ifndef DISABLE_PRDR
 255   { "prdr_enable",              opt_bool,        {&prdr_enable} },
 256 #endif
 257   { "preserve_message_logs",    opt_bool,        {&preserve_message_logs} },
 258   { "primary_hostname",         opt_stringptr,   {&primary_hostname} },
 259   { "print_topbitchars",        opt_bool,        {&print_topbitchars} },
 260   { "process_log_path",         opt_stringptr,   {&process_log_path} },
 261   { "prod_requires_admin",      opt_bool,        {&prod_requires_admin} },
 262   { "qualify_domain",           opt_stringptr,   {&qualify_domain_sender} },
 263   { "qualify_recipient",        opt_stringptr,   {&qualify_domain_recipient} },
 264   { "queue_domains",            opt_stringptr,   {&queue_domains} },
 265 #ifndef DISABLE_QUEUE_RAMP
 266   { "queue_fast_ramp",          opt_bool,        {&queue_fast_ramp} },
 267 #endif
 268   { "queue_list_requires_admin",opt_bool,        {&queue_list_requires_admin} },
 269   { "queue_only",               opt_bool,        {&queue_only} },
 270   { "queue_only_file",          opt_stringptr,   {&queue_only_file} },
 271   { "queue_only_load",          opt_fixed,       {&queue_only_load} },
 272   { "queue_only_load_latch",    opt_bool,        {&queue_only_load_latch} },
 273   { "queue_only_override",      opt_bool,        {&queue_only_override} },
 274   { "queue_run_in_order",       opt_bool,        {&queue_run_in_order} },
 275   { "queue_run_max",            opt_stringptr,   {&queue_run_max} },
 276   { "queue_smtp_domains",       opt_stringptr,   {&queue_smtp_domains} },
 277   { "receive_timeout",          opt_time,        {&receive_timeout} },
 278   { "received_header_text",     opt_stringptr,   {&received_header_text} },
 279   { "received_headers_max",     opt_int,         {&received_headers_max} },
 280   { "recipient_unqualified_hosts", opt_stringptr, {&recipient_unqualified_hosts} },
 281   { "recipients_max",           opt_int,         {&recipients_max} },
 282   { "recipients_max_reject",    opt_bool,        {&recipients_max_reject} },
 283 #ifdef LOOKUP_REDIS
 284   { "redis_servers",            opt_stringptr,   {&redis_servers} },
 285 #endif
 286   { "remote_max_parallel",      opt_int,         {&remote_max_parallel} },
 287   { "remote_sort_domains",      opt_stringptr,   {&remote_sort_domains} },
 288   { "retry_data_expire",        opt_time,        {&retry_data_expire} },
 289   { "retry_interval_max",       opt_time,        {&retry_interval_max} },
 290   { "return_path_remove",       opt_bool,        {&return_path_remove} },
 291   { "return_size_limit",        opt_mkint|opt_hidden, {&bounce_return_size_limit} },
 292   { "rfc1413_hosts",            opt_stringptr,   {&rfc1413_hosts} },
 293   { "rfc1413_query_timeout",    opt_time,        {&rfc1413_query_timeout} },
 294   { "sender_unqualified_hosts", opt_stringptr,   {&sender_unqualified_hosts} },
 295   { "slow_lookup_log",          opt_int,         {&slow_lookup_log} },
 296   { "smtp_accept_keepalive",    opt_bool,        {&smtp_accept_keepalive} },
 297   { "smtp_accept_max",          opt_int,         {&smtp_accept_max} },
 298   { "smtp_accept_max_nonmail",  opt_int,         {&smtp_accept_max_nonmail} },
 299   { "smtp_accept_max_nonmail_hosts", opt_stringptr, {&smtp_accept_max_nonmail_hosts} },
 300   { "smtp_accept_max_per_connection", opt_int,   {&smtp_accept_max_per_connection} },
 301   { "smtp_accept_max_per_host", opt_stringptr,   {&smtp_accept_max_per_host} },
 302   { "smtp_accept_queue",        opt_int,         {&smtp_accept_queue} },
 303   { "smtp_accept_queue_per_connection", opt_int, {&smtp_accept_queue_per_connection} },
 304   { "smtp_accept_reserve",      opt_int,         {&smtp_accept_reserve} },
 305   { "smtp_active_hostname",     opt_stringptr,   {&raw_active_hostname} },
 306   { "smtp_banner",              opt_stringptr,   {&smtp_banner} },
 307   { "smtp_check_spool_space",   opt_bool,        {&smtp_check_spool_space} },
 308   { "smtp_connect_backlog",     opt_int,         {&smtp_connect_backlog} },
 309   { "smtp_enforce_sync",        opt_bool,        {&smtp_enforce_sync} },
 310   { "smtp_etrn_command",        opt_stringptr,   {&smtp_etrn_command} },
 311   { "smtp_etrn_serialize",      opt_bool,        {&smtp_etrn_serialize} },
 312   { "smtp_load_reserve",        opt_fixed,       {&smtp_load_reserve} },
 313   { "smtp_max_synprot_errors",  opt_int,         {&smtp_max_synprot_errors} },
 314   { "smtp_max_unknown_commands",opt_int,         {&smtp_max_unknown_commands} },
 315   { "smtp_ratelimit_hosts",     opt_stringptr,   {&smtp_ratelimit_hosts} },
 316   { "smtp_ratelimit_mail",      opt_stringptr,   {&smtp_ratelimit_mail} },
 317   { "smtp_ratelimit_rcpt",      opt_stringptr,   {&smtp_ratelimit_rcpt} },
 318   { "smtp_receive_timeout",     opt_func,        {.fn = &fn_smtp_receive_timeout} },
 319   { "smtp_reserve_hosts",       opt_stringptr,   {&smtp_reserve_hosts} },
 320   { "smtp_return_error_details",opt_bool,        {&smtp_return_error_details} },
 321 #ifdef SUPPORT_I18N
 322   { "smtputf8_advertise_hosts", opt_stringptr,   {&smtputf8_advertise_hosts} },
 323 #endif
 324 #ifdef WITH_CONTENT_SCAN
 325   { "spamd_address",            opt_stringptr,   {&spamd_address} },
 326 #endif
 327 #ifdef SUPPORT_SPF
 328   { "spf_guess",                opt_stringptr,   {&spf_guess} },
 329 #endif
 330   { "split_spool_directory",    opt_bool,        {&split_spool_directory} },
 331   { "spool_directory",          opt_stringptr,   {&spool_directory} },
 332   { "spool_wireformat",         opt_bool,        {&spool_wireformat} },
 333 #ifdef LOOKUP_SQLITE
 334   { "sqlite_dbfile",            opt_stringptr,   {&sqlite_dbfile} },
 335   { "sqlite_lock_timeout",      opt_int,         {&sqlite_lock_timeout} },
 336 #endif
 337 #ifdef EXPERIMENTAL_SRS_ALT
 338   { "srs_config",               opt_stringptr,   {&srs_config} },
 339   { "srs_hashlength",           opt_int,         {&srs_hashlength} },
 340   { "srs_hashmin",              opt_int,         {&srs_hashmin} },
 341   { "srs_maxage",               opt_int,         {&srs_maxage} },
 342   { "srs_secrets",              opt_stringptr,   {&srs_secrets} },
 343   { "srs_usehash",              opt_bool,        {&srs_usehash} },
 344   { "srs_usetimestamp",         opt_bool,        {&srs_usetimestamp} },
 345 #endif
 346   { "strict_acl_vars",          opt_bool,        {&strict_acl_vars} },
 347   { "strip_excess_angle_brackets", opt_bool,     {&strip_excess_angle_brackets} },
 348   { "strip_trailing_dot",       opt_bool,        {&strip_trailing_dot} },
 349   { "syslog_duplication",       opt_bool,        {&syslog_duplication} },
 350   { "syslog_facility",          opt_stringptr,   {&syslog_facility_str} },
 351   { "syslog_pid",               opt_bool,        {&syslog_pid} },
 352   { "syslog_processname",       opt_stringptr,   {&syslog_processname} },
 353   { "syslog_timestamp",         opt_bool,        {&syslog_timestamp} },
 354   { "system_filter",            opt_stringptr,   {&system_filter} },
 355   { "system_filter_directory_transport", opt_stringptr,{&system_filter_directory_transport} },
 356   { "system_filter_file_transport",opt_stringptr,{&system_filter_file_transport} },
 357   { "system_filter_group",      opt_gid,         {&system_filter_gid} },
 358   { "system_filter_pipe_transport",opt_stringptr,{&system_filter_pipe_transport} },
 359   { "system_filter_reply_transport",opt_stringptr,{&system_filter_reply_transport} },
 360   { "system_filter_user",       opt_uid,         {&system_filter_uid} },
 361   { "tcp_nodelay",              opt_bool,        {&tcp_nodelay} },
 362 #ifdef USE_TCP_WRAPPERS
 363   { "tcp_wrappers_daemon_name", opt_stringptr,   {&tcp_wrappers_daemon_name} },
 364 #endif
 365   { "timeout_frozen_after",     opt_time,        {&timeout_frozen_after} },
 366   { "timezone",                 opt_stringptr,   {&timezone_string} },
 367   { "tls_advertise_hosts",      opt_stringptr,   {&tls_advertise_hosts} },
 368 #ifndef DISABLE_TLS
 369   { "tls_certificate",          opt_stringptr,   {&tls_certificate} },
 370   { "tls_crl",                  opt_stringptr,   {&tls_crl} },
 371   { "tls_dh_max_bits",          opt_int,         {&tls_dh_max_bits} },
 372   { "tls_dhparam",              opt_stringptr,   {&tls_dhparam} },
 373   { "tls_eccurve",              opt_stringptr,   {&tls_eccurve} },
 374 # ifndef DISABLE_OCSP
 375   { "tls_ocsp_file",            opt_stringptr,   {&tls_ocsp_file} },
 376 # endif
 377   { "tls_on_connect_ports",     opt_stringptr,   {&tls_in.on_connect_ports} },
 378   { "tls_privatekey",           opt_stringptr,   {&tls_privatekey} },
 379   { "tls_remember_esmtp",       opt_bool,        {&tls_remember_esmtp} },
 380   { "tls_require_ciphers",      opt_stringptr,   {&tls_require_ciphers} },
 381 # ifdef EXPERIMENTAL_TLS_RESUME
 382   { "tls_resumption_hosts",     opt_stringptr,   {&tls_resumption_hosts} },
 383 # endif
 384   { "tls_try_verify_hosts",     opt_stringptr,   {&tls_try_verify_hosts} },
 385   { "tls_verify_certificates",  opt_stringptr,   {&tls_verify_certificates} },
 386   { "tls_verify_hosts",         opt_stringptr,   {&tls_verify_hosts} },
 387 #endif
 388   { "trusted_groups",           opt_gidlist,     {&trusted_groups} },
 389   { "trusted_users",            opt_uidlist,     {&trusted_users} },
 390   { "unknown_login",            opt_stringptr,   {&unknown_login} },
 391   { "unknown_username",         opt_stringptr,   {&unknown_username} },
 392   { "untrusted_set_sender",     opt_stringptr,   {&untrusted_set_sender} },
 393   { "uucp_from_pattern",        opt_stringptr,   {&uucp_from_pattern} },
 394   { "uucp_from_sender",         opt_stringptr,   {&uucp_from_sender} },
 395   { "warn_message_file",        opt_stringptr,   {&warn_message_file} },
 396   { "write_rejectlog",          opt_bool,        {&write_rejectlog} }
 397 };
 398
 399 #ifndef MACRO_PREDEF
 400 static int optionlist_config_size = nelem(optionlist_config);
 401 #endif
 402
 403
 404 #ifdef MACRO_PREDEF
 405
 406 static void
 407 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
 408
 409 void
 410 options_main(void)
 411 {
 412 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
 413 }
 414
 415 void
 416 options_auths(void)
 417 {
 418 uschar buf[64];
 419
 420 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
 421
 422 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
 423   {
 424   spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
 425   builtin_macro_create(buf);
 426   options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
 427
 428   if (ai->macros_create) (ai->macros_create)();
 429   }
 430 }
 431
 432 void
 433 options_logging(void)
 434 {
 435 uschar buf[64];
 436
 437 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
 438   {
 439   spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
 440   builtin_macro_create(buf);
 441   }
 442 }
 443
 444
 445 #else   /*!MACRO_PREDEF*/
 446
 447 extern char **environ;
 448
 449 static void save_config_line(const uschar* line);
 450 static void save_config_position(const uschar *file, int line);
 451 static void print_config(BOOL admin, BOOL terse);
 452
 453
 454 #define CSTATE_STACK_SIZE 10
 455
 456 const uschar *config_directory = NULL;
 457
 458
 459 /* Structure for chain (stack) of .included files */
 460
 461 typedef struct config_file_item {
 462   struct config_file_item *next;
 463   const uschar *filename;
 464   const uschar *directory;
 465   FILE *file;
 466   int lineno;
 467 } config_file_item;
 468
 469 /* Structure for chain of configuration lines (-bP config) */
 470
 471 typedef struct config_line_item {
 472   struct config_line_item *next;
 473   uschar *line;
 474 } config_line_item;
 475
 476 static config_line_item* config_lines;
 477
 478 /* Structure of table of conditional words and their state transitions */
 479
 480 typedef struct cond_item {
 481   uschar *name;
 482   int    namelen;
 483   int    action1;
 484   int    action2;
 485   int    pushpop;
 486 } cond_item;
 487
 488 /* Structure of table of syslog facility names and values */
 489
 490 typedef struct syslog_fac_item {
 491   uschar *name;
 492   int    value;
 493 } syslog_fac_item;
 494
 495 /* constants */
 496 static const uschar * const hidden = US"<value not displayable>";
 497
 498 /* Static variables */
 499
 500 static config_file_item *config_file_stack = NULL;  /* For includes */
 501
 502 static uschar *syslog_facility_str  = NULL;
 503 static uschar next_section[24];
 504 static uschar time_buffer[24];
 505
 506 /* State variables for conditional loading (.ifdef / .else / .endif) */
 507
 508 static int cstate = 0;
 509 static int cstate_stack_ptr = -1;
 510 static int cstate_stack[CSTATE_STACK_SIZE];
 511
 512 /* Table of state transitions for handling conditional inclusions. There are
 513 four possible state transitions:
 514
 515   .ifdef true
 516   .ifdef false
 517   .elifdef true  (or .else)
 518   .elifdef false
 519
 520 .endif just causes the previous cstate to be popped off the stack */
 521
 522 static int next_cstate[3][4] =
 523   {
 524   /* State 0: reading from file, or reading until next .else or .endif */
 525   { 0, 1, 2, 2 },
 526   /* State 1: condition failed, skipping until next .else or .endif */
 527   { 2, 2, 0, 1 },
 528   /* State 2: skipping until .endif */
 529   { 2, 2, 2, 2 },
 530   };
 531
 532 /* Table of conditionals and the states to set. For each name, there are four
 533 values: the length of the name (to save computing it each time), the state to
 534 set if a macro was found in the line, the state to set if a macro was not found
 535 in the line, and a stack manipulation setting which is:
 536
 537   -1   pull state value off the stack
 538    0   don't alter the stack
 539   +1   push value onto stack, before setting new state
 540 */
 541
 542 static cond_item cond_list[] = {
 543   { US"ifdef",    5, 0, 1,  1 },
 544   { US"ifndef",   6, 1, 0,  1 },
 545   { US"elifdef",  7, 2, 3,  0 },
 546   { US"elifndef", 8, 3, 2,  0 },
 547   { US"else",     4, 2, 2,  0 },
 548   { US"endif",    5, 0, 0, -1 }
 549 };
 550
 551 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
 552
 553 /* Table of syslog facility names and their values */
 554
 555 static syslog_fac_item syslog_list[] = {
 556   { US"mail",   LOG_MAIL },
 557   { US"user",   LOG_USER },
 558   { US"news",   LOG_NEWS },
 559   { US"uucp",   LOG_UUCP },
 560   { US"local0", LOG_LOCAL0 },
 561   { US"local1", LOG_LOCAL1 },
 562   { US"local2", LOG_LOCAL2 },
 563   { US"local3", LOG_LOCAL3 },
 564   { US"local4", LOG_LOCAL4 },
 565   { US"local5", LOG_LOCAL5 },
 566   { US"local6", LOG_LOCAL6 },
 567   { US"local7", LOG_LOCAL7 },
 568   { US"daemon", LOG_DAEMON }
 569 };
 570
 571 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
 572
 573
 574 #define opt_fn_print            BIT(0)
 575 #define opt_fn_print_label      BIT(1)
 576
 577
 578 /*************************************************
 579 *         Find the name of an option             *
 580 *************************************************/
 581
 582 /* This function is to aid debugging. Various functions take arguments that are
 583 pointer variables in the options table or in option tables for various drivers.
 584 For debugging output, it is useful to be able to find the name of the option
 585 which is currently being processed. This function finds it, if it exists, by
 586 searching the table(s).
 587
 588 Arguments:   a value that is presumed to be in the table above
 589 Returns:     the option name, or an empty string
 590 */
 591
 592 uschar *
 593 readconf_find_option(void *p)
 594 {
 595 for (int i = 0; i < nelem(optionlist_config); i++)
 596   if (p == optionlist_config[i].v.value) return US optionlist_config[i].name;
 597
 598 for (router_instance * r = routers; r; r = r->next)
 599   {
 600   router_info *ri = r->info;
 601   for (int i = 0; i < *ri->options_count; i++)
 602     {
 603     if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
 604     if (p == CS (r->options_block) + ri->options[i].v.offset)
 605       return US ri->options[i].name;
 606     }
 607   }
 608
 609 for (transport_instance * t = transports; t; t = t->next)
 610   {
 611   transport_info *ti = t->info;
 612   for (int i = 0; i < *ti->options_count; i++)
 613     {
 614     optionlist * op = &ti->options[i];
 615     if ((op->type & opt_mask) != opt_stringptr) continue;
 616     if (p == (  op->type & opt_public
 617              ? CS t
 618              : CS t->options_block
 619              )
 620              + op->v.offset)
 621         return US op->name;
 622     }
 623   }
 624
 625 return US"";
 626 }
 627
 628
 629
 630
 631 /*************************************************
 632 *       Deal with an assignment to a macro       *
 633 *************************************************/
 634
 635 /* We have a new definition; append to the list.
 636
 637 Args:
 638  name   Name of the macro; will be copied
 639  val    Expansion result for the macro; will be copied
 640 */
 641
 642 macro_item *
 643 macro_create(const uschar * name, const uschar * val, BOOL command_line)
 644 {
 645 macro_item * m = store_get(sizeof(macro_item), FALSE);
 646
 647 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
 648 m->next = NULL;
 649 m->command_line = command_line;
 650 m->namelen = Ustrlen(name);
 651 m->replen = Ustrlen(val);
 652 m->name = string_copy(name);
 653 m->replacement = string_copy(val);
 654 if (mlast)
 655   mlast->next = m;
 656 else
 657   macros = m;
 658 mlast = m;
 659 if (!macros_user)
 660   macros_user = m;
 661 return m;
 662 }
 663
 664
 665 /* This function is called when a line that starts with an upper case letter is
 666 encountered. The argument "line" should contain a complete logical line, and
 667 start with the first letter of the macro name. The macro name and the
 668 replacement text are extracted and stored. Redefinition of existing,
 669 non-command line, macros is permitted using '==' instead of '='.
 670
 671 Arguments:
 672   s            points to the start of the logical line
 673
 674 Returns:       FALSE iff fatal error
 675 */
 676
 677 BOOL
 678 macro_read_assignment(uschar *s)
 679 {
 680 uschar name[64];
 681 int namelen = 0;
 682 BOOL redef = FALSE;
 683 macro_item *m;
 684
 685 while (isalnum(*s) || *s == '_')
 686   {
 687   if (namelen >= sizeof(name) - 1)
 688     {
 689     log_write(0, LOG_PANIC|LOG_CONFIG_IN,
 690       "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
 691     return FALSE;
 692     }
 693   name[namelen++] = *s++;
 694   }
 695 name[namelen] = 0;
 696
 697 Uskip_whitespace(&s);
 698 if (*s++ != '=')
 699   {
 700   log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
 701   return FALSE;
 702   }
 703
 704 if (*s == '=')
 705   {
 706   redef = TRUE;
 707   s++;
 708   }
 709 Uskip_whitespace(&s);
 710
 711 /* If an existing macro of the same name was defined on the command line, we
 712 just skip this definition. It's an error to attempt to redefine a macro without
 713 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
 714 It is also an error to define a macro whose name begins with the name of a
 715 previously defined macro.  This is the requirement that make using a tree
 716 for macros hard; we must check all macros for the substring.  Perhaps a
 717 sorted list, and a bsearch, would work?
 718 Note: it is documented that the other way round works. */
 719
 720 for (m = macros; m; m = m->next)
 721   {
 722   if (Ustrcmp(m->name, name) == 0)
 723     {
 724     if (!m->command_line && !redef)
 725       {
 726       log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
 727        "defined (use \"==\" if you want to redefine it)", name);
 728       return FALSE;
 729       }
 730     break;
 731     }
 732
 733   if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
 734     {
 735     log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
 736       "a macro because previously defined macro \"%s\" is a substring",
 737       name, m->name);
 738     return FALSE;
 739     }
 740
 741   /* We cannot have this test, because it is documented that a substring
 742   macro is permitted (there is even an example).
 743   *
 744   * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
 745   *   log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
 746   *     "a macro because it is a substring of previously defined macro \"%s\"",
 747   *     name, m->name);
 748   */
 749   }
 750
 751 /* Check for an overriding command-line definition. */
 752
 753 if (m && m->command_line) return TRUE;
 754
 755 /* Redefinition must refer to an existing macro. */
 756
 757 if (redef)
 758   if (m)
 759     {
 760     m->replen = Ustrlen(s);
 761     m->replacement = string_copy(s);
 762     }
 763   else
 764     {
 765     log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
 766       "\"%s\"", name);
 767     return FALSE;
 768     }
 769
 770 /* We have a new definition. */
 771 else
 772   (void) macro_create(name, s, FALSE);
 773 return TRUE;
 774 }
 775
 776
 777
 778
 779
 780 /* Process line for macros. The line is in big_buffer starting at offset len.
 781 Expand big_buffer if needed.  Handle definitions of new macros, and
 782 macro expansions, rewriting the line in the buffer.
 783
 784 Arguments:
 785  len            Offset in buffer of start of line
 786  newlen         Pointer to offset of end of line, updated on return
 787  macro_found    Pointer to return that a macro was expanded
 788
 789 Return: pointer to first nonblank char in line
 790 */
 791
 792 uschar *
 793 macros_expand(int len, int * newlen, BOOL * macro_found)
 794 {
 795 uschar * ss = big_buffer + len;
 796 uschar * s;
 797
 798 /* Find the true start of the physical line - leading spaces are always
 799 ignored. */
 800
 801 Uskip_whitespace(&ss);
 802
 803 /* Process the physical line for macros. If this is the start of the logical
 804 line, skip over initial text at the start of the line if it starts with an
 805 upper case character followed by a sequence of name characters and an equals
 806 sign, because that is the definition of a new macro, and we don't do
 807 replacement therein. */
 808
 809 s = ss;
 810 if (len == 0 && isupper(*s))
 811   {
 812   while (isalnum(*s) || *s == '_') s++;
 813   if (Uskip_whitespace(&s) != '=') s = ss;          /* Not a macro definition */
 814   }
 815
 816 /* Skip leading chars which cannot start a macro name, to avoid multiple
 817 pointless rescans in Ustrstr calls. */
 818
 819 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
 820
 821 /* For each defined macro, scan the line (from after XXX= if present),
 822 replacing all occurrences of the macro. */
 823
 824 *macro_found = FALSE;
 825 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
 826   {
 827   uschar * p, *pp;
 828   uschar * t;
 829
 830   while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
 831   if (!*s) break;
 832
 833   t = s;
 834   while ((p = Ustrstr(t, m->name)) != NULL)
 835     {
 836     int moveby;
 837
 838     READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
 839       m->name, (int) Ustrlen(ss)-1, ss);
 840     /* Expand the buffer if necessary */
 841
 842     while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
 843       {
 844       int newsize = big_buffer_size + BIG_BUFFER_SIZE;
 845       uschar *newbuffer = store_malloc(newsize);
 846       memcpy(newbuffer, big_buffer, *newlen + 1);
 847       p = newbuffer  + (p - big_buffer);
 848       s = newbuffer  + (s - big_buffer);
 849       ss = newbuffer + (ss - big_buffer);
 850       t = newbuffer  + (t - big_buffer);
 851       big_buffer_size = newsize;
 852       store_free(big_buffer);
 853       big_buffer = newbuffer;
 854       }
 855
 856     /* Shuffle the remaining characters up or down in the buffer before
 857     copying in the replacement text. Don't rescan the replacement for this
 858     same macro. */
 859
 860     pp = p + m->namelen;
 861     if ((moveby = m->replen - m->namelen) != 0)
 862       {
 863       memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
 864       *newlen += moveby;
 865       }
 866     Ustrncpy(p, m->replacement, m->replen);
 867     t = p + m->replen;
 868     while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
 869     *macro_found = TRUE;
 870     }
 871   }
 872
 873 /* An empty macro replacement at the start of a line could mean that ss no
 874 longer points to the first non-blank character. */
 875
 876 Uskip_whitespace(&ss);
 877 return ss;
 878 }
 879
 880 /*************************************************
 881 *            Read configuration line             *
 882 *************************************************/
 883
 884 /* A logical line of text is read from the configuration file into the big
 885 buffer, taking account of macros, .includes, and continuations. The size of
 886 big_buffer is increased if necessary. The count of configuration lines is
 887 maintained. Physical input lines starting with # (ignoring leading white space,
 888 and after macro replacement) and empty logical lines are always ignored.
 889 Leading and trailing spaces are removed.
 890
 891 If we hit a line of the form "begin xxxx", the xxxx is placed in the
 892 next_section vector, and the function returns NULL, indicating the end of a
 893 configuration section. On end-of-file, NULL is returned with next_section
 894 empty.
 895
 896 Arguments:      none
 897
 898 Returns:        a pointer to the first non-blank in the line,
 899                 or NULL if eof or end of section is reached
 900 */
 901
 902 static uschar *
 903 get_config_line(void)
 904 {
 905 int startoffset = 0;         /* To first non-blank char in logical line */
 906 int len = 0;                 /* Of logical line so far */
 907 int newlen;
 908 uschar *s, *ss;
 909 BOOL macro_found;
 910
 911 /* Loop for handling continuation lines, skipping comments, and dealing with
 912 .include files. */
 913
 914 for (;;)
 915   {
 916   if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
 917     {
 918     if (config_file_stack != NULL)    /* EOF inside .include */
 919       {
 920       (void)fclose(config_file);
 921       config_file = config_file_stack->file;
 922       config_filename = config_file_stack->filename;
 923       config_directory = config_file_stack->directory;
 924       config_lineno = config_file_stack->lineno;
 925       config_file_stack = config_file_stack->next;
 926       if (config_lines)
 927         save_config_position(config_filename, config_lineno);
 928       continue;
 929       }
 930
 931     /* EOF at top level */
 932
 933     if (cstate_stack_ptr >= 0)
 934       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
 935         "Unexpected end of configuration file: .endif missing");
 936
 937     if (len != 0) break;        /* EOF after continuation */
 938     next_section[0] = 0;        /* EOF at start of logical line */
 939     return NULL;
 940     }
 941
 942   config_lineno++;
 943   newlen = len + Ustrlen(big_buffer + len);
 944
 945   if (config_lines && config_lineno == 1)
 946     save_config_position(config_filename, config_lineno);
 947
 948   /* Handle pathologically long physical lines - yes, it did happen - by
 949   extending big_buffer at this point. The code also copes with very long
 950   logical lines. */
 951
 952   while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
 953     {
 954     uschar *newbuffer;
 955     big_buffer_size += BIG_BUFFER_SIZE;
 956     newbuffer = store_malloc(big_buffer_size);
 957
 958     /* This use of strcpy is OK because we know that the string in the old
 959     buffer is shorter than the new buffer. */
 960
 961     Ustrcpy(newbuffer, big_buffer);
 962     store_free(big_buffer);
 963     big_buffer = newbuffer;
 964     if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
 965       break;
 966     newlen += Ustrlen(big_buffer + newlen);
 967     }
 968
 969   ss = macros_expand(len, &newlen, &macro_found);
 970
 971   /* Check for comment lines - these are physical lines. */
 972
 973   if (*ss == '#') continue;
 974
 975   /* Handle conditionals, which are also applied to physical lines. Conditions
 976   are of the form ".ifdef ANYTEXT" and are treated as true if any macro
 977   expansion occurred on the rest of the line. A preliminary test for the leading
 978   '.' saves effort on most lines. */
 979
 980   if (*ss == '.')
 981     {
 982     int i;
 983
 984     /* Search the list of conditional directives */
 985
 986     for (i = 0; i < cond_list_size; i++)
 987       {
 988       int n;
 989       cond_item *c = cond_list+i;
 990       if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
 991
 992       /* The following character must be white space or end of string */
 993
 994       n = ss[1 + c->namelen];
 995       if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
 996
 997       /* .ifdef and .ifndef push the current state onto the stack, then set
 998       a new one from the table. Stack overflow is an error */
 999
1000       if (c->pushpop > 0)
1001         {
1002         if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1003           log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1004             ".%s nested too deeply", c->name);
1005         cstate_stack[++cstate_stack_ptr] = cstate;
1006         cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1007         }
1008
1009       /* For any of the others, stack underflow is an error. The next state
1010       comes either from the stack (.endif) or from the table. */
1011
1012       else
1013         {
1014         if (cstate_stack_ptr < 0)
1015           log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1016             ".%s without matching .ifdef", c->name);
1017         cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1018           next_cstate[cstate][macro_found? c->action1 : c->action2];
1019         }
1020
1021       /* Having dealt with a directive, break the loop */
1022
1023       break;
1024       }
1025
1026     /* If we have handled a conditional directive, continue with the next
1027     physical line. Otherwise, fall through. */
1028
1029     if (i < cond_list_size) continue;
1030     }
1031
1032   /* If the conditional state is not 0 (actively using these lines), ignore
1033   this input line. */
1034
1035   if (cstate != 0) continue;  /* Conditional skip */
1036
1037   /* Handle .include lines - these are also physical lines. */
1038
1039   if (Ustrncmp(ss, ".include", 8) == 0 &&
1040        (isspace(ss[8]) ||
1041          (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1042     {
1043     uschar *t;
1044     int include_if_exists = isspace(ss[8])? 0 : 10;
1045     config_file_item *save;
1046     struct stat statbuf;
1047
1048     ss += 9 + include_if_exists;
1049     Uskip_whitespace(&ss);
1050     t = ss + Ustrlen(ss);
1051     while (t > ss && isspace(t[-1])) t--;
1052     if (*ss == '\"' && t[-1] == '\"')
1053       {
1054       ss++;
1055       t--;
1056       }
1057     *t = 0;
1058
1059     /* We allow relative file names. For security reasons currently
1060     relative names not allowed with .include_if_exists. For .include_if_exists
1061     we need to check the permissions/ownership of the containing folder */
1062     if (*ss != '/')
1063       if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1064           "absolute path \"%s\"", ss);
1065       else
1066         {
1067         gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1068         ss = string_from_gstring(g);
1069         }
1070
1071     if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1072
1073     if (config_lines)
1074       save_config_position(config_filename, config_lineno);
1075     save = store_get(sizeof(config_file_item), FALSE);
1076     save->next = config_file_stack;
1077     config_file_stack = save;
1078     save->file = config_file;
1079     save->filename = config_filename;
1080     save->directory = config_directory;
1081     save->lineno = config_lineno;
1082
1083     if (!(config_file = Ufopen(ss, "rb")))
1084       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1085         "configuration file %s", ss);
1086
1087     config_filename = string_copy(ss);
1088     config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1089     config_lineno = 0;
1090     continue;
1091     }
1092
1093   /* If this is the start of the logical line, remember where the non-blank
1094   data starts. Otherwise shuffle down continuation lines to remove leading
1095   white space. */
1096
1097   if (len == 0)
1098     startoffset = ss - big_buffer;
1099   else
1100     {
1101     s = big_buffer + len;
1102     if (ss > s)
1103       {
1104       memmove(s, ss, (newlen - len) -  (ss - s) + 1);
1105       newlen -= ss - s;
1106       }
1107     }
1108
1109   /* Accept the new addition to the line. Remove trailing white space. */
1110
1111   len = newlen;
1112   while (len > 0 && isspace(big_buffer[len-1])) len--;
1113   big_buffer[len] = 0;
1114
1115   /* We are done if the line does not end in backslash and contains some data.
1116   Empty logical lines are ignored. For continuations, remove the backslash and
1117   go round the loop to read the continuation line. */
1118
1119   if (len > 0)
1120     {
1121     if (big_buffer[len-1] != '\\') break;   /* End of logical line */
1122     big_buffer[--len] = 0;                  /* Remove backslash */
1123     }
1124   }     /* Loop for reading multiple physical lines */
1125
1126 /* We now have a logical line. Test for the end of a configuration section (or,
1127 more accurately, for the start of the next section). Place the name of the next
1128 section in next_section, and return NULL. If the name given is longer than
1129 next_section, truncate it. It will be unrecognized later, because all the known
1130 section names do fit. Leave space for pluralizing. */
1131
1132 s = big_buffer + startoffset;            /* First non-space character */
1133
1134 if (config_lines)
1135   save_config_line(s);
1136
1137 if (strncmpic(s, US"begin ", 6) == 0)
1138   {
1139   s += 6;
1140   Uskip_whitespace(&s);
1141   if (big_buffer + len - s > sizeof(next_section) - 2)
1142     s[sizeof(next_section) - 2] = 0;
1143   Ustrcpy(next_section, s);
1144   return NULL;
1145   }
1146
1147 /* Return the first non-blank character. */
1148
1149 return s;
1150 }
1151
1152
1153
1154 /*************************************************
1155 *             Read a name                        *
1156 *************************************************/
1157
1158 /* The yield is the pointer to the next uschar. Names longer than the
1159 output space are silently truncated. This function is also used from acl.c when
1160 parsing ACLs.
1161
1162 Arguments:
1163   name      where to put the name
1164   len       length of name
1165   s         input pointer
1166
1167 Returns:    new input pointer
1168 */
1169
1170 uschar *
1171 readconf_readname(uschar *name, int len, uschar *s)
1172 {
1173 int p = 0;
1174
1175 if (isalpha(Uskip_whitespace(&s)))
1176   while (isalnum(*s) || *s == '_')
1177     {
1178     if (p < len-1) name[p++] = *s;
1179     s++;
1180     }
1181
1182 name[p] = 0;
1183 Uskip_whitespace(&s);
1184 return s;
1185 }
1186
1187
1188
1189
1190 /*************************************************
1191 *          Read a time value                     *
1192 *************************************************/
1193
1194 /* This function is also called from outside, to read argument
1195 time values. The format of a time value is:
1196
1197   [<n>w][<n>d][<n>h][<n>m][<n>s]
1198
1199 as long as at least one is present. If a format error is encountered,
1200 return a negative value. The value must be terminated by the given
1201 terminator.
1202
1203 Arguments:
1204   s             input pointer
1205   terminator    required terminating character
1206   return_msec   if TRUE, allow fractional seconds and return milliseconds
1207
1208 Returns:        the time value, or -1 on syntax error
1209                 value is seconds if return_msec is FALSE
1210                 value is milliseconds if return_msec is TRUE
1211 */
1212
1213 int
1214 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1215 {
1216 int yield = 0;
1217 for (;;)
1218   {
1219   int value, count;
1220   double fraction;
1221
1222   if (!isdigit(*s)) return -1;
1223   (void)sscanf(CCS s, "%d%n", &value, &count);
1224   s += count;
1225
1226   switch (*s)
1227     {
1228     case 'w': value *= 7;
1229     case 'd': value *= 24;
1230     case 'h': value *= 60;
1231     case 'm': value *= 60;
1232     case 's': s++;
1233     break;
1234
1235     case '.':
1236     if (!return_msec) return -1;
1237     (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1238     s += count;
1239     if (*s++ != 's') return -1;
1240     yield += (int)(fraction * 1000.0);
1241     break;
1242
1243     default: return -1;
1244     }
1245
1246   if (return_msec) value *= 1000;
1247   yield += value;
1248   if (*s == terminator) return yield;
1249   }
1250 /* Control never reaches here. */
1251 }
1252
1253
1254
1255 /*************************************************
1256 *          Read a fixed point value              *
1257 *************************************************/
1258
1259 /* The value is returned *1000
1260
1261 Arguments:
1262   s           input pointer
1263   terminator  required terminator
1264
1265 Returns:      the value, or -1 on error
1266 */
1267
1268 static int
1269 readconf_readfixed(const uschar *s, int terminator)
1270 {
1271 int yield = 0;
1272 int value, count;
1273 if (!isdigit(*s)) return -1;
1274 (void)sscanf(CS  s, "%d%n", &value, &count);
1275 s += count;
1276 yield = value * 1000;
1277 if (*s == '.')
1278   {
1279   int m = 100;
1280   while (isdigit((*(++s))))
1281     {
1282     yield += (*s - '0') * m;
1283     m /= 10;
1284     }
1285   }
1286
1287 return (*s == terminator)? yield : (-1);
1288 }
1289
1290
1291
1292 /*************************************************
1293 *            Find option in list                 *
1294 *************************************************/
1295
1296 /* The lists are always in order, so binary chop can be used.
1297
1298 Arguments:
1299   name      the option name to search for
1300   ol        the first entry in the option list
1301   last      one more than the offset of the last entry in the option list
1302
1303 Returns:    pointer to an option entry, or NULL if not found
1304 */
1305
1306 static optionlist *
1307 find_option(uschar *name, optionlist *ol, int last)
1308 {
1309 int first = 0;
1310 while (last > first)
1311   {
1312   int middle = (first + last)/2;
1313   int c = Ustrcmp(name, ol[middle].name);
1314
1315   if (c == 0) return ol + middle;
1316   else if (c > 0) first = middle + 1;
1317   else last = middle;
1318   }
1319 return NULL;
1320 }
1321
1322
1323
1324 /*************************************************
1325 *      Find a set flag in option list            *
1326 *************************************************/
1327
1328 /* Because some versions of Unix make no restrictions on the values of uids and
1329 gids (even negative ones), we cannot represent "unset" by a special value.
1330 There is therefore a separate boolean variable for each one indicating whether
1331 a value is set or not. This function returns a pointer to the boolean, given
1332 the original option name. It is a major disaster if the flag cannot be found.
1333
1334 Arguments:
1335   name          the name of the uid or gid option
1336   oltop         points to the start of the relevant option list
1337   last          one more than the offset of the last item in the option list
1338   data_block    NULL when reading main options => data values in the option
1339                   list are absolute addresses; otherwise they are byte offsets
1340                   in data_block (used for driver options)
1341
1342 Returns:        a pointer to the boolean flag.
1343 */
1344
1345 static BOOL *
1346 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1347 {
1348 optionlist *ol;
1349 uschar name2[64];
1350 sprintf(CS name2, "*set_%.50s", name);
1351 if (!(ol = find_option(name2, oltop, last)))
1352   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1353     "Exim internal error: missing set flag for %s", name);
1354 return data_block
1355   ? (BOOL *)(US data_block + ol->v.offset) : (BOOL *)ol->v.value;
1356 }
1357
1358
1359
1360
1361 /*************************************************
1362 *    Output extra characters message and die     *
1363 *************************************************/
1364
1365 /* Called when an option line has junk on the end. Sometimes this is because
1366 the sysadmin thinks comments are permitted.
1367
1368 Arguments:
1369   s          points to the extra characters
1370   t1..t3     strings to insert in the log message
1371
1372 Returns:     doesn't return; dies
1373 */
1374
1375 static void
1376 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1377 {
1378 uschar *comment = US"";
1379 if (*s == '#') comment = US" (# is comment only at line start)";
1380 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1381   "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1382 }
1383
1384
1385
1386 /*************************************************
1387 *              Read rewrite information          *
1388 *************************************************/
1389
1390 /* Each line of rewrite information contains:
1391
1392 .  A complete address in the form user@domain, possibly with
1393    leading * for each part; or alternatively, a regex.
1394
1395 .  A replacement string (which will be expanded).
1396
1397 .  An optional sequence of one-letter flags, indicating which
1398    headers etc. to apply this rule to.
1399
1400 All this is decoded and placed into a control block. The OR of the flags is
1401 maintained in a common word.
1402
1403 Arguments:
1404   p           points to the string that makes up the rule
1405   existflags  points to the overall flag word
1406   isglobal    TRUE if reading global rewrite rules
1407
1408 Returns:      the control block for the parsed rule.
1409 */
1410
1411 static rewrite_rule *
1412 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1413 {
1414 rewrite_rule *next = store_get(sizeof(rewrite_rule), FALSE);
1415
1416 next->next = NULL;
1417 next->key = string_dequote(&p);
1418
1419 Uskip_whitespace(&p);
1420 if (!*p)
1421   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1422     "missing rewrite replacement string");
1423
1424 next->flags = 0;
1425 next->replacement = string_dequote(&p);
1426
1427 while (*p) switch (*p++)
1428   {
1429   case ' ': case '\t': break;
1430
1431   case 'q': next->flags |= rewrite_quit; break;
1432   case 'w': next->flags |= rewrite_whole; break;
1433
1434   case 'h': next->flags |= rewrite_all_headers; break;
1435   case 's': next->flags |= rewrite_sender; break;
1436   case 'f': next->flags |= rewrite_from; break;
1437   case 't': next->flags |= rewrite_to;   break;
1438   case 'c': next->flags |= rewrite_cc;   break;
1439   case 'b': next->flags |= rewrite_bcc;  break;
1440   case 'r': next->flags |= rewrite_replyto; break;
1441
1442   case 'E': next->flags |= rewrite_all_envelope; break;
1443   case 'F': next->flags |= rewrite_envfrom; break;
1444   case 'T': next->flags |= rewrite_envto; break;
1445
1446   case 'Q': next->flags |= rewrite_qualify; break;
1447   case 'R': next->flags |= rewrite_repeat; break;
1448
1449   case 'S':
1450   next->flags |= rewrite_smtp;
1451   if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1452     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1453       "rewrite rule has the S flag but is not a regular expression");
1454   break;
1455
1456   default:
1457   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1458     "unknown rewrite flag character '%c' "
1459     "(could be missing quotes round replacement item)", p[-1]);
1460   break;
1461   }
1462
1463 /* If no action flags are set, set all the "normal" rewrites. */
1464
1465 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1466   next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1467
1468 /* Remember which exist, for optimization, and return the rule */
1469
1470 *existflags |= next->flags;
1471 return next;
1472 }
1473
1474
1475
1476
1477 /*************************************************
1478 *          Read global rewrite information       *
1479 *************************************************/
1480
1481 /* Each line is a single rewrite rule; it is parsed into a control block
1482 by readconf_one_rewrite(), and its flags are ORed into the global flag
1483 word rewrite_existflags. */
1484
1485 void
1486 readconf_rewrites(void)
1487 {
1488 rewrite_rule **chain = &global_rewrite_rules;
1489 uschar *p;
1490
1491 while ((p = get_config_line()) != NULL)
1492   {
1493   rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1494   *chain = next;
1495   chain = &(next->next);
1496   }
1497 }
1498
1499
1500
1501 /*************************************************
1502 *               Read a string                    *
1503 *************************************************/
1504
1505 /* Strings are read into the normal store pool. As long we aren't too
1506 near the end of the current block, the string will just use what is necessary
1507 on the top of the stacking pool, because string_cat() uses the extension
1508 mechanism.
1509
1510 Argument:
1511   s         the rest of the input line
1512   name      the option name (for errors)
1513
1514 Returns:    pointer to the string
1515 */
1516
1517 static uschar *
1518 read_string(const uschar *s, const uschar *name)
1519 {
1520 uschar *yield;
1521 const uschar *ss;
1522
1523 if (*s != '\"') return string_copy(s);
1524
1525 ss = s;
1526 yield = string_dequote(&s);
1527
1528 if (s == ss+1 || s[-1] != '\"')
1529   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1530     "missing quote at end of string value for %s", name);
1531
1532 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1533
1534 return yield;
1535 }
1536
1537
1538 /*************************************************
1539 *            Custom-handler options              *
1540 *************************************************/
1541 static void
1542 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1543 {
1544 if (flags & opt_fn_print)
1545   {
1546   if (flags & opt_fn_print_label) printf("%s = ", name);
1547   printf("%s\n", smtp_receive_timeout_s
1548     ? string_printing2(smtp_receive_timeout_s, FALSE)
1549     : readconf_printtime(smtp_receive_timeout));
1550   }
1551 else if (*str == '$')
1552   smtp_receive_timeout_s = string_copy(str);
1553 else
1554   {
1555   /* "smtp_receive_timeout",     opt_time,        &smtp_receive_timeout */
1556   smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1557   if (smtp_receive_timeout < 0)
1558     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1559       name);
1560   }
1561 }
1562
1563 /*************************************************
1564 *            Handle option line                  *
1565 *************************************************/
1566
1567 /* This function is called from several places to process a line containing the
1568 setting of an option. The first argument is the line to be decoded; it has been
1569 checked not to be empty and not to start with '#'. Trailing newlines and white
1570 space have been removed. The second argument is a pointer to the list of
1571 variable names that are to be recognized, together with their types and
1572 locations, and the third argument gives the number of entries in the list.
1573
1574 The fourth argument is a pointer to a data block. If it is NULL, then the data
1575 values in the options list are absolute addresses. Otherwise, they are byte
1576 offsets in the data block.
1577
1578 String option data may continue onto several lines; this function reads further
1579 data from config_file if necessary.
1580
1581 The yield of this function is normally zero. If a string continues onto
1582 multiple lines, then the data value is permitted to be followed by a comma
1583 or a semicolon (for use in drivers) and the yield is that character.
1584
1585 Arguments:
1586   buffer        contains the configuration line to be handled
1587   oltop         points to the start of the relevant option list
1588   last          one more than the offset of the last item in the option list
1589   data_block    NULL when reading main options => data values in the option
1590                   list are absolute addresses; otherwise they are byte offsets
1591                   in data_block when they have opt_public set; otherwise
1592                   they are byte offsets in data_block->options_block.
1593   unknown_txt   format string to use in panic message for unknown option;
1594                   must contain %s for option name
1595                 if given as NULL, don't panic on unknown option
1596
1597 Returns:        TRUE if an option was read successfully,
1598                 FALSE false for an unknown option if unknown_txt == NULL,
1599                   otherwise panic and die on an unknown option
1600 */
1601
1602 static BOOL
1603 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1604   void *data_block, uschar *unknown_txt)
1605 {
1606 int ptr = 0;
1607 int offset = 0;
1608 int count, type, value;
1609 int issecure = 0;
1610 uid_t uid;
1611 gid_t gid;
1612 BOOL boolvalue = TRUE;
1613 BOOL freesptr = TRUE;
1614 optionlist *ol, *ol2;
1615 struct passwd *pw;
1616 rmark reset_point;
1617 int intbase = 0;
1618 uschar *inttype = US"";
1619 uschar *sptr;
1620 uschar *s = buffer;
1621 uschar **str_target;
1622 uschar name[64];
1623 uschar name2[64];
1624
1625 /* There may be leading spaces; thereafter, we expect an option name starting
1626 with a letter. */
1627
1628 while (isspace(*s)) s++;
1629 if (!isalpha(*s))
1630   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1631
1632 /* Read the name of the option, and skip any subsequent white space. If
1633 it turns out that what we read was "hide", set the flag indicating that
1634 this is a secure option, and loop to read the next word. */
1635
1636 for (int n = 0; n < 2; n++)
1637   {
1638   while (isalnum(*s) || *s == '_')
1639     {
1640     if (ptr < sizeof(name)-1) name[ptr++] = *s;
1641     s++;
1642     }
1643   name[ptr] = 0;
1644   while (isspace(*s)) s++;
1645   if (Ustrcmp(name, "hide") != 0) break;
1646   issecure = opt_secure;
1647   ptr = 0;
1648   }
1649
1650 /* Deal with "no_" or "not_" here for booleans */
1651
1652 if (Ustrncmp(name, "no_", 3) == 0)
1653   {
1654   boolvalue = FALSE;
1655   offset = 3;
1656   }
1657
1658 if (Ustrncmp(name, "not_", 4) == 0)
1659   {
1660   boolvalue = FALSE;
1661   offset = 4;
1662   }
1663
1664 /* Search the list for the given name. A non-existent name, or an option that
1665 is set twice, is a disaster. */
1666
1667 if (!(ol = find_option(name + offset, oltop, last)))
1668   {
1669   if (!unknown_txt) return FALSE;
1670   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1671   }
1672
1673 if ((ol->type & opt_set)  && !(ol->type & (opt_rep_con | opt_rep_str)))
1674   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1675     "\"%s\" option set for the second time", name);
1676
1677 ol->type |= opt_set | issecure;
1678 type = ol->type & opt_mask;
1679
1680 /* Types with data values must be followed by '='; the "no[t]_" prefix
1681 applies only to boolean values. */
1682
1683 if (type < opt_bool || type > opt_bool_last)
1684   {
1685   if (offset != 0)
1686     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1687       "negation prefix applied to a non-boolean option");
1688   if (!*s)
1689     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1690       "unexpected end of line (data missing) after %s", name);
1691   if (*s != '=')
1692     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1693   }
1694
1695 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1696 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1697 ultimately expands to one of those values. */
1698
1699 else if (*s && (offset != 0 || *s != '='))
1700   extra_chars_error(s, US"boolean option ", name, US"");
1701
1702 /* Skip white space after = */
1703
1704 if (*s == '=') while (isspace((*(++s))));
1705
1706 /* If there is a data block and the opt_public flag is not set, change
1707 the data block pointer to the private options block. */
1708
1709 if (data_block && !(ol->type & opt_public))
1710   data_block = (void *)(((driver_instance *)data_block)->options_block);
1711
1712 /* Now get the data according to the type. */
1713
1714 switch (type)
1715   {
1716   /* If a string value is not enclosed in quotes, it consists of
1717   the rest of the current line, verbatim. Otherwise, string escapes
1718   are processed.
1719
1720   A transport is specified as a string, which is then looked up in the
1721   list of transports. A search type is specified as one of a number of
1722   known strings.
1723
1724   A set or rewrite rules for a driver is specified as a string, which is
1725   then parsed into a suitable chain of control blocks.
1726
1727   Uids and gids are specified as strings which are then looked up in the
1728   passwd file. Lists of uids and gids are similarly specified as colon-
1729   separated strings. */
1730
1731   case opt_stringptr:
1732   case opt_uid:
1733   case opt_gid:
1734   case opt_expand_uid:
1735   case opt_expand_gid:
1736   case opt_uidlist:
1737   case opt_gidlist:
1738   case opt_rewrite:
1739
1740   reset_point = store_mark();
1741   sptr = read_string(s, name);
1742
1743   /* Having read a string, we now have several different ways of using it,
1744   depending on the data type, so do another switch. If keeping the actual
1745   string is not required (because it is interpreted), freesptr is set TRUE,
1746   and at the end we reset the pool. */
1747
1748   switch (type)
1749     {
1750     /* If this was a string, set the variable to point to the new string,
1751     and set the flag so its store isn't reclaimed. If it was a list of rewrite
1752     rules, we still keep the string (for printing), and parse the rules into a
1753     control block and flags word. */
1754
1755     case opt_stringptr:
1756     str_target = data_block ? USS (US data_block + ol->v.offset)
1757                             : USS ol->v.value;
1758     if (ol->type & opt_rep_con)
1759       {
1760       uschar * saved_condition;
1761       /* We already have a condition, we're conducting a crude hack to let
1762       multiple condition rules be chained together, despite storing them in
1763       text form. */
1764       *str_target = string_copy_perm( (saved_condition = *str_target)
1765         ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1766             saved_condition, sptr)
1767         : sptr,
1768         FALSE);
1769       /* TODO(pdp): there is a memory leak here and just below
1770       when we set 3 or more conditions; I still don't
1771       understand the store mechanism enough to know
1772       what's the safe way to free content from an earlier store.
1773       AFAICT, stores stack, so freeing an early stored item also stores
1774       all data alloc'd after it.  If we knew conditions were adjacent,
1775       we could survive that, but we don't.  So I *think* we need to take
1776       another bit from opt_type to indicate "malloced"; this seems like
1777       quite a hack, especially for this one case.  It also means that
1778       we can't ever reclaim the store from the *first* condition.
1779
1780       Because we only do this once, near process start-up, I'm prepared to
1781       let this slide for the time being, even though it rankles.  */
1782       }
1783     else if (ol->type & opt_rep_str)
1784       {
1785       uschar sep_o =
1786         Ustrncmp(name, "headers_add", 11) == 0  ? '\n'
1787         : Ustrncmp(name, "set", 3) == 0         ? ';'
1788         : ':';
1789       int    sep_i = -(int)sep_o;
1790       const uschar * list = sptr;
1791       uschar * s;
1792       gstring * list_o = NULL;
1793
1794       if (*str_target)
1795         {
1796         list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1797         list_o = string_cat(list_o, *str_target);
1798         }
1799
1800       while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1801         list_o = string_append_listele(list_o, sep_o, s);
1802
1803       if (list_o)
1804         *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1805       }
1806     else
1807       {
1808       *str_target = sptr;
1809       freesptr = FALSE;
1810       }
1811     break;
1812
1813     case opt_rewrite:
1814     if (data_block)
1815       *USS (US data_block + ol->v.offset) = sptr;
1816     else
1817       *USS ol->v.value = sptr;
1818     freesptr = FALSE;
1819     if (type == opt_rewrite)
1820       {
1821       int sep = 0;
1822       int *flagptr;
1823       uschar *p = sptr;
1824       rewrite_rule **chain;
1825       optionlist *ol3;
1826
1827       sprintf(CS name2, "*%.50s_rules", name);
1828       ol2 = find_option(name2, oltop, last);
1829       sprintf(CS name2, "*%.50s_flags", name);
1830       ol3 = find_option(name2, oltop, last);
1831
1832       if (!ol2 || !ol3)
1833         log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1834           "rewrite rules not available for driver");
1835
1836       if (data_block)
1837         {
1838         chain = (rewrite_rule **)(US data_block + ol2->v.offset);
1839         flagptr = (int *)(US data_block + ol3->v.offset);
1840         }
1841       else
1842         {
1843         chain = (rewrite_rule **)ol2->v.value;
1844         flagptr = (int *)ol3->v.value;
1845         }
1846
1847       while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1848         {
1849         rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1850         *chain = next;
1851         chain = &(next->next);
1852         }
1853
1854       if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1855         log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1856           "non-header rewrite - not allowed at transport time -");
1857       }
1858     break;
1859
1860     /* If it was an expanded uid, see if there is any expansion to be
1861     done by checking for the presence of a $ character. If there is, save it
1862     in the corresponding *expand_user option field. Otherwise, fall through
1863     to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1864     of data. */
1865
1866     case opt_expand_uid:
1867     sprintf(CS name2, "*expand_%.50s", name);
1868     if ((ol2 = find_option(name2, oltop, last)))
1869       {
1870       uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1871
1872       if (data_block)
1873         *(USS(US data_block + ol2->v.offset)) = ss;
1874       else
1875         *(USS ol2->v.value) = ss;
1876
1877       if (ss)
1878         {
1879         *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1880         freesptr = FALSE;
1881         break;
1882         }
1883       }
1884
1885     /* Look up a fixed uid, and also make use of the corresponding gid
1886     if a passwd entry is returned and the gid has not been set. */
1887
1888     case opt_uid:
1889     if (!route_finduser(sptr, &pw, &uid))
1890       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1891     if (data_block)
1892       *(uid_t *)(US data_block + ol->v.offset) = uid;
1893     else
1894       *(uid_t *)ol->v.value = uid;
1895
1896     /* Set the flag indicating a fixed value is set */
1897
1898     *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1899
1900     /* Handle matching gid if we have a passwd entry: done by finding the
1901     same name with terminating "user" changed to "group"; if not found,
1902     ignore. Also ignore if the value is already set. */
1903
1904     if (pw == NULL) break;
1905     Ustrcpy(name+Ustrlen(name)-4, US"group");
1906     ol2 = find_option(name, oltop, last);
1907     if (ol2 && ((ol2->type & opt_mask) == opt_gid ||
1908         (ol2->type & opt_mask) == opt_expand_gid))
1909       {
1910       BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1911       if (!*set_flag)
1912         {
1913         if (data_block)
1914           *((gid_t *)(US data_block + ol2->v.offset)) = pw->pw_gid;
1915         else
1916           *((gid_t *)ol2->v.value) = pw->pw_gid;
1917         *set_flag = TRUE;
1918         }
1919       }
1920     break;
1921
1922     /* If it was an expanded gid, see if there is any expansion to be
1923     done by checking for the presence of a $ character. If there is, save it
1924     in the corresponding *expand_user option field. Otherwise, fall through
1925     to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1926     of data. */
1927
1928     case opt_expand_gid:
1929     sprintf(CS name2, "*expand_%.50s", name);
1930     if ((ol2 = find_option(name2, oltop, last)))
1931       {
1932       uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1933
1934       if (data_block)
1935         *(USS(US data_block + ol2->v.offset)) = ss;
1936       else
1937         *(USS ol2->v.value) = ss;
1938
1939       if (ss)
1940         {
1941         *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1942         freesptr = FALSE;
1943         break;
1944         }
1945       }
1946
1947     /* Handle freestanding gid */
1948
1949     case opt_gid:
1950     if (!route_findgroup(sptr, &gid))
1951       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1952     if (data_block)
1953       *((gid_t *)(US data_block + ol->v.offset)) = gid;
1954     else
1955       *((gid_t *)ol->v.value) = gid;
1956     *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1957     break;
1958
1959     /* If it was a uid list, look up each individual entry, and build
1960     a vector of uids, with a count in the first element. Put the vector
1961     in malloc store so we can free the string. (We are reading into
1962     permanent store already.) */
1963
1964     case opt_uidlist:
1965       {
1966       int count = 1;
1967       uid_t *list;
1968       int ptr = 0;
1969       const uschar *p;
1970       const uschar *op = expand_string (sptr);
1971
1972       if (op == NULL)
1973         log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1974           name, expand_string_message);
1975
1976       p = op;
1977       if (*p != 0) count++;
1978       while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1979       list = store_malloc(count*sizeof(uid_t));
1980       list[ptr++] = (uid_t)(count - 1);
1981
1982       if (data_block)
1983         *((uid_t **)(US data_block + ol->v.offset)) = list;
1984       else
1985         *((uid_t **)ol->v.value) = list;
1986
1987       p = op;
1988       while (count-- > 1)
1989         {
1990         int sep = 0;
1991         (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1992         if (!route_finduser(big_buffer, NULL, &uid))
1993           log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1994             big_buffer);
1995         list[ptr++] = uid;
1996         }
1997       }
1998     break;
1999
2000     /* If it was a gid list, look up each individual entry, and build
2001     a vector of gids, with a count in the first element. Put the vector
2002     in malloc store so we can free the string. (We are reading into permanent
2003     store already.) */
2004
2005     case opt_gidlist:
2006       {
2007       int count = 1;
2008       gid_t *list;
2009       int ptr = 0;
2010       const uschar *p;
2011       const uschar *op = expand_string (sptr);
2012
2013       if (!op)
2014         log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2015           name, expand_string_message);
2016
2017       p = op;
2018       if (*p != 0) count++;
2019       while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2020       list = store_malloc(count*sizeof(gid_t));
2021       list[ptr++] = (gid_t)(count - 1);
2022
2023       if (data_block)
2024         *((gid_t **)(US data_block + ol->v.offset)) = list;
2025       else
2026         *((gid_t **)ol->v.value) = list;
2027
2028       p = op;
2029       while (count-- > 1)
2030         {
2031         int sep = 0;
2032         (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2033         if (!route_findgroup(big_buffer, &gid))
2034           log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2035             big_buffer);
2036         list[ptr++] = gid;
2037         }
2038       }
2039     break;
2040     }
2041
2042   /* Release store if the value of the string doesn't need to be kept. */
2043
2044   if (freesptr) reset_point = store_reset(reset_point);
2045   break;
2046
2047   /* Expanded boolean: if no characters follow, or if there are no dollar
2048   characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2049   save the string for later expansion in the alternate place. */
2050
2051   case opt_expand_bool:
2052   if (*s && Ustrchr(s, '$') != 0)
2053     {
2054     sprintf(CS name2, "*expand_%.50s", name);
2055     if ((ol2 = find_option(name2, oltop, last)))
2056       {
2057       reset_point = store_mark();
2058       sptr = read_string(s, name);
2059       if (data_block)
2060         *(USS(US data_block + ol2->v.offset)) = sptr;
2061       else
2062         *(USS ol2->v.value) = sptr;
2063       freesptr = FALSE;
2064       break;
2065       }
2066     }
2067   /* Fall through */
2068
2069   /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2070   look for yes/not/true/false. Some booleans are stored in a single bit in
2071   a single int. There's a special fudge for verify settings; without a suffix
2072   they set both xx_sender and xx_recipient. The table points to the sender
2073   value; search subsequently for the recipient. There's another special case:
2074   opt_bool_set also notes when a boolean has been set. */
2075
2076   case opt_bool:
2077   case opt_bit:
2078   case opt_bool_verify:
2079   case opt_bool_set:
2080   if (*s != 0)
2081     {
2082     s = readconf_readname(name2, 64, s);
2083     if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2084       boolvalue = TRUE;
2085     else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2086       boolvalue = FALSE;
2087     else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2088       "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2089     if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2090       US"for boolean option ", name);
2091     }
2092
2093   /* Handle single-bit type. */
2094
2095   if (type == opt_bit)
2096     {
2097     int bit = 1 << ((ol->type >> 16) & 31);
2098     int * ptr = data_block
2099       ? (int *)(US data_block + ol->v.offset)
2100       : (int *)ol->v.value;
2101     if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2102     break;
2103     }
2104
2105   /* Handle full BOOL types */
2106
2107   if (data_block)
2108     *((BOOL *)(US data_block + ol->v.offset)) = boolvalue;
2109   else
2110     *((BOOL *)ol->v.value) = boolvalue;
2111
2112   /* Verify fudge */
2113
2114   if (type == opt_bool_verify)
2115     {
2116     sprintf(CS name2, "%.50s_recipient", name + offset);
2117     if ((ol2 = find_option(name2, oltop, last)))
2118       if (data_block)
2119         *((BOOL *)(US data_block + ol2->v.offset)) = boolvalue;
2120       else
2121         *((BOOL *)ol2->v.value) = boolvalue;
2122     }
2123
2124   /* Note that opt_bool_set type is set, if there is somewhere to do so */
2125
2126   else if (type == opt_bool_set)
2127     {
2128     sprintf(CS name2, "*set_%.50s", name + offset);
2129     if ((ol2 = find_option(name2, oltop, last)))
2130       if (data_block)
2131         *((BOOL *)(US data_block + ol2->v.offset)) = TRUE;
2132       else
2133         *((BOOL *)ol2->v.value) = TRUE;
2134     }
2135   break;
2136
2137   /* Octal integer */
2138
2139   case opt_octint:
2140   intbase = 8;
2141   inttype = US"octal ";
2142
2143   /*  Integer: a simple(ish) case; allow octal and hex formats, and
2144   suffixes K, M, G, and T.  The different types affect output, not input. */
2145
2146   case opt_mkint:
2147   case opt_int:
2148     {
2149     uschar *endptr;
2150     long int lvalue;
2151
2152     errno = 0;
2153     lvalue = strtol(CS s, CSS &endptr, intbase);
2154
2155     if (endptr == s)
2156       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2157         inttype, name);
2158
2159     if (errno != ERANGE && *endptr)
2160       {
2161       uschar * mp = US"TtGgMmKk\0";     /* YyZzEePpTtGgMmKk */
2162
2163       if ((mp = Ustrchr(mp, *endptr)))
2164         {
2165         endptr++;
2166         do
2167           {
2168           if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2169             {
2170             errno = ERANGE;
2171             break;
2172             }
2173           lvalue *= 1024;
2174           }
2175         while (*(mp += 2));
2176         }
2177       }
2178
2179     if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2180       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2181         "absolute value of integer \"%s\" is too large (overflow)", s);
2182
2183     while (isspace(*endptr)) endptr++;
2184     if (*endptr)
2185       extra_chars_error(endptr, inttype, US"integer value for ", name);
2186
2187     value = (int)lvalue;
2188     }
2189
2190   if (data_block)
2191     *(int *)(US data_block + ol->v.offset) = value;
2192   else
2193     *(int *)ol->v.value = value;
2194   break;
2195
2196   /*  Integer held in K: again, allow formats and suffixes as above. */
2197
2198   case opt_Kint:
2199     {
2200     uschar *endptr;
2201     errno = 0;
2202     int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2203
2204     if (endptr == s)
2205       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2206         inttype, name);
2207
2208     if (errno != ERANGE && *endptr)
2209       {
2210       uschar * mp = US"ZzEePpTtGgMmKk\0";       /* YyZzEePpTtGgMmKk */
2211
2212       if ((mp = Ustrchr(mp, *endptr)))
2213         {
2214         endptr++;
2215         while (*(mp += 2))
2216           {
2217           if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2218             {
2219             errno = ERANGE;
2220             break;
2221             }
2222           lvalue *= 1024;
2223           }
2224         }
2225       else
2226         lvalue = (lvalue + 512)/1024;
2227       }
2228
2229     if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2230       "absolute value of integer \"%s\" is too large (overflow)", s);
2231
2232     while (isspace(*endptr)) endptr++;
2233     if (*endptr != 0)
2234       extra_chars_error(endptr, inttype, US"integer value for ", name);
2235
2236     if (data_block)
2237       *(int_eximarith_t *)(US data_block + ol->v.offset) = lvalue;
2238     else
2239       *(int_eximarith_t *)ol->v.value = lvalue;
2240     break;
2241     }
2242
2243   /*  Fixed-point number: held to 3 decimal places. */
2244
2245   case opt_fixed:
2246   if (sscanf(CS s, "%d%n", &value, &count) != 1)
2247     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2248       "fixed-point number expected for %s", name);
2249
2250   if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2251     "integer \"%s\" is too large (overflow)", s);
2252
2253   value *= 1000;
2254
2255   if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2256     "integer \"%s\" is too large (overflow)", s);
2257
2258   /* We get a coverity error here for using count, as it derived
2259   from the tainted buffer pointed to by s, as parsed by sscanf().
2260   By the definition of sscanf we must be accessing between start
2261   and end of s (assuming it is nul-terminated...) so ignore the error.  */
2262   /* coverity[tainted_data] */
2263   if (s[count] == '.')
2264     {
2265     int d = 100;
2266     while (isdigit(s[++count]))
2267       {
2268       value += (s[count] - '0') * d;
2269       d /= 10;
2270       }
2271     }
2272
2273   while (isspace(s[count])) count++;
2274
2275   if (s[count] != 0)
2276     extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2277
2278   if (data_block)
2279     *((int *)(US data_block + ol->v.offset)) = value;
2280   else
2281     *((int *)ol->v.value) = value;
2282   break;
2283
2284   /* There's a special routine to read time values. */
2285
2286   case opt_time:
2287   value = readconf_readtime(s, 0, FALSE);
2288   if (value < 0)
2289     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2290       name);
2291   if (data_block)
2292     *((int *)(US data_block + ol->v.offset)) = value;
2293   else
2294     *((int *)ol->v.value) = value;
2295   break;
2296
2297   /* A time list is a list of colon-separated times, with the first
2298   element holding the size of the list and the second the number of
2299   entries used. */
2300
2301   case opt_timelist:
2302     {
2303     int count = 0;
2304     int * list = data_block
2305       ? (int *)(US data_block + ol->v.offset)
2306       : (int *)ol->v.value;
2307
2308     if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2309       {
2310       int terminator = 0;
2311       uschar *snext = Ustrchr(s, ':');
2312       if (snext != NULL)
2313         {
2314         uschar *ss = snext;
2315         while (ss > s && isspace(ss[-1])) ss--;
2316         terminator = *ss;
2317         }
2318       value = readconf_readtime(s, terminator, FALSE);
2319       if (value < 0)
2320         log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2321           name);
2322       if (count > 1 && value <= list[count])
2323         log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2324           "time value out of order for %s", name);
2325       list[count+1] = value;
2326       if (snext == NULL) break;
2327       s = snext + 1;
2328       while (isspace(*s)) s++;
2329       }
2330
2331     if (count > list[0] - 2)
2332       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2333         name);
2334     if (count > 0 && list[2] == 0) count = 0;
2335     list[1] = count;
2336     break;
2337     }
2338
2339   case opt_func:
2340     {
2341     void (*fn)() = ol->v.fn;
2342     fn(name, s, 0);
2343     break;
2344     }
2345   }
2346
2347 return TRUE;
2348 }
2349
2350
2351
2352 /*************************************************
2353 *               Print a time value               *
2354 *************************************************/
2355
2356 /*
2357 Argument:  a time value in seconds
2358 Returns:   pointer to a fixed buffer containing the time as a string,
2359            in readconf_readtime() format
2360 */
2361
2362 uschar *
2363 readconf_printtime(int t)
2364 {
2365 int s, m, h, d, w;
2366 uschar *p = time_buffer;
2367
2368 if (t < 0)
2369   {
2370   *p++ = '-';
2371   t = -t;
2372   }
2373
2374 s = t % 60;
2375 t /= 60;
2376 m = t % 60;
2377 t /= 60;
2378 h = t % 24;
2379 t /= 24;
2380 d = t % 7;
2381 w = t/7;
2382
2383 if (w > 0) p += sprintf(CS p, "%dw", w);
2384 if (d > 0) p += sprintf(CS p, "%dd", d);
2385 if (h > 0) p += sprintf(CS p, "%dh", h);
2386 if (m > 0) p += sprintf(CS p, "%dm", m);
2387 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2388
2389 return time_buffer;
2390 }
2391
2392
2393
2394 /*************************************************
2395 *      Print an individual option value          *
2396 *************************************************/
2397
2398 /* This is used by the -bP option, so prints to the standard output.
2399 The entire options list is passed in as an argument, because some options come
2400 in pairs - typically uid/gid settings, which can either be explicit numerical
2401 values, or strings to be expanded later. If the numerical value is unset,
2402 search for "*expand_<name>" to see if there is a string equivalent.
2403
2404 Arguments:
2405   ol             option entry, or NULL for an unknown option
2406   name           option name
2407   options_block  NULL for main configuration options; otherwise points to
2408                    a driver block; if the option doesn't have opt_public
2409                    set, then options_block->options_block is where the item
2410                    resides.
2411   oltop          points to the option list in which ol exists
2412   last           one more than the offset of the last entry in optop
2413   no_labels      do not show "foo = " at the start.
2414
2415 Returns:         boolean success
2416 */
2417
2418 static BOOL
2419 print_ol(optionlist *ol, uschar *name, void *options_block,
2420   optionlist *oltop, int last, BOOL no_labels)
2421 {
2422 struct passwd *pw;
2423 struct group *gr;
2424 optionlist *ol2;
2425 void *value;
2426 uid_t *uidlist;
2427 gid_t *gidlist;
2428 uschar *s;
2429 uschar name2[64];
2430
2431 if (!ol)
2432   {
2433   printf("%s is not a known option\n", name);
2434   return FALSE;
2435   }
2436
2437 /* Non-admin callers cannot see options that have been flagged secure by the
2438 "hide" prefix. */
2439
2440 if (!f.admin_user && ol->type & opt_secure)
2441   {
2442   if (no_labels)
2443     printf("%s\n", CCS hidden);
2444   else
2445     printf("%s = %s\n", name, CCS hidden);
2446   return TRUE;
2447   }
2448
2449 /* Else show the value of the option */
2450
2451 value = ol->v.value;
2452 if (options_block)
2453   {
2454   if (!(ol->type & opt_public))
2455     options_block = (void *)(((driver_instance *)options_block)->options_block);
2456   value = (void *)(US options_block + (long int)value);
2457   }
2458
2459 switch(ol->type & opt_mask)
2460   {
2461   case opt_stringptr:
2462   case opt_rewrite:        /* Show the text value */
2463     s = *(USS value);
2464     if (!no_labels) printf("%s = ", name);
2465     printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2466     break;
2467
2468   case opt_int:
2469     if (!no_labels) printf("%s = ", name);
2470     printf("%d\n", *((int *)value));
2471     break;
2472
2473   case opt_mkint:
2474     {
2475     int x = *((int *)value);
2476     if (x != 0 && (x & 1023) == 0)
2477       {
2478       int c = 'K';
2479       x >>= 10;
2480       if ((x & 1023) == 0)
2481         {
2482         c = 'M';
2483         x >>= 10;
2484         }
2485       if (!no_labels) printf("%s = ", name);
2486       printf("%d%c\n", x, c);
2487       }
2488     else
2489       {
2490       if (!no_labels) printf("%s = ", name);
2491       printf("%d\n", x);
2492       }
2493     }
2494     break;
2495
2496   case opt_Kint:
2497     {
2498     int_eximarith_t x = *((int_eximarith_t *)value);
2499     if (!no_labels) printf("%s = ", name);
2500     if (x == 0) printf("0\n");
2501     else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2502     else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2503     else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2504     else printf(PR_EXIM_ARITH "K\n", x);
2505     }
2506     break;
2507
2508   case opt_octint:
2509     if (!no_labels) printf("%s = ", name);
2510     printf("%#o\n", *((int *)value));
2511     break;
2512
2513   /* Can be negative only when "unset", in which case integer */
2514
2515   case opt_fixed:
2516     {
2517     int x = *((int *)value);
2518     int f = x % 1000;
2519     int d = 100;
2520     if (x < 0) printf("%s =\n", name); else
2521       {
2522       if (!no_labels) printf("%s = ", name);
2523       printf("%d.", x/1000);
2524       do
2525         {
2526         printf("%d", f/d);
2527         f %= d;
2528         d /= 10;
2529         }
2530       while (f != 0);
2531       printf("\n");
2532       }
2533     }
2534     break;
2535
2536   /* If the numerical value is unset, try for the string value */
2537
2538   case opt_expand_uid:
2539     if (! *get_set_flag(name, oltop, last, options_block))
2540       {
2541       sprintf(CS name2, "*expand_%.50s", name);
2542       if ((ol2 = find_option(name2, oltop, last)))
2543         {
2544         if (options_block)
2545           s = *USS (US options_block + ol2->v.offset);
2546         else
2547           s = *USS ol2->v.value;
2548         if (!no_labels) printf("%s = ", name);
2549         printf("%s\n", s ? string_printing(s) : US"");
2550         break;
2551         }
2552       }
2553
2554     /* Else fall through */
2555
2556   case opt_uid:
2557     if (!no_labels) printf("%s = ", name);
2558     if (! *get_set_flag(name, oltop, last, options_block))
2559       printf("\n");
2560     else
2561       if ((pw = getpwuid(*((uid_t *)value))))
2562         printf("%s\n", pw->pw_name);
2563       else
2564         printf("%ld\n", (long int)(*((uid_t *)value)));
2565     break;
2566
2567   /* If the numerical value is unset, try for the string value */
2568
2569   case opt_expand_gid:
2570     if (! *get_set_flag(name, oltop, last, options_block))
2571       {
2572       sprintf(CS name2, "*expand_%.50s", name);
2573       if (  (ol2 = find_option(name2, oltop, last))
2574          && (ol2->type & opt_mask) == opt_stringptr)
2575         {
2576         if (options_block)
2577           s = *USS (US options_block + ol2->v.offset);
2578         else
2579           s = *USS ol2->v.value;
2580         if (!no_labels) printf("%s = ", name);
2581         printf("%s\n", s ? string_printing(s) : US"");
2582         break;
2583         }
2584       }
2585
2586     /* Else fall through */
2587
2588   case opt_gid:
2589     if (!no_labels) printf("%s = ", name);
2590     if (! *get_set_flag(name, oltop, last, options_block))
2591       printf("\n");
2592     else
2593       if ((gr = getgrgid(*((int *)value))))
2594         printf("%s\n", gr->gr_name);
2595       else
2596          printf("%ld\n", (long int)(*((int *)value)));
2597     break;
2598
2599   case opt_uidlist:
2600     uidlist = *((uid_t **)value);
2601     if (!no_labels) printf("%s =", name);
2602     if (uidlist)
2603       {
2604       uschar sep = no_labels ? '\0' : ' ';
2605       for (int i = 1; i <= (int)(uidlist[0]); i++)
2606         {
2607         uschar *name = NULL;
2608         if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2609         if (sep != '\0') printf("%c", sep);
2610         if (name) printf("%s", name);
2611         else printf("%ld", (long int)(uidlist[i]));
2612         sep = ':';
2613         }
2614       }
2615     printf("\n");
2616     break;
2617
2618   case opt_gidlist:
2619     gidlist = *((gid_t **)value);
2620     if (!no_labels) printf("%s =", name);
2621     if (gidlist)
2622       {
2623       uschar sep = no_labels ? '\0' : ' ';
2624       for (int i = 1; i <= (int)(gidlist[0]); i++)
2625         {
2626         uschar *name = NULL;
2627         if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2628         if (sep != '\0') printf("%c", sep);
2629         if (name) printf("%s", name);
2630         else printf("%ld", (long int)(gidlist[i]));
2631         sep = ':';
2632         }
2633       }
2634     printf("\n");
2635     break;
2636
2637   case opt_time:
2638     if (!no_labels) printf("%s = ", name);
2639     printf("%s\n", readconf_printtime(*((int *)value)));
2640     break;
2641
2642   case opt_timelist:
2643     {
2644     int *list = (int *)value;
2645     if (!no_labels) printf("%s = ", name);
2646     for (int i = 0; i < list[1]; i++)
2647       printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2648     printf("\n");
2649     }
2650     break;
2651
2652   case opt_bit:
2653     printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2654       "" : "no_", name);
2655     break;
2656
2657   case opt_expand_bool:
2658     sprintf(CS name2, "*expand_%.50s", name);
2659     if ((ol2 = find_option(name2, oltop, last)) && ol2->v.value)
2660       {
2661       if (options_block)
2662         s = *USS (US options_block + ol2->v.offset);
2663       else
2664         s = *USS ol2->v.value;
2665       if (s)
2666         {
2667         if (!no_labels) printf("%s = ", name);
2668         printf("%s\n", string_printing(s));
2669         break;
2670         }
2671       /* s == NULL => string not set; fall through */
2672       }
2673
2674     /* Fall through */
2675
2676   case opt_bool:
2677   case opt_bool_verify:
2678   case opt_bool_set:
2679     printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2680     break;
2681
2682   case opt_func:
2683     ol->v.fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2684     break;
2685   }
2686 return TRUE;
2687 }
2688
2689
2690
2691 /*************************************************
2692 *        Print value from main configuration     *
2693 *************************************************/
2694
2695 /* This function, called as a result of encountering the -bP option,
2696 causes the value of any main configuration variable to be output if the
2697 second argument is NULL. There are some special values:
2698
2699   all                print all main configuration options
2700   config_file        print the name of the configuration file
2701                      (configure_file will still work, for backward
2702                      compatibility)
2703   routers            print the routers' configurations
2704   transports         print the transports' configuration
2705   authenticators     print the authenticators' configuration
2706   macros             print the macros' configuration
2707   router_list        print a list of router names
2708   transport_list     print a list of transport names
2709   authenticator_list print a list of authentication mechanism names
2710   macro_list         print a list of macro names
2711   +name              print a named list item
2712   local_scan         print the local_scan options
2713   config             print the configuration as it is parsed
2714   environment        print the used execution environment
2715
2716 If the second argument is not NULL, it must be one of "router", "transport",
2717 "authenticator" or "macro" in which case the first argument identifies the
2718 driver whose options are to be printed.
2719
2720 Arguments:
2721   name        option name if type == NULL; else driver name
2722   type        NULL or driver type name, as described above
2723   no_labels   avoid the "foo = " at the start of an item
2724
2725 Returns:      Boolean success
2726 */
2727
2728 BOOL
2729 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2730 {
2731 BOOL names_only = FALSE;
2732 optionlist *ol2 = NULL;
2733 driver_instance *d = NULL;
2734 int size = 0;
2735
2736 if (!type)
2737   {
2738   if (*name == '+')
2739     {
2740     tree_node *t;
2741     BOOL found = FALSE;
2742     static uschar *types[] = { US"address", US"domain", US"host",
2743       US"localpart" };
2744     static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2745       &hostlist_anchor, &localpartlist_anchor };
2746
2747     for (int i = 0; i < 4; i++)
2748       if ((t = tree_search(*(anchors[i]), name+1)))
2749         {
2750         namedlist_block * nb = t->data.ptr;
2751         const uschar * s = nb->hide ? hidden : nb->string;
2752         found = TRUE;
2753         if (no_labels)
2754           printf("%s\n", CCS s);
2755         else
2756           printf("%slist %s = %s\n", types[i], name+1, CCS s);
2757         }
2758
2759     if (!found)
2760       printf("no address, domain, host, or local part list called \"%s\" "
2761         "exists\n", name+1);
2762
2763     return found;
2764     }
2765
2766   if (  Ustrcmp(name, "configure_file") == 0
2767      || Ustrcmp(name, "config_file") == 0)
2768     {
2769     printf("%s\n", CS config_main_filename);
2770     return TRUE;
2771     }
2772
2773   if (Ustrcmp(name, "all") == 0)
2774     {
2775     for (optionlist * ol = optionlist_config;
2776          ol < optionlist_config + nelem(optionlist_config); ol++)
2777       if (!(ol->type & opt_hidden))
2778         (void) print_ol(ol, US ol->name, NULL,
2779                   optionlist_config, nelem(optionlist_config),
2780                   no_labels);
2781     return TRUE;
2782     }
2783
2784   if (Ustrcmp(name, "local_scan") == 0)
2785     {
2786 #ifndef LOCAL_SCAN_HAS_OPTIONS
2787     printf("local_scan() options are not supported\n");
2788     return FALSE;
2789 #else
2790     for (optionlist * ol = local_scan_options;
2791          ol < local_scan_options + local_scan_options_count; ol++)
2792       (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2793                   local_scan_options_count, no_labels);
2794     return TRUE;
2795 #endif
2796     }
2797
2798   if (Ustrcmp(name, "config") == 0)
2799     {
2800     print_config(f.admin_user, no_labels);
2801     return TRUE;
2802     }
2803
2804   if (Ustrcmp(name, "routers") == 0)
2805     {
2806     type = US"router";
2807     name = NULL;
2808     }
2809   else if (Ustrcmp(name, "transports") == 0)
2810     {
2811     type = US"transport";
2812     name = NULL;
2813     }
2814   else if (Ustrcmp(name, "authenticators") == 0)
2815     {
2816     type = US"authenticator";
2817     name = NULL;
2818     }
2819   else if (Ustrcmp(name, "macros") == 0)
2820     {
2821     type = US"macro";
2822     name = NULL;
2823     }
2824   else if (Ustrcmp(name, "router_list") == 0)
2825     {
2826     type = US"router";
2827     name = NULL;
2828     names_only = TRUE;
2829     }
2830   else if (Ustrcmp(name, "transport_list") == 0)
2831     {
2832     type = US"transport";
2833     name = NULL;
2834     names_only = TRUE;
2835     }
2836   else if (Ustrcmp(name, "authenticator_list") == 0)
2837     {
2838     type = US"authenticator";
2839     name = NULL;
2840     names_only = TRUE;
2841     }
2842   else if (Ustrcmp(name, "macro_list") == 0)
2843     {
2844     type = US"macro";
2845     name = NULL;
2846     names_only = TRUE;
2847     }
2848   else if (Ustrcmp(name, "environment") == 0)
2849     {
2850     if (environ)
2851       {
2852       uschar ** p;
2853       for (p = USS environ; *p; p++) ;
2854       qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2855
2856       for (p = USS environ; *p; p++)
2857         {
2858         uschar * q;
2859         if (no_labels && (q = Ustrchr(*p, '='))) *q  = '\0';
2860         puts(CS *p);
2861         }
2862       }
2863     return TRUE;
2864     }
2865
2866   else
2867     return print_ol(find_option(name,
2868       optionlist_config, nelem(optionlist_config)),
2869       name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2870   }
2871
2872 /* Handle the options for a router or transport. Skip options that are flagged
2873 as hidden. Some of these are options with names starting with '*', used for
2874 internal alternative representations of other options (which the printing
2875 function will sort out). Others are synonyms kept for backward compatibility.
2876 */
2877
2878 if (Ustrcmp(type, "router") == 0)
2879   {
2880   d = (driver_instance *)routers;
2881   ol2 = optionlist_routers;
2882   size = optionlist_routers_size;
2883   }
2884 else if (Ustrcmp(type, "transport") == 0)
2885   {
2886   d = (driver_instance *)transports;
2887   ol2 = optionlist_transports;
2888   size = optionlist_transports_size;
2889   }
2890 else if (Ustrcmp(type, "authenticator") == 0)
2891   {
2892   d = (driver_instance *)auths;
2893   ol2 = optionlist_auths;
2894   size = optionlist_auths_size;
2895   }
2896
2897 else if (Ustrcmp(type, "macro") == 0)
2898   {
2899   /* People store passwords in macros and they were previously not available
2900   for printing.  So we have an admin_users restriction. */
2901   if (!f.admin_user)
2902     {
2903     fprintf(stderr, "exim: permission denied\n");
2904     return FALSE;
2905     }
2906   for (macro_item * m = macros; m; m = m->next)
2907     if (!name || Ustrcmp(name, m->name) == 0)
2908       {
2909       if (names_only)
2910         printf("%s\n", CS m->name);
2911       else if (no_labels)
2912         printf("%s\n", CS m->replacement);
2913       else
2914         printf("%s=%s\n", CS m->name, CS m->replacement);
2915       if (name)
2916         return TRUE;
2917       }
2918   if (!name) return TRUE;
2919
2920   printf("%s %s not found\n", type, name);
2921   return FALSE;
2922   }
2923
2924 if (names_only)
2925   {
2926   for (; d; d = d->next) printf("%s\n", CS d->name);
2927   return TRUE;
2928   }
2929
2930 /* Either search for a given driver, or print all of them */
2931
2932 for (; d; d = d->next)
2933   {
2934   BOOL rc = FALSE;
2935   if (!name)
2936     printf("\n%s %s:\n", d->name, type);
2937   else if (Ustrcmp(d->name, name) != 0) continue;
2938
2939   for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2940     if (!(ol->type & opt_hidden))
2941       rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2942
2943   for (optionlist * ol = d->info->options;
2944        ol < d->info->options + *(d->info->options_count); ol++)
2945     if (!(ol->type & opt_hidden))
2946       rc |= print_ol(ol, US ol->name, d, d->info->options,
2947                     *d->info->options_count, no_labels);
2948
2949   if (name) return rc;
2950   }
2951 if (!name) return TRUE;
2952
2953 printf("%s %s not found\n", type, name);
2954 return FALSE;
2955 }
2956
2957
2958
2959 /*************************************************
2960 *          Read a named list item                *
2961 *************************************************/
2962
2963 /* This function reads a name and a list (i.e. string). The name is used to
2964 save the list in a tree, sorted by its name. Each entry also has a number,
2965 which can be used for caching tests, but if the string contains any expansion
2966 items other than $key, the number is set negative to inhibit caching. This
2967 mechanism is used for domain, host, and address lists that are referenced by
2968 the "+name" syntax.
2969
2970 Arguments:
2971   anchorp     points to the tree anchor
2972   numberp     points to the current number for this tree
2973   max         the maximum number permitted
2974   s           the text of the option line, starting immediately after the name
2975                 of the list type
2976   tname       the name of the list type, for messages
2977   hide        do not output value on "-bP"
2978
2979 Returns:      nothing
2980 */
2981
2982 static void
2983 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2984   uschar *tname, BOOL hide)
2985 {
2986 BOOL forcecache = FALSE;
2987 uschar *ss;
2988 tree_node *t;
2989 namedlist_block * nb = store_get(sizeof(namedlist_block), FALSE);
2990
2991 if (Ustrncmp(s, "_cache", 6) == 0)
2992   {
2993   forcecache = TRUE;
2994   s += 6;
2995   }
2996
2997 if (!isspace(*s))
2998   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2999
3000 if (*numberp >= max)
3001  log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3002    tname, max);
3003
3004 Uskip_whitespace(&s);
3005 ss = s;
3006 while (isalnum(*s) || *s == '_') s++;
3007 t = store_get(sizeof(tree_node) + s-ss, is_tainted(ss));
3008 Ustrncpy(t->name, ss, s-ss);
3009 t->name[s-ss] = 0;
3010 Uskip_whitespace(&s);
3011
3012 if (!tree_insertnode(anchorp, t))
3013   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3014     "duplicate name \"%s\" for a named %s", t->name, tname);
3015
3016 t->data.ptr = nb;
3017 nb->number = *numberp;
3018 *numberp += 1;
3019 nb->hide = hide;
3020
3021 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3022   "missing '=' after \"%s\"", t->name);
3023 Uskip_whitespace(&s);
3024 nb->string = read_string(s, t->name);
3025 nb->cache_data = NULL;
3026
3027 /* Check the string for any expansions; if any are found, mark this list
3028 uncacheable unless the user has explicited forced caching. */
3029
3030 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3031 }
3032
3033
3034
3035
3036 /*************************************************
3037 *        Unpick data for a rate limit            *
3038 *************************************************/
3039
3040 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3041 separate values.
3042
3043 Arguments:
3044   s            string, in the form t,b,f,l
3045                where t is the threshold (integer)
3046                b is the initial delay (time)
3047                f is the multiplicative factor (fixed point)
3048                k is the maximum time (time)
3049   threshold    where to store threshold
3050   base         where to store base in milliseconds
3051   factor       where to store factor in milliseconds
3052   limit        where to store limit
3053
3054 Returns:       nothing (panics on error)
3055 */
3056
3057 static void
3058 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3059   int *limit)
3060 {
3061 uschar bstring[16], lstring[16];
3062
3063 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3064     factor, lstring) == 4)
3065   {
3066   *base = readconf_readtime(bstring, 0, TRUE);
3067   *limit = readconf_readtime(lstring, 0, TRUE);
3068   if (*base >= 0 && *limit >= 0) return;
3069   }
3070 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3071 }
3072
3073
3074
3075
3076 /*************************************************
3077 *         Read main configuration options        *
3078 *************************************************/
3079
3080 /* This function is the first to be called for configuration reading. It
3081 opens the configuration file and reads general configuration settings until
3082 it reaches the end of the configuration section. The file is then left open so
3083 that the remaining configuration data can subsequently be read if needed for
3084 this run of Exim.
3085
3086 The configuration file must be owned either by root or exim, and be writeable
3087 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3088 in the config file, so the test is done on the compiled in values. A slight
3089 anomaly, to be carefully documented.
3090
3091 The name of the configuration file is taken from a list that is included in the
3092 binary of Exim. It can be altered from the command line, but if that is done,
3093 root privilege is immediately withdrawn unless the caller is root or exim.
3094 The first file on the list that exists is used.
3095
3096 For use on multiple systems that share file systems, first look for a
3097 configuration file whose name has the current node name on the end. If that is
3098 not found, try the generic name. For really contorted configurations, that run
3099 multiple Exims with different uid settings, first try adding the effective uid
3100 before the node name. These complications are going to waste resources on most
3101 systems. Therefore they are available only when requested by compile-time
3102 options. */
3103
3104 void
3105 readconf_main(BOOL nowarn)
3106 {
3107 int sep = 0;
3108 struct stat statbuf;
3109 uschar *s, *filename;
3110 const uschar *list = config_main_filelist;
3111
3112 /* Loop through the possible file names */
3113
3114 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3115   {
3116
3117   /* Cut out all the fancy processing unless specifically wanted */
3118
3119   #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3120   uschar *suffix = filename + Ustrlen(filename);
3121
3122   /* Try for the node-specific file if a node name exists */
3123
3124   #ifdef CONFIGURE_FILE_USE_NODE
3125   struct utsname uts;
3126   if (uname(&uts) >= 0)
3127     {
3128     #ifdef CONFIGURE_FILE_USE_EUID
3129     sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3130     config_file = Ufopen(filename, "rb");
3131     if (config_file == NULL)
3132     #endif  /* CONFIGURE_FILE_USE_EUID */
3133       {
3134       sprintf(CS suffix, ".%.256s", uts.nodename);
3135       config_file = Ufopen(filename, "rb");
3136       }
3137     }
3138   #endif  /* CONFIGURE_FILE_USE_NODE */
3139
3140   /* Otherwise, try the generic name, possibly with the euid added */
3141
3142   #ifdef CONFIGURE_FILE_USE_EUID
3143   if (config_file == NULL)
3144     {
3145     sprintf(CS suffix, ".%ld", (long int)original_euid);
3146     config_file = Ufopen(filename, "rb");
3147     }
3148   #endif  /* CONFIGURE_FILE_USE_EUID */
3149
3150   /* Finally, try the unadorned name */
3151
3152   if (config_file == NULL)
3153     {
3154     *suffix = 0;
3155     config_file = Ufopen(filename, "rb");
3156     }
3157   #else  /* if neither defined */
3158
3159   /* This is the common case when the fancy processing is not included. */
3160
3161   config_file = Ufopen(filename, "rb");
3162   #endif
3163
3164   /* If the file does not exist, continue to try any others. For any other
3165   error, break out (and die). */
3166
3167   if (config_file != NULL || errno != ENOENT) break;
3168   }
3169
3170 /* On success, save the name for verification; config_filename is used when
3171 logging configuration errors (it changes for .included files) whereas
3172 config_main_filename is the name shown by -bP. Failure to open a configuration
3173 file is a serious disaster. */
3174
3175 if (config_file)
3176   {
3177   uschar *last_slash = Ustrrchr(filename, '/');
3178   config_filename = config_main_filename = string_copy(filename);
3179
3180   /* The config_main_directory we need for the $config_dir expansion.
3181   config_main_filename we need for $config_file expansion.
3182   And config_dir is the directory of the current configuration, used for
3183   relative .includes. We do need to know it's name, as we change our working
3184   directory later. */
3185
3186   if (filename[0] == '/')
3187     config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3188   else
3189     {
3190       /* relative configuration file name: working dir + / + basename(filename) */
3191
3192       uschar buf[PATH_MAX];
3193       gstring * g;
3194
3195       if (os_getcwd(buf, PATH_MAX) == NULL)
3196         {
3197         perror("exim: getcwd");
3198         exit(EXIT_FAILURE);
3199         }
3200       g = string_cat(NULL, buf);
3201
3202       /* If the dir does not end with a "/", append one */
3203       if (g->s[g->ptr-1] != '/')
3204         g = string_catn(g, US"/", 1);
3205
3206       /* If the config file contains a "/", extract the directory part */
3207       if (last_slash)
3208         g = string_catn(g, filename, last_slash - filename);
3209
3210       config_main_directory = string_from_gstring(g);
3211     }
3212   config_directory = config_main_directory;
3213   }
3214 else
3215   {
3216   if (filename == NULL)
3217     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3218       "%s", config_main_filelist);
3219   else
3220     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3221       "configuration file %s", filename));
3222   }
3223
3224 /* Now, once we found and opened our configuration file, we change the directory
3225 to a safe place. Later we change to $spool_directory. */
3226
3227 if (Uchdir("/") < 0)
3228   {
3229   perror("exim: chdir `/': ");
3230   exit(EXIT_FAILURE);
3231   }
3232
3233 /* Check the status of the file we have opened, if we have retained root
3234 privileges and the file isn't /dev/null (which *should* be 0666). */
3235
3236 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3237   {
3238   if (fstat(fileno(config_file), &statbuf) != 0)
3239     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3240       big_buffer);
3241
3242   if ((statbuf.st_uid != root_uid                /* owner not root */
3243        #ifdef CONFIGURE_OWNER
3244        && statbuf.st_uid != config_uid           /* owner not the special one */
3245        #endif
3246          ) ||                                    /* or */
3247       (statbuf.st_gid != root_gid                /* group not root & */
3248        #ifdef CONFIGURE_GROUP
3249        && statbuf.st_gid != config_gid           /* group not the special one */
3250        #endif
3251        && (statbuf.st_mode & 020) != 0) ||       /* group writeable  */
3252                                                  /* or */
3253       ((statbuf.st_mode & 2) != 0))              /* world writeable  */
3254
3255     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3256       "wrong owner, group, or mode", big_buffer);
3257
3258   /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3259   This assumes we will need this much storage to handle all the allocations
3260   during startup; it won't help when .include is being used.  When it does, it
3261   will cut down on the number of store blocks (and malloc calls, and sbrk
3262   syscalls).  It also assume we're on the relevant pool. */
3263
3264   if (statbuf.st_size > 8192)
3265     {
3266     rmark r = store_mark();
3267     void * dummy = store_get((int)statbuf.st_size, FALSE);
3268     store_reset(r);
3269     }
3270   }
3271
3272 /* Process the main configuration settings. They all begin with a lower case
3273 letter. If we see something starting with an upper case letter, it is taken as
3274 a macro definition. */
3275
3276 while ((s = get_config_line()))
3277   {
3278   BOOL hide;
3279   uschar * t;
3280
3281   if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3282     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3283       "found unexpected BOM (Byte Order Mark)");
3284
3285   if (isupper(*s))
3286     {
3287     if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE);
3288     continue;
3289     }
3290
3291   t = (hide = Ustrncmp(s, "hide", 4) == 0 && isspace(s[4])) ? s + 5 : s;
3292
3293   if (Ustrncmp(t, "domainlist", 10) == 0)
3294     read_named_list(&domainlist_anchor, &domainlist_count,
3295       MAX_NAMED_LIST, t+10, US"domain list", hide);
3296
3297   else if (Ustrncmp(t, "hostlist", 8) == 0)
3298     read_named_list(&hostlist_anchor, &hostlist_count,
3299       MAX_NAMED_LIST, t+8, US"host list", hide);
3300
3301   else if (Ustrncmp(t, US"addresslist", 11) == 0)
3302     read_named_list(&addresslist_anchor, &addresslist_count,
3303       MAX_NAMED_LIST, t+11, US"address list", hide);
3304
3305   else if (Ustrncmp(t, US"localpartlist", 13) == 0)
3306     read_named_list(&localpartlist_anchor, &localpartlist_count,
3307       MAX_NAMED_LIST, t+13, US"local part list", hide);
3308
3309   else
3310     (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3311       NULL, US"main option \"%s\" unknown");
3312   }
3313
3314
3315 /* If local_sender_retain is set, local_from_check must be unset. */
3316
3317 if (local_sender_retain && local_from_check)
3318   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3319     "local_sender_retain are set; this combination is not allowed");
3320
3321 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3322 wanted. */
3323
3324 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3325
3326 /* The max retry interval must not be greater than 24 hours. */
3327
3328 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3329
3330 /* remote_max_parallel must be > 0 */
3331
3332 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3333
3334 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3335 start of a new SMTP message. */
3336
3337 freeze_tell_config = freeze_tell;
3338
3339 /* The primary host name may be required for expansion of spool_directory
3340 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3341 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3342 canonize it. Some people like upper case letters in their host names, so we
3343 don't force the case. */
3344
3345 if (primary_hostname == NULL)
3346   {
3347   const uschar *hostname;
3348   struct utsname uts;
3349   if (uname(&uts) < 0)
3350     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3351   hostname = US uts.nodename;
3352
3353   if (Ustrchr(hostname, '.') == NULL)
3354     {
3355     int af = AF_INET;
3356     struct hostent *hostdata;
3357
3358     #if HAVE_IPV6
3359     if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3360          match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3361             MCL_DOMAIN, TRUE, NULL) != OK))
3362       af = AF_INET6;
3363     #else
3364     af = AF_INET;
3365     #endif
3366
3367     for (;;)
3368       {
3369       #if HAVE_IPV6
3370         #if HAVE_GETIPNODEBYNAME
3371         int error_num;
3372         hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3373         #else
3374         hostdata = gethostbyname2(CS hostname, af);
3375         #endif
3376       #else
3377       hostdata = gethostbyname(CS hostname);
3378       #endif
3379
3380       if (hostdata != NULL)
3381         {
3382         hostname = US hostdata->h_name;
3383         break;
3384         }
3385
3386       if (af == AF_INET) break;
3387       af = AF_INET;
3388       }
3389     }
3390
3391   primary_hostname = string_copy(hostname);
3392   }
3393
3394 /* Set up default value for smtp_active_hostname */
3395
3396 smtp_active_hostname = primary_hostname;
3397
3398 /* If spool_directory wasn't set in the build-time configuration, it must have
3399 got set above. Of course, writing to the log may not work if log_file_path is
3400 not set, but it will at least get to syslog or somewhere, with any luck. */
3401
3402 if (!*spool_directory)
3403   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3404     "proceed");
3405
3406 /* Expand the spool directory name; it may, for example, contain the primary
3407 host name. Same comment about failure. */
3408
3409 if (!(s = expand_string(spool_directory)))
3410   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3411     "\"%s\": %s", spool_directory, expand_string_message);
3412 spool_directory = s;
3413
3414 /* Expand log_file_path, which must contain "%s" in any component that isn't
3415 the null string or "syslog". It is also allowed to contain one instance of %D
3416 or %M. However, it must NOT contain % followed by anything else. */
3417
3418 if (*log_file_path)
3419   {
3420   const uschar *ss, *sss;
3421   int sep = ':';                       /* Fixed for log file path */
3422   if (!(s = expand_string(log_file_path)))
3423     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3424       "\"%s\": %s", log_file_path, expand_string_message);
3425
3426   ss = s;
3427   while ((sss = string_nextinlist(&ss, &sep, big_buffer, big_buffer_size)))
3428     {
3429     uschar *t;
3430     if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3431     if (!(t = Ustrstr(sss, "%s")))
3432       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3433         "contain \"%%s\"", sss);
3434     *t = 'X';
3435     if ((t = Ustrchr(sss, '%')))
3436       if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3437         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3438           "unexpected \"%%\" character", s);
3439     }
3440
3441   log_file_path = s;
3442   }
3443
3444 /* Interpret syslog_facility into an integer argument for 'ident' param to
3445 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3446 leading "log_". */
3447
3448 if (syslog_facility_str)
3449   {
3450   int i;
3451   uschar *s = syslog_facility_str;
3452
3453   if ((Ustrlen(syslog_facility_str) >= 4) &&
3454         (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3455     s += 4;
3456
3457   for (i = 0; i < syslog_list_size; i++)
3458     if (strcmpic(s, syslog_list[i].name) == 0)
3459       {
3460       syslog_facility = syslog_list[i].value;
3461       break;
3462       }
3463
3464   if (i >= syslog_list_size)
3465     log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3466       "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3467   }
3468
3469 /* Expand pid_file_path */
3470
3471 if (*pid_file_path != 0)
3472   {
3473   if (!(s = expand_string(pid_file_path)))
3474     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3475       "\"%s\": %s", pid_file_path, expand_string_message);
3476   pid_file_path = s;
3477   }
3478
3479 /* Set default value of process_log_path */
3480
3481 if (!process_log_path || *process_log_path =='\0')
3482   process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3483
3484 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3485 message. */
3486
3487 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3488
3489 /* Unpick the SMTP rate limiting options, if set */
3490
3491 if (smtp_ratelimit_mail)
3492   unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3493     &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3494
3495 if (smtp_ratelimit_rcpt)
3496   unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3497     &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3498
3499 /* The qualify domains default to the primary host name */
3500
3501 if (!qualify_domain_sender)
3502   qualify_domain_sender = primary_hostname;
3503 if (!qualify_domain_recipient)
3504   qualify_domain_recipient = qualify_domain_sender;
3505
3506 /* Setting system_filter_user in the configuration sets the gid as well if a
3507 name is given, but a numerical value does not. */
3508
3509 if (system_filter_uid_set && !system_filter_gid_set)
3510   {
3511   struct passwd *pw = getpwuid(system_filter_uid);
3512   if (!pw)
3513     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3514       (long int)system_filter_uid);
3515   system_filter_gid = pw->pw_gid;
3516   system_filter_gid_set = TRUE;
3517   }
3518
3519 /* If the errors_reply_to field is set, check that it is syntactically valid
3520 and ensure it contains a domain. */
3521
3522 if (errors_reply_to)
3523   {
3524   uschar *errmess;
3525   int start, end, domain;
3526   uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3527     &start, &end, &domain, FALSE);
3528
3529   if (!recipient)
3530     log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3531       "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3532
3533   if (domain == 0)
3534     log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3535       "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3536   }
3537
3538 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3539 smtp_accept_max must also be set. */
3540
3541 if (smtp_accept_max == 0 &&
3542     (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3543   log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3544     "smtp_accept_max must be set if smtp_accept_queue or "
3545     "smtp_accept_max_per_host is set");
3546
3547 /* Set up the host number if anything is specified. It is an expanded string
3548 so that it can be computed from the host name, for example. We do this last
3549 so as to ensure that everything else is set up before the expansion. */
3550
3551 if (host_number_string)
3552   {
3553   long int n;
3554   uschar *end;
3555   uschar *s = expand_string(host_number_string);
3556
3557   if (!s)
3558     log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3559         "failed to expand localhost_number \"%s\": %s",
3560         host_number_string, expand_string_message);
3561   n = Ustrtol(s, &end, 0);
3562   while (isspace(*end)) end++;
3563   if (*end != 0)
3564     log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3565       "localhost_number value is not a number: %s", s);
3566   if (n > LOCALHOST_MAX)
3567     log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3568       "localhost_number is greater than the maximum allowed value (%d)",
3569         LOCALHOST_MAX);
3570   host_number = n;
3571   }
3572
3573 #ifndef DISABLE_TLS
3574 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3575
3576 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3577   log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3578     "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3579     tls_verify_hosts ? "" : "try_");
3580
3581 /* Magic number: at time of writing, 1024 has been the long-standing value
3582 used by so many clients, and what Exim used to use always, that it makes
3583 sense to just min-clamp this max-clamp at that. */
3584 if (tls_dh_max_bits < 1024)
3585   log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3586       "tls_dh_max_bits is too small, must be at least 1024 for interop");
3587
3588 /* If openssl_options is set, validate it */
3589 if (openssl_options)
3590   {
3591 # ifdef USE_GNUTLS
3592   log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3593     "openssl_options is set but we're using GnuTLS");
3594 # else
3595   long dummy;
3596   if (!tls_openssl_options_parse(openssl_options, &dummy))
3597     log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3598       "openssl_options parse error: %s", openssl_options);
3599 # endif
3600   }
3601 #endif  /*DISABLE_TLS*/
3602
3603 if (!nowarn && !keep_environment && environ && *environ)
3604   log_write(0, LOG_MAIN,
3605       "Warning: purging the environment.\n"
3606       " Suggested action: use keep_environment.");
3607 }
3608
3609
3610
3611 /*************************************************
3612 *          Initialize one driver                 *
3613 *************************************************/
3614
3615 /* This is called once the driver's generic options, if any, have been read.
3616 We can now find the driver, set up defaults for the private options, and
3617 unset any "set" bits in the private options table (which might have been
3618 set by another incarnation of the same driver).
3619
3620 Arguments:
3621   d                   pointer to driver instance block, with generic
3622                         options filled in
3623   drivers_available   vector of available drivers
3624   size_of_info        size of each block in drivers_available
3625   class               class of driver, for error message
3626
3627 Returns:              pointer to the driver info block
3628 */
3629
3630 static driver_info *
3631 init_driver(driver_instance *d, driver_info *drivers_available,
3632   int size_of_info, uschar *class)
3633 {
3634 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3635      dd = (driver_info *)((US dd) + size_of_info))
3636   if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3637     {
3638     int len = dd->options_len;
3639     d->info = dd;
3640     d->options_block = store_get(len, FALSE);
3641     memcpy(d->options_block, dd->options_block, len);
3642     for (int i = 0; i < *(dd->options_count); i++)
3643       dd->options[i].type &= ~opt_set;
3644     return dd;
3645     }
3646
3647 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3648   "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3649
3650 return NULL;   /* never obeyed */
3651 }
3652
3653
3654
3655
3656 /*************************************************
3657 *             Initialize driver list             *
3658 *************************************************/
3659
3660 /* This function is called for routers, transports, and authentication
3661 mechanisms. It reads the data from the current point in the configuration file
3662 up to the end of the section, and sets up a chain of instance blocks according
3663 to the file's contents. The file will already have been opened by a call to
3664 readconf_main, and must be left open for subsequent reading of further data.
3665
3666 Any errors cause a panic crash. Note that the blocks with names driver_info and
3667 driver_instance must map the first portions of all the _info and _instance
3668 blocks for this shared code to work.
3669
3670 Arguments:
3671   class                      "router", "transport", or "authenticator"
3672   anchor                     &routers, &transports, &auths
3673   drivers_available          available drivers
3674   size_of_info               size of each info block
3675   instance_default           points to default data for an instance
3676   instance_size              size of instance block
3677   driver_optionlist          generic option list
3678   driver_optionlist_count    count of generic option list
3679
3680 Returns:                     nothing
3681 */
3682
3683 void
3684 readconf_driver_init(
3685   uschar *class,
3686   driver_instance **anchor,
3687   driver_info *drivers_available,
3688   int size_of_info,
3689   void *instance_default,
3690   int  instance_size,
3691   optionlist *driver_optionlist,
3692   int  driver_optionlist_count)
3693 {
3694 driver_instance **p = anchor;
3695 driver_instance *d = NULL;
3696 uschar *buffer;
3697
3698 while ((buffer = get_config_line()))
3699   {
3700   uschar name[64];
3701   uschar *s;
3702
3703   /* Read the first name on the line and test for the start of a new driver. A
3704   macro definition indicates the end of the previous driver. If this isn't the
3705   start of a new driver, the line will be re-read. */
3706
3707   s = readconf_readname(name, sizeof(name), buffer);
3708
3709   /* Handle macro definition, first finishing off the initialization of the
3710   previous driver, if any. */
3711
3712   if (isupper(*name) && *s == '=')
3713     {
3714     if (d)
3715       {
3716       if (!d->driver_name)
3717         log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3718           "no driver defined for %s \"%s\"", class, d->name);
3719       /* s is using big_buffer, so this call had better not */
3720       (d->info->init)(d);
3721       d = NULL;
3722       }
3723     if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE);
3724     continue;
3725     }
3726
3727   /* If the line starts with a name terminated by a colon, we are at the
3728   start of the definition of a new driver. The rest of the line must be
3729   blank. */
3730
3731   if (*s++ == ':')
3732     {
3733     /* Finish off initializing the previous driver. */
3734
3735     if (d)
3736       {
3737       if (!d->driver_name)
3738         log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3739           "no driver defined for %s \"%s\"", class, d->name);
3740       (d->info->init)(d);
3741       }
3742
3743     /* Check that we haven't already got a driver of this name */
3744
3745     for (d = *anchor; d; d = d->next)
3746       if (Ustrcmp(name, d->name) == 0)
3747         log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3748           "there are two %ss called \"%s\"", class, name);
3749
3750     /* Set up a new driver instance data block on the chain, with
3751     its default values installed. */
3752
3753     d = store_get(instance_size, FALSE);
3754     memcpy(d, instance_default, instance_size);
3755     *p = d;
3756     p = &d->next;
3757     d->name = string_copy(name);
3758
3759     /* Clear out the "set" bits in the generic options */
3760
3761     for (int i = 0; i < driver_optionlist_count; i++)
3762       driver_optionlist[i].type &= ~opt_set;
3763
3764     /* Check nothing more on this line, then do the next loop iteration. */
3765
3766     Uskip_whitespace(&s);
3767     if (*s) extra_chars_error(s, US"driver name ", name, US"");
3768     continue;
3769     }
3770
3771   /* Not the start of a new driver. Give an error if we have not set up a
3772   current driver yet. */
3773
3774   if (!d)
3775     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3776
3777   /* First look to see if this is a generic option; if it is "driver",
3778   initialize the driver. If is it not a generic option, we can look for a
3779   private option provided that the driver has been previously set up. */
3780
3781   if (readconf_handle_option(buffer, driver_optionlist,
3782         driver_optionlist_count, d, NULL))
3783     {
3784     if (!d->info && d->driver_name)
3785       init_driver(d, drivers_available, size_of_info, class);
3786     }
3787
3788   /* Handle private options - pass the generic block because some may
3789   live therein. A flag with each option indicates if it is in the public
3790   block. */
3791
3792   else if (d->info)
3793     readconf_handle_option(buffer, d->info->options,
3794       *(d->info->options_count), d, US"option \"%s\" unknown");
3795
3796   /* The option is not generic and the driver name has not yet been given. */
3797
3798   else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3799     "(\"driver\" must be specified before any private options)", name);
3800   }
3801
3802 /* Run the initialization function for the final driver. */
3803
3804 if (d)
3805   {
3806   if (!d->driver_name)
3807     log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3808       "no driver defined for %s \"%s\"", class, d->name);
3809   (d->info->init)(d);
3810   }
3811 }
3812
3813
3814
3815 /*************************************************
3816 *            Check driver dependency             *
3817 *************************************************/
3818
3819 /* This function is passed a driver instance and a string. It checks whether
3820 any of the string options for the driver contains the given string as an
3821 expansion variable.
3822
3823 Arguments:
3824   d        points to a driver instance block
3825   s        the string to search for
3826
3827 Returns:   TRUE if a dependency is found
3828 */
3829
3830 BOOL
3831 readconf_depends(driver_instance *d, uschar *s)
3832 {
3833 int count = *(d->info->options_count);
3834 uschar *ss;
3835
3836 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3837   if ((ol->type & opt_mask) == opt_stringptr)
3838     {
3839     void * options_block = ol->type & opt_public ? (void *)d : d->options_block;
3840     uschar * value = *USS(US options_block + ol->v.offset);
3841
3842     if (value && (ss = Ustrstr(value, s)) != NULL)
3843       {
3844       if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3845         isalnum(ss[Ustrlen(s)])) continue;
3846       DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3847         d->name, ol->name, s);
3848       return TRUE;
3849       }
3850     }
3851
3852 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3853 return FALSE;
3854 }
3855
3856
3857
3858
3859 /*************************************************
3860 *      Decode an error type for retries          *
3861 *************************************************/
3862
3863 /* This function is global because it is also called from the main
3864 program when testing retry information. It decodes strings such as "quota_7d"
3865 into numerical error codes.
3866
3867 Arguments:
3868   pp           points to start of text
3869   p            points past end of text
3870   basic_errno  points to an int to receive the main error number
3871   more_errno   points to an int to receive the secondary error data
3872
3873 Returns:       NULL if decoded correctly; else points to error text
3874 */
3875
3876 uschar *
3877 readconf_retry_error(const uschar *pp, const uschar *p,
3878   int *basic_errno, int *more_errno)
3879 {
3880 int len;
3881 const uschar *q = pp;
3882 while (q < p && *q != '_') q++;
3883 len = q - pp;
3884
3885 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3886   {
3887   *basic_errno = ERRNO_EXIMQUOTA;
3888   if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3889       return US"bad time value";
3890   }
3891
3892 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3893   {
3894   *basic_errno = ECONNREFUSED;
3895   if (q != p)
3896     {
3897     if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3898     else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3899     else return US"A or MX expected after \"refused\"";
3900     }
3901   }
3902
3903 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3904   {
3905   *basic_errno = ETIMEDOUT;
3906   if (q != p)
3907     {
3908     int i;
3909     int xlen = p - q - 1;
3910     const uschar *x = q + 1;
3911
3912     static uschar *extras[] =
3913       { US"A", US"MX", US"connect", US"connect_A",  US"connect_MX" };
3914     static int values[] =
3915       { 'A',   'M',    RTEF_CTOUT,  RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3916
3917     for (i = 0; i < nelem(extras); i++)
3918       if (strncmpic(x, extras[i], xlen) == 0)
3919         {
3920         *more_errno = values[i];
3921         break;
3922         }
3923
3924     if (i >= nelem(extras))
3925       if (strncmpic(x, US"DNS", xlen) == 0)
3926         log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3927           "available in retry rules (it has never worked) - treated as "
3928           "\"timeout\"");
3929       else
3930         return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3931     }
3932   }
3933
3934 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3935          strncmpic(pp, US"rcpt_4", 6) == 0 ||
3936          strncmpic(pp, US"data_4", 6) == 0)
3937   {
3938   BOOL bad = FALSE;
3939   int x = 255;                           /* means "any 4xx code" */
3940   if (p != pp + 8) bad = TRUE; else
3941     {
3942     int a = pp[6], b = pp[7];
3943     if (isdigit(a))
3944       {
3945       x = (a - '0') * 10;
3946       if (isdigit(b)) x += b - '0';
3947       else if (b == 'x') x += 100;
3948       else bad = TRUE;
3949       }
3950     else if (a != 'x' || b != 'x') bad = TRUE;
3951     }
3952
3953   if (bad)
3954     return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3955       "x is literal and d is any digit", pp);
3956
3957   *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3958                  *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3959   *more_errno = x << 8;
3960   }
3961
3962 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3963          strncmpic(q+1, US"failed", p-q-1) == 0)
3964   *basic_errno = ERRNO_AUTHFAIL;
3965
3966 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3967   *basic_errno = ERRNO_SMTPCLOSED;
3968
3969 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3970   *basic_errno = ERRNO_TLSREQUIRED;
3971
3972 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3973   *basic_errno = ERRNO_UNKNOWNHOST;
3974
3975 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3976   return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3977
3978 return NULL;
3979 }
3980
3981
3982
3983
3984 /*************************************************
3985 *                Read retry information          *
3986 *************************************************/
3987
3988 /* Each line of retry information contains:
3989
3990 .  A domain name pattern or an address pattern;
3991
3992 .  An error name, possibly with additional data, or *;
3993
3994 .  An optional sequence of retry items, each consisting of an identifying
3995    letter, a cutoff time, and optional parameters.
3996
3997 All this is decoded and placed into a control block. */
3998
3999
4000 /* Subroutine to read an argument, preceded by a comma and terminated
4001 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4002 1 = fixed point number (returned *1000).
4003
4004 Arguments:
4005   paddr     pointer to pointer to current character; updated
4006   type      0 => read a time; 1 => read a fixed point number
4007
4008 Returns:    time in seconds or fixed point number * 1000
4009 */
4010
4011 static int
4012 retry_arg(const uschar **paddr, int type)
4013 {
4014 const uschar *p = *paddr;
4015 const uschar *pp;
4016
4017 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4018
4019 Uskip_whitespace(&p);
4020 pp = p;
4021 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4022
4023 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4024   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4025
4026 *paddr = p;
4027 switch (type)
4028   {
4029   case 0: return readconf_readtime(pp, *p, FALSE);
4030   case 1: return readconf_readfixed(pp, *p);
4031   }
4032 return 0;    /* Keep picky compilers happy */
4033 }
4034
4035 /* The function proper */
4036
4037 void
4038 readconf_retries(void)
4039 {
4040 retry_config **chain = &retries;
4041 retry_config *next;
4042 const uschar *p;
4043
4044 while ((p = get_config_line()))
4045   {
4046   retry_rule **rchain;
4047   const uschar *pp;
4048   uschar *error;
4049
4050   next = store_get(sizeof(retry_config), FALSE);
4051   next->next = NULL;
4052   *chain = next;
4053   chain = &(next->next);
4054   next->basic_errno = next->more_errno = 0;
4055   next->senders = NULL;
4056   next->rules = NULL;
4057   rchain = &(next->rules);
4058
4059   next->pattern = string_dequote(&p);
4060   Uskip_whitespace(&p);
4061   pp = p;
4062   while (mac_isgraph(*p)) p++;
4063   if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4064     "missing error type in retry rule");
4065
4066   /* Test error names for things we understand. */
4067
4068   if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4069        &next->more_errno)))
4070     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4071
4072   /* There may be an optional address list of senders to be used as another
4073   constraint on the rule. This was added later, so the syntax is a bit of a
4074   fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4075   an address list. */
4076
4077   Uskip_whitespace(&p);
4078   if (Ustrncmp(p, "senders", 7) == 0)
4079     {
4080     p += 7;
4081     Uskip_whitespace(&p);
4082     if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4083       "\"=\" expected after \"senders\" in retry rule");
4084     Uskip_whitespace(&p);
4085     next->senders = string_dequote(&p);
4086     }
4087
4088   /* Now the retry rules. Keep the maximum timeout encountered. */
4089
4090   Uskip_whitespace(&p);
4091
4092   while (*p)
4093     {
4094     retry_rule *rule = store_get(sizeof(retry_rule), FALSE);
4095     *rchain = rule;
4096     rchain = &(rule->next);
4097     rule->next = NULL;
4098     rule->rule = toupper(*p++);
4099     rule->timeout = retry_arg(&p, 0);
4100     if (rule->timeout > retry_maximum_timeout)
4101       retry_maximum_timeout = rule->timeout;
4102
4103     switch (rule->rule)
4104       {
4105       case 'F':   /* Fixed interval */
4106         rule->p1 = retry_arg(&p, 0);
4107         break;
4108
4109       case 'G':   /* Geometrically increasing intervals */
4110       case 'H':   /* Ditto, but with randomness */
4111         rule->p1 = retry_arg(&p, 0);
4112         rule->p2 = retry_arg(&p, 1);
4113         break;
4114
4115       default:
4116         log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4117         break;
4118       }
4119
4120     if (rule->timeout <= 0 || rule->p1 <= 0 ||
4121           (rule->rule != 'F' && rule->p2 < 1000))
4122       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4123         "bad parameters for retry rule");
4124
4125     if (Uskip_whitespace(&p) == ';')
4126       {
4127       p++;
4128       Uskip_whitespace(&p);
4129       }
4130     else if (*p)
4131       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4132     }
4133   }
4134 }
4135
4136
4137
4138 /*************************************************
4139 *         Initialize authenticators              *
4140 *************************************************/
4141
4142 /* Read the authenticators section of the configuration file.
4143
4144 Arguments:   none
4145 Returns:     nothing
4146 */
4147
4148 static void
4149 auths_init(void)
4150 {
4151 #ifndef DISABLE_PIPE_CONNECT
4152 int nauths = 0;
4153 #endif
4154
4155 readconf_driver_init(US"authenticator",
4156   (driver_instance **)(&auths),      /* chain anchor */
4157   (driver_info *)auths_available,    /* available drivers */
4158   sizeof(auth_info),                 /* size of info block */
4159   &auth_defaults,                    /* default values for generic options */
4160   sizeof(auth_instance),             /* size of instance block */
4161   optionlist_auths,                  /* generic options */
4162   optionlist_auths_size);
4163
4164 for (auth_instance * au = auths; au; au = au->next)
4165   {
4166   if (!au->public_name)
4167     log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4168       "the %s authenticator", au->name);
4169
4170   for (auth_instance * bu = au->next; bu; bu = bu->next)
4171     if (strcmpic(au->public_name, bu->public_name) == 0)
4172       if ((au->client && bu->client) || (au->server && bu->server))
4173         log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4174           "(%s and %s) have the same public name (%s)",
4175           au->client ? US"client" : US"server", au->name, bu->name,
4176           au->public_name);
4177 #ifndef DISABLE_PIPE_CONNECT
4178   nauths++;
4179 #endif
4180   }
4181 #ifndef DISABLE_PIPE_CONNECT
4182 f.smtp_in_early_pipe_no_auth = nauths > 16;
4183 #endif
4184 }
4185
4186
4187
4188
4189 /*************************************************
4190 *             Read ACL information               *
4191 *************************************************/
4192
4193 /* If this run of Exim is not doing something that involves receiving a
4194 message, we can just skip over the ACL information. No need to parse it.
4195
4196 First, we have a function for acl_read() to call back to get the next line. We
4197 need to remember the line we passed, because at the end it will contain the
4198 name of the next ACL. */
4199
4200 static uschar *acl_line;
4201
4202 static uschar *
4203 acl_callback(void)
4204 {
4205 acl_line = get_config_line();
4206 return acl_line;
4207 }
4208
4209
4210 /* Now the main function:
4211
4212 Arguments:    none
4213 Returns:      nothing
4214 */
4215
4216 static void
4217 readconf_acl(void)
4218 {
4219 uschar *p;
4220
4221 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4222 between ACLs. */
4223
4224 acl_line = get_config_line();
4225
4226 while(acl_line)
4227   {
4228   uschar name[64];
4229   tree_node *node;
4230   uschar *error;
4231
4232   p = readconf_readname(name, sizeof(name), acl_line);
4233   if (isupper(*name) && *p == '=')
4234     {
4235     if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE);
4236     acl_line = get_config_line();
4237     continue;
4238     }
4239
4240   if (*p != ':' || name[0] == 0)
4241     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4242
4243   node = store_get(sizeof(tree_node) + Ustrlen(name), is_tainted(name));
4244   Ustrcpy(node->name, name);
4245   if (!tree_insertnode(&acl_anchor, node))
4246     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4247       "there are two ACLs called \"%s\"", name);
4248
4249   node->data.ptr = acl_read(acl_callback, &error);
4250
4251   if (node->data.ptr == NULL && error != NULL)
4252     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4253   }
4254 }
4255
4256
4257
4258 /*************************************************
4259 *     Read configuration for local_scan()        *
4260 *************************************************/
4261
4262 /* This function is called after "begin local_scan" is encountered in the
4263 configuration file. If the local_scan() function allows for configuration
4264 options, we can process them. Otherwise, we expire in a panic.
4265
4266 Arguments:  none
4267 Returns:    nothing
4268 */
4269
4270 static void
4271 local_scan_init(void)
4272 {
4273 #ifndef LOCAL_SCAN_HAS_OPTIONS
4274 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4275   "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4276 #else
4277
4278 uschar *p;
4279 while ((p = get_config_line()))
4280   (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4281     NULL, US"local_scan option \"%s\" unknown");
4282 #endif
4283 }
4284
4285
4286
4287 /*************************************************
4288 *     Read rest of configuration (after main)    *
4289 *************************************************/
4290
4291 /* This function reads the rest of the runtime configuration, after the main
4292 configuration. It is called only when actually needed. Each subsequent section
4293 of the configuration starts with a line of the form
4294
4295   begin name
4296
4297 where the name is "routers", "transports", etc. A section is terminated by
4298 hitting the next "begin" line, and the next name is left in next_section.
4299 Because it may confuse people as to whether the names are singular or plural,
4300 we add "s" if it's missing. There is always enough room in next_section for
4301 this. This function is basically just a switch.
4302
4303 Arguments:   none
4304 Returns:     nothing
4305 */
4306
4307 static uschar *section_list[] = {
4308   US"acls",
4309   US"authenticators",
4310   US"local_scans",
4311   US"retrys",
4312   US"rewrites",
4313   US"routers",
4314   US"transports"};
4315
4316 void
4317 readconf_rest(void)
4318 {
4319 int had = 0;
4320
4321 while(next_section[0] != 0)
4322   {
4323   int bit;
4324   int first = 0;
4325   int last = nelem(section_list);
4326   int mid = last/2;
4327   int n = Ustrlen(next_section);
4328
4329   if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4330
4331   for (;;)
4332     {
4333     int c = strcmpic(next_section, section_list[mid]);
4334     if (c == 0) break;
4335     if (c > 0) first = mid + 1; else last = mid;
4336     if (first >= last)
4337       log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4338         "\"%.*s\" is not a known configuration section name", n, next_section);
4339     mid = (last + first)/2;
4340     }
4341
4342   bit = 1 << mid;
4343   if (((had ^= bit) & bit) == 0)
4344     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4345       "\"%.*s\" section is repeated in the configuration file", n,
4346         next_section);
4347
4348   switch(mid)
4349     {
4350     case 0: readconf_acl(); break;
4351     case 1: auths_init(); break;
4352     case 2: local_scan_init(); break;
4353     case 3: readconf_retries(); break;
4354     case 4: readconf_rewrites(); break;
4355     case 5: route_init(); break;
4356     case 6: transport_init(); break;
4357     }
4358   }
4359
4360 (void)fclose(config_file);
4361 }
4362
4363 /* Init the storage for the pre-parsed config lines */
4364 void
4365 readconf_save_config(const uschar *s)
4366 {
4367 save_config_line(string_sprintf("# Exim Configuration (%s)",
4368   f.running_in_test_harness ? US"X" : s));
4369 }
4370
4371 static void
4372 save_config_position(const uschar *file, int line)
4373 {
4374 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4375 }
4376
4377 /* Append a pre-parsed logical line to the config lines store,
4378 this operates on a global (static) list that holds all the pre-parsed
4379 config lines, we do no further processing here, output formatting and
4380 honouring of <hide> or macros will be done during output */
4381
4382 static void
4383 save_config_line(const uschar* line)
4384 {
4385 static config_line_item *current;
4386 config_line_item *next;
4387
4388 next = (config_line_item*) store_get(sizeof(config_line_item), FALSE);
4389 next->line = string_copy(line);
4390 next->next = NULL;
4391
4392 if (!config_lines) config_lines = next;
4393 else current->next = next;
4394
4395 current = next;
4396 }
4397
4398 /* List the parsed config lines, care about nice formatting and
4399 hide the <hide> values unless we're the admin user */
4400 void
4401 print_config(BOOL admin, BOOL terse)
4402 {
4403 const int TS = terse ? 0 : 2;
4404 int indent = 0;
4405
4406 for (config_line_item * i = config_lines; i; i = i->next)
4407   {
4408   uschar *current;
4409   uschar *p;
4410
4411   /* skip over to the first non-space */
4412   for (current = i->line; *current && isspace(*current); ++current)
4413     ;
4414
4415   if (*current == '\0')
4416     continue;
4417
4418   /* Collapse runs of spaces. We stop this if we encounter one of the
4419    * following characters: "'$, as this may indicate careful formatting */
4420   for (p = current; *p; ++p)
4421     {
4422     uschar *next;
4423     if (!isspace(*p)) continue;
4424     if (*p != ' ') *p = ' ';
4425
4426     for (next = p; isspace(*next); ++next)
4427       ;
4428
4429     if (next - p > 1)
4430       memmove(p+1, next, Ustrlen(next)+1);
4431
4432     if (*next == '"' || *next == '\'' || *next == '$')
4433       break;
4434     }
4435
4436   /* # lines */
4437   if (current[0] == '#')
4438     puts(CCS current);
4439
4440   /* begin lines are left aligned */
4441   else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4442     {
4443     if (!terse) puts("");
4444     puts(CCS current);
4445     indent = TS;
4446     }
4447
4448   /* router/acl/transport block names */
4449   else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4450     {
4451     if (!terse) puts("");
4452     printf("%*s%s\n", TS, "", current);
4453     indent = 2 * TS;
4454     }
4455
4456   /* hidden lines (all MACROS or lines prefixed with "hide") */
4457   else if (  !admin
4458           && (  isupper(*current)
4459              || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4460              )
4461           )
4462     {
4463     if ((p = Ustrchr(current, '=')))
4464       {
4465       *p = '\0';
4466       printf("%*s%s= %s\n", indent, "", current, CCS hidden);
4467       }
4468     /* e.g.: hide split_spool_directory */
4469     else
4470       printf("%*s\n", indent, CCS hidden);
4471     }
4472
4473   else
4474     /* rest is public */
4475     printf("%*s%s\n", indent, "", current);
4476   }
4477 }
4478
4479 #endif  /*!MACRO_PREDEF*/
4480 /* vi: aw ai sw=2
4481 */
4482 /* End of readconf.c */