1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Prototypes for functions that appear in various modules. Gathered together
10 to avoid having a lot of tiddly little headers with only a couple of lines in
11 them. However, some functions that are used (or not used) by utility programs
12 are in in fact in separate headers. */
20 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
21 uschar **) WARN_UNUSED_RESULT;
22 extern void cleanup_perl(void);
23 extern uschar *init_perl(uschar *);
29 std_dh_prime_default(void);
31 std_dh_prime_named(const uschar *);
33 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
34 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
35 extern uschar * tls_cert_issuer(void *, uschar * mod);
36 extern uschar * tls_cert_not_before(void *, uschar * mod);
37 extern uschar * tls_cert_not_after(void *, uschar * mod);
38 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
39 extern uschar * tls_cert_serial_number(void *, uschar * mod);
40 extern uschar * tls_cert_signature(void *, uschar * mod);
41 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
42 extern uschar * tls_cert_subject(void *, uschar * mod);
43 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
44 extern uschar * tls_cert_version(void *, uschar * mod);
46 extern uschar * tls_cert_der_b64(void * cert);
47 extern uschar * tls_cert_fprt_md5(void *);
48 extern uschar * tls_cert_fprt_sha1(void *);
49 extern uschar * tls_cert_fprt_sha256(void *);
51 extern void tls_clean_env(void);
52 extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
53 void *, tls_support *, uschar **);
55 extern void tls_close(void *, int);
56 extern BOOL tls_could_read(void);
57 extern void tls_daemon_init(void);
58 extern BOOL tls_dropprivs_validate_require_cipher(BOOL);
59 extern BOOL tls_export_cert(uschar *, size_t, void *);
60 extern int tls_feof(void);
61 extern int tls_ferror(void);
62 extern void tls_free_cert(void **);
63 extern int tls_getc(unsigned);
64 extern uschar *tls_getbuf(unsigned *);
65 extern void tls_get_cache(void);
66 extern BOOL tls_import_cert(const uschar *, void **);
67 extern int tls_read(void *, uschar *, size_t);
68 extern int tls_server_start(const uschar *, uschar **);
69 extern BOOL tls_smtp_buffered(void);
70 extern int tls_ungetc(int);
71 extern int tls_write(void *, const uschar *, size_t, BOOL);
72 extern uschar *tls_validate_require_cipher(void);
73 extern void tls_version_report(FILE *);
75 extern BOOL tls_openssl_options_parse(uschar *, long *);
77 extern uschar * tls_field_from_dn(uschar *, const uschar *);
78 extern BOOL tls_is_name_for_cert(const uschar *, void *);
81 extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
84 #endif /*DISABLE_TLS*/
87 /* Everything else... */
89 extern acl_block *acl_read(uschar *(*)(void), uschar **);
90 extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
91 extern int acl_eval(int, uschar *, uschar **, uschar **);
93 extern tree_node *acl_var_create(uschar *);
94 extern void acl_var_write(uschar *, uschar *, void *);
96 #ifdef EXPERIMENTAL_ARC
97 extern void *arc_ams_setup_sign_bodyhash(void);
98 extern const uschar *arc_header_feed(gstring *, BOOL);
99 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
100 extern void arc_sign_init(void);
101 extern const uschar *acl_verify_arc(void);
102 extern uschar * fn_arc_domains(void);
105 extern void assert_no_variables(void *, int, const char *, int);
106 extern int auth_call_pam(const uschar *, uschar **);
107 extern int auth_call_pwcheck(uschar *, uschar **);
108 extern int auth_call_radius(const uschar *, uschar **);
109 extern int auth_call_saslauthd(const uschar *, const uschar *,
110 const uschar *, const uschar *, uschar **);
111 extern int auth_check_serv_cond(auth_instance *);
112 extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
113 extern int auth_client_item(void *, auth_instance *, const uschar **,
114 unsigned, int, uschar *, int);
117 extern int auth_get_data(uschar **, const uschar *, int);
118 extern int auth_get_no64_data(uschar **, uschar *);
119 extern int auth_prompt(const uschar *);
120 extern int auth_read_input(const uschar *);
121 extern void auth_show_supported(FILE *);
122 extern uschar *auth_xtextencode(uschar *, int);
123 extern int auth_xtextdecode(uschar *, uschar **);
125 #ifdef EXPERIMENTAL_ARC
126 extern gstring *authres_arc(gstring *);
129 extern gstring *authres_dkim(gstring *);
132 extern gstring *authres_dmarc(gstring *);
134 extern gstring *authres_smtpauth(gstring *);
136 extern gstring *authres_spf(gstring *);
139 extern uschar *b64encode(const uschar *, int);
140 extern uschar *b64encode_taint(const uschar *, int, BOOL);
141 extern int b64decode(const uschar *, uschar **);
142 extern int bdat_getc(unsigned);
143 extern uschar *bdat_getbuf(unsigned *);
144 extern int bdat_ungetc(int);
145 extern void bdat_flush_data(void);
147 extern void bits_clear(unsigned int *, size_t, int *);
148 extern void bits_set(unsigned int *, size_t, int *);
150 extern void cancel_cutthrough_connection(BOOL, const uschar *);
151 extern int check_host(void *, const uschar *, const uschar **, uschar **);
152 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
153 extern pid_t child_open_exim_function(int *, const uschar *);
154 extern pid_t child_open_exim2_function(int *, uschar *, uschar *,
156 extern pid_t child_open_function(uschar **, uschar **, int,
157 int *, int *, BOOL, const uschar *);
158 extern pid_t child_open_uid(const uschar **, const uschar **, int,
159 uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *);
160 extern BOOL cleanup_environment(void);
161 extern void cutthrough_data_puts(uschar *, int);
162 extern void cutthrough_data_put_nl(void);
163 extern uschar *cutthrough_finaldot(void);
164 extern BOOL cutthrough_flush_send(void);
165 extern BOOL cutthrough_headers_send(void);
166 extern BOOL cutthrough_predata(void);
167 extern void release_cutthrough_connection(const uschar *);
169 extern void daemon_go(void);
171 #ifdef EXPERIMENTAL_DCC
172 extern int dcc_process(uschar **);
175 extern void debug_logging_activate(uschar *, uschar *);
176 extern void debug_logging_stop(void);
177 extern void debug_print_argv(const uschar **);
178 extern void debug_print_ids(uschar *);
179 extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
180 extern void debug_print_string(uschar *);
181 extern void debug_print_tree(tree_node *);
182 extern void debug_vprintf(int, const char *, va_list);
183 extern void decode_bits(unsigned int *, size_t, int *,
184 uschar *, bit_table *, int, uschar *, int);
185 extern void delete_pid_file(void);
186 extern address_item *deliver_make_addr(uschar *, BOOL);
187 extern void delivery_log(int, address_item *, int, uschar *);
188 extern int deliver_message(uschar *, BOOL, BOOL);
189 extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
190 extern void deliver_set_expansions(address_item *);
191 extern int deliver_split_address(address_item *);
192 extern void deliver_succeeded(address_item *);
194 extern uschar *deliver_get_sender_address (uschar *id);
195 extern void delivery_re_exec(int);
197 extern void die_tainted(const uschar *, const uschar *, int);
198 extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
200 extern uschar *dkim_exim_query_dns_txt(const uschar *);
201 extern void dkim_exim_sign_init(void);
203 extern BOOL dkim_transport_write_message(transport_ctx *,
204 struct ob_dkim *, const uschar ** errstr);
206 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
207 extern int dns_basic_lookup(dns_answer *, const uschar *, int);
208 extern uschar *dns_build_reverse(const uschar *);
209 extern time_t dns_expire_from_soa(dns_answer *, int);
210 extern void dns_init(BOOL, BOOL, BOOL);
211 extern BOOL dns_is_aa(const dns_answer *);
212 extern BOOL dns_is_secure(const dns_answer *);
213 extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
214 extern void dns_pattern_init(void);
215 extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
216 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
217 extern uschar *dns_text_type(int);
218 extern void dscp_list_to_stream(FILE *);
219 extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
221 extern void enq_end(uschar *);
222 extern BOOL enq_start(uschar *, unsigned);
223 #ifndef DISABLE_EVENT
224 extern uschar *event_raise(uschar *, const uschar *, uschar *);
225 extern void msg_event_raise(const uschar *, const address_item *);
228 extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
229 extern const uschar * exim_errstr(int);
230 extern void exim_exit(int) NORETURN;
231 extern void exim_nullstd(void);
232 extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
233 extern void exim_underbar_exit(int) NORETURN;
234 extern void exim_wait_tick(struct timeval *, int);
235 extern int exp_bool(address_item *addr,
236 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
237 uschar *svalue, BOOL *rvalue);
238 extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
239 extern uschar *expand_file_big_buffer(const uschar *);
240 extern uschar *expand_string(uschar *); /* public, cannot make const */
241 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
242 extern uschar *expand_hide_passwords(uschar * );
243 extern uschar *expand_string_copy(const uschar *);
244 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
245 extern void modify_variable(uschar *, void *);
247 extern BOOL fd_ready(int, time_t);
249 extern int filter_interpret(uschar *, int, address_item **, uschar **);
250 extern BOOL filter_personal(string_item *, BOOL);
251 extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
252 extern BOOL filter_system_interpret(address_item **, uschar **);
254 extern uschar * fn_hdrs_added(void);
256 extern void header_add(int, const char *, ...);
257 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
258 extern int header_checkname(header_line *, BOOL);
259 extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
260 extern int host_address_extract_port(uschar *);
261 extern uschar *host_and_ident(BOOL);
262 extern int host_aton(const uschar *, int *);
263 extern void host_build_hostlist(host_item **, const uschar *, BOOL);
264 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
265 extern void host_build_log_info(void);
266 extern void host_build_sender_fullhost(void);
267 extern int host_find_byname(host_item *, const uschar *, int,
268 const uschar **, BOOL);
269 extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
270 uschar *, const dnssec_domains *, const uschar **, BOOL *);
271 extern ip_address_item *host_find_interfaces(void);
272 extern BOOL host_is_in_net(const uschar *, const uschar *, int);
273 extern BOOL host_is_tls_on_connect_port(int);
274 extern int host_item_get_port(host_item *);
275 extern void host_mask(int, int *, int);
276 extern int host_name_lookup(void);
277 extern int host_nmtoa(int, int *, int, uschar *, int);
278 extern uschar *host_ntoa(int, const void *, uschar *, int *);
279 extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
281 extern uschar *imap_utf7_encode(uschar *, const uschar *,
282 uschar, uschar *, uschar **);
284 extern void invert_address(uschar *, uschar *);
285 extern int ip_addr(void *, int, const uschar *, int);
286 extern int ip_bind(int, int, uschar *, int);
287 extern int ip_connect(int, int, const uschar *, int, int, const blob *);
288 extern int ip_connectedsocket(int, const uschar *, int, int,
289 int, host_item *, uschar **, const blob *);
290 extern int ip_get_address_family(int);
291 extern void ip_keepalive(int, const uschar *, BOOL);
292 extern int ip_recv(client_conn_ctx *, uschar *, int, time_t);
293 extern int ip_socket(int, int);
295 extern int ip_tcpsocket(const uschar *, uschar **, int, host_item *);
296 extern int ip_unixsocket(const uschar *, uschar **);
297 extern int ip_streamsocket(const uschar *, uschar **, int, host_item *);
299 extern int ipv6_nmtoa(int *, uschar *);
301 extern uschar *local_part_quote(uschar *);
302 extern int log_create(uschar *);
303 extern int log_create_as_exim(uschar *);
304 extern void log_close_all(void);
306 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
307 extern BOOL macro_read_assignment(uschar *);
308 extern uschar *macros_expand(int, int *, BOOL *);
309 extern void mainlog_close(void);
310 #ifdef WITH_CONTENT_SCAN
311 extern int malware(const uschar *, int);
312 extern int malware_in_file(uschar *);
313 extern void malware_init(void);
314 extern void malware_show_supported(FILE *);
316 extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
317 unsigned int *, int, int, const uschar **);
318 extern int match_address_list_basic(const uschar *, const uschar **, int);
319 extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
320 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
321 const uschar *, const uschar **);
322 extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
323 unsigned int *, int, BOOL, const uschar **);
324 extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
326 extern void md5_end(md5 *, const uschar *, int, uschar *);
327 extern void md5_mid(md5 *, const uschar *);
328 extern void md5_start(md5 *);
329 extern void millisleep(int);
330 #ifdef WITH_CONTENT_SCAN
331 struct mime_boundary_context;
332 extern int mime_acl_check(uschar *acl, FILE *f,
333 struct mime_boundary_context *, uschar **, uschar **);
334 extern int mime_decode(const uschar **);
335 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
336 extern int mime_regex(const uschar **);
337 extern void mime_set_anomaly(int);
339 extern uschar *moan_check_errorcopy(uschar *);
340 extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
342 extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
343 extern BOOL moan_send_message(uschar *, int, error_block *eblock,
344 header_line *, FILE *, uschar *);
345 extern void moan_tell_someone(uschar *, address_item *,
346 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
347 extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
348 extern void moan_write_from(FILE *);
349 extern void moan_write_references(FILE *, uschar *);
350 extern FILE *modefopen(const uschar *, const char *, mode_t);
352 extern int open_cutthrough_connection( address_item * addr );
354 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
356 extern int parse_forward_list(uschar *, int, address_item **, uschar **,
357 const uschar *, uschar *, error_block **);
358 extern uschar *parse_find_address_end(uschar *, BOOL);
359 extern uschar *parse_find_at(uschar *);
360 extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
361 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
362 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
363 extern uschar *parse_date_time(uschar *str, time_t *t);
364 extern int vaguely_random_number(int);
366 extern int vaguely_random_number_fallback(int);
369 extern BOOL queue_action(uschar *, int, uschar **, int, int);
370 extern void queue_check_only(void);
371 extern unsigned queue_count(void);
372 extern unsigned queue_count_cached(void);
373 extern void queue_list(int, uschar **, int);
374 #ifdef EXPERIMENTAL_QUEUE_RAMP
375 extern void queue_notify_daemon(const uschar * hostname);
377 extern void queue_run(uschar *, uschar *, BOOL);
379 extern int random_number(int);
380 extern const uschar *rc_to_string(int);
381 extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
382 uschar *, uschar *, uschar *, ugid_block *, address_item **,
383 uschar **, error_block **, int *, uschar *);
384 extern int rda_is_filter(const uschar *);
385 extern BOOL readconf_depends(driver_instance *, uschar *);
386 extern void readconf_driver_init(uschar *, driver_instance **,
387 driver_info *, int, void *, int, optionlist *, int);
388 extern uschar *readconf_find_option(void *);
389 extern void readconf_main(BOOL);
390 extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
391 extern BOOL readconf_print(uschar *, uschar *, BOOL);
392 extern uschar *readconf_printtime(int);
393 extern uschar *readconf_readname(uschar *, int, uschar *);
394 extern int readconf_readtime(const uschar *, int, BOOL);
395 extern void readconf_rest(void);
396 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
397 extern void readconf_save_config(const uschar *);
398 extern void read_message_body(BOOL);
399 extern void receive_bomb_out(uschar *, uschar *) NORETURN;
400 extern BOOL receive_check_fs(int);
401 extern BOOL receive_check_set_sender(uschar *);
402 extern BOOL receive_msg(BOOL);
403 extern int_eximarith_t receive_statvfs(BOOL, int *);
404 extern void receive_swallow_smtp(void);
405 #ifdef WITH_CONTENT_SCAN
406 extern int regex(const uschar **);
408 extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
409 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
410 extern void retry_add_item(address_item *, uschar *, int);
411 extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
412 uschar **, uschar **);
413 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
414 extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
415 dbdata_retry *, time_t);
416 extern void retry_update(address_item **, address_item **, address_item **);
417 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
418 extern uschar *rewrite_address_qualify(uschar *, BOOL);
419 extern header_line *rewrite_header(header_line *,
420 const uschar *, const uschar *,
421 rewrite_rule *, int, BOOL);
422 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
424 extern void rewrite_test(uschar *);
425 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
427 extern int route_address(address_item *, address_item **, address_item **,
428 address_item **, address_item **, int);
429 extern int route_check_prefix(const uschar *, const uschar *, unsigned *);
430 extern int route_check_suffix(const uschar *, const uschar *, unsigned *);
431 extern BOOL route_findgroup(uschar *, gid_t *);
432 extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
433 extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
435 extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
436 struct passwd **, uid_t *, uschar **);
437 extern void route_init(void);
438 extern void route_show_supported(FILE *);
439 extern void route_tidyup(void);
441 extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
443 extern int search_findtype(const uschar *, int);
444 extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
446 extern void *search_open(uschar *, int, int, uid_t *, gid_t *);
447 extern void search_tidyup(void);
448 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
449 extern void sha1_end(hctx *, const uschar *, int, uschar *);
450 extern void sha1_mid(hctx *, const uschar *);
451 extern void sha1_start(hctx *);
452 extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
453 uschar *, address_item **, uschar **);
454 extern void sigalrm_handler(int);
455 extern BOOL smtp_buffered(void);
456 extern void smtp_closedown(uschar *);
457 extern void smtp_command_timeout_exit(void) NORETURN;
458 extern void smtp_command_sigterm_exit(void) NORETURN;
459 extern void smtp_data_timeout_exit(void) NORETURN;
460 extern void smtp_data_sigint_exit(void) NORETURN;
461 extern void smtp_deliver_init(void);
462 extern uschar *smtp_cmd_hist(void);
463 extern int smtp_connect(smtp_connect_args *, const blob *);
464 extern int smtp_sock_connect(host_item *, int, int, uschar *,
465 transport_instance * tb, int, const blob *);
466 extern int smtp_feof(void);
467 extern int smtp_ferror(void);
468 extern uschar *smtp_get_connection_info(void);
469 extern BOOL smtp_get_interface(uschar *, int, address_item *,
470 uschar **, uschar *);
471 extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
472 extern int smtp_getc(unsigned);
473 extern uschar *smtp_getbuf(unsigned *);
474 extern void smtp_get_cache(void);
475 extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
476 extern void smtp_log_no_mail(void);
477 extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
478 extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
479 extern BOOL smtp_read_response(void *, uschar *, int, int, int);
480 extern void *smtp_reset(void *);
481 extern void smtp_respond(uschar *, int, BOOL, uschar *);
482 extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
483 extern void smtp_port_for_connect(host_item *, int);
484 extern void smtp_send_prohibition_message(int, uschar *);
485 extern int smtp_setup_msg(void);
486 extern BOOL smtp_start_session(void);
487 extern int smtp_ungetc(int);
488 extern BOOL smtp_verify_helo(void);
489 extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
490 #ifdef WITH_CONTENT_SCAN
491 extern int spam(const uschar **);
492 extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
494 extern void spool_clear_header_globals(void);
495 extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
496 extern int spool_open_datafile(uschar *);
497 extern int spool_open_temp(uschar *);
498 extern int spool_read_header(uschar *, BOOL, BOOL);
499 extern int spool_write_header(uschar *, int, uschar **);
500 extern int stdin_getc(unsigned);
501 extern int stdin_feof(void);
502 extern int stdin_ferror(void);
503 extern int stdin_ungetc(int);
505 extern void store_exit(void);
506 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
507 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
508 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
509 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
510 extern uschar *string_base62(unsigned long int);
511 extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
512 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
513 extern int string_compare_by_pointer(const void *, const void *);
514 extern uschar *string_copy_dnsdomain(uschar *);
515 extern uschar *string_copy_malloc(const uschar *);
516 extern uschar *string_dequote(const uschar **);
517 extern uschar *string_format_size(int, uschar *);
518 extern int string_interpret_escape(const uschar **);
519 extern int string_is_ip_address(const uschar *, int *);
521 extern BOOL string_is_utf8(const uschar *);
523 extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
524 extern const uschar *string_printing2(const uschar *, BOOL);
525 extern uschar *string_split_message(uschar *);
526 extern uschar *string_unprinting(uschar *);
528 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
529 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
530 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
531 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
532 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
535 #define string_format(buf, siz, fmt, ...) \
536 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
537 extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
538 const char *, ...) ALMOST_PRINTF(5,6);
540 #define string_vformat(g, flgs, fmt, ap) \
541 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
542 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
543 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
544 unsigned, unsigned, const char *, va_list);
546 #define string_open_failed(eno, fmt, ...) \
547 string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
548 extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
549 const char *, ...) PRINTF_FUNCTION(4,5);
551 extern int strcmpic(const uschar *, const uschar *);
552 extern int strncmpic(const uschar *, const uschar *, int);
553 extern uschar *strstric(uschar *, uschar *, BOOL);
555 extern int test_harness_fudged_queue_time(int);
556 extern void tcp_init(void);
557 #ifdef EXIM_TFO_PROBE
558 extern void tfo_probe(void);
560 extern void tls_modify_variables(tls_support *);
561 extern uschar *tod_stamp(int);
563 extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
564 BOOL *, oicf, void*);
565 extern void transport_init(void);
566 extern void transport_do_pass_socket(const uschar *, const uschar *,
567 const uschar *, uschar *, int);
568 extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
570 extern uschar *transport_rcpt_address(address_item *, BOOL);
571 extern BOOL transport_set_up_command(const uschar ***, uschar *,
572 BOOL, int, address_item *, uschar *, uschar **);
573 extern void transport_update_waiting(host_item *, uschar *);
574 extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
575 extern void transport_write_reset(int);
576 extern BOOL transport_write_string(int, const char *, ...);
577 extern BOOL transport_headers_send(transport_ctx *,
578 BOOL (*)(transport_ctx *, uschar *, int));
579 extern void transport_show_supported(FILE *);
580 extern BOOL transport_write_message(transport_ctx *, int);
581 extern void tree_add_duplicate(uschar *, address_item *);
582 extern void tree_add_nonrecipient(uschar *);
583 extern void tree_add_unusable(host_item *);
584 extern void tree_dup(tree_node **, tree_node *);
585 extern int tree_insertnode(tree_node **, tree_node *);
586 extern tree_node *tree_search(tree_node *, const uschar *);
587 extern void tree_write(tree_node *, FILE *);
588 extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
590 #ifdef WITH_CONTENT_SCAN
591 extern void unspool_mbox(void);
594 extern void utf8_version_report(FILE *);
597 extern int verify_address(address_item *, FILE *, int, int, int, int,
598 uschar *, uschar *, BOOL *);
599 extern int verify_check_dnsbl(int, const uschar **, uschar **);
600 extern int verify_check_header_address(uschar **, uschar **, int, int, int,
601 uschar *, uschar *, int, int *);
602 extern int verify_check_headers(uschar **);
603 extern int verify_check_header_names_ascii(uschar **);
604 extern int verify_check_host(uschar **);
605 extern int verify_check_notblind(BOOL);
606 extern int verify_check_given_host(const uschar **, const host_item *);
607 extern int verify_check_this_host(const uschar **, unsigned int *,
608 const uschar*, const uschar *, const uschar **);
609 extern address_item *verify_checked_sender(uschar *);
610 extern void verify_get_ident(int);
611 extern BOOL verify_sender(int *, uschar **);
612 extern BOOL verify_sender_preliminary(int *, uschar **);
613 extern void version_init(void);
615 extern BOOL write_chunk(transport_ctx *, uschar *, int);
616 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
619 /******************************************************************************/
620 /* Predicate: if an address is in a tainted pool.
621 By extension, a variable pointing to this address is tainted.
625 is_tainted(const void * p)
627 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
631 extern BOOL is_tainted_fn(const void *);
632 return is_tainted_fn(p);
636 /******************************************************************************/
637 /* String functions */
638 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
640 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
641 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
643 return US strcat(CS dst, CCS src);
645 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
647 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
648 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
650 return US strcpy(CS dst, CCS src);
652 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
654 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
655 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
657 return US strncat(CS dst, CCS src, n);
659 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
661 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
662 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
664 return US strncpy(CS dst, CCS src, n);
666 /*XXX will likely need unchecked copy also */
669 /******************************************************************************/
671 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
672 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
673 chown(<exim-uid>, <exim-gid>).
675 Probably because the idmapping is broken, misconfigured or set up in
676 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
677 case of misconfiguration, or if there are more such broken systems
678 out, I try to impose as least impact as possible and for now just write
679 a panic log entry pointing to the bug report. You're encouraged to
680 contact the developers, if you experience this issue.
682 fd the file descriptor (or -1 if not valid)
683 name the file name for error messages or for file operations,
688 returns 0 on success, -1 on failure */
691 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
693 return fchown(fd, owner, group)
694 ? exim_chown_failure(fd, name, owner, group) : 0;
698 exim_chown(const uschar *name, uid_t owner, gid_t group)
700 return chown(CCS name, owner, group)
701 ? exim_chown_failure(-1, name, owner, group) : 0;
703 #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
705 /******************************************************************************/
706 /* String functions */
708 #if !defined(MACRO_PREDEF)
709 /*************************************************
710 * Copy and save string *
711 *************************************************/
713 /* This function assumes that memcpy() is faster than strcpy().
714 The result is explicitly nul-terminated.
717 static inline uschar *
718 string_copyn_taint_trc(const uschar * s, unsigned len,
719 BOOL tainted, const char * func, int line)
721 uschar * ss = store_get_3(len + 1, tainted, func, line);
727 static inline uschar *
728 string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line)
729 { return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); }
731 static inline uschar *
732 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
733 { return string_copyn_taint_trc(s, len, is_tainted(s), func, line); }
734 static inline uschar *
735 string_copy_trc(const uschar * s, const char * func, int line)
736 { return string_copy_taint_trc(s, is_tainted(s), func, line); }
739 /* String-copy functions explicitly setting the taint status */
741 #define string_copyn_taint(s, len, tainted) \
742 string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__)
743 #define string_copy_taint(s, tainted) \
744 string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__)
746 /* Simple string-copy functions maintaining the taint */
748 #define string_copyn(s, len) \
749 string_copyn_taint_trc((s), (len), is_tainted(s), __FUNCTION__, __LINE__)
750 #define string_copy(s) \
751 string_copy_taint_trc((s), is_tainted(s), __FUNCTION__, __LINE__)
754 /*************************************************
755 * Copy, lowercase and save string *
756 *************************************************/
759 Argument: string to copy
760 Returns: copy of string in new store, with letters lowercased
763 static inline uschar *
764 string_copylc(const uschar *s)
766 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
768 while (*s != 0) *p++ = tolower(*s++);
775 /*************************************************
776 * Copy, lowercase, and save string, given length *
777 *************************************************/
779 /* It is assumed the data contains no zeros. A zero is added
784 n number of characters
786 Returns: copy of string in new store, with letters lowercased
789 static inline uschar *
790 string_copynlc(uschar *s, int n)
792 uschar *ss = store_get(n + 1, is_tainted(s));
794 while (n-- > 0) *p++ = tolower(*s++);
800 # ifndef COMPILE_UTILITY
801 /*************************************************
802 * Copy and save string in longterm store *
803 *************************************************/
805 /* This function assumes that memcpy() is faster than strcpy().
807 Argument: string to copy
808 Returns: copy of string in new store
811 static inline uschar *
812 string_copy_perm(const uschar *s, BOOL force_taint)
814 int old_pool = store_pool;
815 int len = Ustrlen(s) + 1;
818 store_pool = POOL_PERM;
819 ss = store_get(len, force_taint || is_tainted(s));
821 store_pool = old_pool;
828 /* sprintf into a buffer, taint-unchecked */
831 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
833 gstring gs = { .size = siz, .ptr = 0, .s = buf };
836 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
842 /******************************************************************************/
843 /* Growable-string functions */
845 /* Create a growable-string with some preassigned space */
847 #define string_get_tainted(size, tainted) \
848 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
850 static inline gstring *
851 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
853 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
860 #define string_get(size) \
861 string_get_trc((size), __FUNCTION__, __LINE__)
863 static inline gstring *
864 string_get_trc(unsigned size, const char * func, unsigned line)
866 return string_get_tainted_trc(size, FALSE, func, line);
869 /* NUL-terminate the C string in the growable-string, and return it. */
871 static inline uschar *
872 string_from_gstring(gstring * g)
879 static inline unsigned
880 gstring_length(const gstring * g)
882 return g ? (unsigned)g->ptr : 0;
886 #define gstring_release_unused(g) \
887 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
890 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
892 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
896 /* sprintf-append to a growable-string */
898 #define string_fmt_append(g, fmt, ...) \
899 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
900 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
902 #define string_fmt_append_f(g, flgs, fmt, ...) \
903 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
904 flgs, fmt, __VA_ARGS__)
906 static inline gstring *
907 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
908 unsigned flags, const char *format, ...)
911 va_start(ap, format);
912 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
919 /* Copy the content of a string to tainted memory */
922 gstring_rebuffer(gstring * g)
924 uschar * s = store_get(g->size, TRUE);
925 memcpy(s, g->s, g->ptr);
930 /******************************************************************************/
932 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
934 static inline dns_answer *
935 store_get_dns_answer_trc(const uschar * func, unsigned line)
937 return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */
940 /******************************************************************************/
941 /* Routines with knowledge of spool layout */
943 # ifndef COMPILE_UTILITY
945 spool_pname_buf(uschar * buf, int len)
947 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
950 static inline uschar *
951 spool_dname(const uschar * purpose, uschar * subdir)
953 return string_sprintf("%s/%s/%s/%s",
954 spool_directory, queue_name, purpose, subdir);
958 static inline uschar *
959 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
961 return string_sprintf("%s%s%s%s%s",
964 *subdir ? "/" : "", subdir);
967 static inline uschar *
968 spool_sname(const uschar * purpose, uschar * subdir)
970 return spool_q_sname(purpose, queue_name, subdir);
973 static inline uschar *
974 spool_q_fname(const uschar * purpose, const uschar * q,
975 const uschar * subdir, const uschar * fname, const uschar * suffix)
977 return string_sprintf("%s/%s/%s/%s/%s%s",
978 spool_directory, q, purpose, subdir, fname, suffix);
981 static inline uschar *
982 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
983 const uschar * suffix)
985 #ifdef COMPILE_UTILITY /* version avoiding string-extension */
986 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
987 + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
988 uschar * buf = store_get(len, FALSE);
989 string_format(buf, len, "%s/%s/%s/%s/%s%s",
990 spool_directory, queue_name, purpose, subdir, fname, suffix);
993 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
998 set_subdir_str(uschar * subdir_str, const uschar * name,
1001 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1003 subdir_str[1] = '\0';
1006 /******************************************************************************/
1007 /* Time calculations */
1010 timesince(struct timeval * diff, const struct timeval * then)
1012 gettimeofday(diff, NULL);
1013 diff->tv_sec -= then->tv_sec;
1014 if ((diff->tv_usec -= then->tv_usec) < 0)
1017 diff->tv_usec += 1000*1000;
1021 static inline uschar *
1022 string_timediff(const struct timeval * diff)
1024 static uschar buf[sizeof("0.000s")];
1026 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1027 return readconf_printtime((int)diff->tv_sec);
1029 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1034 static inline uschar *
1035 string_timesince(const struct timeval * then)
1037 struct timeval diff;
1038 timesince(&diff, then);
1039 return string_timediff(&diff);
1043 report_time_since(const struct timeval * t0, const uschar * where)
1045 # ifdef MEASURE_TIMING
1046 struct timeval diff;
1047 timesince(&diff, t0);
1048 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1049 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1055 testharness_pause_ms(int millisec)
1057 #ifndef MEASURE_TIMING
1058 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1062 /******************************************************************************/
1063 /* Taint-checked file opens */
1066 exim_open2(const char *pathname, int flags)
1068 if (!is_tainted(pathname)) return open(pathname, flags);
1069 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'\n", pathname);
1074 exim_open(const char *pathname, int flags, mode_t mode)
1076 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1077 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'\n", pathname);
1082 exim_openat(int dirfd, const char *pathname, int flags)
1084 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1085 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'\n", pathname);
1090 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1092 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1093 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'\n", pathname);
1098 static inline FILE *
1099 exim_fopen(const char *pathname, const char *mode)
1101 if (!is_tainted(pathname)) return fopen(pathname, mode);
1102 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'\n", pathname);
1107 /******************************************************************************/
1108 # if !defined(COMPILE_UTILITY)
1109 /* Process manipulation */
1112 exim_fork(const unsigned char * purpose)
1115 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1116 if ((pid = fork()) == 0)
1118 process_purpose = purpose;
1119 DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1123 testharness_pause_ms(100); /* let child work */
1124 DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1131 child_open_exim(int * fdptr, const uschar * purpose)
1132 { return child_open_exim_function(fdptr, purpose); }
1135 child_open_exim2(int * fdptr, uschar * sender,
1136 uschar * sender_auth, const uschar * purpose)
1137 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1140 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1141 int *outfdptr, BOOL make_leader, const uschar * purpose)
1142 { return child_open_function(argv, envp, newumask, infdptr,
1143 outfdptr, make_leader, purpose);
1146 # endif /* !COMPILE_UTILITY */
1148 /******************************************************************************/
1149 #endif /* !MACRO_PREDEF */
1151 #endif /* _FUNCTIONS_H_ */
1155 /* End of functions.h */