1e8083673803621d37fff303c4873d28b5466dd2
[exim.git] / src / src / functions.h
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
8
9
10 /* Prototypes for functions that appear in various modules. Gathered together
11 to avoid having a lot of tiddly little headers with only a couple of lines in
12 them. However, some functions that are used (or not used) by utility programs
13 are in in fact in separate headers. */
14 #ifndef _FUNCTIONS_H_
15 #define _FUNCTIONS_H_
16
17 #include <ctype.h>
18 #include <sys/time.h>
19
20
21 #ifdef EXIM_PERL
22 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
23                  uschar **) WARN_UNUSED_RESULT;
24 extern void    cleanup_perl(void);
25 extern uschar *init_perl(uschar *);
26 #endif
27
28
29 #ifndef DISABLE_TLS
30 extern const char *
31                std_dh_prime_default(void);
32 extern const char *
33                std_dh_prime_named(const uschar *);
34
35 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
36 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
37 extern uschar * tls_cert_issuer(void *, uschar * mod);
38 extern uschar * tls_cert_not_before(void *, uschar * mod);
39 extern uschar * tls_cert_not_after(void *, uschar * mod);
40 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
41 extern uschar * tls_cert_serial_number(void *, uschar * mod);
42 extern uschar * tls_cert_signature(void *, uschar * mod);
43 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
44 extern uschar * tls_cert_subject(void *, uschar * mod);
45 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
46 extern uschar * tls_cert_version(void *, uschar * mod);
47
48 extern uschar * tls_cert_der_b64(void * cert);
49 extern uschar * tls_cert_fprt_md5(void *);
50 extern uschar * tls_cert_fprt_sha1(void *);
51 extern uschar * tls_cert_fprt_sha256(void *);
52
53 extern void    tls_clean_env(void);
54 extern BOOL    tls_client_start(client_conn_ctx *, smtp_connect_args *,
55                   void *, tls_support *, uschar **);
56
57 extern void    tls_close(void *, int);
58 extern BOOL    tls_could_read(void);
59 extern void    tls_daemon_init(void);
60 extern BOOL    tls_dropprivs_validate_require_cipher(BOOL);
61 extern BOOL    tls_export_cert(uschar *, size_t, void *);
62 extern int     tls_feof(void);
63 extern int     tls_ferror(void);
64 extern void    tls_free_cert(void **);
65 extern int     tls_getc(unsigned);
66 extern uschar *tls_getbuf(unsigned *);
67 extern void    tls_get_cache(void);
68 extern BOOL    tls_import_cert(const uschar *, void **);
69 extern int     tls_read(void *, uschar *, size_t);
70 extern int     tls_server_start(const uschar *, uschar **);
71 extern BOOL    tls_smtp_buffered(void);
72 extern int     tls_ungetc(int);
73 extern int     tls_write(void *, const uschar *, size_t, BOOL);
74 extern uschar *tls_validate_require_cipher(void);
75 extern void    tls_version_report(FILE *);
76 # ifdef USE_OPENSSL
77 extern BOOL    tls_openssl_options_parse(uschar *, long *);
78 # endif
79 extern uschar * tls_field_from_dn(uschar *, const uschar *);
80 extern BOOL    tls_is_name_for_cert(const uschar *, void *);
81
82 # ifdef SUPPORT_DANE
83 extern int     tlsa_lookup(const host_item *, dns_answer *, BOOL);
84 # endif
85
86 #endif  /*DISABLE_TLS*/
87
88
89 /* Everything else... */
90
91 extern acl_block *acl_read(uschar *(*)(void), uschar **);
92 extern int     acl_check(int, uschar *, uschar *, uschar **, uschar **);
93 extern int     acl_eval(int, uschar *, uschar **, uschar **);
94
95 extern tree_node *acl_var_create(uschar *);
96 extern void    acl_var_write(uschar *, uschar *, void *);
97
98 #ifdef EXPERIMENTAL_ARC
99 extern void   *arc_ams_setup_sign_bodyhash(void);
100 extern const uschar *arc_header_feed(gstring *, BOOL);
101 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
102 extern void     arc_sign_init(void);
103 extern const uschar *acl_verify_arc(void);
104 extern uschar * fn_arc_domains(void);
105 #endif
106
107 extern void    assert_no_variables(void *, int, const char *, int);
108 extern int     auth_call_pam(const uschar *, uschar **);
109 extern int     auth_call_pwcheck(uschar *, uschar **);
110 extern int     auth_call_radius(const uschar *, uschar **);
111 extern int     auth_call_saslauthd(const uschar *, const uschar *,
112                  const uschar *, const uschar *, uschar **);
113 extern int     auth_check_serv_cond(auth_instance *);
114 extern int     auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
115 extern int     auth_client_item(void *, auth_instance *, const uschar **,
116                  unsigned, int, uschar *, int);
117
118
119 extern int     auth_get_data(uschar **, const uschar *, int);
120 extern int     auth_get_no64_data(uschar **, uschar *);
121 extern int     auth_prompt(const uschar *);
122 extern int     auth_read_input(const uschar *);
123 extern gstring * auth_show_supported(gstring *);
124 extern uschar *auth_xtextencode(uschar *, int);
125 extern int     auth_xtextdecode(uschar *, uschar **);
126
127 #ifdef EXPERIMENTAL_ARC
128 extern gstring *authres_arc(gstring *);
129 #endif
130 #ifndef DISABLE_DKIM
131 extern gstring *authres_dkim(gstring *);
132 #endif
133 #ifdef SUPPORT_DMARC
134 extern gstring *authres_dmarc(gstring *);
135 #endif
136 extern gstring *authres_smtpauth(gstring *);
137 #ifdef SUPPORT_SPF
138 extern gstring *authres_spf(gstring *);
139 #endif
140
141 extern uschar *b64encode(const uschar *, int);
142 extern uschar *b64encode_taint(const uschar *, int, BOOL);
143 extern int     b64decode(const uschar *, uschar **);
144 extern int     bdat_getc(unsigned);
145 extern uschar *bdat_getbuf(unsigned *);
146 extern int     bdat_ungetc(int);
147 extern void    bdat_flush_data(void);
148
149 extern void    bits_clear(unsigned int *, size_t, int *);
150 extern void    bits_set(unsigned int *, size_t, int *);
151
152 extern void    cancel_cutthrough_connection(BOOL, const uschar *);
153 extern gstring *cat_file(FILE *, gstring *, uschar *);
154 extern gstring *cat_file_tls(void *, gstring *, uschar *);
155 extern int     check_host(void *, const uschar *, const uschar **, uschar **);
156 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
157 extern pid_t   child_open_exim_function(int *, const uschar *);
158 extern pid_t   child_open_exim2_function(int *, uschar *, uschar *,
159                  const uschar *);
160 extern pid_t   child_open_function(uschar **, uschar **, int,
161                  int *, int *, BOOL, const uschar *);
162 extern pid_t   child_open_uid(const uschar **, const uschar **, int,
163                  uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *);
164 extern BOOL    cleanup_environment(void);
165 extern void    cutthrough_data_puts(uschar *, int);
166 extern void    cutthrough_data_put_nl(void);
167 extern uschar *cutthrough_finaldot(void);
168 extern BOOL    cutthrough_flush_send(void);
169 extern BOOL    cutthrough_headers_send(void);
170 extern BOOL    cutthrough_predata(void);
171 extern void    release_cutthrough_connection(const uschar *);
172
173 extern void    daemon_go(void);
174
175 #ifdef EXPERIMENTAL_DCC
176 extern int     dcc_process(uschar **);
177 #endif
178
179 extern void    debug_logging_activate(uschar *, uschar *);
180 extern void    debug_logging_stop(void);
181 extern void    debug_print_argv(const uschar **);
182 extern void    debug_print_ids(uschar *);
183 extern void    debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
184 extern void    debug_print_string(uschar *);
185 extern void    debug_print_tree(tree_node *);
186 extern void    debug_vprintf(int, const char *, va_list);
187 extern void    debug_print_socket(int);
188
189 extern void    decode_bits(unsigned int *, size_t, int *,
190                    uschar *, bit_table *, int, uschar *, int);
191 extern void    delete_pid_file(void);
192 extern address_item *deliver_make_addr(uschar *, BOOL);
193 extern void    delivery_log(int, address_item *, int, uschar *);
194 extern int     deliver_message(uschar *, BOOL, BOOL);
195 extern void    deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
196 extern void    deliver_set_expansions(address_item *);
197 extern int     deliver_split_address(address_item *);
198 extern void    deliver_succeeded(address_item *);
199
200 extern uschar *deliver_get_sender_address (uschar *id);
201 extern void    delivery_re_exec(int);
202
203 extern void    die_tainted(const uschar *, const uschar *, int);
204 extern BOOL    directory_make(const uschar *, const uschar *, int, BOOL);
205 #ifndef DISABLE_DKIM
206 extern uschar *dkim_exim_query_dns_txt(const uschar *);
207 extern void    dkim_exim_sign_init(void);
208
209 extern BOOL    dkim_transport_write_message(transport_ctx *,
210                   struct ob_dkim *, const uschar ** errstr);
211 #endif
212 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
213 extern int     dns_basic_lookup(dns_answer *, const uschar *, int);
214 extern uschar *dns_build_reverse(const uschar *);
215 extern time_t  dns_expire_from_soa(dns_answer *, int);
216 extern void    dns_init(BOOL, BOOL, BOOL);
217 extern BOOL    dns_is_aa(const dns_answer *);
218 extern BOOL    dns_is_secure(const dns_answer *);
219 extern int     dns_lookup(dns_answer *, const uschar *, int, const uschar **);
220 extern void    dns_pattern_init(void);
221 extern int     dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
222 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
223 extern uschar *dns_text_type(int);
224 extern void    dscp_list_to_stream(FILE *);
225 extern BOOL    dscp_lookup(const uschar *, int, int *, int *, int *);
226
227 extern void    enq_end(uschar *);
228 extern BOOL    enq_start(uschar *, unsigned);
229 #ifndef DISABLE_EVENT
230 extern uschar *event_raise(uschar *, const uschar *, uschar *);
231 extern void    msg_event_raise(const uschar *, const address_item *);
232 #endif
233
234 extern int     exim_chown_failure(int, const uschar*, uid_t, gid_t);
235 extern const uschar * exim_errstr(int);
236 extern void    exim_exit(int) NORETURN;
237 extern void    exim_gettime(struct timeval *);
238 extern void    exim_nullstd(void);
239 extern void    exim_setugid(uid_t, gid_t, BOOL, uschar *);
240 extern void    exim_underbar_exit(int) NORETURN;
241 extern void    exim_wait_tick(struct timeval *, int);
242 extern int     exp_bool(address_item *addr,
243   uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
244   uschar *svalue, BOOL *rvalue);
245 extern BOOL    expand_check_condition(uschar *, uschar *, uschar *);
246 extern uschar *expand_file_big_buffer(const uschar *);
247 extern uschar *expand_string(uschar *); /* public, cannot make const */
248 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
249 extern uschar *expand_getkeyed(const uschar *, const uschar *);
250
251 extern uschar *expand_hide_passwords(uschar * );
252 extern uschar *expand_string_copy(const uschar *);
253 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
254 extern void    modify_variable(uschar *, void *);
255
256 extern BOOL    fd_ready(int, time_t);
257
258 extern int     filter_interpret(uschar *, int, address_item **, uschar **);
259 extern BOOL    filter_personal(string_item *, BOOL);
260 extern BOOL    filter_runtest(int, uschar *, BOOL, BOOL);
261 extern BOOL    filter_system_interpret(address_item **, uschar **);
262
263 extern uschar * fn_hdrs_added(void);
264
265 extern void    header_add(int, const char *, ...);
266 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
267 extern int     header_checkname(header_line *, BOOL);
268 extern BOOL    header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
269 extern int     host_address_extract_port(uschar *);
270 extern uschar *host_and_ident(BOOL);
271 extern int     host_aton(const uschar *, int *);
272 extern void    host_build_hostlist(host_item **, const uschar *, BOOL);
273 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
274 extern void    host_build_log_info(void);
275 extern void    host_build_sender_fullhost(void);
276 extern int     host_find_byname(host_item *, const uschar *, int,
277                                 const uschar **, BOOL);
278 extern int     host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
279                  uschar *, const dnssec_domains *, const uschar **, BOOL *);
280 extern ip_address_item *host_find_interfaces(void);
281 extern BOOL    host_is_in_net(const uschar *, const uschar *, int);
282 extern BOOL    host_is_tls_on_connect_port(int);
283 extern int     host_item_get_port(host_item *);
284 extern void    host_mask(int, int *, int);
285 extern int     host_name_lookup(void);
286 extern int     host_nmtoa(int, int *, int, uschar *, int);
287 extern uschar *host_ntoa(int, const void *, uschar *, int *);
288 extern int     host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
289
290 extern uschar *imap_utf7_encode(uschar *, const uschar *,
291                                  uschar, uschar *, uschar **);
292
293 extern void    invert_address(uschar *, uschar *);
294 extern int     ip_addr(void *, int, const uschar *, int);
295 extern int     ip_bind(int, int, uschar *, int);
296 extern int     ip_connect(int, int, const uschar *, int, int, const blob *);
297 extern int     ip_connectedsocket(int, const uschar *, int, int,
298                  int, host_item *, uschar **, const blob *);
299 extern int     ip_get_address_family(int);
300 extern void    ip_keepalive(int, const uschar *, BOOL);
301 extern int     ip_recv(client_conn_ctx *, uschar *, int, time_t);
302 extern int     ip_socket(int, int);
303
304 extern int     ip_tcpsocket(const uschar *, uschar **, int, host_item *);
305 extern int     ip_unixsocket(const uschar *, uschar **);
306 extern int     ip_streamsocket(const uschar *, uschar **, int, host_item *);
307
308 extern int     ipv6_nmtoa(int *, uschar *);
309
310 extern uschar *local_part_quote(uschar *);
311 extern int     log_create(uschar *);
312 extern int     log_create_as_exim(uschar *);
313 extern void    log_close_all(void);
314
315 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
316 extern BOOL    macro_read_assignment(uschar *);
317 extern uschar *macros_expand(int, int *, BOOL *);
318 extern void    mainlog_close(void);
319 #ifdef WITH_CONTENT_SCAN
320 extern int     malware(const uschar *, int);
321 extern int     malware_in_file(uschar *);
322 extern void    malware_init(void);
323 extern gstring * malware_show_supported(gstring *);
324 #endif
325 extern int     match_address_list(const uschar *, BOOL, BOOL, const uschar **,
326                  unsigned int *, int, int, const uschar **);
327 extern int     match_address_list_basic(const uschar *, const uschar **, int);
328 extern int     match_check_list(const uschar **, int, tree_node **, unsigned int **,
329                  int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
330                  const uschar *, const uschar **);
331 extern int     match_isinlist(const uschar *, const uschar **, int, tree_node **,
332                  unsigned int *, int, BOOL, const uschar **);
333 extern int     match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
334                  const uschar **);
335 extern void    md5_end(md5 *, const uschar *, int, uschar *);
336 extern void    md5_mid(md5 *, const uschar *);
337 extern void    md5_start(md5 *);
338 extern void    millisleep(int);
339 #ifdef WITH_CONTENT_SCAN
340 struct mime_boundary_context;
341 extern int     mime_acl_check(uschar *acl, FILE *f,
342                  struct mime_boundary_context *, uschar **, uschar **);
343 extern int     mime_decode(const uschar **);
344 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
345 extern int     mime_regex(const uschar **);
346 extern void    mime_set_anomaly(int);
347 #endif
348 extern uschar *moan_check_errorcopy(uschar *);
349 extern BOOL    moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
350                  BOOL, uschar *);
351 extern void    moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
352 extern BOOL    moan_send_message(uschar *, int, error_block *eblock,
353                  header_line *, FILE *, uschar *);
354 extern void    moan_tell_someone(uschar *, address_item *,
355                  const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
356 extern BOOL    moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
357 extern void    moan_write_from(FILE *);
358 extern void    moan_write_references(FILE *, uschar *);
359 extern FILE   *modefopen(const uschar *, const char *, mode_t);
360
361 extern int     open_cutthrough_connection( address_item * addr );
362
363 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
364                  BOOL);
365 extern int     parse_forward_list(uschar *, int, address_item **, uschar **,
366                  const uschar *, uschar *, error_block **);
367 extern uschar *parse_find_address_end(uschar *, BOOL);
368 extern uschar *parse_find_at(uschar *);
369 extern const uschar *parse_fix_phrase(const uschar *, int);
370 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
371 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, BOOL);
372 extern uschar *parse_date_time(uschar *str, time_t *t);
373 extern int     vaguely_random_number(int);
374 #ifndef DISABLE_TLS
375 extern int     vaguely_random_number_fallback(int);
376 #endif
377
378 extern BOOL    queue_action(uschar *, int, uschar **, int, int);
379 extern void    queue_check_only(void);
380 extern unsigned queue_count(void);
381 extern unsigned queue_count_cached(void);
382 extern void    queue_list(int, uschar **, int);
383 #ifdef EXPERIMENTAL_QUEUE_RAMP
384 extern void    queue_notify_daemon(const uschar * hostname);
385 #endif
386 extern void    queue_run(uschar *, uschar *, BOOL);
387
388 extern int     random_number(int);
389 extern const uschar *rc_to_string(int);
390 extern int     rda_interpret(redirect_block *, int, uschar *, uschar *,
391                  uschar *, uschar *, uschar *, ugid_block *, address_item **,
392                  uschar **, error_block **, int *, uschar *);
393 extern int     rda_is_filter(const uschar *);
394 extern BOOL    readconf_depends(driver_instance *, uschar *);
395 extern void    readconf_driver_init(uschar *, driver_instance **,
396                  driver_info *, int, void *, int, optionlist *, int);
397 extern uschar *readconf_find_option(void *);
398 extern void    readconf_main(BOOL);
399 extern void    readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
400 extern BOOL    readconf_print(uschar *, uschar *, BOOL);
401 extern uschar *readconf_printtime(int);
402 extern uschar *readconf_readname(uschar *, int, uschar *);
403 extern int     readconf_readtime(const uschar *, int, BOOL);
404 extern void    readconf_rest(void);
405 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
406 extern void    readconf_save_config(const uschar *);
407 extern void    read_message_body(BOOL);
408 extern void    receive_bomb_out(uschar *, uschar *) NORETURN;
409 extern BOOL    receive_check_fs(int);
410 extern BOOL    receive_check_set_sender(uschar *);
411 extern BOOL    receive_msg(BOOL);
412 extern int_eximarith_t receive_statvfs(BOOL, int *);
413 extern void    receive_swallow_smtp(void);
414 #ifdef WITH_CONTENT_SCAN
415 extern int     regex(const uschar **);
416 #endif
417 extern BOOL    regex_match_and_setup(const pcre *, const uschar *, int, int);
418 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
419 extern void    retry_add_item(address_item *, uschar *, int);
420 extern BOOL    retry_check_address(const uschar *, host_item *, uschar *, BOOL,
421                  uschar **, uschar **);
422 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
423 extern BOOL    retry_ultimate_address_timeout(uschar *, const uschar *,
424                  dbdata_retry *, time_t);
425 extern void    retry_update(address_item **, address_item **, address_item **);
426 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
427 extern uschar *rewrite_address_qualify(uschar *, BOOL);
428 extern header_line *rewrite_header(header_line *,
429                const uschar *, const uschar *,
430                rewrite_rule *, int, BOOL);
431 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
432                  rewrite_rule *);
433 extern void    rewrite_test(uschar *);
434 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
435                  uschar **);
436 extern int     route_address(address_item *, address_item **, address_item **,
437                  address_item **, address_item **, int);
438 extern int     route_check_prefix(const uschar *, const uschar *, unsigned *);
439 extern int     route_check_suffix(const uschar *, const uschar *, unsigned *);
440 extern BOOL    route_findgroup(uschar *, gid_t *);
441 extern BOOL    route_finduser(const uschar *, struct passwd **, uid_t *);
442 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
443                  uschar **);
444 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
445                  struct passwd **, uid_t *, uschar **);
446 extern void    route_init(void);
447 extern gstring * route_show_supported(gstring *);
448 extern void    route_tidyup(void);
449
450 extern uschar *search_find(void *, const uschar *, uschar *, int,
451                  const uschar *, int, int, int *, const uschar *);
452 extern int     search_findtype(const uschar *, int);
453 extern int     search_findtype_partial(const uschar *, int *, const uschar **, int *,
454                  int *, const uschar **);
455 extern void   *search_open(const uschar *, int, int, uid_t *, gid_t *);
456 extern void    search_tidyup(void);
457 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
458 extern void    sha1_end(hctx *, const uschar *, int, uschar *);
459 extern void    sha1_mid(hctx *, const uschar *);
460 extern void    sha1_start(hctx *);
461 extern int     sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
462                  uschar *, address_item **, uschar **);
463 extern void    sigalrm_handler(int);
464 extern BOOL    smtp_buffered(void);
465 extern void    smtp_closedown(uschar *);
466 extern void    smtp_command_timeout_exit(void) NORETURN;
467 extern void    smtp_command_sigterm_exit(void) NORETURN;
468 extern void    smtp_data_timeout_exit(void) NORETURN;
469 extern void    smtp_data_sigint_exit(void) NORETURN;
470 extern void    smtp_deliver_init(void);
471 extern uschar *smtp_cmd_hist(void);
472 extern int     smtp_connect(smtp_connect_args *, const blob *);
473 extern int     smtp_sock_connect(host_item *, int, int, uschar *,
474                  transport_instance * tb, int, const blob *);
475 extern int     smtp_feof(void);
476 extern int     smtp_ferror(void);
477 extern uschar *smtp_get_connection_info(void);
478 extern BOOL    smtp_get_interface(uschar *, int, address_item *,
479                  uschar **, uschar *);
480 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
481 extern int     smtp_getc(unsigned);
482 extern uschar *smtp_getbuf(unsigned *);
483 extern void    smtp_get_cache(void);
484 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
485 extern void    smtp_log_no_mail(void);
486 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
487 extern void    smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
488 extern BOOL    smtp_read_response(void *, uschar *, int, int, int);
489 extern void   *smtp_reset(void *);
490 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
491 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
492 extern void    smtp_port_for_connect(host_item *, int);
493 extern void    smtp_send_prohibition_message(int, uschar *);
494 extern int     smtp_setup_msg(void);
495 extern BOOL    smtp_start_session(void);
496 extern int     smtp_ungetc(int);
497 extern BOOL    smtp_verify_helo(void);
498 extern int     smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
499 #ifdef WITH_CONTENT_SCAN
500 extern int     spam(const uschar **);
501 extern FILE   *spool_mbox(unsigned long *, const uschar *, uschar **);
502 #endif
503 extern void    spool_clear_header_globals(void);
504 extern BOOL    spool_move_message(uschar *, uschar *, uschar *, uschar *);
505 extern int     spool_open_datafile(uschar *);
506 extern int     spool_open_temp(uschar *);
507 extern int     spool_read_header(uschar *, BOOL, BOOL);
508 extern int     spool_write_header(uschar *, int, uschar **);
509 extern int     stdin_getc(unsigned);
510 extern int     stdin_feof(void);
511 extern int     stdin_ferror(void);
512 extern int     stdin_ungetc(int);
513
514 extern void    store_exit(void);
515 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
516 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
517 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
518 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
519 extern uschar *string_base62(unsigned long int);
520 extern gstring *string_cat (gstring *, const uschar *     ) WARN_UNUSED_RESULT;
521 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
522 extern int     string_compare_by_pointer(const void *, const void *);
523 extern uschar *string_copy_dnsdomain(uschar *);
524 extern uschar *string_copy_malloc(const uschar *);
525 extern uschar *string_dequote(const uschar **);
526 extern uschar *string_format_size(int, uschar *);
527 extern int     string_interpret_escape(const uschar **);
528 extern int     string_is_ip_address(const uschar *, int *);
529 #ifdef SUPPORT_I18N
530 extern BOOL    string_is_utf8(const uschar *);
531 #endif
532 extern const uschar *string_printing2(const uschar *, int);
533 extern uschar *string_split_message(uschar *);
534 extern uschar *string_unprinting(uschar *);
535 #ifdef SUPPORT_I18N
536 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
537 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
538 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
539 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
540 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
541 #endif
542
543 #define string_format(buf, siz, fmt, ...) \
544         string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
545 extern BOOL    string_format_trc(uschar *, int, const uschar *, unsigned,
546                         const char *, ...) ALMOST_PRINTF(5,6);
547
548 #define string_vformat(g, flgs, fmt, ap) \
549         string_vformat_trc(g, US __FUNCTION__, __LINE__, \
550                          STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
551 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
552                         unsigned, unsigned, const char *, va_list);
553
554 #define string_open_failed(eno, fmt, ...) \
555         string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
556 extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
557                         const char *, ...) PRINTF_FUNCTION(4,5);
558
559 #define string_nextinlist(lp, sp, b, l) \
560         string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
561 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
562                         const uschar * func, int line);
563
564 extern int     strcmpic(const uschar *, const uschar *);
565 extern int     strncmpic(const uschar *, const uschar *, int);
566 extern uschar *strstric(uschar *, uschar *, BOOL);
567
568 extern int     test_harness_fudged_queue_time(int);
569 extern void    tcp_init(void);
570 #ifdef EXIM_TFO_PROBE
571 extern void    tfo_probe(void);
572 #endif
573 extern void    tls_modify_variables(tls_support *);
574 extern uschar *tod_stamp(int);
575
576 extern BOOL    transport_check_waiting(const uschar *, const uschar *, int, uschar *,
577                  BOOL *, oicf, void*);
578 extern void    transport_init(void);
579 extern void    transport_do_pass_socket(const uschar *, const uschar *,
580                  const uschar *, uschar *, int);
581 extern BOOL    transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
582                  int);
583 extern uschar *transport_rcpt_address(address_item *, BOOL);
584 extern BOOL    transport_set_up_command(const uschar ***, uschar *,
585                  BOOL, int, address_item *, uschar *, uschar **);
586 extern void    transport_update_waiting(host_item *, uschar *);
587 extern BOOL    transport_write_block(transport_ctx *, uschar *, int, BOOL);
588 extern void    transport_write_reset(int);
589 extern BOOL    transport_write_string(int, const char *, ...);
590 extern BOOL    transport_headers_send(transport_ctx *,
591                  BOOL (*)(transport_ctx *, uschar *, int));
592 extern gstring * transport_show_supported(gstring *);
593 extern BOOL    transport_write_message(transport_ctx *, int);
594 extern void    tree_add_duplicate(uschar *, address_item *);
595 extern void    tree_add_nonrecipient(uschar *);
596 extern void    tree_add_unusable(host_item *);
597 extern void    tree_dup(tree_node **, tree_node *);
598 extern int     tree_insertnode(tree_node **, tree_node *);
599 extern tree_node *tree_search(tree_node *, const uschar *);
600 extern void    tree_write(tree_node *, FILE *);
601 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
602
603 #ifdef WITH_CONTENT_SCAN
604 extern void    unspool_mbox(void);
605 #endif
606 #ifdef SUPPORT_I18N
607 extern void    utf8_version_report(FILE *);
608 #endif
609
610 extern int     verify_address(address_item *, FILE *, int, int, int, int,
611                  uschar *, uschar *, BOOL *);
612 extern int     verify_check_dnsbl(int, const uschar **, uschar **);
613 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
614                  uschar *, uschar *, int, int *);
615 extern int     verify_check_headers(uschar **);
616 extern int     verify_check_header_names_ascii(uschar **);
617 extern int     verify_check_host(uschar **);
618 extern int     verify_check_notblind(BOOL);
619 extern int     verify_check_given_host(const uschar **, const host_item *);
620 extern int     verify_check_this_host(const uschar **, unsigned int *,
621                  const uschar*, const uschar *, const uschar **);
622 extern address_item *verify_checked_sender(uschar *);
623 extern void    verify_get_ident(int);
624 extern BOOL    verify_sender(int *, uschar **);
625 extern BOOL    verify_sender_preliminary(int *, uschar **);
626 extern void    version_init(void);
627
628 extern BOOL    write_chunk(transport_ctx *, uschar *, int);
629 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
630
631
632 /******************************************************************************/
633 /* Predicate: if an address is in a tainted pool.
634 By extension, a variable pointing to this address is tainted.
635 */
636
637 static inline BOOL
638 is_tainted(const void * p)
639 {
640 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
641 return FALSE;
642
643 #else
644 extern BOOL is_tainted_fn(const void *);
645 return is_tainted_fn(p);
646 #endif
647 }
648
649 /******************************************************************************/
650 /* String functions */
651 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
652 {
653 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
654 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
655 #endif
656 return US strcat(CS dst, CCS src);
657 }
658 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
659 {
660 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
661 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
662 #endif
663 return US strcpy(CS dst, CCS src);
664 }
665 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
666 {
667 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
668 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
669 #endif
670 return US strncat(CS dst, CCS src, n);
671 }
672 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
673 {
674 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
675 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
676 #endif
677 return US strncpy(CS dst, CCS src, n);
678 }
679 /*XXX will likely need unchecked copy also */
680
681
682 /* Advance the string pointer given over any whitespace.
683 Return the next char as there's enought places using it to be useful. */
684
685 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
686
687 static inline uschar skip_whitespace(const uschar ** sp)
688 { while (isspace(**sp)) (*sp)++; return **sp; }
689
690
691 /******************************************************************************/
692
693 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
694 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
695 chown(<exim-uid>, <exim-gid>).
696
697 Probably because the idmapping is broken, misconfigured or set up in
698 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
699 case of misconfiguration, or if there are more such broken systems
700 out, I try to impose as least impact as possible and for now just write
701 a panic log entry pointing to the bug report. You're encouraged to
702 contact the developers, if you experience this issue.
703
704 fd     the file descriptor (or -1 if not valid)
705 name   the file name for error messages or for file operations,
706   if fd is < 0
707 owner  the owner
708 group  the group
709
710 returns 0 on success, -1 on failure */
711
712 static inline int
713 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
714 {
715 return fchown(fd, owner, group)
716   ? exim_chown_failure(fd, name, owner, group) : 0;
717 }
718
719 static inline int
720 exim_chown(const uschar *name, uid_t owner, gid_t group)
721 {
722 return chown(CCS name, owner, group)
723   ? exim_chown_failure(-1, name, owner, group) : 0;
724 }
725 #endif  /* !MACRO_PREDEF && !COMPILE_UTILITY */
726
727 /******************************************************************************/
728 /* String functions */
729
730 #if !defined(MACRO_PREDEF)
731 /*************************************************
732 *            Copy and save string                *
733 *************************************************/
734
735 /* This function assumes that memcpy() is faster than strcpy().
736 The result is explicitly nul-terminated.
737 */
738
739 static inline uschar *
740 string_copyn_taint_trc(const uschar * s, unsigned len,
741         BOOL tainted, const char * func, int line)
742 {
743 uschar * ss = store_get_3(len + 1, tainted, func, line);
744 memcpy(ss, s, len);
745 ss[len] = '\0';
746 return ss;
747 }
748
749 static inline uschar *
750 string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line)
751 { return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); }
752
753 static inline uschar *
754 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
755 { return string_copyn_taint_trc(s, len, is_tainted(s), func, line); }
756 static inline uschar *
757 string_copy_trc(const uschar * s, const char * func, int line)
758 { return string_copy_taint_trc(s, is_tainted(s), func, line); }
759
760
761 /* String-copy functions explicitly setting the taint status */
762
763 #define string_copyn_taint(s, len, tainted) \
764         string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__)
765 #define string_copy_taint(s, tainted) \
766         string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__)
767
768 /* Simple string-copy functions maintaining the taint */
769
770 #define string_copyn(s, len) \
771         string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
772 #define string_copy(s) \
773         string_copy_trc((s), __FUNCTION__, __LINE__)
774
775
776 /*************************************************
777 *       Copy, lowercase and save string          *
778 *************************************************/
779
780 /*
781 Argument: string to copy
782 Returns:  copy of string in new store, with letters lowercased
783 */
784
785 static inline uschar *
786 string_copylc(const uschar *s)
787 {
788 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
789 uschar *p = ss;
790 while (*s != 0) *p++ = tolower(*s++);
791 *p = 0;
792 return ss;
793 }
794
795
796
797 /*************************************************
798 * Copy, lowercase, and save string, given length *
799 *************************************************/
800
801 /* It is assumed the data contains no zeros. A zero is added
802 onto the end.
803
804 Arguments:
805   s         string to copy
806   n         number of characters
807
808 Returns:    copy of string in new store, with letters lowercased
809 */
810
811 static inline uschar *
812 string_copynlc(uschar *s, int n)
813 {
814 uschar *ss = store_get(n + 1, is_tainted(s));
815 uschar *p = ss;
816 while (n-- > 0) *p++ = tolower(*s++);
817 *p = 0;
818 return ss;
819 }
820
821
822 # ifndef COMPILE_UTILITY
823 /*************************************************
824 *     Copy and save string in longterm store     *
825 *************************************************/
826
827 /* This function assumes that memcpy() is faster than strcpy().
828
829 Argument: string to copy
830 Returns:  copy of string in new store
831 */
832
833 static inline uschar *
834 string_copy_perm(const uschar *s, BOOL force_taint)
835 {
836 int old_pool = store_pool;
837 int len = Ustrlen(s) + 1;
838 uschar *ss;
839
840 store_pool = POOL_PERM;
841 ss = store_get(len, force_taint || is_tainted(s));
842 memcpy(ss, s, len);
843 store_pool = old_pool;
844 return ss;
845 }
846 # endif
847
848
849
850 /* sprintf into a buffer, taint-unchecked */
851
852 static inline void
853 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
854 {
855 gstring gs = { .size = siz, .ptr = 0, .s = buf };
856 va_list ap;
857 va_start(ap, fmt);
858 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
859 va_end(ap);
860 }
861
862
863
864 /******************************************************************************/
865 /* Growable-string functions */
866
867 /* Create a growable-string with some preassigned space */
868
869 #define string_get_tainted(size, tainted) \
870         string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
871
872 static inline gstring *
873 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
874 {
875 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
876 g->size = size;
877 g->ptr = 0;
878 g->s = US(g + 1);
879 return g;
880 }
881
882 #define string_get(size) \
883         string_get_trc((size), __FUNCTION__, __LINE__)
884
885 static inline gstring *
886 string_get_trc(unsigned size, const char * func, unsigned line)
887 {
888 return string_get_tainted_trc(size, FALSE, func, line);
889 }
890
891 /* NUL-terminate the C string in the growable-string, and return it. */
892
893 static inline uschar *
894 string_from_gstring(gstring * g)
895 {
896 if (!g) return NULL;
897 g->s[g->ptr] = '\0';
898 return g->s;
899 }
900
901 static inline unsigned
902 gstring_length(const gstring * g)
903 {
904 return g ? (unsigned)g->ptr : 0;
905 }
906
907
908 #define gstring_release_unused(g) \
909         gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
910
911 static inline void
912 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
913 {
914 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
915 }
916
917
918 /* sprintf-append to a growable-string */
919
920 #define string_fmt_append(g, fmt, ...) \
921         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
922         SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
923
924 #define string_fmt_append_f(g, flgs, fmt, ...) \
925         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
926         flgs,         fmt, __VA_ARGS__)
927
928 static inline gstring *
929 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
930   unsigned flags, const char *format, ...)
931 {
932 va_list ap;
933 va_start(ap, format);
934 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
935                         flags, format, ap);
936 va_end(ap);
937 return g;
938 }
939
940
941 /* Copy the content of a string to tainted memory */
942
943 static inline void
944 gstring_rebuffer(gstring * g)
945 {
946 uschar * s = store_get(g->size, TRUE);
947 memcpy(s, g->s, g->ptr);
948 g->s = s;
949 }
950
951
952 /******************************************************************************/
953
954 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
955
956 static inline dns_answer *
957 store_get_dns_answer_trc(const uschar * func, unsigned line)
958 {
959 return store_get_3(sizeof(dns_answer), TRUE, CCS func, line);  /* use tainted mem */
960 }
961
962 /******************************************************************************/
963 /* Routines with knowledge of spool layout */
964
965 # ifndef COMPILE_UTILITY
966 static inline void
967 spool_pname_buf(uschar * buf, int len)
968 {
969 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
970 }
971
972 static inline uschar *
973 spool_dname(const uschar * purpose, uschar * subdir)
974 {
975 return string_sprintf("%s/%s/%s/%s",
976         spool_directory, queue_name, purpose, subdir);
977 }
978 # endif
979
980 static inline uschar *
981 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
982 {
983 return string_sprintf("%s%s%s%s%s",
984                     q, *q ? "/" : "",
985                     purpose,
986                     *subdir ? "/" : "", subdir);
987 }
988
989 static inline uschar *
990 spool_sname(const uschar * purpose, uschar * subdir)
991 {
992 return spool_q_sname(purpose, queue_name, subdir);
993 }
994
995 static inline uschar *
996 spool_q_fname(const uschar * purpose, const uschar * q,
997         const uschar * subdir, const uschar * fname, const uschar * suffix)
998 {
999 return string_sprintf("%s/%s/%s/%s/%s%s",
1000         spool_directory, q, purpose, subdir, fname, suffix);
1001 }
1002
1003 static inline uschar *
1004 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1005         const uschar * suffix)
1006 {
1007 #ifdef COMPILE_UTILITY          /* version avoiding string-extension */
1008 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1009         + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1010 uschar * buf = store_get(len, FALSE);
1011 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1012         spool_directory, queue_name, purpose, subdir, fname, suffix);
1013 return buf;
1014 #else
1015 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1016 #endif
1017 }
1018
1019 static inline void
1020 set_subdir_str(uschar * subdir_str, const uschar * name,
1021         int search_sequence)
1022 {
1023 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1024        ? name[5] : '\0';
1025 subdir_str[1] = '\0';
1026 }
1027
1028 /******************************************************************************/
1029 /* Time calculations */
1030
1031 static inline void
1032 timesince(struct timeval * diff, const struct timeval * then)
1033 {
1034 gettimeofday(diff, NULL);
1035 diff->tv_sec -= then->tv_sec;
1036 if ((diff->tv_usec -= then->tv_usec) < 0)
1037   {
1038   diff->tv_sec--;
1039   diff->tv_usec += 1000*1000;
1040   }
1041 }
1042
1043 static inline uschar *
1044 string_timediff(const struct timeval * diff)
1045 {
1046 static uschar buf[sizeof("0.000s")];
1047
1048 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1049   return readconf_printtime((int)diff->tv_sec);
1050
1051 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1052 return buf;
1053 }
1054
1055
1056 static inline uschar *
1057 string_timesince(const struct timeval * then)
1058 {
1059 struct timeval diff;
1060 timesince(&diff, then);
1061 return string_timediff(&diff);
1062 }
1063
1064 static inline void
1065 report_time_since(const struct timeval * t0, const uschar * where)
1066 {
1067 # ifdef MEASURE_TIMING
1068 struct timeval diff;
1069 timesince(&diff, t0);
1070 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1071        (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1072 # endif
1073 }
1074
1075
1076 static inline void
1077 testharness_pause_ms(int millisec)
1078 {
1079 #ifndef MEASURE_TIMING
1080 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1081 #endif
1082 }
1083
1084 /******************************************************************************/
1085 /* Taint-checked file opens */
1086 static inline uschar *
1087 is_tainted2(const void *p, int lflags, const uschar* fmt, ...)
1088 {
1089 va_list ap;
1090 uschar *msg;
1091 rmark mark;
1092
1093 if (!is_tainted(p))
1094   return NULL;
1095
1096 mark = store_mark();
1097 va_start(ap, fmt);
1098 msg = string_from_gstring(string_vformat(NULL, SVFMT_TAINT_NOCHK|SVFMT_EXTEND, fmt, ap));
1099 va_end(ap);
1100
1101 #ifdef ALLOW_INSECURE_TAINTED_DATA
1102 if (allow_insecure_tainted_data)
1103   {
1104   if LOGGING(tainted) log_write(0, LOG_MAIN, "Warning: %s", msg);
1105   store_reset(mark);
1106   return NULL;
1107   }
1108 #endif
1109
1110 if (lflags) log_write(0, lflags, "%s", msg);
1111 return msg; /* no store_reset(), as the message might be used afterwards and Exim
1112             is expected to exit anyway, so we do not care about the leaked
1113             storage */
1114 }
1115
1116 static inline int
1117 exim_open2(const char *pathname, int flags)
1118 {
1119 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1120   return open(pathname, flags);
1121 errno = EACCES;
1122 return -1;
1123 }
1124
1125 static inline int
1126 exim_open(const char *pathname, int flags, mode_t mode)
1127 {
1128 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1129   return open(pathname, flags, mode);
1130 errno = EACCES;
1131 return -1;
1132 }
1133 static inline int
1134 exim_openat(int dirfd, const char *pathname, int flags)
1135 {
1136 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1137   return openat(dirfd, pathname, flags);
1138 errno = EACCES;
1139 return -1;
1140 }
1141 static inline int
1142 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1143 {
1144 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1145   return openat(dirfd, pathname, flags, mode);
1146 errno = EACCES;
1147 return -1;
1148 }
1149
1150 static inline FILE *
1151 exim_fopen(const char *pathname, const char *mode)
1152 {
1153 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1154   return fopen(pathname, mode);
1155 errno = EACCES;
1156 return NULL;
1157 }
1158
1159 static inline DIR *
1160 exim_opendir(const uschar * name)
1161 {
1162 if (!is_tainted2(name, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name))
1163   return opendir(CCS name);
1164 errno = EACCES;
1165 return NULL;
1166 }
1167
1168 /******************************************************************************/
1169 # if !defined(COMPILE_UTILITY)
1170 /* Process manipulation */
1171
1172 static inline pid_t
1173 exim_fork(const unsigned char * purpose)
1174 {
1175 pid_t pid;
1176 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1177 if ((pid = fork()) == 0)
1178   {
1179   process_purpose = purpose;
1180   DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1181   }
1182 else
1183   {
1184   testharness_pause_ms(100); /* let child work */
1185   DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1186   }
1187 return pid;
1188 }
1189
1190
1191 static inline pid_t
1192 child_open_exim(int * fdptr, const uschar * purpose)
1193 { return child_open_exim_function(fdptr, purpose); }
1194
1195 static inline pid_t
1196 child_open_exim2(int * fdptr, uschar * sender,
1197   uschar * sender_auth, const uschar * purpose)
1198 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1199
1200 static inline pid_t
1201 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1202   int *outfdptr, BOOL make_leader, const uschar * purpose)
1203 { return child_open_function(argv, envp, newumask, infdptr,
1204   outfdptr, make_leader, purpose);
1205 }
1206
1207 # endif /* !COMPILE_UTILITY */
1208
1209 /******************************************************************************/
1210 #endif  /* !MACRO_PREDEF */
1211
1212 #endif  /* _FUNCTIONS_H_ */
1213
1214 /* vi: aw
1215 */
1216 /* End of functions.h */