1 /* $Cambridge: exim/src/src/readconf.c,v 1.40 2010/06/05 09:10:10 pdp Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2009 */
8 /* See the file NOTICE for conditions of use and distribution. */
10 /* Functions for reading the configuration file, and for displaying
11 overall configuration values. Thanks to Brian Candler for the original
12 implementation of the conditional .ifdef etc. */
16 #define CSTATE_STACK_SIZE 10
19 /* Structure for chain (stack) of .included files */
21 typedef struct config_file_item {
22 struct config_file_item *next;
28 /* Structure of table of conditional words and their state transitions */
30 typedef struct cond_item {
38 /* Structure of table of syslog facility names and values */
40 typedef struct syslog_fac_item {
46 /* Static variables */
48 static config_file_item *config_file_stack = NULL; /* For includes */
50 static uschar *syslog_facility_str = NULL;
51 static uschar next_section[24];
52 static uschar time_buffer[24];
54 /* State variables for conditional loading (.ifdef / .else / .endif) */
56 static int cstate = 0;
57 static int cstate_stack_ptr = -1;
58 static int cstate_stack[CSTATE_STACK_SIZE];
60 /* Table of state transitions for handling conditional inclusions. There are
61 four possible state transitions:
65 .elifdef true (or .else)
68 .endif just causes the previous cstate to be popped off the stack */
70 static int next_cstate[3][4] =
72 /* State 0: reading from file, or reading until next .else or .endif */
74 /* State 1: condition failed, skipping until next .else or .endif */
76 /* State 2: skipping until .endif */
80 /* Table of conditionals and the states to set. For each name, there are four
81 values: the length of the name (to save computing it each time), the state to
82 set if a macro was found in the line, the state to set if a macro was not found
83 in the line, and a stack manipulation setting which is:
85 -1 pull state value off the stack
86 0 don't alter the stack
87 +1 push value onto stack, before setting new state
90 static cond_item cond_list[] = {
91 { US"ifdef", 5, 0, 1, 1 },
92 { US"ifndef", 6, 1, 0, 1 },
93 { US"elifdef", 7, 2, 3, 0 },
94 { US"elifndef", 8, 3, 2, 0 },
95 { US"else", 4, 2, 2, 0 },
96 { US"endif", 5, 0, 0, -1 }
99 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
101 /* Table of syslog facility names and their values */
103 static syslog_fac_item syslog_list[] = {
104 { US"mail", LOG_MAIL },
105 { US"user", LOG_USER },
106 { US"news", LOG_NEWS },
107 { US"uucp", LOG_UUCP },
108 { US"local0", LOG_LOCAL0 },
109 { US"local1", LOG_LOCAL1 },
110 { US"local2", LOG_LOCAL2 },
111 { US"local3", LOG_LOCAL3 },
112 { US"local4", LOG_LOCAL4 },
113 { US"local5", LOG_LOCAL5 },
114 { US"local6", LOG_LOCAL6 },
115 { US"local7", LOG_LOCAL7 },
116 { US"daemon", LOG_DAEMON }
119 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
124 /*************************************************
125 * Main configuration options *
126 *************************************************/
128 /* The list of options that can be set in the main configuration file. This
129 must be in alphabetic order because it is searched by binary chop. */
131 static optionlist optionlist_config[] = {
132 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
133 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
134 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
135 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
136 { "accept_8bitmime", opt_bool, &accept_8bitmime },
137 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
138 #ifdef WITH_CONTENT_SCAN
139 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
141 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
142 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
143 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
144 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
146 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
148 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
149 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
150 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
151 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
152 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
153 #ifdef WITH_CONTENT_SCAN
154 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
156 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
157 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
158 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
159 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
161 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
163 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
164 { "admin_groups", opt_gidlist, &admin_groups },
165 { "allow_domain_literals", opt_bool, &allow_domain_literals },
166 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
167 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
168 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
169 { "auto_thaw", opt_time, &auto_thaw },
170 #ifdef WITH_CONTENT_SCAN
171 { "av_scanner", opt_stringptr, &av_scanner },
173 { "bi_command", opt_stringptr, &bi_command },
174 #ifdef EXPERIMENTAL_BRIGHTMAIL
175 { "bmi_config_file", opt_stringptr, &bmi_config_file },
177 { "bounce_message_file", opt_stringptr, &bounce_message_file },
178 { "bounce_message_text", opt_stringptr, &bounce_message_text },
179 { "bounce_return_body", opt_bool, &bounce_return_body },
180 { "bounce_return_message", opt_bool, &bounce_return_message },
181 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
182 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
183 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
184 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
185 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
186 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
187 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
188 { "check_log_inodes", opt_int, &check_log_inodes },
189 { "check_log_space", opt_Kint, &check_log_space },
190 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
191 { "check_spool_inodes", opt_int, &check_spool_inodes },
192 { "check_spool_space", opt_Kint, &check_spool_space },
193 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
194 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
195 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
196 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
197 #ifdef EXPERIMENTAL_DCC
198 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
199 { "dccifd_address", opt_stringptr, &dccifd_address },
200 { "dccifd_options", opt_stringptr, &dccifd_options },
202 { "delay_warning", opt_timelist, &delay_warning },
203 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
204 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
205 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
206 { "delivery_date_remove", opt_bool, &delivery_date_remove },
207 #ifdef ENABLE_DISABLE_FSYNC
208 { "disable_fsync", opt_bool, &disable_fsync },
210 { "disable_ipv6", opt_bool, &disable_ipv6 },
212 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
214 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
215 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
216 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
217 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
218 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
219 { "dns_retrans", opt_time, &dns_retrans },
220 { "dns_retry", opt_int, &dns_retry },
221 /* This option is now a no-op, retained for compability */
222 { "drop_cr", opt_bool, &drop_cr },
223 /*********************************************************/
224 { "dsn_from", opt_stringptr, &dsn_from },
225 { "envelope_to_remove", opt_bool, &envelope_to_remove },
226 { "errors_copy", opt_stringptr, &errors_copy },
227 { "errors_reply_to", opt_stringptr, &errors_reply_to },
228 { "exim_group", opt_gid, &exim_gid },
229 { "exim_path", opt_stringptr, &exim_path },
230 { "exim_user", opt_uid, &exim_uid },
231 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
232 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
233 { "finduser_retries", opt_int, &finduser_retries },
234 { "freeze_tell", opt_stringptr, &freeze_tell },
235 { "gecos_name", opt_stringptr, &gecos_name },
236 { "gecos_pattern", opt_stringptr, &gecos_pattern },
238 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
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_default_servers", opt_stringptr, &eldap_default_servers },
266 { "ldap_version", opt_int, &eldap_version },
268 { "local_from_check", opt_bool, &local_from_check },
269 { "local_from_prefix", opt_stringptr, &local_from_prefix },
270 { "local_from_suffix", opt_stringptr, &local_from_suffix },
271 { "local_interfaces", opt_stringptr, &local_interfaces },
272 { "local_scan_timeout", opt_time, &local_scan_timeout },
273 { "local_sender_retain", opt_bool, &local_sender_retain },
274 { "localhost_number", opt_stringptr, &host_number_string },
275 { "log_file_path", opt_stringptr, &log_file_path },
276 { "log_selector", opt_stringptr, &log_selector_string },
277 { "log_timezone", opt_bool, &log_timezone },
278 { "lookup_open_max", opt_int, &lookup_open_max },
279 { "max_username_length", opt_int, &max_username_length },
280 { "message_body_newlines", opt_bool, &message_body_newlines },
281 { "message_body_visible", opt_mkint, &message_body_visible },
282 { "message_id_header_domain", opt_stringptr, &message_id_domain },
283 { "message_id_header_text", opt_stringptr, &message_id_text },
284 { "message_logs", opt_bool, &message_logs },
285 { "message_size_limit", opt_stringptr, &message_size_limit },
286 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
287 { "move_frozen_messages", opt_bool, &move_frozen_messages },
289 { "mua_wrapper", opt_bool, &mua_wrapper },
291 { "mysql_servers", opt_stringptr, &mysql_servers },
293 { "never_users", opt_uidlist, &never_users },
295 { "openssl_options", opt_stringptr, &openssl_options },
298 { "oracle_servers", opt_stringptr, &oracle_servers },
300 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
302 { "perl_at_start", opt_bool, &opt_perl_at_start },
303 { "perl_startup", opt_stringptr, &opt_perl_startup },
306 { "pgsql_servers", opt_stringptr, &pgsql_servers },
308 { "pid_file_path", opt_stringptr, &pid_file_path },
309 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
310 { "preserve_message_logs", opt_bool, &preserve_message_logs },
311 { "primary_hostname", opt_stringptr, &primary_hostname },
312 { "print_topbitchars", opt_bool, &print_topbitchars },
313 { "process_log_path", opt_stringptr, &process_log_path },
314 { "prod_requires_admin", opt_bool, &prod_requires_admin },
315 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
316 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
317 { "queue_domains", opt_stringptr, &queue_domains },
318 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
319 { "queue_only", opt_bool, &queue_only },
320 { "queue_only_file", opt_stringptr, &queue_only_file },
321 { "queue_only_load", opt_fixed, &queue_only_load },
322 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
323 { "queue_only_override", opt_bool, &queue_only_override },
324 { "queue_run_in_order", opt_bool, &queue_run_in_order },
325 { "queue_run_max", opt_int, &queue_run_max },
326 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
327 { "receive_timeout", opt_time, &receive_timeout },
328 { "received_header_text", opt_stringptr, &received_header_text },
329 { "received_headers_max", opt_int, &received_headers_max },
330 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
331 { "recipients_max", opt_int, &recipients_max },
332 { "recipients_max_reject", opt_bool, &recipients_max_reject },
333 { "remote_max_parallel", opt_int, &remote_max_parallel },
334 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
335 { "retry_data_expire", opt_time, &retry_data_expire },
336 { "retry_interval_max", opt_time, &retry_interval_max },
337 { "return_path_remove", opt_bool, &return_path_remove },
338 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
339 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
340 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
341 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
342 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
343 { "smtp_accept_max", opt_int, &smtp_accept_max },
344 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
345 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
346 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
347 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
348 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
349 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
350 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
351 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
352 { "smtp_banner", opt_stringptr, &smtp_banner },
353 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
354 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
355 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
356 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
357 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
358 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
359 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
360 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
361 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
362 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
363 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
364 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
365 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
366 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
367 #ifdef WITH_CONTENT_SCAN
368 { "spamd_address", opt_stringptr, &spamd_address },
370 #ifdef EXPERIMENTAL_SPF
371 { "spf_guess", opt_stringptr, &spf_guess },
373 { "split_spool_directory", opt_bool, &split_spool_directory },
374 { "spool_directory", opt_stringptr, &spool_directory },
376 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
378 #ifdef EXPERIMENTAL_SRS
379 { "srs_config", opt_stringptr, &srs_config },
380 { "srs_hashlength", opt_int, &srs_hashlength },
381 { "srs_hashmin", opt_int, &srs_hashmin },
382 { "srs_maxage", opt_int, &srs_maxage },
383 { "srs_secrets", opt_stringptr, &srs_secrets },
384 { "srs_usehash", opt_bool, &srs_usehash },
385 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
387 { "strict_acl_vars", opt_bool, &strict_acl_vars },
388 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
389 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
390 { "syslog_duplication", opt_bool, &syslog_duplication },
391 { "syslog_facility", opt_stringptr, &syslog_facility_str },
392 { "syslog_processname", opt_stringptr, &syslog_processname },
393 { "syslog_timestamp", opt_bool, &syslog_timestamp },
394 { "system_filter", opt_stringptr, &system_filter },
395 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
396 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
397 { "system_filter_group", opt_gid, &system_filter_gid },
398 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
399 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
400 { "system_filter_user", opt_uid, &system_filter_uid },
401 { "tcp_nodelay", opt_bool, &tcp_nodelay },
402 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
403 { "timezone", opt_stringptr, &timezone_string },
405 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
406 { "tls_certificate", opt_stringptr, &tls_certificate },
407 { "tls_crl", opt_stringptr, &tls_crl },
408 { "tls_dhparam", opt_stringptr, &tls_dhparam },
409 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
410 { "tls_privatekey", opt_stringptr, &tls_privatekey },
411 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
412 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
413 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
414 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
415 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
417 { "trusted_groups", opt_gidlist, &trusted_groups },
418 { "trusted_users", opt_uidlist, &trusted_users },
419 { "unknown_login", opt_stringptr, &unknown_login },
420 { "unknown_username", opt_stringptr, &unknown_username },
421 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
422 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
423 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
424 { "warn_message_file", opt_stringptr, &warn_message_file },
425 { "write_rejectlog", opt_bool, &write_rejectlog }
428 static int optionlist_config_size =
429 sizeof(optionlist_config)/sizeof(optionlist);
433 /*************************************************
434 * Find the name of an option *
435 *************************************************/
437 /* This function is to aid debugging. Various functions take arguments that are
438 pointer variables in the options table or in option tables for various drivers.
439 For debugging output, it is useful to be able to find the name of the option
440 which is currently being processed. This function finds it, if it exists, by
441 searching the table(s).
443 Arguments: a value that is presumed to be in the table above
444 Returns: the option name, or an empty string
448 readconf_find_option(void *p)
452 transport_instance *t;
454 for (i = 0; i < optionlist_config_size; i++)
455 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
457 for (r = routers; r != NULL; r = r->next)
459 router_info *ri = r->info;
460 for (i = 0; i < ri->options_count[0]; i++)
462 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
463 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
464 return US ri->options[i].name;
468 for (t = transports; t != NULL; t = t->next)
470 transport_info *ti = t->info;
471 for (i = 0; i < ti->options_count[0]; i++)
473 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
474 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
475 return US ti->options[i].name;
485 /*************************************************
486 * Deal with an assignment to a macro *
487 *************************************************/
489 /* This function is called when a line that starts with an upper case letter is
490 encountered. The argument "line" should contain a complete logical line, and
491 start with the first letter of the macro name. The macro name and the
492 replacement text are extracted and stored. Redefinition of existing,
493 non-command line, macros is permitted using '==' instead of '='.
496 s points to the start of the logical line
502 read_macro_assignment(uschar *s)
508 macro_item *mlast = NULL;
510 while (isalnum(*s) || *s == '_')
512 if (namelen >= sizeof(name) - 1)
513 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
514 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
515 name[namelen++] = *s++;
519 while (isspace(*s)) s++;
521 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
528 while (isspace(*s)) s++;
530 /* If an existing macro of the same name was defined on the command line, we
531 just skip this definition. It's an error to attempt to redefine a macro without
532 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
533 It is also an error to define a macro whose name begins with the name of a
534 previously defined macro. Note: it is documented that the other way round
537 for (m = macros; m != NULL; m = m->next)
539 int len = Ustrlen(m->name);
541 if (Ustrcmp(m->name, name) == 0)
543 if (!m->command_line && !redef)
544 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
545 "defined (use \"==\" if you want to redefine it", name);
549 if (len < namelen && Ustrstr(name, m->name) != NULL)
550 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
551 "a macro because previously defined macro \"%s\" is a substring",
554 /* We cannot have this test, because it is documented that a substring
555 macro is permitted (there is even an example).
557 * if (len > namelen && Ustrstr(m->name, name) != NULL)
558 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
559 * "a macro because it is a substring of previously defined macro \"%s\"",
566 /* Check for an overriding command-line definition. */
568 if (m != NULL && m->command_line) return;
570 /* Redefinition must refer to an existing macro. */
575 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
579 /* We have a new definition. The macro_item structure includes a final vector
580 called "name" which is one byte long. Thus, adding "namelen" gives us enough
581 room to store the "name" string. */
585 m = store_get(sizeof(macro_item) + namelen);
586 if (macros == NULL) macros = m; else mlast->next = m;
587 Ustrncpy(m->name, name, namelen);
588 m->name[namelen] = 0;
590 m->command_line = FALSE;
593 /* Set the value of the new or redefined macro */
595 m->replacement = string_copy(s);
602 /*************************************************
603 * Read configuration line *
604 *************************************************/
606 /* A logical line of text is read from the configuration file into the big
607 buffer, taking account of macros, .includes, and continuations. The size of
608 big_buffer is increased if necessary. The count of configuration lines is
609 maintained. Physical input lines starting with # (ignoring leading white space,
610 and after macro replacement) and empty logical lines are always ignored.
611 Leading and trailing spaces are removed.
613 If we hit a line of the form "begin xxxx", the xxxx is placed in the
614 next_section vector, and the function returns NULL, indicating the end of a
615 configuration section. On end-of-file, NULL is returned with next_section
620 Returns: a pointer to the first non-blank in the line,
621 or NULL if eof or end of section is reached
625 get_config_line(void)
627 int startoffset = 0; /* To first non-blank char in logical line */
628 int len = 0; /* Of logical line so far */
634 /* Loop for handling continuation lines, skipping comments, and dealing with
639 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
641 if (config_file_stack != NULL) /* EOF inside .include */
643 (void)fclose(config_file);
644 config_file = config_file_stack->file;
645 config_filename = config_file_stack->filename;
646 config_lineno = config_file_stack->lineno;
647 config_file_stack = config_file_stack->next;
651 /* EOF at top level */
653 if (cstate_stack_ptr >= 0)
654 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
655 "Unexpected end of configuration file: .endif missing");
657 if (len != 0) break; /* EOF after continuation */
658 next_section[0] = 0; /* EOF at start of logical line */
663 newlen = len + Ustrlen(big_buffer + len);
665 /* Handle pathologically long physical lines - yes, it did happen - by
666 extending big_buffer at this point. The code also copes with very long
669 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
672 big_buffer_size += BIG_BUFFER_SIZE;
673 newbuffer = store_malloc(big_buffer_size);
675 /* This use of strcpy is OK because we know that the string in the old
676 buffer is shorter than the new buffer. */
678 Ustrcpy(newbuffer, big_buffer);
679 store_free(big_buffer);
680 big_buffer = newbuffer;
681 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
683 newlen += Ustrlen(big_buffer + newlen);
686 /* Find the true start of the physical line - leading spaces are always
689 ss = big_buffer + len;
690 while (isspace(*ss)) ss++;
692 /* Process the physical line for macros. If this is the start of the logical
693 line, skip over initial text at the start of the line if it starts with an
694 upper case character followed by a sequence of name characters and an equals
695 sign, because that is the definition of a new macro, and we don't do
696 replacement therein. */
699 if (len == 0 && isupper(*s))
701 while (isalnum(*s) || *s == '_') s++;
702 while (isspace(*s)) s++;
703 if (*s != '=') s = ss; /* Not a macro definition */
706 /* For each defined macro, scan the line (from after XXX= if present),
707 replacing all occurrences of the macro. */
710 for (m = macros; m != NULL; m = m->next)
715 while ((p = Ustrstr(t, m->name)) != NULL)
718 int namelen = Ustrlen(m->name);
719 int replen = Ustrlen(m->replacement);
721 /* Expand the buffer if necessary */
723 while (newlen - namelen + replen + 1 > big_buffer_size)
725 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
726 uschar *newbuffer = store_malloc(newsize);
727 memcpy(newbuffer, big_buffer, newlen + 1);
728 p = newbuffer + (p - big_buffer);
729 s = newbuffer + (s - big_buffer);
730 ss = newbuffer + (ss - big_buffer);
731 t = newbuffer + (t - big_buffer);
732 big_buffer_size = newsize;
733 store_free(big_buffer);
734 big_buffer = newbuffer;
737 /* Shuffle the remaining characters up or down in the buffer before
738 copying in the replacement text. Don't rescan the replacement for this
742 moveby = replen - namelen;
745 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
748 Ustrncpy(p, m->replacement, replen);
754 /* An empty macro replacement at the start of a line could mean that ss no
755 longer points to the first non-blank character. */
757 while (isspace(*ss)) ss++;
759 /* Check for comment lines - these are physical lines. */
761 if (*ss == '#') continue;
763 /* Handle conditionals, which are also applied to physical lines. Conditions
764 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
765 expansion occured on the rest of the line. A preliminary test for the leading
766 '.' saves effort on most lines. */
772 /* Search the list of conditional directives */
774 for (i = 0; i < cond_list_size; i++)
777 cond_item *c = cond_list+i;
778 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
780 /* The following character must be white space or end of string */
782 n = ss[1 + c->namelen];
783 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
785 /* .ifdef and .ifndef push the current state onto the stack, then set
786 a new one from the table. Stack overflow is an error */
790 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
791 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
792 ".%s nested too deeply", c->name);
793 cstate_stack[++cstate_stack_ptr] = cstate;
794 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
797 /* For any of the others, stack underflow is an error. The next state
798 comes either from the stack (.endif) or from the table. */
802 if (cstate_stack_ptr < 0)
803 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
804 ".%s without matching .ifdef", c->name);
805 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
806 next_cstate[cstate][macro_found? c->action1 : c->action2];
809 /* Having dealt with a directive, break the loop */
814 /* If we have handled a conditional directive, continue with the next
815 physical line. Otherwise, fall through. */
817 if (i < cond_list_size) continue;
820 /* If the conditional state is not 0 (actively using these lines), ignore
823 if (cstate != 0) continue; /* Conditional skip */
825 /* Handle .include lines - these are also physical lines. */
827 if (Ustrncmp(ss, ".include", 8) == 0 &&
829 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
832 int include_if_exists = isspace(ss[8])? 0 : 10;
833 config_file_item *save;
836 ss += 9 + include_if_exists;
837 while (isspace(*ss)) ss++;
838 t = ss + Ustrlen(ss);
839 while (t > ss && isspace(t[-1])) t--;
840 if (*ss == '\"' && t[-1] == '\"')
848 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
849 "absolute path \"%s\"", ss);
851 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
853 save = store_get(sizeof(config_file_item));
854 save->next = config_file_stack;
855 config_file_stack = save;
856 save->file = config_file;
857 save->filename = config_filename;
858 save->lineno = config_lineno;
860 config_file = Ufopen(ss, "rb");
861 if (config_file == NULL)
862 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
863 "configuration file %s", ss);
864 config_filename = string_copy(ss);
869 /* If this is the start of the logical line, remember where the non-blank
870 data starts. Otherwise shuffle down continuation lines to remove leading
874 startoffset = ss - big_buffer;
877 s = big_buffer + len;
880 memmove(s, ss, (newlen - len) - (ss - s) + 1);
885 /* Accept the new addition to the line. Remove trailing white space. */
888 while (len > 0 && isspace(big_buffer[len-1])) len--;
891 /* We are done if the line does not end in backslash and contains some data.
892 Empty logical lines are ignored. For continuations, remove the backslash and
893 go round the loop to read the continuation line. */
897 if (big_buffer[len-1] != '\\') break; /* End of logical line */
898 big_buffer[--len] = 0; /* Remove backslash */
900 } /* Loop for reading multiple physical lines */
902 /* We now have a logical line. Test for the end of a configuration section (or,
903 more accurately, for the start of the next section). Place the name of the next
904 section in next_section, and return NULL. If the name given is longer than
905 next_section, truncate it. It will be unrecognized later, because all the known
906 section names do fit. Leave space for pluralizing. */
908 s = big_buffer + startoffset; /* First non-space character */
909 if (strncmpic(s, US"begin ", 6) == 0)
912 while (isspace(*s)) s++;
913 if (big_buffer + len - s > sizeof(next_section) - 2)
914 s[sizeof(next_section) - 2] = 0;
915 Ustrcpy(next_section, s);
919 /* Return the first non-blank character. */
926 /*************************************************
928 *************************************************/
930 /* The yield is the pointer to the next uschar. Names longer than the
931 output space are silently truncated. This function is also used from acl.c when
935 name where to put the name
939 Returns: new input pointer
943 readconf_readname(uschar *name, int len, uschar *s)
946 while (isspace(*s)) s++;
949 while (isalnum(*s) || *s == '_')
951 if (p < len-1) name[p++] = *s;
956 while (isspace(*s)) s++;
963 /*************************************************
964 * Read a time value *
965 *************************************************/
967 /* This function is also called from outside, to read argument
968 time values. The format of a time value is:
970 [<n>w][<n>d][<n>h][<n>m][<n>s]
972 as long as at least one is present. If a format error is encountered,
973 return a negative value. The value must be terminated by the given
978 terminator required terminating character
979 return_msec if TRUE, allow fractional seconds and return milliseconds
981 Returns: the time value, or -1 on syntax error
982 value is seconds if return_msec is FALSE
983 value is milliseconds if return_msec is TRUE
987 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
995 if (!isdigit(*s)) return -1;
996 (void)sscanf(CS s, "%d%n", &value, &count);
1001 case 'w': value *= 7;
1002 case 'd': value *= 24;
1003 case 'h': value *= 60;
1004 case 'm': value *= 60;
1009 if (!return_msec) return -1;
1010 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1012 if (*s++ != 's') return -1;
1013 yield += (int)(fraction * 1000.0);
1019 if (return_msec) value *= 1000;
1021 if (*s == terminator) return yield;
1023 /* Control never reaches here. */
1028 /*************************************************
1029 * Read a fixed point value *
1030 *************************************************/
1032 /* The value is returned *1000
1036 terminator required terminator
1038 Returns: the value, or -1 on error
1042 readconf_readfixed(uschar *s, int terminator)
1046 if (!isdigit(*s)) return -1;
1047 (void)sscanf(CS s, "%d%n", &value, &count);
1049 yield = value * 1000;
1053 while (isdigit((*(++s))))
1055 yield += (*s - '0') * m;
1060 return (*s == terminator)? yield : (-1);
1065 /*************************************************
1066 * Find option in list *
1067 *************************************************/
1069 /* The lists are always in order, so binary chop can be used.
1072 name the option name to search for
1073 ol the first entry in the option list
1074 last one more than the offset of the last entry in the option list
1076 Returns: pointer to an option entry, or NULL if not found
1080 find_option(uschar *name, optionlist *ol, int last)
1083 while (last > first)
1085 int middle = (first + last)/2;
1086 int c = Ustrcmp(name, ol[middle].name);
1087 if (c == 0) return ol + middle;
1088 else if (c > 0) first = middle + 1;
1096 /*************************************************
1097 * Find a set flag in option list *
1098 *************************************************/
1100 /* Because some versions of Unix make no restrictions on the values of uids and
1101 gids (even negative ones), we cannot represent "unset" by a special value.
1102 There is therefore a separate boolean variable for each one indicating whether
1103 a value is set or not. This function returns a pointer to the boolean, given
1104 the original option name. It is a major disaster if the flag cannot be found.
1107 name the name of the uid or gid option
1108 oltop points to the start of the relevant option list
1109 last one more than the offset of the last item in the option list
1110 data_block NULL when reading main options => data values in the option
1111 list are absolute addresses; otherwise they are byte offsets
1112 in data_block (used for driver options)
1114 Returns: a pointer to the boolean flag.
1118 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1122 sprintf(CS name2, "*set_%.50s", name);
1123 ol = find_option(name2, oltop, last);
1124 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1125 "Exim internal error: missing set flag for %s", name);
1126 return (data_block == NULL)? (BOOL *)(ol->value) :
1127 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1133 /*************************************************
1134 * Output extra characters message and die *
1135 *************************************************/
1137 /* Called when an option line has junk on the end. Sometimes this is because
1138 the sysadmin thinks comments are permitted.
1141 s points to the extra characters
1142 t1..t3 strings to insert in the log message
1144 Returns: doesn't return; dies
1148 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1150 uschar *comment = US"";
1151 if (*s == '#') comment = US" (# is comment only at line start)";
1152 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1153 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1158 /*************************************************
1159 * Read rewrite information *
1160 *************************************************/
1162 /* Each line of rewrite information contains:
1164 . A complete address in the form user@domain, possibly with
1165 leading * for each part; or alternatively, a regex.
1167 . A replacement string (which will be expanded).
1169 . An optional sequence of one-letter flags, indicating which
1170 headers etc. to apply this rule to.
1172 All this is decoded and placed into a control block. The OR of the flags is
1173 maintained in a common word.
1176 p points to the string that makes up the rule
1177 existflags points to the overall flag word
1178 isglobal TRUE if reading global rewrite rules
1180 Returns: the control block for the parsed rule.
1183 static rewrite_rule *
1184 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1186 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1189 next->key = string_dequote(&p);
1191 while (isspace(*p)) p++;
1193 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1194 "missing rewrite replacement string");
1197 next->replacement = string_dequote(&p);
1199 while (*p != 0) switch (*p++)
1201 case ' ': case '\t': break;
1203 case 'q': next->flags |= rewrite_quit; break;
1204 case 'w': next->flags |= rewrite_whole; break;
1206 case 'h': next->flags |= rewrite_all_headers; break;
1207 case 's': next->flags |= rewrite_sender; break;
1208 case 'f': next->flags |= rewrite_from; break;
1209 case 't': next->flags |= rewrite_to; break;
1210 case 'c': next->flags |= rewrite_cc; break;
1211 case 'b': next->flags |= rewrite_bcc; break;
1212 case 'r': next->flags |= rewrite_replyto; break;
1214 case 'E': next->flags |= rewrite_all_envelope; break;
1215 case 'F': next->flags |= rewrite_envfrom; break;
1216 case 'T': next->flags |= rewrite_envto; break;
1218 case 'Q': next->flags |= rewrite_qualify; break;
1219 case 'R': next->flags |= rewrite_repeat; break;
1222 next->flags |= rewrite_smtp;
1223 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1224 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1225 "rewrite rule has the S flag but is not a regular expression");
1229 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1230 "unknown rewrite flag character '%c' "
1231 "(could be missing quotes round replacement item)", p[-1]);
1235 /* If no action flags are set, set all the "normal" rewrites. */
1237 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1238 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1240 /* Remember which exist, for optimization, and return the rule */
1242 *existflags |= next->flags;
1249 /*************************************************
1250 * Read global rewrite information *
1251 *************************************************/
1253 /* Each line is a single rewrite rule; it is parsed into a control block
1254 by readconf_one_rewrite(), and its flags are ORed into the global flag
1255 word rewrite_existflags. */
1258 readconf_rewrites(void)
1260 rewrite_rule **chain = &global_rewrite_rules;
1263 while ((p = get_config_line()) != NULL)
1265 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1267 chain = &(next->next);
1273 /*************************************************
1275 *************************************************/
1277 /* Strings are read into the normal store pool. As long we aren't too
1278 near the end of the current block, the string will just use what is necessary
1279 on the top of the stacking pool, because string_cat() uses the extension
1283 s the rest of the input line
1284 name the option name (for errors)
1286 Returns: pointer to the string
1290 read_string(uschar *s, uschar *name)
1295 if (*s != '\"') return string_copy(s);
1298 yield = string_dequote(&s);
1300 if (s == ss+1 || s[-1] != '\"')
1301 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1302 "missing quote at end of string value for %s", name);
1304 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1310 /*************************************************
1311 * Handle option line *
1312 *************************************************/
1314 /* This function is called from several places to process a line containing the
1315 setting of an option. The first argument is the line to be decoded; it has been
1316 checked not to be empty and not to start with '#'. Trailing newlines and white
1317 space have been removed. The second argument is a pointer to the list of
1318 variable names that are to be recognized, together with their types and
1319 locations, and the third argument gives the number of entries in the list.
1321 The fourth argument is a pointer to a data block. If it is NULL, then the data
1322 values in the options list are absolute addresses. Otherwise, they are byte
1323 offsets in the data block.
1325 String option data may continue onto several lines; this function reads further
1326 data from config_file if necessary.
1328 The yield of this function is normally zero. If a string continues onto
1329 multiple lines, then the data value is permitted to be followed by a comma
1330 or a semicolon (for use in drivers) and the yield is that character.
1333 buffer contains the configuration line to be handled
1334 oltop points to the start of the relevant option list
1335 last one more than the offset of the last item in the option list
1336 data_block NULL when reading main options => data values in the option
1337 list are absolute addresses; otherwise they are byte offsets
1338 in data_block when they have opt_public set; otherwise
1339 they are byte offsets in data_block->options_block.
1340 unknown_txt format string to use in panic message for unknown option;
1341 must contain %s for option name
1342 if given as NULL, don't panic on unknown option
1344 Returns: TRUE if an option was read successfully,
1345 FALSE false for an unknown option if unknown_txt == NULL,
1346 otherwise panic and die on an unknown option
1350 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1351 void *data_block, uschar *unknown_txt)
1355 int n, count, type, value;
1359 BOOL boolvalue = TRUE;
1360 BOOL freesptr = TRUE;
1361 optionlist *ol, *ol2;
1365 uschar *inttype = US"";
1371 /* There may be leading spaces; thereafter, we expect an option name starting
1374 while (isspace(*s)) s++;
1376 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1378 /* Read the name of the option, and skip any subsequent white space. If
1379 it turns out that what we read was "hide", set the flag indicating that
1380 this is a secure option, and loop to read the next word. */
1382 for (n = 0; n < 2; n++)
1384 while (isalnum(*s) || *s == '_')
1386 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1390 while (isspace(*s)) s++;
1391 if (Ustrcmp(name, "hide") != 0) break;
1392 issecure = opt_secure;
1396 /* Deal with "no_" or "not_" here for booleans */
1398 if (Ustrncmp(name, "no_", 3) == 0)
1404 if (Ustrncmp(name, "not_", 4) == 0)
1410 /* Search the list for the given name. A non-existent name, or an option that
1411 is set twice, is a disaster. */
1413 ol = find_option(name + offset, oltop, last);
1417 if (unknown_txt == NULL) return FALSE;
1418 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1421 if ((ol->type & opt_set) != 0)
1423 uschar *mname = name;
1424 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1425 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1426 "\"%s\" option set for the second time", mname);
1429 ol->type |= opt_set | issecure;
1430 type = ol->type & opt_mask;
1432 /* Types with data values must be followed by '='; the "no[t]_" prefix
1433 applies only to boolean values. */
1435 if (type < opt_bool || type > opt_bool_last)
1438 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1439 "negation prefix applied to a non-boolean option");
1441 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1442 "unexpected end of line (data missing) after %s", name);
1444 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1447 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1448 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1449 ultimately expands to one of those values. */
1451 else if (*s != 0 && (offset != 0 || *s != '='))
1452 extra_chars_error(s, US"boolean option ", name, US"");
1454 /* Skip white space after = */
1456 if (*s == '=') while (isspace((*(++s))));
1458 /* If there is a data block and the opt_public flag is not set, change
1459 the data block pointer to the private options block. */
1461 if (data_block != NULL && (ol->type & opt_public) == 0)
1462 data_block = (void *)(((driver_instance *)data_block)->options_block);
1464 /* Now get the data according to the type. */
1468 /* If a string value is not enclosed in quotes, it consists of
1469 the rest of the current line, verbatim. Otherwise, string escapes
1472 A transport is specified as a string, which is then looked up in the
1473 list of transports. A search type is specified as one of a number of
1476 A set or rewrite rules for a driver is specified as a string, which is
1477 then parsed into a suitable chain of control blocks.
1479 Uids and gids are specified as strings which are then looked up in the
1480 passwd file. Lists of uids and gids are similarly specified as colon-
1481 separated strings. */
1486 case opt_expand_uid:
1487 case opt_expand_gid:
1492 reset_point = sptr = read_string(s, name);
1494 /* Having read a string, we now have several different ways of using it,
1495 depending on the data type, so do another switch. If keeping the actual
1496 string is not required (because it is interpreted), freesptr is set TRUE,
1497 and at the end we reset the pool. */
1501 /* If this was a string, set the variable to point to the new string,
1502 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1503 rules, we still keep the string (for printing), and parse the rules into a
1504 control block and flags word. */
1508 if (data_block == NULL)
1509 *((uschar **)(ol->value)) = sptr;
1511 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1513 if (type == opt_rewrite)
1518 rewrite_rule **chain;
1521 sprintf(CS name2, "*%.50s_rules", name);
1522 ol2 = find_option(name2, oltop, last);
1523 sprintf(CS name2, "*%.50s_flags", name);
1524 ol3 = find_option(name2, oltop, last);
1526 if (ol2 == NULL || ol3 == NULL)
1527 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1528 "rewrite rules not available for driver");
1530 if (data_block == NULL)
1532 chain = (rewrite_rule **)(ol2->value);
1533 flagptr = (int *)(ol3->value);
1537 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1538 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1541 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1544 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1546 chain = &(next->next);
1549 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1550 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1551 "non-header rewrite - not allowed at transport time -");
1555 /* If it was an expanded uid, see if there is any expansion to be
1556 done by checking for the presence of a $ character. If there is, save it
1557 in the corresponding *expand_user option field. Otherwise, fall through
1558 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1561 case opt_expand_uid:
1562 sprintf(CS name2, "*expand_%.50s", name);
1563 ol2 = find_option(name2, oltop, last);
1566 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1568 if (data_block == NULL)
1569 *((uschar **)(ol2->value)) = ss;
1571 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1575 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1581 /* Look up a fixed uid, and also make use of the corresponding gid
1582 if a passwd entry is returned and the gid has not been set. */
1585 if (!route_finduser(sptr, &pw, &uid))
1586 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1587 if (data_block == NULL)
1588 *((uid_t *)(ol->value)) = uid;
1590 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1592 /* Set the flag indicating a fixed value is set */
1594 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1596 /* Handle matching gid if we have a passwd entry: done by finding the
1597 same name with terminating "user" changed to "group"; if not found,
1598 ignore. Also ignore if the value is already set. */
1600 if (pw == NULL) break;
1601 Ustrcpy(name+Ustrlen(name)-4, "group");
1602 ol2 = find_option(name, oltop, last);
1603 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1604 (ol2->type & opt_mask) == opt_expand_gid))
1606 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1609 if (data_block == NULL)
1610 *((gid_t *)(ol2->value)) = pw->pw_gid;
1612 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1618 /* If it was an expanded gid, see if there is any expansion to be
1619 done by checking for the presence of a $ character. If there is, save it
1620 in the corresponding *expand_user option field. Otherwise, fall through
1621 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1624 case opt_expand_gid:
1625 sprintf(CS name2, "*expand_%.50s", name);
1626 ol2 = find_option(name2, oltop, last);
1629 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1631 if (data_block == NULL)
1632 *((uschar **)(ol2->value)) = ss;
1634 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1638 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1644 /* Handle freestanding gid */
1647 if (!route_findgroup(sptr, &gid))
1648 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1649 if (data_block == NULL)
1650 *((gid_t *)(ol->value)) = gid;
1652 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1653 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1656 /* If it was a uid list, look up each individual entry, and build
1657 a vector of uids, with a count in the first element. Put the vector
1658 in malloc store so we can free the string. (We are reading into
1659 permanent store already.) */
1667 uschar *op = expand_string (sptr);
1670 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1671 name, expand_string_message);
1674 if (*p != 0) count++;
1675 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1676 list = store_malloc(count*sizeof(uid_t));
1677 list[ptr++] = (uid_t)(count - 1);
1679 if (data_block == NULL)
1680 *((uid_t **)(ol->value)) = list;
1682 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1688 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1689 if (!route_finduser(big_buffer, NULL, &uid))
1690 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1697 /* If it was a gid list, look up each individual entry, and build
1698 a vector of gids, with a count in the first element. Put the vector
1699 in malloc store so we can free the string. (We are reading into permanent
1708 uschar *op = expand_string (sptr);
1711 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1712 name, expand_string_message);
1715 if (*p != 0) count++;
1716 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1717 list = store_malloc(count*sizeof(gid_t));
1718 list[ptr++] = (gid_t)(count - 1);
1720 if (data_block == NULL)
1721 *((gid_t **)(ol->value)) = list;
1723 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1729 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1730 if (!route_findgroup(big_buffer, &gid))
1731 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1739 /* Release store if the value of the string doesn't need to be kept. */
1741 if (freesptr) store_reset(reset_point);
1744 /* Expanded boolean: if no characters follow, or if there are no dollar
1745 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1746 save the string for later expansion in the alternate place. */
1748 case opt_expand_bool:
1749 if (*s != 0 && Ustrchr(s, '$') != 0)
1751 sprintf(CS name2, "*expand_%.50s", name);
1752 ol2 = find_option(name2, oltop, last);
1755 reset_point = sptr = read_string(s, name);
1756 if (data_block == NULL)
1757 *((uschar **)(ol2->value)) = sptr;
1759 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1766 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1767 look for yes/not/true/false. Some booleans are stored in a single bit in
1768 a single int. There's a special fudge for verify settings; without a suffix
1769 they set both xx_sender and xx_recipient. The table points to the sender
1770 value; search subsequently for the recipient. There's another special case:
1771 opt_bool_set also notes when a boolean has been set. */
1775 case opt_bool_verify:
1779 s = readconf_readname(name2, 64, s);
1780 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1782 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1784 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1785 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1786 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1787 US"for boolean option ", name);
1790 /* Handle single-bit type. */
1792 if (type == opt_bit)
1794 int bit = 1 << ((ol->type >> 16) & 31);
1795 int *ptr = (data_block == NULL)?
1796 (int *)(ol->value) :
1797 (int *)((uschar *)data_block + (long int)ol->value);
1798 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1802 /* Handle full BOOL types */
1804 if (data_block == NULL)
1805 *((BOOL *)(ol->value)) = boolvalue;
1807 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1811 if (type == opt_bool_verify)
1813 sprintf(CS name2, "%.50s_recipient", name + offset);
1814 ol2 = find_option(name2, oltop, last);
1817 if (data_block == NULL)
1818 *((BOOL *)(ol2->value)) = boolvalue;
1820 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1824 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1826 else if (type == opt_bool_set)
1828 sprintf(CS name2, "*set_%.50s", name + offset);
1829 ol2 = find_option(name2, oltop, last);
1832 if (data_block == NULL)
1833 *((BOOL *)(ol2->value)) = TRUE;
1835 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1844 inttype = US"octal ";
1846 /* Integer: a simple(ish) case; allow octal and hex formats, and
1847 suffixes K and M. The different types affect output, not input. */
1856 lvalue = strtol(CS s, CSS &endptr, intbase);
1859 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1862 if (errno != ERANGE)
1864 if (tolower(*endptr) == 'k')
1866 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1867 else lvalue *= 1024;
1870 else if (tolower(*endptr) == 'm')
1872 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1874 else lvalue *= 1024*1024;
1879 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1880 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1881 "absolute value of integer \"%s\" is too large (overflow)", s);
1883 while (isspace(*endptr)) endptr++;
1885 extra_chars_error(endptr, inttype, US"integer value for ", name);
1887 value = (int)lvalue;
1890 if (data_block == NULL)
1891 *((int *)(ol->value)) = value;
1893 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1896 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1903 value = strtol(CS s, CSS &endptr, intbase);
1906 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1909 if (errno != ERANGE)
1911 if (tolower(*endptr) == 'm')
1913 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1917 else if (tolower(*endptr) == 'k')
1923 value = (value + 512)/1024;
1927 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1928 "absolute value of integer \"%s\" is too large (overflow)", s);
1930 while (isspace(*endptr)) endptr++;
1932 extra_chars_error(endptr, inttype, US"integer value for ", name);
1935 if (data_block == NULL)
1936 *((int *)(ol->value)) = value;
1938 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1941 /* Fixed-point number: held to 3 decimal places. */
1944 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1945 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1946 "fixed-point number expected for %s", name);
1948 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1949 "integer \"%s\" is too large (overflow)", s);
1953 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1954 "integer \"%s\" is too large (overflow)", s);
1956 if (s[count] == '.')
1959 while (isdigit(s[++count]))
1961 value += (s[count] - '0') * d;
1966 while (isspace(s[count])) count++;
1969 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1971 if (data_block == NULL)
1972 *((int *)(ol->value)) = value;
1974 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1977 /* There's a special routine to read time values. */
1980 value = readconf_readtime(s, 0, FALSE);
1982 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1984 if (data_block == NULL)
1985 *((int *)(ol->value)) = value;
1987 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1990 /* A time list is a list of colon-separated times, with the first
1991 element holding the size of the list and the second the number of
1997 int *list = (data_block == NULL)?
1998 (int *)(ol->value) :
1999 (int *)((uschar *)data_block + (long int)(ol->value));
2001 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2004 uschar *snext = Ustrchr(s, ':');
2008 while (ss > s && isspace(ss[-1])) ss--;
2011 value = readconf_readtime(s, terminator, FALSE);
2013 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2015 if (count > 1 && value <= list[count])
2016 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2017 "time value out of order for %s", name);
2018 list[count+1] = value;
2019 if (snext == NULL) break;
2021 while (isspace(*s)) s++;
2024 if (count > list[0] - 2)
2025 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2027 if (count > 0 && list[2] == 0) count = 0;
2039 /*************************************************
2040 * Print a time value *
2041 *************************************************/
2044 Argument: a time value in seconds
2045 Returns: pointer to a fixed buffer containing the time as a string,
2046 in readconf_readtime() format
2050 readconf_printtime(int t)
2053 uschar *p = time_buffer;
2070 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2071 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2072 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2073 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2074 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2081 /*************************************************
2082 * Print an individual option value *
2083 *************************************************/
2085 /* This is used by the -bP option, so prints to the standard output.
2086 The entire options list is passed in as an argument, because some options come
2087 in pairs - typically uid/gid settings, which can either be explicit numerical
2088 values, or strings to be expanded later. If the numerical value is unset,
2089 search for "*expand_<name>" to see if there is a string equivalent.
2092 ol option entry, or NULL for an unknown option
2094 options_block NULL for main configuration options; otherwise points to
2095 a driver block; if the option doesn't have opt_public
2096 set, then options_block->options_block is where the item
2098 oltop points to the option list in which ol exists
2099 last one more than the offset of the last entry in optop
2105 print_ol(optionlist *ol, uschar *name, void *options_block,
2106 optionlist *oltop, int last)
2119 printf("%s is not a known option\n", name);
2123 /* Non-admin callers cannot see options that have been flagged secure by the
2126 if (!admin_user && (ol->type & opt_secure) != 0)
2128 printf("%s = <value not displayable>\n", name);
2132 /* Else show the value of the option */
2135 if (options_block != NULL)
2137 if ((ol->type & opt_public) == 0)
2138 options_block = (void *)(((driver_instance *)options_block)->options_block);
2139 value = (void *)((uschar *)options_block + (long int)value);
2142 switch(ol->type & opt_mask)
2145 case opt_rewrite: /* Show the text value */
2146 s = *((uschar **)value);
2147 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2151 printf("%s = %d\n", name, *((int *)value));
2156 int x = *((int *)value);
2157 if (x != 0 && (x & 1023) == 0)
2161 if ((x & 1023) == 0)
2166 printf("%s = %d%c\n", name, x, c);
2168 else printf("%s = %d\n", name, x);
2174 int x = *((int *)value);
2175 if (x == 0) printf("%s = 0\n", name);
2176 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2177 else printf("%s = %dK\n", name, x);
2182 printf("%s = %#o\n", name, *((int *)value));
2185 /* Can be negative only when "unset", in which case integer */
2189 int x = *((int *)value);
2192 if (x < 0) printf("%s =\n", name); else
2194 printf("%s = %d.", name, x/1000);
2207 /* If the numerical value is unset, try for the string value */
2209 case opt_expand_uid:
2210 if (! *get_set_flag(name, oltop, last, options_block))
2212 sprintf(CS name2, "*expand_%.50s", name);
2213 ol2 = find_option(name2, oltop, last);
2216 void *value2 = ol2->value;
2217 if (options_block != NULL)
2218 value2 = (void *)((uschar *)options_block + (long int)value2);
2219 s = *((uschar **)value2);
2220 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2225 /* Else fall through */
2228 if (! *get_set_flag(name, oltop, last, options_block))
2229 printf("%s =\n", name);
2232 pw = getpwuid(*((uid_t *)value));
2234 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2235 else printf("%s = %s\n", name, pw->pw_name);
2239 /* If the numerical value is unset, try for the string value */
2241 case opt_expand_gid:
2242 if (! *get_set_flag(name, oltop, last, options_block))
2244 sprintf(CS name2, "*expand_%.50s", name);
2245 ol2 = find_option(name2, oltop, last);
2246 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2248 void *value2 = ol2->value;
2249 if (options_block != NULL)
2250 value2 = (void *)((uschar *)options_block + (long int)value2);
2251 s = *((uschar **)value2);
2252 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2257 /* Else fall through */
2260 if (! *get_set_flag(name, oltop, last, options_block))
2261 printf("%s =\n", name);
2264 gr = getgrgid(*((int *)value));
2266 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2267 else printf("%s = %s\n", name, gr->gr_name);
2272 uidlist = *((uid_t **)value);
2273 printf("%s =", name);
2274 if (uidlist != NULL)
2278 for (i = 1; i <= (int)(uidlist[0]); i++)
2280 uschar *name = NULL;
2281 pw = getpwuid(uidlist[i]);
2282 if (pw != NULL) name = US pw->pw_name;
2283 if (name != NULL) printf("%c%s", sep, name);
2284 else printf("%c%ld", sep, (long int)(uidlist[i]));
2292 gidlist = *((gid_t **)value);
2293 printf("%s =", name);
2294 if (gidlist != NULL)
2298 for (i = 1; i <= (int)(gidlist[0]); i++)
2300 uschar *name = NULL;
2301 gr = getgrgid(gidlist[i]);
2302 if (gr != NULL) name = US gr->gr_name;
2303 if (name != NULL) printf("%c%s", sep, name);
2304 else printf("%c%ld", sep, (long int)(gidlist[i]));
2312 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2318 int *list = (int *)value;
2319 printf("%s = ", name);
2320 for (i = 0; i < list[1]; i++)
2321 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2327 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2331 case opt_expand_bool:
2332 sprintf(CS name2, "*expand_%.50s", name);
2333 ol2 = find_option(name2, oltop, last);
2334 if (ol2 != NULL && ol2->value != NULL)
2336 void *value2 = ol2->value;
2337 if (options_block != NULL)
2338 value2 = (void *)((uschar *)options_block + (long int)value2);
2339 s = *((uschar **)value2);
2342 printf("%s = %s\n", name, string_printing(s));
2345 /* s == NULL => string not set; fall through */
2351 case opt_bool_verify:
2353 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2360 /*************************************************
2361 * Print value from main configuration *
2362 *************************************************/
2364 /* This function, called as a result of encountering the -bP option,
2365 causes the value of any main configuration variable to be output if the
2366 second argument is NULL. There are some special values:
2368 all print all main configuration options
2369 configure_file print the name of the configuration file
2370 routers print the routers' configurations
2371 transports print the transports' configuration
2372 authenticators print the authenticators' configuration
2373 macros print the macros' configuration
2374 router_list print a list of router names
2375 transport_list print a list of transport names
2376 authenticator_list print a list of authentication mechanism names
2377 macro_list print a list of macro names
2378 +name print a named list item
2379 local_scan print the local_scan options
2381 If the second argument is not NULL, it must be one of "router", "transport",
2382 "authenticator" or "macro" in which case the first argument identifies the
2383 driver whose options are to be printed.
2386 name option name if type == NULL; else driver name
2387 type NULL or driver type name, as described above
2393 readconf_print(uschar *name, uschar *type)
2395 BOOL names_only = FALSE;
2397 optionlist *ol2 = NULL;
2398 driver_instance *d = NULL;
2409 static uschar *types[] = { US"address", US"domain", US"host",
2411 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2412 &hostlist_anchor, &localpartlist_anchor };
2414 for (i = 0; i < 4; i++)
2416 t = tree_search(*(anchors[i]), name+1);
2420 printf("%slist %s = %s\n", types[i], name+1,
2421 ((namedlist_block *)(t->data.ptr))->string);
2426 printf("no address, domain, host, or local part list called \"%s\" "
2427 "exists\n", name+1);
2432 if (Ustrcmp(name, "configure_file") == 0)
2434 printf("%s\n", CS config_main_filename);
2438 if (Ustrcmp(name, "all") == 0)
2440 for (ol = optionlist_config;
2441 ol < optionlist_config + optionlist_config_size; ol++)
2443 if ((ol->type & opt_hidden) == 0)
2444 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2449 if (Ustrcmp(name, "local_scan") == 0)
2451 #ifndef LOCAL_SCAN_HAS_OPTIONS
2452 printf("local_scan() options are not supported\n");
2454 for (ol = local_scan_options;
2455 ol < local_scan_options + local_scan_options_count; ol++)
2457 print_ol(ol, US ol->name, NULL, local_scan_options,
2458 local_scan_options_count);
2464 if (Ustrcmp(name, "routers") == 0)
2469 else if (Ustrcmp(name, "transports") == 0)
2471 type = US"transport";
2475 else if (Ustrcmp(name, "authenticators") == 0)
2477 type = US"authenticator";
2481 else if (Ustrcmp(name, "macros") == 0)
2487 else if (Ustrcmp(name, "router_list") == 0)
2494 else if (Ustrcmp(name, "transport_list") == 0)
2496 type = US"transport";
2501 else if (Ustrcmp(name, "authenticator_list") == 0)
2503 type = US"authenticator";
2508 else if (Ustrcmp(name, "macro_list") == 0)
2517 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2518 name, NULL, optionlist_config, optionlist_config_size);
2523 /* Handle the options for a router or transport. Skip options that are flagged
2524 as hidden. Some of these are options with names starting with '*', used for
2525 internal alternative representations of other options (which the printing
2526 function will sort out). Others are synonyms kept for backward compatibility.
2529 if (Ustrcmp(type, "router") == 0)
2531 d = (driver_instance *)routers;
2532 ol2 = optionlist_routers;
2533 size = optionlist_routers_size;
2535 else if (Ustrcmp(type, "transport") == 0)
2537 d = (driver_instance *)transports;
2538 ol2 = optionlist_transports;
2539 size = optionlist_transports_size;
2541 else if (Ustrcmp(type, "authenticator") == 0)
2543 d = (driver_instance *)auths;
2544 ol2 = optionlist_auths;
2545 size = optionlist_auths_size;
2548 else if (Ustrcmp(type, "macro") == 0)
2550 /* People store passwords in macros and they were previously not available
2551 for printing. So we have an admin_users restriction. */
2554 fprintf(stderr, "exim: permission denied\n");
2557 for (m = macros; m != NULL; m = m->next)
2559 if (name == NULL || Ustrcmp(name, m->name) == 0)
2562 printf("%s\n", CS m->name);
2564 printf("%s=%s\n", CS m->name, CS m->replacement);
2570 printf("%s %s not found\n", type, name);
2576 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2580 /* Either search for a given driver, or print all of them */
2582 for (; d != NULL; d = d->next)
2585 printf("\n%s %s:\n", d->name, type);
2586 else if (Ustrcmp(d->name, name) != 0) continue;
2588 for (ol = ol2; ol < ol2 + size; ol++)
2590 if ((ol->type & opt_hidden) == 0)
2591 print_ol(ol, US ol->name, d, ol2, size);
2594 for (ol = d->info->options;
2595 ol < d->info->options + *(d->info->options_count); ol++)
2597 if ((ol->type & opt_hidden) == 0)
2598 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2600 if (name != NULL) return;
2602 if (name != NULL) printf("%s %s not found\n", type, name);
2607 /*************************************************
2608 * Read a named list item *
2609 *************************************************/
2611 /* This function reads a name and a list (i.e. string). The name is used to
2612 save the list in a tree, sorted by its name. Each entry also has a number,
2613 which can be used for caching tests, but if the string contains any expansion
2614 items other than $key, the number is set negative to inhibit caching. This
2615 mechanism is used for domain, host, and address lists that are referenced by
2619 anchorp points to the tree anchor
2620 numberp points to the current number for this tree
2621 max the maximum number permitted
2622 s the text of the option line, starting immediately after the name
2624 tname the name of the list type, for messages
2630 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2633 BOOL forcecache = FALSE;
2636 namedlist_block *nb = store_get(sizeof(namedlist_block));
2638 if (Ustrncmp(s, "_cache", 6) == 0)
2645 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2647 if (*numberp >= max)
2648 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2651 while (isspace(*s)) s++;
2653 while (isalnum(*s) || *s == '_') s++;
2654 t = store_get(sizeof(tree_node) + s-ss);
2655 Ustrncpy(t->name, ss, s-ss);
2657 while (isspace(*s)) s++;
2659 if (!tree_insertnode(anchorp, t))
2660 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2661 "duplicate name \"%s\" for a named %s", t->name, tname);
2664 nb->number = *numberp;
2667 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2668 "missing '=' after \"%s\"", t->name);
2669 while (isspace(*s)) s++;
2670 nb->string = read_string(s, t->name);
2671 nb->cache_data = NULL;
2673 /* Check the string for any expansions; if any are found, mark this list
2674 uncacheable unless the user has explicited forced caching. */
2676 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2682 /*************************************************
2683 * Unpick data for a rate limit *
2684 *************************************************/
2686 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2690 s string, in the form t,b,f,l
2691 where t is the threshold (integer)
2692 b is the initial delay (time)
2693 f is the multiplicative factor (fixed point)
2694 k is the maximum time (time)
2695 threshold where to store threshold
2696 base where to store base in milliseconds
2697 factor where to store factor in milliseconds
2698 limit where to store limit
2700 Returns: nothing (panics on error)
2704 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2707 uschar bstring[16], lstring[16];
2709 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2710 factor, lstring) == 4)
2712 *base = readconf_readtime(bstring, 0, TRUE);
2713 *limit = readconf_readtime(lstring, 0, TRUE);
2714 if (*base >= 0 && *limit >= 0) return;
2716 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2722 /*************************************************
2723 * Read main configuration options *
2724 *************************************************/
2726 /* This function is the first to be called for configuration reading. It
2727 opens the configuration file and reads general configuration settings until
2728 it reaches the end of the configuration section. The file is then left open so
2729 that the remaining configuration data can subsequently be read if needed for
2732 The configuration file must be owned either by root or exim, and be writeable
2733 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2734 in the config file, so the test is done on the compiled in values. A slight
2735 anomaly, to be carefully documented.
2737 The name of the configuration file is taken from a list that is included in the
2738 binary of Exim. It can be altered from the command line, but if that is done,
2739 root privilege is immediately withdrawn unless the caller is root or exim.
2740 The first file on the list that exists is used.
2742 For use on multiple systems that share file systems, first look for a
2743 configuration file whose name has the current node name on the end. If that is
2744 not found, try the generic name. For really contorted configurations, that run
2745 multiple Exims with different uid settings, first try adding the effective uid
2746 before the node name. These complications are going to waste resources on most
2747 systems. Therefore they are available only when requested by compile-time
2755 struct stat statbuf;
2756 uschar *s, *filename;
2757 uschar *list = config_main_filelist;
2759 /* Loop through the possible file names */
2761 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2764 /* Cut out all the fancy processing unless specifically wanted */
2766 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2767 uschar *suffix = filename + Ustrlen(filename);
2769 /* Try for the node-specific file if a node name exists */
2771 #ifdef CONFIGURE_FILE_USE_NODE
2773 if (uname(&uts) >= 0)
2775 #ifdef CONFIGURE_FILE_USE_EUID
2776 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2777 config_file = Ufopen(filename, "rb");
2778 if (config_file == NULL)
2779 #endif /* CONFIGURE_FILE_USE_EUID */
2781 sprintf(CS suffix, ".%.256s", uts.nodename);
2782 config_file = Ufopen(filename, "rb");
2785 #endif /* CONFIGURE_FILE_USE_NODE */
2787 /* Otherwise, try the generic name, possibly with the euid added */
2789 #ifdef CONFIGURE_FILE_USE_EUID
2790 if (config_file == NULL)
2792 sprintf(CS suffix, ".%ld", (long int)original_euid);
2793 config_file = Ufopen(filename, "rb");
2795 #endif /* CONFIGURE_FILE_USE_EUID */
2797 /* Finally, try the unadorned name */
2799 if (config_file == NULL)
2802 config_file = Ufopen(filename, "rb");
2804 #else /* if neither defined */
2806 /* This is the common case when the fancy processing is not included. */
2808 config_file = Ufopen(filename, "rb");
2811 /* If the file does not exist, continue to try any others. For any other
2812 error, break out (and die). */
2814 if (config_file != NULL || errno != ENOENT) break;
2817 /* On success, save the name for verification; config_filename is used when
2818 logging configuration errors (it changes for .included files) whereas
2819 config_main_filename is the name shown by -bP. Failure to open a configuration
2820 file is a serious disaster. */
2822 if (config_file != NULL)
2824 config_filename = config_main_filename = string_copy(filename);
2828 if (filename == NULL)
2829 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2830 "%s", config_main_filelist);
2832 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2833 "configuration file %s", filename));
2836 /* Check the status of the file we have opened, unless it was specified on
2837 the command line, in which case privilege was given away at the start. */
2839 if (!config_changed)
2841 if (fstat(fileno(config_file), &statbuf) != 0)
2842 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2845 if ((statbuf.st_uid != root_uid && /* owner not root */
2846 statbuf.st_uid != exim_uid /* owner not exim */
2847 #ifdef CONFIGURE_OWNER
2848 && statbuf.st_uid != config_uid /* owner not the special one */
2851 (statbuf.st_gid != exim_gid /* group not exim & */
2852 #ifdef CONFIGURE_GROUP
2853 && statbuf.st_gid != config_gid /* group not the special one */
2855 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2857 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2859 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2860 "wrong owner, group, or mode", big_buffer);
2863 /* Process the main configuration settings. They all begin with a lower case
2864 letter. If we see something starting with an upper case letter, it is taken as
2865 a macro definition. */
2867 while ((s = get_config_line()) != NULL)
2869 if (isupper(s[0])) read_macro_assignment(s);
2871 else if (Ustrncmp(s, "domainlist", 10) == 0)
2872 read_named_list(&domainlist_anchor, &domainlist_count,
2873 MAX_NAMED_LIST, s+10, US"domain list");
2875 else if (Ustrncmp(s, "hostlist", 8) == 0)
2876 read_named_list(&hostlist_anchor, &hostlist_count,
2877 MAX_NAMED_LIST, s+8, US"host list");
2879 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2880 read_named_list(&addresslist_anchor, &addresslist_count,
2881 MAX_NAMED_LIST, s+11, US"address list");
2883 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2884 read_named_list(&localpartlist_anchor, &localpartlist_count,
2885 MAX_NAMED_LIST, s+13, US"local part list");
2888 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2889 NULL, US"main option \"%s\" unknown");
2893 /* If local_sender_retain is set, local_from_check must be unset. */
2895 if (local_sender_retain && local_from_check)
2896 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2897 "local_sender_retain are set; this combination is not allowed");
2899 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2902 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2904 /* The max retry interval must not be greater than 24 hours. */
2906 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2908 /* remote_max_parallel must be > 0 */
2910 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2912 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2913 start of a new SMTP message. */
2915 freeze_tell_config = freeze_tell;
2917 /* The primary host name may be required for expansion of spool_directory
2918 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2919 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2920 canonize it. Some people like upper case letters in their host names, so we
2921 don't force the case. */
2923 if (primary_hostname == NULL)
2927 if (uname(&uts) < 0)
2928 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2929 hostname = US uts.nodename;
2931 if (Ustrchr(hostname, '.') == NULL)
2934 struct hostent *hostdata;
2937 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2938 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2948 #if HAVE_GETIPNODEBYNAME
2950 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2952 hostdata = gethostbyname2(CS hostname, af);
2955 hostdata = gethostbyname(CS hostname);
2958 if (hostdata != NULL)
2960 hostname = US hostdata->h_name;
2964 if (af == AF_INET) break;
2969 primary_hostname = string_copy(hostname);
2972 /* Set up default value for smtp_active_hostname */
2974 smtp_active_hostname = primary_hostname;
2976 /* If spool_directory wasn't set in the build-time configuration, it must have
2977 got set above. Of course, writing to the log may not work if log_file_path is
2978 not set, but it will at least get to syslog or somewhere, with any luck. */
2980 if (*spool_directory == 0)
2981 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2984 /* Expand the spool directory name; it may, for example, contain the primary
2985 host name. Same comment about failure. */
2987 s = expand_string(spool_directory);
2989 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2990 "\"%s\": %s", spool_directory, expand_string_message);
2991 spool_directory = s;
2993 /* Expand log_file_path, which must contain "%s" in any component that isn't
2994 the null string or "syslog". It is also allowed to contain one instance of %D.
2995 However, it must NOT contain % followed by anything else. */
2997 if (*log_file_path != 0)
3000 int sep = ':'; /* Fixed for log file path */
3001 s = expand_string(log_file_path);
3003 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3004 "\"%s\": %s", log_file_path, expand_string_message);
3007 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3010 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3011 t = Ustrstr(sss, "%s");
3013 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3014 "contain \"%%s\"", sss);
3016 t = Ustrchr(sss, '%');
3019 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
3020 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3021 "unexpected \"%%\" character", s);
3028 /* Interpret syslog_facility into an integer argument for 'ident' param to
3029 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3032 if (syslog_facility_str != NULL)
3035 uschar *s = syslog_facility_str;
3037 if ((Ustrlen(syslog_facility_str) >= 4) &&
3038 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3041 for (i = 0; i < syslog_list_size; i++)
3043 if (strcmpic(s, syslog_list[i].name) == 0)
3045 syslog_facility = syslog_list[i].value;
3050 if (i >= syslog_list_size)
3052 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3053 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3057 /* Expand pid_file_path */
3059 if (*pid_file_path != 0)
3061 s = expand_string(pid_file_path);
3063 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3064 "\"%s\": %s", pid_file_path, expand_string_message);
3068 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3071 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3073 /* Unpick the SMTP rate limiting options, if set */
3075 if (smtp_ratelimit_mail != NULL)
3077 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3078 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3081 if (smtp_ratelimit_rcpt != NULL)
3083 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3084 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3087 /* The qualify domains default to the primary host name */
3089 if (qualify_domain_sender == NULL)
3090 qualify_domain_sender = primary_hostname;
3091 if (qualify_domain_recipient == NULL)
3092 qualify_domain_recipient = qualify_domain_sender;
3094 /* Setting system_filter_user in the configuration sets the gid as well if a
3095 name is given, but a numerical value does not. */
3097 if (system_filter_uid_set && !system_filter_gid_set)
3099 struct passwd *pw = getpwuid(system_filter_uid);
3101 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3102 (long int)system_filter_uid);
3103 system_filter_gid = pw->pw_gid;
3104 system_filter_gid_set = TRUE;
3107 /* If the errors_reply_to field is set, check that it is syntactically valid
3108 and ensure it contains a domain. */
3110 if (errors_reply_to != NULL)
3113 int start, end, domain;
3114 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3115 &start, &end, &domain, FALSE);
3117 if (recipient == NULL)
3118 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3119 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3122 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3123 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3126 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3127 smtp_accept_max must also be set. */
3129 if (smtp_accept_max == 0 &&
3130 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3131 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3132 "smtp_accept_max must be set if smtp_accept_queue or "
3133 "smtp_accept_max_per_host is set");
3135 /* Set up the host number if anything is specified. It is an expanded string
3136 so that it can be computed from the host name, for example. We do this last
3137 so as to ensure that everything else is set up before the expansion. */
3139 if (host_number_string != NULL)
3142 uschar *s = expand_string(host_number_string);
3143 long int n = Ustrtol(s, &end, 0);
3144 while (isspace(*end)) end++;
3146 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3147 "localhost_number value is not a number: %s", s);
3148 if (n > LOCALHOST_MAX)
3149 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3150 "localhost_number is greater than the maximum allowed value (%d)",
3156 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3158 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3159 tls_verify_certificates == NULL)
3160 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3161 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3162 (tls_verify_hosts != NULL)? "" : "try_");
3164 /* If openssl_options is set, validate it */
3165 if (openssl_options != NULL)
3168 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3169 "openssl_options is set but we're using GnuTLS\n");
3172 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3173 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3174 "openssl_options parse error: %s\n", openssl_options);
3182 /*************************************************
3183 * Initialize one driver *
3184 *************************************************/
3186 /* This is called once the driver's generic options, if any, have been read.
3187 We can now find the driver, set up defaults for the private options, and
3188 unset any "set" bits in the private options table (which might have been
3189 set by another incarnation of the same driver).
3192 d pointer to driver instance block, with generic
3194 drivers_available vector of available drivers
3195 size_of_info size of each block in drivers_available
3196 class class of driver, for error message
3198 Returns: pointer to the driver info block
3201 static driver_info *
3202 init_driver(driver_instance *d, driver_info *drivers_available,
3203 int size_of_info, uschar *class)
3207 for (dd = drivers_available; dd->driver_name[0] != 0;
3208 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3210 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3213 int len = dd->options_len;
3215 d->options_block = store_get(len);
3216 memcpy(d->options_block, dd->options_block, len);
3217 for (i = 0; i < *(dd->options_count); i++)
3218 dd->options[i].type &= ~opt_set;
3223 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3224 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3226 return NULL; /* never obeyed */
3232 /*************************************************
3233 * Initialize driver list *
3234 *************************************************/
3236 /* This function is called for routers, transports, and authentication
3237 mechanisms. It reads the data from the current point in the configuration file
3238 up to the end of the section, and sets up a chain of instance blocks according
3239 to the file's contents. The file will already have been opened by a call to
3240 readconf_main, and must be left open for subsequent reading of further data.
3242 Any errors cause a panic crash. Note that the blocks with names driver_info and
3243 driver_instance must map the first portions of all the _info and _instance
3244 blocks for this shared code to work.
3247 class "router", "transport", or "authenticator"
3248 anchor &routers, &transports, &auths
3249 drivers_available available drivers
3250 size_of_info size of each info block
3251 instance_default points to default data for an instance
3252 instance_size size of instance block
3253 driver_optionlist generic option list
3254 driver_optionlist_count count of generic option list
3260 readconf_driver_init(
3262 driver_instance **anchor,
3263 driver_info *drivers_available,
3265 void *instance_default,
3267 optionlist *driver_optionlist,
3268 int driver_optionlist_count)
3270 driver_instance **p = anchor;
3271 driver_instance *d = NULL;
3274 while ((buffer = get_config_line()) != NULL)
3279 /* Read the first name on the line and test for the start of a new driver. A
3280 macro definition indicates the end of the previous driver. If this isn't the
3281 start of a new driver, the line will be re-read. */
3283 s = readconf_readname(name, sizeof(name), buffer);
3285 /* Handle macro definition, first finishing off the initialization of the
3286 previous driver, if any. */
3288 if (isupper(*name) && *s == '=')
3292 if (d->driver_name == NULL)
3293 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3294 "no driver defined for %s \"%s\"", class, d->name);
3298 read_macro_assignment(buffer);
3302 /* If the line starts with a name terminated by a colon, we are at the
3303 start of the definition of a new driver. The rest of the line must be
3310 /* Finish off initializing the previous driver. */
3314 if (d->driver_name == NULL)
3315 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3316 "no driver defined for %s \"%s\"", class, d->name);
3320 /* Check that we haven't already got a driver of this name */
3322 for (d = *anchor; d != NULL; d = d->next)
3323 if (Ustrcmp(name, d->name) == 0)
3324 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3325 "there are two %ss called \"%s\"", class, name);
3327 /* Set up a new driver instance data block on the chain, with
3328 its default values installed. */
3330 d = store_get(instance_size);
3331 memcpy(d, instance_default, instance_size);
3334 d->name = string_copy(name);
3336 /* Clear out the "set" bits in the generic options */
3338 for (i = 0; i < driver_optionlist_count; i++)
3339 driver_optionlist[i].type &= ~opt_set;
3341 /* Check nothing more on this line, then do the next loop iteration. */
3343 while (isspace(*s)) s++;
3344 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3348 /* Not the start of a new driver. Give an error if we have not set up a
3349 current driver yet. */
3351 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3352 "%s name missing", class);
3354 /* First look to see if this is a generic option; if it is "driver",
3355 initialize the driver. If is it not a generic option, we can look for a
3356 private option provided that the driver has been previously set up. */
3358 if (readconf_handle_option(buffer, driver_optionlist,
3359 driver_optionlist_count, d, NULL))
3361 if (d->info == NULL && d->driver_name != NULL)
3362 init_driver(d, drivers_available, size_of_info, class);
3365 /* Handle private options - pass the generic block because some may
3366 live therein. A flag with each option indicates if it is in the public
3369 else if (d->info != NULL)
3371 readconf_handle_option(buffer, d->info->options,
3372 *(d->info->options_count), d, US"option \"%s\" unknown");
3375 /* The option is not generic and the driver name has not yet been given. */
3377 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3378 "(\"driver\" must be specified before any private options)", name);
3381 /* Run the initialization function for the final driver. */
3385 if (d->driver_name == NULL)
3386 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3387 "no driver defined for %s \"%s\"", class, d->name);
3394 /*************************************************
3395 * Check driver dependency *
3396 *************************************************/
3398 /* This function is passed a driver instance and a string. It checks whether
3399 any of the string options for the driver contains the given string as an
3403 d points to a driver instance block
3404 s the string to search for
3406 Returns: TRUE if a dependency is found
3410 readconf_depends(driver_instance *d, uschar *s)
3412 int count = *(d->info->options_count);
3416 for (ol = d->info->options; ol < d->info->options + count; ol++)
3418 void *options_block;
3420 int type = ol->type & opt_mask;
3421 if (type != opt_stringptr) continue;
3422 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3423 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3424 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3426 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3427 isalnum(ss[Ustrlen(s)])) continue;
3428 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3429 d->name, ol->name, s);
3434 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3441 /*************************************************
3442 * Decode an error type for retries *
3443 *************************************************/
3445 /* This function is global because it is also called from the main
3446 program when testing retry information. It decodes strings such as "quota_7d"
3447 into numerical error codes.
3450 pp points to start of text
3451 p points past end of text
3452 basic_errno points to an int to receive the main error number
3453 more_errno points to an int to receive the secondary error data
3455 Returns: NULL if decoded correctly; else points to error text
3459 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3463 while (q < p && *q != '_') q++;
3466 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3468 *basic_errno = ERRNO_EXIMQUOTA;
3469 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3470 return US"bad time value";
3473 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3475 *basic_errno = ECONNREFUSED;
3478 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3479 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3480 else return US"A or MX expected after \"refused\"";
3484 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3486 *basic_errno = ETIMEDOUT;
3490 int xlen = p - q - 1;
3493 static uschar *extras[] =
3494 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3495 static int values[] =
3496 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3498 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3500 if (strncmpic(x, extras[i], xlen) == 0)
3502 *more_errno = values[i];
3507 if (i >= sizeof(extras)/sizeof(uschar *))
3509 if (strncmpic(x, US"DNS", xlen) == 0)
3511 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3512 "available in retry rules (it has never worked) - treated as "
3515 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3520 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3521 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3522 strncmpic(pp, US"data_4", 6) == 0)
3525 int x = 255; /* means "any 4xx code" */
3526 if (p != pp + 8) bad = TRUE; else
3528 int a = pp[6], b = pp[7];
3532 if (isdigit(b)) x += b - '0';
3533 else if (b == 'x') x += 100;
3536 else if (a != 'x' || b != 'x') bad = TRUE;
3540 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3541 "x is literal and d is any digit", pp);
3543 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3544 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3545 *more_errno = x << 8;
3548 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3549 strncmpic(q+1, US"failed", p-q-1) == 0)
3550 *basic_errno = ERRNO_AUTHFAIL;
3552 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3553 *basic_errno = ERRNO_SMTPCLOSED;
3555 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3556 *basic_errno = ERRNO_TLSREQUIRED;
3558 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3559 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3567 /*************************************************
3568 * Read retry information *
3569 *************************************************/
3571 /* Each line of retry information contains:
3573 . A domain name pattern or an address pattern;
3575 . An error name, possibly with additional data, or *;
3577 . An optional sequence of retry items, each consisting of an identifying
3578 letter, a cutoff time, and optional parameters.
3580 All this is decoded and placed into a control block. */
3583 /* Subroutine to read an argument, preceded by a comma and terminated
3584 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3585 1 = fixed point number (returned *1000).
3588 paddr pointer to pointer to current character; updated
3589 type 0 => read a time; 1 => read a fixed point number
3591 Returns: time in seconds or fixed point number * 1000
3595 retry_arg(uschar **paddr, int type)
3600 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3602 while (isspace(*p)) p++;
3604 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3606 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3607 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3613 return readconf_readtime(pp, *p, FALSE);
3615 return readconf_readfixed(pp, *p);
3617 return 0; /* Keep picky compilers happy */
3620 /* The function proper */
3623 readconf_retries(void)
3625 retry_config **chain = &retries;
3629 while ((p = get_config_line()) != NULL)
3631 retry_rule **rchain;
3634 next = store_get(sizeof(retry_config));
3637 chain = &(next->next);
3638 next->basic_errno = next->more_errno = 0;
3639 next->senders = NULL;
3641 rchain = &(next->rules);
3643 next->pattern = string_dequote(&p);
3644 while (isspace(*p)) p++;
3646 while (mac_isgraph(*p)) p++;
3647 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3648 "missing error type");
3650 /* Test error names for things we understand. */
3652 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3653 &(next->more_errno))) != NULL)
3654 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3656 /* There may be an optional address list of senders to be used as another
3657 constraint on the rule. This was added later, so the syntax is a bit of a
3658 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3661 while (isspace(*p)) p++;
3662 if (Ustrncmp(p, "senders", 7) == 0)
3665 while (isspace(*p)) p++;
3666 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3667 "\"=\" expected after \"senders\" in retry rule");
3668 while (isspace(*p)) p++;
3669 next->senders = string_dequote(&p);
3672 /* Now the retry rules. Keep the maximum timeout encountered. */
3674 while (isspace(*p)) p++;
3678 retry_rule *rule = store_get(sizeof(retry_rule));
3680 rchain = &(rule->next);
3682 rule->rule = toupper(*p++);
3683 rule->timeout = retry_arg(&p, 0);
3684 if (rule->timeout > retry_maximum_timeout)
3685 retry_maximum_timeout = rule->timeout;
3689 case 'F': /* Fixed interval */
3690 rule->p1 = retry_arg(&p, 0);
3693 case 'G': /* Geometrically increasing intervals */
3694 case 'H': /* Ditto, but with randomness */
3695 rule->p1 = retry_arg(&p, 0);
3696 rule->p2 = retry_arg(&p, 1);
3700 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3704 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3705 (rule->rule != 'F' && rule->p2 < 1000))
3706 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3707 "bad parameters for retry rule");
3709 while (isspace(*p)) p++;
3713 while (isspace(*p)) p++;
3716 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3723 /*************************************************
3724 * Initialize authenticators *
3725 *************************************************/
3727 /* Read the authenticators section of the configuration file.
3736 auth_instance *au, *bu;
3737 readconf_driver_init(US"authenticator",
3738 (driver_instance **)(&auths), /* chain anchor */
3739 (driver_info *)auths_available, /* available drivers */
3740 sizeof(auth_info), /* size of info block */
3741 &auth_defaults, /* default values for generic options */
3742 sizeof(auth_instance), /* size of instance block */
3743 optionlist_auths, /* generic options */
3744 optionlist_auths_size);
3746 for (au = auths; au != NULL; au = au->next)
3748 if (au->public_name == NULL)
3749 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3750 "the %s authenticator", au->name);
3751 for (bu = au->next; bu != NULL; bu = bu->next)
3753 if (strcmpic(au->public_name, bu->public_name) == 0)
3755 if ((au->client && bu->client) || (au->server && bu->server))
3756 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3757 "(%s and %s) have the same public name (%s)",
3758 (au->client)? US"client" : US"server", au->name, bu->name,
3768 /*************************************************
3769 * Read ACL information *
3770 *************************************************/
3772 /* If this run of Exim is not doing something that involves receiving a
3773 message, we can just skip over the ACL information. No need to parse it.
3775 First, we have a function for acl_read() to call back to get the next line. We
3776 need to remember the line we passed, because at the end it will contain the
3777 name of the next ACL. */
3779 static uschar *acl_line;
3784 acl_line = get_config_line();
3789 /* Now the main function:
3792 skip TRUE when this Exim process is doing something that will
3793 not need the ACL data
3799 readconf_acl(BOOL skip)
3803 /* Not receiving messages, don't need to parse the ACL data */
3807 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3808 while ((p = get_config_line()) != NULL);
3812 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3815 acl_line = get_config_line();
3817 while(acl_line != NULL)
3823 p = readconf_readname(name, sizeof(name), acl_line);
3824 if (isupper(*name) && *p == '=')
3826 read_macro_assignment(acl_line);
3827 acl_line = get_config_line();
3831 if (*p != ':' || name[0] == 0)
3832 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3834 node = store_get(sizeof(tree_node) + Ustrlen(name));
3835 Ustrcpy(node->name, name);
3836 if (!tree_insertnode(&acl_anchor, node))
3837 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3838 "there are two ACLs called \"%s\"", name);
3840 node->data.ptr = acl_read(acl_callback, &error);
3842 if (node->data.ptr == NULL && error != NULL)
3843 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3849 /*************************************************
3850 * Read configuration for local_scan() *
3851 *************************************************/
3853 /* This function is called after "begin local_scan" is encountered in the
3854 configuration file. If the local_scan() function allows for configuration
3855 options, we can process them. Otherwise, we expire in a panic.
3862 local_scan_init(void)
3864 #ifndef LOCAL_SCAN_HAS_OPTIONS
3865 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3866 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3870 while ((p = get_config_line()) != NULL)
3872 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3873 NULL, US"local_scan option \"%s\" unknown");
3880 /*************************************************
3881 * Read rest of configuration (after main) *
3882 *************************************************/
3884 /* This function reads the rest of the runtime configuration, after the main
3885 configuration. It is called only when actually needed. Each subsequent section
3886 of the configuration starts with a line of the form
3890 where the name is "routers", "transports", etc. A section is terminated by
3891 hitting the next "begin" line, and the next name is left in next_section.
3892 Because it may confuse people as to whether the names are singular or plural,
3893 we add "s" if it's missing. There is always enough room in next_section for
3894 this. This function is basically just a switch.
3897 skip_acl TRUE if ACL information is not needed
3902 static uschar *section_list[] = {
3912 readconf_rest(BOOL skip_acl)
3916 while(next_section[0] != 0)
3920 int last = sizeof(section_list) / sizeof(uschar *);
3922 int n = Ustrlen(next_section);
3924 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3928 int c = strcmpic(next_section, section_list[mid]);
3930 if (c > 0) first = mid + 1; else last = mid;
3932 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3933 "\"%.*s\" is not a known configuration section name", n, next_section);
3934 mid = (last + first)/2;
3938 if (((had ^= bit) & bit) == 0)
3939 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3940 "\"%.*s\" section is repeated in the configuration file", n,
3945 case 0: readconf_acl(skip_acl); break;
3946 case 1: auths_init(); break;
3947 case 2: local_scan_init(); break;
3948 case 3: readconf_retries(); break;
3949 case 4: readconf_rewrites(); break;
3950 case 5: route_init(); break;
3951 case 6: transport_init(); break;
3955 (void)fclose(config_file);
3958 /* End of readconf.c */