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