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