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 },
144 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
146 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
147 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
148 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
149 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
150 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
151 #ifdef WITH_CONTENT_SCAN
152 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
154 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
155 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
156 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
157 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
159 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
161 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
162 { "admin_groups", opt_gidlist, &admin_groups },
163 { "allow_domain_literals", opt_bool, &allow_domain_literals },
164 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
165 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
166 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
167 { "auto_thaw", opt_time, &auto_thaw },
168 #ifdef WITH_CONTENT_SCAN
169 { "av_scanner", opt_stringptr, &av_scanner },
171 { "bi_command", opt_stringptr, &bi_command },
172 #ifdef EXPERIMENTAL_BRIGHTMAIL
173 { "bmi_config_file", opt_stringptr, &bmi_config_file },
175 { "bounce_message_file", opt_stringptr, &bounce_message_file },
176 { "bounce_message_text", opt_stringptr, &bounce_message_text },
177 { "bounce_return_body", opt_bool, &bounce_return_body },
178 { "bounce_return_message", opt_bool, &bounce_return_message },
179 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
180 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
181 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
182 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
183 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
184 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
185 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
186 { "check_log_inodes", opt_int, &check_log_inodes },
187 { "check_log_space", opt_Kint, &check_log_space },
188 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
189 { "check_spool_inodes", opt_int, &check_spool_inodes },
190 { "check_spool_space", opt_Kint, &check_spool_space },
191 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
192 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
193 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
194 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
195 #ifdef EXPERIMENTAL_DCC
196 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
197 { "dccifd_address", opt_stringptr, &dccifd_address },
198 { "dccifd_options", opt_stringptr, &dccifd_options },
200 { "delay_warning", opt_timelist, &delay_warning },
201 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
202 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
203 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
204 { "delivery_date_remove", opt_bool, &delivery_date_remove },
205 #ifdef ENABLE_DISABLE_FSYNC
206 { "disable_fsync", opt_bool, &disable_fsync },
208 { "disable_ipv6", opt_bool, &disable_ipv6 },
210 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
212 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
213 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
214 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
215 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
216 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
217 { "dns_retrans", opt_time, &dns_retrans },
218 { "dns_retry", opt_int, &dns_retry },
219 { "dns_use_edns0", opt_int, &dns_use_edns0 },
220 /* This option is now a no-op, retained for compability */
221 { "drop_cr", opt_bool, &drop_cr },
222 /*********************************************************/
223 { "dsn_from", opt_stringptr, &dsn_from },
224 { "envelope_to_remove", opt_bool, &envelope_to_remove },
225 { "errors_copy", opt_stringptr, &errors_copy },
226 { "errors_reply_to", opt_stringptr, &errors_reply_to },
227 { "exim_group", opt_gid, &exim_gid },
228 { "exim_path", opt_stringptr, &exim_path },
229 { "exim_user", opt_uid, &exim_uid },
230 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
231 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
232 { "finduser_retries", opt_int, &finduser_retries },
233 { "freeze_tell", opt_stringptr, &freeze_tell },
234 { "gecos_name", opt_stringptr, &gecos_name },
235 { "gecos_pattern", opt_stringptr, &gecos_pattern },
237 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
238 /* These three gnutls_require_* options stopped working in Exim 4.80 */
239 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
240 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
241 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
243 { "header_line_maxsize", opt_int, &header_line_maxsize },
244 { "header_maxsize", opt_int, &header_maxsize },
245 { "headers_charset", opt_stringptr, &headers_charset },
246 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
247 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
248 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
249 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
250 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
251 { "hold_domains", opt_stringptr, &hold_domains },
252 { "host_lookup", opt_stringptr, &host_lookup },
253 { "host_lookup_order", opt_stringptr, &host_lookup_order },
254 { "host_reject_connection", opt_stringptr, &host_reject_connection },
255 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
256 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
258 { "ibase_servers", opt_stringptr, &ibase_servers },
260 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
261 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
262 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
263 { "keep_malformed", opt_time, &keep_malformed },
265 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
266 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
267 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
268 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
269 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
270 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
271 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
272 { "ldap_start_tls", opt_bool, &eldap_start_tls },
273 { "ldap_version", opt_int, &eldap_version },
275 { "local_from_check", opt_bool, &local_from_check },
276 { "local_from_prefix", opt_stringptr, &local_from_prefix },
277 { "local_from_suffix", opt_stringptr, &local_from_suffix },
278 { "local_interfaces", opt_stringptr, &local_interfaces },
279 { "local_scan_timeout", opt_time, &local_scan_timeout },
280 { "local_sender_retain", opt_bool, &local_sender_retain },
281 { "localhost_number", opt_stringptr, &host_number_string },
282 { "log_file_path", opt_stringptr, &log_file_path },
283 { "log_selector", opt_stringptr, &log_selector_string },
284 { "log_timezone", opt_bool, &log_timezone },
285 { "lookup_open_max", opt_int, &lookup_open_max },
286 { "max_username_length", opt_int, &max_username_length },
287 { "message_body_newlines", opt_bool, &message_body_newlines },
288 { "message_body_visible", opt_mkint, &message_body_visible },
289 { "message_id_header_domain", opt_stringptr, &message_id_domain },
290 { "message_id_header_text", opt_stringptr, &message_id_text },
291 { "message_logs", opt_bool, &message_logs },
292 { "message_size_limit", opt_stringptr, &message_size_limit },
293 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
294 { "move_frozen_messages", opt_bool, &move_frozen_messages },
296 { "mua_wrapper", opt_bool, &mua_wrapper },
298 { "mysql_servers", opt_stringptr, &mysql_servers },
300 { "never_users", opt_uidlist, &never_users },
302 { "openssl_options", opt_stringptr, &openssl_options },
305 { "oracle_servers", opt_stringptr, &oracle_servers },
307 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
309 { "perl_at_start", opt_bool, &opt_perl_at_start },
310 { "perl_startup", opt_stringptr, &opt_perl_startup },
313 { "pgsql_servers", opt_stringptr, &pgsql_servers },
315 { "pid_file_path", opt_stringptr, &pid_file_path },
316 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
317 { "preserve_message_logs", opt_bool, &preserve_message_logs },
318 { "primary_hostname", opt_stringptr, &primary_hostname },
319 { "print_topbitchars", opt_bool, &print_topbitchars },
320 { "process_log_path", opt_stringptr, &process_log_path },
321 { "prod_requires_admin", opt_bool, &prod_requires_admin },
322 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
323 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
324 { "queue_domains", opt_stringptr, &queue_domains },
325 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
326 { "queue_only", opt_bool, &queue_only },
327 { "queue_only_file", opt_stringptr, &queue_only_file },
328 { "queue_only_load", opt_fixed, &queue_only_load },
329 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
330 { "queue_only_override", opt_bool, &queue_only_override },
331 { "queue_run_in_order", opt_bool, &queue_run_in_order },
332 { "queue_run_max", opt_int, &queue_run_max },
333 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
334 { "receive_timeout", opt_time, &receive_timeout },
335 { "received_header_text", opt_stringptr, &received_header_text },
336 { "received_headers_max", opt_int, &received_headers_max },
337 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
338 { "recipients_max", opt_int, &recipients_max },
339 { "recipients_max_reject", opt_bool, &recipients_max_reject },
340 { "remote_max_parallel", opt_int, &remote_max_parallel },
341 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
342 { "retry_data_expire", opt_time, &retry_data_expire },
343 { "retry_interval_max", opt_time, &retry_interval_max },
344 { "return_path_remove", opt_bool, &return_path_remove },
345 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
346 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
347 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
348 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
349 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
350 { "smtp_accept_max", opt_int, &smtp_accept_max },
351 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
352 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
353 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
354 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
355 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
356 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
357 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
358 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
359 { "smtp_banner", opt_stringptr, &smtp_banner },
360 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
361 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
362 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
363 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
364 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
365 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
366 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
367 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
368 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
369 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
370 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
371 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
372 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
373 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
374 #ifdef WITH_CONTENT_SCAN
375 { "spamd_address", opt_stringptr, &spamd_address },
377 #ifdef EXPERIMENTAL_SPF
378 { "spf_guess", opt_stringptr, &spf_guess },
380 { "split_spool_directory", opt_bool, &split_spool_directory },
381 { "spool_directory", opt_stringptr, &spool_directory },
383 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
385 #ifdef EXPERIMENTAL_SRS
386 { "srs_config", opt_stringptr, &srs_config },
387 { "srs_hashlength", opt_int, &srs_hashlength },
388 { "srs_hashmin", opt_int, &srs_hashmin },
389 { "srs_maxage", opt_int, &srs_maxage },
390 { "srs_secrets", opt_stringptr, &srs_secrets },
391 { "srs_usehash", opt_bool, &srs_usehash },
392 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
394 { "strict_acl_vars", opt_bool, &strict_acl_vars },
395 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
396 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
397 { "syslog_duplication", opt_bool, &syslog_duplication },
398 { "syslog_facility", opt_stringptr, &syslog_facility_str },
399 { "syslog_processname", opt_stringptr, &syslog_processname },
400 { "syslog_timestamp", opt_bool, &syslog_timestamp },
401 { "system_filter", opt_stringptr, &system_filter },
402 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
403 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
404 { "system_filter_group", opt_gid, &system_filter_gid },
405 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
406 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
407 { "system_filter_user", opt_uid, &system_filter_uid },
408 { "tcp_nodelay", opt_bool, &tcp_nodelay },
409 #ifdef USE_TCP_WRAPPERS
410 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
412 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
413 { "timezone", opt_stringptr, &timezone_string },
415 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
416 { "tls_certificate", opt_stringptr, &tls_certificate },
417 { "tls_crl", opt_stringptr, &tls_crl },
418 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
419 { "tls_dhparam", opt_stringptr, &tls_dhparam },
420 #if defined(EXPERIMENTAL_OCSP) && !defined(USE_GNUTLS)
421 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
423 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
424 { "tls_privatekey", opt_stringptr, &tls_privatekey },
425 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
426 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
427 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
428 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
429 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
431 { "trusted_groups", opt_gidlist, &trusted_groups },
432 { "trusted_users", opt_uidlist, &trusted_users },
433 { "unknown_login", opt_stringptr, &unknown_login },
434 { "unknown_username", opt_stringptr, &unknown_username },
435 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
436 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
437 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
438 { "warn_message_file", opt_stringptr, &warn_message_file },
439 { "write_rejectlog", opt_bool, &write_rejectlog }
442 static int optionlist_config_size =
443 sizeof(optionlist_config)/sizeof(optionlist);
447 /*************************************************
448 * Find the name of an option *
449 *************************************************/
451 /* This function is to aid debugging. Various functions take arguments that are
452 pointer variables in the options table or in option tables for various drivers.
453 For debugging output, it is useful to be able to find the name of the option
454 which is currently being processed. This function finds it, if it exists, by
455 searching the table(s).
457 Arguments: a value that is presumed to be in the table above
458 Returns: the option name, or an empty string
462 readconf_find_option(void *p)
466 transport_instance *t;
468 for (i = 0; i < optionlist_config_size; i++)
469 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
471 for (r = routers; r != NULL; r = r->next)
473 router_info *ri = r->info;
474 for (i = 0; i < ri->options_count[0]; i++)
476 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
477 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
478 return US ri->options[i].name;
482 for (t = transports; t != NULL; t = t->next)
484 transport_info *ti = t->info;
485 for (i = 0; i < ti->options_count[0]; i++)
487 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
488 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
489 return US ti->options[i].name;
499 /*************************************************
500 * Deal with an assignment to a macro *
501 *************************************************/
503 /* This function is called when a line that starts with an upper case letter is
504 encountered. The argument "line" should contain a complete logical line, and
505 start with the first letter of the macro name. The macro name and the
506 replacement text are extracted and stored. Redefinition of existing,
507 non-command line, macros is permitted using '==' instead of '='.
510 s points to the start of the logical line
516 read_macro_assignment(uschar *s)
522 macro_item *mlast = NULL;
524 while (isalnum(*s) || *s == '_')
526 if (namelen >= sizeof(name) - 1)
527 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
528 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
529 name[namelen++] = *s++;
533 while (isspace(*s)) s++;
535 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
542 while (isspace(*s)) s++;
544 /* If an existing macro of the same name was defined on the command line, we
545 just skip this definition. It's an error to attempt to redefine a macro without
546 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
547 It is also an error to define a macro whose name begins with the name of a
548 previously defined macro. Note: it is documented that the other way round
551 for (m = macros; m != NULL; m = m->next)
553 int len = Ustrlen(m->name);
555 if (Ustrcmp(m->name, name) == 0)
557 if (!m->command_line && !redef)
558 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
559 "defined (use \"==\" if you want to redefine it", name);
563 if (len < namelen && Ustrstr(name, m->name) != NULL)
564 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
565 "a macro because previously defined macro \"%s\" is a substring",
568 /* We cannot have this test, because it is documented that a substring
569 macro is permitted (there is even an example).
571 * if (len > namelen && Ustrstr(m->name, name) != NULL)
572 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
573 * "a macro because it is a substring of previously defined macro \"%s\"",
580 /* Check for an overriding command-line definition. */
582 if (m != NULL && m->command_line) return;
584 /* Redefinition must refer to an existing macro. */
589 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
593 /* We have a new definition. The macro_item structure includes a final vector
594 called "name" which is one byte long. Thus, adding "namelen" gives us enough
595 room to store the "name" string. */
599 m = store_get(sizeof(macro_item) + namelen);
600 if (macros == NULL) macros = m; else mlast->next = m;
601 Ustrncpy(m->name, name, namelen);
602 m->name[namelen] = 0;
604 m->command_line = FALSE;
607 /* Set the value of the new or redefined macro */
609 m->replacement = string_copy(s);
616 /*************************************************
617 * Read configuration line *
618 *************************************************/
620 /* A logical line of text is read from the configuration file into the big
621 buffer, taking account of macros, .includes, and continuations. The size of
622 big_buffer is increased if necessary. The count of configuration lines is
623 maintained. Physical input lines starting with # (ignoring leading white space,
624 and after macro replacement) and empty logical lines are always ignored.
625 Leading and trailing spaces are removed.
627 If we hit a line of the form "begin xxxx", the xxxx is placed in the
628 next_section vector, and the function returns NULL, indicating the end of a
629 configuration section. On end-of-file, NULL is returned with next_section
634 Returns: a pointer to the first non-blank in the line,
635 or NULL if eof or end of section is reached
639 get_config_line(void)
641 int startoffset = 0; /* To first non-blank char in logical line */
642 int len = 0; /* Of logical line so far */
648 /* Loop for handling continuation lines, skipping comments, and dealing with
653 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
655 if (config_file_stack != NULL) /* EOF inside .include */
657 (void)fclose(config_file);
658 config_file = config_file_stack->file;
659 config_filename = config_file_stack->filename;
660 config_lineno = config_file_stack->lineno;
661 config_file_stack = config_file_stack->next;
665 /* EOF at top level */
667 if (cstate_stack_ptr >= 0)
668 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
669 "Unexpected end of configuration file: .endif missing");
671 if (len != 0) break; /* EOF after continuation */
672 next_section[0] = 0; /* EOF at start of logical line */
677 newlen = len + Ustrlen(big_buffer + len);
679 /* Handle pathologically long physical lines - yes, it did happen - by
680 extending big_buffer at this point. The code also copes with very long
683 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
686 big_buffer_size += BIG_BUFFER_SIZE;
687 newbuffer = store_malloc(big_buffer_size);
689 /* This use of strcpy is OK because we know that the string in the old
690 buffer is shorter than the new buffer. */
692 Ustrcpy(newbuffer, big_buffer);
693 store_free(big_buffer);
694 big_buffer = newbuffer;
695 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
697 newlen += Ustrlen(big_buffer + newlen);
700 /* Find the true start of the physical line - leading spaces are always
703 ss = big_buffer + len;
704 while (isspace(*ss)) ss++;
706 /* Process the physical line for macros. If this is the start of the logical
707 line, skip over initial text at the start of the line if it starts with an
708 upper case character followed by a sequence of name characters and an equals
709 sign, because that is the definition of a new macro, and we don't do
710 replacement therein. */
713 if (len == 0 && isupper(*s))
715 while (isalnum(*s) || *s == '_') s++;
716 while (isspace(*s)) s++;
717 if (*s != '=') s = ss; /* Not a macro definition */
720 /* For each defined macro, scan the line (from after XXX= if present),
721 replacing all occurrences of the macro. */
724 for (m = macros; m != NULL; m = m->next)
729 while ((p = Ustrstr(t, m->name)) != NULL)
732 int namelen = Ustrlen(m->name);
733 int replen = Ustrlen(m->replacement);
735 /* Expand the buffer if necessary */
737 while (newlen - namelen + replen + 1 > big_buffer_size)
739 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
740 uschar *newbuffer = store_malloc(newsize);
741 memcpy(newbuffer, big_buffer, newlen + 1);
742 p = newbuffer + (p - big_buffer);
743 s = newbuffer + (s - big_buffer);
744 ss = newbuffer + (ss - big_buffer);
745 t = newbuffer + (t - big_buffer);
746 big_buffer_size = newsize;
747 store_free(big_buffer);
748 big_buffer = newbuffer;
751 /* Shuffle the remaining characters up or down in the buffer before
752 copying in the replacement text. Don't rescan the replacement for this
756 moveby = replen - namelen;
759 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
762 Ustrncpy(p, m->replacement, replen);
768 /* An empty macro replacement at the start of a line could mean that ss no
769 longer points to the first non-blank character. */
771 while (isspace(*ss)) ss++;
773 /* Check for comment lines - these are physical lines. */
775 if (*ss == '#') continue;
777 /* Handle conditionals, which are also applied to physical lines. Conditions
778 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
779 expansion occured on the rest of the line. A preliminary test for the leading
780 '.' saves effort on most lines. */
786 /* Search the list of conditional directives */
788 for (i = 0; i < cond_list_size; i++)
791 cond_item *c = cond_list+i;
792 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
794 /* The following character must be white space or end of string */
796 n = ss[1 + c->namelen];
797 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
799 /* .ifdef and .ifndef push the current state onto the stack, then set
800 a new one from the table. Stack overflow is an error */
804 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
805 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
806 ".%s nested too deeply", c->name);
807 cstate_stack[++cstate_stack_ptr] = cstate;
808 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
811 /* For any of the others, stack underflow is an error. The next state
812 comes either from the stack (.endif) or from the table. */
816 if (cstate_stack_ptr < 0)
817 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
818 ".%s without matching .ifdef", c->name);
819 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
820 next_cstate[cstate][macro_found? c->action1 : c->action2];
823 /* Having dealt with a directive, break the loop */
828 /* If we have handled a conditional directive, continue with the next
829 physical line. Otherwise, fall through. */
831 if (i < cond_list_size) continue;
834 /* If the conditional state is not 0 (actively using these lines), ignore
837 if (cstate != 0) continue; /* Conditional skip */
839 /* Handle .include lines - these are also physical lines. */
841 if (Ustrncmp(ss, ".include", 8) == 0 &&
843 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
846 int include_if_exists = isspace(ss[8])? 0 : 10;
847 config_file_item *save;
850 ss += 9 + include_if_exists;
851 while (isspace(*ss)) ss++;
852 t = ss + Ustrlen(ss);
853 while (t > ss && isspace(t[-1])) t--;
854 if (*ss == '\"' && t[-1] == '\"')
862 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
863 "absolute path \"%s\"", ss);
865 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
867 save = store_get(sizeof(config_file_item));
868 save->next = config_file_stack;
869 config_file_stack = save;
870 save->file = config_file;
871 save->filename = config_filename;
872 save->lineno = config_lineno;
874 config_file = Ufopen(ss, "rb");
875 if (config_file == NULL)
876 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
877 "configuration file %s", ss);
878 config_filename = string_copy(ss);
883 /* If this is the start of the logical line, remember where the non-blank
884 data starts. Otherwise shuffle down continuation lines to remove leading
888 startoffset = ss - big_buffer;
891 s = big_buffer + len;
894 memmove(s, ss, (newlen - len) - (ss - s) + 1);
899 /* Accept the new addition to the line. Remove trailing white space. */
902 while (len > 0 && isspace(big_buffer[len-1])) len--;
905 /* We are done if the line does not end in backslash and contains some data.
906 Empty logical lines are ignored. For continuations, remove the backslash and
907 go round the loop to read the continuation line. */
911 if (big_buffer[len-1] != '\\') break; /* End of logical line */
912 big_buffer[--len] = 0; /* Remove backslash */
914 } /* Loop for reading multiple physical lines */
916 /* We now have a logical line. Test for the end of a configuration section (or,
917 more accurately, for the start of the next section). Place the name of the next
918 section in next_section, and return NULL. If the name given is longer than
919 next_section, truncate it. It will be unrecognized later, because all the known
920 section names do fit. Leave space for pluralizing. */
922 s = big_buffer + startoffset; /* First non-space character */
923 if (strncmpic(s, US"begin ", 6) == 0)
926 while (isspace(*s)) s++;
927 if (big_buffer + len - s > sizeof(next_section) - 2)
928 s[sizeof(next_section) - 2] = 0;
929 Ustrcpy(next_section, s);
933 /* Return the first non-blank character. */
940 /*************************************************
942 *************************************************/
944 /* The yield is the pointer to the next uschar. Names longer than the
945 output space are silently truncated. This function is also used from acl.c when
949 name where to put the name
953 Returns: new input pointer
957 readconf_readname(uschar *name, int len, uschar *s)
960 while (isspace(*s)) s++;
963 while (isalnum(*s) || *s == '_')
965 if (p < len-1) name[p++] = *s;
970 while (isspace(*s)) s++;
977 /*************************************************
978 * Read a time value *
979 *************************************************/
981 /* This function is also called from outside, to read argument
982 time values. The format of a time value is:
984 [<n>w][<n>d][<n>h][<n>m][<n>s]
986 as long as at least one is present. If a format error is encountered,
987 return a negative value. The value must be terminated by the given
992 terminator required terminating character
993 return_msec if TRUE, allow fractional seconds and return milliseconds
995 Returns: the time value, or -1 on syntax error
996 value is seconds if return_msec is FALSE
997 value is milliseconds if return_msec is TRUE
1001 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
1009 if (!isdigit(*s)) return -1;
1010 (void)sscanf(CS s, "%d%n", &value, &count);
1015 case 'w': value *= 7;
1016 case 'd': value *= 24;
1017 case 'h': value *= 60;
1018 case 'm': value *= 60;
1023 if (!return_msec) return -1;
1024 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1026 if (*s++ != 's') return -1;
1027 yield += (int)(fraction * 1000.0);
1033 if (return_msec) value *= 1000;
1035 if (*s == terminator) return yield;
1037 /* Control never reaches here. */
1042 /*************************************************
1043 * Read a fixed point value *
1044 *************************************************/
1046 /* The value is returned *1000
1050 terminator required terminator
1052 Returns: the value, or -1 on error
1056 readconf_readfixed(uschar *s, int terminator)
1060 if (!isdigit(*s)) return -1;
1061 (void)sscanf(CS s, "%d%n", &value, &count);
1063 yield = value * 1000;
1067 while (isdigit((*(++s))))
1069 yield += (*s - '0') * m;
1074 return (*s == terminator)? yield : (-1);
1079 /*************************************************
1080 * Find option in list *
1081 *************************************************/
1083 /* The lists are always in order, so binary chop can be used.
1086 name the option name to search for
1087 ol the first entry in the option list
1088 last one more than the offset of the last entry in the option list
1090 Returns: pointer to an option entry, or NULL if not found
1094 find_option(uschar *name, optionlist *ol, int last)
1097 while (last > first)
1099 int middle = (first + last)/2;
1100 int c = Ustrcmp(name, ol[middle].name);
1101 if (c == 0) return ol + middle;
1102 else if (c > 0) first = middle + 1;
1110 /*************************************************
1111 * Find a set flag in option list *
1112 *************************************************/
1114 /* Because some versions of Unix make no restrictions on the values of uids and
1115 gids (even negative ones), we cannot represent "unset" by a special value.
1116 There is therefore a separate boolean variable for each one indicating whether
1117 a value is set or not. This function returns a pointer to the boolean, given
1118 the original option name. It is a major disaster if the flag cannot be found.
1121 name the name of the uid or gid option
1122 oltop points to the start of the relevant option list
1123 last one more than the offset of the last item in the option list
1124 data_block NULL when reading main options => data values in the option
1125 list are absolute addresses; otherwise they are byte offsets
1126 in data_block (used for driver options)
1128 Returns: a pointer to the boolean flag.
1132 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1136 sprintf(CS name2, "*set_%.50s", name);
1137 ol = find_option(name2, oltop, last);
1138 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1139 "Exim internal error: missing set flag for %s", name);
1140 return (data_block == NULL)? (BOOL *)(ol->value) :
1141 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1147 /*************************************************
1148 * Output extra characters message and die *
1149 *************************************************/
1151 /* Called when an option line has junk on the end. Sometimes this is because
1152 the sysadmin thinks comments are permitted.
1155 s points to the extra characters
1156 t1..t3 strings to insert in the log message
1158 Returns: doesn't return; dies
1162 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1164 uschar *comment = US"";
1165 if (*s == '#') comment = US" (# is comment only at line start)";
1166 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1167 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1172 /*************************************************
1173 * Read rewrite information *
1174 *************************************************/
1176 /* Each line of rewrite information contains:
1178 . A complete address in the form user@domain, possibly with
1179 leading * for each part; or alternatively, a regex.
1181 . A replacement string (which will be expanded).
1183 . An optional sequence of one-letter flags, indicating which
1184 headers etc. to apply this rule to.
1186 All this is decoded and placed into a control block. The OR of the flags is
1187 maintained in a common word.
1190 p points to the string that makes up the rule
1191 existflags points to the overall flag word
1192 isglobal TRUE if reading global rewrite rules
1194 Returns: the control block for the parsed rule.
1197 static rewrite_rule *
1198 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1200 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1203 next->key = string_dequote(&p);
1205 while (isspace(*p)) p++;
1207 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1208 "missing rewrite replacement string");
1211 next->replacement = string_dequote(&p);
1213 while (*p != 0) switch (*p++)
1215 case ' ': case '\t': break;
1217 case 'q': next->flags |= rewrite_quit; break;
1218 case 'w': next->flags |= rewrite_whole; break;
1220 case 'h': next->flags |= rewrite_all_headers; break;
1221 case 's': next->flags |= rewrite_sender; break;
1222 case 'f': next->flags |= rewrite_from; break;
1223 case 't': next->flags |= rewrite_to; break;
1224 case 'c': next->flags |= rewrite_cc; break;
1225 case 'b': next->flags |= rewrite_bcc; break;
1226 case 'r': next->flags |= rewrite_replyto; break;
1228 case 'E': next->flags |= rewrite_all_envelope; break;
1229 case 'F': next->flags |= rewrite_envfrom; break;
1230 case 'T': next->flags |= rewrite_envto; break;
1232 case 'Q': next->flags |= rewrite_qualify; break;
1233 case 'R': next->flags |= rewrite_repeat; break;
1236 next->flags |= rewrite_smtp;
1237 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1238 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1239 "rewrite rule has the S flag but is not a regular expression");
1243 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1244 "unknown rewrite flag character '%c' "
1245 "(could be missing quotes round replacement item)", p[-1]);
1249 /* If no action flags are set, set all the "normal" rewrites. */
1251 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1252 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1254 /* Remember which exist, for optimization, and return the rule */
1256 *existflags |= next->flags;
1263 /*************************************************
1264 * Read global rewrite information *
1265 *************************************************/
1267 /* Each line is a single rewrite rule; it is parsed into a control block
1268 by readconf_one_rewrite(), and its flags are ORed into the global flag
1269 word rewrite_existflags. */
1272 readconf_rewrites(void)
1274 rewrite_rule **chain = &global_rewrite_rules;
1277 while ((p = get_config_line()) != NULL)
1279 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1281 chain = &(next->next);
1287 /*************************************************
1289 *************************************************/
1291 /* Strings are read into the normal store pool. As long we aren't too
1292 near the end of the current block, the string will just use what is necessary
1293 on the top of the stacking pool, because string_cat() uses the extension
1297 s the rest of the input line
1298 name the option name (for errors)
1300 Returns: pointer to the string
1304 read_string(uschar *s, uschar *name)
1309 if (*s != '\"') return string_copy(s);
1312 yield = string_dequote(&s);
1314 if (s == ss+1 || s[-1] != '\"')
1315 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1316 "missing quote at end of string value for %s", name);
1318 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1324 /*************************************************
1325 * Handle option line *
1326 *************************************************/
1328 /* This function is called from several places to process a line containing the
1329 setting of an option. The first argument is the line to be decoded; it has been
1330 checked not to be empty and not to start with '#'. Trailing newlines and white
1331 space have been removed. The second argument is a pointer to the list of
1332 variable names that are to be recognized, together with their types and
1333 locations, and the third argument gives the number of entries in the list.
1335 The fourth argument is a pointer to a data block. If it is NULL, then the data
1336 values in the options list are absolute addresses. Otherwise, they are byte
1337 offsets in the data block.
1339 String option data may continue onto several lines; this function reads further
1340 data from config_file if necessary.
1342 The yield of this function is normally zero. If a string continues onto
1343 multiple lines, then the data value is permitted to be followed by a comma
1344 or a semicolon (for use in drivers) and the yield is that character.
1347 buffer contains the configuration line to be handled
1348 oltop points to the start of the relevant option list
1349 last one more than the offset of the last item in the option list
1350 data_block NULL when reading main options => data values in the option
1351 list are absolute addresses; otherwise they are byte offsets
1352 in data_block when they have opt_public set; otherwise
1353 they are byte offsets in data_block->options_block.
1354 unknown_txt format string to use in panic message for unknown option;
1355 must contain %s for option name
1356 if given as NULL, don't panic on unknown option
1358 Returns: TRUE if an option was read successfully,
1359 FALSE false for an unknown option if unknown_txt == NULL,
1360 otherwise panic and die on an unknown option
1364 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1365 void *data_block, uschar *unknown_txt)
1369 int n, count, type, value;
1373 BOOL boolvalue = TRUE;
1374 BOOL freesptr = TRUE;
1375 BOOL extra_condition = FALSE;
1376 optionlist *ol, *ol2;
1380 uschar *inttype = US"";
1383 uschar *saved_condition, *strtemp;
1384 uschar **str_target;
1388 /* There may be leading spaces; thereafter, we expect an option name starting
1391 while (isspace(*s)) s++;
1393 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1395 /* Read the name of the option, and skip any subsequent white space. If
1396 it turns out that what we read was "hide", set the flag indicating that
1397 this is a secure option, and loop to read the next word. */
1399 for (n = 0; n < 2; n++)
1401 while (isalnum(*s) || *s == '_')
1403 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1407 while (isspace(*s)) s++;
1408 if (Ustrcmp(name, "hide") != 0) break;
1409 issecure = opt_secure;
1413 /* Deal with "no_" or "not_" here for booleans */
1415 if (Ustrncmp(name, "no_", 3) == 0)
1421 if (Ustrncmp(name, "not_", 4) == 0)
1427 /* Search the list for the given name. A non-existent name, or an option that
1428 is set twice, is a disaster. */
1430 ol = find_option(name + offset, oltop, last);
1434 if (unknown_txt == NULL) return FALSE;
1435 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1438 if ((ol->type & opt_set) != 0)
1440 uschar *mname = name;
1441 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1442 if (Ustrcmp(mname, "condition") == 0)
1443 extra_condition = TRUE;
1445 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1446 "\"%s\" option set for the second time", mname);
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 (extra_condition)
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 when we set 3 or more
1541 conditions; I still don't understand the store mechanism enough
1542 to know what's the safe way to free content from an earlier store.
1543 AFAICT, stores stack, so freeing an early stored item also stores
1544 all data alloc'd after it. If we knew conditions were adjacent,
1545 we could survive that, but we don't. So I *think* we need to take
1546 another bit from opt_type to indicate "malloced"; this seems like
1547 quite a hack, especially for this one case. It also means that
1548 we can't ever reclaim the store from the *first* condition.
1550 Because we only do this once, near process start-up, I'm prepared to
1551 let this slide for the time being, even though it rankles. */
1561 if (data_block == NULL)
1562 *((uschar **)(ol->value)) = sptr;
1564 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1566 if (type == opt_rewrite)
1571 rewrite_rule **chain;
1574 sprintf(CS name2, "*%.50s_rules", name);
1575 ol2 = find_option(name2, oltop, last);
1576 sprintf(CS name2, "*%.50s_flags", name);
1577 ol3 = find_option(name2, oltop, last);
1579 if (ol2 == NULL || ol3 == NULL)
1580 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1581 "rewrite rules not available for driver");
1583 if (data_block == NULL)
1585 chain = (rewrite_rule **)(ol2->value);
1586 flagptr = (int *)(ol3->value);
1590 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1591 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1594 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1597 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1599 chain = &(next->next);
1602 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1603 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1604 "non-header rewrite - not allowed at transport time -");
1608 /* If it was an expanded uid, see if there is any expansion to be
1609 done by checking for the presence of a $ character. If there is, save it
1610 in the corresponding *expand_user option field. Otherwise, fall through
1611 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1614 case opt_expand_uid:
1615 sprintf(CS name2, "*expand_%.50s", name);
1616 ol2 = find_option(name2, oltop, last);
1619 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1621 if (data_block == NULL)
1622 *((uschar **)(ol2->value)) = ss;
1624 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1628 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1634 /* Look up a fixed uid, and also make use of the corresponding gid
1635 if a passwd entry is returned and the gid has not been set. */
1638 if (!route_finduser(sptr, &pw, &uid))
1639 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1640 if (data_block == NULL)
1641 *((uid_t *)(ol->value)) = uid;
1643 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1645 /* Set the flag indicating a fixed value is set */
1647 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1649 /* Handle matching gid if we have a passwd entry: done by finding the
1650 same name with terminating "user" changed to "group"; if not found,
1651 ignore. Also ignore if the value is already set. */
1653 if (pw == NULL) break;
1654 Ustrcpy(name+Ustrlen(name)-4, "group");
1655 ol2 = find_option(name, oltop, last);
1656 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1657 (ol2->type & opt_mask) == opt_expand_gid))
1659 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1662 if (data_block == NULL)
1663 *((gid_t *)(ol2->value)) = pw->pw_gid;
1665 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1671 /* If it was an expanded gid, see if there is any expansion to be
1672 done by checking for the presence of a $ character. If there is, save it
1673 in the corresponding *expand_user option field. Otherwise, fall through
1674 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1677 case opt_expand_gid:
1678 sprintf(CS name2, "*expand_%.50s", name);
1679 ol2 = find_option(name2, oltop, last);
1682 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1684 if (data_block == NULL)
1685 *((uschar **)(ol2->value)) = ss;
1687 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1691 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1697 /* Handle freestanding gid */
1700 if (!route_findgroup(sptr, &gid))
1701 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1702 if (data_block == NULL)
1703 *((gid_t *)(ol->value)) = gid;
1705 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1706 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1709 /* If it was a uid list, look up each individual entry, and build
1710 a vector of uids, with a count in the first element. Put the vector
1711 in malloc store so we can free the string. (We are reading into
1712 permanent store already.) */
1720 uschar *op = expand_string (sptr);
1723 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1724 name, expand_string_message);
1727 if (*p != 0) count++;
1728 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1729 list = store_malloc(count*sizeof(uid_t));
1730 list[ptr++] = (uid_t)(count - 1);
1732 if (data_block == NULL)
1733 *((uid_t **)(ol->value)) = list;
1735 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1741 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1742 if (!route_finduser(big_buffer, NULL, &uid))
1743 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1750 /* If it was a gid list, look up each individual entry, and build
1751 a vector of gids, with a count in the first element. Put the vector
1752 in malloc store so we can free the string. (We are reading into permanent
1761 uschar *op = expand_string (sptr);
1764 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1765 name, expand_string_message);
1768 if (*p != 0) count++;
1769 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1770 list = store_malloc(count*sizeof(gid_t));
1771 list[ptr++] = (gid_t)(count - 1);
1773 if (data_block == NULL)
1774 *((gid_t **)(ol->value)) = list;
1776 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1782 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1783 if (!route_findgroup(big_buffer, &gid))
1784 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1792 /* Release store if the value of the string doesn't need to be kept. */
1794 if (freesptr) store_reset(reset_point);
1797 /* Expanded boolean: if no characters follow, or if there are no dollar
1798 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1799 save the string for later expansion in the alternate place. */
1801 case opt_expand_bool:
1802 if (*s != 0 && Ustrchr(s, '$') != 0)
1804 sprintf(CS name2, "*expand_%.50s", name);
1805 ol2 = find_option(name2, oltop, last);
1808 reset_point = sptr = read_string(s, name);
1809 if (data_block == NULL)
1810 *((uschar **)(ol2->value)) = sptr;
1812 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1819 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1820 look for yes/not/true/false. Some booleans are stored in a single bit in
1821 a single int. There's a special fudge for verify settings; without a suffix
1822 they set both xx_sender and xx_recipient. The table points to the sender
1823 value; search subsequently for the recipient. There's another special case:
1824 opt_bool_set also notes when a boolean has been set. */
1828 case opt_bool_verify:
1832 s = readconf_readname(name2, 64, s);
1833 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1835 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1837 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1838 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1839 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1840 US"for boolean option ", name);
1843 /* Handle single-bit type. */
1845 if (type == opt_bit)
1847 int bit = 1 << ((ol->type >> 16) & 31);
1848 int *ptr = (data_block == NULL)?
1849 (int *)(ol->value) :
1850 (int *)((uschar *)data_block + (long int)ol->value);
1851 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1855 /* Handle full BOOL types */
1857 if (data_block == NULL)
1858 *((BOOL *)(ol->value)) = boolvalue;
1860 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1864 if (type == opt_bool_verify)
1866 sprintf(CS name2, "%.50s_recipient", name + offset);
1867 ol2 = find_option(name2, oltop, last);
1870 if (data_block == NULL)
1871 *((BOOL *)(ol2->value)) = boolvalue;
1873 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1877 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1879 else if (type == opt_bool_set)
1881 sprintf(CS name2, "*set_%.50s", name + offset);
1882 ol2 = find_option(name2, oltop, last);
1885 if (data_block == NULL)
1886 *((BOOL *)(ol2->value)) = TRUE;
1888 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1897 inttype = US"octal ";
1899 /* Integer: a simple(ish) case; allow octal and hex formats, and
1900 suffixes K and M. The different types affect output, not input. */
1909 lvalue = strtol(CS s, CSS &endptr, intbase);
1912 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1915 if (errno != ERANGE)
1917 if (tolower(*endptr) == 'k')
1919 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1920 else lvalue *= 1024;
1923 else if (tolower(*endptr) == 'm')
1925 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1927 else lvalue *= 1024*1024;
1932 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1933 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1934 "absolute value of integer \"%s\" is too large (overflow)", s);
1936 while (isspace(*endptr)) endptr++;
1938 extra_chars_error(endptr, inttype, US"integer value for ", name);
1940 value = (int)lvalue;
1943 if (data_block == NULL)
1944 *((int *)(ol->value)) = value;
1946 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1949 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1956 value = strtol(CS s, CSS &endptr, intbase);
1959 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1962 if (errno != ERANGE)
1964 if (tolower(*endptr) == 'm')
1966 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1970 else if (tolower(*endptr) == 'k')
1976 value = (value + 512)/1024;
1980 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1981 "absolute value of integer \"%s\" is too large (overflow)", s);
1983 while (isspace(*endptr)) endptr++;
1985 extra_chars_error(endptr, inttype, US"integer value for ", name);
1988 if (data_block == NULL)
1989 *((int *)(ol->value)) = value;
1991 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1994 /* Fixed-point number: held to 3 decimal places. */
1997 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1998 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1999 "fixed-point number expected for %s", name);
2001 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2002 "integer \"%s\" is too large (overflow)", s);
2006 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2007 "integer \"%s\" is too large (overflow)", s);
2009 if (s[count] == '.')
2012 while (isdigit(s[++count]))
2014 value += (s[count] - '0') * d;
2019 while (isspace(s[count])) count++;
2022 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2024 if (data_block == NULL)
2025 *((int *)(ol->value)) = value;
2027 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2030 /* There's a special routine to read time values. */
2033 value = readconf_readtime(s, 0, FALSE);
2035 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2037 if (data_block == NULL)
2038 *((int *)(ol->value)) = value;
2040 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2043 /* A time list is a list of colon-separated times, with the first
2044 element holding the size of the list and the second the number of
2050 int *list = (data_block == NULL)?
2051 (int *)(ol->value) :
2052 (int *)((uschar *)data_block + (long int)(ol->value));
2054 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2057 uschar *snext = Ustrchr(s, ':');
2061 while (ss > s && isspace(ss[-1])) ss--;
2064 value = readconf_readtime(s, terminator, FALSE);
2066 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2068 if (count > 1 && value <= list[count])
2069 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2070 "time value out of order for %s", name);
2071 list[count+1] = value;
2072 if (snext == NULL) break;
2074 while (isspace(*s)) s++;
2077 if (count > list[0] - 2)
2078 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2080 if (count > 0 && list[2] == 0) count = 0;
2092 /*************************************************
2093 * Print a time value *
2094 *************************************************/
2097 Argument: a time value in seconds
2098 Returns: pointer to a fixed buffer containing the time as a string,
2099 in readconf_readtime() format
2103 readconf_printtime(int t)
2106 uschar *p = time_buffer;
2123 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2124 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2125 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2126 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2127 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2134 /*************************************************
2135 * Print an individual option value *
2136 *************************************************/
2138 /* This is used by the -bP option, so prints to the standard output.
2139 The entire options list is passed in as an argument, because some options come
2140 in pairs - typically uid/gid settings, which can either be explicit numerical
2141 values, or strings to be expanded later. If the numerical value is unset,
2142 search for "*expand_<name>" to see if there is a string equivalent.
2145 ol option entry, or NULL for an unknown option
2147 options_block NULL for main configuration options; otherwise points to
2148 a driver block; if the option doesn't have opt_public
2149 set, then options_block->options_block is where the item
2151 oltop points to the option list in which ol exists
2152 last one more than the offset of the last entry in optop
2158 print_ol(optionlist *ol, uschar *name, void *options_block,
2159 optionlist *oltop, int last)
2172 printf("%s is not a known option\n", name);
2176 /* Non-admin callers cannot see options that have been flagged secure by the
2179 if (!admin_user && (ol->type & opt_secure) != 0)
2181 printf("%s = <value not displayable>\n", name);
2185 /* Else show the value of the option */
2188 if (options_block != NULL)
2190 if ((ol->type & opt_public) == 0)
2191 options_block = (void *)(((driver_instance *)options_block)->options_block);
2192 value = (void *)((uschar *)options_block + (long int)value);
2195 switch(ol->type & opt_mask)
2198 case opt_rewrite: /* Show the text value */
2199 s = *((uschar **)value);
2200 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2204 printf("%s = %d\n", name, *((int *)value));
2209 int x = *((int *)value);
2210 if (x != 0 && (x & 1023) == 0)
2214 if ((x & 1023) == 0)
2219 printf("%s = %d%c\n", name, x, c);
2221 else printf("%s = %d\n", name, x);
2227 int x = *((int *)value);
2228 if (x == 0) printf("%s = 0\n", name);
2229 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2230 else printf("%s = %dK\n", name, x);
2235 printf("%s = %#o\n", name, *((int *)value));
2238 /* Can be negative only when "unset", in which case integer */
2242 int x = *((int *)value);
2245 if (x < 0) printf("%s =\n", name); else
2247 printf("%s = %d.", name, x/1000);
2260 /* If the numerical value is unset, try for the string value */
2262 case opt_expand_uid:
2263 if (! *get_set_flag(name, oltop, last, options_block))
2265 sprintf(CS name2, "*expand_%.50s", name);
2266 ol2 = find_option(name2, oltop, last);
2269 void *value2 = ol2->value;
2270 if (options_block != NULL)
2271 value2 = (void *)((uschar *)options_block + (long int)value2);
2272 s = *((uschar **)value2);
2273 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2278 /* Else fall through */
2281 if (! *get_set_flag(name, oltop, last, options_block))
2282 printf("%s =\n", name);
2285 pw = getpwuid(*((uid_t *)value));
2287 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2288 else printf("%s = %s\n", name, pw->pw_name);
2292 /* If the numerical value is unset, try for the string value */
2294 case opt_expand_gid:
2295 if (! *get_set_flag(name, oltop, last, options_block))
2297 sprintf(CS name2, "*expand_%.50s", name);
2298 ol2 = find_option(name2, oltop, last);
2299 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2301 void *value2 = ol2->value;
2302 if (options_block != NULL)
2303 value2 = (void *)((uschar *)options_block + (long int)value2);
2304 s = *((uschar **)value2);
2305 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2310 /* Else fall through */
2313 if (! *get_set_flag(name, oltop, last, options_block))
2314 printf("%s =\n", name);
2317 gr = getgrgid(*((int *)value));
2319 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2320 else printf("%s = %s\n", name, gr->gr_name);
2325 uidlist = *((uid_t **)value);
2326 printf("%s =", name);
2327 if (uidlist != NULL)
2331 for (i = 1; i <= (int)(uidlist[0]); i++)
2333 uschar *name = NULL;
2334 pw = getpwuid(uidlist[i]);
2335 if (pw != NULL) name = US pw->pw_name;
2336 if (name != NULL) printf("%c%s", sep, name);
2337 else printf("%c%ld", sep, (long int)(uidlist[i]));
2345 gidlist = *((gid_t **)value);
2346 printf("%s =", name);
2347 if (gidlist != NULL)
2351 for (i = 1; i <= (int)(gidlist[0]); i++)
2353 uschar *name = NULL;
2354 gr = getgrgid(gidlist[i]);
2355 if (gr != NULL) name = US gr->gr_name;
2356 if (name != NULL) printf("%c%s", sep, name);
2357 else printf("%c%ld", sep, (long int)(gidlist[i]));
2365 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2371 int *list = (int *)value;
2372 printf("%s = ", name);
2373 for (i = 0; i < list[1]; i++)
2374 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2380 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2384 case opt_expand_bool:
2385 sprintf(CS name2, "*expand_%.50s", name);
2386 ol2 = find_option(name2, oltop, last);
2387 if (ol2 != NULL && ol2->value != NULL)
2389 void *value2 = ol2->value;
2390 if (options_block != NULL)
2391 value2 = (void *)((uschar *)options_block + (long int)value2);
2392 s = *((uschar **)value2);
2395 printf("%s = %s\n", name, string_printing(s));
2398 /* s == NULL => string not set; fall through */
2404 case opt_bool_verify:
2406 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2413 /*************************************************
2414 * Print value from main configuration *
2415 *************************************************/
2417 /* This function, called as a result of encountering the -bP option,
2418 causes the value of any main configuration variable to be output if the
2419 second argument is NULL. There are some special values:
2421 all print all main configuration options
2422 configure_file print the name of the configuration file
2423 routers print the routers' configurations
2424 transports print the transports' configuration
2425 authenticators print the authenticators' configuration
2426 macros print the macros' configuration
2427 router_list print a list of router names
2428 transport_list print a list of transport names
2429 authenticator_list print a list of authentication mechanism names
2430 macro_list print a list of macro names
2431 +name print a named list item
2432 local_scan print the local_scan options
2434 If the second argument is not NULL, it must be one of "router", "transport",
2435 "authenticator" or "macro" in which case the first argument identifies the
2436 driver whose options are to be printed.
2439 name option name if type == NULL; else driver name
2440 type NULL or driver type name, as described above
2446 readconf_print(uschar *name, uschar *type)
2448 BOOL names_only = FALSE;
2450 optionlist *ol2 = NULL;
2451 driver_instance *d = NULL;
2462 static uschar *types[] = { US"address", US"domain", US"host",
2464 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2465 &hostlist_anchor, &localpartlist_anchor };
2467 for (i = 0; i < 4; i++)
2469 t = tree_search(*(anchors[i]), name+1);
2473 printf("%slist %s = %s\n", types[i], name+1,
2474 ((namedlist_block *)(t->data.ptr))->string);
2479 printf("no address, domain, host, or local part list called \"%s\" "
2480 "exists\n", name+1);
2485 if (Ustrcmp(name, "configure_file") == 0)
2487 printf("%s\n", CS config_main_filename);
2491 if (Ustrcmp(name, "all") == 0)
2493 for (ol = optionlist_config;
2494 ol < optionlist_config + optionlist_config_size; ol++)
2496 if ((ol->type & opt_hidden) == 0)
2497 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2502 if (Ustrcmp(name, "local_scan") == 0)
2504 #ifndef LOCAL_SCAN_HAS_OPTIONS
2505 printf("local_scan() options are not supported\n");
2507 for (ol = local_scan_options;
2508 ol < local_scan_options + local_scan_options_count; ol++)
2510 print_ol(ol, US ol->name, NULL, local_scan_options,
2511 local_scan_options_count);
2517 if (Ustrcmp(name, "routers") == 0)
2522 else if (Ustrcmp(name, "transports") == 0)
2524 type = US"transport";
2528 else if (Ustrcmp(name, "authenticators") == 0)
2530 type = US"authenticator";
2534 else if (Ustrcmp(name, "macros") == 0)
2540 else if (Ustrcmp(name, "router_list") == 0)
2547 else if (Ustrcmp(name, "transport_list") == 0)
2549 type = US"transport";
2554 else if (Ustrcmp(name, "authenticator_list") == 0)
2556 type = US"authenticator";
2561 else if (Ustrcmp(name, "macro_list") == 0)
2570 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2571 name, NULL, optionlist_config, optionlist_config_size);
2576 /* Handle the options for a router or transport. Skip options that are flagged
2577 as hidden. Some of these are options with names starting with '*', used for
2578 internal alternative representations of other options (which the printing
2579 function will sort out). Others are synonyms kept for backward compatibility.
2582 if (Ustrcmp(type, "router") == 0)
2584 d = (driver_instance *)routers;
2585 ol2 = optionlist_routers;
2586 size = optionlist_routers_size;
2588 else if (Ustrcmp(type, "transport") == 0)
2590 d = (driver_instance *)transports;
2591 ol2 = optionlist_transports;
2592 size = optionlist_transports_size;
2594 else if (Ustrcmp(type, "authenticator") == 0)
2596 d = (driver_instance *)auths;
2597 ol2 = optionlist_auths;
2598 size = optionlist_auths_size;
2601 else if (Ustrcmp(type, "macro") == 0)
2603 /* People store passwords in macros and they were previously not available
2604 for printing. So we have an admin_users restriction. */
2607 fprintf(stderr, "exim: permission denied\n");
2610 for (m = macros; m != NULL; m = m->next)
2612 if (name == NULL || Ustrcmp(name, m->name) == 0)
2615 printf("%s\n", CS m->name);
2617 printf("%s=%s\n", CS m->name, CS m->replacement);
2623 printf("%s %s not found\n", type, name);
2629 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2633 /* Either search for a given driver, or print all of them */
2635 for (; d != NULL; d = d->next)
2638 printf("\n%s %s:\n", d->name, type);
2639 else if (Ustrcmp(d->name, name) != 0) continue;
2641 for (ol = ol2; ol < ol2 + size; ol++)
2643 if ((ol->type & opt_hidden) == 0)
2644 print_ol(ol, US ol->name, d, ol2, size);
2647 for (ol = d->info->options;
2648 ol < d->info->options + *(d->info->options_count); ol++)
2650 if ((ol->type & opt_hidden) == 0)
2651 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2653 if (name != NULL) return;
2655 if (name != NULL) printf("%s %s not found\n", type, name);
2660 /*************************************************
2661 * Read a named list item *
2662 *************************************************/
2664 /* This function reads a name and a list (i.e. string). The name is used to
2665 save the list in a tree, sorted by its name. Each entry also has a number,
2666 which can be used for caching tests, but if the string contains any expansion
2667 items other than $key, the number is set negative to inhibit caching. This
2668 mechanism is used for domain, host, and address lists that are referenced by
2672 anchorp points to the tree anchor
2673 numberp points to the current number for this tree
2674 max the maximum number permitted
2675 s the text of the option line, starting immediately after the name
2677 tname the name of the list type, for messages
2683 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2686 BOOL forcecache = FALSE;
2689 namedlist_block *nb = store_get(sizeof(namedlist_block));
2691 if (Ustrncmp(s, "_cache", 6) == 0)
2698 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2700 if (*numberp >= max)
2701 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2704 while (isspace(*s)) s++;
2706 while (isalnum(*s) || *s == '_') s++;
2707 t = store_get(sizeof(tree_node) + s-ss);
2708 Ustrncpy(t->name, ss, s-ss);
2710 while (isspace(*s)) s++;
2712 if (!tree_insertnode(anchorp, t))
2713 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2714 "duplicate name \"%s\" for a named %s", t->name, tname);
2717 nb->number = *numberp;
2720 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2721 "missing '=' after \"%s\"", t->name);
2722 while (isspace(*s)) s++;
2723 nb->string = read_string(s, t->name);
2724 nb->cache_data = NULL;
2726 /* Check the string for any expansions; if any are found, mark this list
2727 uncacheable unless the user has explicited forced caching. */
2729 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2735 /*************************************************
2736 * Unpick data for a rate limit *
2737 *************************************************/
2739 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2743 s string, in the form t,b,f,l
2744 where t is the threshold (integer)
2745 b is the initial delay (time)
2746 f is the multiplicative factor (fixed point)
2747 k is the maximum time (time)
2748 threshold where to store threshold
2749 base where to store base in milliseconds
2750 factor where to store factor in milliseconds
2751 limit where to store limit
2753 Returns: nothing (panics on error)
2757 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2760 uschar bstring[16], lstring[16];
2762 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2763 factor, lstring) == 4)
2765 *base = readconf_readtime(bstring, 0, TRUE);
2766 *limit = readconf_readtime(lstring, 0, TRUE);
2767 if (*base >= 0 && *limit >= 0) return;
2769 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2775 /*************************************************
2776 * Drop privs for checking TLS config *
2777 *************************************************/
2779 /* We want to validate TLS options during readconf, but do not want to be
2780 root when we call into the TLS library, in case of library linkage errors
2781 which cause segfaults; before this check, those were always done as the Exim
2782 runtime user and it makes sense to continue with that.
2784 Assumes: tls_require_ciphers has been set, if it will be
2785 exim_user has been set, if it will be
2786 exim_group has been set, if it will be
2788 Returns: bool for "okay"; false will cause caller to immediately exit.
2793 tls_dropprivs_validate_require_cipher(void)
2795 const uschar *errmsg;
2798 void (*oldsignal)(int);
2800 oldsignal = signal(SIGCHLD, SIG_DFL);
2803 if ((pid = fork()) < 0)
2804 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2808 exim_setugid(exim_uid, exim_gid, FALSE,
2809 US"calling tls_validate_require_cipher");
2811 errmsg = tls_validate_require_cipher();
2814 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2815 "tls_require_ciphers invalid: %s", errmsg);
2822 rc = waitpid(pid, &status, 0);
2823 } while (rc < 0 && errno == EINTR);
2826 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
2829 signal(SIGCHLD, oldsignal);
2833 #endif /* SUPPORT_TLS */
2838 /*************************************************
2839 * Read main configuration options *
2840 *************************************************/
2842 /* This function is the first to be called for configuration reading. It
2843 opens the configuration file and reads general configuration settings until
2844 it reaches the end of the configuration section. The file is then left open so
2845 that the remaining configuration data can subsequently be read if needed for
2848 The configuration file must be owned either by root or exim, and be writeable
2849 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2850 in the config file, so the test is done on the compiled in values. A slight
2851 anomaly, to be carefully documented.
2853 The name of the configuration file is taken from a list that is included in the
2854 binary of Exim. It can be altered from the command line, but if that is done,
2855 root privilege is immediately withdrawn unless the caller is root or exim.
2856 The first file on the list that exists is used.
2858 For use on multiple systems that share file systems, first look for a
2859 configuration file whose name has the current node name on the end. If that is
2860 not found, try the generic name. For really contorted configurations, that run
2861 multiple Exims with different uid settings, first try adding the effective uid
2862 before the node name. These complications are going to waste resources on most
2863 systems. Therefore they are available only when requested by compile-time
2870 struct stat statbuf;
2871 uschar *s, *filename;
2872 uschar *list = config_main_filelist;
2874 /* Loop through the possible file names */
2876 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2879 /* Cut out all the fancy processing unless specifically wanted */
2881 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2882 uschar *suffix = filename + Ustrlen(filename);
2884 /* Try for the node-specific file if a node name exists */
2886 #ifdef CONFIGURE_FILE_USE_NODE
2888 if (uname(&uts) >= 0)
2890 #ifdef CONFIGURE_FILE_USE_EUID
2891 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2892 config_file = Ufopen(filename, "rb");
2893 if (config_file == NULL)
2894 #endif /* CONFIGURE_FILE_USE_EUID */
2896 sprintf(CS suffix, ".%.256s", uts.nodename);
2897 config_file = Ufopen(filename, "rb");
2900 #endif /* CONFIGURE_FILE_USE_NODE */
2902 /* Otherwise, try the generic name, possibly with the euid added */
2904 #ifdef CONFIGURE_FILE_USE_EUID
2905 if (config_file == NULL)
2907 sprintf(CS suffix, ".%ld", (long int)original_euid);
2908 config_file = Ufopen(filename, "rb");
2910 #endif /* CONFIGURE_FILE_USE_EUID */
2912 /* Finally, try the unadorned name */
2914 if (config_file == NULL)
2917 config_file = Ufopen(filename, "rb");
2919 #else /* if neither defined */
2921 /* This is the common case when the fancy processing is not included. */
2923 config_file = Ufopen(filename, "rb");
2926 /* If the file does not exist, continue to try any others. For any other
2927 error, break out (and die). */
2929 if (config_file != NULL || errno != ENOENT) break;
2932 /* On success, save the name for verification; config_filename is used when
2933 logging configuration errors (it changes for .included files) whereas
2934 config_main_filename is the name shown by -bP. Failure to open a configuration
2935 file is a serious disaster. */
2937 if (config_file != NULL)
2939 config_filename = config_main_filename = string_copy(filename);
2943 if (filename == NULL)
2944 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2945 "%s", config_main_filelist);
2947 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2948 "configuration file %s", filename));
2951 /* Check the status of the file we have opened, if we have retained root
2952 privileges and the file isn't /dev/null (which *should* be 0666). */
2954 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
2956 if (fstat(fileno(config_file), &statbuf) != 0)
2957 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2960 if ((statbuf.st_uid != root_uid /* owner not root */
2961 #ifdef CONFIGURE_OWNER
2962 && statbuf.st_uid != config_uid /* owner not the special one */
2965 (statbuf.st_gid != root_gid /* group not root & */
2966 #ifdef CONFIGURE_GROUP
2967 && statbuf.st_gid != config_gid /* group not the special one */
2969 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2971 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2973 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2974 "wrong owner, group, or mode", big_buffer);
2977 /* Process the main configuration settings. They all begin with a lower case
2978 letter. If we see something starting with an upper case letter, it is taken as
2979 a macro definition. */
2981 while ((s = get_config_line()) != NULL)
2983 if (isupper(s[0])) read_macro_assignment(s);
2985 else if (Ustrncmp(s, "domainlist", 10) == 0)
2986 read_named_list(&domainlist_anchor, &domainlist_count,
2987 MAX_NAMED_LIST, s+10, US"domain list");
2989 else if (Ustrncmp(s, "hostlist", 8) == 0)
2990 read_named_list(&hostlist_anchor, &hostlist_count,
2991 MAX_NAMED_LIST, s+8, US"host list");
2993 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2994 read_named_list(&addresslist_anchor, &addresslist_count,
2995 MAX_NAMED_LIST, s+11, US"address list");
2997 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2998 read_named_list(&localpartlist_anchor, &localpartlist_count,
2999 MAX_NAMED_LIST, s+13, US"local part list");
3002 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3003 NULL, US"main option \"%s\" unknown");
3007 /* If local_sender_retain is set, local_from_check must be unset. */
3009 if (local_sender_retain && local_from_check)
3010 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3011 "local_sender_retain are set; this combination is not allowed");
3013 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3016 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3018 /* The max retry interval must not be greater than 24 hours. */
3020 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3022 /* remote_max_parallel must be > 0 */
3024 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3026 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3027 start of a new SMTP message. */
3029 freeze_tell_config = freeze_tell;
3031 /* The primary host name may be required for expansion of spool_directory
3032 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3033 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3034 canonize it. Some people like upper case letters in their host names, so we
3035 don't force the case. */
3037 if (primary_hostname == NULL)
3041 if (uname(&uts) < 0)
3042 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3043 hostname = US uts.nodename;
3045 if (Ustrchr(hostname, '.') == NULL)
3048 struct hostent *hostdata;
3051 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3052 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
3062 #if HAVE_GETIPNODEBYNAME
3064 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3066 hostdata = gethostbyname2(CS hostname, af);
3069 hostdata = gethostbyname(CS hostname);
3072 if (hostdata != NULL)
3074 hostname = US hostdata->h_name;
3078 if (af == AF_INET) break;
3083 primary_hostname = string_copy(hostname);
3086 /* Set up default value for smtp_active_hostname */
3088 smtp_active_hostname = primary_hostname;
3090 /* If spool_directory wasn't set in the build-time configuration, it must have
3091 got set above. Of course, writing to the log may not work if log_file_path is
3092 not set, but it will at least get to syslog or somewhere, with any luck. */
3094 if (*spool_directory == 0)
3095 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3098 /* Expand the spool directory name; it may, for example, contain the primary
3099 host name. Same comment about failure. */
3101 s = expand_string(spool_directory);
3103 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3104 "\"%s\": %s", spool_directory, expand_string_message);
3105 spool_directory = s;
3107 /* Expand log_file_path, which must contain "%s" in any component that isn't
3108 the null string or "syslog". It is also allowed to contain one instance of %D
3109 or %M. However, it must NOT contain % followed by anything else. */
3111 if (*log_file_path != 0)
3114 int sep = ':'; /* Fixed for log file path */
3115 s = expand_string(log_file_path);
3117 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3118 "\"%s\": %s", log_file_path, expand_string_message);
3121 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3124 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3125 t = Ustrstr(sss, "%s");
3127 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3128 "contain \"%%s\"", sss);
3130 t = Ustrchr(sss, '%');
3133 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3134 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3135 "unexpected \"%%\" character", s);
3142 /* Interpret syslog_facility into an integer argument for 'ident' param to
3143 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3146 if (syslog_facility_str != NULL)
3149 uschar *s = syslog_facility_str;
3151 if ((Ustrlen(syslog_facility_str) >= 4) &&
3152 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3155 for (i = 0; i < syslog_list_size; i++)
3157 if (strcmpic(s, syslog_list[i].name) == 0)
3159 syslog_facility = syslog_list[i].value;
3164 if (i >= syslog_list_size)
3166 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3167 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3171 /* Expand pid_file_path */
3173 if (*pid_file_path != 0)
3175 s = expand_string(pid_file_path);
3177 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3178 "\"%s\": %s", pid_file_path, expand_string_message);
3182 /* Set default value of process_log_path */
3184 if (process_log_path == NULL || *process_log_path =='\0')
3185 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3187 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3190 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3192 /* Unpick the SMTP rate limiting options, if set */
3194 if (smtp_ratelimit_mail != NULL)
3196 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3197 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3200 if (smtp_ratelimit_rcpt != NULL)
3202 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3203 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3206 /* The qualify domains default to the primary host name */
3208 if (qualify_domain_sender == NULL)
3209 qualify_domain_sender = primary_hostname;
3210 if (qualify_domain_recipient == NULL)
3211 qualify_domain_recipient = qualify_domain_sender;
3213 /* Setting system_filter_user in the configuration sets the gid as well if a
3214 name is given, but a numerical value does not. */
3216 if (system_filter_uid_set && !system_filter_gid_set)
3218 struct passwd *pw = getpwuid(system_filter_uid);
3220 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3221 (long int)system_filter_uid);
3222 system_filter_gid = pw->pw_gid;
3223 system_filter_gid_set = TRUE;
3226 /* If the errors_reply_to field is set, check that it is syntactically valid
3227 and ensure it contains a domain. */
3229 if (errors_reply_to != NULL)
3232 int start, end, domain;
3233 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3234 &start, &end, &domain, FALSE);
3236 if (recipient == NULL)
3237 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3238 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3241 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3242 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3245 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3246 smtp_accept_max must also be set. */
3248 if (smtp_accept_max == 0 &&
3249 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3250 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3251 "smtp_accept_max must be set if smtp_accept_queue or "
3252 "smtp_accept_max_per_host is set");
3254 /* Set up the host number if anything is specified. It is an expanded string
3255 so that it can be computed from the host name, for example. We do this last
3256 so as to ensure that everything else is set up before the expansion. */
3258 if (host_number_string != NULL)
3262 uschar *s = expand_string(host_number_string);
3264 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3265 "failed to expand localhost_number \"%s\": %s",
3266 host_number_string, expand_string_message);
3267 n = Ustrtol(s, &end, 0);
3268 while (isspace(*end)) end++;
3270 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3271 "localhost_number value is not a number: %s", s);
3272 if (n > LOCALHOST_MAX)
3273 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3274 "localhost_number is greater than the maximum allowed value (%d)",
3280 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3282 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3283 tls_verify_certificates == NULL)
3284 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3285 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3286 (tls_verify_hosts != NULL)? "" : "try_");
3288 /* This also checks that the library linkage is working and we can call
3289 routines in it, so call even if tls_require_ciphers is unset */
3290 if (!tls_dropprivs_validate_require_cipher())
3293 /* Magic number: at time of writing, 1024 has been the long-standing value
3294 used by so many clients, and what Exim used to use always, that it makes
3295 sense to just min-clamp this max-clamp at that. */
3296 if (tls_dh_max_bits < 1024)
3297 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3298 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3300 /* If openssl_options is set, validate it */
3301 if (openssl_options != NULL)
3304 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3305 "openssl_options is set but we're using GnuTLS");
3308 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3309 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3310 "openssl_options parse error: %s", openssl_options);
3318 /*************************************************
3319 * Initialize one driver *
3320 *************************************************/
3322 /* This is called once the driver's generic options, if any, have been read.
3323 We can now find the driver, set up defaults for the private options, and
3324 unset any "set" bits in the private options table (which might have been
3325 set by another incarnation of the same driver).
3328 d pointer to driver instance block, with generic
3330 drivers_available vector of available drivers
3331 size_of_info size of each block in drivers_available
3332 class class of driver, for error message
3334 Returns: pointer to the driver info block
3337 static driver_info *
3338 init_driver(driver_instance *d, driver_info *drivers_available,
3339 int size_of_info, uschar *class)
3343 for (dd = drivers_available; dd->driver_name[0] != 0;
3344 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3346 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3349 int len = dd->options_len;
3351 d->options_block = store_get(len);
3352 memcpy(d->options_block, dd->options_block, len);
3353 for (i = 0; i < *(dd->options_count); i++)
3354 dd->options[i].type &= ~opt_set;
3359 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3360 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3362 return NULL; /* never obeyed */
3368 /*************************************************
3369 * Initialize driver list *
3370 *************************************************/
3372 /* This function is called for routers, transports, and authentication
3373 mechanisms. It reads the data from the current point in the configuration file
3374 up to the end of the section, and sets up a chain of instance blocks according
3375 to the file's contents. The file will already have been opened by a call to
3376 readconf_main, and must be left open for subsequent reading of further data.
3378 Any errors cause a panic crash. Note that the blocks with names driver_info and
3379 driver_instance must map the first portions of all the _info and _instance
3380 blocks for this shared code to work.
3383 class "router", "transport", or "authenticator"
3384 anchor &routers, &transports, &auths
3385 drivers_available available drivers
3386 size_of_info size of each info block
3387 instance_default points to default data for an instance
3388 instance_size size of instance block
3389 driver_optionlist generic option list
3390 driver_optionlist_count count of generic option list
3396 readconf_driver_init(
3398 driver_instance **anchor,
3399 driver_info *drivers_available,
3401 void *instance_default,
3403 optionlist *driver_optionlist,
3404 int driver_optionlist_count)
3406 driver_instance **p = anchor;
3407 driver_instance *d = NULL;
3410 while ((buffer = get_config_line()) != NULL)
3415 /* Read the first name on the line and test for the start of a new driver. A
3416 macro definition indicates the end of the previous driver. If this isn't the
3417 start of a new driver, the line will be re-read. */
3419 s = readconf_readname(name, sizeof(name), buffer);
3421 /* Handle macro definition, first finishing off the initialization of the
3422 previous driver, if any. */
3424 if (isupper(*name) && *s == '=')
3428 if (d->driver_name == NULL)
3429 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3430 "no driver defined for %s \"%s\"", class, d->name);
3434 read_macro_assignment(buffer);
3438 /* If the line starts with a name terminated by a colon, we are at the
3439 start of the definition of a new driver. The rest of the line must be
3446 /* Finish off initializing the previous driver. */
3450 if (d->driver_name == NULL)
3451 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3452 "no driver defined for %s \"%s\"", class, d->name);
3456 /* Check that we haven't already got a driver of this name */
3458 for (d = *anchor; d != NULL; d = d->next)
3459 if (Ustrcmp(name, d->name) == 0)
3460 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3461 "there are two %ss called \"%s\"", class, name);
3463 /* Set up a new driver instance data block on the chain, with
3464 its default values installed. */
3466 d = store_get(instance_size);
3467 memcpy(d, instance_default, instance_size);
3470 d->name = string_copy(name);
3472 /* Clear out the "set" bits in the generic options */
3474 for (i = 0; i < driver_optionlist_count; i++)
3475 driver_optionlist[i].type &= ~opt_set;
3477 /* Check nothing more on this line, then do the next loop iteration. */
3479 while (isspace(*s)) s++;
3480 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3484 /* Not the start of a new driver. Give an error if we have not set up a
3485 current driver yet. */
3487 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3488 "%s name missing", class);
3490 /* First look to see if this is a generic option; if it is "driver",
3491 initialize the driver. If is it not a generic option, we can look for a
3492 private option provided that the driver has been previously set up. */
3494 if (readconf_handle_option(buffer, driver_optionlist,
3495 driver_optionlist_count, d, NULL))
3497 if (d->info == NULL && d->driver_name != NULL)
3498 init_driver(d, drivers_available, size_of_info, class);
3501 /* Handle private options - pass the generic block because some may
3502 live therein. A flag with each option indicates if it is in the public
3505 else if (d->info != NULL)
3507 readconf_handle_option(buffer, d->info->options,
3508 *(d->info->options_count), d, US"option \"%s\" unknown");
3511 /* The option is not generic and the driver name has not yet been given. */
3513 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3514 "(\"driver\" must be specified before any private options)", name);
3517 /* Run the initialization function for the final driver. */
3521 if (d->driver_name == NULL)
3522 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3523 "no driver defined for %s \"%s\"", class, d->name);
3530 /*************************************************
3531 * Check driver dependency *
3532 *************************************************/
3534 /* This function is passed a driver instance and a string. It checks whether
3535 any of the string options for the driver contains the given string as an
3539 d points to a driver instance block
3540 s the string to search for
3542 Returns: TRUE if a dependency is found
3546 readconf_depends(driver_instance *d, uschar *s)
3548 int count = *(d->info->options_count);
3552 for (ol = d->info->options; ol < d->info->options + count; ol++)
3554 void *options_block;
3556 int type = ol->type & opt_mask;
3557 if (type != opt_stringptr) continue;
3558 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3559 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3560 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3562 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3563 isalnum(ss[Ustrlen(s)])) continue;
3564 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3565 d->name, ol->name, s);
3570 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3577 /*************************************************
3578 * Decode an error type for retries *
3579 *************************************************/
3581 /* This function is global because it is also called from the main
3582 program when testing retry information. It decodes strings such as "quota_7d"
3583 into numerical error codes.
3586 pp points to start of text
3587 p points past end of text
3588 basic_errno points to an int to receive the main error number
3589 more_errno points to an int to receive the secondary error data
3591 Returns: NULL if decoded correctly; else points to error text
3595 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3599 while (q < p && *q != '_') q++;
3602 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3604 *basic_errno = ERRNO_EXIMQUOTA;
3605 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3606 return US"bad time value";
3609 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3611 *basic_errno = ECONNREFUSED;
3614 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3615 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3616 else return US"A or MX expected after \"refused\"";
3620 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3622 *basic_errno = ETIMEDOUT;
3626 int xlen = p - q - 1;
3629 static uschar *extras[] =
3630 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3631 static int values[] =
3632 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3634 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3636 if (strncmpic(x, extras[i], xlen) == 0)
3638 *more_errno = values[i];
3643 if (i >= sizeof(extras)/sizeof(uschar *))
3645 if (strncmpic(x, US"DNS", xlen) == 0)
3647 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3648 "available in retry rules (it has never worked) - treated as "
3651 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3656 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3657 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3658 strncmpic(pp, US"data_4", 6) == 0)
3661 int x = 255; /* means "any 4xx code" */
3662 if (p != pp + 8) bad = TRUE; else
3664 int a = pp[6], b = pp[7];
3668 if (isdigit(b)) x += b - '0';
3669 else if (b == 'x') x += 100;
3672 else if (a != 'x' || b != 'x') bad = TRUE;
3676 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3677 "x is literal and d is any digit", pp);
3679 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3680 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3681 *more_errno = x << 8;
3684 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3685 strncmpic(q+1, US"failed", p-q-1) == 0)
3686 *basic_errno = ERRNO_AUTHFAIL;
3688 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3689 *basic_errno = ERRNO_SMTPCLOSED;
3691 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3692 *basic_errno = ERRNO_TLSREQUIRED;
3694 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3695 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3703 /*************************************************
3704 * Read retry information *
3705 *************************************************/
3707 /* Each line of retry information contains:
3709 . A domain name pattern or an address pattern;
3711 . An error name, possibly with additional data, or *;
3713 . An optional sequence of retry items, each consisting of an identifying
3714 letter, a cutoff time, and optional parameters.
3716 All this is decoded and placed into a control block. */
3719 /* Subroutine to read an argument, preceded by a comma and terminated
3720 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3721 1 = fixed point number (returned *1000).
3724 paddr pointer to pointer to current character; updated
3725 type 0 => read a time; 1 => read a fixed point number
3727 Returns: time in seconds or fixed point number * 1000
3731 retry_arg(uschar **paddr, int type)
3736 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3738 while (isspace(*p)) p++;
3740 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3742 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3743 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3749 return readconf_readtime(pp, *p, FALSE);
3751 return readconf_readfixed(pp, *p);
3753 return 0; /* Keep picky compilers happy */
3756 /* The function proper */
3759 readconf_retries(void)
3761 retry_config **chain = &retries;
3765 while ((p = get_config_line()) != NULL)
3767 retry_rule **rchain;
3770 next = store_get(sizeof(retry_config));
3773 chain = &(next->next);
3774 next->basic_errno = next->more_errno = 0;
3775 next->senders = NULL;
3777 rchain = &(next->rules);
3779 next->pattern = string_dequote(&p);
3780 while (isspace(*p)) p++;
3782 while (mac_isgraph(*p)) p++;
3783 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3784 "missing error type");
3786 /* Test error names for things we understand. */
3788 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3789 &(next->more_errno))) != NULL)
3790 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3792 /* There may be an optional address list of senders to be used as another
3793 constraint on the rule. This was added later, so the syntax is a bit of a
3794 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3797 while (isspace(*p)) p++;
3798 if (Ustrncmp(p, "senders", 7) == 0)
3801 while (isspace(*p)) p++;
3802 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3803 "\"=\" expected after \"senders\" in retry rule");
3804 while (isspace(*p)) p++;
3805 next->senders = string_dequote(&p);
3808 /* Now the retry rules. Keep the maximum timeout encountered. */
3810 while (isspace(*p)) p++;
3814 retry_rule *rule = store_get(sizeof(retry_rule));
3816 rchain = &(rule->next);
3818 rule->rule = toupper(*p++);
3819 rule->timeout = retry_arg(&p, 0);
3820 if (rule->timeout > retry_maximum_timeout)
3821 retry_maximum_timeout = rule->timeout;
3825 case 'F': /* Fixed interval */
3826 rule->p1 = retry_arg(&p, 0);
3829 case 'G': /* Geometrically increasing intervals */
3830 case 'H': /* Ditto, but with randomness */
3831 rule->p1 = retry_arg(&p, 0);
3832 rule->p2 = retry_arg(&p, 1);
3836 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3840 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3841 (rule->rule != 'F' && rule->p2 < 1000))
3842 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3843 "bad parameters for retry rule");
3845 while (isspace(*p)) p++;
3849 while (isspace(*p)) p++;
3852 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3859 /*************************************************
3860 * Initialize authenticators *
3861 *************************************************/
3863 /* Read the authenticators section of the configuration file.
3872 auth_instance *au, *bu;
3873 readconf_driver_init(US"authenticator",
3874 (driver_instance **)(&auths), /* chain anchor */
3875 (driver_info *)auths_available, /* available drivers */
3876 sizeof(auth_info), /* size of info block */
3877 &auth_defaults, /* default values for generic options */
3878 sizeof(auth_instance), /* size of instance block */
3879 optionlist_auths, /* generic options */
3880 optionlist_auths_size);
3882 for (au = auths; au != NULL; au = au->next)
3884 if (au->public_name == NULL)
3885 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3886 "the %s authenticator", au->name);
3887 for (bu = au->next; bu != NULL; bu = bu->next)
3889 if (strcmpic(au->public_name, bu->public_name) == 0)
3891 if ((au->client && bu->client) || (au->server && bu->server))
3892 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3893 "(%s and %s) have the same public name (%s)",
3894 (au->client)? US"client" : US"server", au->name, bu->name,
3904 /*************************************************
3905 * Read ACL information *
3906 *************************************************/
3908 /* If this run of Exim is not doing something that involves receiving a
3909 message, we can just skip over the ACL information. No need to parse it.
3911 First, we have a function for acl_read() to call back to get the next line. We
3912 need to remember the line we passed, because at the end it will contain the
3913 name of the next ACL. */
3915 static uschar *acl_line;
3920 acl_line = get_config_line();
3925 /* Now the main function:
3928 skip TRUE when this Exim process is doing something that will
3929 not need the ACL data
3935 readconf_acl(BOOL skip)
3939 /* Not receiving messages, don't need to parse the ACL data */
3943 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3944 while ((p = get_config_line()) != NULL);
3948 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3951 acl_line = get_config_line();
3953 while(acl_line != NULL)
3959 p = readconf_readname(name, sizeof(name), acl_line);
3960 if (isupper(*name) && *p == '=')
3962 read_macro_assignment(acl_line);
3963 acl_line = get_config_line();
3967 if (*p != ':' || name[0] == 0)
3968 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3970 node = store_get(sizeof(tree_node) + Ustrlen(name));
3971 Ustrcpy(node->name, name);
3972 if (!tree_insertnode(&acl_anchor, node))
3973 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3974 "there are two ACLs called \"%s\"", name);
3976 node->data.ptr = acl_read(acl_callback, &error);
3978 if (node->data.ptr == NULL && error != NULL)
3979 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3985 /*************************************************
3986 * Read configuration for local_scan() *
3987 *************************************************/
3989 /* This function is called after "begin local_scan" is encountered in the
3990 configuration file. If the local_scan() function allows for configuration
3991 options, we can process them. Otherwise, we expire in a panic.
3998 local_scan_init(void)
4000 #ifndef LOCAL_SCAN_HAS_OPTIONS
4001 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4002 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4006 while ((p = get_config_line()) != NULL)
4008 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4009 NULL, US"local_scan option \"%s\" unknown");
4016 /*************************************************
4017 * Read rest of configuration (after main) *
4018 *************************************************/
4020 /* This function reads the rest of the runtime configuration, after the main
4021 configuration. It is called only when actually needed. Each subsequent section
4022 of the configuration starts with a line of the form
4026 where the name is "routers", "transports", etc. A section is terminated by
4027 hitting the next "begin" line, and the next name is left in next_section.
4028 Because it may confuse people as to whether the names are singular or plural,
4029 we add "s" if it's missing. There is always enough room in next_section for
4030 this. This function is basically just a switch.
4033 skip_acl TRUE if ACL information is not needed
4038 static uschar *section_list[] = {
4048 readconf_rest(BOOL skip_acl)
4052 while(next_section[0] != 0)
4056 int last = sizeof(section_list) / sizeof(uschar *);
4058 int n = Ustrlen(next_section);
4060 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4064 int c = strcmpic(next_section, section_list[mid]);
4066 if (c > 0) first = mid + 1; else last = mid;
4068 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4069 "\"%.*s\" is not a known configuration section name", n, next_section);
4070 mid = (last + first)/2;
4074 if (((had ^= bit) & bit) == 0)
4075 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4076 "\"%.*s\" section is repeated in the configuration file", n,
4081 case 0: readconf_acl(skip_acl); break;
4082 case 1: auths_init(); break;
4083 case 2: local_scan_init(); break;
4084 case 3: readconf_retries(); break;
4085 case 4: readconf_rewrites(); break;
4086 case 5: route_init(); break;
4087 case 6: transport_init(); break;
4091 (void)fclose(config_file);
4094 /* End of readconf.c */