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(const 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 const uschar *parse_find_at(const uschar *);
380 extern const uschar *parse_fix_phrase(const uschar *, int);
381 extern const uschar *parse_message_id(const uschar *, uschar **, uschar **);
382 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, BOOL);
383 extern const uschar *parse_date_time(const uschar *str, time_t *t);
384 extern void priv_drop_temp(const uid_t, const gid_t);
385 extern void priv_restore(void);
386 extern int vaguely_random_number(int);
388 extern int vaguely_random_number_fallback(int);
391 extern BOOL queue_action(uschar *, int, uschar **, int, int);
392 extern void queue_check_only(void);
393 extern unsigned queue_count(void);
394 extern unsigned queue_count_cached(void);
395 extern void queue_list(int, uschar **, int);
396 #ifndef DISABLE_QUEUE_RAMP
397 extern void queue_notify_daemon(const uschar * hostname);
399 extern void queue_run(uschar *, uschar *, BOOL);
401 extern int random_number(int);
402 extern const uschar *rc_to_string(int);
403 extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
404 uschar *, uschar *, uschar *, ugid_block *, address_item **,
405 uschar **, error_block **, int *, uschar *);
406 extern int rda_is_filter(const uschar *);
407 extern BOOL readconf_depends(driver_instance *, uschar *);
408 extern void readconf_driver_init(uschar *, driver_instance **,
409 driver_info *, int, void *, int, optionlist *, int);
410 extern uschar *readconf_find_option(void *);
411 extern void readconf_main(BOOL);
412 extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
413 extern BOOL readconf_print(const uschar *, uschar *, BOOL);
414 extern uschar *readconf_printtime(int);
415 extern uschar *readconf_readname(uschar *, int, uschar *);
416 extern int readconf_readtime(const uschar *, int, BOOL);
417 extern void readconf_rest(void);
418 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
419 extern void readconf_save_config(const uschar *);
420 extern void read_message_body(BOOL);
421 extern void receive_bomb_out(uschar *, uschar *) NORETURN;
422 extern BOOL receive_check_fs(int);
423 extern BOOL receive_check_set_sender(uschar *);
424 extern BOOL receive_msg(BOOL);
425 extern int_eximarith_t receive_statvfs(BOOL, int *);
426 extern void receive_swallow_smtp(void);
427 #ifdef WITH_CONTENT_SCAN
428 extern int regex(const uschar **);
430 extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
431 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
432 extern void retry_add_item(address_item *, uschar *, int);
433 extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
434 uschar **, uschar **);
435 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
436 extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
437 dbdata_retry *, time_t);
438 extern void retry_update(address_item **, address_item **, address_item **);
439 extern const uschar *rewrite_address(const uschar *, BOOL, BOOL, rewrite_rule *, int);
440 extern const uschar *rewrite_address_qualify(const uschar *, BOOL);
441 extern header_line *rewrite_header(header_line *,
442 const uschar *, const uschar *,
443 rewrite_rule *, int, BOOL);
444 extern const uschar *rewrite_one(const uschar *, int, BOOL *, BOOL, uschar *,
446 extern void rewrite_test(const uschar *);
447 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
449 extern int route_address(address_item *, address_item **, address_item **,
450 address_item **, address_item **, int);
451 extern int route_check_prefix(const uschar *, const uschar *, unsigned *);
452 extern int route_check_suffix(const uschar *, const uschar *, unsigned *);
453 extern BOOL route_findgroup(uschar *, gid_t *);
454 extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
455 extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
457 extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
458 struct passwd **, uid_t *, uschar **);
459 extern void route_init(void);
460 extern gstring * route_show_supported(gstring *);
461 extern void route_tidyup(void);
463 extern uschar *search_args(int, uschar *, uschar *, uschar **, const uschar *);
464 extern uschar *search_find(void *, const uschar *, uschar *, int,
465 const uschar *, int, int, int *, const uschar *);
466 extern int search_findtype(const uschar *, int);
467 extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
468 int *, const uschar **);
469 extern void *search_open(const uschar *, int, int, uid_t *, gid_t *);
470 extern void search_tidyup(void);
471 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
472 extern void sha1_end(hctx *, const uschar *, int, uschar *);
473 extern void sha1_mid(hctx *, const uschar *);
474 extern void sha1_start(hctx *);
475 extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
476 uschar *, address_item **, uschar **);
477 extern void sigalrm_handler(int);
478 extern BOOL smtp_buffered(void);
479 extern void smtp_closedown(uschar *);
480 extern void smtp_command_timeout_exit(void) NORETURN;
481 extern void smtp_command_sigterm_exit(void) NORETURN;
482 extern void smtp_data_timeout_exit(void) NORETURN;
483 extern void smtp_data_sigint_exit(void) NORETURN;
484 extern void smtp_deliver_init(void);
485 extern uschar *smtp_cmd_hist(void);
486 extern int smtp_connect(smtp_connect_args *, const blob *);
487 extern int smtp_sock_connect(host_item *, int, int, uschar *,
488 transport_instance * tb, int, const blob *);
489 extern int smtp_feof(void);
490 extern int smtp_ferror(void);
491 extern uschar *smtp_get_connection_info(void);
492 extern BOOL smtp_get_interface(uschar *, int, address_item *,
493 uschar **, uschar *);
494 extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
495 extern int smtp_getc(unsigned);
496 extern uschar *smtp_getbuf(unsigned *);
497 extern void smtp_get_cache(void);
498 extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
499 extern void smtp_log_no_mail(void);
500 extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
501 extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
502 extern BOOL smtp_read_response(void *, uschar *, int, int, int);
503 extern void *smtp_reset(void *);
504 extern void smtp_respond(uschar *, int, BOOL, uschar *);
505 extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
506 extern void smtp_port_for_connect(host_item *, int);
507 extern void smtp_send_prohibition_message(int, uschar *);
508 extern int smtp_setup_msg(void);
509 extern BOOL smtp_start_session(void);
510 extern int smtp_ungetc(int);
511 extern BOOL smtp_verify_helo(void);
512 extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
513 #ifdef WITH_CONTENT_SCAN
514 extern int spam(const uschar **);
515 extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
517 extern void spool_clear_header_globals(void);
518 extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
519 extern int spool_open_datafile(uschar *);
520 extern int spool_open_temp(uschar *);
521 extern int spool_read_header(uschar *, BOOL, BOOL);
522 extern uschar *spool_sender_from_msgid(const uschar *);
523 extern int spool_write_header(uschar *, int, uschar **);
524 extern int stdin_getc(unsigned);
525 extern int stdin_feof(void);
526 extern int stdin_ferror(void);
527 extern int stdin_ungetc(int);
529 extern void store_exit(void);
530 extern void store_init(void);
532 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
533 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
534 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
535 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
536 extern uschar *string_base62(unsigned long int);
537 extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
538 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
539 extern int string_compare_by_pointer(const void *, const void *);
540 extern uschar *string_copy_dnsdomain(uschar *);
541 extern uschar *string_copy_malloc(const uschar *);
542 extern uschar *string_dequote(const uschar **);
543 extern uschar *string_format_size(int, uschar *);
544 extern int string_interpret_escape(const uschar **);
545 extern int string_is_ip_address(const uschar *, int *);
547 extern BOOL string_is_utf8(const uschar *);
549 extern const uschar *string_printing2(const uschar *, int);
550 extern uschar *string_split_message(uschar *);
551 extern uschar *string_unprinting(uschar *);
553 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
554 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
555 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
556 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
557 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
560 #define string_format(buf, siz, fmt, ...) \
561 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
562 extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
563 const char *, ...) ALMOST_PRINTF(5,6);
565 #define string_vformat(g, flgs, fmt, ap) \
566 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
567 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
568 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
569 unsigned, unsigned, const char *, va_list);
571 #define string_open_failed(fmt, ...) \
572 string_open_failed_trc(US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
573 extern uschar *string_open_failed_trc(const uschar *, unsigned,
574 const char *, ...) PRINTF_FUNCTION(3,4);
576 #define string_nextinlist(lp, sp, b, l) \
577 string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
578 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
579 const uschar * func, int line);
581 extern int strcmpic(const uschar *, const uschar *);
582 extern int strncmpic(const uschar *, const uschar *, int);
583 extern uschar *strstric(uschar *, uschar *, BOOL);
585 extern int test_harness_fudged_queue_time(int);
586 extern void tcp_init(void);
587 #ifdef EXIM_TFO_PROBE
588 extern void tfo_probe(void);
590 extern void tls_modify_variables(tls_support *);
591 extern uschar *tod_stamp(int);
593 extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
595 extern void transport_init(void);
596 extern void transport_do_pass_socket(const uschar *, const uschar *,
597 const uschar *, uschar *, int);
598 extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *, int
599 #ifdef EXPERIMENTAL_ESMTP_LIMITS
600 , unsigned, unsigned, unsigned
603 extern uschar *transport_rcpt_address(address_item *, BOOL);
604 extern BOOL transport_set_up_command(const uschar ***, uschar *,
605 BOOL, int, address_item *, uschar *, uschar **);
606 extern void transport_update_waiting(host_item *, uschar *);
607 extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
608 extern void transport_write_reset(int);
609 extern BOOL transport_write_string(int, const char *, ...);
610 extern BOOL transport_headers_send(transport_ctx *,
611 BOOL (*)(transport_ctx *, uschar *, int));
612 extern gstring * transport_show_supported(gstring *);
613 extern BOOL transport_write_message(transport_ctx *, int);
614 extern void tree_add_duplicate(const uschar *, address_item *);
615 extern void tree_add_nonrecipient(const uschar *);
616 extern void tree_add_unusable(const host_item *);
617 extern void tree_dup(tree_node **, tree_node *);
618 extern int tree_insertnode(tree_node **, tree_node *);
619 extern tree_node *tree_search(tree_node *, const uschar *);
620 extern void tree_write(tree_node *, FILE *);
621 extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
623 #ifdef WITH_CONTENT_SCAN
624 extern void unspool_mbox(void);
627 extern void utf8_version_report(FILE *);
630 extern int verify_address(address_item *, FILE *, int, int, int, int,
631 uschar *, uschar *, BOOL *);
632 extern int verify_check_dnsbl(int, const uschar **, uschar **);
633 extern int verify_check_header_address(uschar **, uschar **, int, int, int,
634 uschar *, uschar *, int, int *);
635 extern int verify_check_headers(uschar **);
636 extern int verify_check_header_names_ascii(uschar **);
637 extern int verify_check_host(uschar **);
638 extern int verify_check_notblind(BOOL);
639 extern int verify_check_given_host(const uschar **, const host_item *);
640 extern int verify_check_this_host(const uschar **, unsigned int *,
641 const uschar*, const uschar *, const uschar **);
642 extern address_item *verify_checked_sender(uschar *);
643 extern void verify_get_ident(int);
644 extern void verify_quota(uschar *);
645 extern int verify_quota_call(const uschar *, int, int, uschar **);
646 extern BOOL verify_sender(int *, uschar **);
647 extern BOOL verify_sender_preliminary(int *, uschar **);
648 extern void version_init(void);
650 extern BOOL write_chunk(transport_ctx *, uschar *, int);
651 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
654 /******************************************************************************/
655 /* Predicate: if an address is in a tainted pool.
656 By extension, a variable pointing to this address is tainted.
660 is_tainted(const void * p)
662 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
666 extern BOOL is_tainted_fn(const void *);
667 return is_tainted_fn(p);
671 /******************************************************************************/
672 /* String functions */
673 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
675 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
676 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
678 return US strcat(CS dst, CCS src);
680 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
682 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
683 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
685 return US strcpy(CS dst, CCS src);
687 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
689 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
690 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
692 return US strncat(CS dst, CCS src, n);
694 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
696 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
697 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
699 return US strncpy(CS dst, CCS src, n);
701 /*XXX will likely need unchecked copy also */
704 /* Advance the string pointer given over any whitespace.
705 Return the next char as there's enought places using it to be useful. */
707 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
709 static inline uschar skip_whitespace(const uschar ** sp)
710 { while (isspace(**sp)) (*sp)++; return **sp; }
713 /******************************************************************************/
715 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
716 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
717 chown(<exim-uid>, <exim-gid>).
719 Probably because the idmapping is broken, misconfigured or set up in
720 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
721 case of misconfiguration, or if there are more such broken systems
722 out, I try to impose as least impact as possible and for now just write
723 a panic log entry pointing to the bug report. You're encouraged to
724 contact the developers, if you experience this issue.
726 fd the file descriptor (or -1 if not valid)
727 name the file name for error messages or for file operations,
732 returns 0 on success, -1 on failure */
735 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
737 return fchown(fd, owner, group)
738 ? exim_chown_failure(fd, name, owner, group) : 0;
742 exim_chown(const uschar *name, uid_t owner, gid_t group)
744 return chown(CCS name, owner, group)
745 ? exim_chown_failure(-1, name, owner, group) : 0;
747 #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
749 /******************************************************************************/
750 /* String functions */
752 #if !defined(MACRO_PREDEF)
753 /*************************************************
754 * Copy and save string *
755 *************************************************/
757 /* This function assumes that memcpy() is faster than strcpy().
758 The result is explicitly nul-terminated.
761 static inline uschar *
762 string_copyn_taint_trc(const uschar * s, unsigned len,
763 BOOL tainted, const char * func, int line)
765 uschar * ss = store_get_3(len + 1, tainted, func, line);
771 static inline uschar *
772 string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line)
773 { return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); }
775 static inline uschar *
776 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
777 { return string_copyn_taint_trc(s, len, is_tainted(s), func, line); }
778 static inline uschar *
779 string_copy_trc(const uschar * s, const char * func, int line)
780 { return string_copy_taint_trc(s, is_tainted(s), func, line); }
783 /* String-copy functions explicitly setting the taint status */
785 #define string_copyn_taint(s, len, tainted) \
786 string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__)
787 #define string_copy_taint(s, tainted) \
788 string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__)
790 /* Simple string-copy functions maintaining the taint */
792 #define string_copyn(s, len) \
793 string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
794 #define string_copy(s) \
795 string_copy_trc((s), __FUNCTION__, __LINE__)
798 /*************************************************
799 * Copy, lowercase and save string *
800 *************************************************/
803 Argument: string to copy
804 Returns: copy of string in new store, with letters lowercased
807 static inline uschar *
808 string_copylc(const uschar *s)
810 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
812 while (*s != 0) *p++ = tolower(*s++);
819 /*************************************************
820 * Copy, lowercase, and save string, given length *
821 *************************************************/
823 /* It is assumed the data contains no zeros. A zero is added
828 n number of characters
830 Returns: copy of string in new store, with letters lowercased
833 static inline uschar *
834 string_copynlc(uschar *s, int n)
836 uschar *ss = store_get(n + 1, is_tainted(s));
838 while (n-- > 0) *p++ = tolower(*s++);
844 # ifndef COMPILE_UTILITY
845 /*************************************************
846 * Copy and save string in longterm store *
847 *************************************************/
849 /* This function assumes that memcpy() is faster than strcpy().
851 Argument: string to copy
852 Returns: copy of string in new store
855 static inline uschar *
856 string_copy_perm(const uschar *s, BOOL force_taint)
858 int old_pool = store_pool;
859 int len = Ustrlen(s) + 1;
862 store_pool = POOL_PERM;
863 ss = store_get(len, force_taint || is_tainted(s));
865 store_pool = old_pool;
872 /* sprintf into a buffer, taint-unchecked */
875 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
877 gstring gs = { .size = siz, .ptr = 0, .s = buf };
880 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
886 /******************************************************************************/
887 /* Growable-string functions */
889 /* Create a growable-string with some preassigned space */
891 #define string_get_tainted(size, tainted) \
892 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
894 static inline gstring *
895 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
897 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
904 #define string_get(size) \
905 string_get_trc((size), __FUNCTION__, __LINE__)
907 static inline gstring *
908 string_get_trc(unsigned size, const char * func, unsigned line)
910 return string_get_tainted_trc(size, FALSE, func, line);
913 /* NUL-terminate the C string in the growable-string, and return it. */
915 static inline uschar *
916 string_from_gstring(gstring * g)
923 static inline unsigned
924 gstring_length(const gstring * g)
926 return g ? (unsigned)g->ptr : 0;
930 #define gstring_release_unused(g) \
931 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
934 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
936 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
940 /* sprintf-append to a growable-string */
942 #define string_fmt_append(g, fmt, ...) \
943 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
944 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
946 #define string_fmt_append_f(g, flgs, fmt, ...) \
947 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
948 flgs, fmt, __VA_ARGS__)
950 static inline gstring *
951 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
952 unsigned flags, const char *format, ...)
955 va_start(ap, format);
956 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
963 /* Copy the content of a string to tainted memory */
966 gstring_rebuffer(gstring * g)
968 uschar * s = store_get(g->size, TRUE);
969 memcpy(s, g->s, g->ptr);
974 # ifndef COMPILE_UTILITY
975 /******************************************************************************/
976 /* Use store_malloc for DNSA structs, and explicit frees. Using the same pool
977 for them as the strings we proceed to copy from them meant they could not be
978 released, hence blowing 64k for every DNS lookup. That mounted up. With malloc
979 we do have to take care over marking tainted all copied strings. A separate pool
980 could be used and would handle that implicitly. */
982 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
984 static inline dns_answer *
985 store_get_dns_answer_trc(const uschar * func, unsigned line)
987 /* return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); use tainted mem */
988 return store_malloc_3(sizeof(dns_answer), CCS func, line);
991 #define store_free_dns_answer(dnsa) store_free_dns_answer_trc(dnsa, CUS __FUNCTION__, __LINE__)
994 store_free_dns_answer_trc(dns_answer * dnsa, const uschar * func, unsigned line)
996 store_free_3(dnsa, CCS func, line);
999 /******************************************************************************/
1000 /* Routines with knowledge of spool layout */
1003 spool_pname_buf(uschar * buf, int len)
1005 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
1008 static inline uschar *
1009 spool_dname(const uschar * purpose, uschar * subdir)
1011 return string_sprintf("%s/%s/%s/%s",
1012 spool_directory, queue_name, purpose, subdir);
1016 static inline uschar *
1017 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
1019 return string_sprintf("%s%s%s%s%s",
1022 *subdir ? "/" : "", subdir);
1025 static inline uschar *
1026 spool_sname(const uschar * purpose, uschar * subdir)
1028 return spool_q_sname(purpose, queue_name, subdir);
1031 static inline uschar *
1032 spool_q_fname(const uschar * purpose, const uschar * q,
1033 const uschar * subdir, const uschar * fname, const uschar * suffix)
1035 return string_sprintf("%s/%s/%s/%s/%s%s",
1036 spool_directory, q, purpose, subdir, fname, suffix);
1039 static inline uschar *
1040 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1041 const uschar * suffix)
1043 #ifdef COMPILE_UTILITY /* version avoiding string-extension */
1044 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1045 + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1046 uschar * buf = store_get(len, FALSE);
1047 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1048 spool_directory, queue_name, purpose, subdir, fname, suffix);
1051 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1056 set_subdir_str(uschar * subdir_str, const uschar * name,
1057 int search_sequence)
1059 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1061 subdir_str[1] = '\0';
1064 /******************************************************************************/
1065 /* Time calculations */
1067 /* Diff two times (later, earlier) returning diff in 1st arg */
1069 timediff(struct timeval * later, const struct timeval * earlier)
1071 later->tv_sec -= earlier->tv_sec;
1072 if ((later->tv_usec -= earlier->tv_usec) < 0)
1075 later->tv_usec += 1000*1000;
1080 timesince(struct timeval * diff, const struct timeval * then)
1082 gettimeofday(diff, NULL);
1083 timediff(diff, then);
1086 static inline uschar *
1087 string_timediff(const struct timeval * diff)
1089 static uschar buf[sizeof("0.000s")];
1091 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1092 return readconf_printtime((int)diff->tv_sec);
1094 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1099 static inline uschar *
1100 string_timesince(const struct timeval * then)
1102 struct timeval diff;
1103 timesince(&diff, then);
1104 return string_timediff(&diff);
1108 report_time_since(const struct timeval * t0, const uschar * where)
1110 # ifdef MEASURE_TIMING
1111 struct timeval diff;
1112 timesince(&diff, t0);
1113 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1114 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1120 testharness_pause_ms(int millisec)
1122 #ifndef MEASURE_TIMING
1123 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1127 /******************************************************************************/
1128 /* Taint-checked file opens */
1131 exim_open2(const char *pathname, int flags)
1133 if (!is_tainted(pathname)) return open(pathname, flags);
1134 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1139 exim_open(const char *pathname, int flags, mode_t mode)
1141 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1142 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1146 #ifdef EXIM_HAVE_OPENAT
1148 exim_openat(int dirfd, const char *pathname, int flags)
1150 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1151 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1156 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1158 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1159 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1165 static inline FILE *
1166 exim_fopen(const char *pathname, const char *mode)
1168 if (!is_tainted(pathname)) return fopen(pathname, mode);
1169 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1175 exim_opendir(const uschar * name)
1177 if (!is_tainted(name)) return opendir(CCS name);
1178 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name);
1183 /******************************************************************************/
1184 # if !defined(COMPILE_UTILITY)
1185 /* Process manipulation */
1188 exim_fork(const unsigned char * purpose)
1191 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1192 if ((pid = fork()) == 0)
1194 process_purpose = purpose;
1195 DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1199 testharness_pause_ms(100); /* let child work */
1200 DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1207 child_open_exim(int * fdptr, const uschar * purpose)
1208 { return child_open_exim_function(fdptr, purpose); }
1211 child_open_exim2(int * fdptr, uschar * sender,
1212 uschar * sender_auth, const uschar * purpose)
1213 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1216 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1217 int *outfdptr, BOOL make_leader, const uschar * purpose)
1218 { return child_open_function(argv, envp, newumask, infdptr,
1219 outfdptr, make_leader, purpose);
1222 # endif /* !COMPILE_UTILITY */
1224 /******************************************************************************/
1225 #endif /* !MACRO_PREDEF */
1227 #endif /* _FUNCTIONS_H_ */
1231 /* End of functions.h */