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 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
216 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
217 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
218 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
219 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
220 { "dns_retrans", opt_time, &dns_retrans },
221 { "dns_retry", opt_int, &dns_retry },
222 { "dns_use_dnssec", opt_int, &dns_use_dnssec },
223 { "dns_use_edns0", opt_int, &dns_use_edns0 },
224 /* This option is now a no-op, retained for compability */
225 { "drop_cr", opt_bool, &drop_cr },
226 /*********************************************************/
227 { "dsn_from", opt_stringptr, &dsn_from },
228 { "envelope_to_remove", opt_bool, &envelope_to_remove },
229 { "errors_copy", opt_stringptr, &errors_copy },
230 { "errors_reply_to", opt_stringptr, &errors_reply_to },
231 { "exim_group", opt_gid, &exim_gid },
232 { "exim_path", opt_stringptr, &exim_path },
233 { "exim_user", opt_uid, &exim_uid },
234 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
235 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
236 { "finduser_retries", opt_int, &finduser_retries },
237 { "freeze_tell", opt_stringptr, &freeze_tell },
238 { "gecos_name", opt_stringptr, &gecos_name },
239 { "gecos_pattern", opt_stringptr, &gecos_pattern },
241 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
242 { "gnutls_enable_pkcs11", opt_bool, &gnutls_enable_pkcs11 },
243 /* These three gnutls_require_* options stopped working in Exim 4.80 */
244 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
245 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
246 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
248 { "header_line_maxsize", opt_int, &header_line_maxsize },
249 { "header_maxsize", opt_int, &header_maxsize },
250 { "headers_charset", opt_stringptr, &headers_charset },
251 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
252 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
253 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
254 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
255 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
256 { "hold_domains", opt_stringptr, &hold_domains },
257 { "host_lookup", opt_stringptr, &host_lookup },
258 { "host_lookup_order", opt_stringptr, &host_lookup_order },
259 { "host_reject_connection", opt_stringptr, &host_reject_connection },
260 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
261 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
263 { "ibase_servers", opt_stringptr, &ibase_servers },
265 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
266 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
267 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
268 { "keep_malformed", opt_time, &keep_malformed },
270 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
271 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
272 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
273 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
274 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
275 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
276 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
277 { "ldap_start_tls", opt_bool, &eldap_start_tls },
278 { "ldap_version", opt_int, &eldap_version },
280 { "local_from_check", opt_bool, &local_from_check },
281 { "local_from_prefix", opt_stringptr, &local_from_prefix },
282 { "local_from_suffix", opt_stringptr, &local_from_suffix },
283 { "local_interfaces", opt_stringptr, &local_interfaces },
284 { "local_scan_timeout", opt_time, &local_scan_timeout },
285 { "local_sender_retain", opt_bool, &local_sender_retain },
286 { "localhost_number", opt_stringptr, &host_number_string },
287 { "log_file_path", opt_stringptr, &log_file_path },
288 { "log_selector", opt_stringptr, &log_selector_string },
289 { "log_timezone", opt_bool, &log_timezone },
290 { "lookup_open_max", opt_int, &lookup_open_max },
291 { "max_username_length", opt_int, &max_username_length },
292 { "message_body_newlines", opt_bool, &message_body_newlines },
293 { "message_body_visible", opt_mkint, &message_body_visible },
294 { "message_id_header_domain", opt_stringptr, &message_id_domain },
295 { "message_id_header_text", opt_stringptr, &message_id_text },
296 { "message_logs", opt_bool, &message_logs },
297 { "message_size_limit", opt_stringptr, &message_size_limit },
298 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
299 { "move_frozen_messages", opt_bool, &move_frozen_messages },
301 { "mua_wrapper", opt_bool, &mua_wrapper },
303 { "mysql_servers", opt_stringptr, &mysql_servers },
305 { "never_users", opt_uidlist, &never_users },
307 { "openssl_options", opt_stringptr, &openssl_options },
310 { "oracle_servers", opt_stringptr, &oracle_servers },
312 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
314 { "perl_at_start", opt_bool, &opt_perl_at_start },
315 { "perl_startup", opt_stringptr, &opt_perl_startup },
318 { "pgsql_servers", opt_stringptr, &pgsql_servers },
320 { "pid_file_path", opt_stringptr, &pid_file_path },
321 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
322 #ifdef EXPERIMENTAL_PRDR
323 { "prdr_enable", opt_bool, &prdr_enable },
325 { "preserve_message_logs", opt_bool, &preserve_message_logs },
326 { "primary_hostname", opt_stringptr, &primary_hostname },
327 { "print_topbitchars", opt_bool, &print_topbitchars },
328 { "process_log_path", opt_stringptr, &process_log_path },
329 { "prod_requires_admin", opt_bool, &prod_requires_admin },
330 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
331 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
332 { "queue_domains", opt_stringptr, &queue_domains },
333 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
334 { "queue_only", opt_bool, &queue_only },
335 { "queue_only_file", opt_stringptr, &queue_only_file },
336 { "queue_only_load", opt_fixed, &queue_only_load },
337 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
338 { "queue_only_override", opt_bool, &queue_only_override },
339 { "queue_run_in_order", opt_bool, &queue_run_in_order },
340 { "queue_run_max", opt_int, &queue_run_max },
341 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
342 { "receive_timeout", opt_time, &receive_timeout },
343 { "received_header_text", opt_stringptr, &received_header_text },
344 { "received_headers_max", opt_int, &received_headers_max },
345 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
346 { "recipients_max", opt_int, &recipients_max },
347 { "recipients_max_reject", opt_bool, &recipients_max_reject },
348 { "remote_max_parallel", opt_int, &remote_max_parallel },
349 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
350 { "retry_data_expire", opt_time, &retry_data_expire },
351 { "retry_interval_max", opt_time, &retry_interval_max },
352 { "return_path_remove", opt_bool, &return_path_remove },
353 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
354 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
355 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
356 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
357 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
358 { "smtp_accept_max", opt_int, &smtp_accept_max },
359 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
360 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
361 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
362 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
363 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
364 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
365 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
366 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
367 { "smtp_banner", opt_stringptr, &smtp_banner },
368 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
369 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
370 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
371 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
372 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
373 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
374 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
375 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
376 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
377 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
378 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
379 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
380 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
381 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
382 #ifdef WITH_CONTENT_SCAN
383 { "spamd_address", opt_stringptr, &spamd_address },
385 #ifdef EXPERIMENTAL_SPF
386 { "spf_guess", opt_stringptr, &spf_guess },
388 { "split_spool_directory", opt_bool, &split_spool_directory },
389 { "spool_directory", opt_stringptr, &spool_directory },
391 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
393 #ifdef EXPERIMENTAL_SRS
394 { "srs_config", opt_stringptr, &srs_config },
395 { "srs_hashlength", opt_int, &srs_hashlength },
396 { "srs_hashmin", opt_int, &srs_hashmin },
397 { "srs_maxage", opt_int, &srs_maxage },
398 { "srs_secrets", opt_stringptr, &srs_secrets },
399 { "srs_usehash", opt_bool, &srs_usehash },
400 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
402 { "strict_acl_vars", opt_bool, &strict_acl_vars },
403 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
404 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
405 { "syslog_duplication", opt_bool, &syslog_duplication },
406 { "syslog_facility", opt_stringptr, &syslog_facility_str },
407 { "syslog_processname", opt_stringptr, &syslog_processname },
408 { "syslog_timestamp", opt_bool, &syslog_timestamp },
409 { "system_filter", opt_stringptr, &system_filter },
410 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
411 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
412 { "system_filter_group", opt_gid, &system_filter_gid },
413 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
414 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
415 { "system_filter_user", opt_uid, &system_filter_uid },
416 { "tcp_nodelay", opt_bool, &tcp_nodelay },
417 #ifdef USE_TCP_WRAPPERS
418 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
420 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
421 { "timezone", opt_stringptr, &timezone_string },
423 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
424 { "tls_certificate", opt_stringptr, &tls_certificate },
425 { "tls_crl", opt_stringptr, &tls_crl },
426 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
427 { "tls_dhparam", opt_stringptr, &tls_dhparam },
428 # if defined(EXPERIMENTAL_OCSP) && !defined(USE_GNUTLS)
429 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
431 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
432 { "tls_privatekey", opt_stringptr, &tls_privatekey },
433 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
434 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
435 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
436 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
437 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
439 { "trusted_groups", opt_gidlist, &trusted_groups },
440 { "trusted_users", opt_uidlist, &trusted_users },
441 { "unknown_login", opt_stringptr, &unknown_login },
442 { "unknown_username", opt_stringptr, &unknown_username },
443 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
444 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
445 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
446 { "warn_message_file", opt_stringptr, &warn_message_file },
447 { "write_rejectlog", opt_bool, &write_rejectlog }
450 static int optionlist_config_size =
451 sizeof(optionlist_config)/sizeof(optionlist);
455 /*************************************************
456 * Find the name of an option *
457 *************************************************/
459 /* This function is to aid debugging. Various functions take arguments that are
460 pointer variables in the options table or in option tables for various drivers.
461 For debugging output, it is useful to be able to find the name of the option
462 which is currently being processed. This function finds it, if it exists, by
463 searching the table(s).
465 Arguments: a value that is presumed to be in the table above
466 Returns: the option name, or an empty string
470 readconf_find_option(void *p)
474 transport_instance *t;
476 for (i = 0; i < optionlist_config_size; i++)
477 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
479 for (r = routers; r != NULL; r = r->next)
481 router_info *ri = r->info;
482 for (i = 0; i < ri->options_count[0]; i++)
484 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
485 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
486 return US ri->options[i].name;
490 for (t = transports; t != NULL; t = t->next)
492 transport_info *ti = t->info;
493 for (i = 0; i < ti->options_count[0]; i++)
495 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
496 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
497 return US ti->options[i].name;
507 /*************************************************
508 * Deal with an assignment to a macro *
509 *************************************************/
511 /* This function is called when a line that starts with an upper case letter is
512 encountered. The argument "line" should contain a complete logical line, and
513 start with the first letter of the macro name. The macro name and the
514 replacement text are extracted and stored. Redefinition of existing,
515 non-command line, macros is permitted using '==' instead of '='.
518 s points to the start of the logical line
524 read_macro_assignment(uschar *s)
530 macro_item *mlast = NULL;
532 while (isalnum(*s) || *s == '_')
534 if (namelen >= sizeof(name) - 1)
535 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
536 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
537 name[namelen++] = *s++;
541 while (isspace(*s)) s++;
543 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
550 while (isspace(*s)) s++;
552 /* If an existing macro of the same name was defined on the command line, we
553 just skip this definition. It's an error to attempt to redefine a macro without
554 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
555 It is also an error to define a macro whose name begins with the name of a
556 previously defined macro. Note: it is documented that the other way round
559 for (m = macros; m != NULL; m = m->next)
561 int len = Ustrlen(m->name);
563 if (Ustrcmp(m->name, name) == 0)
565 if (!m->command_line && !redef)
566 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
567 "defined (use \"==\" if you want to redefine it", name);
571 if (len < namelen && Ustrstr(name, m->name) != NULL)
572 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
573 "a macro because previously defined macro \"%s\" is a substring",
576 /* We cannot have this test, because it is documented that a substring
577 macro is permitted (there is even an example).
579 * if (len > namelen && Ustrstr(m->name, name) != NULL)
580 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
581 * "a macro because it is a substring of previously defined macro \"%s\"",
588 /* Check for an overriding command-line definition. */
590 if (m != NULL && m->command_line) return;
592 /* Redefinition must refer to an existing macro. */
597 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
601 /* We have a new definition. The macro_item structure includes a final vector
602 called "name" which is one byte long. Thus, adding "namelen" gives us enough
603 room to store the "name" string. */
607 m = store_get(sizeof(macro_item) + namelen);
608 if (macros == NULL) macros = m; else mlast->next = m;
609 Ustrncpy(m->name, name, namelen);
610 m->name[namelen] = 0;
612 m->command_line = FALSE;
615 /* Set the value of the new or redefined macro */
617 m->replacement = string_copy(s);
624 /*************************************************
625 * Read configuration line *
626 *************************************************/
628 /* A logical line of text is read from the configuration file into the big
629 buffer, taking account of macros, .includes, and continuations. The size of
630 big_buffer is increased if necessary. The count of configuration lines is
631 maintained. Physical input lines starting with # (ignoring leading white space,
632 and after macro replacement) and empty logical lines are always ignored.
633 Leading and trailing spaces are removed.
635 If we hit a line of the form "begin xxxx", the xxxx is placed in the
636 next_section vector, and the function returns NULL, indicating the end of a
637 configuration section. On end-of-file, NULL is returned with next_section
642 Returns: a pointer to the first non-blank in the line,
643 or NULL if eof or end of section is reached
647 get_config_line(void)
649 int startoffset = 0; /* To first non-blank char in logical line */
650 int len = 0; /* Of logical line so far */
656 /* Loop for handling continuation lines, skipping comments, and dealing with
661 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
663 if (config_file_stack != NULL) /* EOF inside .include */
665 (void)fclose(config_file);
666 config_file = config_file_stack->file;
667 config_filename = config_file_stack->filename;
668 config_lineno = config_file_stack->lineno;
669 config_file_stack = config_file_stack->next;
673 /* EOF at top level */
675 if (cstate_stack_ptr >= 0)
676 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
677 "Unexpected end of configuration file: .endif missing");
679 if (len != 0) break; /* EOF after continuation */
680 next_section[0] = 0; /* EOF at start of logical line */
685 newlen = len + Ustrlen(big_buffer + len);
687 /* Handle pathologically long physical lines - yes, it did happen - by
688 extending big_buffer at this point. The code also copes with very long
691 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
694 big_buffer_size += BIG_BUFFER_SIZE;
695 newbuffer = store_malloc(big_buffer_size);
697 /* This use of strcpy is OK because we know that the string in the old
698 buffer is shorter than the new buffer. */
700 Ustrcpy(newbuffer, big_buffer);
701 store_free(big_buffer);
702 big_buffer = newbuffer;
703 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
705 newlen += Ustrlen(big_buffer + newlen);
708 /* Find the true start of the physical line - leading spaces are always
711 ss = big_buffer + len;
712 while (isspace(*ss)) ss++;
714 /* Process the physical line for macros. If this is the start of the logical
715 line, skip over initial text at the start of the line if it starts with an
716 upper case character followed by a sequence of name characters and an equals
717 sign, because that is the definition of a new macro, and we don't do
718 replacement therein. */
721 if (len == 0 && isupper(*s))
723 while (isalnum(*s) || *s == '_') s++;
724 while (isspace(*s)) s++;
725 if (*s != '=') s = ss; /* Not a macro definition */
728 /* For each defined macro, scan the line (from after XXX= if present),
729 replacing all occurrences of the macro. */
732 for (m = macros; m != NULL; m = m->next)
737 while ((p = Ustrstr(t, m->name)) != NULL)
740 int namelen = Ustrlen(m->name);
741 int replen = Ustrlen(m->replacement);
743 /* Expand the buffer if necessary */
745 while (newlen - namelen + replen + 1 > big_buffer_size)
747 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
748 uschar *newbuffer = store_malloc(newsize);
749 memcpy(newbuffer, big_buffer, newlen + 1);
750 p = newbuffer + (p - big_buffer);
751 s = newbuffer + (s - big_buffer);
752 ss = newbuffer + (ss - big_buffer);
753 t = newbuffer + (t - big_buffer);
754 big_buffer_size = newsize;
755 store_free(big_buffer);
756 big_buffer = newbuffer;
759 /* Shuffle the remaining characters up or down in the buffer before
760 copying in the replacement text. Don't rescan the replacement for this
764 moveby = replen - namelen;
767 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
770 Ustrncpy(p, m->replacement, replen);
776 /* An empty macro replacement at the start of a line could mean that ss no
777 longer points to the first non-blank character. */
779 while (isspace(*ss)) ss++;
781 /* Check for comment lines - these are physical lines. */
783 if (*ss == '#') continue;
785 /* Handle conditionals, which are also applied to physical lines. Conditions
786 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
787 expansion occured on the rest of the line. A preliminary test for the leading
788 '.' saves effort on most lines. */
794 /* Search the list of conditional directives */
796 for (i = 0; i < cond_list_size; i++)
799 cond_item *c = cond_list+i;
800 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
802 /* The following character must be white space or end of string */
804 n = ss[1 + c->namelen];
805 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
807 /* .ifdef and .ifndef push the current state onto the stack, then set
808 a new one from the table. Stack overflow is an error */
812 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
813 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
814 ".%s nested too deeply", c->name);
815 cstate_stack[++cstate_stack_ptr] = cstate;
816 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
819 /* For any of the others, stack underflow is an error. The next state
820 comes either from the stack (.endif) or from the table. */
824 if (cstate_stack_ptr < 0)
825 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
826 ".%s without matching .ifdef", c->name);
827 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
828 next_cstate[cstate][macro_found? c->action1 : c->action2];
831 /* Having dealt with a directive, break the loop */
836 /* If we have handled a conditional directive, continue with the next
837 physical line. Otherwise, fall through. */
839 if (i < cond_list_size) continue;
842 /* If the conditional state is not 0 (actively using these lines), ignore
845 if (cstate != 0) continue; /* Conditional skip */
847 /* Handle .include lines - these are also physical lines. */
849 if (Ustrncmp(ss, ".include", 8) == 0 &&
851 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
854 int include_if_exists = isspace(ss[8])? 0 : 10;
855 config_file_item *save;
858 ss += 9 + include_if_exists;
859 while (isspace(*ss)) ss++;
860 t = ss + Ustrlen(ss);
861 while (t > ss && isspace(t[-1])) t--;
862 if (*ss == '\"' && t[-1] == '\"')
870 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
871 "absolute path \"%s\"", ss);
873 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
875 save = store_get(sizeof(config_file_item));
876 save->next = config_file_stack;
877 config_file_stack = save;
878 save->file = config_file;
879 save->filename = config_filename;
880 save->lineno = config_lineno;
882 config_file = Ufopen(ss, "rb");
883 if (config_file == NULL)
884 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
885 "configuration file %s", ss);
886 config_filename = string_copy(ss);
891 /* If this is the start of the logical line, remember where the non-blank
892 data starts. Otherwise shuffle down continuation lines to remove leading
896 startoffset = ss - big_buffer;
899 s = big_buffer + len;
902 memmove(s, ss, (newlen - len) - (ss - s) + 1);
907 /* Accept the new addition to the line. Remove trailing white space. */
910 while (len > 0 && isspace(big_buffer[len-1])) len--;
913 /* We are done if the line does not end in backslash and contains some data.
914 Empty logical lines are ignored. For continuations, remove the backslash and
915 go round the loop to read the continuation line. */
919 if (big_buffer[len-1] != '\\') break; /* End of logical line */
920 big_buffer[--len] = 0; /* Remove backslash */
922 } /* Loop for reading multiple physical lines */
924 /* We now have a logical line. Test for the end of a configuration section (or,
925 more accurately, for the start of the next section). Place the name of the next
926 section in next_section, and return NULL. If the name given is longer than
927 next_section, truncate it. It will be unrecognized later, because all the known
928 section names do fit. Leave space for pluralizing. */
930 s = big_buffer + startoffset; /* First non-space character */
931 if (strncmpic(s, US"begin ", 6) == 0)
934 while (isspace(*s)) s++;
935 if (big_buffer + len - s > sizeof(next_section) - 2)
936 s[sizeof(next_section) - 2] = 0;
937 Ustrcpy(next_section, s);
941 /* Return the first non-blank character. */
948 /*************************************************
950 *************************************************/
952 /* The yield is the pointer to the next uschar. Names longer than the
953 output space are silently truncated. This function is also used from acl.c when
957 name where to put the name
961 Returns: new input pointer
965 readconf_readname(uschar *name, int len, uschar *s)
968 while (isspace(*s)) s++;
971 while (isalnum(*s) || *s == '_')
973 if (p < len-1) name[p++] = *s;
978 while (isspace(*s)) s++;
985 /*************************************************
986 * Read a time value *
987 *************************************************/
989 /* This function is also called from outside, to read argument
990 time values. The format of a time value is:
992 [<n>w][<n>d][<n>h][<n>m][<n>s]
994 as long as at least one is present. If a format error is encountered,
995 return a negative value. The value must be terminated by the given
1000 terminator required terminating character
1001 return_msec if TRUE, allow fractional seconds and return milliseconds
1003 Returns: the time value, or -1 on syntax error
1004 value is seconds if return_msec is FALSE
1005 value is milliseconds if return_msec is TRUE
1009 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
1017 if (!isdigit(*s)) return -1;
1018 (void)sscanf(CS s, "%d%n", &value, &count);
1023 case 'w': value *= 7;
1024 case 'd': value *= 24;
1025 case 'h': value *= 60;
1026 case 'm': value *= 60;
1031 if (!return_msec) return -1;
1032 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1034 if (*s++ != 's') return -1;
1035 yield += (int)(fraction * 1000.0);
1041 if (return_msec) value *= 1000;
1043 if (*s == terminator) return yield;
1045 /* Control never reaches here. */
1050 /*************************************************
1051 * Read a fixed point value *
1052 *************************************************/
1054 /* The value is returned *1000
1058 terminator required terminator
1060 Returns: the value, or -1 on error
1064 readconf_readfixed(uschar *s, int terminator)
1068 if (!isdigit(*s)) return -1;
1069 (void)sscanf(CS s, "%d%n", &value, &count);
1071 yield = value * 1000;
1075 while (isdigit((*(++s))))
1077 yield += (*s - '0') * m;
1082 return (*s == terminator)? yield : (-1);
1087 /*************************************************
1088 * Find option in list *
1089 *************************************************/
1091 /* The lists are always in order, so binary chop can be used.
1094 name the option name to search for
1095 ol the first entry in the option list
1096 last one more than the offset of the last entry in the option list
1098 Returns: pointer to an option entry, or NULL if not found
1102 find_option(uschar *name, optionlist *ol, int last)
1105 while (last > first)
1107 int middle = (first + last)/2;
1108 int c = Ustrcmp(name, ol[middle].name);
1109 if (c == 0) return ol + middle;
1110 else if (c > 0) first = middle + 1;
1118 /*************************************************
1119 * Find a set flag in option list *
1120 *************************************************/
1122 /* Because some versions of Unix make no restrictions on the values of uids and
1123 gids (even negative ones), we cannot represent "unset" by a special value.
1124 There is therefore a separate boolean variable for each one indicating whether
1125 a value is set or not. This function returns a pointer to the boolean, given
1126 the original option name. It is a major disaster if the flag cannot be found.
1129 name the name of the uid or gid option
1130 oltop points to the start of the relevant option list
1131 last one more than the offset of the last item in the option list
1132 data_block NULL when reading main options => data values in the option
1133 list are absolute addresses; otherwise they are byte offsets
1134 in data_block (used for driver options)
1136 Returns: a pointer to the boolean flag.
1140 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1144 sprintf(CS name2, "*set_%.50s", name);
1145 ol = find_option(name2, oltop, last);
1146 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1147 "Exim internal error: missing set flag for %s", name);
1148 return (data_block == NULL)? (BOOL *)(ol->value) :
1149 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1155 /*************************************************
1156 * Output extra characters message and die *
1157 *************************************************/
1159 /* Called when an option line has junk on the end. Sometimes this is because
1160 the sysadmin thinks comments are permitted.
1163 s points to the extra characters
1164 t1..t3 strings to insert in the log message
1166 Returns: doesn't return; dies
1170 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1172 uschar *comment = US"";
1173 if (*s == '#') comment = US" (# is comment only at line start)";
1174 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1175 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1180 /*************************************************
1181 * Read rewrite information *
1182 *************************************************/
1184 /* Each line of rewrite information contains:
1186 . A complete address in the form user@domain, possibly with
1187 leading * for each part; or alternatively, a regex.
1189 . A replacement string (which will be expanded).
1191 . An optional sequence of one-letter flags, indicating which
1192 headers etc. to apply this rule to.
1194 All this is decoded and placed into a control block. The OR of the flags is
1195 maintained in a common word.
1198 p points to the string that makes up the rule
1199 existflags points to the overall flag word
1200 isglobal TRUE if reading global rewrite rules
1202 Returns: the control block for the parsed rule.
1205 static rewrite_rule *
1206 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1208 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1211 next->key = string_dequote(&p);
1213 while (isspace(*p)) p++;
1215 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1216 "missing rewrite replacement string");
1219 next->replacement = string_dequote(&p);
1221 while (*p != 0) switch (*p++)
1223 case ' ': case '\t': break;
1225 case 'q': next->flags |= rewrite_quit; break;
1226 case 'w': next->flags |= rewrite_whole; break;
1228 case 'h': next->flags |= rewrite_all_headers; break;
1229 case 's': next->flags |= rewrite_sender; break;
1230 case 'f': next->flags |= rewrite_from; break;
1231 case 't': next->flags |= rewrite_to; break;
1232 case 'c': next->flags |= rewrite_cc; break;
1233 case 'b': next->flags |= rewrite_bcc; break;
1234 case 'r': next->flags |= rewrite_replyto; break;
1236 case 'E': next->flags |= rewrite_all_envelope; break;
1237 case 'F': next->flags |= rewrite_envfrom; break;
1238 case 'T': next->flags |= rewrite_envto; break;
1240 case 'Q': next->flags |= rewrite_qualify; break;
1241 case 'R': next->flags |= rewrite_repeat; break;
1244 next->flags |= rewrite_smtp;
1245 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1246 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1247 "rewrite rule has the S flag but is not a regular expression");
1251 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1252 "unknown rewrite flag character '%c' "
1253 "(could be missing quotes round replacement item)", p[-1]);
1257 /* If no action flags are set, set all the "normal" rewrites. */
1259 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1260 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1262 /* Remember which exist, for optimization, and return the rule */
1264 *existflags |= next->flags;
1271 /*************************************************
1272 * Read global rewrite information *
1273 *************************************************/
1275 /* Each line is a single rewrite rule; it is parsed into a control block
1276 by readconf_one_rewrite(), and its flags are ORed into the global flag
1277 word rewrite_existflags. */
1280 readconf_rewrites(void)
1282 rewrite_rule **chain = &global_rewrite_rules;
1285 while ((p = get_config_line()) != NULL)
1287 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1289 chain = &(next->next);
1295 /*************************************************
1297 *************************************************/
1299 /* Strings are read into the normal store pool. As long we aren't too
1300 near the end of the current block, the string will just use what is necessary
1301 on the top of the stacking pool, because string_cat() uses the extension
1305 s the rest of the input line
1306 name the option name (for errors)
1308 Returns: pointer to the string
1312 read_string(uschar *s, uschar *name)
1317 if (*s != '\"') return string_copy(s);
1320 yield = string_dequote(&s);
1322 if (s == ss+1 || s[-1] != '\"')
1323 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1324 "missing quote at end of string value for %s", name);
1326 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1332 /*************************************************
1333 * Handle option line *
1334 *************************************************/
1336 /* This function is called from several places to process a line containing the
1337 setting of an option. The first argument is the line to be decoded; it has been
1338 checked not to be empty and not to start with '#'. Trailing newlines and white
1339 space have been removed. The second argument is a pointer to the list of
1340 variable names that are to be recognized, together with their types and
1341 locations, and the third argument gives the number of entries in the list.
1343 The fourth argument is a pointer to a data block. If it is NULL, then the data
1344 values in the options list are absolute addresses. Otherwise, they are byte
1345 offsets in the data block.
1347 String option data may continue onto several lines; this function reads further
1348 data from config_file if necessary.
1350 The yield of this function is normally zero. If a string continues onto
1351 multiple lines, then the data value is permitted to be followed by a comma
1352 or a semicolon (for use in drivers) and the yield is that character.
1355 buffer contains the configuration line to be handled
1356 oltop points to the start of the relevant option list
1357 last one more than the offset of the last item in the option list
1358 data_block NULL when reading main options => data values in the option
1359 list are absolute addresses; otherwise they are byte offsets
1360 in data_block when they have opt_public set; otherwise
1361 they are byte offsets in data_block->options_block.
1362 unknown_txt format string to use in panic message for unknown option;
1363 must contain %s for option name
1364 if given as NULL, don't panic on unknown option
1366 Returns: TRUE if an option was read successfully,
1367 FALSE false for an unknown option if unknown_txt == NULL,
1368 otherwise panic and die on an unknown option
1372 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1373 void *data_block, uschar *unknown_txt)
1377 int n, count, type, value;
1381 BOOL boolvalue = TRUE;
1382 BOOL freesptr = TRUE;
1383 optionlist *ol, *ol2;
1387 uschar *inttype = US"";
1390 uschar *saved_condition, *strtemp;
1391 uschar **str_target;
1395 /* There may be leading spaces; thereafter, we expect an option name starting
1398 while (isspace(*s)) s++;
1400 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1402 /* Read the name of the option, and skip any subsequent white space. If
1403 it turns out that what we read was "hide", set the flag indicating that
1404 this is a secure option, and loop to read the next word. */
1406 for (n = 0; n < 2; n++)
1408 while (isalnum(*s) || *s == '_')
1410 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1414 while (isspace(*s)) s++;
1415 if (Ustrcmp(name, "hide") != 0) break;
1416 issecure = opt_secure;
1420 /* Deal with "no_" or "not_" here for booleans */
1422 if (Ustrncmp(name, "no_", 3) == 0)
1428 if (Ustrncmp(name, "not_", 4) == 0)
1434 /* Search the list for the given name. A non-existent name, or an option that
1435 is set twice, is a disaster. */
1437 ol = find_option(name + offset, oltop, last);
1441 if (unknown_txt == NULL) return FALSE;
1442 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1445 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1446 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1447 "\"%s\" option set for the second time", name);
1449 ol->type |= opt_set | issecure;
1450 type = ol->type & opt_mask;
1452 /* Types with data values must be followed by '='; the "no[t]_" prefix
1453 applies only to boolean values. */
1455 if (type < opt_bool || type > opt_bool_last)
1458 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1459 "negation prefix applied to a non-boolean option");
1461 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1462 "unexpected end of line (data missing) after %s", name);
1464 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1467 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1468 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1469 ultimately expands to one of those values. */
1471 else if (*s != 0 && (offset != 0 || *s != '='))
1472 extra_chars_error(s, US"boolean option ", name, US"");
1474 /* Skip white space after = */
1476 if (*s == '=') while (isspace((*(++s))));
1478 /* If there is a data block and the opt_public flag is not set, change
1479 the data block pointer to the private options block. */
1481 if (data_block != NULL && (ol->type & opt_public) == 0)
1482 data_block = (void *)(((driver_instance *)data_block)->options_block);
1484 /* Now get the data according to the type. */
1488 /* If a string value is not enclosed in quotes, it consists of
1489 the rest of the current line, verbatim. Otherwise, string escapes
1492 A transport is specified as a string, which is then looked up in the
1493 list of transports. A search type is specified as one of a number of
1496 A set or rewrite rules for a driver is specified as a string, which is
1497 then parsed into a suitable chain of control blocks.
1499 Uids and gids are specified as strings which are then looked up in the
1500 passwd file. Lists of uids and gids are similarly specified as colon-
1501 separated strings. */
1506 case opt_expand_uid:
1507 case opt_expand_gid:
1512 reset_point = sptr = read_string(s, name);
1514 /* Having read a string, we now have several different ways of using it,
1515 depending on the data type, so do another switch. If keeping the actual
1516 string is not required (because it is interpreted), freesptr is set TRUE,
1517 and at the end we reset the pool. */
1521 /* If this was a string, set the variable to point to the new string,
1522 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1523 rules, we still keep the string (for printing), and parse the rules into a
1524 control block and flags word. */
1527 if (data_block == NULL)
1528 str_target = (uschar **)(ol->value);
1530 str_target = (uschar **)((uschar *)data_block + (long int)(ol->value));
1531 if (ol->type & opt_rep_con)
1533 /* We already have a condition, we're conducting a crude hack to let
1534 multiple condition rules be chained together, despite storing them in
1536 saved_condition = *str_target;
1537 strtemp = string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1538 saved_condition, sptr);
1539 *str_target = string_copy_malloc(strtemp);
1540 /* TODO(pdp): there is a memory leak here and just below
1541 when we set 3 or more conditions; I still don't
1542 understand the store mechanism enough to know
1543 what's the safe way to free content from an earlier store.
1544 AFAICT, stores stack, so freeing an early stored item also stores
1545 all data alloc'd after it. If we knew conditions were adjacent,
1546 we could survive that, but we don't. So I *think* we need to take
1547 another bit from opt_type to indicate "malloced"; this seems like
1548 quite a hack, especially for this one case. It also means that
1549 we can't ever reclaim the store from the *first* condition.
1551 Because we only do this once, near process start-up, I'm prepared to
1552 let this slide for the time being, even though it rankles. */
1554 else if (*str_target && (ol->type & opt_rep_str))
1556 uschar sep = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1557 saved_condition = *str_target;
1558 strtemp = saved_condition + Ustrlen(saved_condition)-1;
1559 if (*strtemp == sep) *strtemp = 0; /* eliminate trailing list-sep */
1560 strtemp = string_sprintf("%s%c%s", saved_condition, sep, sptr);
1561 *str_target = string_copy_malloc(strtemp);
1571 if (data_block == NULL)
1572 *((uschar **)(ol->value)) = sptr;
1574 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1576 if (type == opt_rewrite)
1581 rewrite_rule **chain;
1584 sprintf(CS name2, "*%.50s_rules", name);
1585 ol2 = find_option(name2, oltop, last);
1586 sprintf(CS name2, "*%.50s_flags", name);
1587 ol3 = find_option(name2, oltop, last);
1589 if (ol2 == NULL || ol3 == NULL)
1590 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1591 "rewrite rules not available for driver");
1593 if (data_block == NULL)
1595 chain = (rewrite_rule **)(ol2->value);
1596 flagptr = (int *)(ol3->value);
1600 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1601 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1604 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1607 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1609 chain = &(next->next);
1612 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1613 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1614 "non-header rewrite - not allowed at transport time -");
1618 /* If it was an expanded uid, see if there is any expansion to be
1619 done by checking for the presence of a $ character. If there is, save it
1620 in the corresponding *expand_user option field. Otherwise, fall through
1621 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1624 case opt_expand_uid:
1625 sprintf(CS name2, "*expand_%.50s", name);
1626 ol2 = find_option(name2, oltop, last);
1629 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1631 if (data_block == NULL)
1632 *((uschar **)(ol2->value)) = ss;
1634 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1638 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1644 /* Look up a fixed uid, and also make use of the corresponding gid
1645 if a passwd entry is returned and the gid has not been set. */
1648 if (!route_finduser(sptr, &pw, &uid))
1649 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1650 if (data_block == NULL)
1651 *((uid_t *)(ol->value)) = uid;
1653 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1655 /* Set the flag indicating a fixed value is set */
1657 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1659 /* Handle matching gid if we have a passwd entry: done by finding the
1660 same name with terminating "user" changed to "group"; if not found,
1661 ignore. Also ignore if the value is already set. */
1663 if (pw == NULL) break;
1664 Ustrcpy(name+Ustrlen(name)-4, "group");
1665 ol2 = find_option(name, oltop, last);
1666 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1667 (ol2->type & opt_mask) == opt_expand_gid))
1669 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1672 if (data_block == NULL)
1673 *((gid_t *)(ol2->value)) = pw->pw_gid;
1675 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1681 /* If it was an expanded gid, see if there is any expansion to be
1682 done by checking for the presence of a $ character. If there is, save it
1683 in the corresponding *expand_user option field. Otherwise, fall through
1684 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1687 case opt_expand_gid:
1688 sprintf(CS name2, "*expand_%.50s", name);
1689 ol2 = find_option(name2, oltop, last);
1692 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1694 if (data_block == NULL)
1695 *((uschar **)(ol2->value)) = ss;
1697 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1701 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1707 /* Handle freestanding gid */
1710 if (!route_findgroup(sptr, &gid))
1711 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1712 if (data_block == NULL)
1713 *((gid_t *)(ol->value)) = gid;
1715 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1716 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1719 /* If it was a uid list, look up each individual entry, and build
1720 a vector of uids, with a count in the first element. Put the vector
1721 in malloc store so we can free the string. (We are reading into
1722 permanent store already.) */
1730 uschar *op = expand_string (sptr);
1733 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1734 name, expand_string_message);
1737 if (*p != 0) count++;
1738 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1739 list = store_malloc(count*sizeof(uid_t));
1740 list[ptr++] = (uid_t)(count - 1);
1742 if (data_block == NULL)
1743 *((uid_t **)(ol->value)) = list;
1745 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1751 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1752 if (!route_finduser(big_buffer, NULL, &uid))
1753 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1760 /* If it was a gid list, look up each individual entry, and build
1761 a vector of gids, with a count in the first element. Put the vector
1762 in malloc store so we can free the string. (We are reading into permanent
1771 uschar *op = expand_string (sptr);
1774 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1775 name, expand_string_message);
1778 if (*p != 0) count++;
1779 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1780 list = store_malloc(count*sizeof(gid_t));
1781 list[ptr++] = (gid_t)(count - 1);
1783 if (data_block == NULL)
1784 *((gid_t **)(ol->value)) = list;
1786 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1792 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1793 if (!route_findgroup(big_buffer, &gid))
1794 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1802 /* Release store if the value of the string doesn't need to be kept. */
1804 if (freesptr) store_reset(reset_point);
1807 /* Expanded boolean: if no characters follow, or if there are no dollar
1808 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1809 save the string for later expansion in the alternate place. */
1811 case opt_expand_bool:
1812 if (*s != 0 && Ustrchr(s, '$') != 0)
1814 sprintf(CS name2, "*expand_%.50s", name);
1815 ol2 = find_option(name2, oltop, last);
1818 reset_point = sptr = read_string(s, name);
1819 if (data_block == NULL)
1820 *((uschar **)(ol2->value)) = sptr;
1822 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1829 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1830 look for yes/not/true/false. Some booleans are stored in a single bit in
1831 a single int. There's a special fudge for verify settings; without a suffix
1832 they set both xx_sender and xx_recipient. The table points to the sender
1833 value; search subsequently for the recipient. There's another special case:
1834 opt_bool_set also notes when a boolean has been set. */
1838 case opt_bool_verify:
1842 s = readconf_readname(name2, 64, s);
1843 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1845 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1847 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1848 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1849 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1850 US"for boolean option ", name);
1853 /* Handle single-bit type. */
1855 if (type == opt_bit)
1857 int bit = 1 << ((ol->type >> 16) & 31);
1858 int *ptr = (data_block == NULL)?
1859 (int *)(ol->value) :
1860 (int *)((uschar *)data_block + (long int)ol->value);
1861 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1865 /* Handle full BOOL types */
1867 if (data_block == NULL)
1868 *((BOOL *)(ol->value)) = boolvalue;
1870 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1874 if (type == opt_bool_verify)
1876 sprintf(CS name2, "%.50s_recipient", name + offset);
1877 ol2 = find_option(name2, oltop, last);
1880 if (data_block == NULL)
1881 *((BOOL *)(ol2->value)) = boolvalue;
1883 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1887 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1889 else if (type == opt_bool_set)
1891 sprintf(CS name2, "*set_%.50s", name + offset);
1892 ol2 = find_option(name2, oltop, last);
1895 if (data_block == NULL)
1896 *((BOOL *)(ol2->value)) = TRUE;
1898 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1907 inttype = US"octal ";
1909 /* Integer: a simple(ish) case; allow octal and hex formats, and
1910 suffixes K and M. The different types affect output, not input. */
1919 lvalue = strtol(CS s, CSS &endptr, intbase);
1922 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1925 if (errno != ERANGE)
1927 if (tolower(*endptr) == 'k')
1929 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1930 else lvalue *= 1024;
1933 else if (tolower(*endptr) == 'm')
1935 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1937 else lvalue *= 1024*1024;
1942 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1943 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1944 "absolute value of integer \"%s\" is too large (overflow)", s);
1946 while (isspace(*endptr)) endptr++;
1948 extra_chars_error(endptr, inttype, US"integer value for ", name);
1950 value = (int)lvalue;
1953 if (data_block == NULL)
1954 *((int *)(ol->value)) = value;
1956 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1959 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1966 value = strtol(CS s, CSS &endptr, intbase);
1969 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1972 if (errno != ERANGE)
1974 if (tolower(*endptr) == 'm')
1976 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1980 else if (tolower(*endptr) == 'k')
1986 value = (value + 512)/1024;
1990 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1991 "absolute value of integer \"%s\" is too large (overflow)", s);
1993 while (isspace(*endptr)) endptr++;
1995 extra_chars_error(endptr, inttype, US"integer value for ", name);
1998 if (data_block == NULL)
1999 *((int *)(ol->value)) = value;
2001 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2004 /* Fixed-point number: held to 3 decimal places. */
2007 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2008 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2009 "fixed-point number expected for %s", name);
2011 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2012 "integer \"%s\" is too large (overflow)", s);
2016 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2017 "integer \"%s\" is too large (overflow)", s);
2019 if (s[count] == '.')
2022 while (isdigit(s[++count]))
2024 value += (s[count] - '0') * d;
2029 while (isspace(s[count])) count++;
2032 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2034 if (data_block == NULL)
2035 *((int *)(ol->value)) = value;
2037 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2040 /* There's a special routine to read time values. */
2043 value = readconf_readtime(s, 0, FALSE);
2045 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2047 if (data_block == NULL)
2048 *((int *)(ol->value)) = value;
2050 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2053 /* A time list is a list of colon-separated times, with the first
2054 element holding the size of the list and the second the number of
2060 int *list = (data_block == NULL)?
2061 (int *)(ol->value) :
2062 (int *)((uschar *)data_block + (long int)(ol->value));
2064 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2067 uschar *snext = Ustrchr(s, ':');
2071 while (ss > s && isspace(ss[-1])) ss--;
2074 value = readconf_readtime(s, terminator, FALSE);
2076 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2078 if (count > 1 && value <= list[count])
2079 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2080 "time value out of order for %s", name);
2081 list[count+1] = value;
2082 if (snext == NULL) break;
2084 while (isspace(*s)) s++;
2087 if (count > list[0] - 2)
2088 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2090 if (count > 0 && list[2] == 0) count = 0;
2102 /*************************************************
2103 * Print a time value *
2104 *************************************************/
2107 Argument: a time value in seconds
2108 Returns: pointer to a fixed buffer containing the time as a string,
2109 in readconf_readtime() format
2113 readconf_printtime(int t)
2116 uschar *p = time_buffer;
2133 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2134 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2135 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2136 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2137 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2144 /*************************************************
2145 * Print an individual option value *
2146 *************************************************/
2148 /* This is used by the -bP option, so prints to the standard output.
2149 The entire options list is passed in as an argument, because some options come
2150 in pairs - typically uid/gid settings, which can either be explicit numerical
2151 values, or strings to be expanded later. If the numerical value is unset,
2152 search for "*expand_<name>" to see if there is a string equivalent.
2155 ol option entry, or NULL for an unknown option
2157 options_block NULL for main configuration options; otherwise points to
2158 a driver block; if the option doesn't have opt_public
2159 set, then options_block->options_block is where the item
2161 oltop points to the option list in which ol exists
2162 last one more than the offset of the last entry in optop
2163 no_labels do not show "foo = " at the start.
2169 print_ol(optionlist *ol, uschar *name, void *options_block,
2170 optionlist *oltop, int last, BOOL no_labels)
2183 printf("%s is not a known option\n", name);
2187 /* Non-admin callers cannot see options that have been flagged secure by the
2190 if (!admin_user && (ol->type & opt_secure) != 0)
2192 const char * const hidden = "<value not displayable>";
2194 printf("%s\n", hidden);
2196 printf("%s = %s\n", name, hidden);
2200 /* Else show the value of the option */
2203 if (options_block != NULL)
2205 if ((ol->type & opt_public) == 0)
2206 options_block = (void *)(((driver_instance *)options_block)->options_block);
2207 value = (void *)((uschar *)options_block + (long int)value);
2210 switch(ol->type & opt_mask)
2213 case opt_rewrite: /* Show the text value */
2214 s = *((uschar **)value);
2215 if (!no_labels) printf("%s = ", name);
2216 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2220 if (!no_labels) printf("%s = ", name);
2221 printf("%d\n", *((int *)value));
2226 int x = *((int *)value);
2227 if (x != 0 && (x & 1023) == 0)
2231 if ((x & 1023) == 0)
2236 if (!no_labels) printf("%s = ", name);
2237 printf("%d%c\n", x, c);
2241 if (!no_labels) printf("%s = ", name);
2249 int x = *((int *)value);
2250 if (!no_labels) printf("%s = ", name);
2251 if (x == 0) printf("0\n");
2252 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2253 else printf("%dK\n", x);
2258 if (!no_labels) printf("%s = ", name);
2259 printf("%#o\n", *((int *)value));
2262 /* Can be negative only when "unset", in which case integer */
2266 int x = *((int *)value);
2269 if (x < 0) printf("%s =\n", name); else
2271 if (!no_labels) printf("%s = ", name);
2272 printf("%d.", x/1000);
2285 /* If the numerical value is unset, try for the string value */
2287 case opt_expand_uid:
2288 if (! *get_set_flag(name, oltop, last, options_block))
2290 sprintf(CS name2, "*expand_%.50s", name);
2291 ol2 = find_option(name2, oltop, last);
2294 void *value2 = ol2->value;
2295 if (options_block != NULL)
2296 value2 = (void *)((uschar *)options_block + (long int)value2);
2297 s = *((uschar **)value2);
2298 if (!no_labels) printf("%s = ", name);
2299 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2304 /* Else fall through */
2307 if (!no_labels) printf("%s = ", name);
2308 if (! *get_set_flag(name, oltop, last, options_block))
2312 pw = getpwuid(*((uid_t *)value));
2314 printf("%ld\n", (long int)(*((uid_t *)value)));
2315 else printf("%s\n", pw->pw_name);
2319 /* If the numerical value is unset, try for the string value */
2321 case opt_expand_gid:
2322 if (! *get_set_flag(name, oltop, last, options_block))
2324 sprintf(CS name2, "*expand_%.50s", name);
2325 ol2 = find_option(name2, oltop, last);
2326 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2328 void *value2 = ol2->value;
2329 if (options_block != NULL)
2330 value2 = (void *)((uschar *)options_block + (long int)value2);
2331 s = *((uschar **)value2);
2332 if (!no_labels) printf("%s = ", name);
2333 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2338 /* Else fall through */
2341 if (!no_labels) printf("%s = ", name);
2342 if (! *get_set_flag(name, oltop, last, options_block))
2346 gr = getgrgid(*((int *)value));
2348 printf("%ld\n", (long int)(*((int *)value)));
2349 else printf("%s\n", gr->gr_name);
2354 uidlist = *((uid_t **)value);
2355 if (!no_labels) printf("%s =", name);
2356 if (uidlist != NULL)
2360 if (no_labels) sep = '\0';
2361 for (i = 1; i <= (int)(uidlist[0]); i++)
2363 uschar *name = NULL;
2364 pw = getpwuid(uidlist[i]);
2365 if (pw != NULL) name = US pw->pw_name;
2366 if (sep != '\0') printf("%c", sep);
2367 if (name != NULL) printf("%s", name);
2368 else printf("%ld", (long int)(uidlist[i]));
2376 gidlist = *((gid_t **)value);
2377 if (!no_labels) printf("%s =", name);
2378 if (gidlist != NULL)
2382 if (no_labels) sep = '\0';
2383 for (i = 1; i <= (int)(gidlist[0]); i++)
2385 uschar *name = NULL;
2386 gr = getgrgid(gidlist[i]);
2387 if (gr != NULL) name = US gr->gr_name;
2388 if (sep != '\0') printf("%c", sep);
2389 if (name != NULL) printf("%s", name);
2390 else printf("%ld", (long int)(gidlist[i]));
2398 if (!no_labels) printf("%s = ", name);
2399 printf("%s\n", readconf_printtime(*((int *)value)));
2405 int *list = (int *)value;
2406 if (!no_labels) printf("%s = ", name);
2407 for (i = 0; i < list[1]; i++)
2408 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2414 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2418 case opt_expand_bool:
2419 sprintf(CS name2, "*expand_%.50s", name);
2420 ol2 = find_option(name2, oltop, last);
2421 if (ol2 != NULL && ol2->value != NULL)
2423 void *value2 = ol2->value;
2424 if (options_block != NULL)
2425 value2 = (void *)((uschar *)options_block + (long int)value2);
2426 s = *((uschar **)value2);
2429 if (!no_labels) printf("%s = ", name);
2430 printf("%s\n", string_printing(s));
2433 /* s == NULL => string not set; fall through */
2439 case opt_bool_verify:
2441 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2448 /*************************************************
2449 * Print value from main configuration *
2450 *************************************************/
2452 /* This function, called as a result of encountering the -bP option,
2453 causes the value of any main configuration variable to be output if the
2454 second argument is NULL. There are some special values:
2456 all print all main configuration options
2457 configure_file print the name of the configuration file
2458 routers print the routers' configurations
2459 transports print the transports' configuration
2460 authenticators print the authenticators' configuration
2461 macros print the macros' configuration
2462 router_list print a list of router names
2463 transport_list print a list of transport names
2464 authenticator_list print a list of authentication mechanism names
2465 macro_list print a list of macro names
2466 +name print a named list item
2467 local_scan print the local_scan options
2469 If the second argument is not NULL, it must be one of "router", "transport",
2470 "authenticator" or "macro" in which case the first argument identifies the
2471 driver whose options are to be printed.
2474 name option name if type == NULL; else driver name
2475 type NULL or driver type name, as described above
2476 no_labels avoid the "foo = " at the start of an item
2482 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2484 BOOL names_only = FALSE;
2486 optionlist *ol2 = NULL;
2487 driver_instance *d = NULL;
2498 static uschar *types[] = { US"address", US"domain", US"host",
2500 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2501 &hostlist_anchor, &localpartlist_anchor };
2503 for (i = 0; i < 4; i++)
2505 t = tree_search(*(anchors[i]), name+1);
2510 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2512 printf("%slist %s = %s\n", types[i], name+1,
2513 ((namedlist_block *)(t->data.ptr))->string);
2518 printf("no address, domain, host, or local part list called \"%s\" "
2519 "exists\n", name+1);
2524 if (Ustrcmp(name, "configure_file") == 0)
2526 printf("%s\n", CS config_main_filename);
2530 if (Ustrcmp(name, "all") == 0)
2532 for (ol = optionlist_config;
2533 ol < optionlist_config + optionlist_config_size; ol++)
2535 if ((ol->type & opt_hidden) == 0)
2536 print_ol(ol, US ol->name, NULL,
2537 optionlist_config, optionlist_config_size,
2543 if (Ustrcmp(name, "local_scan") == 0)
2545 #ifndef LOCAL_SCAN_HAS_OPTIONS
2546 printf("local_scan() options are not supported\n");
2548 for (ol = local_scan_options;
2549 ol < local_scan_options + local_scan_options_count; ol++)
2551 print_ol(ol, US ol->name, NULL, local_scan_options,
2552 local_scan_options_count, no_labels);
2558 if (Ustrcmp(name, "routers") == 0)
2563 else if (Ustrcmp(name, "transports") == 0)
2565 type = US"transport";
2569 else if (Ustrcmp(name, "authenticators") == 0)
2571 type = US"authenticator";
2575 else if (Ustrcmp(name, "macros") == 0)
2581 else if (Ustrcmp(name, "router_list") == 0)
2588 else if (Ustrcmp(name, "transport_list") == 0)
2590 type = US"transport";
2595 else if (Ustrcmp(name, "authenticator_list") == 0)
2597 type = US"authenticator";
2602 else if (Ustrcmp(name, "macro_list") == 0)
2611 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2612 name, NULL, optionlist_config, optionlist_config_size, no_labels);
2617 /* Handle the options for a router or transport. Skip options that are flagged
2618 as hidden. Some of these are options with names starting with '*', used for
2619 internal alternative representations of other options (which the printing
2620 function will sort out). Others are synonyms kept for backward compatibility.
2623 if (Ustrcmp(type, "router") == 0)
2625 d = (driver_instance *)routers;
2626 ol2 = optionlist_routers;
2627 size = optionlist_routers_size;
2629 else if (Ustrcmp(type, "transport") == 0)
2631 d = (driver_instance *)transports;
2632 ol2 = optionlist_transports;
2633 size = optionlist_transports_size;
2635 else if (Ustrcmp(type, "authenticator") == 0)
2637 d = (driver_instance *)auths;
2638 ol2 = optionlist_auths;
2639 size = optionlist_auths_size;
2642 else if (Ustrcmp(type, "macro") == 0)
2644 /* People store passwords in macros and they were previously not available
2645 for printing. So we have an admin_users restriction. */
2648 fprintf(stderr, "exim: permission denied\n");
2651 for (m = macros; m != NULL; m = m->next)
2653 if (name == NULL || Ustrcmp(name, m->name) == 0)
2656 printf("%s\n", CS m->name);
2658 printf("%s=%s\n", CS m->name, CS m->replacement);
2664 printf("%s %s not found\n", type, name);
2670 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2674 /* Either search for a given driver, or print all of them */
2676 for (; d != NULL; d = d->next)
2679 printf("\n%s %s:\n", d->name, type);
2680 else if (Ustrcmp(d->name, name) != 0) continue;
2682 for (ol = ol2; ol < ol2 + size; ol++)
2684 if ((ol->type & opt_hidden) == 0)
2685 print_ol(ol, US ol->name, d, ol2, size, no_labels);
2688 for (ol = d->info->options;
2689 ol < d->info->options + *(d->info->options_count); ol++)
2691 if ((ol->type & opt_hidden) == 0)
2692 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
2694 if (name != NULL) return;
2696 if (name != NULL) printf("%s %s not found\n", type, name);
2701 /*************************************************
2702 * Read a named list item *
2703 *************************************************/
2705 /* This function reads a name and a list (i.e. string). The name is used to
2706 save the list in a tree, sorted by its name. Each entry also has a number,
2707 which can be used for caching tests, but if the string contains any expansion
2708 items other than $key, the number is set negative to inhibit caching. This
2709 mechanism is used for domain, host, and address lists that are referenced by
2713 anchorp points to the tree anchor
2714 numberp points to the current number for this tree
2715 max the maximum number permitted
2716 s the text of the option line, starting immediately after the name
2718 tname the name of the list type, for messages
2724 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2727 BOOL forcecache = FALSE;
2730 namedlist_block *nb = store_get(sizeof(namedlist_block));
2732 if (Ustrncmp(s, "_cache", 6) == 0)
2739 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2741 if (*numberp >= max)
2742 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2745 while (isspace(*s)) s++;
2747 while (isalnum(*s) || *s == '_') s++;
2748 t = store_get(sizeof(tree_node) + s-ss);
2749 Ustrncpy(t->name, ss, s-ss);
2751 while (isspace(*s)) s++;
2753 if (!tree_insertnode(anchorp, t))
2754 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2755 "duplicate name \"%s\" for a named %s", t->name, tname);
2758 nb->number = *numberp;
2761 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2762 "missing '=' after \"%s\"", t->name);
2763 while (isspace(*s)) s++;
2764 nb->string = read_string(s, t->name);
2765 nb->cache_data = NULL;
2767 /* Check the string for any expansions; if any are found, mark this list
2768 uncacheable unless the user has explicited forced caching. */
2770 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2776 /*************************************************
2777 * Unpick data for a rate limit *
2778 *************************************************/
2780 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2784 s string, in the form t,b,f,l
2785 where t is the threshold (integer)
2786 b is the initial delay (time)
2787 f is the multiplicative factor (fixed point)
2788 k is the maximum time (time)
2789 threshold where to store threshold
2790 base where to store base in milliseconds
2791 factor where to store factor in milliseconds
2792 limit where to store limit
2794 Returns: nothing (panics on error)
2798 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2801 uschar bstring[16], lstring[16];
2803 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2804 factor, lstring) == 4)
2806 *base = readconf_readtime(bstring, 0, TRUE);
2807 *limit = readconf_readtime(lstring, 0, TRUE);
2808 if (*base >= 0 && *limit >= 0) return;
2810 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2816 /*************************************************
2817 * Drop privs for checking TLS config *
2818 *************************************************/
2820 /* We want to validate TLS options during readconf, but do not want to be
2821 root when we call into the TLS library, in case of library linkage errors
2822 which cause segfaults; before this check, those were always done as the Exim
2823 runtime user and it makes sense to continue with that.
2825 Assumes: tls_require_ciphers has been set, if it will be
2826 exim_user has been set, if it will be
2827 exim_group has been set, if it will be
2829 Returns: bool for "okay"; false will cause caller to immediately exit.
2834 tls_dropprivs_validate_require_cipher(void)
2836 const uschar *errmsg;
2839 void (*oldsignal)(int);
2841 oldsignal = signal(SIGCHLD, SIG_DFL);
2844 if ((pid = fork()) < 0)
2845 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2849 /* in some modes, will have dropped privilege already */
2851 exim_setugid(exim_uid, exim_gid, FALSE,
2852 US"calling tls_validate_require_cipher");
2854 errmsg = tls_validate_require_cipher();
2857 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2858 "tls_require_ciphers invalid: %s", errmsg);
2865 rc = waitpid(pid, &status, 0);
2866 } while (rc < 0 && errno == EINTR);
2869 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
2872 signal(SIGCHLD, oldsignal);
2876 #endif /* SUPPORT_TLS */
2881 /*************************************************
2882 * Read main configuration options *
2883 *************************************************/
2885 /* This function is the first to be called for configuration reading. It
2886 opens the configuration file and reads general configuration settings until
2887 it reaches the end of the configuration section. The file is then left open so
2888 that the remaining configuration data can subsequently be read if needed for
2891 The configuration file must be owned either by root or exim, and be writeable
2892 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2893 in the config file, so the test is done on the compiled in values. A slight
2894 anomaly, to be carefully documented.
2896 The name of the configuration file is taken from a list that is included in the
2897 binary of Exim. It can be altered from the command line, but if that is done,
2898 root privilege is immediately withdrawn unless the caller is root or exim.
2899 The first file on the list that exists is used.
2901 For use on multiple systems that share file systems, first look for a
2902 configuration file whose name has the current node name on the end. If that is
2903 not found, try the generic name. For really contorted configurations, that run
2904 multiple Exims with different uid settings, first try adding the effective uid
2905 before the node name. These complications are going to waste resources on most
2906 systems. Therefore they are available only when requested by compile-time
2913 struct stat statbuf;
2914 uschar *s, *filename;
2915 uschar *list = config_main_filelist;
2917 /* Loop through the possible file names */
2919 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2922 /* Cut out all the fancy processing unless specifically wanted */
2924 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2925 uschar *suffix = filename + Ustrlen(filename);
2927 /* Try for the node-specific file if a node name exists */
2929 #ifdef CONFIGURE_FILE_USE_NODE
2931 if (uname(&uts) >= 0)
2933 #ifdef CONFIGURE_FILE_USE_EUID
2934 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2935 config_file = Ufopen(filename, "rb");
2936 if (config_file == NULL)
2937 #endif /* CONFIGURE_FILE_USE_EUID */
2939 sprintf(CS suffix, ".%.256s", uts.nodename);
2940 config_file = Ufopen(filename, "rb");
2943 #endif /* CONFIGURE_FILE_USE_NODE */
2945 /* Otherwise, try the generic name, possibly with the euid added */
2947 #ifdef CONFIGURE_FILE_USE_EUID
2948 if (config_file == NULL)
2950 sprintf(CS suffix, ".%ld", (long int)original_euid);
2951 config_file = Ufopen(filename, "rb");
2953 #endif /* CONFIGURE_FILE_USE_EUID */
2955 /* Finally, try the unadorned name */
2957 if (config_file == NULL)
2960 config_file = Ufopen(filename, "rb");
2962 #else /* if neither defined */
2964 /* This is the common case when the fancy processing is not included. */
2966 config_file = Ufopen(filename, "rb");
2969 /* If the file does not exist, continue to try any others. For any other
2970 error, break out (and die). */
2972 if (config_file != NULL || errno != ENOENT) break;
2975 /* On success, save the name for verification; config_filename is used when
2976 logging configuration errors (it changes for .included files) whereas
2977 config_main_filename is the name shown by -bP. Failure to open a configuration
2978 file is a serious disaster. */
2980 if (config_file != NULL)
2982 config_filename = config_main_filename = string_copy(filename);
2986 if (filename == NULL)
2987 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2988 "%s", config_main_filelist);
2990 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2991 "configuration file %s", filename));
2994 /* Check the status of the file we have opened, if we have retained root
2995 privileges and the file isn't /dev/null (which *should* be 0666). */
2997 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
2999 if (fstat(fileno(config_file), &statbuf) != 0)
3000 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3003 if ((statbuf.st_uid != root_uid /* owner not root */
3004 #ifdef CONFIGURE_OWNER
3005 && statbuf.st_uid != config_uid /* owner not the special one */
3008 (statbuf.st_gid != root_gid /* group not root & */
3009 #ifdef CONFIGURE_GROUP
3010 && statbuf.st_gid != config_gid /* group not the special one */
3012 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3014 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3016 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3017 "wrong owner, group, or mode", big_buffer);
3020 /* Process the main configuration settings. They all begin with a lower case
3021 letter. If we see something starting with an upper case letter, it is taken as
3022 a macro definition. */
3024 while ((s = get_config_line()) != NULL)
3026 if (isupper(s[0])) read_macro_assignment(s);
3028 else if (Ustrncmp(s, "domainlist", 10) == 0)
3029 read_named_list(&domainlist_anchor, &domainlist_count,
3030 MAX_NAMED_LIST, s+10, US"domain list");
3032 else if (Ustrncmp(s, "hostlist", 8) == 0)
3033 read_named_list(&hostlist_anchor, &hostlist_count,
3034 MAX_NAMED_LIST, s+8, US"host list");
3036 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3037 read_named_list(&addresslist_anchor, &addresslist_count,
3038 MAX_NAMED_LIST, s+11, US"address list");
3040 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3041 read_named_list(&localpartlist_anchor, &localpartlist_count,
3042 MAX_NAMED_LIST, s+13, US"local part list");
3045 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3046 NULL, US"main option \"%s\" unknown");
3050 /* If local_sender_retain is set, local_from_check must be unset. */
3052 if (local_sender_retain && local_from_check)
3053 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3054 "local_sender_retain are set; this combination is not allowed");
3056 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3059 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3061 /* The max retry interval must not be greater than 24 hours. */
3063 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3065 /* remote_max_parallel must be > 0 */
3067 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3069 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3070 start of a new SMTP message. */
3072 freeze_tell_config = freeze_tell;
3074 /* The primary host name may be required for expansion of spool_directory
3075 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3076 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3077 canonize it. Some people like upper case letters in their host names, so we
3078 don't force the case. */
3080 if (primary_hostname == NULL)
3084 if (uname(&uts) < 0)
3085 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3086 hostname = US uts.nodename;
3088 if (Ustrchr(hostname, '.') == NULL)
3091 struct hostent *hostdata;
3094 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3095 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
3105 #if HAVE_GETIPNODEBYNAME
3107 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3109 hostdata = gethostbyname2(CS hostname, af);
3112 hostdata = gethostbyname(CS hostname);
3115 if (hostdata != NULL)
3117 hostname = US hostdata->h_name;
3121 if (af == AF_INET) break;
3126 primary_hostname = string_copy(hostname);
3129 /* Set up default value for smtp_active_hostname */
3131 smtp_active_hostname = primary_hostname;
3133 /* If spool_directory wasn't set in the build-time configuration, it must have
3134 got set above. Of course, writing to the log may not work if log_file_path is
3135 not set, but it will at least get to syslog or somewhere, with any luck. */
3137 if (*spool_directory == 0)
3138 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3141 /* Expand the spool directory name; it may, for example, contain the primary
3142 host name. Same comment about failure. */
3144 s = expand_string(spool_directory);
3146 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3147 "\"%s\": %s", spool_directory, expand_string_message);
3148 spool_directory = s;
3150 /* Expand log_file_path, which must contain "%s" in any component that isn't
3151 the null string or "syslog". It is also allowed to contain one instance of %D
3152 or %M. However, it must NOT contain % followed by anything else. */
3154 if (*log_file_path != 0)
3157 int sep = ':'; /* Fixed for log file path */
3158 s = expand_string(log_file_path);
3160 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3161 "\"%s\": %s", log_file_path, expand_string_message);
3164 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3167 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3168 t = Ustrstr(sss, "%s");
3170 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3171 "contain \"%%s\"", sss);
3173 t = Ustrchr(sss, '%');
3176 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3177 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3178 "unexpected \"%%\" character", s);
3185 /* Interpret syslog_facility into an integer argument for 'ident' param to
3186 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3189 if (syslog_facility_str != NULL)
3192 uschar *s = syslog_facility_str;
3194 if ((Ustrlen(syslog_facility_str) >= 4) &&
3195 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3198 for (i = 0; i < syslog_list_size; i++)
3200 if (strcmpic(s, syslog_list[i].name) == 0)
3202 syslog_facility = syslog_list[i].value;
3207 if (i >= syslog_list_size)
3209 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3210 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3214 /* Expand pid_file_path */
3216 if (*pid_file_path != 0)
3218 s = expand_string(pid_file_path);
3220 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3221 "\"%s\": %s", pid_file_path, expand_string_message);
3225 /* Set default value of process_log_path */
3227 if (process_log_path == NULL || *process_log_path =='\0')
3228 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3230 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3233 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3235 /* Unpick the SMTP rate limiting options, if set */
3237 if (smtp_ratelimit_mail != NULL)
3239 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3240 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3243 if (smtp_ratelimit_rcpt != NULL)
3245 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3246 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3249 /* The qualify domains default to the primary host name */
3251 if (qualify_domain_sender == NULL)
3252 qualify_domain_sender = primary_hostname;
3253 if (qualify_domain_recipient == NULL)
3254 qualify_domain_recipient = qualify_domain_sender;
3256 /* Setting system_filter_user in the configuration sets the gid as well if a
3257 name is given, but a numerical value does not. */
3259 if (system_filter_uid_set && !system_filter_gid_set)
3261 struct passwd *pw = getpwuid(system_filter_uid);
3263 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3264 (long int)system_filter_uid);
3265 system_filter_gid = pw->pw_gid;
3266 system_filter_gid_set = TRUE;
3269 /* If the errors_reply_to field is set, check that it is syntactically valid
3270 and ensure it contains a domain. */
3272 if (errors_reply_to != NULL)
3275 int start, end, domain;
3276 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3277 &start, &end, &domain, FALSE);
3279 if (recipient == NULL)
3280 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3281 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3284 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3285 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3288 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3289 smtp_accept_max must also be set. */
3291 if (smtp_accept_max == 0 &&
3292 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3293 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3294 "smtp_accept_max must be set if smtp_accept_queue or "
3295 "smtp_accept_max_per_host is set");
3297 /* Set up the host number if anything is specified. It is an expanded string
3298 so that it can be computed from the host name, for example. We do this last
3299 so as to ensure that everything else is set up before the expansion. */
3301 if (host_number_string != NULL)
3305 uschar *s = expand_string(host_number_string);
3307 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3308 "failed to expand localhost_number \"%s\": %s",
3309 host_number_string, expand_string_message);
3310 n = Ustrtol(s, &end, 0);
3311 while (isspace(*end)) end++;
3313 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3314 "localhost_number value is not a number: %s", s);
3315 if (n > LOCALHOST_MAX)
3316 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3317 "localhost_number is greater than the maximum allowed value (%d)",
3323 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3325 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3326 tls_verify_certificates == NULL)
3327 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3328 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3329 (tls_verify_hosts != NULL)? "" : "try_");
3331 /* This also checks that the library linkage is working and we can call
3332 routines in it, so call even if tls_require_ciphers is unset */
3333 if (!tls_dropprivs_validate_require_cipher())
3336 /* Magic number: at time of writing, 1024 has been the long-standing value
3337 used by so many clients, and what Exim used to use always, that it makes
3338 sense to just min-clamp this max-clamp at that. */
3339 if (tls_dh_max_bits < 1024)
3340 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3341 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3343 /* If openssl_options is set, validate it */
3344 if (openssl_options != NULL)
3347 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3348 "openssl_options is set but we're using GnuTLS");
3351 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3352 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3353 "openssl_options parse error: %s", openssl_options);
3361 /*************************************************
3362 * Initialize one driver *
3363 *************************************************/
3365 /* This is called once the driver's generic options, if any, have been read.
3366 We can now find the driver, set up defaults for the private options, and
3367 unset any "set" bits in the private options table (which might have been
3368 set by another incarnation of the same driver).
3371 d pointer to driver instance block, with generic
3373 drivers_available vector of available drivers
3374 size_of_info size of each block in drivers_available
3375 class class of driver, for error message
3377 Returns: pointer to the driver info block
3380 static driver_info *
3381 init_driver(driver_instance *d, driver_info *drivers_available,
3382 int size_of_info, uschar *class)
3386 for (dd = drivers_available; dd->driver_name[0] != 0;
3387 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3389 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3392 int len = dd->options_len;
3394 d->options_block = store_get(len);
3395 memcpy(d->options_block, dd->options_block, len);
3396 for (i = 0; i < *(dd->options_count); i++)
3397 dd->options[i].type &= ~opt_set;
3402 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3403 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3405 return NULL; /* never obeyed */
3411 /*************************************************
3412 * Initialize driver list *
3413 *************************************************/
3415 /* This function is called for routers, transports, and authentication
3416 mechanisms. It reads the data from the current point in the configuration file
3417 up to the end of the section, and sets up a chain of instance blocks according
3418 to the file's contents. The file will already have been opened by a call to
3419 readconf_main, and must be left open for subsequent reading of further data.
3421 Any errors cause a panic crash. Note that the blocks with names driver_info and
3422 driver_instance must map the first portions of all the _info and _instance
3423 blocks for this shared code to work.
3426 class "router", "transport", or "authenticator"
3427 anchor &routers, &transports, &auths
3428 drivers_available available drivers
3429 size_of_info size of each info block
3430 instance_default points to default data for an instance
3431 instance_size size of instance block
3432 driver_optionlist generic option list
3433 driver_optionlist_count count of generic option list
3439 readconf_driver_init(
3441 driver_instance **anchor,
3442 driver_info *drivers_available,
3444 void *instance_default,
3446 optionlist *driver_optionlist,
3447 int driver_optionlist_count)
3449 driver_instance **p = anchor;
3450 driver_instance *d = NULL;
3453 while ((buffer = get_config_line()) != NULL)
3458 /* Read the first name on the line and test for the start of a new driver. A
3459 macro definition indicates the end of the previous driver. If this isn't the
3460 start of a new driver, the line will be re-read. */
3462 s = readconf_readname(name, sizeof(name), buffer);
3464 /* Handle macro definition, first finishing off the initialization of the
3465 previous driver, if any. */
3467 if (isupper(*name) && *s == '=')
3471 if (d->driver_name == NULL)
3472 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3473 "no driver defined for %s \"%s\"", class, d->name);
3477 read_macro_assignment(buffer);
3481 /* If the line starts with a name terminated by a colon, we are at the
3482 start of the definition of a new driver. The rest of the line must be
3489 /* Finish off initializing the previous driver. */
3493 if (d->driver_name == NULL)
3494 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3495 "no driver defined for %s \"%s\"", class, d->name);
3499 /* Check that we haven't already got a driver of this name */
3501 for (d = *anchor; d != NULL; d = d->next)
3502 if (Ustrcmp(name, d->name) == 0)
3503 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3504 "there are two %ss called \"%s\"", class, name);
3506 /* Set up a new driver instance data block on the chain, with
3507 its default values installed. */
3509 d = store_get(instance_size);
3510 memcpy(d, instance_default, instance_size);
3513 d->name = string_copy(name);
3515 /* Clear out the "set" bits in the generic options */
3517 for (i = 0; i < driver_optionlist_count; i++)
3518 driver_optionlist[i].type &= ~opt_set;
3520 /* Check nothing more on this line, then do the next loop iteration. */
3522 while (isspace(*s)) s++;
3523 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3527 /* Not the start of a new driver. Give an error if we have not set up a
3528 current driver yet. */
3530 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3531 "%s name missing", class);
3533 /* First look to see if this is a generic option; if it is "driver",
3534 initialize the driver. If is it not a generic option, we can look for a
3535 private option provided that the driver has been previously set up. */
3537 if (readconf_handle_option(buffer, driver_optionlist,
3538 driver_optionlist_count, d, NULL))
3540 if (d->info == NULL && d->driver_name != NULL)
3541 init_driver(d, drivers_available, size_of_info, class);
3544 /* Handle private options - pass the generic block because some may
3545 live therein. A flag with each option indicates if it is in the public
3548 else if (d->info != NULL)
3550 readconf_handle_option(buffer, d->info->options,
3551 *(d->info->options_count), d, US"option \"%s\" unknown");
3554 /* The option is not generic and the driver name has not yet been given. */
3556 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3557 "(\"driver\" must be specified before any private options)", name);
3560 /* Run the initialization function for the final driver. */
3564 if (d->driver_name == NULL)
3565 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3566 "no driver defined for %s \"%s\"", class, d->name);
3573 /*************************************************
3574 * Check driver dependency *
3575 *************************************************/
3577 /* This function is passed a driver instance and a string. It checks whether
3578 any of the string options for the driver contains the given string as an
3582 d points to a driver instance block
3583 s the string to search for
3585 Returns: TRUE if a dependency is found
3589 readconf_depends(driver_instance *d, uschar *s)
3591 int count = *(d->info->options_count);
3595 for (ol = d->info->options; ol < d->info->options + count; ol++)
3597 void *options_block;
3599 int type = ol->type & opt_mask;
3600 if (type != opt_stringptr) continue;
3601 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3602 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3603 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3605 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3606 isalnum(ss[Ustrlen(s)])) continue;
3607 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3608 d->name, ol->name, s);
3613 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3620 /*************************************************
3621 * Decode an error type for retries *
3622 *************************************************/
3624 /* This function is global because it is also called from the main
3625 program when testing retry information. It decodes strings such as "quota_7d"
3626 into numerical error codes.
3629 pp points to start of text
3630 p points past end of text
3631 basic_errno points to an int to receive the main error number
3632 more_errno points to an int to receive the secondary error data
3634 Returns: NULL if decoded correctly; else points to error text
3638 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3642 while (q < p && *q != '_') q++;
3645 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3647 *basic_errno = ERRNO_EXIMQUOTA;
3648 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3649 return US"bad time value";
3652 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3654 *basic_errno = ECONNREFUSED;
3657 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3658 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3659 else return US"A or MX expected after \"refused\"";
3663 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3665 *basic_errno = ETIMEDOUT;
3669 int xlen = p - q - 1;
3672 static uschar *extras[] =
3673 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3674 static int values[] =
3675 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3677 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3679 if (strncmpic(x, extras[i], xlen) == 0)
3681 *more_errno = values[i];
3686 if (i >= sizeof(extras)/sizeof(uschar *))
3688 if (strncmpic(x, US"DNS", xlen) == 0)
3690 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3691 "available in retry rules (it has never worked) - treated as "
3694 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3699 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3700 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3701 strncmpic(pp, US"data_4", 6) == 0)
3704 int x = 255; /* means "any 4xx code" */
3705 if (p != pp + 8) bad = TRUE; else
3707 int a = pp[6], b = pp[7];
3711 if (isdigit(b)) x += b - '0';
3712 else if (b == 'x') x += 100;
3715 else if (a != 'x' || b != 'x') bad = TRUE;
3719 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3720 "x is literal and d is any digit", pp);
3722 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3723 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3724 *more_errno = x << 8;
3727 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3728 strncmpic(q+1, US"failed", p-q-1) == 0)
3729 *basic_errno = ERRNO_AUTHFAIL;
3731 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3732 *basic_errno = ERRNO_SMTPCLOSED;
3734 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3735 *basic_errno = ERRNO_TLSREQUIRED;
3737 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3738 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3746 /*************************************************
3747 * Read retry information *
3748 *************************************************/
3750 /* Each line of retry information contains:
3752 . A domain name pattern or an address pattern;
3754 . An error name, possibly with additional data, or *;
3756 . An optional sequence of retry items, each consisting of an identifying
3757 letter, a cutoff time, and optional parameters.
3759 All this is decoded and placed into a control block. */
3762 /* Subroutine to read an argument, preceded by a comma and terminated
3763 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3764 1 = fixed point number (returned *1000).
3767 paddr pointer to pointer to current character; updated
3768 type 0 => read a time; 1 => read a fixed point number
3770 Returns: time in seconds or fixed point number * 1000
3774 retry_arg(uschar **paddr, int type)
3779 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3781 while (isspace(*p)) p++;
3783 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3785 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3786 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3792 return readconf_readtime(pp, *p, FALSE);
3794 return readconf_readfixed(pp, *p);
3796 return 0; /* Keep picky compilers happy */
3799 /* The function proper */
3802 readconf_retries(void)
3804 retry_config **chain = &retries;
3808 while ((p = get_config_line()) != NULL)
3810 retry_rule **rchain;
3813 next = store_get(sizeof(retry_config));
3816 chain = &(next->next);
3817 next->basic_errno = next->more_errno = 0;
3818 next->senders = NULL;
3820 rchain = &(next->rules);
3822 next->pattern = string_dequote(&p);
3823 while (isspace(*p)) p++;
3825 while (mac_isgraph(*p)) p++;
3826 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3827 "missing error type");
3829 /* Test error names for things we understand. */
3831 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3832 &(next->more_errno))) != NULL)
3833 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3835 /* There may be an optional address list of senders to be used as another
3836 constraint on the rule. This was added later, so the syntax is a bit of a
3837 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3840 while (isspace(*p)) p++;
3841 if (Ustrncmp(p, "senders", 7) == 0)
3844 while (isspace(*p)) p++;
3845 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3846 "\"=\" expected after \"senders\" in retry rule");
3847 while (isspace(*p)) p++;
3848 next->senders = string_dequote(&p);
3851 /* Now the retry rules. Keep the maximum timeout encountered. */
3853 while (isspace(*p)) p++;
3857 retry_rule *rule = store_get(sizeof(retry_rule));
3859 rchain = &(rule->next);
3861 rule->rule = toupper(*p++);
3862 rule->timeout = retry_arg(&p, 0);
3863 if (rule->timeout > retry_maximum_timeout)
3864 retry_maximum_timeout = rule->timeout;
3868 case 'F': /* Fixed interval */
3869 rule->p1 = retry_arg(&p, 0);
3872 case 'G': /* Geometrically increasing intervals */
3873 case 'H': /* Ditto, but with randomness */
3874 rule->p1 = retry_arg(&p, 0);
3875 rule->p2 = retry_arg(&p, 1);
3879 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3883 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3884 (rule->rule != 'F' && rule->p2 < 1000))
3885 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3886 "bad parameters for retry rule");
3888 while (isspace(*p)) p++;
3892 while (isspace(*p)) p++;
3895 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3902 /*************************************************
3903 * Initialize authenticators *
3904 *************************************************/
3906 /* Read the authenticators section of the configuration file.
3915 auth_instance *au, *bu;
3916 readconf_driver_init(US"authenticator",
3917 (driver_instance **)(&auths), /* chain anchor */
3918 (driver_info *)auths_available, /* available drivers */
3919 sizeof(auth_info), /* size of info block */
3920 &auth_defaults, /* default values for generic options */
3921 sizeof(auth_instance), /* size of instance block */
3922 optionlist_auths, /* generic options */
3923 optionlist_auths_size);
3925 for (au = auths; au != NULL; au = au->next)
3927 if (au->public_name == NULL)
3928 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3929 "the %s authenticator", au->name);
3930 for (bu = au->next; bu != NULL; bu = bu->next)
3932 if (strcmpic(au->public_name, bu->public_name) == 0)
3934 if ((au->client && bu->client) || (au->server && bu->server))
3935 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3936 "(%s and %s) have the same public name (%s)",
3937 (au->client)? US"client" : US"server", au->name, bu->name,
3947 /*************************************************
3948 * Read ACL information *
3949 *************************************************/
3951 /* If this run of Exim is not doing something that involves receiving a
3952 message, we can just skip over the ACL information. No need to parse it.
3954 First, we have a function for acl_read() to call back to get the next line. We
3955 need to remember the line we passed, because at the end it will contain the
3956 name of the next ACL. */
3958 static uschar *acl_line;
3963 acl_line = get_config_line();
3968 /* Now the main function:
3971 skip TRUE when this Exim process is doing something that will
3972 not need the ACL data
3978 readconf_acl(BOOL skip)
3982 /* Not receiving messages, don't need to parse the ACL data */
3986 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3987 while ((p = get_config_line()) != NULL);
3991 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3994 acl_line = get_config_line();
3996 while(acl_line != NULL)
4002 p = readconf_readname(name, sizeof(name), acl_line);
4003 if (isupper(*name) && *p == '=')
4005 read_macro_assignment(acl_line);
4006 acl_line = get_config_line();
4010 if (*p != ':' || name[0] == 0)
4011 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4013 node = store_get(sizeof(tree_node) + Ustrlen(name));
4014 Ustrcpy(node->name, name);
4015 if (!tree_insertnode(&acl_anchor, node))
4016 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4017 "there are two ACLs called \"%s\"", name);
4019 node->data.ptr = acl_read(acl_callback, &error);
4021 if (node->data.ptr == NULL && error != NULL)
4022 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4028 /*************************************************
4029 * Read configuration for local_scan() *
4030 *************************************************/
4032 /* This function is called after "begin local_scan" is encountered in the
4033 configuration file. If the local_scan() function allows for configuration
4034 options, we can process them. Otherwise, we expire in a panic.
4041 local_scan_init(void)
4043 #ifndef LOCAL_SCAN_HAS_OPTIONS
4044 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4045 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4049 while ((p = get_config_line()) != NULL)
4051 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4052 NULL, US"local_scan option \"%s\" unknown");
4059 /*************************************************
4060 * Read rest of configuration (after main) *
4061 *************************************************/
4063 /* This function reads the rest of the runtime configuration, after the main
4064 configuration. It is called only when actually needed. Each subsequent section
4065 of the configuration starts with a line of the form
4069 where the name is "routers", "transports", etc. A section is terminated by
4070 hitting the next "begin" line, and the next name is left in next_section.
4071 Because it may confuse people as to whether the names are singular or plural,
4072 we add "s" if it's missing. There is always enough room in next_section for
4073 this. This function is basically just a switch.
4076 skip_acl TRUE if ACL information is not needed
4081 static uschar *section_list[] = {
4091 readconf_rest(BOOL skip_acl)
4095 while(next_section[0] != 0)
4099 int last = sizeof(section_list) / sizeof(uschar *);
4101 int n = Ustrlen(next_section);
4103 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4107 int c = strcmpic(next_section, section_list[mid]);
4109 if (c > 0) first = mid + 1; else last = mid;
4111 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4112 "\"%.*s\" is not a known configuration section name", n, next_section);
4113 mid = (last + first)/2;
4117 if (((had ^= bit) & bit) == 0)
4118 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4119 "\"%.*s\" section is repeated in the configuration file", n,
4124 case 0: readconf_acl(skip_acl); break;
4125 case 1: auths_init(); break;
4126 case 2: local_scan_init(); break;
4127 case 3: readconf_retries(); break;
4128 case 4: readconf_rewrites(); break;
4129 case 5: route_init(); break;
4130 case 6: transport_init(); break;
4134 (void)fclose(config_file);
4137 /* End of readconf.c */