1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
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. */
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. */
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 *);
31 std_dh_prime_default(void);
33 std_dh_prime_named(const uschar *);
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);
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 *);
53 extern void tls_clean_env(void);
54 extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
55 void *, tls_support *, uschar **);
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 *);
77 extern BOOL tls_openssl_options_parse(uschar *, long *);
79 extern uschar * tls_field_from_dn(uschar *, const uschar *);
80 extern BOOL tls_is_name_for_cert(const uschar *, void *);
83 extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
86 #endif /*DISABLE_TLS*/
89 /* Everything else... */
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 **);
95 extern tree_node *acl_var_create(uschar *);
96 extern void acl_var_write(uschar *, uschar *, void *);
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);
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);
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 **);
127 #ifdef EXPERIMENTAL_ARC
128 extern gstring *authres_arc(gstring *);
131 extern gstring *authres_dkim(gstring *);
134 extern gstring *authres_dmarc(gstring *);
136 extern gstring *authres_smtpauth(gstring *);
138 extern gstring *authres_spf(gstring *);
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);
149 extern void bits_clear(unsigned int *, size_t, int *);
150 extern void bits_set(unsigned int *, size_t, int *);
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 *,
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 *);
173 extern void daemon_go(void);
175 #ifdef EXPERIMENTAL_DCC
176 extern int dcc_process(uschar **);
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);
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 *);
200 extern uschar *deliver_get_sender_address (uschar *id);
201 extern void delivery_re_exec(int);
203 extern void die_tainted(const uschar *, const uschar *, int);
204 extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
206 extern uschar *dkim_exim_query_dns_txt(const uschar *);
207 extern void dkim_exim_sign_init(void);
209 extern BOOL dkim_transport_write_message(transport_ctx *,
210 struct ob_dkim *, const uschar ** errstr);
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 *);
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 *);
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 *);
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 *);
256 extern BOOL fd_ready(int, time_t);
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 **);
263 extern uschar * fn_hdrs_added(void);
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 *);
290 extern uschar *imap_utf7_encode(uschar *, const uschar *,
291 uschar, uschar *, uschar **);
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);
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 *);
308 extern int ipv6_nmtoa(int *, uschar *);
310 extern uschar *local_part_quote(uschar *);
311 extern int log_open_as_exim(uschar *);
312 extern void log_close_all(void);
314 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
315 extern BOOL macro_read_assignment(uschar *);
316 extern uschar *macros_expand(int, int *, BOOL *);
317 extern void mainlog_close(void);
318 #ifdef WITH_CONTENT_SCAN
319 extern int malware(const uschar *, int);
320 extern int malware_in_file(uschar *);
321 extern void malware_init(void);
322 extern gstring * malware_show_supported(gstring *);
324 extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
325 unsigned int *, int, int, const uschar **);
326 extern int match_address_list_basic(const uschar *, const uschar **, int);
327 extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
328 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
329 const uschar *, const uschar **);
330 extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
331 unsigned int *, int, BOOL, const uschar **);
332 extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
334 extern void md5_end(md5 *, const uschar *, int, uschar *);
335 extern void md5_mid(md5 *, const uschar *);
336 extern void md5_start(md5 *);
337 extern void millisleep(int);
338 #ifdef WITH_CONTENT_SCAN
339 struct mime_boundary_context;
340 extern int mime_acl_check(uschar *acl, FILE *f,
341 struct mime_boundary_context *, uschar **, uschar **);
342 extern int mime_decode(const uschar **);
343 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
344 extern int mime_regex(const uschar **);
345 extern void mime_set_anomaly(int);
347 extern uschar *moan_check_errorcopy(uschar *);
348 extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
350 extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
351 extern BOOL moan_send_message(uschar *, int, error_block *eblock,
352 header_line *, FILE *, uschar *);
353 extern void moan_tell_someone(uschar *, address_item *,
354 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
355 extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
356 extern void moan_write_from(FILE *);
357 extern void moan_write_references(FILE *, uschar *);
358 extern FILE *modefopen(const uschar *, const char *, mode_t);
360 extern int open_cutthrough_connection( address_item * addr );
362 extern uschar *parse_extract_address(const uschar *, uschar **, int *, int *, int *,
364 extern int parse_forward_list(uschar *, int, address_item **, uschar **,
365 const uschar *, uschar *, error_block **);
366 extern uschar *parse_find_address_end(uschar *, BOOL);
367 extern const uschar *parse_find_at(const uschar *);
368 extern const uschar *parse_fix_phrase(const uschar *, int);
369 extern const uschar *parse_message_id(const uschar *, uschar **, uschar **);
370 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, BOOL);
371 extern const uschar *parse_date_time(const uschar *str, time_t *t);
372 extern void priv_drop_temp(const uid_t, const gid_t);
373 extern void priv_restore(void);
374 extern int vaguely_random_number(int);
376 extern int vaguely_random_number_fallback(int);
379 extern BOOL queue_action(uschar *, int, uschar **, int, int);
380 extern void queue_check_only(void);
381 extern unsigned queue_count(void);
382 extern unsigned queue_count_cached(void);
383 extern void queue_list(int, uschar **, int);
384 #ifdef EXPERIMENTAL_QUEUE_RAMP
385 extern void queue_notify_daemon(const uschar * hostname);
387 extern void queue_run(uschar *, uschar *, BOOL);
389 extern int random_number(int);
390 extern const uschar *rc_to_string(int);
391 extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
392 uschar *, uschar *, uschar *, ugid_block *, address_item **,
393 uschar **, error_block **, int *, uschar *);
394 extern int rda_is_filter(const uschar *);
395 extern BOOL readconf_depends(driver_instance *, uschar *);
396 extern void readconf_driver_init(uschar *, driver_instance **,
397 driver_info *, int, void *, int, optionlist *, int);
398 extern uschar *readconf_find_option(void *);
399 extern void readconf_main(BOOL);
400 extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
401 extern BOOL readconf_print(const uschar *, uschar *, BOOL);
402 extern uschar *readconf_printtime(int);
403 extern uschar *readconf_readname(uschar *, int, uschar *);
404 extern int readconf_readtime(const uschar *, int, BOOL);
405 extern void readconf_rest(void);
406 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
407 extern void readconf_save_config(const uschar *);
408 extern void read_message_body(BOOL);
409 extern void receive_bomb_out(uschar *, uschar *) NORETURN;
410 extern BOOL receive_check_fs(int);
411 extern BOOL receive_check_set_sender(uschar *);
412 extern BOOL receive_msg(BOOL);
413 extern int_eximarith_t receive_statvfs(BOOL, int *);
414 extern void receive_swallow_smtp(void);
415 #ifdef WITH_CONTENT_SCAN
416 extern int regex(const uschar **);
418 extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
419 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
420 extern void retry_add_item(address_item *, uschar *, int);
421 extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
422 uschar **, uschar **);
423 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
424 extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
425 dbdata_retry *, time_t);
426 extern void retry_update(address_item **, address_item **, address_item **);
427 extern const uschar *rewrite_address(const uschar *, BOOL, BOOL, rewrite_rule *, int);
428 extern const uschar *rewrite_address_qualify(const uschar *, BOOL);
429 extern header_line *rewrite_header(header_line *,
430 const uschar *, const uschar *,
431 rewrite_rule *, int, BOOL);
432 extern const uschar *rewrite_one(const uschar *, int, BOOL *, BOOL, uschar *,
434 extern void rewrite_test(const uschar *);
435 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
437 extern int route_address(address_item *, address_item **, address_item **,
438 address_item **, address_item **, int);
439 extern int route_check_prefix(const uschar *, const uschar *, unsigned *);
440 extern int route_check_suffix(const uschar *, const uschar *, unsigned *);
441 extern BOOL route_findgroup(uschar *, gid_t *);
442 extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
443 extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
445 extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
446 struct passwd **, uid_t *, uschar **);
447 extern void route_init(void);
448 extern gstring * route_show_supported(gstring *);
449 extern void route_tidyup(void);
451 extern uschar *search_find(void *, const uschar *, uschar *, int,
452 const uschar *, int, int, int *, const uschar *);
453 extern int search_findtype(const uschar *, int);
454 extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
455 int *, const uschar **);
456 extern void *search_open(const uschar *, int, int, uid_t *, gid_t *);
457 extern void search_tidyup(void);
458 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
459 extern void sha1_end(hctx *, const uschar *, int, uschar *);
460 extern void sha1_mid(hctx *, const uschar *);
461 extern void sha1_start(hctx *);
462 extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
463 uschar *, address_item **, uschar **);
464 extern void sigalrm_handler(int);
465 extern BOOL smtp_buffered(void);
466 extern void smtp_closedown(uschar *);
467 extern void smtp_command_timeout_exit(void) NORETURN;
468 extern void smtp_command_sigterm_exit(void) NORETURN;
469 extern void smtp_data_timeout_exit(void) NORETURN;
470 extern void smtp_data_sigint_exit(void) NORETURN;
471 extern void smtp_deliver_init(void);
472 extern uschar *smtp_cmd_hist(void);
473 extern int smtp_connect(smtp_connect_args *, const blob *);
474 extern int smtp_sock_connect(host_item *, int, int, uschar *,
475 transport_instance * tb, int, const blob *);
476 extern int smtp_feof(void);
477 extern int smtp_ferror(void);
478 extern uschar *smtp_get_connection_info(void);
479 extern BOOL smtp_get_interface(uschar *, int, address_item *,
480 uschar **, uschar *);
481 extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
482 extern int smtp_getc(unsigned);
483 extern uschar *smtp_getbuf(unsigned *);
484 extern void smtp_get_cache(void);
485 extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
486 extern void smtp_log_no_mail(void);
487 extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
488 extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
489 extern BOOL smtp_read_response(void *, uschar *, int, int, int);
490 extern void *smtp_reset(void *);
491 extern void smtp_respond(uschar *, int, BOOL, uschar *);
492 extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
493 extern void smtp_port_for_connect(host_item *, int);
494 extern void smtp_send_prohibition_message(int, uschar *);
495 extern int smtp_setup_msg(void);
496 extern BOOL smtp_start_session(void);
497 extern int smtp_ungetc(int);
498 extern BOOL smtp_verify_helo(void);
499 extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
500 #ifdef WITH_CONTENT_SCAN
501 extern int spam(const uschar **);
502 extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
504 extern void spool_clear_header_globals(void);
505 extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
506 extern int spool_open_datafile(uschar *);
507 extern int spool_open_temp(uschar *);
508 extern int spool_read_header(uschar *, BOOL, BOOL);
509 extern int spool_write_header(uschar *, int, uschar **);
510 extern int stdin_getc(unsigned);
511 extern int stdin_feof(void);
512 extern int stdin_ferror(void);
513 extern int stdin_ungetc(int);
515 extern void store_exit(void);
516 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
517 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
518 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
519 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
520 extern uschar *string_base62(unsigned long int);
521 extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
522 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
523 extern int string_compare_by_pointer(const void *, const void *);
524 extern uschar *string_copy_dnsdomain(uschar *);
525 extern uschar *string_copy_malloc(const uschar *);
526 extern uschar *string_dequote(const uschar **);
527 extern uschar *string_format_size(int, uschar *);
528 extern int string_interpret_escape(const uschar **);
529 extern int string_is_ip_address(const uschar *, int *);
531 extern BOOL string_is_utf8(const uschar *);
533 extern const uschar *string_printing2(const uschar *, int);
534 extern uschar *string_split_message(uschar *);
535 extern uschar *string_unprinting(uschar *);
537 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
538 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
539 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
540 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
541 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
544 #define string_format(buf, siz, fmt, ...) \
545 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
546 extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
547 const char *, ...) ALMOST_PRINTF(5,6);
549 #define string_vformat(g, flgs, fmt, ap) \
550 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
551 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
552 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
553 unsigned, unsigned, const char *, va_list);
555 #define string_open_failed(eno, fmt, ...) \
556 string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
557 extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
558 const char *, ...) PRINTF_FUNCTION(4,5);
560 #define string_nextinlist(lp, sp, b, l) \
561 string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
562 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
563 const uschar * func, int line);
565 extern int strcmpic(const uschar *, const uschar *);
566 extern int strncmpic(const uschar *, const uschar *, int);
567 extern uschar *strstric(uschar *, uschar *, BOOL);
569 extern int test_harness_fudged_queue_time(int);
570 extern void tcp_init(void);
571 #ifdef EXIM_TFO_PROBE
572 extern void tfo_probe(void);
574 extern void tls_modify_variables(tls_support *);
575 extern uschar *tod_stamp(int);
577 extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
578 BOOL *, oicf, void*);
579 extern void transport_init(void);
580 extern void transport_do_pass_socket(const uschar *, const uschar *,
581 const uschar *, uschar *, int);
582 extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
584 extern uschar *transport_rcpt_address(address_item *, BOOL);
585 extern BOOL transport_set_up_command(const uschar ***, uschar *,
586 BOOL, int, address_item *, uschar *, uschar **);
587 extern void transport_update_waiting(host_item *, uschar *);
588 extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
589 extern void transport_write_reset(int);
590 extern BOOL transport_write_string(int, const char *, ...);
591 extern BOOL transport_headers_send(transport_ctx *,
592 BOOL (*)(transport_ctx *, uschar *, int));
593 extern gstring * transport_show_supported(gstring *);
594 extern BOOL transport_write_message(transport_ctx *, int);
595 extern void tree_add_duplicate(const uschar *, address_item *);
596 extern void tree_add_nonrecipient(const uschar *);
597 extern void tree_add_unusable(const host_item *);
598 extern void tree_dup(tree_node **, tree_node *);
599 extern int tree_insertnode(tree_node **, tree_node *);
600 extern tree_node *tree_search(tree_node *, const uschar *);
601 extern void tree_write(tree_node *, FILE *);
602 extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
604 #ifdef WITH_CONTENT_SCAN
605 extern void unspool_mbox(void);
608 extern void utf8_version_report(FILE *);
611 extern int verify_address(address_item *, FILE *, int, int, int, int,
612 uschar *, uschar *, BOOL *);
613 extern int verify_check_dnsbl(int, const uschar **, uschar **);
614 extern int verify_check_header_address(uschar **, uschar **, int, int, int,
615 uschar *, uschar *, int, int *);
616 extern int verify_check_headers(uschar **);
617 extern int verify_check_header_names_ascii(uschar **);
618 extern int verify_check_host(uschar **);
619 extern int verify_check_notblind(BOOL);
620 extern int verify_check_given_host(const uschar **, const host_item *);
621 extern int verify_check_this_host(const uschar **, unsigned int *,
622 const uschar*, const uschar *, const uschar **);
623 extern address_item *verify_checked_sender(uschar *);
624 extern void verify_get_ident(int);
625 extern BOOL verify_sender(int *, uschar **);
626 extern BOOL verify_sender_preliminary(int *, uschar **);
627 extern void version_init(void);
629 extern BOOL write_chunk(transport_ctx *, uschar *, int);
630 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
633 /******************************************************************************/
634 /* Predicate: if an address is in a tainted pool.
635 By extension, a variable pointing to this address is tainted.
639 is_tainted(const void * p)
641 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
645 extern BOOL is_tainted_fn(const void *);
646 return is_tainted_fn(p);
650 /******************************************************************************/
651 /* String functions */
652 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
654 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
655 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
657 return US strcat(CS dst, CCS src);
659 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
661 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
662 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
664 return US strcpy(CS dst, CCS src);
666 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
668 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
669 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
671 return US strncat(CS dst, CCS src, n);
673 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
675 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
676 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
678 return US strncpy(CS dst, CCS src, n);
680 /*XXX will likely need unchecked copy also */
683 /* Advance the string pointer given over any whitespace.
684 Return the next char as there's enought places using it to be useful. */
686 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
688 static inline uschar skip_whitespace(const uschar ** sp)
689 { while (isspace(**sp)) (*sp)++; return **sp; }
692 /******************************************************************************/
694 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
695 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
696 chown(<exim-uid>, <exim-gid>).
698 Probably because the idmapping is broken, misconfigured or set up in
699 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
700 case of misconfiguration, or if there are more such broken systems
701 out, I try to impose as least impact as possible and for now just write
702 a panic log entry pointing to the bug report. You're encouraged to
703 contact the developers, if you experience this issue.
705 fd the file descriptor (or -1 if not valid)
706 name the file name for error messages or for file operations,
711 returns 0 on success, -1 on failure */
714 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
716 return fchown(fd, owner, group)
717 ? exim_chown_failure(fd, name, owner, group) : 0;
721 exim_chown(const uschar *name, uid_t owner, gid_t group)
723 return chown(CCS name, owner, group)
724 ? exim_chown_failure(-1, name, owner, group) : 0;
726 #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
728 /******************************************************************************/
729 /* String functions */
731 #if !defined(MACRO_PREDEF)
732 /*************************************************
733 * Copy and save string *
734 *************************************************/
736 /* This function assumes that memcpy() is faster than strcpy().
737 The result is explicitly nul-terminated.
740 static inline uschar *
741 string_copyn_taint_trc(const uschar * s, unsigned len,
742 BOOL tainted, const char * func, int line)
744 uschar * ss = store_get_3(len + 1, tainted, func, line);
750 static inline uschar *
751 string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line)
752 { return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); }
754 static inline uschar *
755 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
756 { return string_copyn_taint_trc(s, len, is_tainted(s), func, line); }
757 static inline uschar *
758 string_copy_trc(const uschar * s, const char * func, int line)
759 { return string_copy_taint_trc(s, is_tainted(s), func, line); }
762 /* String-copy functions explicitly setting the taint status */
764 #define string_copyn_taint(s, len, tainted) \
765 string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__)
766 #define string_copy_taint(s, tainted) \
767 string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__)
769 /* Simple string-copy functions maintaining the taint */
771 #define string_copyn(s, len) \
772 string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
773 #define string_copy(s) \
774 string_copy_trc((s), __FUNCTION__, __LINE__)
777 /*************************************************
778 * Copy, lowercase and save string *
779 *************************************************/
782 Argument: string to copy
783 Returns: copy of string in new store, with letters lowercased
786 static inline uschar *
787 string_copylc(const uschar *s)
789 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
791 while (*s != 0) *p++ = tolower(*s++);
798 /*************************************************
799 * Copy, lowercase, and save string, given length *
800 *************************************************/
802 /* It is assumed the data contains no zeros. A zero is added
807 n number of characters
809 Returns: copy of string in new store, with letters lowercased
812 static inline uschar *
813 string_copynlc(uschar *s, int n)
815 uschar *ss = store_get(n + 1, is_tainted(s));
817 while (n-- > 0) *p++ = tolower(*s++);
823 # ifndef COMPILE_UTILITY
824 /*************************************************
825 * Copy and save string in longterm store *
826 *************************************************/
828 /* This function assumes that memcpy() is faster than strcpy().
830 Argument: string to copy
831 Returns: copy of string in new store
834 static inline uschar *
835 string_copy_perm(const uschar *s, BOOL force_taint)
837 int old_pool = store_pool;
838 int len = Ustrlen(s) + 1;
841 store_pool = POOL_PERM;
842 ss = store_get(len, force_taint || is_tainted(s));
844 store_pool = old_pool;
851 /* sprintf into a buffer, taint-unchecked */
854 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
856 gstring gs = { .size = siz, .ptr = 0, .s = buf };
859 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
865 /******************************************************************************/
866 /* Growable-string functions */
868 /* Create a growable-string with some preassigned space */
870 #define string_get_tainted(size, tainted) \
871 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
873 static inline gstring *
874 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
876 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
883 #define string_get(size) \
884 string_get_trc((size), __FUNCTION__, __LINE__)
886 static inline gstring *
887 string_get_trc(unsigned size, const char * func, unsigned line)
889 return string_get_tainted_trc(size, FALSE, func, line);
892 /* NUL-terminate the C string in the growable-string, and return it. */
894 static inline uschar *
895 string_from_gstring(gstring * g)
902 static inline unsigned
903 gstring_length(const gstring * g)
905 return g ? (unsigned)g->ptr : 0;
909 #define gstring_release_unused(g) \
910 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
913 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
915 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
919 /* sprintf-append to a growable-string */
921 #define string_fmt_append(g, fmt, ...) \
922 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
923 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
925 #define string_fmt_append_f(g, flgs, fmt, ...) \
926 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
927 flgs, fmt, __VA_ARGS__)
929 static inline gstring *
930 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
931 unsigned flags, const char *format, ...)
934 va_start(ap, format);
935 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
942 /* Copy the content of a string to tainted memory */
945 gstring_rebuffer(gstring * g)
947 uschar * s = store_get(g->size, TRUE);
948 memcpy(s, g->s, g->ptr);
953 /******************************************************************************/
955 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
957 static inline dns_answer *
958 store_get_dns_answer_trc(const uschar * func, unsigned line)
960 return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */
963 /******************************************************************************/
964 /* Routines with knowledge of spool layout */
966 # ifndef COMPILE_UTILITY
968 spool_pname_buf(uschar * buf, int len)
970 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
973 static inline uschar *
974 spool_dname(const uschar * purpose, uschar * subdir)
976 return string_sprintf("%s/%s/%s/%s",
977 spool_directory, queue_name, purpose, subdir);
981 static inline uschar *
982 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
984 return string_sprintf("%s%s%s%s%s",
987 *subdir ? "/" : "", subdir);
990 static inline uschar *
991 spool_sname(const uschar * purpose, uschar * subdir)
993 return spool_q_sname(purpose, queue_name, subdir);
996 static inline uschar *
997 spool_q_fname(const uschar * purpose, const uschar * q,
998 const uschar * subdir, const uschar * fname, const uschar * suffix)
1000 return string_sprintf("%s/%s/%s/%s/%s%s",
1001 spool_directory, q, purpose, subdir, fname, suffix);
1004 static inline uschar *
1005 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1006 const uschar * suffix)
1008 #ifdef COMPILE_UTILITY /* version avoiding string-extension */
1009 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1010 + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1011 uschar * buf = store_get(len, FALSE);
1012 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1013 spool_directory, queue_name, purpose, subdir, fname, suffix);
1016 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1021 set_subdir_str(uschar * subdir_str, const uschar * name,
1022 int search_sequence)
1024 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1026 subdir_str[1] = '\0';
1029 /******************************************************************************/
1030 /* Time calculations */
1033 timesince(struct timeval * diff, const struct timeval * then)
1035 gettimeofday(diff, NULL);
1036 diff->tv_sec -= then->tv_sec;
1037 if ((diff->tv_usec -= then->tv_usec) < 0)
1040 diff->tv_usec += 1000*1000;
1044 static inline uschar *
1045 string_timediff(const struct timeval * diff)
1047 static uschar buf[sizeof("0.000s")];
1049 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1050 return readconf_printtime((int)diff->tv_sec);
1052 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1057 static inline uschar *
1058 string_timesince(const struct timeval * then)
1060 struct timeval diff;
1061 timesince(&diff, then);
1062 return string_timediff(&diff);
1066 report_time_since(const struct timeval * t0, const uschar * where)
1068 # ifdef MEASURE_TIMING
1069 struct timeval diff;
1070 timesince(&diff, t0);
1071 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1072 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1078 testharness_pause_ms(int millisec)
1080 #ifndef MEASURE_TIMING
1081 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1085 /******************************************************************************/
1086 /* Taint-checked file opens */
1089 exim_open2(const char *pathname, int flags)
1091 if (!is_tainted(pathname)) return open(pathname, flags);
1092 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1097 exim_open(const char *pathname, int flags, mode_t mode)
1099 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1100 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1105 exim_openat(int dirfd, const char *pathname, int flags)
1107 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1108 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1113 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1115 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1116 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1121 static inline FILE *
1122 exim_fopen(const char *pathname, const char *mode)
1124 if (!is_tainted(pathname)) return fopen(pathname, mode);
1125 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1131 exim_opendir(const uschar * name)
1133 if (!is_tainted(name)) return opendir(CCS name);
1134 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name);
1139 /******************************************************************************/
1140 # if !defined(COMPILE_UTILITY)
1141 /* Process manipulation */
1144 exim_fork(const unsigned char * purpose)
1147 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1148 if ((pid = fork()) == 0)
1150 process_purpose = purpose;
1151 DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1155 testharness_pause_ms(100); /* let child work */
1156 DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1163 child_open_exim(int * fdptr, const uschar * purpose)
1164 { return child_open_exim_function(fdptr, purpose); }
1167 child_open_exim2(int * fdptr, uschar * sender,
1168 uschar * sender_auth, const uschar * purpose)
1169 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1172 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1173 int *outfdptr, BOOL make_leader, const uschar * purpose)
1174 { return child_open_function(argv, envp, newumask, infdptr,
1175 outfdptr, make_leader, purpose);
1178 # endif /* !COMPILE_UTILITY */
1180 /******************************************************************************/
1181 #endif /* !MACRO_PREDEF */
1183 #endif /* _FUNCTIONS_H_ */
1187 /* End of functions.h */