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