src/src/readconf.c

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