1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2023 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
11 /* Prototypes for functions that appear in various modules. Gathered together
12 to avoid having a lot of tiddly little headers with only a couple of lines in
13 them. However, some functions that are used (or not used) by utility programs
14 are in in fact in separate headers. */
23 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
24 uschar **) WARN_UNUSED_RESULT;
25 extern void cleanup_perl(void);
26 extern uschar *init_perl(uschar *);
32 std_dh_prime_default(void);
34 std_dh_prime_named(const uschar *);
36 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
37 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
38 extern uschar * tls_cert_issuer(void *, uschar * mod);
39 extern uschar * tls_cert_not_before(void *, uschar * mod);
40 extern uschar * tls_cert_not_after(void *, uschar * mod);
41 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
42 extern uschar * tls_cert_serial_number(void *, uschar * mod);
43 extern uschar * tls_cert_signature(void *, uschar * mod);
44 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
45 extern uschar * tls_cert_subject(void *, uschar * mod);
46 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
47 extern uschar * tls_cert_version(void *, uschar * mod);
49 extern uschar * tls_cert_der_b64(void * cert);
50 extern uschar * tls_cert_fprt_md5(void *);
51 extern uschar * tls_cert_fprt_sha1(void *);
52 extern uschar * tls_cert_fprt_sha256(void *);
54 extern void tls_clean_env(void);
55 extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
56 void *, tls_support *, uschar **);
57 extern BOOL tls_client_adjunct_start(host_item *, client_conn_ctx *,
58 const uschar *, uschar **);
59 extern void tls_client_creds_reload(BOOL);
61 extern void tls_close(void *, int);
62 extern BOOL tls_could_getc(void);
63 extern void tls_daemon_init(void);
64 extern int tls_daemon_tick(void);
65 extern BOOL tls_dropprivs_validate_require_cipher(BOOL);
66 extern BOOL tls_export_cert(uschar *, size_t, void *);
67 extern int tls_feof(void);
68 extern int tls_ferror(void);
69 extern uschar *tls_field_from_dn(uschar *, const uschar *);
70 extern void tls_free_cert(void **);
71 extern int tls_getc(unsigned);
72 extern uschar *tls_getbuf(unsigned *);
73 extern void tls_get_cache(unsigned);
74 extern BOOL tls_hasc(void);
75 extern BOOL tls_import_cert(const uschar *, void **);
76 extern BOOL tls_is_name_for_cert(const uschar *, void *);
78 extern BOOL tls_openssl_options_parse(uschar *, long *);
80 extern int tls_read(void *, uschar *, size_t);
81 extern int tls_server_start(uschar **);
82 extern void tls_shutdown_wr(void *);
83 extern BOOL tls_smtp_buffered(void);
84 extern int tls_ungetc(int);
85 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
86 extern void tls_watch_discard_event(int);
87 extern void tls_watch_invalidate(void);
89 extern int tls_write(void *, const uschar *, size_t, BOOL);
90 extern uschar *tls_validate_require_cipher(void);
91 extern gstring *tls_version_report(gstring *);
94 extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
97 #endif /*DISABLE_TLS*/
100 /* Everything else... */
102 extern acl_block *acl_read(uschar *(*)(void), uschar **);
103 extern int acl_check(int, const uschar *, uschar *, uschar **, uschar **);
104 extern uschar *acl_current_verb(void);
105 extern int acl_eval(int, uschar *, uschar **, uschar **);
106 extern uschar *acl_standalone_setvar(const uschar *, BOOL);
108 extern tree_node *acl_var_create(uschar *);
109 extern void acl_var_write(uschar *, uschar *, void *);
111 #ifdef EXPERIMENTAL_ARC
112 # ifdef SUPPORT_DMARC
113 extern gstring *arc_dmarc_hist_append(gstring *);
115 extern void *arc_ams_setup_sign_bodyhash(void);
116 extern const uschar *arc_header_feed(gstring *, BOOL);
117 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
118 extern void arc_sign_init(void);
119 extern const uschar *acl_verify_arc(void);
120 extern uschar * fn_arc_domains(void);
123 extern void assert_no_variables(void *, int, const char *, int);
124 extern int auth_call_pam(const uschar *, uschar **);
125 extern int auth_call_pwcheck(uschar *, uschar **);
126 extern int auth_call_radius(const uschar *, uschar **);
127 extern int auth_call_saslauthd(const uschar *, const uschar *,
128 const uschar *, const uschar *, uschar **);
129 extern int auth_check_serv_cond(auth_instance *);
130 extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
131 extern int auth_client_item(void *, auth_instance *, const uschar **,
132 unsigned, int, uschar *, int);
135 extern int auth_get_data(uschar **, const uschar *, int);
136 extern int auth_get_no64_data(uschar **, uschar *);
137 extern int auth_prompt(const uschar *);
138 extern int auth_read_input(const uschar *);
139 extern gstring * auth_show_supported(gstring *);
140 extern uschar *auth_xtextencode(uschar *, int);
141 extern int auth_xtextdecode(uschar *, uschar **);
142 extern uschar *authenticator_current_name(void);
144 #ifdef EXPERIMENTAL_ARC
145 extern gstring *authres_arc(gstring *);
148 extern gstring *authres_dkim(gstring *);
151 extern gstring *authres_dmarc(gstring *);
153 extern gstring *authres_smtpauth(gstring *);
155 extern gstring *authres_spf(gstring *);
158 extern uschar *b64encode(const uschar *, int);
159 extern uschar *b64encode_taint(const uschar *, int, const void *);
160 extern int b64decode(const uschar *, uschar **, const void *);
161 extern int bdat_getc(unsigned);
162 extern uschar *bdat_getbuf(unsigned *);
163 extern BOOL bdat_hasc(void);
164 extern int bdat_ungetc(int);
165 extern void bdat_flush_data(void);
167 extern void bits_clear(unsigned int *, size_t, int *);
168 extern void bits_set(unsigned int *, size_t, int *);
170 extern void cancel_cutthrough_connection(BOOL, const uschar *);
171 extern gstring *cat_file(FILE *, gstring *, uschar *);
172 extern gstring *cat_file_tls(void *, gstring *, uschar *);
173 extern int check_host(void *, const uschar *, const uschar **, uschar **);
174 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
175 extern pid_t child_open_exim_function(int *, const uschar *);
176 extern pid_t child_open_exim2_function(int *, uschar *, uschar *,
178 extern pid_t child_open_function(uschar **, uschar **, int,
179 int *, int *, BOOL, const uschar *);
180 extern pid_t child_open_uid(const uschar **, const uschar **, int,
181 uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *);
182 extern BOOL cleanup_environment(void);
183 extern void cutthrough_data_puts(uschar *, int);
184 extern void cutthrough_data_put_nl(void);
185 extern uschar *cutthrough_finaldot(void);
186 extern BOOL cutthrough_flush_send(void);
187 extern BOOL cutthrough_headers_send(void);
188 extern BOOL cutthrough_predata(void);
189 extern void release_cutthrough_connection(const uschar *);
191 extern void daemon_go(void);
192 #ifndef COMPILE_UTILITY
193 extern ssize_t daemon_client_sockname(struct sockaddr_un *, uschar **);
194 extern ssize_t daemon_notifier_sockname(struct sockaddr_un *);
197 #ifdef EXPERIMENTAL_DCC
198 extern int dcc_process(uschar **);
201 extern void debug_logging_activate(const uschar *, const uschar *);
202 extern void debug_logging_from_spool(const uschar *);
203 extern void debug_logging_stop(BOOL);
204 extern void debug_print_argv(const uschar **);
205 extern void debug_print_ids(uschar *);
206 extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
207 extern void debug_print_string(uschar *);
208 extern void debug_print_tree(const char *, tree_node *);
209 extern void debug_vprintf(int, const char *, va_list);
210 extern void debug_pretrigger_setup(const uschar *);
211 extern void debug_pretrigger_discard(void);
212 extern void debug_print_socket(int);
213 extern void debug_trigger_fire(void);
215 extern void decode_bits(unsigned int *, size_t, int *,
216 const uschar *, bit_table *, int, uschar *, int);
217 extern void delete_pid_file(void);
218 extern void deliver_local(address_item *, BOOL);
219 extern address_item *deliver_make_addr(const uschar *, BOOL);
220 extern void delivery_log(int, address_item *, int, uschar *);
221 extern int deliver_message(const uschar *, BOOL, BOOL);
222 extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
223 extern void deliver_set_expansions(address_item *);
224 extern int deliver_split_address(address_item *);
225 extern void deliver_succeeded(address_item *);
227 extern void delivery_re_exec(int);
229 extern void die_tainted(const uschar *, const uschar *, int);
230 extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
232 extern uschar *dkim_exim_query_dns_txt(const uschar *);
233 extern void dkim_exim_sign_init(void);
235 extern BOOL dkim_transport_write_message(transport_ctx *,
236 struct ob_dkim *, const uschar ** errstr);
238 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
239 extern int dns_basic_lookup(dns_answer *, const uschar *, int);
240 extern uschar *dns_build_reverse(const uschar *);
241 extern time_t dns_expire_from_soa(dns_answer *, int);
242 extern void dns_init(BOOL, BOOL, BOOL);
243 extern BOOL dns_is_aa(const dns_answer *);
244 extern BOOL dns_is_secure(const dns_answer *);
245 extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
246 extern void dns_pattern_init(void);
247 extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
248 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
249 extern uschar *dns_text_type(int);
250 extern void dscp_list_to_stream(FILE *);
251 extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
253 extern void enq_end(uschar *);
254 extern BOOL enq_start(uschar *, unsigned);
255 #ifndef DISABLE_EVENT
256 extern uschar *event_raise(uschar *, const uschar *, uschar *, int *);
257 extern void msg_event_raise(const uschar *, const address_item *);
260 extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
261 extern const uschar * exim_errstr(int);
262 extern void exim_exit(int) NORETURN;
263 extern void exim_gettime(struct timeval *);
264 extern void exim_nullstd(void);
265 extern void exim_setugid(uid_t, gid_t, BOOL, const uschar *);
266 extern void exim_underbar_exit(int) NORETURN;
267 extern void exim_wait_tick(struct timeval *, int);
268 extern int exp_bool(address_item *addr,
269 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
270 uschar *svalue, BOOL *rvalue);
271 extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
272 extern uschar *expand_file_big_buffer(const uschar *);
273 extern uschar *expand_string(uschar *); /* public, cannot make const */
274 extern const uschar *expand_string_2(const uschar *, BOOL *);
275 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
276 extern uschar *expand_getkeyed(const uschar *, const uschar *);
278 extern uschar *expand_hide_passwords(uschar * );
279 extern uschar *expand_string_copy(const uschar *);
280 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
281 extern void modify_variable(uschar *, void *);
283 extern BOOL fd_ready(int, time_t);
285 extern int filter_interpret(const uschar *, int, address_item **, uschar **);
286 extern BOOL filter_personal(string_item *, BOOL);
287 extern BOOL filter_runtest(int, const uschar *, BOOL, BOOL);
288 extern BOOL filter_system_interpret(address_item **, uschar **);
290 extern uschar * fn_hdrs_added(void);
291 extern void force_fd(int, int);
293 extern void header_add(int, const char *, ...);
294 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
295 extern int header_checkname(header_line *, BOOL);
296 extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
297 extern int host_address_extract_port(uschar *);
298 extern uschar *host_and_ident(BOOL);
299 extern int host_aton(const uschar *, int *);
300 extern void host_build_hostlist(host_item **, const uschar *, BOOL);
301 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
302 extern void host_build_log_info(void);
303 extern void host_build_sender_fullhost(void);
304 extern int host_find_byname(host_item *, const uschar *, int,
305 const uschar **, BOOL);
306 extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
307 uschar *, const dnssec_domains *, const uschar **, BOOL *);
308 extern ip_address_item *host_find_interfaces(void);
309 extern BOOL host_is_in_net(const uschar *, const uschar *, int);
310 extern BOOL host_is_tls_on_connect_port(int);
311 extern int host_item_get_port(host_item *);
312 extern void host_mask(int, int *, int);
313 extern int host_name_lookup(void);
314 extern int host_nmtoa(int, int *, int, uschar *, int);
315 extern uschar *host_ntoa(int, const void *, uschar *, int *);
316 extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
318 extern uschar *imap_utf7_encode(uschar *, const uschar *,
319 uschar, uschar *, uschar **);
321 extern void invert_address(uschar *, uschar *);
322 extern int ip_addr(void *, int, const uschar *, int);
323 extern int ip_bind(int, int, uschar *, int);
324 extern int ip_connect(int, int, const uschar *, int, int, const blob *);
325 extern int ip_connectedsocket(int, const uschar *, int, int,
326 int, host_item *, uschar **, const blob *);
327 extern int ip_get_address_family(int);
328 extern void ip_keepalive(int, const uschar *, BOOL);
329 extern int ip_recv(client_conn_ctx *, uschar *, int, time_t);
330 extern int ip_socket(int, int);
332 extern int ip_tcpsocket(const uschar *, uschar **, int, host_item *);
333 extern int ip_unixsocket(const uschar *, uschar **);
334 extern int ip_streamsocket(const uschar *, uschar **, int, host_item *);
336 extern int ipv6_nmtoa(int *, uschar *);
338 extern const uschar *local_part_quote(const uschar *);
339 extern int log_open_as_exim(const uschar * const);
340 extern void log_close_all(void);
342 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
343 extern BOOL macro_read_assignment(uschar *);
344 extern uschar *macros_expand(int, int *, BOOL *);
345 extern void mainlog_close(void);
346 #ifdef WITH_CONTENT_SCAN
347 extern int malware(const uschar *, BOOL, int);
348 extern int malware_in_file(const uschar *);
349 extern void malware_init(void);
350 extern gstring * malware_show_supported(gstring *);
352 extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
353 unsigned int *, int, int, const uschar **);
354 extern int match_address_list_basic(const uschar *, const uschar **, int);
355 extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
356 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
357 const uschar *, const uschar **);
358 extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
359 unsigned int *, int, BOOL, const uschar **);
360 extern int match_check_string(const uschar *, const uschar *, int, mcs_flags,
363 extern void message_start(void);
364 extern void message_tidyup(void);
365 extern void md5_end(md5 *, const uschar *, int, uschar *);
366 extern void md5_mid(md5 *, const uschar *);
367 extern void md5_start(md5 *);
368 extern void millisleep(int);
369 #ifdef WITH_CONTENT_SCAN
370 struct mime_boundary_context;
371 extern int mime_acl_check(uschar *acl, FILE *f,
372 struct mime_boundary_context *, uschar **, uschar **);
373 extern int mime_decode(const uschar **);
374 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
375 extern int mime_regex(const uschar **, BOOL);
376 extern void mime_set_anomaly(int);
378 extern uschar *moan_check_errorcopy(const uschar *);
379 extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
381 extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
382 extern BOOL moan_send_message(const uschar *, int, error_block *eblock,
383 header_line *, FILE *, uschar *);
384 extern void moan_tell_someone(uschar *, address_item *,
385 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
386 extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
387 extern void moan_write_from(FILE *);
388 extern void moan_write_references(FILE *, uschar *);
389 extern FILE *modefopen(const uschar *, const char *, mode_t);
391 extern int open_cutthrough_connection( address_item * addr );
393 extern uschar *parse_extract_address(const uschar *, uschar **, int *, int *, int *,
395 extern int parse_forward_list(const uschar *, int, address_item **, uschar **,
396 const uschar *, const uschar *, error_block **);
397 extern uschar *parse_find_address_end(const uschar *, BOOL);
398 extern const uschar *parse_find_at(const uschar *);
399 extern const uschar *parse_fix_phrase(const uschar *, int);
400 extern const uschar *parse_message_id(const uschar *, uschar **, uschar **);
401 extern const uschar *parse_quote_2047(const uschar *, int, const uschar *,
403 extern const uschar *parse_date_time(const uschar *str, time_t *t);
404 extern void priv_drop_temp(const uid_t, const gid_t);
405 extern void priv_restore(void);
407 extern BOOL proxy_protocol_host(void);
408 extern void proxy_protocol_setup(void);
411 extern BOOL queue_action(const uschar *, int, const uschar **, int, int);
412 extern void queue_check_only(void);
413 extern unsigned queue_count(void);
414 extern unsigned queue_count_cached(void);
415 extern void queue_list(int, const uschar **, int);
416 #ifndef DISABLE_QUEUE_RAMP
417 extern void queue_notify_daemon(const uschar * hostname);
419 extern void queue_run(qrunner *, const uschar *, const uschar *, BOOL);
421 extern int random_number(int);
422 extern const uschar *rc_to_string(int);
423 extern int rda_interpret(redirect_block *, int, const uschar *, const uschar *,
424 const uschar *, const uschar *, const uschar *, const ugid_block *, address_item **,
425 uschar **, error_block **, int *, const uschar *);
426 extern int rda_is_filter(const uschar *);
427 extern BOOL readconf_depends(driver_instance *, uschar *);
428 extern void readconf_driver_init(uschar *, driver_instance **,
429 driver_info *, int, void *, int, optionlist *, int);
430 extern uschar *readconf_find_option(void *);
431 extern void readconf_main(BOOL);
432 extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
433 extern BOOL readconf_print(const uschar *, const uschar *, BOOL);
434 extern uschar *readconf_printtime(int);
435 extern const uschar *readconf_readname(uschar *, int, const uschar *);
436 extern int readconf_readtime(const uschar *, int, BOOL);
437 extern void readconf_rest(void);
438 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
439 extern void readconf_save_config(const uschar *);
440 extern void read_message_body(BOOL);
441 extern void receive_bomb_out(uschar *, uschar *) NORETURN;
442 extern BOOL receive_check_fs(int);
443 extern BOOL receive_check_set_sender(const uschar *);
444 extern BOOL receive_msg(BOOL);
445 extern int_eximarith_t receive_statvfs(BOOL, int *);
446 extern void receive_swallow_smtp(void);
447 #ifdef WITH_CONTENT_SCAN
448 extern int regex(const uschar **, BOOL);
449 extern void regex_vars_clear(void);
451 extern void regex_at_daemon(const uschar *);
452 extern BOOL regex_match(const pcre2_code *, const uschar *, int, uschar **);
453 extern BOOL regex_match_and_setup(const pcre2_code *, const uschar *, int, int);
454 extern const pcre2_code *regex_compile(const uschar *, mcs_flags, uschar **,
455 pcre2_compile_context *);
456 extern const pcre2_code *regex_must_compile(const uschar *, mcs_flags, BOOL);
457 extern void retry_add_item(address_item *, uschar *, int);
458 extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
459 uschar **, uschar **);
460 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
461 extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
462 dbdata_retry *, time_t);
463 extern void retry_update(address_item **, address_item **, address_item **);
464 extern const uschar *rewrite_address(const uschar *, BOOL, BOOL, rewrite_rule *, int);
465 extern const uschar *rewrite_address_qualify(const uschar *, BOOL);
466 extern header_line *rewrite_header(header_line *,
467 const uschar *, const uschar *,
468 rewrite_rule *, int, BOOL);
469 extern const uschar *rewrite_one(const uschar *, int, BOOL *, BOOL, uschar *,
471 extern void rewrite_test(const uschar *);
472 extern uschar *rfc2047_decode2(uschar *, BOOL, const uschar *, int, int *,
474 extern int route_address(address_item *, address_item **, address_item **,
475 address_item **, address_item **, int);
476 extern int route_check_prefix(const uschar *, const uschar *, unsigned *);
477 extern int route_check_suffix(const uschar *, const uschar *, unsigned *);
478 extern BOOL route_findgroup(uschar *, gid_t *);
479 extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
480 extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
482 extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
483 struct passwd **, uid_t *, uschar **);
484 extern void route_init(void);
485 extern gstring * route_show_supported(gstring *);
486 extern void route_tidyup(void);
487 extern uschar *router_current_name(void);
489 extern uschar *search_args(int, uschar *, uschar *, uschar **, const uschar *);
490 extern uschar *search_find(void *, const uschar *, uschar *, int,
491 const uschar *, int, int, int *, const uschar *);
492 extern int search_findtype(const uschar *, int);
493 extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
494 int *, const uschar **);
495 extern void *search_open(const uschar *, int, int, uid_t *, gid_t *);
496 extern void search_tidyup(void);
497 extern uschar *sender_helo_verified_boolstr(void);
498 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
499 extern void sha1_end(hctx *, const uschar *, int, uschar *);
500 extern void sha1_mid(hctx *, const uschar *);
501 extern void sha1_start(hctx *);
502 extern int sieve_interpret(const uschar *, int, const uschar *,
503 const uschar *, const uschar *, const uschar *,
504 address_item **, uschar **);
505 extern void sigalrm_handler(int);
506 extern void single_queue_run(qrunner *, const uschar *, const uschar *);
507 extern int smtp_boundsock(smtp_connect_args *);
508 extern void smtp_closedown(uschar *);
509 extern void smtp_command_timeout_exit(void) NORETURN;
510 extern void smtp_command_sigterm_exit(void) NORETURN;
511 extern void smtp_data_timeout_exit(void) NORETURN;
512 extern void smtp_data_sigint_exit(void) NORETURN;
513 extern void smtp_deliver_init(void);
514 extern uschar *smtp_cmd_hist(void);
515 extern int smtp_connect(smtp_connect_args *, const blob *);
516 extern int smtp_feof(void);
517 extern int smtp_ferror(void);
518 extern uschar *smtp_get_connection_info(void);
519 extern BOOL smtp_get_interface(uschar *, int, address_item *,
520 uschar **, uschar *);
521 extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
522 extern int smtp_getc(unsigned);
523 extern uschar *smtp_getbuf(unsigned *);
524 extern void smtp_get_cache(unsigned);
525 extern BOOL smtp_hasc(void);
526 extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
527 extern void smtp_log_no_mail(void);
528 extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
529 extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int, const uschar *) NORETURN;
530 extern BOOL smtp_read_response(void *, uschar *, int, int, int);
531 extern void *smtp_reset(void *);
532 extern void smtp_respond(uschar *, int, BOOL, uschar *);
533 extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
534 extern void smtp_port_for_connect(host_item *, int);
535 extern void smtp_send_prohibition_message(int, uschar *);
536 extern int smtp_setup_msg(void);
537 extern int smtp_sock_connect(smtp_connect_args *, int, const blob *);
538 extern BOOL smtp_start_session(void);
539 extern int smtp_ungetc(int);
540 extern BOOL smtp_verify_helo(void);
541 extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
542 #ifdef WITH_CONTENT_SCAN
543 extern int spam(const uschar **);
544 extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
546 extern void spool_clear_header_globals(void);
547 extern BOOL spool_move_message(const uschar *, const uschar *, const uschar *, const uschar *);
548 extern int spool_open_datafile(const uschar *);
549 extern int spool_open_temp(uschar *);
550 extern int spool_read_header(uschar *, BOOL, BOOL);
551 extern uschar *spool_sender_from_msgid(const uschar *);
552 extern int spool_write_header(const uschar *, int, uschar **);
553 extern int stdin_getc(unsigned);
554 extern int stdin_feof(void);
555 extern int stdin_ferror(void);
556 extern BOOL stdin_hasc(void);
557 extern int stdin_ungetc(int);
559 extern void stackdump(void);
560 extern void store_exit(void);
561 extern void store_init(void);
562 extern void store_writeprotect(int);
564 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
565 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
566 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
567 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
568 extern uschar *string_base62_32(unsigned long int);
569 extern uschar *string_base62_64(unsigned long int);
570 extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
571 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
572 extern int string_compare_by_pointer(const void *, const void *);
573 extern uschar *string_copy_dnsdomain(uschar *);
574 extern uschar *string_copy_malloc(const uschar *);
575 extern uschar *string_dequote(const uschar **);
576 extern uschar *string_format_size(int, uschar *);
577 extern int string_interpret_escape(const uschar **);
578 extern int string_is_ip_address(const uschar *, int *);
579 extern int string_is_ip_addressX(const uschar *, int *, const uschar **);
581 extern BOOL string_is_utf8(const uschar *);
583 extern const uschar *string_printing2(const uschar *, int);
584 extern uschar *string_split_message(uschar *);
585 extern uschar *string_unprinting(uschar *);
587 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
588 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
589 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
590 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
591 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
594 #define string_format(buf, siz, fmt, ...) \
595 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
596 extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
597 const char *, ...) ALMOST_PRINTF(5,6);
599 #define string_vformat(g, flgs, fmt, ap) \
600 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
601 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
602 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
603 unsigned, unsigned, const char *, va_list);
605 #define string_open_failed(fmt, ...) \
606 string_open_failed_trc(US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
607 extern uschar *string_open_failed_trc(const uschar *, unsigned,
608 const char *, ...) PRINTF_FUNCTION(3,4);
610 #define string_nextinlist(lp, sp, b, l) \
611 string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
612 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
613 const uschar * func, int line);
615 extern int strcmpic(const uschar *, const uschar *);
616 extern int strncmpic(const uschar *, const uschar *, int);
617 extern uschar *strstric(uschar *, uschar *, BOOL);
618 extern const uschar *strstric_c(const uschar *, const uschar *, BOOL);
620 extern int test_harness_fudged_queue_time(int);
621 extern void tcp_init(void);
622 #ifdef EXIM_TFO_PROBE
623 extern void tfo_probe(void);
625 extern void tls_modify_variables(tls_support *);
626 extern uschar *tod_stamp(int);
628 extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
630 extern uschar *transport_current_name(void);
631 extern void transport_do_pass_socket(const uschar *, const uschar *,
632 const uschar *, uschar *, int);
633 extern void transport_init(void);
634 extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *, int
635 #ifndef DISABLE_ESMTP_LIMITS
636 , unsigned, unsigned, unsigned
639 extern const uschar *transport_rcpt_address(address_item *, BOOL);
640 extern BOOL transport_set_up_command(const uschar ***, const uschar *,
641 unsigned, int, address_item *, const uschar *, uschar **);
642 extern void transport_update_waiting(host_item *, uschar *);
643 extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
644 extern void transport_write_reset(int);
645 extern BOOL transport_write_string(int, const char *, ...);
646 extern BOOL transport_headers_send(transport_ctx *,
647 BOOL (*)(transport_ctx *, const uschar *, int));
648 extern gstring * transport_show_supported(gstring *);
649 extern BOOL transport_write_message(transport_ctx *, int);
650 extern void tree_add_duplicate(const uschar *, address_item *);
651 extern void tree_add_nonrecipient(const uschar *);
652 extern void tree_add_unusable(const host_item *);
653 extern void tree_dup(tree_node **, tree_node *);
654 extern int tree_insertnode(tree_node **, tree_node *);
655 extern tree_node *tree_search(tree_node *, const uschar *);
656 extern void tree_write(tree_node *, FILE *);
657 extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
659 #ifdef WITH_CONTENT_SCAN
660 extern void unspool_mbox(void);
663 extern gstring *utf8_version_report(gstring *);
666 extern int vaguely_random_number(int);
668 extern int vaguely_random_number_fallback(int);
670 extern int verify_address(address_item *, FILE *, int, int, int, int,
671 uschar *, uschar *, BOOL *);
672 extern int verify_check_dnsbl(int, const uschar **, uschar **);
673 extern int verify_check_header_address(uschar **, uschar **, int, int, int,
674 uschar *, uschar *, int, int *);
675 extern int verify_check_headers(uschar **);
676 extern int verify_check_header_names_ascii(uschar **);
677 extern int verify_check_host(uschar **);
678 extern int verify_check_notblind(BOOL);
679 extern int verify_check_given_host(const uschar **, const host_item *);
680 extern int verify_check_this_host(const uschar **, unsigned int *,
681 const uschar*, const uschar *, const uschar **);
682 extern address_item *verify_checked_sender(const uschar *);
683 extern void verify_get_ident(int);
684 extern void verify_quota(uschar *);
685 extern int verify_quota_call(const uschar *, int, int, uschar **);
686 extern BOOL verify_sender(int *, uschar **);
687 extern BOOL verify_sender_preliminary(int *, uschar **);
688 extern void version_init(void);
690 extern BOOL write_chunk(transport_ctx *, const uschar *, int);
691 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
692 extern uschar *wrap_header(const uschar *, unsigned, unsigned, const uschar *, unsigned);
694 #ifdef EXPERIMENTAL_XCLIENT
695 extern uschar * xclient_smtp_command(uschar *, int *, BOOL *);
696 extern gstring * xclient_smtp_advertise_str(gstring *);
700 /******************************************************************************/
701 /* Predicate: if an address is in a tainted pool.
702 By extension, a variable pointing to this address is tainted.
706 is_tainted(const void * p)
708 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
712 extern BOOL is_tainted_fn(const void *);
713 return is_tainted_fn(p);
718 is_incompatible(const void * old, const void * new)
720 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
724 extern BOOL is_incompatible_fn(const void *, const void *);
725 return is_incompatible_fn(old, new);
729 /******************************************************************************/
730 /* String functions */
731 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
733 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
734 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
736 return US strcat(CS dst, CCS src);
738 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
740 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
741 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
743 return US strcpy(CS dst, CCS src);
745 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
747 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
748 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
750 return US strncat(CS dst, CCS src, n);
752 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
754 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
755 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
757 return US strncpy(CS dst, CCS src, n);
759 /*XXX will likely need unchecked copy also */
762 /* Advance the string pointer given over any whitespace.
763 Return the next char as there's enough places using it to be useful. */
765 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
767 static inline uschar skip_whitespace(const uschar ** sp)
768 { while (isspace(**sp)) (*sp)++; return **sp; }
770 /* Ditto, non-whitespace */
772 #define Uskip_nonwhite(sp) skip_nonwhite(CUSS sp)
773 static inline uschar skip_nonwhite(const uschar ** sp)
774 { while (**sp && !isspace(**sp)) (*sp)++; return **sp; }
777 /******************************************************************************/
779 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
780 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
781 chown(<exim-uid>, <exim-gid>).
783 Probably because the idmapping is broken, misconfigured or set up in
784 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
785 case of misconfiguration, or if there are more such broken systems
786 out, I try to impose as least impact as possible and for now just write
787 a panic log entry pointing to the bug report. You're encouraged to
788 contact the developers, if you experience this issue.
790 fd the file descriptor (or -1 if not valid)
791 name the file name for error messages or for file operations,
796 returns 0 on success, -1 on failure */
799 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
801 return fchown(fd, owner, group)
802 ? exim_chown_failure(fd, name, owner, group) : 0;
806 exim_chown(const uschar *name, uid_t owner, gid_t group)
808 return chown(CCS name, owner, group)
809 ? exim_chown_failure(-1, name, owner, group) : 0;
811 #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
813 /******************************************************************************/
814 /* String functions */
816 #if !defined(MACRO_PREDEF)
817 /*************************************************
818 * Copy and save string *
819 *************************************************/
821 /* This function assumes that memcpy() is faster than strcpy().
822 The result is explicitly nul-terminated.
825 static inline uschar *
826 string_copyn_taint_trc(const uschar * s, unsigned len,
827 const void * proto_mem, const char * func, int line)
830 unsigned slen = Ustrlen(s);
831 if (len > slen) len = slen;
832 ss = store_get_3(len + 1, proto_mem, func, line);
838 static inline uschar *
839 string_copy_taint_trc(const uschar * s, const void * proto_mem, const char * func, int line)
840 { return string_copyn_taint_trc(s, Ustrlen(s), proto_mem, func, line); }
842 static inline uschar *
843 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
844 { return string_copyn_taint_trc(s, len, s, func, line); }
845 static inline uschar *
846 string_copy_trc(const uschar * s, const char * func, int line)
847 { return string_copy_taint_trc(s, s, func, line); }
850 /* String-copy functions explicitly setting the taint status */
852 #define string_copyn_taint(s, len, proto_mem) \
853 string_copyn_taint_trc((s), (len), (proto_mem), __FUNCTION__, __LINE__)
854 #define string_copy_taint(s, proto_mem) \
855 string_copy_taint_trc((s), (proto_mem), __FUNCTION__, __LINE__)
857 /* Simple string-copy functions maintaining the taint */
859 #define string_copyn(s, len) \
860 string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
861 #define string_copy(s) \
862 string_copy_trc((s), __FUNCTION__, __LINE__)
865 /*************************************************
866 * Copy, lowercase and save string *
867 *************************************************/
870 Argument: string to copy
871 Returns: copy of string in new store, with letters lowercased
874 static inline uschar *
875 string_copylc(const uschar * s)
877 uschar * ss = store_get(Ustrlen(s) + 1, s);
879 while (*s) *p++ = tolower(*s++);
886 /*************************************************
887 * Copy, lowercase, and save string, given length *
888 *************************************************/
890 /* It is assumed the data contains no zeros. A zero is added
895 n number of characters
897 Returns: copy of string in new store, with letters lowercased
900 static inline uschar *
901 string_copynlc(uschar * s, int n)
903 uschar * ss = store_get(n + 1, s);
905 while (n-- > 0) *p++ = tolower(*s++);
911 # ifndef COMPILE_UTILITY
912 /*************************************************
913 * Copy and save string in longterm store *
914 *************************************************/
916 /* This function assumes that memcpy() is faster than strcpy().
918 Argument: string to copy
919 Returns: copy of string in new store
922 static inline uschar *
923 string_copy_perm(const uschar *s, BOOL force_taint)
925 int old_pool = store_pool;
926 int len = Ustrlen(s) + 1;
929 store_pool = POOL_PERM;
930 ss = store_get(len, force_taint ? GET_TAINTED : s);
932 store_pool = old_pool;
939 /* sprintf into a buffer, taint-unchecked */
942 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
944 gstring gs = { .size = siz, .ptr = 0, .s = buf };
947 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
953 /******************************************************************************/
954 /* Growable-string functions */
956 /* Create a growable-string with some preassigned space */
958 #define string_get_tainted(size, proto_mem) \
959 string_get_tainted_trc((size), (proto_mem), __FUNCTION__, __LINE__)
961 static inline gstring *
962 string_get_tainted_trc(unsigned size, const void * proto_mem, const char * func, unsigned line)
964 gstring * g = store_get_3(sizeof(gstring) + size, proto_mem, func, line);
965 g->size = size; /*XXX would be good if we could see the actual alloc size */
971 #define string_get(size) \
972 string_get_trc((size), __FUNCTION__, __LINE__)
974 static inline gstring *
975 string_get_trc(unsigned size, const char * func, unsigned line)
977 return string_get_tainted_trc(size, GET_UNTAINTED, func, line);
980 /* NUL-terminate the C string in the growable-string, and return it. */
982 static inline uschar *
983 string_from_gstring(gstring * g)
991 len_string_from_gstring(gstring * g, uschar ** sp)
1006 static inline uschar *
1007 string_copy_from_gstring(gstring * g)
1009 return g ? string_copyn(g->s, g->ptr) : NULL;
1012 static inline unsigned
1013 gstring_length(const gstring * g)
1015 return g ? (unsigned)g->ptr : 0;
1018 static inline uschar
1019 gstring_last_char(gstring * g)
1021 return g->s[g->ptr-1];
1025 gstring_trim(gstring * g, unsigned amount)
1031 gstring_trim_trailing(gstring * g, uschar c)
1033 if (gstring_last_char(g) == c) gstring_trim(g, 1);
1037 gstring_reset(gstring * g)
1043 #define gstring_release_unused(g) \
1044 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
1047 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
1049 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
1053 /* sprintf-append to a growable-string */
1055 #define string_fmt_append(g, fmt, ...) \
1056 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
1057 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
1059 #define string_fmt_append_f(g, flgs, fmt, ...) \
1060 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
1061 flgs, fmt, __VA_ARGS__)
1063 static inline gstring *
1064 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
1065 unsigned flags, const char *format, ...)
1068 va_start(ap, format);
1069 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
1076 /* Copy the content of a string to tainted memory. The proto_mem arg
1077 will always be tainted, and suitable as a prototype. */
1080 gstring_rebuffer(gstring * g, const void * proto_mem)
1082 uschar * s = store_get_3(g->size, proto_mem, __FUNCTION__, __LINE__);
1083 memcpy(s, g->s, g->ptr);
1087 /* Append one gstring to another */
1088 static inline gstring *
1089 gstring_append(gstring * dest, gstring * item)
1091 return string_catn(dest, item->s, item->ptr);
1095 # ifndef COMPILE_UTILITY
1096 /******************************************************************************/
1097 /* Use store_malloc for DNSA structs, and explicit frees. Using the same pool
1098 for them as the strings we proceed to copy from them meant they could not be
1099 released, hence blowing 64k for every DNS lookup. That mounted up. With malloc
1100 we do have to take care over marking tainted all copied strings. A separate pool
1101 could be used and would handle that implicitly. */
1103 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
1105 static inline dns_answer *
1106 store_get_dns_answer_trc(const uschar * func, unsigned line)
1108 return store_malloc_3(sizeof(dns_answer), CCS func, line);
1111 #define store_free_dns_answer(dnsa) store_free_dns_answer_trc(dnsa, CUS __FUNCTION__, __LINE__)
1114 store_free_dns_answer_trc(dns_answer * dnsa, const uschar * func, unsigned line)
1116 store_free_3(dnsa, CCS func, line);
1120 /* Check for an RR being large enough. Return TRUE iff bad. */
1122 rr_bad_size(const dns_record * rr, size_t minbytes)
1124 return rr->size < minbytes;
1127 /* Check for an RR having further data beyond a given pointer.
1128 Return TRUE iff bad. */
1130 rr_bad_increment(const dns_record * rr, const uschar * ptr, size_t minbytes)
1132 return rr_bad_size(rr, ptr - rr->data + minbytes);
1135 /******************************************************************************/
1136 /* Routines with knowledge of spool layout */
1139 spool_pname_buf(uschar * buf, int len)
1141 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
1144 static inline uschar *
1145 spool_dname(const uschar * purpose, uschar * subdir)
1147 return string_sprintf("%s/%s/%s/%s",
1148 spool_directory, queue_name, purpose, subdir);
1152 static inline uschar *
1153 spool_q_sname(const uschar * purpose, const uschar * q, const uschar * subdir)
1155 return string_sprintf("%s%s%s%s%s",
1158 *subdir ? "/" : "", subdir);
1161 static inline uschar *
1162 spool_sname(const uschar * purpose, const uschar * subdir)
1164 return spool_q_sname(purpose, queue_name, subdir);
1167 static inline uschar *
1168 spool_q_fname(const uschar * purpose, const uschar * q,
1169 const uschar * subdir, const uschar * fname, const uschar * suffix)
1171 return string_sprintf("%s/%s/%s/%s/%s%s",
1172 spool_directory, q, purpose, subdir, fname, suffix);
1175 static inline uschar *
1176 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1177 const uschar * suffix)
1179 #ifdef COMPILE_UTILITY /* version avoiding string-extension */
1180 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1181 + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1182 uschar * buf = store_get(len, GET_UNTAINTED);
1183 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1184 spool_directory, queue_name, purpose, subdir, fname, suffix);
1187 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1192 set_subdir_str(uschar * subdir_str, const uschar * name,
1193 int search_sequence)
1195 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1196 ? name[MESSAGE_ID_TIME_LEN-1] : '\0';
1197 subdir_str[1] = '\0';
1200 /******************************************************************************/
1201 /* Message-ID format transition knowlege */
1204 is_new_message_id(const uschar * id)
1206 return id[MESSAGE_ID_TIME_LEN + 1 + MESSAGE_ID_PID_LEN] == '-';
1210 is_old_message_id(const uschar * id)
1212 return id[MESSAGE_ID_TIME_LEN + 1 + MESSAGE_ID_PID_LEN_OLD] == '-';
1215 static inline unsigned
1216 spool_data_start_offset(const uschar * id)
1218 if (is_old_message_id(id)) return SPOOL_DATA_START_OFFSET_OLD;
1219 return SPOOL_DATA_START_OFFSET;
1222 /******************************************************************************/
1223 /* Time calculations */
1225 /* Diff two times (later, earlier) returning diff in 1st arg */
1227 timediff(struct timeval * later, const struct timeval * earlier)
1229 later->tv_sec -= earlier->tv_sec;
1230 if ((later->tv_usec -= earlier->tv_usec) < 0)
1233 later->tv_usec += 1000*1000;
1238 timesince(struct timeval * diff, const struct timeval * then)
1240 gettimeofday(diff, NULL);
1241 timediff(diff, then);
1244 static inline uschar *
1245 string_timediff(const struct timeval * diff)
1247 static uschar buf[sizeof("0.000s")];
1249 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1250 return readconf_printtime((int)diff->tv_sec);
1252 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1257 static inline uschar *
1258 string_timesince(const struct timeval * then)
1260 struct timeval diff;
1261 timesince(&diff, then);
1262 return string_timediff(&diff);
1266 report_time_since(const struct timeval * t0, const uschar * where)
1268 # ifdef MEASURE_TIMING
1269 struct timeval diff;
1270 timesince(&diff, t0);
1271 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1272 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1278 testharness_pause_ms(int millisec)
1280 #ifndef MEASURE_TIMING
1281 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1285 /******************************************************************************/
1286 /* Taint-checked file opens */
1289 exim_open2(const char *pathname, int flags)
1291 if (!is_tainted(pathname)) return open(pathname, flags);
1292 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1297 exim_open(const char *pathname, int flags, mode_t mode)
1299 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1300 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1304 #ifdef EXIM_HAVE_OPENAT
1306 exim_openat(int dirfd, const char *pathname, int flags)
1308 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1309 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1314 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1316 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1317 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1323 static inline FILE *
1324 exim_fopen(const char *pathname, const char *mode)
1326 if (!is_tainted(pathname)) return fopen(pathname, mode);
1327 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1333 exim_opendir(const uschar * name)
1335 if (!is_tainted(name)) return opendir(CCS name);
1336 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name);
1341 /******************************************************************************/
1342 # if !defined(COMPILE_UTILITY)
1343 /* Process manipulation */
1346 exim_fork(const unsigned char * purpose)
1349 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1350 if ((pid = fork()) == 0)
1352 f.daemon_listen = FALSE;
1353 process_purpose = purpose;
1354 DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1358 testharness_pause_ms(100); /* let child work */
1359 DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1366 child_open_exim(int * fdptr, const uschar * purpose)
1367 { return child_open_exim_function(fdptr, purpose); }
1370 child_open_exim2(int * fdptr, uschar * sender,
1371 uschar * sender_auth, const uschar * purpose)
1372 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1375 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1376 int *outfdptr, BOOL make_leader, const uschar * purpose)
1377 { return child_open_function(argv, envp, newumask, infdptr,
1378 outfdptr, make_leader, purpose);
1381 /* Return 1 if fd is usable per pollbits, else 0 */
1383 poll_one_fd(int fd, short pollbits, int tmo_millisec)
1385 struct pollfd p = {.fd = fd, .events = pollbits};
1386 return poll(&p, 1, tmo_millisec);
1389 /******************************************************************************/
1390 /* Client-side smtp log string, for debug */
1393 smtp_debug_cmd(const uschar * buf, int mode)
1395 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP%c> %s\n",
1396 mode == SCMD_BUFFER ? '|' : mode == SCMD_MORE ? '+' : '>', buf);
1398 # ifndef DISABLE_CLIENT_CMD_LOG
1400 int len = Ustrcspn(buf, " \n");
1401 int old_pool = store_pool;
1402 store_pool = POOL_PERM; /* Main pool ACL allocations eg. callouts get released */
1403 client_cmd_log = string_append_listele_n(client_cmd_log, ':', buf, MIN(len, 8));
1404 if (mode == SCMD_BUFFER)
1406 client_cmd_log = string_catn(client_cmd_log, US"|", 1);
1407 (void) string_from_gstring(client_cmd_log);
1409 else if (mode == SCMD_MORE)
1411 client_cmd_log = string_catn(client_cmd_log, US"+", 1);
1412 (void) string_from_gstring(client_cmd_log);
1414 store_pool = old_pool;
1421 smtp_debug_cmd_report(void)
1423 # ifndef DISABLE_CLIENT_CMD_LOG
1424 debug_printf("cmdlog: '%s'\n", client_cmd_log ? client_cmd_log->s : US"(unset)");
1431 expand_max_rcpt(const uschar * str_max_rcpt)
1433 const uschar * s = expand_cstring(str_max_rcpt);
1435 return !s || !*s || (res = Uatoi(s)) == 0 ? UNLIMITED_ADDRS : res;
1438 /******************************************************************************/
1439 /* Queue-runner operations */
1442 is_onetime_qrun(void)
1444 return qrunners && !qrunners->next && qrunners->interval == 0;
1448 is_multiple_qrun(void)
1450 return qrunners && (qrunners->interval > 0 || qrunners->next);
1454 # endif /* !COMPILE_UTILITY */
1456 /******************************************************************************/
1457 #endif /* !MACRO_PREDEF */
1459 #endif /* _FUNCTIONS_H_ */
1463 /* End of functions.h */