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