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