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 **);
56 extern void tls_client_creds_reload(BOOL);
58 extern void tls_close(void *, int);
59 extern BOOL tls_could_read(void);
60 extern void tls_daemon_init(void);
61 extern void tls_daemon_tick(void);
62 extern BOOL tls_dropprivs_validate_require_cipher(BOOL);
63 extern BOOL tls_export_cert(uschar *, size_t, void *);
64 extern int tls_feof(void);
65 extern int tls_ferror(void);
66 extern uschar *tls_field_from_dn(uschar *, const uschar *);
67 extern void tls_free_cert(void **);
68 extern int tls_getc(unsigned);
69 extern uschar *tls_getbuf(unsigned *);
70 extern void tls_get_cache(void);
71 extern BOOL tls_import_cert(const uschar *, void **);
72 extern BOOL tls_is_name_for_cert(const uschar *, void *);
74 extern BOOL tls_openssl_options_parse(uschar *, long *);
76 extern int tls_read(void *, uschar *, size_t);
77 extern int tls_server_start(uschar **);
78 extern void tls_shutdown_wr(void *);
79 extern BOOL tls_smtp_buffered(void);
80 extern int tls_ungetc(int);
81 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
82 extern void tls_watch_discard_event(int);
83 extern void tls_watch_invalidate(void);
85 extern int tls_write(void *, const uschar *, size_t, BOOL);
86 extern uschar *tls_validate_require_cipher(void);
87 extern void tls_version_report(FILE *);
90 extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
93 #endif /*DISABLE_TLS*/
96 /* Everything else... */
98 extern acl_block *acl_read(uschar *(*)(void), uschar **);
99 extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
100 extern int acl_eval(int, uschar *, uschar **, uschar **);
102 extern tree_node *acl_var_create(uschar *);
103 extern void acl_var_write(uschar *, uschar *, void *);
105 #ifdef EXPERIMENTAL_ARC
106 extern void *arc_ams_setup_sign_bodyhash(void);
107 extern const uschar *arc_header_feed(gstring *, BOOL);
108 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
109 extern void arc_sign_init(void);
110 extern const uschar *acl_verify_arc(void);
111 extern uschar * fn_arc_domains(void);
114 extern void assert_no_variables(void *, int, const char *, int);
115 extern int auth_call_pam(const uschar *, uschar **);
116 extern int auth_call_pwcheck(uschar *, uschar **);
117 extern int auth_call_radius(const uschar *, uschar **);
118 extern int auth_call_saslauthd(const uschar *, const uschar *,
119 const uschar *, const uschar *, uschar **);
120 extern int auth_check_serv_cond(auth_instance *);
121 extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
122 extern int auth_client_item(void *, auth_instance *, const uschar **,
123 unsigned, int, uschar *, int);
126 extern int auth_get_data(uschar **, const uschar *, int);
127 extern int auth_get_no64_data(uschar **, uschar *);
128 extern int auth_prompt(const uschar *);
129 extern int auth_read_input(const uschar *);
130 extern gstring * auth_show_supported(gstring *);
131 extern uschar *auth_xtextencode(uschar *, int);
132 extern int auth_xtextdecode(uschar *, uschar **);
134 #ifdef EXPERIMENTAL_ARC
135 extern gstring *authres_arc(gstring *);
138 extern gstring *authres_dkim(gstring *);
141 extern gstring *authres_dmarc(gstring *);
143 extern gstring *authres_smtpauth(gstring *);
145 extern gstring *authres_spf(gstring *);
148 extern uschar *b64encode(const uschar *, int);
149 extern uschar *b64encode_taint(const uschar *, int, BOOL);
150 extern int b64decode(const uschar *, uschar **);
151 extern int bdat_getc(unsigned);
152 extern uschar *bdat_getbuf(unsigned *);
153 extern int bdat_ungetc(int);
154 extern void bdat_flush_data(void);
156 extern void bits_clear(unsigned int *, size_t, int *);
157 extern void bits_set(unsigned int *, size_t, int *);
159 extern void cancel_cutthrough_connection(BOOL, const uschar *);
160 extern gstring *cat_file(FILE *, gstring *, uschar *);
161 extern gstring *cat_file_tls(void *, gstring *, uschar *);
162 extern int check_host(void *, const uschar *, const uschar **, uschar **);
163 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
164 extern pid_t child_open_exim_function(int *, const uschar *);
165 extern pid_t child_open_exim2_function(int *, uschar *, uschar *,
167 extern pid_t child_open_function(uschar **, uschar **, int,
168 int *, int *, BOOL, const uschar *);
169 extern pid_t child_open_uid(const uschar **, const uschar **, int,
170 uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *);
171 extern BOOL cleanup_environment(void);
172 extern void cutthrough_data_puts(uschar *, int);
173 extern void cutthrough_data_put_nl(void);
174 extern uschar *cutthrough_finaldot(void);
175 extern BOOL cutthrough_flush_send(void);
176 extern BOOL cutthrough_headers_send(void);
177 extern BOOL cutthrough_predata(void);
178 extern void release_cutthrough_connection(const uschar *);
180 extern void daemon_go(void);
182 #ifdef EXPERIMENTAL_DCC
183 extern int dcc_process(uschar **);
186 extern void debug_logging_activate(uschar *, uschar *);
187 extern void debug_logging_stop(void);
188 extern void debug_print_argv(const uschar **);
189 extern void debug_print_ids(uschar *);
190 extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
191 extern void debug_print_string(uschar *);
192 extern void debug_print_tree(const char *, tree_node *);
193 extern void debug_vprintf(int, const char *, va_list);
194 extern void debug_print_socket(int);
196 extern void decode_bits(unsigned int *, size_t, int *,
197 uschar *, bit_table *, int, uschar *, int);
198 extern void delete_pid_file(void);
199 extern void deliver_local(address_item *, BOOL);
200 extern address_item *deliver_make_addr(uschar *, BOOL);
201 extern void delivery_log(int, address_item *, int, uschar *);
202 extern int deliver_message(uschar *, BOOL, BOOL);
203 extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
204 extern void deliver_set_expansions(address_item *);
205 extern int deliver_split_address(address_item *);
206 extern void deliver_succeeded(address_item *);
208 extern void delivery_re_exec(int);
210 extern void die_tainted(const uschar *, const uschar *, int);
211 extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
213 extern uschar *dkim_exim_query_dns_txt(const uschar *);
214 extern void dkim_exim_sign_init(void);
216 extern BOOL dkim_transport_write_message(transport_ctx *,
217 struct ob_dkim *, const uschar ** errstr);
219 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
220 extern int dns_basic_lookup(dns_answer *, const uschar *, int);
221 extern uschar *dns_build_reverse(const uschar *);
222 extern time_t dns_expire_from_soa(dns_answer *, int);
223 extern void dns_init(BOOL, BOOL, BOOL);
224 extern BOOL dns_is_aa(const dns_answer *);
225 extern BOOL dns_is_secure(const dns_answer *);
226 extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
227 extern void dns_pattern_init(void);
228 extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
229 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
230 extern uschar *dns_text_type(int);
231 extern void dscp_list_to_stream(FILE *);
232 extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
234 extern void enq_end(uschar *);
235 extern BOOL enq_start(uschar *, unsigned);
236 #ifndef DISABLE_EVENT
237 extern uschar *event_raise(uschar *, const uschar *, uschar *);
238 extern void msg_event_raise(const uschar *, const address_item *);
241 extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
242 extern const uschar * exim_errstr(int);
243 extern void exim_exit(int) NORETURN;
244 extern void exim_gettime(struct timeval *);
245 extern void exim_nullstd(void);
246 extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
247 extern void exim_underbar_exit(int) NORETURN;
248 extern void exim_wait_tick(struct timeval *, int);
249 extern int exp_bool(address_item *addr,
250 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
251 uschar *svalue, BOOL *rvalue);
252 extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
253 extern uschar *expand_file_big_buffer(const uschar *);
254 extern uschar *expand_string(uschar *); /* public, cannot make const */
255 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
256 extern uschar *expand_getkeyed(const uschar *, const uschar *);
258 extern uschar *expand_hide_passwords(uschar * );
259 extern uschar *expand_string_copy(const uschar *);
260 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
261 extern void modify_variable(uschar *, void *);
263 extern BOOL fd_ready(int, time_t);
265 extern int filter_interpret(uschar *, int, address_item **, uschar **);
266 extern BOOL filter_personal(string_item *, BOOL);
267 extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
268 extern BOOL filter_system_interpret(address_item **, uschar **);
270 extern uschar * fn_hdrs_added(void);
271 extern void force_fd(int, int);
273 extern void header_add(int, const char *, ...);
274 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
275 extern int header_checkname(header_line *, BOOL);
276 extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
277 extern int host_address_extract_port(uschar *);
278 extern uschar *host_and_ident(BOOL);
279 extern int host_aton(const uschar *, int *);
280 extern void host_build_hostlist(host_item **, const uschar *, BOOL);
281 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
282 extern void host_build_log_info(void);
283 extern void host_build_sender_fullhost(void);
284 extern int host_find_byname(host_item *, const uschar *, int,
285 const uschar **, BOOL);
286 extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
287 uschar *, const dnssec_domains *, const uschar **, BOOL *);
288 extern ip_address_item *host_find_interfaces(void);
289 extern BOOL host_is_in_net(const uschar *, const uschar *, int);
290 extern BOOL host_is_tls_on_connect_port(int);
291 extern int host_item_get_port(host_item *);
292 extern void host_mask(int, int *, int);
293 extern int host_name_lookup(void);
294 extern int host_nmtoa(int, int *, int, uschar *, int);
295 extern uschar *host_ntoa(int, const void *, uschar *, int *);
296 extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
298 extern uschar *imap_utf7_encode(uschar *, const uschar *,
299 uschar, uschar *, uschar **);
301 extern void invert_address(uschar *, uschar *);
302 extern int ip_addr(void *, int, const uschar *, int);
303 extern int ip_bind(int, int, uschar *, int);
304 extern int ip_connect(int, int, const uschar *, int, int, const blob *);
305 extern int ip_connectedsocket(int, const uschar *, int, int,
306 int, host_item *, uschar **, const blob *);
307 extern int ip_get_address_family(int);
308 extern void ip_keepalive(int, const uschar *, BOOL);
309 extern int ip_recv(client_conn_ctx *, uschar *, int, time_t);
310 extern int ip_socket(int, int);
312 extern int ip_tcpsocket(const uschar *, uschar **, int, host_item *);
313 extern int ip_unixsocket(const uschar *, uschar **);
314 extern int ip_streamsocket(const uschar *, uschar **, int, host_item *);
316 extern int ipv6_nmtoa(int *, uschar *);
318 extern uschar *local_part_quote(uschar *);
319 extern int log_create(uschar *);
320 extern int log_create_as_exim(uschar *);
321 extern void log_close_all(void);
323 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
324 extern BOOL macro_read_assignment(uschar *);
325 extern uschar *macros_expand(int, int *, BOOL *);
326 extern void mainlog_close(void);
327 #ifdef WITH_CONTENT_SCAN
328 extern int malware(const uschar *, int);
329 extern int malware_in_file(uschar *);
330 extern void malware_init(void);
331 extern gstring * malware_show_supported(gstring *);
333 extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
334 unsigned int *, int, int, const uschar **);
335 extern int match_address_list_basic(const uschar *, const uschar **, int);
336 extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
337 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
338 const uschar *, const uschar **);
339 extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
340 unsigned int *, int, BOOL, const uschar **);
341 extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
344 extern void message_start(void);
345 extern void message_tidyup(void);
346 extern void md5_end(md5 *, const uschar *, int, uschar *);
347 extern void md5_mid(md5 *, const uschar *);
348 extern void md5_start(md5 *);
349 extern void millisleep(int);
350 #ifdef WITH_CONTENT_SCAN
351 struct mime_boundary_context;
352 extern int mime_acl_check(uschar *acl, FILE *f,
353 struct mime_boundary_context *, uschar **, uschar **);
354 extern int mime_decode(const uschar **);
355 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
356 extern int mime_regex(const uschar **);
357 extern void mime_set_anomaly(int);
359 extern uschar *moan_check_errorcopy(uschar *);
360 extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
362 extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
363 extern BOOL moan_send_message(uschar *, int, error_block *eblock,
364 header_line *, FILE *, uschar *);
365 extern void moan_tell_someone(uschar *, address_item *,
366 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
367 extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
368 extern void moan_write_from(FILE *);
369 extern void moan_write_references(FILE *, uschar *);
370 extern FILE *modefopen(const uschar *, const char *, mode_t);
372 extern int open_cutthrough_connection( address_item * addr );
374 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
376 extern int parse_forward_list(uschar *, int, address_item **, uschar **,
377 const uschar *, uschar *, error_block **);
378 extern uschar *parse_find_address_end(uschar *, BOOL);
379 extern uschar *parse_find_at(uschar *);
380 extern const uschar *parse_fix_phrase(const uschar *, int);
381 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
382 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, BOOL);
383 extern uschar *parse_date_time(uschar *str, time_t *t);
384 extern int vaguely_random_number(int);
386 extern int vaguely_random_number_fallback(int);
389 extern BOOL queue_action(uschar *, int, uschar **, int, int);
390 extern void queue_check_only(void);
391 extern unsigned queue_count(void);
392 extern unsigned queue_count_cached(void);
393 extern void queue_list(int, uschar **, int);
394 #ifndef DISABLE_QUEUE_RAMP
395 extern void queue_notify_daemon(const uschar * hostname);
397 extern void queue_run(uschar *, uschar *, BOOL);
399 extern int random_number(int);
400 extern const uschar *rc_to_string(int);
401 extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
402 uschar *, uschar *, uschar *, ugid_block *, address_item **,
403 uschar **, error_block **, int *, uschar *);
404 extern int rda_is_filter(const uschar *);
405 extern BOOL readconf_depends(driver_instance *, uschar *);
406 extern void readconf_driver_init(uschar *, driver_instance **,
407 driver_info *, int, void *, int, optionlist *, int);
408 extern uschar *readconf_find_option(void *);
409 extern void readconf_main(BOOL);
410 extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
411 extern BOOL readconf_print(uschar *, uschar *, BOOL);
412 extern uschar *readconf_printtime(int);
413 extern uschar *readconf_readname(uschar *, int, uschar *);
414 extern int readconf_readtime(const uschar *, int, BOOL);
415 extern void readconf_rest(void);
416 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
417 extern void readconf_save_config(const uschar *);
418 extern void read_message_body(BOOL);
419 extern void receive_bomb_out(uschar *, uschar *) NORETURN;
420 extern BOOL receive_check_fs(int);
421 extern BOOL receive_check_set_sender(uschar *);
422 extern BOOL receive_msg(BOOL);
423 extern int_eximarith_t receive_statvfs(BOOL, int *);
424 extern void receive_swallow_smtp(void);
425 #ifdef WITH_CONTENT_SCAN
426 extern int regex(const uschar **);
428 extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
429 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
430 extern void retry_add_item(address_item *, uschar *, int);
431 extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
432 uschar **, uschar **);
433 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
434 extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
435 dbdata_retry *, time_t);
436 extern void retry_update(address_item **, address_item **, address_item **);
437 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
438 extern uschar *rewrite_address_qualify(uschar *, BOOL);
439 extern header_line *rewrite_header(header_line *,
440 const uschar *, const uschar *,
441 rewrite_rule *, int, BOOL);
442 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
444 extern void rewrite_test(uschar *);
445 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
447 extern int route_address(address_item *, address_item **, address_item **,
448 address_item **, address_item **, int);
449 extern int route_check_prefix(const uschar *, const uschar *, unsigned *);
450 extern int route_check_suffix(const uschar *, const uschar *, unsigned *);
451 extern BOOL route_findgroup(uschar *, gid_t *);
452 extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
453 extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
455 extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
456 struct passwd **, uid_t *, uschar **);
457 extern void route_init(void);
458 extern gstring * route_show_supported(gstring *);
459 extern void route_tidyup(void);
461 extern uschar *search_args(int, uschar *, uschar *, uschar **, const uschar *);
462 extern uschar *search_find(void *, const uschar *, uschar *, int,
463 const uschar *, int, int, int *, const uschar *);
464 extern int search_findtype(const uschar *, int);
465 extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
466 int *, const uschar **);
467 extern void *search_open(const uschar *, int, int, uid_t *, gid_t *);
468 extern void search_tidyup(void);
469 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
470 extern void sha1_end(hctx *, const uschar *, int, uschar *);
471 extern void sha1_mid(hctx *, const uschar *);
472 extern void sha1_start(hctx *);
473 extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
474 uschar *, address_item **, uschar **);
475 extern void sigalrm_handler(int);
476 extern BOOL smtp_buffered(void);
477 extern void smtp_closedown(uschar *);
478 extern void smtp_command_timeout_exit(void) NORETURN;
479 extern void smtp_command_sigterm_exit(void) NORETURN;
480 extern void smtp_data_timeout_exit(void) NORETURN;
481 extern void smtp_data_sigint_exit(void) NORETURN;
482 extern void smtp_deliver_init(void);
483 extern uschar *smtp_cmd_hist(void);
484 extern int smtp_connect(smtp_connect_args *, const blob *);
485 extern int smtp_sock_connect(host_item *, int, int, uschar *,
486 transport_instance * tb, int, const blob *);
487 extern int smtp_feof(void);
488 extern int smtp_ferror(void);
489 extern uschar *smtp_get_connection_info(void);
490 extern BOOL smtp_get_interface(uschar *, int, address_item *,
491 uschar **, uschar *);
492 extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
493 extern int smtp_getc(unsigned);
494 extern uschar *smtp_getbuf(unsigned *);
495 extern void smtp_get_cache(void);
496 extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
497 extern void smtp_log_no_mail(void);
498 extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
499 extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
500 extern BOOL smtp_read_response(void *, uschar *, int, int, int);
501 extern void *smtp_reset(void *);
502 extern void smtp_respond(uschar *, int, BOOL, uschar *);
503 extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
504 extern void smtp_port_for_connect(host_item *, int);
505 extern void smtp_send_prohibition_message(int, uschar *);
506 extern int smtp_setup_msg(void);
507 extern BOOL smtp_start_session(void);
508 extern int smtp_ungetc(int);
509 extern BOOL smtp_verify_helo(void);
510 extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
511 #ifdef WITH_CONTENT_SCAN
512 extern int spam(const uschar **);
513 extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
515 extern void spool_clear_header_globals(void);
516 extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
517 extern int spool_open_datafile(uschar *);
518 extern int spool_open_temp(uschar *);
519 extern int spool_read_header(uschar *, BOOL, BOOL);
520 extern uschar *spool_sender_from_msgid(const uschar *);
521 extern int spool_write_header(uschar *, int, uschar **);
522 extern int stdin_getc(unsigned);
523 extern int stdin_feof(void);
524 extern int stdin_ferror(void);
525 extern int stdin_ungetc(int);
527 extern void store_exit(void);
528 extern void store_init(void);
530 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
531 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
532 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
533 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
534 extern uschar *string_base62(unsigned long int);
535 extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
536 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
537 extern int string_compare_by_pointer(const void *, const void *);
538 extern uschar *string_copy_dnsdomain(uschar *);
539 extern uschar *string_copy_malloc(const uschar *);
540 extern uschar *string_dequote(const uschar **);
541 extern uschar *string_format_size(int, uschar *);
542 extern int string_interpret_escape(const uschar **);
543 extern int string_is_ip_address(const uschar *, int *);
545 extern BOOL string_is_utf8(const uschar *);
547 extern const uschar *string_printing2(const uschar *, int);
548 extern uschar *string_split_message(uschar *);
549 extern uschar *string_unprinting(uschar *);
551 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
552 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
553 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
554 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
555 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
558 #define string_format(buf, siz, fmt, ...) \
559 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
560 extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
561 const char *, ...) ALMOST_PRINTF(5,6);
563 #define string_vformat(g, flgs, fmt, ap) \
564 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
565 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
566 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
567 unsigned, unsigned, const char *, va_list);
569 #define string_open_failed(fmt, ...) \
570 string_open_failed_trc(US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
571 extern uschar *string_open_failed_trc(const uschar *, unsigned,
572 const char *, ...) PRINTF_FUNCTION(3,4);
574 #define string_nextinlist(lp, sp, b, l) \
575 string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
576 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
577 const uschar * func, int line);
579 extern int strcmpic(const uschar *, const uschar *);
580 extern int strncmpic(const uschar *, const uschar *, int);
581 extern uschar *strstric(uschar *, uschar *, BOOL);
583 extern int test_harness_fudged_queue_time(int);
584 extern void tcp_init(void);
585 #ifdef EXIM_TFO_PROBE
586 extern void tfo_probe(void);
588 extern void tls_modify_variables(tls_support *);
589 extern uschar *tod_stamp(int);
591 extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
593 extern void transport_init(void);
594 extern void transport_do_pass_socket(const uschar *, const uschar *,
595 const uschar *, uschar *, int);
596 extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
598 extern uschar *transport_rcpt_address(address_item *, BOOL);
599 extern BOOL transport_set_up_command(const uschar ***, uschar *,
600 BOOL, int, address_item *, uschar *, uschar **);
601 extern void transport_update_waiting(host_item *, uschar *);
602 extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
603 extern void transport_write_reset(int);
604 extern BOOL transport_write_string(int, const char *, ...);
605 extern BOOL transport_headers_send(transport_ctx *,
606 BOOL (*)(transport_ctx *, uschar *, int));
607 extern gstring * transport_show_supported(gstring *);
608 extern BOOL transport_write_message(transport_ctx *, int);
609 extern void tree_add_duplicate(uschar *, address_item *);
610 extern void tree_add_nonrecipient(uschar *);
611 extern void tree_add_unusable(host_item *);
612 extern void tree_dup(tree_node **, tree_node *);
613 extern int tree_insertnode(tree_node **, tree_node *);
614 extern tree_node *tree_search(tree_node *, const uschar *);
615 extern void tree_write(tree_node *, FILE *);
616 extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
618 #ifdef WITH_CONTENT_SCAN
619 extern void unspool_mbox(void);
622 extern void utf8_version_report(FILE *);
625 extern int verify_address(address_item *, FILE *, int, int, int, int,
626 uschar *, uschar *, BOOL *);
627 extern int verify_check_dnsbl(int, const uschar **, uschar **);
628 extern int verify_check_header_address(uschar **, uschar **, int, int, int,
629 uschar *, uschar *, int, int *);
630 extern int verify_check_headers(uschar **);
631 extern int verify_check_header_names_ascii(uschar **);
632 extern int verify_check_host(uschar **);
633 extern int verify_check_notblind(BOOL);
634 extern int verify_check_given_host(const uschar **, const host_item *);
635 extern int verify_check_this_host(const uschar **, unsigned int *,
636 const uschar*, const uschar *, const uschar **);
637 extern address_item *verify_checked_sender(uschar *);
638 extern void verify_get_ident(int);
639 extern void verify_quota(uschar *);
640 extern int verify_quota_call(const uschar *, int, int, uschar **);
641 extern BOOL verify_sender(int *, uschar **);
642 extern BOOL verify_sender_preliminary(int *, uschar **);
643 extern void version_init(void);
645 extern BOOL write_chunk(transport_ctx *, uschar *, int);
646 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
649 /******************************************************************************/
650 /* Predicate: if an address is in a tainted pool.
651 By extension, a variable pointing to this address is tainted.
655 is_tainted(const void * p)
657 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
661 extern BOOL is_tainted_fn(const void *);
662 return is_tainted_fn(p);
666 /******************************************************************************/
667 /* String functions */
668 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
670 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
671 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
673 return US strcat(CS dst, CCS src);
675 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
677 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
678 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
680 return US strcpy(CS dst, CCS src);
682 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
684 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
685 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
687 return US strncat(CS dst, CCS src, n);
689 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
691 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
692 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
694 return US strncpy(CS dst, CCS src, n);
696 /*XXX will likely need unchecked copy also */
699 /* Advance the string pointer given over any whitespace.
700 Return the next char as there's enought places using it to be useful. */
702 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
704 static inline uschar skip_whitespace(const uschar ** sp)
705 { while (isspace(**sp)) (*sp)++; return **sp; }
708 /******************************************************************************/
710 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
711 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
712 chown(<exim-uid>, <exim-gid>).
714 Probably because the idmapping is broken, misconfigured or set up in
715 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
716 case of misconfiguration, or if there are more such broken systems
717 out, I try to impose as least impact as possible and for now just write
718 a panic log entry pointing to the bug report. You're encouraged to
719 contact the developers, if you experience this issue.
721 fd the file descriptor (or -1 if not valid)
722 name the file name for error messages or for file operations,
727 returns 0 on success, -1 on failure */
730 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
732 return fchown(fd, owner, group)
733 ? exim_chown_failure(fd, name, owner, group) : 0;
737 exim_chown(const uschar *name, uid_t owner, gid_t group)
739 return chown(CCS name, owner, group)
740 ? exim_chown_failure(-1, name, owner, group) : 0;
742 #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
744 /******************************************************************************/
745 /* String functions */
747 #if !defined(MACRO_PREDEF)
748 /*************************************************
749 * Copy and save string *
750 *************************************************/
752 /* This function assumes that memcpy() is faster than strcpy().
753 The result is explicitly nul-terminated.
756 static inline uschar *
757 string_copyn_taint_trc(const uschar * s, unsigned len,
758 BOOL tainted, const char * func, int line)
760 uschar * ss = store_get_3(len + 1, tainted, func, line);
766 static inline uschar *
767 string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line)
768 { return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); }
770 static inline uschar *
771 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
772 { return string_copyn_taint_trc(s, len, is_tainted(s), func, line); }
773 static inline uschar *
774 string_copy_trc(const uschar * s, const char * func, int line)
775 { return string_copy_taint_trc(s, is_tainted(s), func, line); }
778 /* String-copy functions explicitly setting the taint status */
780 #define string_copyn_taint(s, len, tainted) \
781 string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__)
782 #define string_copy_taint(s, tainted) \
783 string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__)
785 /* Simple string-copy functions maintaining the taint */
787 #define string_copyn(s, len) \
788 string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
789 #define string_copy(s) \
790 string_copy_trc((s), __FUNCTION__, __LINE__)
793 /*************************************************
794 * Copy, lowercase and save string *
795 *************************************************/
798 Argument: string to copy
799 Returns: copy of string in new store, with letters lowercased
802 static inline uschar *
803 string_copylc(const uschar *s)
805 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
807 while (*s != 0) *p++ = tolower(*s++);
814 /*************************************************
815 * Copy, lowercase, and save string, given length *
816 *************************************************/
818 /* It is assumed the data contains no zeros. A zero is added
823 n number of characters
825 Returns: copy of string in new store, with letters lowercased
828 static inline uschar *
829 string_copynlc(uschar *s, int n)
831 uschar *ss = store_get(n + 1, is_tainted(s));
833 while (n-- > 0) *p++ = tolower(*s++);
839 # ifndef COMPILE_UTILITY
840 /*************************************************
841 * Copy and save string in longterm store *
842 *************************************************/
844 /* This function assumes that memcpy() is faster than strcpy().
846 Argument: string to copy
847 Returns: copy of string in new store
850 static inline uschar *
851 string_copy_perm(const uschar *s, BOOL force_taint)
853 int old_pool = store_pool;
854 int len = Ustrlen(s) + 1;
857 store_pool = POOL_PERM;
858 ss = store_get(len, force_taint || is_tainted(s));
860 store_pool = old_pool;
867 /* sprintf into a buffer, taint-unchecked */
870 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
872 gstring gs = { .size = siz, .ptr = 0, .s = buf };
875 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
881 /******************************************************************************/
882 /* Growable-string functions */
884 /* Create a growable-string with some preassigned space */
886 #define string_get_tainted(size, tainted) \
887 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
889 static inline gstring *
890 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
892 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
899 #define string_get(size) \
900 string_get_trc((size), __FUNCTION__, __LINE__)
902 static inline gstring *
903 string_get_trc(unsigned size, const char * func, unsigned line)
905 return string_get_tainted_trc(size, FALSE, func, line);
908 /* NUL-terminate the C string in the growable-string, and return it. */
910 static inline uschar *
911 string_from_gstring(gstring * g)
918 static inline unsigned
919 gstring_length(const gstring * g)
921 return g ? (unsigned)g->ptr : 0;
925 #define gstring_release_unused(g) \
926 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
929 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
931 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
935 /* sprintf-append to a growable-string */
937 #define string_fmt_append(g, fmt, ...) \
938 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
939 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
941 #define string_fmt_append_f(g, flgs, fmt, ...) \
942 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
943 flgs, fmt, __VA_ARGS__)
945 static inline gstring *
946 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
947 unsigned flags, const char *format, ...)
950 va_start(ap, format);
951 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
958 /* Copy the content of a string to tainted memory */
961 gstring_rebuffer(gstring * g)
963 uschar * s = store_get(g->size, TRUE);
964 memcpy(s, g->s, g->ptr);
969 /******************************************************************************/
971 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
973 static inline dns_answer *
974 store_get_dns_answer_trc(const uschar * func, unsigned line)
976 return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */
979 /******************************************************************************/
980 /* Routines with knowledge of spool layout */
982 # ifndef COMPILE_UTILITY
984 spool_pname_buf(uschar * buf, int len)
986 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
989 static inline uschar *
990 spool_dname(const uschar * purpose, uschar * subdir)
992 return string_sprintf("%s/%s/%s/%s",
993 spool_directory, queue_name, purpose, subdir);
997 static inline uschar *
998 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
1000 return string_sprintf("%s%s%s%s%s",
1003 *subdir ? "/" : "", subdir);
1006 static inline uschar *
1007 spool_sname(const uschar * purpose, uschar * subdir)
1009 return spool_q_sname(purpose, queue_name, subdir);
1012 static inline uschar *
1013 spool_q_fname(const uschar * purpose, const uschar * q,
1014 const uschar * subdir, const uschar * fname, const uschar * suffix)
1016 return string_sprintf("%s/%s/%s/%s/%s%s",
1017 spool_directory, q, purpose, subdir, fname, suffix);
1020 static inline uschar *
1021 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1022 const uschar * suffix)
1024 #ifdef COMPILE_UTILITY /* version avoiding string-extension */
1025 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1026 + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1027 uschar * buf = store_get(len, FALSE);
1028 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1029 spool_directory, queue_name, purpose, subdir, fname, suffix);
1032 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1037 set_subdir_str(uschar * subdir_str, const uschar * name,
1038 int search_sequence)
1040 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1042 subdir_str[1] = '\0';
1045 /******************************************************************************/
1046 /* Time calculations */
1049 timesince(struct timeval * diff, const struct timeval * then)
1051 gettimeofday(diff, NULL);
1052 diff->tv_sec -= then->tv_sec;
1053 if ((diff->tv_usec -= then->tv_usec) < 0)
1056 diff->tv_usec += 1000*1000;
1060 static inline uschar *
1061 string_timediff(const struct timeval * diff)
1063 static uschar buf[sizeof("0.000s")];
1065 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1066 return readconf_printtime((int)diff->tv_sec);
1068 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1073 static inline uschar *
1074 string_timesince(const struct timeval * then)
1076 struct timeval diff;
1077 timesince(&diff, then);
1078 return string_timediff(&diff);
1082 report_time_since(const struct timeval * t0, const uschar * where)
1084 # ifdef MEASURE_TIMING
1085 struct timeval diff;
1086 timesince(&diff, t0);
1087 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1088 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1094 testharness_pause_ms(int millisec)
1096 #ifndef MEASURE_TIMING
1097 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1101 /******************************************************************************/
1102 /* Taint-checked file opens */
1105 exim_open2(const char *pathname, int flags)
1107 if (!is_tainted(pathname)) return open(pathname, flags);
1108 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1113 exim_open(const char *pathname, int flags, mode_t mode)
1115 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1116 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1120 #ifdef EXIM_HAVE_OPENAT
1122 exim_openat(int dirfd, const char *pathname, int flags)
1124 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1125 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1130 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1132 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1133 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1139 static inline FILE *
1140 exim_fopen(const char *pathname, const char *mode)
1142 if (!is_tainted(pathname)) return fopen(pathname, mode);
1143 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1149 exim_opendir(const uschar * name)
1151 if (!is_tainted(name)) return opendir(CCS name);
1152 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name);
1157 /******************************************************************************/
1158 # if !defined(COMPILE_UTILITY)
1159 /* Process manipulation */
1162 exim_fork(const unsigned char * purpose)
1165 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1166 if ((pid = fork()) == 0)
1168 process_purpose = purpose;
1169 DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1173 testharness_pause_ms(100); /* let child work */
1174 DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1181 child_open_exim(int * fdptr, const uschar * purpose)
1182 { return child_open_exim_function(fdptr, purpose); }
1185 child_open_exim2(int * fdptr, uschar * sender,
1186 uschar * sender_auth, const uschar * purpose)
1187 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1190 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1191 int *outfdptr, BOOL make_leader, const uschar * purpose)
1192 { return child_open_function(argv, envp, newumask, infdptr,
1193 outfdptr, make_leader, purpose);
1196 # endif /* !COMPILE_UTILITY */
1198 /******************************************************************************/
1199 #endif /* !MACRO_PREDEF */
1201 #endif /* _FUNCTIONS_H_ */
1205 /* End of functions.h */