1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
6 /* See the file NOTICE for conditions of use and distribution. */
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. */
14 #define CSTATE_STACK_SIZE 10
17 /* Structure for chain (stack) of .included files */
19 typedef struct config_file_item {
20 struct config_file_item *next;
26 /* Structure of table of conditional words and their state transitions */
28 typedef struct cond_item {
36 /* Structure of table of syslog facility names and values */
38 typedef struct syslog_fac_item {
44 /* Static variables */
46 static config_file_item *config_file_stack = NULL; /* For includes */
48 static uschar *syslog_facility_str = NULL;
49 static uschar next_section[24];
50 static uschar time_buffer[24];
52 /* State variables for conditional loading (.ifdef / .else / .endif) */
54 static int cstate = 0;
55 static int cstate_stack_ptr = -1;
56 static int cstate_stack[CSTATE_STACK_SIZE];
58 /* Table of state transitions for handling conditional inclusions. There are
59 four possible state transitions:
63 .elifdef true (or .else)
66 .endif just causes the previous cstate to be popped off the stack */
68 static int next_cstate[3][4] =
70 /* State 0: reading from file, or reading until next .else or .endif */
72 /* State 1: condition failed, skipping until next .else or .endif */
74 /* State 2: skipping until .endif */
78 /* Table of conditionals and the states to set. For each name, there are four
79 values: the length of the name (to save computing it each time), the state to
80 set if a macro was found in the line, the state to set if a macro was not found
81 in the line, and a stack manipulation setting which is:
83 -1 pull state value off the stack
84 0 don't alter the stack
85 +1 push value onto stack, before setting new state
88 static cond_item cond_list[] = {
89 { US"ifdef", 5, 0, 1, 1 },
90 { US"ifndef", 6, 1, 0, 1 },
91 { US"elifdef", 7, 2, 3, 0 },
92 { US"elifndef", 8, 3, 2, 0 },
93 { US"else", 4, 2, 2, 0 },
94 { US"endif", 5, 0, 0, -1 }
97 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
99 /* Table of syslog facility names and their values */
101 static syslog_fac_item syslog_list[] = {
102 { US"mail", LOG_MAIL },
103 { US"user", LOG_USER },
104 { US"news", LOG_NEWS },
105 { US"uucp", LOG_UUCP },
106 { US"local0", LOG_LOCAL0 },
107 { US"local1", LOG_LOCAL1 },
108 { US"local2", LOG_LOCAL2 },
109 { US"local3", LOG_LOCAL3 },
110 { US"local4", LOG_LOCAL4 },
111 { US"local5", LOG_LOCAL5 },
112 { US"local6", LOG_LOCAL6 },
113 { US"local7", LOG_LOCAL7 },
114 { US"daemon", LOG_DAEMON }
117 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
122 /*************************************************
123 * Main configuration options *
124 *************************************************/
126 /* The list of options that can be set in the main configuration file. This
127 must be in alphabetic order because it is searched by binary chop. */
129 static optionlist optionlist_config[] = {
130 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
131 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
132 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
133 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
134 { "accept_8bitmime", opt_bool, &accept_8bitmime },
135 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
136 #ifdef WITH_CONTENT_SCAN
137 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
139 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
140 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
141 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
142 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
143 #ifdef EXPERIMENTAL_PRDR
144 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
147 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
149 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
150 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
151 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
152 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
153 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
154 #ifdef WITH_CONTENT_SCAN
155 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
157 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
158 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
159 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
160 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
162 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
164 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
165 { "admin_groups", opt_gidlist, &admin_groups },
166 { "allow_domain_literals", opt_bool, &allow_domain_literals },
167 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
168 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
169 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
170 { "auto_thaw", opt_time, &auto_thaw },
171 #ifdef WITH_CONTENT_SCAN
172 { "av_scanner", opt_stringptr, &av_scanner },
174 { "bi_command", opt_stringptr, &bi_command },
175 #ifdef EXPERIMENTAL_BRIGHTMAIL
176 { "bmi_config_file", opt_stringptr, &bmi_config_file },
178 { "bounce_message_file", opt_stringptr, &bounce_message_file },
179 { "bounce_message_text", opt_stringptr, &bounce_message_text },
180 { "bounce_return_body", opt_bool, &bounce_return_body },
181 { "bounce_return_message", opt_bool, &bounce_return_message },
182 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
183 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
184 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
185 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
186 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
187 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
188 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
189 { "check_log_inodes", opt_int, &check_log_inodes },
190 { "check_log_space", opt_Kint, &check_log_space },
191 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
192 { "check_spool_inodes", opt_int, &check_spool_inodes },
193 { "check_spool_space", opt_Kint, &check_spool_space },
194 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
195 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
196 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
197 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
198 #ifdef EXPERIMENTAL_DCC
199 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
200 { "dccifd_address", opt_stringptr, &dccifd_address },
201 { "dccifd_options", opt_stringptr, &dccifd_options },
203 { "delay_warning", opt_timelist, &delay_warning },
204 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
205 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
206 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
207 { "delivery_date_remove", opt_bool, &delivery_date_remove },
208 #ifdef ENABLE_DISABLE_FSYNC
209 { "disable_fsync", opt_bool, &disable_fsync },
211 { "disable_ipv6", opt_bool, &disable_ipv6 },
213 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
215 #ifdef EXPERIMENTAL_DMARC
216 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
217 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
218 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
220 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
221 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
222 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
223 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
224 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
225 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
226 { "dns_retrans", opt_time, &dns_retrans },
227 { "dns_retry", opt_int, &dns_retry },
228 { "dns_use_edns0", opt_int, &dns_use_edns0 },
229 /* This option is now a no-op, retained for compability */
230 { "drop_cr", opt_bool, &drop_cr },
231 /*********************************************************/
232 { "dsn_from", opt_stringptr, &dsn_from },
233 { "envelope_to_remove", opt_bool, &envelope_to_remove },
234 { "errors_copy", opt_stringptr, &errors_copy },
235 { "errors_reply_to", opt_stringptr, &errors_reply_to },
236 { "exim_group", opt_gid, &exim_gid },
237 { "exim_path", opt_stringptr, &exim_path },
238 { "exim_user", opt_uid, &exim_uid },
239 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
240 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
241 { "finduser_retries", opt_int, &finduser_retries },
242 { "freeze_tell", opt_stringptr, &freeze_tell },
243 { "gecos_name", opt_stringptr, &gecos_name },
244 { "gecos_pattern", opt_stringptr, &gecos_pattern },
246 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
247 { "gnutls_enable_pkcs11", opt_bool, &gnutls_enable_pkcs11 },
248 /* These three gnutls_require_* options stopped working in Exim 4.80 */
249 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
250 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
251 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
253 { "header_line_maxsize", opt_int, &header_line_maxsize },
254 { "header_maxsize", opt_int, &header_maxsize },
255 { "headers_charset", opt_stringptr, &headers_charset },
256 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
257 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
258 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
259 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
260 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
261 { "hold_domains", opt_stringptr, &hold_domains },
262 { "host_lookup", opt_stringptr, &host_lookup },
263 { "host_lookup_order", opt_stringptr, &host_lookup_order },
264 { "host_reject_connection", opt_stringptr, &host_reject_connection },
265 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
266 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
268 { "ibase_servers", opt_stringptr, &ibase_servers },
270 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
271 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
272 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
273 { "keep_malformed", opt_time, &keep_malformed },
275 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
276 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
277 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
278 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
279 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
280 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
281 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
282 { "ldap_start_tls", opt_bool, &eldap_start_tls },
283 { "ldap_version", opt_int, &eldap_version },
285 { "local_from_check", opt_bool, &local_from_check },
286 { "local_from_prefix", opt_stringptr, &local_from_prefix },
287 { "local_from_suffix", opt_stringptr, &local_from_suffix },
288 { "local_interfaces", opt_stringptr, &local_interfaces },
289 { "local_scan_timeout", opt_time, &local_scan_timeout },
290 { "local_sender_retain", opt_bool, &local_sender_retain },
291 { "localhost_number", opt_stringptr, &host_number_string },
292 { "log_file_path", opt_stringptr, &log_file_path },
293 { "log_selector", opt_stringptr, &log_selector_string },
294 { "log_timezone", opt_bool, &log_timezone },
295 { "lookup_open_max", opt_int, &lookup_open_max },
296 { "max_username_length", opt_int, &max_username_length },
297 { "message_body_newlines", opt_bool, &message_body_newlines },
298 { "message_body_visible", opt_mkint, &message_body_visible },
299 { "message_id_header_domain", opt_stringptr, &message_id_domain },
300 { "message_id_header_text", opt_stringptr, &message_id_text },
301 { "message_logs", opt_bool, &message_logs },
302 { "message_size_limit", opt_stringptr, &message_size_limit },
303 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
304 { "move_frozen_messages", opt_bool, &move_frozen_messages },
306 { "mua_wrapper", opt_bool, &mua_wrapper },
308 { "mysql_servers", opt_stringptr, &mysql_servers },
310 { "never_users", opt_uidlist, &never_users },
312 { "openssl_options", opt_stringptr, &openssl_options },
315 { "oracle_servers", opt_stringptr, &oracle_servers },
317 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
319 { "perl_at_start", opt_bool, &opt_perl_at_start },
320 { "perl_startup", opt_stringptr, &opt_perl_startup },
323 { "pgsql_servers", opt_stringptr, &pgsql_servers },
325 { "pid_file_path", opt_stringptr, &pid_file_path },
326 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
327 #ifdef EXPERIMENTAL_PRDR
328 { "prdr_enable", opt_bool, &prdr_enable },
330 { "preserve_message_logs", opt_bool, &preserve_message_logs },
331 { "primary_hostname", opt_stringptr, &primary_hostname },
332 { "print_topbitchars", opt_bool, &print_topbitchars },
333 { "process_log_path", opt_stringptr, &process_log_path },
334 { "prod_requires_admin", opt_bool, &prod_requires_admin },
335 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
336 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
337 { "queue_domains", opt_stringptr, &queue_domains },
338 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
339 { "queue_only", opt_bool, &queue_only },
340 { "queue_only_file", opt_stringptr, &queue_only_file },
341 { "queue_only_load", opt_fixed, &queue_only_load },
342 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
343 { "queue_only_override", opt_bool, &queue_only_override },
344 { "queue_run_in_order", opt_bool, &queue_run_in_order },
345 { "queue_run_max", opt_int, &queue_run_max },
346 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
347 { "receive_timeout", opt_time, &receive_timeout },
348 { "received_header_text", opt_stringptr, &received_header_text },
349 { "received_headers_max", opt_int, &received_headers_max },
350 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
351 { "recipients_max", opt_int, &recipients_max },
352 { "recipients_max_reject", opt_bool, &recipients_max_reject },
353 #ifdef EXPERIMENTAL_REDIS
354 { "redis_servers", opt_stringptr, &redis_servers },
356 { "remote_max_parallel", opt_int, &remote_max_parallel },
357 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
358 { "retry_data_expire", opt_time, &retry_data_expire },
359 { "retry_interval_max", opt_time, &retry_interval_max },
360 { "return_path_remove", opt_bool, &return_path_remove },
361 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
362 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
363 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
364 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
365 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
366 { "smtp_accept_max", opt_int, &smtp_accept_max },
367 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
368 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
369 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
370 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
371 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
372 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
373 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
374 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
375 { "smtp_banner", opt_stringptr, &smtp_banner },
376 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
377 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
378 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
379 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
380 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
381 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
382 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
383 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
384 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
385 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
386 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
387 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
388 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
389 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
390 #ifdef WITH_CONTENT_SCAN
391 { "spamd_address", opt_stringptr, &spamd_address },
393 #ifdef EXPERIMENTAL_SPF
394 { "spf_guess", opt_stringptr, &spf_guess },
396 { "split_spool_directory", opt_bool, &split_spool_directory },
397 { "spool_directory", opt_stringptr, &spool_directory },
399 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
401 #ifdef EXPERIMENTAL_SRS
402 { "srs_config", opt_stringptr, &srs_config },
403 { "srs_hashlength", opt_int, &srs_hashlength },
404 { "srs_hashmin", opt_int, &srs_hashmin },
405 { "srs_maxage", opt_int, &srs_maxage },
406 { "srs_secrets", opt_stringptr, &srs_secrets },
407 { "srs_usehash", opt_bool, &srs_usehash },
408 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
410 { "strict_acl_vars", opt_bool, &strict_acl_vars },
411 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
412 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
413 { "syslog_duplication", opt_bool, &syslog_duplication },
414 { "syslog_facility", opt_stringptr, &syslog_facility_str },
415 { "syslog_processname", opt_stringptr, &syslog_processname },
416 { "syslog_timestamp", opt_bool, &syslog_timestamp },
417 { "system_filter", opt_stringptr, &system_filter },
418 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
419 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
420 { "system_filter_group", opt_gid, &system_filter_gid },
421 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
422 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
423 { "system_filter_user", opt_uid, &system_filter_uid },
424 { "tcp_nodelay", opt_bool, &tcp_nodelay },
425 #ifdef USE_TCP_WRAPPERS
426 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
428 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
429 { "timezone", opt_stringptr, &timezone_string },
431 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
432 { "tls_certificate", opt_stringptr, &tls_certificate },
433 { "tls_crl", opt_stringptr, &tls_crl },
434 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
435 { "tls_dhparam", opt_stringptr, &tls_dhparam },
436 # if defined(EXPERIMENTAL_OCSP) && !defined(USE_GNUTLS)
437 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
439 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
440 { "tls_privatekey", opt_stringptr, &tls_privatekey },
441 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
442 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
443 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
444 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
445 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
447 { "trusted_groups", opt_gidlist, &trusted_groups },
448 { "trusted_users", opt_uidlist, &trusted_users },
449 { "unknown_login", opt_stringptr, &unknown_login },
450 { "unknown_username", opt_stringptr, &unknown_username },
451 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
452 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
453 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
454 { "warn_message_file", opt_stringptr, &warn_message_file },
455 { "write_rejectlog", opt_bool, &write_rejectlog }
458 static int optionlist_config_size =
459 sizeof(optionlist_config)/sizeof(optionlist);
463 /*************************************************
464 * Find the name of an option *
465 *************************************************/
467 /* This function is to aid debugging. Various functions take arguments that are
468 pointer variables in the options table or in option tables for various drivers.
469 For debugging output, it is useful to be able to find the name of the option
470 which is currently being processed. This function finds it, if it exists, by
471 searching the table(s).
473 Arguments: a value that is presumed to be in the table above
474 Returns: the option name, or an empty string
478 readconf_find_option(void *p)
482 transport_instance *t;
484 for (i = 0; i < optionlist_config_size; i++)
485 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
487 for (r = routers; r != NULL; r = r->next)
489 router_info *ri = r->info;
490 for (i = 0; i < ri->options_count[0]; i++)
492 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
493 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
494 return US ri->options[i].name;
498 for (t = transports; t != NULL; t = t->next)
500 transport_info *ti = t->info;
501 for (i = 0; i < ti->options_count[0]; i++)
503 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
504 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
505 return US ti->options[i].name;
515 /*************************************************
516 * Deal with an assignment to a macro *
517 *************************************************/
519 /* This function is called when a line that starts with an upper case letter is
520 encountered. The argument "line" should contain a complete logical line, and
521 start with the first letter of the macro name. The macro name and the
522 replacement text are extracted and stored. Redefinition of existing,
523 non-command line, macros is permitted using '==' instead of '='.
526 s points to the start of the logical line
532 read_macro_assignment(uschar *s)
538 macro_item *mlast = NULL;
540 while (isalnum(*s) || *s == '_')
542 if (namelen >= sizeof(name) - 1)
543 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
544 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
545 name[namelen++] = *s++;
549 while (isspace(*s)) s++;
551 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
558 while (isspace(*s)) s++;
560 /* If an existing macro of the same name was defined on the command line, we
561 just skip this definition. It's an error to attempt to redefine a macro without
562 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
563 It is also an error to define a macro whose name begins with the name of a
564 previously defined macro. Note: it is documented that the other way round
567 for (m = macros; m != NULL; m = m->next)
569 int len = Ustrlen(m->name);
571 if (Ustrcmp(m->name, name) == 0)
573 if (!m->command_line && !redef)
574 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
575 "defined (use \"==\" if you want to redefine it", name);
579 if (len < namelen && Ustrstr(name, m->name) != NULL)
580 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
581 "a macro because previously defined macro \"%s\" is a substring",
584 /* We cannot have this test, because it is documented that a substring
585 macro is permitted (there is even an example).
587 * if (len > namelen && Ustrstr(m->name, name) != NULL)
588 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
589 * "a macro because it is a substring of previously defined macro \"%s\"",
596 /* Check for an overriding command-line definition. */
598 if (m != NULL && m->command_line) return;
600 /* Redefinition must refer to an existing macro. */
605 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
609 /* We have a new definition. The macro_item structure includes a final vector
610 called "name" which is one byte long. Thus, adding "namelen" gives us enough
611 room to store the "name" string. */
615 m = store_get(sizeof(macro_item) + namelen);
616 if (macros == NULL) macros = m; else mlast->next = m;
617 Ustrncpy(m->name, name, namelen);
618 m->name[namelen] = 0;
620 m->command_line = FALSE;
623 /* Set the value of the new or redefined macro */
625 m->replacement = string_copy(s);
632 /*************************************************
633 * Read configuration line *
634 *************************************************/
636 /* A logical line of text is read from the configuration file into the big
637 buffer, taking account of macros, .includes, and continuations. The size of
638 big_buffer is increased if necessary. The count of configuration lines is
639 maintained. Physical input lines starting with # (ignoring leading white space,
640 and after macro replacement) and empty logical lines are always ignored.
641 Leading and trailing spaces are removed.
643 If we hit a line of the form "begin xxxx", the xxxx is placed in the
644 next_section vector, and the function returns NULL, indicating the end of a
645 configuration section. On end-of-file, NULL is returned with next_section
650 Returns: a pointer to the first non-blank in the line,
651 or NULL if eof or end of section is reached
655 get_config_line(void)
657 int startoffset = 0; /* To first non-blank char in logical line */
658 int len = 0; /* Of logical line so far */
664 /* Loop for handling continuation lines, skipping comments, and dealing with
669 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
671 if (config_file_stack != NULL) /* EOF inside .include */
673 (void)fclose(config_file);
674 config_file = config_file_stack->file;
675 config_filename = config_file_stack->filename;
676 config_lineno = config_file_stack->lineno;
677 config_file_stack = config_file_stack->next;
681 /* EOF at top level */
683 if (cstate_stack_ptr >= 0)
684 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
685 "Unexpected end of configuration file: .endif missing");
687 if (len != 0) break; /* EOF after continuation */
688 next_section[0] = 0; /* EOF at start of logical line */
693 newlen = len + Ustrlen(big_buffer + len);
695 /* Handle pathologically long physical lines - yes, it did happen - by
696 extending big_buffer at this point. The code also copes with very long
699 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
702 big_buffer_size += BIG_BUFFER_SIZE;
703 newbuffer = store_malloc(big_buffer_size);
705 /* This use of strcpy is OK because we know that the string in the old
706 buffer is shorter than the new buffer. */
708 Ustrcpy(newbuffer, big_buffer);
709 store_free(big_buffer);
710 big_buffer = newbuffer;
711 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
713 newlen += Ustrlen(big_buffer + newlen);
716 /* Find the true start of the physical line - leading spaces are always
719 ss = big_buffer + len;
720 while (isspace(*ss)) ss++;
722 /* Process the physical line for macros. If this is the start of the logical
723 line, skip over initial text at the start of the line if it starts with an
724 upper case character followed by a sequence of name characters and an equals
725 sign, because that is the definition of a new macro, and we don't do
726 replacement therein. */
729 if (len == 0 && isupper(*s))
731 while (isalnum(*s) || *s == '_') s++;
732 while (isspace(*s)) s++;
733 if (*s != '=') s = ss; /* Not a macro definition */
736 /* For each defined macro, scan the line (from after XXX= if present),
737 replacing all occurrences of the macro. */
740 for (m = macros; m != NULL; m = m->next)
745 while ((p = Ustrstr(t, m->name)) != NULL)
748 int namelen = Ustrlen(m->name);
749 int replen = Ustrlen(m->replacement);
751 /* Expand the buffer if necessary */
753 while (newlen - namelen + replen + 1 > big_buffer_size)
755 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
756 uschar *newbuffer = store_malloc(newsize);
757 memcpy(newbuffer, big_buffer, newlen + 1);
758 p = newbuffer + (p - big_buffer);
759 s = newbuffer + (s - big_buffer);
760 ss = newbuffer + (ss - big_buffer);
761 t = newbuffer + (t - big_buffer);
762 big_buffer_size = newsize;
763 store_free(big_buffer);
764 big_buffer = newbuffer;
767 /* Shuffle the remaining characters up or down in the buffer before
768 copying in the replacement text. Don't rescan the replacement for this
772 moveby = replen - namelen;
775 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
778 Ustrncpy(p, m->replacement, replen);
784 /* An empty macro replacement at the start of a line could mean that ss no
785 longer points to the first non-blank character. */
787 while (isspace(*ss)) ss++;
789 /* Check for comment lines - these are physical lines. */
791 if (*ss == '#') continue;
793 /* Handle conditionals, which are also applied to physical lines. Conditions
794 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
795 expansion occured on the rest of the line. A preliminary test for the leading
796 '.' saves effort on most lines. */
802 /* Search the list of conditional directives */
804 for (i = 0; i < cond_list_size; i++)
807 cond_item *c = cond_list+i;
808 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
810 /* The following character must be white space or end of string */
812 n = ss[1 + c->namelen];
813 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
815 /* .ifdef and .ifndef push the current state onto the stack, then set
816 a new one from the table. Stack overflow is an error */
820 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
821 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
822 ".%s nested too deeply", c->name);
823 cstate_stack[++cstate_stack_ptr] = cstate;
824 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
827 /* For any of the others, stack underflow is an error. The next state
828 comes either from the stack (.endif) or from the table. */
832 if (cstate_stack_ptr < 0)
833 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
834 ".%s without matching .ifdef", c->name);
835 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
836 next_cstate[cstate][macro_found? c->action1 : c->action2];
839 /* Having dealt with a directive, break the loop */
844 /* If we have handled a conditional directive, continue with the next
845 physical line. Otherwise, fall through. */
847 if (i < cond_list_size) continue;
850 /* If the conditional state is not 0 (actively using these lines), ignore
853 if (cstate != 0) continue; /* Conditional skip */
855 /* Handle .include lines - these are also physical lines. */
857 if (Ustrncmp(ss, ".include", 8) == 0 &&
859 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
862 int include_if_exists = isspace(ss[8])? 0 : 10;
863 config_file_item *save;
866 ss += 9 + include_if_exists;
867 while (isspace(*ss)) ss++;
868 t = ss + Ustrlen(ss);
869 while (t > ss && isspace(t[-1])) t--;
870 if (*ss == '\"' && t[-1] == '\"')
878 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
879 "absolute path \"%s\"", ss);
881 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
883 save = store_get(sizeof(config_file_item));
884 save->next = config_file_stack;
885 config_file_stack = save;
886 save->file = config_file;
887 save->filename = config_filename;
888 save->lineno = config_lineno;
890 config_file = Ufopen(ss, "rb");
891 if (config_file == NULL)
892 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
893 "configuration file %s", ss);
894 config_filename = string_copy(ss);
899 /* If this is the start of the logical line, remember where the non-blank
900 data starts. Otherwise shuffle down continuation lines to remove leading
904 startoffset = ss - big_buffer;
907 s = big_buffer + len;
910 memmove(s, ss, (newlen - len) - (ss - s) + 1);
915 /* Accept the new addition to the line. Remove trailing white space. */
918 while (len > 0 && isspace(big_buffer[len-1])) len--;
921 /* We are done if the line does not end in backslash and contains some data.
922 Empty logical lines are ignored. For continuations, remove the backslash and
923 go round the loop to read the continuation line. */
927 if (big_buffer[len-1] != '\\') break; /* End of logical line */
928 big_buffer[--len] = 0; /* Remove backslash */
930 } /* Loop for reading multiple physical lines */
932 /* We now have a logical line. Test for the end of a configuration section (or,
933 more accurately, for the start of the next section). Place the name of the next
934 section in next_section, and return NULL. If the name given is longer than
935 next_section, truncate it. It will be unrecognized later, because all the known
936 section names do fit. Leave space for pluralizing. */
938 s = big_buffer + startoffset; /* First non-space character */
939 if (strncmpic(s, US"begin ", 6) == 0)
942 while (isspace(*s)) s++;
943 if (big_buffer + len - s > sizeof(next_section) - 2)
944 s[sizeof(next_section) - 2] = 0;
945 Ustrcpy(next_section, s);
949 /* Return the first non-blank character. */
956 /*************************************************
958 *************************************************/
960 /* The yield is the pointer to the next uschar. Names longer than the
961 output space are silently truncated. This function is also used from acl.c when
965 name where to put the name
969 Returns: new input pointer
973 readconf_readname(uschar *name, int len, uschar *s)
976 while (isspace(*s)) s++;
979 while (isalnum(*s) || *s == '_')
981 if (p < len-1) name[p++] = *s;
986 while (isspace(*s)) s++;
993 /*************************************************
994 * Read a time value *
995 *************************************************/
997 /* This function is also called from outside, to read argument
998 time values. The format of a time value is:
1000 [<n>w][<n>d][<n>h][<n>m][<n>s]
1002 as long as at least one is present. If a format error is encountered,
1003 return a negative value. The value must be terminated by the given
1008 terminator required terminating character
1009 return_msec if TRUE, allow fractional seconds and return milliseconds
1011 Returns: the time value, or -1 on syntax error
1012 value is seconds if return_msec is FALSE
1013 value is milliseconds if return_msec is TRUE
1017 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
1025 if (!isdigit(*s)) return -1;
1026 (void)sscanf(CS s, "%d%n", &value, &count);
1031 case 'w': value *= 7;
1032 case 'd': value *= 24;
1033 case 'h': value *= 60;
1034 case 'm': value *= 60;
1039 if (!return_msec) return -1;
1040 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1042 if (*s++ != 's') return -1;
1043 yield += (int)(fraction * 1000.0);
1049 if (return_msec) value *= 1000;
1051 if (*s == terminator) return yield;
1053 /* Control never reaches here. */
1058 /*************************************************
1059 * Read a fixed point value *
1060 *************************************************/
1062 /* The value is returned *1000
1066 terminator required terminator
1068 Returns: the value, or -1 on error
1072 readconf_readfixed(uschar *s, int terminator)
1076 if (!isdigit(*s)) return -1;
1077 (void)sscanf(CS s, "%d%n", &value, &count);
1079 yield = value * 1000;
1083 while (isdigit((*(++s))))
1085 yield += (*s - '0') * m;
1090 return (*s == terminator)? yield : (-1);
1095 /*************************************************
1096 * Find option in list *
1097 *************************************************/
1099 /* The lists are always in order, so binary chop can be used.
1102 name the option name to search for
1103 ol the first entry in the option list
1104 last one more than the offset of the last entry in the option list
1106 Returns: pointer to an option entry, or NULL if not found
1110 find_option(uschar *name, optionlist *ol, int last)
1113 while (last > first)
1115 int middle = (first + last)/2;
1116 int c = Ustrcmp(name, ol[middle].name);
1117 if (c == 0) return ol + middle;
1118 else if (c > 0) first = middle + 1;
1126 /*************************************************
1127 * Find a set flag in option list *
1128 *************************************************/
1130 /* Because some versions of Unix make no restrictions on the values of uids and
1131 gids (even negative ones), we cannot represent "unset" by a special value.
1132 There is therefore a separate boolean variable for each one indicating whether
1133 a value is set or not. This function returns a pointer to the boolean, given
1134 the original option name. It is a major disaster if the flag cannot be found.
1137 name the name of the uid or gid option
1138 oltop points to the start of the relevant option list
1139 last one more than the offset of the last item in the option list
1140 data_block NULL when reading main options => data values in the option
1141 list are absolute addresses; otherwise they are byte offsets
1142 in data_block (used for driver options)
1144 Returns: a pointer to the boolean flag.
1148 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1152 sprintf(CS name2, "*set_%.50s", name);
1153 ol = find_option(name2, oltop, last);
1154 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1155 "Exim internal error: missing set flag for %s", name);
1156 return (data_block == NULL)? (BOOL *)(ol->value) :
1157 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1163 /*************************************************
1164 * Output extra characters message and die *
1165 *************************************************/
1167 /* Called when an option line has junk on the end. Sometimes this is because
1168 the sysadmin thinks comments are permitted.
1171 s points to the extra characters
1172 t1..t3 strings to insert in the log message
1174 Returns: doesn't return; dies
1178 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1180 uschar *comment = US"";
1181 if (*s == '#') comment = US" (# is comment only at line start)";
1182 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1183 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1188 /*************************************************
1189 * Read rewrite information *
1190 *************************************************/
1192 /* Each line of rewrite information contains:
1194 . A complete address in the form user@domain, possibly with
1195 leading * for each part; or alternatively, a regex.
1197 . A replacement string (which will be expanded).
1199 . An optional sequence of one-letter flags, indicating which
1200 headers etc. to apply this rule to.
1202 All this is decoded and placed into a control block. The OR of the flags is
1203 maintained in a common word.
1206 p points to the string that makes up the rule
1207 existflags points to the overall flag word
1208 isglobal TRUE if reading global rewrite rules
1210 Returns: the control block for the parsed rule.
1213 static rewrite_rule *
1214 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1216 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1219 next->key = string_dequote(&p);
1221 while (isspace(*p)) p++;
1223 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1224 "missing rewrite replacement string");
1227 next->replacement = string_dequote(&p);
1229 while (*p != 0) switch (*p++)
1231 case ' ': case '\t': break;
1233 case 'q': next->flags |= rewrite_quit; break;
1234 case 'w': next->flags |= rewrite_whole; break;
1236 case 'h': next->flags |= rewrite_all_headers; break;
1237 case 's': next->flags |= rewrite_sender; break;
1238 case 'f': next->flags |= rewrite_from; break;
1239 case 't': next->flags |= rewrite_to; break;
1240 case 'c': next->flags |= rewrite_cc; break;
1241 case 'b': next->flags |= rewrite_bcc; break;
1242 case 'r': next->flags |= rewrite_replyto; break;
1244 case 'E': next->flags |= rewrite_all_envelope; break;
1245 case 'F': next->flags |= rewrite_envfrom; break;
1246 case 'T': next->flags |= rewrite_envto; break;
1248 case 'Q': next->flags |= rewrite_qualify; break;
1249 case 'R': next->flags |= rewrite_repeat; break;
1252 next->flags |= rewrite_smtp;
1253 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1254 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1255 "rewrite rule has the S flag but is not a regular expression");
1259 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1260 "unknown rewrite flag character '%c' "
1261 "(could be missing quotes round replacement item)", p[-1]);
1265 /* If no action flags are set, set all the "normal" rewrites. */
1267 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1268 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1270 /* Remember which exist, for optimization, and return the rule */
1272 *existflags |= next->flags;
1279 /*************************************************
1280 * Read global rewrite information *
1281 *************************************************/
1283 /* Each line is a single rewrite rule; it is parsed into a control block
1284 by readconf_one_rewrite(), and its flags are ORed into the global flag
1285 word rewrite_existflags. */
1288 readconf_rewrites(void)
1290 rewrite_rule **chain = &global_rewrite_rules;
1293 while ((p = get_config_line()) != NULL)
1295 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1297 chain = &(next->next);
1303 /*************************************************
1305 *************************************************/
1307 /* Strings are read into the normal store pool. As long we aren't too
1308 near the end of the current block, the string will just use what is necessary
1309 on the top of the stacking pool, because string_cat() uses the extension
1313 s the rest of the input line
1314 name the option name (for errors)
1316 Returns: pointer to the string
1320 read_string(uschar *s, uschar *name)
1325 if (*s != '\"') return string_copy(s);
1328 yield = string_dequote(&s);
1330 if (s == ss+1 || s[-1] != '\"')
1331 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1332 "missing quote at end of string value for %s", name);
1334 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1340 /*************************************************
1341 * Handle option line *
1342 *************************************************/
1344 /* This function is called from several places to process a line containing the
1345 setting of an option. The first argument is the line to be decoded; it has been
1346 checked not to be empty and not to start with '#'. Trailing newlines and white
1347 space have been removed. The second argument is a pointer to the list of
1348 variable names that are to be recognized, together with their types and
1349 locations, and the third argument gives the number of entries in the list.
1351 The fourth argument is a pointer to a data block. If it is NULL, then the data
1352 values in the options list are absolute addresses. Otherwise, they are byte
1353 offsets in the data block.
1355 String option data may continue onto several lines; this function reads further
1356 data from config_file if necessary.
1358 The yield of this function is normally zero. If a string continues onto
1359 multiple lines, then the data value is permitted to be followed by a comma
1360 or a semicolon (for use in drivers) and the yield is that character.
1363 buffer contains the configuration line to be handled
1364 oltop points to the start of the relevant option list
1365 last one more than the offset of the last item in the option list
1366 data_block NULL when reading main options => data values in the option
1367 list are absolute addresses; otherwise they are byte offsets
1368 in data_block when they have opt_public set; otherwise
1369 they are byte offsets in data_block->options_block.
1370 unknown_txt format string to use in panic message for unknown option;
1371 must contain %s for option name
1372 if given as NULL, don't panic on unknown option
1374 Returns: TRUE if an option was read successfully,
1375 FALSE false for an unknown option if unknown_txt == NULL,
1376 otherwise panic and die on an unknown option
1380 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1381 void *data_block, uschar *unknown_txt)
1385 int n, count, type, value;
1389 BOOL boolvalue = TRUE;
1390 BOOL freesptr = TRUE;
1391 optionlist *ol, *ol2;
1395 uschar *inttype = US"";
1398 uschar *saved_condition, *strtemp;
1399 uschar **str_target;
1403 /* There may be leading spaces; thereafter, we expect an option name starting
1406 while (isspace(*s)) s++;
1408 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1410 /* Read the name of the option, and skip any subsequent white space. If
1411 it turns out that what we read was "hide", set the flag indicating that
1412 this is a secure option, and loop to read the next word. */
1414 for (n = 0; n < 2; n++)
1416 while (isalnum(*s) || *s == '_')
1418 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1422 while (isspace(*s)) s++;
1423 if (Ustrcmp(name, "hide") != 0) break;
1424 issecure = opt_secure;
1428 /* Deal with "no_" or "not_" here for booleans */
1430 if (Ustrncmp(name, "no_", 3) == 0)
1436 if (Ustrncmp(name, "not_", 4) == 0)
1442 /* Search the list for the given name. A non-existent name, or an option that
1443 is set twice, is a disaster. */
1445 ol = find_option(name + offset, oltop, last);
1449 if (unknown_txt == NULL) return FALSE;
1450 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1453 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1454 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1455 "\"%s\" option set for the second time", name);
1457 ol->type |= opt_set | issecure;
1458 type = ol->type & opt_mask;
1460 /* Types with data values must be followed by '='; the "no[t]_" prefix
1461 applies only to boolean values. */
1463 if (type < opt_bool || type > opt_bool_last)
1466 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1467 "negation prefix applied to a non-boolean option");
1469 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1470 "unexpected end of line (data missing) after %s", name);
1472 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1475 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1476 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1477 ultimately expands to one of those values. */
1479 else if (*s != 0 && (offset != 0 || *s != '='))
1480 extra_chars_error(s, US"boolean option ", name, US"");
1482 /* Skip white space after = */
1484 if (*s == '=') while (isspace((*(++s))));
1486 /* If there is a data block and the opt_public flag is not set, change
1487 the data block pointer to the private options block. */
1489 if (data_block != NULL && (ol->type & opt_public) == 0)
1490 data_block = (void *)(((driver_instance *)data_block)->options_block);
1492 /* Now get the data according to the type. */
1496 /* If a string value is not enclosed in quotes, it consists of
1497 the rest of the current line, verbatim. Otherwise, string escapes
1500 A transport is specified as a string, which is then looked up in the
1501 list of transports. A search type is specified as one of a number of
1504 A set or rewrite rules for a driver is specified as a string, which is
1505 then parsed into a suitable chain of control blocks.
1507 Uids and gids are specified as strings which are then looked up in the
1508 passwd file. Lists of uids and gids are similarly specified as colon-
1509 separated strings. */
1514 case opt_expand_uid:
1515 case opt_expand_gid:
1520 reset_point = sptr = read_string(s, name);
1522 /* Having read a string, we now have several different ways of using it,
1523 depending on the data type, so do another switch. If keeping the actual
1524 string is not required (because it is interpreted), freesptr is set TRUE,
1525 and at the end we reset the pool. */
1529 /* If this was a string, set the variable to point to the new string,
1530 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1531 rules, we still keep the string (for printing), and parse the rules into a
1532 control block and flags word. */
1535 if (data_block == NULL)
1536 str_target = (uschar **)(ol->value);
1538 str_target = (uschar **)((uschar *)data_block + (long int)(ol->value));
1539 if (ol->type & opt_rep_con)
1541 /* We already have a condition, we're conducting a crude hack to let
1542 multiple condition rules be chained together, despite storing them in
1544 saved_condition = *str_target;
1545 strtemp = string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1546 saved_condition, sptr);
1547 *str_target = string_copy_malloc(strtemp);
1548 /* TODO(pdp): there is a memory leak here and just below
1549 when we set 3 or more conditions; I still don't
1550 understand the store mechanism enough to know
1551 what's the safe way to free content from an earlier store.
1552 AFAICT, stores stack, so freeing an early stored item also stores
1553 all data alloc'd after it. If we knew conditions were adjacent,
1554 we could survive that, but we don't. So I *think* we need to take
1555 another bit from opt_type to indicate "malloced"; this seems like
1556 quite a hack, especially for this one case. It also means that
1557 we can't ever reclaim the store from the *first* condition.
1559 Because we only do this once, near process start-up, I'm prepared to
1560 let this slide for the time being, even though it rankles. */
1562 else if (*str_target && (ol->type & opt_rep_str))
1564 uschar sep = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1565 saved_condition = *str_target;
1566 strtemp = saved_condition + Ustrlen(saved_condition)-1;
1567 if (*strtemp == sep) *strtemp = 0; /* eliminate trailing list-sep */
1568 strtemp = string_sprintf("%s%c%s", saved_condition, sep, sptr);
1569 *str_target = string_copy_malloc(strtemp);
1579 if (data_block == NULL)
1580 *((uschar **)(ol->value)) = sptr;
1582 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1584 if (type == opt_rewrite)
1589 rewrite_rule **chain;
1592 sprintf(CS name2, "*%.50s_rules", name);
1593 ol2 = find_option(name2, oltop, last);
1594 sprintf(CS name2, "*%.50s_flags", name);
1595 ol3 = find_option(name2, oltop, last);
1597 if (ol2 == NULL || ol3 == NULL)
1598 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1599 "rewrite rules not available for driver");
1601 if (data_block == NULL)
1603 chain = (rewrite_rule **)(ol2->value);
1604 flagptr = (int *)(ol3->value);
1608 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1609 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1612 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1615 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1617 chain = &(next->next);
1620 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1621 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1622 "non-header rewrite - not allowed at transport time -");
1626 /* If it was an expanded uid, see if there is any expansion to be
1627 done by checking for the presence of a $ character. If there is, save it
1628 in the corresponding *expand_user option field. Otherwise, fall through
1629 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1632 case opt_expand_uid:
1633 sprintf(CS name2, "*expand_%.50s", name);
1634 ol2 = find_option(name2, oltop, last);
1637 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1639 if (data_block == NULL)
1640 *((uschar **)(ol2->value)) = ss;
1642 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1646 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1652 /* Look up a fixed uid, and also make use of the corresponding gid
1653 if a passwd entry is returned and the gid has not been set. */
1656 if (!route_finduser(sptr, &pw, &uid))
1657 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1658 if (data_block == NULL)
1659 *((uid_t *)(ol->value)) = uid;
1661 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1663 /* Set the flag indicating a fixed value is set */
1665 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1667 /* Handle matching gid if we have a passwd entry: done by finding the
1668 same name with terminating "user" changed to "group"; if not found,
1669 ignore. Also ignore if the value is already set. */
1671 if (pw == NULL) break;
1672 Ustrcpy(name+Ustrlen(name)-4, "group");
1673 ol2 = find_option(name, oltop, last);
1674 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1675 (ol2->type & opt_mask) == opt_expand_gid))
1677 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1680 if (data_block == NULL)
1681 *((gid_t *)(ol2->value)) = pw->pw_gid;
1683 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1689 /* If it was an expanded gid, see if there is any expansion to be
1690 done by checking for the presence of a $ character. If there is, save it
1691 in the corresponding *expand_user option field. Otherwise, fall through
1692 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1695 case opt_expand_gid:
1696 sprintf(CS name2, "*expand_%.50s", name);
1697 ol2 = find_option(name2, oltop, last);
1700 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1702 if (data_block == NULL)
1703 *((uschar **)(ol2->value)) = ss;
1705 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1709 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1715 /* Handle freestanding gid */
1718 if (!route_findgroup(sptr, &gid))
1719 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1720 if (data_block == NULL)
1721 *((gid_t *)(ol->value)) = gid;
1723 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1724 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1727 /* If it was a uid list, look up each individual entry, and build
1728 a vector of uids, with a count in the first element. Put the vector
1729 in malloc store so we can free the string. (We are reading into
1730 permanent store already.) */
1738 uschar *op = expand_string (sptr);
1741 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1742 name, expand_string_message);
1745 if (*p != 0) count++;
1746 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1747 list = store_malloc(count*sizeof(uid_t));
1748 list[ptr++] = (uid_t)(count - 1);
1750 if (data_block == NULL)
1751 *((uid_t **)(ol->value)) = list;
1753 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1759 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1760 if (!route_finduser(big_buffer, NULL, &uid))
1761 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1768 /* If it was a gid list, look up each individual entry, and build
1769 a vector of gids, with a count in the first element. Put the vector
1770 in malloc store so we can free the string. (We are reading into permanent
1779 uschar *op = expand_string (sptr);
1782 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1783 name, expand_string_message);
1786 if (*p != 0) count++;
1787 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1788 list = store_malloc(count*sizeof(gid_t));
1789 list[ptr++] = (gid_t)(count - 1);
1791 if (data_block == NULL)
1792 *((gid_t **)(ol->value)) = list;
1794 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1800 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1801 if (!route_findgroup(big_buffer, &gid))
1802 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1810 /* Release store if the value of the string doesn't need to be kept. */
1812 if (freesptr) store_reset(reset_point);
1815 /* Expanded boolean: if no characters follow, or if there are no dollar
1816 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1817 save the string for later expansion in the alternate place. */
1819 case opt_expand_bool:
1820 if (*s != 0 && Ustrchr(s, '$') != 0)
1822 sprintf(CS name2, "*expand_%.50s", name);
1823 ol2 = find_option(name2, oltop, last);
1826 reset_point = sptr = read_string(s, name);
1827 if (data_block == NULL)
1828 *((uschar **)(ol2->value)) = sptr;
1830 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1837 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1838 look for yes/not/true/false. Some booleans are stored in a single bit in
1839 a single int. There's a special fudge for verify settings; without a suffix
1840 they set both xx_sender and xx_recipient. The table points to the sender
1841 value; search subsequently for the recipient. There's another special case:
1842 opt_bool_set also notes when a boolean has been set. */
1846 case opt_bool_verify:
1850 s = readconf_readname(name2, 64, s);
1851 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1853 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1855 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1856 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1857 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1858 US"for boolean option ", name);
1861 /* Handle single-bit type. */
1863 if (type == opt_bit)
1865 int bit = 1 << ((ol->type >> 16) & 31);
1866 int *ptr = (data_block == NULL)?
1867 (int *)(ol->value) :
1868 (int *)((uschar *)data_block + (long int)ol->value);
1869 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1873 /* Handle full BOOL types */
1875 if (data_block == NULL)
1876 *((BOOL *)(ol->value)) = boolvalue;
1878 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1882 if (type == opt_bool_verify)
1884 sprintf(CS name2, "%.50s_recipient", name + offset);
1885 ol2 = find_option(name2, oltop, last);
1888 if (data_block == NULL)
1889 *((BOOL *)(ol2->value)) = boolvalue;
1891 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1895 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1897 else if (type == opt_bool_set)
1899 sprintf(CS name2, "*set_%.50s", name + offset);
1900 ol2 = find_option(name2, oltop, last);
1903 if (data_block == NULL)
1904 *((BOOL *)(ol2->value)) = TRUE;
1906 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1915 inttype = US"octal ";
1917 /* Integer: a simple(ish) case; allow octal and hex formats, and
1918 suffixes K and M. The different types affect output, not input. */
1927 lvalue = strtol(CS s, CSS &endptr, intbase);
1930 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1933 if (errno != ERANGE)
1935 if (tolower(*endptr) == 'k')
1937 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1938 else lvalue *= 1024;
1941 else if (tolower(*endptr) == 'm')
1943 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1945 else lvalue *= 1024*1024;
1950 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1951 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1952 "absolute value of integer \"%s\" is too large (overflow)", s);
1954 while (isspace(*endptr)) endptr++;
1956 extra_chars_error(endptr, inttype, US"integer value for ", name);
1958 value = (int)lvalue;
1961 if (data_block == NULL)
1962 *((int *)(ol->value)) = value;
1964 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1967 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1974 value = strtol(CS s, CSS &endptr, intbase);
1977 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1980 if (errno != ERANGE)
1982 if (tolower(*endptr) == 'm')
1984 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1988 else if (tolower(*endptr) == 'k')
1994 value = (value + 512)/1024;
1998 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1999 "absolute value of integer \"%s\" is too large (overflow)", s);
2001 while (isspace(*endptr)) endptr++;
2003 extra_chars_error(endptr, inttype, US"integer value for ", name);
2006 if (data_block == NULL)
2007 *((int *)(ol->value)) = value;
2009 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2012 /* Fixed-point number: held to 3 decimal places. */
2015 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2016 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2017 "fixed-point number expected for %s", name);
2019 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2020 "integer \"%s\" is too large (overflow)", s);
2024 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2025 "integer \"%s\" is too large (overflow)", s);
2027 if (s[count] == '.')
2030 while (isdigit(s[++count]))
2032 value += (s[count] - '0') * d;
2037 while (isspace(s[count])) count++;
2040 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2042 if (data_block == NULL)
2043 *((int *)(ol->value)) = value;
2045 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2048 /* There's a special routine to read time values. */
2051 value = readconf_readtime(s, 0, FALSE);
2053 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2055 if (data_block == NULL)
2056 *((int *)(ol->value)) = value;
2058 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2061 /* A time list is a list of colon-separated times, with the first
2062 element holding the size of the list and the second the number of
2068 int *list = (data_block == NULL)?
2069 (int *)(ol->value) :
2070 (int *)((uschar *)data_block + (long int)(ol->value));
2072 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2075 uschar *snext = Ustrchr(s, ':');
2079 while (ss > s && isspace(ss[-1])) ss--;
2082 value = readconf_readtime(s, terminator, FALSE);
2084 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2086 if (count > 1 && value <= list[count])
2087 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2088 "time value out of order for %s", name);
2089 list[count+1] = value;
2090 if (snext == NULL) break;
2092 while (isspace(*s)) s++;
2095 if (count > list[0] - 2)
2096 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2098 if (count > 0 && list[2] == 0) count = 0;
2110 /*************************************************
2111 * Print a time value *
2112 *************************************************/
2115 Argument: a time value in seconds
2116 Returns: pointer to a fixed buffer containing the time as a string,
2117 in readconf_readtime() format
2121 readconf_printtime(int t)
2124 uschar *p = time_buffer;
2141 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2142 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2143 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2144 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2145 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2152 /*************************************************
2153 * Print an individual option value *
2154 *************************************************/
2156 /* This is used by the -bP option, so prints to the standard output.
2157 The entire options list is passed in as an argument, because some options come
2158 in pairs - typically uid/gid settings, which can either be explicit numerical
2159 values, or strings to be expanded later. If the numerical value is unset,
2160 search for "*expand_<name>" to see if there is a string equivalent.
2163 ol option entry, or NULL for an unknown option
2165 options_block NULL for main configuration options; otherwise points to
2166 a driver block; if the option doesn't have opt_public
2167 set, then options_block->options_block is where the item
2169 oltop points to the option list in which ol exists
2170 last one more than the offset of the last entry in optop
2171 no_labels do not show "foo = " at the start.
2177 print_ol(optionlist *ol, uschar *name, void *options_block,
2178 optionlist *oltop, int last, BOOL no_labels)
2191 printf("%s is not a known option\n", name);
2195 /* Non-admin callers cannot see options that have been flagged secure by the
2198 if (!admin_user && (ol->type & opt_secure) != 0)
2200 const char * const hidden = "<value not displayable>";
2202 printf("%s\n", hidden);
2204 printf("%s = %s\n", name, hidden);
2208 /* Else show the value of the option */
2211 if (options_block != NULL)
2213 if ((ol->type & opt_public) == 0)
2214 options_block = (void *)(((driver_instance *)options_block)->options_block);
2215 value = (void *)((uschar *)options_block + (long int)value);
2218 switch(ol->type & opt_mask)
2221 case opt_rewrite: /* Show the text value */
2222 s = *((uschar **)value);
2223 if (!no_labels) printf("%s = ", name);
2224 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2228 if (!no_labels) printf("%s = ", name);
2229 printf("%d\n", *((int *)value));
2234 int x = *((int *)value);
2235 if (x != 0 && (x & 1023) == 0)
2239 if ((x & 1023) == 0)
2244 if (!no_labels) printf("%s = ", name);
2245 printf("%d%c\n", x, c);
2249 if (!no_labels) printf("%s = ", name);
2257 int x = *((int *)value);
2258 if (!no_labels) printf("%s = ", name);
2259 if (x == 0) printf("0\n");
2260 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2261 else printf("%dK\n", x);
2266 if (!no_labels) printf("%s = ", name);
2267 printf("%#o\n", *((int *)value));
2270 /* Can be negative only when "unset", in which case integer */
2274 int x = *((int *)value);
2277 if (x < 0) printf("%s =\n", name); else
2279 if (!no_labels) printf("%s = ", name);
2280 printf("%d.", x/1000);
2293 /* If the numerical value is unset, try for the string value */
2295 case opt_expand_uid:
2296 if (! *get_set_flag(name, oltop, last, options_block))
2298 sprintf(CS name2, "*expand_%.50s", name);
2299 ol2 = find_option(name2, oltop, last);
2302 void *value2 = ol2->value;
2303 if (options_block != NULL)
2304 value2 = (void *)((uschar *)options_block + (long int)value2);
2305 s = *((uschar **)value2);
2306 if (!no_labels) printf("%s = ", name);
2307 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2312 /* Else fall through */
2315 if (!no_labels) printf("%s = ", name);
2316 if (! *get_set_flag(name, oltop, last, options_block))
2320 pw = getpwuid(*((uid_t *)value));
2322 printf("%ld\n", (long int)(*((uid_t *)value)));
2323 else printf("%s\n", pw->pw_name);
2327 /* If the numerical value is unset, try for the string value */
2329 case opt_expand_gid:
2330 if (! *get_set_flag(name, oltop, last, options_block))
2332 sprintf(CS name2, "*expand_%.50s", name);
2333 ol2 = find_option(name2, oltop, last);
2334 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2336 void *value2 = ol2->value;
2337 if (options_block != NULL)
2338 value2 = (void *)((uschar *)options_block + (long int)value2);
2339 s = *((uschar **)value2);
2340 if (!no_labels) printf("%s = ", name);
2341 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2346 /* Else fall through */
2349 if (!no_labels) printf("%s = ", name);
2350 if (! *get_set_flag(name, oltop, last, options_block))
2354 gr = getgrgid(*((int *)value));
2356 printf("%ld\n", (long int)(*((int *)value)));
2357 else printf("%s\n", gr->gr_name);
2362 uidlist = *((uid_t **)value);
2363 if (!no_labels) printf("%s =", name);
2364 if (uidlist != NULL)
2368 if (no_labels) sep = '\0';
2369 for (i = 1; i <= (int)(uidlist[0]); i++)
2371 uschar *name = NULL;
2372 pw = getpwuid(uidlist[i]);
2373 if (pw != NULL) name = US pw->pw_name;
2374 if (sep != '\0') printf("%c", sep);
2375 if (name != NULL) printf("%s", name);
2376 else printf("%ld", (long int)(uidlist[i]));
2384 gidlist = *((gid_t **)value);
2385 if (!no_labels) printf("%s =", name);
2386 if (gidlist != NULL)
2390 if (no_labels) sep = '\0';
2391 for (i = 1; i <= (int)(gidlist[0]); i++)
2393 uschar *name = NULL;
2394 gr = getgrgid(gidlist[i]);
2395 if (gr != NULL) name = US gr->gr_name;
2396 if (sep != '\0') printf("%c", sep);
2397 if (name != NULL) printf("%s", name);
2398 else printf("%ld", (long int)(gidlist[i]));
2406 if (!no_labels) printf("%s = ", name);
2407 printf("%s\n", readconf_printtime(*((int *)value)));
2413 int *list = (int *)value;
2414 if (!no_labels) printf("%s = ", name);
2415 for (i = 0; i < list[1]; i++)
2416 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2422 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2426 case opt_expand_bool:
2427 sprintf(CS name2, "*expand_%.50s", name);
2428 ol2 = find_option(name2, oltop, last);
2429 if (ol2 != NULL && ol2->value != NULL)
2431 void *value2 = ol2->value;
2432 if (options_block != NULL)
2433 value2 = (void *)((uschar *)options_block + (long int)value2);
2434 s = *((uschar **)value2);
2437 if (!no_labels) printf("%s = ", name);
2438 printf("%s\n", string_printing(s));
2441 /* s == NULL => string not set; fall through */
2447 case opt_bool_verify:
2449 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2456 /*************************************************
2457 * Print value from main configuration *
2458 *************************************************/
2460 /* This function, called as a result of encountering the -bP option,
2461 causes the value of any main configuration variable to be output if the
2462 second argument is NULL. There are some special values:
2464 all print all main configuration options
2465 configure_file print the name of the configuration file
2466 routers print the routers' configurations
2467 transports print the transports' configuration
2468 authenticators print the authenticators' configuration
2469 macros print the macros' configuration
2470 router_list print a list of router names
2471 transport_list print a list of transport names
2472 authenticator_list print a list of authentication mechanism names
2473 macro_list print a list of macro names
2474 +name print a named list item
2475 local_scan print the local_scan options
2477 If the second argument is not NULL, it must be one of "router", "transport",
2478 "authenticator" or "macro" in which case the first argument identifies the
2479 driver whose options are to be printed.
2482 name option name if type == NULL; else driver name
2483 type NULL or driver type name, as described above
2484 no_labels avoid the "foo = " at the start of an item
2490 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2492 BOOL names_only = FALSE;
2494 optionlist *ol2 = NULL;
2495 driver_instance *d = NULL;
2506 static uschar *types[] = { US"address", US"domain", US"host",
2508 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2509 &hostlist_anchor, &localpartlist_anchor };
2511 for (i = 0; i < 4; i++)
2513 t = tree_search(*(anchors[i]), name+1);
2518 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2520 printf("%slist %s = %s\n", types[i], name+1,
2521 ((namedlist_block *)(t->data.ptr))->string);
2526 printf("no address, domain, host, or local part list called \"%s\" "
2527 "exists\n", name+1);
2532 if (Ustrcmp(name, "configure_file") == 0)
2534 printf("%s\n", CS config_main_filename);
2538 if (Ustrcmp(name, "all") == 0)
2540 for (ol = optionlist_config;
2541 ol < optionlist_config + optionlist_config_size; ol++)
2543 if ((ol->type & opt_hidden) == 0)
2544 print_ol(ol, US ol->name, NULL,
2545 optionlist_config, optionlist_config_size,
2551 if (Ustrcmp(name, "local_scan") == 0)
2553 #ifndef LOCAL_SCAN_HAS_OPTIONS
2554 printf("local_scan() options are not supported\n");
2556 for (ol = local_scan_options;
2557 ol < local_scan_options + local_scan_options_count; ol++)
2559 print_ol(ol, US ol->name, NULL, local_scan_options,
2560 local_scan_options_count, no_labels);
2566 if (Ustrcmp(name, "routers") == 0)
2571 else if (Ustrcmp(name, "transports") == 0)
2573 type = US"transport";
2577 else if (Ustrcmp(name, "authenticators") == 0)
2579 type = US"authenticator";
2583 else if (Ustrcmp(name, "macros") == 0)
2589 else if (Ustrcmp(name, "router_list") == 0)
2596 else if (Ustrcmp(name, "transport_list") == 0)
2598 type = US"transport";
2603 else if (Ustrcmp(name, "authenticator_list") == 0)
2605 type = US"authenticator";
2610 else if (Ustrcmp(name, "macro_list") == 0)
2619 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2620 name, NULL, optionlist_config, optionlist_config_size, no_labels);
2625 /* Handle the options for a router or transport. Skip options that are flagged
2626 as hidden. Some of these are options with names starting with '*', used for
2627 internal alternative representations of other options (which the printing
2628 function will sort out). Others are synonyms kept for backward compatibility.
2631 if (Ustrcmp(type, "router") == 0)
2633 d = (driver_instance *)routers;
2634 ol2 = optionlist_routers;
2635 size = optionlist_routers_size;
2637 else if (Ustrcmp(type, "transport") == 0)
2639 d = (driver_instance *)transports;
2640 ol2 = optionlist_transports;
2641 size = optionlist_transports_size;
2643 else if (Ustrcmp(type, "authenticator") == 0)
2645 d = (driver_instance *)auths;
2646 ol2 = optionlist_auths;
2647 size = optionlist_auths_size;
2650 else if (Ustrcmp(type, "macro") == 0)
2652 /* People store passwords in macros and they were previously not available
2653 for printing. So we have an admin_users restriction. */
2656 fprintf(stderr, "exim: permission denied\n");
2659 for (m = macros; m != NULL; m = m->next)
2661 if (name == NULL || Ustrcmp(name, m->name) == 0)
2664 printf("%s\n", CS m->name);
2666 printf("%s=%s\n", CS m->name, CS m->replacement);
2672 printf("%s %s not found\n", type, name);
2678 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2682 /* Either search for a given driver, or print all of them */
2684 for (; d != NULL; d = d->next)
2687 printf("\n%s %s:\n", d->name, type);
2688 else if (Ustrcmp(d->name, name) != 0) continue;
2690 for (ol = ol2; ol < ol2 + size; ol++)
2692 if ((ol->type & opt_hidden) == 0)
2693 print_ol(ol, US ol->name, d, ol2, size, no_labels);
2696 for (ol = d->info->options;
2697 ol < d->info->options + *(d->info->options_count); ol++)
2699 if ((ol->type & opt_hidden) == 0)
2700 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
2702 if (name != NULL) return;
2704 if (name != NULL) printf("%s %s not found\n", type, name);
2709 /*************************************************
2710 * Read a named list item *
2711 *************************************************/
2713 /* This function reads a name and a list (i.e. string). The name is used to
2714 save the list in a tree, sorted by its name. Each entry also has a number,
2715 which can be used for caching tests, but if the string contains any expansion
2716 items other than $key, the number is set negative to inhibit caching. This
2717 mechanism is used for domain, host, and address lists that are referenced by
2721 anchorp points to the tree anchor
2722 numberp points to the current number for this tree
2723 max the maximum number permitted
2724 s the text of the option line, starting immediately after the name
2726 tname the name of the list type, for messages
2732 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2735 BOOL forcecache = FALSE;
2738 namedlist_block *nb = store_get(sizeof(namedlist_block));
2740 if (Ustrncmp(s, "_cache", 6) == 0)
2747 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2749 if (*numberp >= max)
2750 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2753 while (isspace(*s)) s++;
2755 while (isalnum(*s) || *s == '_') s++;
2756 t = store_get(sizeof(tree_node) + s-ss);
2757 Ustrncpy(t->name, ss, s-ss);
2759 while (isspace(*s)) s++;
2761 if (!tree_insertnode(anchorp, t))
2762 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2763 "duplicate name \"%s\" for a named %s", t->name, tname);
2766 nb->number = *numberp;
2769 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2770 "missing '=' after \"%s\"", t->name);
2771 while (isspace(*s)) s++;
2772 nb->string = read_string(s, t->name);
2773 nb->cache_data = NULL;
2775 /* Check the string for any expansions; if any are found, mark this list
2776 uncacheable unless the user has explicited forced caching. */
2778 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2784 /*************************************************
2785 * Unpick data for a rate limit *
2786 *************************************************/
2788 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2792 s string, in the form t,b,f,l
2793 where t is the threshold (integer)
2794 b is the initial delay (time)
2795 f is the multiplicative factor (fixed point)
2796 k is the maximum time (time)
2797 threshold where to store threshold
2798 base where to store base in milliseconds
2799 factor where to store factor in milliseconds
2800 limit where to store limit
2802 Returns: nothing (panics on error)
2806 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2809 uschar bstring[16], lstring[16];
2811 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2812 factor, lstring) == 4)
2814 *base = readconf_readtime(bstring, 0, TRUE);
2815 *limit = readconf_readtime(lstring, 0, TRUE);
2816 if (*base >= 0 && *limit >= 0) return;
2818 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2824 /*************************************************
2825 * Drop privs for checking TLS config *
2826 *************************************************/
2828 /* We want to validate TLS options during readconf, but do not want to be
2829 root when we call into the TLS library, in case of library linkage errors
2830 which cause segfaults; before this check, those were always done as the Exim
2831 runtime user and it makes sense to continue with that.
2833 Assumes: tls_require_ciphers has been set, if it will be
2834 exim_user has been set, if it will be
2835 exim_group has been set, if it will be
2837 Returns: bool for "okay"; false will cause caller to immediately exit.
2842 tls_dropprivs_validate_require_cipher(void)
2844 const uschar *errmsg;
2847 void (*oldsignal)(int);
2849 oldsignal = signal(SIGCHLD, SIG_DFL);
2852 if ((pid = fork()) < 0)
2853 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2857 /* in some modes, will have dropped privilege already */
2859 exim_setugid(exim_uid, exim_gid, FALSE,
2860 US"calling tls_validate_require_cipher");
2862 errmsg = tls_validate_require_cipher();
2865 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2866 "tls_require_ciphers invalid: %s", errmsg);
2873 rc = waitpid(pid, &status, 0);
2874 } while (rc < 0 && errno == EINTR);
2877 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
2880 signal(SIGCHLD, oldsignal);
2884 #endif /* SUPPORT_TLS */
2889 /*************************************************
2890 * Read main configuration options *
2891 *************************************************/
2893 /* This function is the first to be called for configuration reading. It
2894 opens the configuration file and reads general configuration settings until
2895 it reaches the end of the configuration section. The file is then left open so
2896 that the remaining configuration data can subsequently be read if needed for
2899 The configuration file must be owned either by root or exim, and be writeable
2900 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2901 in the config file, so the test is done on the compiled in values. A slight
2902 anomaly, to be carefully documented.
2904 The name of the configuration file is taken from a list that is included in the
2905 binary of Exim. It can be altered from the command line, but if that is done,
2906 root privilege is immediately withdrawn unless the caller is root or exim.
2907 The first file on the list that exists is used.
2909 For use on multiple systems that share file systems, first look for a
2910 configuration file whose name has the current node name on the end. If that is
2911 not found, try the generic name. For really contorted configurations, that run
2912 multiple Exims with different uid settings, first try adding the effective uid
2913 before the node name. These complications are going to waste resources on most
2914 systems. Therefore they are available only when requested by compile-time
2921 struct stat statbuf;
2922 uschar *s, *filename;
2923 uschar *list = config_main_filelist;
2925 /* Loop through the possible file names */
2927 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2930 /* Cut out all the fancy processing unless specifically wanted */
2932 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2933 uschar *suffix = filename + Ustrlen(filename);
2935 /* Try for the node-specific file if a node name exists */
2937 #ifdef CONFIGURE_FILE_USE_NODE
2939 if (uname(&uts) >= 0)
2941 #ifdef CONFIGURE_FILE_USE_EUID
2942 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2943 config_file = Ufopen(filename, "rb");
2944 if (config_file == NULL)
2945 #endif /* CONFIGURE_FILE_USE_EUID */
2947 sprintf(CS suffix, ".%.256s", uts.nodename);
2948 config_file = Ufopen(filename, "rb");
2951 #endif /* CONFIGURE_FILE_USE_NODE */
2953 /* Otherwise, try the generic name, possibly with the euid added */
2955 #ifdef CONFIGURE_FILE_USE_EUID
2956 if (config_file == NULL)
2958 sprintf(CS suffix, ".%ld", (long int)original_euid);
2959 config_file = Ufopen(filename, "rb");
2961 #endif /* CONFIGURE_FILE_USE_EUID */
2963 /* Finally, try the unadorned name */
2965 if (config_file == NULL)
2968 config_file = Ufopen(filename, "rb");
2970 #else /* if neither defined */
2972 /* This is the common case when the fancy processing is not included. */
2974 config_file = Ufopen(filename, "rb");
2977 /* If the file does not exist, continue to try any others. For any other
2978 error, break out (and die). */
2980 if (config_file != NULL || errno != ENOENT) break;
2983 /* On success, save the name for verification; config_filename is used when
2984 logging configuration errors (it changes for .included files) whereas
2985 config_main_filename is the name shown by -bP. Failure to open a configuration
2986 file is a serious disaster. */
2988 if (config_file != NULL)
2990 config_filename = config_main_filename = string_copy(filename);
2994 if (filename == NULL)
2995 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2996 "%s", config_main_filelist);
2998 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2999 "configuration file %s", filename));
3002 /* Check the status of the file we have opened, if we have retained root
3003 privileges and the file isn't /dev/null (which *should* be 0666). */
3005 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3007 if (fstat(fileno(config_file), &statbuf) != 0)
3008 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3011 if ((statbuf.st_uid != root_uid /* owner not root */
3012 #ifdef CONFIGURE_OWNER
3013 && statbuf.st_uid != config_uid /* owner not the special one */
3016 (statbuf.st_gid != root_gid /* group not root & */
3017 #ifdef CONFIGURE_GROUP
3018 && statbuf.st_gid != config_gid /* group not the special one */
3020 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3022 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3024 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3025 "wrong owner, group, or mode", big_buffer);
3028 /* Process the main configuration settings. They all begin with a lower case
3029 letter. If we see something starting with an upper case letter, it is taken as
3030 a macro definition. */
3032 while ((s = get_config_line()) != NULL)
3034 if (isupper(s[0])) read_macro_assignment(s);
3036 else if (Ustrncmp(s, "domainlist", 10) == 0)
3037 read_named_list(&domainlist_anchor, &domainlist_count,
3038 MAX_NAMED_LIST, s+10, US"domain list");
3040 else if (Ustrncmp(s, "hostlist", 8) == 0)
3041 read_named_list(&hostlist_anchor, &hostlist_count,
3042 MAX_NAMED_LIST, s+8, US"host list");
3044 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3045 read_named_list(&addresslist_anchor, &addresslist_count,
3046 MAX_NAMED_LIST, s+11, US"address list");
3048 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3049 read_named_list(&localpartlist_anchor, &localpartlist_count,
3050 MAX_NAMED_LIST, s+13, US"local part list");
3053 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3054 NULL, US"main option \"%s\" unknown");
3058 /* If local_sender_retain is set, local_from_check must be unset. */
3060 if (local_sender_retain && local_from_check)
3061 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3062 "local_sender_retain are set; this combination is not allowed");
3064 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3067 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3069 /* The max retry interval must not be greater than 24 hours. */
3071 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3073 /* remote_max_parallel must be > 0 */
3075 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3077 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3078 start of a new SMTP message. */
3080 freeze_tell_config = freeze_tell;
3082 /* The primary host name may be required for expansion of spool_directory
3083 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3084 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3085 canonize it. Some people like upper case letters in their host names, so we
3086 don't force the case. */
3088 if (primary_hostname == NULL)
3092 if (uname(&uts) < 0)
3093 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3094 hostname = US uts.nodename;
3096 if (Ustrchr(hostname, '.') == NULL)
3099 struct hostent *hostdata;
3102 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3103 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
3113 #if HAVE_GETIPNODEBYNAME
3115 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3117 hostdata = gethostbyname2(CS hostname, af);
3120 hostdata = gethostbyname(CS hostname);
3123 if (hostdata != NULL)
3125 hostname = US hostdata->h_name;
3129 if (af == AF_INET) break;
3134 primary_hostname = string_copy(hostname);
3137 /* Set up default value for smtp_active_hostname */
3139 smtp_active_hostname = primary_hostname;
3141 /* If spool_directory wasn't set in the build-time configuration, it must have
3142 got set above. Of course, writing to the log may not work if log_file_path is
3143 not set, but it will at least get to syslog or somewhere, with any luck. */
3145 if (*spool_directory == 0)
3146 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3149 /* Expand the spool directory name; it may, for example, contain the primary
3150 host name. Same comment about failure. */
3152 s = expand_string(spool_directory);
3154 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3155 "\"%s\": %s", spool_directory, expand_string_message);
3156 spool_directory = s;
3158 /* Expand log_file_path, which must contain "%s" in any component that isn't
3159 the null string or "syslog". It is also allowed to contain one instance of %D
3160 or %M. However, it must NOT contain % followed by anything else. */
3162 if (*log_file_path != 0)
3165 int sep = ':'; /* Fixed for log file path */
3166 s = expand_string(log_file_path);
3168 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3169 "\"%s\": %s", log_file_path, expand_string_message);
3172 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3175 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3176 t = Ustrstr(sss, "%s");
3178 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3179 "contain \"%%s\"", sss);
3181 t = Ustrchr(sss, '%');
3184 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3185 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3186 "unexpected \"%%\" character", s);
3193 /* Interpret syslog_facility into an integer argument for 'ident' param to
3194 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3197 if (syslog_facility_str != NULL)
3200 uschar *s = syslog_facility_str;
3202 if ((Ustrlen(syslog_facility_str) >= 4) &&
3203 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3206 for (i = 0; i < syslog_list_size; i++)
3208 if (strcmpic(s, syslog_list[i].name) == 0)
3210 syslog_facility = syslog_list[i].value;
3215 if (i >= syslog_list_size)
3217 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3218 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3222 /* Expand pid_file_path */
3224 if (*pid_file_path != 0)
3226 s = expand_string(pid_file_path);
3228 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3229 "\"%s\": %s", pid_file_path, expand_string_message);
3233 /* Set default value of process_log_path */
3235 if (process_log_path == NULL || *process_log_path =='\0')
3236 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3238 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3241 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3243 /* Unpick the SMTP rate limiting options, if set */
3245 if (smtp_ratelimit_mail != NULL)
3247 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3248 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3251 if (smtp_ratelimit_rcpt != NULL)
3253 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3254 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3257 /* The qualify domains default to the primary host name */
3259 if (qualify_domain_sender == NULL)
3260 qualify_domain_sender = primary_hostname;
3261 if (qualify_domain_recipient == NULL)
3262 qualify_domain_recipient = qualify_domain_sender;
3264 /* Setting system_filter_user in the configuration sets the gid as well if a
3265 name is given, but a numerical value does not. */
3267 if (system_filter_uid_set && !system_filter_gid_set)
3269 struct passwd *pw = getpwuid(system_filter_uid);
3271 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3272 (long int)system_filter_uid);
3273 system_filter_gid = pw->pw_gid;
3274 system_filter_gid_set = TRUE;
3277 /* If the errors_reply_to field is set, check that it is syntactically valid
3278 and ensure it contains a domain. */
3280 if (errors_reply_to != NULL)
3283 int start, end, domain;
3284 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3285 &start, &end, &domain, FALSE);
3287 if (recipient == NULL)
3288 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3289 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3292 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3293 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3296 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3297 smtp_accept_max must also be set. */
3299 if (smtp_accept_max == 0 &&
3300 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3301 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3302 "smtp_accept_max must be set if smtp_accept_queue or "
3303 "smtp_accept_max_per_host is set");
3305 /* Set up the host number if anything is specified. It is an expanded string
3306 so that it can be computed from the host name, for example. We do this last
3307 so as to ensure that everything else is set up before the expansion. */
3309 if (host_number_string != NULL)
3313 uschar *s = expand_string(host_number_string);
3315 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3316 "failed to expand localhost_number \"%s\": %s",
3317 host_number_string, expand_string_message);
3318 n = Ustrtol(s, &end, 0);
3319 while (isspace(*end)) end++;
3321 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3322 "localhost_number value is not a number: %s", s);
3323 if (n > LOCALHOST_MAX)
3324 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3325 "localhost_number is greater than the maximum allowed value (%d)",
3331 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3333 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3334 tls_verify_certificates == NULL)
3335 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3336 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3337 (tls_verify_hosts != NULL)? "" : "try_");
3339 /* This also checks that the library linkage is working and we can call
3340 routines in it, so call even if tls_require_ciphers is unset */
3341 if (!tls_dropprivs_validate_require_cipher())
3344 /* Magic number: at time of writing, 1024 has been the long-standing value
3345 used by so many clients, and what Exim used to use always, that it makes
3346 sense to just min-clamp this max-clamp at that. */
3347 if (tls_dh_max_bits < 1024)
3348 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3349 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3351 /* If openssl_options is set, validate it */
3352 if (openssl_options != NULL)
3355 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3356 "openssl_options is set but we're using GnuTLS");
3359 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3360 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3361 "openssl_options parse error: %s", openssl_options);
3369 /*************************************************
3370 * Initialize one driver *
3371 *************************************************/
3373 /* This is called once the driver's generic options, if any, have been read.
3374 We can now find the driver, set up defaults for the private options, and
3375 unset any "set" bits in the private options table (which might have been
3376 set by another incarnation of the same driver).
3379 d pointer to driver instance block, with generic
3381 drivers_available vector of available drivers
3382 size_of_info size of each block in drivers_available
3383 class class of driver, for error message
3385 Returns: pointer to the driver info block
3388 static driver_info *
3389 init_driver(driver_instance *d, driver_info *drivers_available,
3390 int size_of_info, uschar *class)
3394 for (dd = drivers_available; dd->driver_name[0] != 0;
3395 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3397 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3400 int len = dd->options_len;
3402 d->options_block = store_get(len);
3403 memcpy(d->options_block, dd->options_block, len);
3404 for (i = 0; i < *(dd->options_count); i++)
3405 dd->options[i].type &= ~opt_set;
3410 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3411 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3413 return NULL; /* never obeyed */
3419 /*************************************************
3420 * Initialize driver list *
3421 *************************************************/
3423 /* This function is called for routers, transports, and authentication
3424 mechanisms. It reads the data from the current point in the configuration file
3425 up to the end of the section, and sets up a chain of instance blocks according
3426 to the file's contents. The file will already have been opened by a call to
3427 readconf_main, and must be left open for subsequent reading of further data.
3429 Any errors cause a panic crash. Note that the blocks with names driver_info and
3430 driver_instance must map the first portions of all the _info and _instance
3431 blocks for this shared code to work.
3434 class "router", "transport", or "authenticator"
3435 anchor &routers, &transports, &auths
3436 drivers_available available drivers
3437 size_of_info size of each info block
3438 instance_default points to default data for an instance
3439 instance_size size of instance block
3440 driver_optionlist generic option list
3441 driver_optionlist_count count of generic option list
3447 readconf_driver_init(
3449 driver_instance **anchor,
3450 driver_info *drivers_available,
3452 void *instance_default,
3454 optionlist *driver_optionlist,
3455 int driver_optionlist_count)
3457 driver_instance **p = anchor;
3458 driver_instance *d = NULL;
3461 while ((buffer = get_config_line()) != NULL)
3466 /* Read the first name on the line and test for the start of a new driver. A
3467 macro definition indicates the end of the previous driver. If this isn't the
3468 start of a new driver, the line will be re-read. */
3470 s = readconf_readname(name, sizeof(name), buffer);
3472 /* Handle macro definition, first finishing off the initialization of the
3473 previous driver, if any. */
3475 if (isupper(*name) && *s == '=')
3479 if (d->driver_name == NULL)
3480 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3481 "no driver defined for %s \"%s\"", class, d->name);
3485 read_macro_assignment(buffer);
3489 /* If the line starts with a name terminated by a colon, we are at the
3490 start of the definition of a new driver. The rest of the line must be
3497 /* Finish off initializing the previous driver. */
3501 if (d->driver_name == NULL)
3502 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3503 "no driver defined for %s \"%s\"", class, d->name);
3507 /* Check that we haven't already got a driver of this name */
3509 for (d = *anchor; d != NULL; d = d->next)
3510 if (Ustrcmp(name, d->name) == 0)
3511 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3512 "there are two %ss called \"%s\"", class, name);
3514 /* Set up a new driver instance data block on the chain, with
3515 its default values installed. */
3517 d = store_get(instance_size);
3518 memcpy(d, instance_default, instance_size);
3521 d->name = string_copy(name);
3523 /* Clear out the "set" bits in the generic options */
3525 for (i = 0; i < driver_optionlist_count; i++)
3526 driver_optionlist[i].type &= ~opt_set;
3528 /* Check nothing more on this line, then do the next loop iteration. */
3530 while (isspace(*s)) s++;
3531 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3535 /* Not the start of a new driver. Give an error if we have not set up a
3536 current driver yet. */
3538 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3539 "%s name missing", class);
3541 /* First look to see if this is a generic option; if it is "driver",
3542 initialize the driver. If is it not a generic option, we can look for a
3543 private option provided that the driver has been previously set up. */
3545 if (readconf_handle_option(buffer, driver_optionlist,
3546 driver_optionlist_count, d, NULL))
3548 if (d->info == NULL && d->driver_name != NULL)
3549 init_driver(d, drivers_available, size_of_info, class);
3552 /* Handle private options - pass the generic block because some may
3553 live therein. A flag with each option indicates if it is in the public
3556 else if (d->info != NULL)
3558 readconf_handle_option(buffer, d->info->options,
3559 *(d->info->options_count), d, US"option \"%s\" unknown");
3562 /* The option is not generic and the driver name has not yet been given. */
3564 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3565 "(\"driver\" must be specified before any private options)", name);
3568 /* Run the initialization function for the final driver. */
3572 if (d->driver_name == NULL)
3573 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3574 "no driver defined for %s \"%s\"", class, d->name);
3581 /*************************************************
3582 * Check driver dependency *
3583 *************************************************/
3585 /* This function is passed a driver instance and a string. It checks whether
3586 any of the string options for the driver contains the given string as an
3590 d points to a driver instance block
3591 s the string to search for
3593 Returns: TRUE if a dependency is found
3597 readconf_depends(driver_instance *d, uschar *s)
3599 int count = *(d->info->options_count);
3603 for (ol = d->info->options; ol < d->info->options + count; ol++)
3605 void *options_block;
3607 int type = ol->type & opt_mask;
3608 if (type != opt_stringptr) continue;
3609 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3610 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3611 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3613 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3614 isalnum(ss[Ustrlen(s)])) continue;
3615 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3616 d->name, ol->name, s);
3621 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3628 /*************************************************
3629 * Decode an error type for retries *
3630 *************************************************/
3632 /* This function is global because it is also called from the main
3633 program when testing retry information. It decodes strings such as "quota_7d"
3634 into numerical error codes.
3637 pp points to start of text
3638 p points past end of text
3639 basic_errno points to an int to receive the main error number
3640 more_errno points to an int to receive the secondary error data
3642 Returns: NULL if decoded correctly; else points to error text
3646 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3650 while (q < p && *q != '_') q++;
3653 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3655 *basic_errno = ERRNO_EXIMQUOTA;
3656 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3657 return US"bad time value";
3660 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3662 *basic_errno = ECONNREFUSED;
3665 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3666 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3667 else return US"A or MX expected after \"refused\"";
3671 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3673 *basic_errno = ETIMEDOUT;
3677 int xlen = p - q - 1;
3680 static uschar *extras[] =
3681 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3682 static int values[] =
3683 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3685 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3687 if (strncmpic(x, extras[i], xlen) == 0)
3689 *more_errno = values[i];
3694 if (i >= sizeof(extras)/sizeof(uschar *))
3696 if (strncmpic(x, US"DNS", xlen) == 0)
3698 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3699 "available in retry rules (it has never worked) - treated as "
3702 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3707 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3708 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3709 strncmpic(pp, US"data_4", 6) == 0)
3712 int x = 255; /* means "any 4xx code" */
3713 if (p != pp + 8) bad = TRUE; else
3715 int a = pp[6], b = pp[7];
3719 if (isdigit(b)) x += b - '0';
3720 else if (b == 'x') x += 100;
3723 else if (a != 'x' || b != 'x') bad = TRUE;
3727 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3728 "x is literal and d is any digit", pp);
3730 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3731 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3732 *more_errno = x << 8;
3735 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3736 strncmpic(q+1, US"failed", p-q-1) == 0)
3737 *basic_errno = ERRNO_AUTHFAIL;
3739 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3740 *basic_errno = ERRNO_SMTPCLOSED;
3742 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3743 *basic_errno = ERRNO_TLSREQUIRED;
3745 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3746 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3754 /*************************************************
3755 * Read retry information *
3756 *************************************************/
3758 /* Each line of retry information contains:
3760 . A domain name pattern or an address pattern;
3762 . An error name, possibly with additional data, or *;
3764 . An optional sequence of retry items, each consisting of an identifying
3765 letter, a cutoff time, and optional parameters.
3767 All this is decoded and placed into a control block. */
3770 /* Subroutine to read an argument, preceded by a comma and terminated
3771 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3772 1 = fixed point number (returned *1000).
3775 paddr pointer to pointer to current character; updated
3776 type 0 => read a time; 1 => read a fixed point number
3778 Returns: time in seconds or fixed point number * 1000
3782 retry_arg(uschar **paddr, int type)
3787 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3789 while (isspace(*p)) p++;
3791 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3793 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3794 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3800 return readconf_readtime(pp, *p, FALSE);
3802 return readconf_readfixed(pp, *p);
3804 return 0; /* Keep picky compilers happy */
3807 /* The function proper */
3810 readconf_retries(void)
3812 retry_config **chain = &retries;
3816 while ((p = get_config_line()) != NULL)
3818 retry_rule **rchain;
3821 next = store_get(sizeof(retry_config));
3824 chain = &(next->next);
3825 next->basic_errno = next->more_errno = 0;
3826 next->senders = NULL;
3828 rchain = &(next->rules);
3830 next->pattern = string_dequote(&p);
3831 while (isspace(*p)) p++;
3833 while (mac_isgraph(*p)) p++;
3834 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3835 "missing error type in retry rule");
3837 /* Test error names for things we understand. */
3839 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3840 &(next->more_errno))) != NULL)
3841 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3843 /* There may be an optional address list of senders to be used as another
3844 constraint on the rule. This was added later, so the syntax is a bit of a
3845 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3848 while (isspace(*p)) p++;
3849 if (Ustrncmp(p, "senders", 7) == 0)
3852 while (isspace(*p)) p++;
3853 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3854 "\"=\" expected after \"senders\" in retry rule");
3855 while (isspace(*p)) p++;
3856 next->senders = string_dequote(&p);
3859 /* Now the retry rules. Keep the maximum timeout encountered. */
3861 while (isspace(*p)) p++;
3865 retry_rule *rule = store_get(sizeof(retry_rule));
3867 rchain = &(rule->next);
3869 rule->rule = toupper(*p++);
3870 rule->timeout = retry_arg(&p, 0);
3871 if (rule->timeout > retry_maximum_timeout)
3872 retry_maximum_timeout = rule->timeout;
3876 case 'F': /* Fixed interval */
3877 rule->p1 = retry_arg(&p, 0);
3880 case 'G': /* Geometrically increasing intervals */
3881 case 'H': /* Ditto, but with randomness */
3882 rule->p1 = retry_arg(&p, 0);
3883 rule->p2 = retry_arg(&p, 1);
3887 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3891 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3892 (rule->rule != 'F' && rule->p2 < 1000))
3893 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3894 "bad parameters for retry rule");
3896 while (isspace(*p)) p++;
3900 while (isspace(*p)) p++;
3903 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3910 /*************************************************
3911 * Initialize authenticators *
3912 *************************************************/
3914 /* Read the authenticators section of the configuration file.
3923 auth_instance *au, *bu;
3924 readconf_driver_init(US"authenticator",
3925 (driver_instance **)(&auths), /* chain anchor */
3926 (driver_info *)auths_available, /* available drivers */
3927 sizeof(auth_info), /* size of info block */
3928 &auth_defaults, /* default values for generic options */
3929 sizeof(auth_instance), /* size of instance block */
3930 optionlist_auths, /* generic options */
3931 optionlist_auths_size);
3933 for (au = auths; au != NULL; au = au->next)
3935 if (au->public_name == NULL)
3936 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3937 "the %s authenticator", au->name);
3938 for (bu = au->next; bu != NULL; bu = bu->next)
3940 if (strcmpic(au->public_name, bu->public_name) == 0)
3942 if ((au->client && bu->client) || (au->server && bu->server))
3943 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3944 "(%s and %s) have the same public name (%s)",
3945 (au->client)? US"client" : US"server", au->name, bu->name,
3955 /*************************************************
3956 * Read ACL information *
3957 *************************************************/
3959 /* If this run of Exim is not doing something that involves receiving a
3960 message, we can just skip over the ACL information. No need to parse it.
3962 First, we have a function for acl_read() to call back to get the next line. We
3963 need to remember the line we passed, because at the end it will contain the
3964 name of the next ACL. */
3966 static uschar *acl_line;
3971 acl_line = get_config_line();
3976 /* Now the main function:
3987 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3990 acl_line = get_config_line();
3992 while(acl_line != NULL)
3998 p = readconf_readname(name, sizeof(name), acl_line);
3999 if (isupper(*name) && *p == '=')
4001 read_macro_assignment(acl_line);
4002 acl_line = get_config_line();
4006 if (*p != ':' || name[0] == 0)
4007 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4009 node = store_get(sizeof(tree_node) + Ustrlen(name));
4010 Ustrcpy(node->name, name);
4011 if (!tree_insertnode(&acl_anchor, node))
4012 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4013 "there are two ACLs called \"%s\"", name);
4015 node->data.ptr = acl_read(acl_callback, &error);
4017 if (node->data.ptr == NULL && error != NULL)
4018 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4024 /*************************************************
4025 * Read configuration for local_scan() *
4026 *************************************************/
4028 /* This function is called after "begin local_scan" is encountered in the
4029 configuration file. If the local_scan() function allows for configuration
4030 options, we can process them. Otherwise, we expire in a panic.
4037 local_scan_init(void)
4039 #ifndef LOCAL_SCAN_HAS_OPTIONS
4040 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4041 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4045 while ((p = get_config_line()) != NULL)
4047 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4048 NULL, US"local_scan option \"%s\" unknown");
4055 /*************************************************
4056 * Read rest of configuration (after main) *
4057 *************************************************/
4059 /* This function reads the rest of the runtime configuration, after the main
4060 configuration. It is called only when actually needed. Each subsequent section
4061 of the configuration starts with a line of the form
4065 where the name is "routers", "transports", etc. A section is terminated by
4066 hitting the next "begin" line, and the next name is left in next_section.
4067 Because it may confuse people as to whether the names are singular or plural,
4068 we add "s" if it's missing. There is always enough room in next_section for
4069 this. This function is basically just a switch.
4075 static uschar *section_list[] = {
4089 while(next_section[0] != 0)
4093 int last = sizeof(section_list) / sizeof(uschar *);
4095 int n = Ustrlen(next_section);
4097 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4101 int c = strcmpic(next_section, section_list[mid]);
4103 if (c > 0) first = mid + 1; else last = mid;
4105 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4106 "\"%.*s\" is not a known configuration section name", n, next_section);
4107 mid = (last + first)/2;
4111 if (((had ^= bit) & bit) == 0)
4112 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4113 "\"%.*s\" section is repeated in the configuration file", n,
4118 case 0: readconf_acl(); break;
4119 case 1: auths_init(); break;
4120 case 2: local_scan_init(); break;
4121 case 3: readconf_retries(); break;
4122 case 4: readconf_rewrites(); break;
4123 case 5: route_init(); break;
4124 case 6: transport_init(); break;
4128 (void)fclose(config_file);
4131 /* End of readconf.c */