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