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