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