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