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 BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
52 void *, tls_support *, uschar **);
54 extern void tls_close(void *, int);
55 extern BOOL tls_could_read(void);
56 extern void tls_daemon_init(void);
57 extern BOOL tls_dropprivs_validate_require_cipher(BOOL);
58 extern BOOL tls_export_cert(uschar *, size_t, void *);
59 extern int tls_feof(void);
60 extern int tls_ferror(void);
61 extern void tls_free_cert(void **);
62 extern int tls_getc(unsigned);
63 extern uschar *tls_getbuf(unsigned *);
64 extern void tls_get_cache(void);
65 extern BOOL tls_import_cert(const uschar *, void **);
66 extern int tls_read(void *, uschar *, size_t);
67 extern int tls_server_start(const uschar *, uschar **);
68 extern BOOL tls_smtp_buffered(void);
69 extern int tls_ungetc(int);
70 extern int tls_write(void *, const uschar *, size_t, BOOL);
71 extern uschar *tls_validate_require_cipher(void);
72 extern void tls_version_report(FILE *);
74 extern BOOL tls_openssl_options_parse(uschar *, long *);
76 extern uschar * tls_field_from_dn(uschar *, const uschar *);
77 extern BOOL tls_is_name_for_cert(const uschar *, void *);
80 extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
83 #endif /*DISABLE_TLS*/
86 /* Everything else... */
88 extern acl_block *acl_read(uschar *(*)(void), uschar **);
89 extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
90 extern int acl_eval(int, uschar *, uschar **, uschar **);
92 extern tree_node *acl_var_create(uschar *);
93 extern void acl_var_write(uschar *, uschar *, void *);
95 #ifdef EXPERIMENTAL_ARC
96 extern void *arc_ams_setup_sign_bodyhash(void);
97 extern const uschar *arc_header_feed(gstring *, BOOL);
98 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
99 extern void arc_sign_init(void);
100 extern const uschar *acl_verify_arc(void);
101 extern uschar * fn_arc_domains(void);
104 extern void assert_no_variables(void *, int, const char *, int);
105 extern int auth_call_pam(const uschar *, uschar **);
106 extern int auth_call_pwcheck(uschar *, uschar **);
107 extern int auth_call_radius(const uschar *, uschar **);
108 extern int auth_call_saslauthd(const uschar *, const uschar *,
109 const uschar *, const uschar *, uschar **);
110 extern int auth_check_serv_cond(auth_instance *);
111 extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
112 extern int auth_client_item(void *, auth_instance *, const uschar **,
113 unsigned, int, uschar *, int);
116 extern int auth_get_data(uschar **, const uschar *, int);
117 extern int auth_get_no64_data(uschar **, uschar *);
118 extern int auth_prompt(const uschar *);
119 extern int auth_read_input(const uschar *);
120 extern void auth_show_supported(FILE *);
121 extern uschar *auth_xtextencode(uschar *, int);
122 extern int auth_xtextdecode(uschar *, uschar **);
124 #ifdef EXPERIMENTAL_ARC
125 extern gstring *authres_arc(gstring *);
128 extern gstring *authres_dkim(gstring *);
131 extern gstring *authres_dmarc(gstring *);
133 extern gstring *authres_smtpauth(gstring *);
135 extern gstring *authres_spf(gstring *);
138 extern uschar *b64encode(const uschar *, int);
139 extern uschar *b64encode_taint(const uschar *, int, BOOL);
140 extern int b64decode(const uschar *, uschar **);
141 extern int bdat_getc(unsigned);
142 extern uschar *bdat_getbuf(unsigned *);
143 extern int bdat_ungetc(int);
144 extern void bdat_flush_data(void);
146 extern void bits_clear(unsigned int *, size_t, int *);
147 extern void bits_set(unsigned int *, size_t, int *);
149 extern void cancel_cutthrough_connection(BOOL, const uschar *);
150 extern int check_host(void *, const uschar *, const uschar **, uschar **);
151 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
152 extern pid_t child_open_uid(const uschar **, const uschar **, int,
153 uid_t *, gid_t *, int *, int *, uschar *, BOOL);
154 extern BOOL cleanup_environment(void);
155 extern void cutthrough_data_puts(uschar *, int);
156 extern void cutthrough_data_put_nl(void);
157 extern uschar *cutthrough_finaldot(void);
158 extern BOOL cutthrough_flush_send(void);
159 extern BOOL cutthrough_headers_send(void);
160 extern BOOL cutthrough_predata(void);
161 extern void release_cutthrough_connection(const uschar *);
163 extern void daemon_go(void);
165 #ifdef EXPERIMENTAL_DCC
166 extern int dcc_process(uschar **);
169 extern void debug_logging_activate(uschar *, uschar *);
170 extern void debug_logging_stop(void);
171 extern void debug_print_argv(const uschar **);
172 extern void debug_print_ids(uschar *);
173 extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
174 extern void debug_print_string(uschar *);
175 extern void debug_print_tree(tree_node *);
176 extern void debug_vprintf(int, const char *, va_list);
177 extern void decode_bits(unsigned int *, size_t, int *,
178 uschar *, bit_table *, int, uschar *, int);
179 extern void delete_pid_file(void);
180 extern address_item *deliver_make_addr(uschar *, BOOL);
181 extern void delivery_log(int, address_item *, int, uschar *);
182 extern int deliver_message(uschar *, BOOL, BOOL);
183 extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
184 extern void deliver_set_expansions(address_item *);
185 extern int deliver_split_address(address_item *);
186 extern void deliver_succeeded(address_item *);
188 extern uschar *deliver_get_sender_address (uschar *id);
189 extern void delivery_re_exec(int);
191 extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
193 extern uschar *dkim_exim_query_dns_txt(const uschar *);
194 extern void dkim_exim_sign_init(void);
196 extern BOOL dkim_transport_write_message(transport_ctx *,
197 struct ob_dkim *, const uschar ** errstr);
199 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
200 extern int dns_basic_lookup(dns_answer *, const uschar *, int);
201 extern void dns_build_reverse(const uschar *, uschar *);
202 extern time_t dns_expire_from_soa(dns_answer *);
203 extern void dns_init(BOOL, BOOL, BOOL);
204 extern BOOL dns_is_aa(const dns_answer *);
205 extern BOOL dns_is_secure(const dns_answer *);
206 extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
207 extern void dns_pattern_init(void);
208 extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
209 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
210 extern uschar *dns_text_type(int);
211 extern void dscp_list_to_stream(FILE *);
212 extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
214 extern void enq_end(uschar *);
215 extern BOOL enq_start(uschar *, unsigned);
216 #ifndef DISABLE_EVENT
217 extern uschar *event_raise(uschar *, const uschar *, uschar *);
218 extern void msg_event_raise(const uschar *, const address_item *);
221 extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
222 extern const uschar * exim_errstr(int);
223 extern void exim_exit(int, const uschar *) NORETURN;
224 extern void exim_nullstd(void);
225 extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
226 extern void exim_underbar_exit(int);
227 extern void exim_wait_tick(struct timeval *, int);
228 extern int exp_bool(address_item *addr,
229 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
230 uschar *svalue, BOOL *rvalue);
231 extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
232 extern uschar *expand_file_big_buffer(const uschar *);
233 extern uschar *expand_string(uschar *); /* public, cannot make const */
234 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
235 extern uschar *expand_hide_passwords(uschar * );
236 extern uschar *expand_string_copy(const uschar *);
237 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
238 extern void modify_variable(uschar *, void *);
240 extern BOOL fd_ready(int, time_t);
242 extern int filter_interpret(uschar *, int, address_item **, uschar **);
243 extern BOOL filter_personal(string_item *, BOOL);
244 extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
245 extern BOOL filter_system_interpret(address_item **, uschar **);
247 extern uschar * fn_hdrs_added(void);
249 extern void header_add(int, const char *, ...);
250 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
251 extern int header_checkname(header_line *, BOOL);
252 extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
253 extern int host_address_extract_port(uschar *);
254 extern uschar *host_and_ident(BOOL);
255 extern int host_aton(const uschar *, int *);
256 extern void host_build_hostlist(host_item **, const uschar *, BOOL);
257 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
258 extern void host_build_log_info(void);
259 extern void host_build_sender_fullhost(void);
260 extern int host_find_byname(host_item *, const uschar *, int,
261 const uschar **, BOOL);
262 extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
263 uschar *, const dnssec_domains *, const uschar **, BOOL *);
264 extern ip_address_item *host_find_interfaces(void);
265 extern BOOL host_is_in_net(const uschar *, const uschar *, int);
266 extern BOOL host_is_tls_on_connect_port(int);
267 extern int host_item_get_port(host_item *);
268 extern void host_mask(int, int *, int);
269 extern int host_name_lookup(void);
270 extern int host_nmtoa(int, int *, int, uschar *, int);
271 extern uschar *host_ntoa(int, const void *, uschar *, int *);
272 extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
274 extern uschar *imap_utf7_encode(uschar *, const uschar *,
275 uschar, uschar *, uschar **);
277 extern void invert_address(uschar *, uschar *);
278 extern int ip_addr(void *, int, const uschar *, int);
279 extern int ip_bind(int, int, uschar *, int);
280 extern int ip_connect(int, int, const uschar *, int, int, const blob *);
281 extern int ip_connectedsocket(int, const uschar *, int, int,
282 int, host_item *, uschar **, const blob *);
283 extern int ip_get_address_family(int);
284 extern void ip_keepalive(int, const uschar *, BOOL);
285 extern int ip_recv(client_conn_ctx *, uschar *, int, time_t);
286 extern int ip_socket(int, int);
288 extern int ip_tcpsocket(const uschar *, uschar **, int);
289 extern int ip_unixsocket(const uschar *, uschar **);
290 extern int ip_streamsocket(const uschar *, uschar **, int);
292 extern int ipv6_nmtoa(int *, uschar *);
294 extern uschar *local_part_quote(uschar *);
295 extern int log_create(uschar *);
296 extern int log_create_as_exim(uschar *);
297 extern void log_close_all(void);
299 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
300 extern BOOL macro_read_assignment(uschar *);
301 extern uschar *macros_expand(int, int *, BOOL *);
302 extern void mainlog_close(void);
303 #ifdef WITH_CONTENT_SCAN
304 extern int malware(const uschar *, int);
305 extern int malware_in_file(uschar *);
306 extern void malware_init(void);
307 extern void malware_show_supported(FILE *);
309 extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
310 unsigned int *, int, int, const uschar **);
311 extern int match_address_list_basic(const uschar *, const uschar **, int);
312 extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
313 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
314 const uschar *, const uschar **);
315 extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
316 unsigned int *, int, BOOL, const uschar **);
317 extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
319 extern void md5_end(md5 *, const uschar *, int, uschar *);
320 extern void md5_mid(md5 *, const uschar *);
321 extern void md5_start(md5 *);
322 extern void millisleep(int);
323 #ifdef WITH_CONTENT_SCAN
324 struct mime_boundary_context;
325 extern int mime_acl_check(uschar *acl, FILE *f,
326 struct mime_boundary_context *, uschar **, uschar **);
327 extern int mime_decode(const uschar **);
328 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
329 extern int mime_regex(const uschar **);
330 extern void mime_set_anomaly(int);
332 extern uschar *moan_check_errorcopy(uschar *);
333 extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
335 extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
336 extern BOOL moan_send_message(uschar *, int, error_block *eblock,
337 header_line *, FILE *, uschar *);
338 extern void moan_tell_someone(uschar *, address_item *,
339 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
340 extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
341 extern void moan_write_from(FILE *);
342 extern void moan_write_references(FILE *, uschar *);
343 extern FILE *modefopen(const uschar *, const char *, mode_t);
345 extern int open_cutthrough_connection( address_item * addr );
347 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
349 extern int parse_forward_list(uschar *, int, address_item **, uschar **,
350 const uschar *, uschar *, error_block **);
351 extern uschar *parse_find_address_end(uschar *, BOOL);
352 extern uschar *parse_find_at(uschar *);
353 extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
354 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
355 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
356 extern uschar *parse_date_time(uschar *str, time_t *t);
357 extern int vaguely_random_number(int);
359 extern int vaguely_random_number_fallback(int);
362 extern BOOL queue_action(uschar *, int, uschar **, int, int);
363 extern void queue_check_only(void);
364 extern void queue_list(int, uschar **, int);
365 extern void queue_count(void);
366 extern void queue_run(uschar *, uschar *, BOOL);
368 extern int random_number(int);
369 extern const uschar *rc_to_string(int);
370 extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
371 uschar *, uschar *, uschar *, ugid_block *, address_item **,
372 uschar **, error_block **, int *, uschar *);
373 extern int rda_is_filter(const uschar *);
374 extern BOOL readconf_depends(driver_instance *, uschar *);
375 extern void readconf_driver_init(uschar *, driver_instance **,
376 driver_info *, int, void *, int, optionlist *, int);
377 extern uschar *readconf_find_option(void *);
378 extern void readconf_main(BOOL);
379 extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
380 extern BOOL readconf_print(uschar *, uschar *, BOOL);
381 extern uschar *readconf_printtime(int);
382 extern uschar *readconf_readname(uschar *, int, uschar *);
383 extern int readconf_readtime(const uschar *, int, BOOL);
384 extern void readconf_rest(void);
385 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
386 extern void readconf_save_config(const uschar *);
387 extern void read_message_body(BOOL);
388 extern void receive_bomb_out(uschar *, uschar *) NORETURN;
389 extern BOOL receive_check_fs(int);
390 extern BOOL receive_check_set_sender(uschar *);
391 extern BOOL receive_msg(BOOL);
392 extern int_eximarith_t receive_statvfs(BOOL, int *);
393 extern void receive_swallow_smtp(void);
394 #ifdef WITH_CONTENT_SCAN
395 extern int regex(const uschar **);
397 extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
398 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
399 extern void retry_add_item(address_item *, uschar *, int);
400 extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
401 uschar **, uschar **);
402 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
403 extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
404 dbdata_retry *, time_t);
405 extern void retry_update(address_item **, address_item **, address_item **);
406 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
407 extern uschar *rewrite_address_qualify(uschar *, BOOL);
408 extern header_line *rewrite_header(header_line *,
409 const uschar *, const uschar *,
410 rewrite_rule *, int, BOOL);
411 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
413 extern void rewrite_test(uschar *);
414 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
416 extern int route_address(address_item *, address_item **, address_item **,
417 address_item **, address_item **, int);
418 extern int route_check_prefix(const uschar *, const uschar *);
419 extern int route_check_suffix(const uschar *, const uschar *);
420 extern BOOL route_findgroup(uschar *, gid_t *);
421 extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
422 extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
424 extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
425 struct passwd **, uid_t *, uschar **);
426 extern void route_init(void);
427 extern void route_show_supported(FILE *);
428 extern void route_tidyup(void);
430 extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
432 extern int search_findtype(const uschar *, int);
433 extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
435 extern void *search_open(uschar *, int, int, uid_t *, gid_t *);
436 extern void search_tidyup(void);
437 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
438 extern void sha1_end(hctx *, const uschar *, int, uschar *);
439 extern void sha1_mid(hctx *, const uschar *);
440 extern void sha1_start(hctx *);
441 extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
442 uschar *, address_item **, uschar **);
443 extern void sigalrm_handler(int);
444 extern BOOL smtp_buffered(void);
445 extern void smtp_closedown(uschar *);
446 extern void smtp_command_timeout_exit(void) NORETURN;
447 extern void smtp_command_sigterm_exit(void) NORETURN;
448 extern void smtp_data_timeout_exit(void) NORETURN;
449 extern void smtp_data_sigint_exit(void) NORETURN;
450 extern void smtp_deliver_init(void);
451 extern uschar *smtp_cmd_hist(void);
452 extern int smtp_connect(smtp_connect_args *, const blob *);
453 extern int smtp_sock_connect(host_item *, int, int, uschar *,
454 transport_instance * tb, int, const blob *);
455 extern int smtp_feof(void);
456 extern int smtp_ferror(void);
457 extern uschar *smtp_get_connection_info(void);
458 extern BOOL smtp_get_interface(uschar *, int, address_item *,
459 uschar **, uschar *);
460 extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
461 extern int smtp_getc(unsigned);
462 extern uschar *smtp_getbuf(unsigned *);
463 extern void smtp_get_cache(void);
464 extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
465 extern void smtp_log_no_mail(void);
466 extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
467 extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
468 extern BOOL smtp_read_response(void *, uschar *, int, int, int);
469 extern void *smtp_reset(void *);
470 extern void smtp_respond(uschar *, int, BOOL, uschar *);
471 extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
472 extern void smtp_port_for_connect(host_item *, int);
473 extern void smtp_send_prohibition_message(int, uschar *);
474 extern int smtp_setup_msg(void);
475 extern BOOL smtp_start_session(void);
476 extern int smtp_ungetc(int);
477 extern BOOL smtp_verify_helo(void);
478 extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
479 #ifdef WITH_CONTENT_SCAN
480 extern int spam(const uschar **);
481 extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
483 extern void spool_clear_header_globals(void);
484 extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
485 extern int spool_open_datafile(uschar *);
486 extern int spool_open_temp(uschar *);
487 extern int spool_read_header(uschar *, BOOL, BOOL);
488 extern int spool_write_header(uschar *, int, uschar **);
489 extern int stdin_getc(unsigned);
490 extern int stdin_feof(void);
491 extern int stdin_ferror(void);
492 extern int stdin_ungetc(int);
494 extern void store_exit(void);
495 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
496 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
497 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
498 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
499 extern uschar *string_base62(unsigned long int);
500 extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
501 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
502 extern int string_compare_by_pointer(const void *, const void *);
503 extern uschar *string_copy_dnsdomain(uschar *);
504 extern uschar *string_copy_malloc(const uschar *);
505 extern uschar *string_dequote(const uschar **);
506 extern uschar *string_format_size(int, uschar *);
507 extern int string_interpret_escape(const uschar **);
508 extern int string_is_ip_address(const uschar *, int *);
510 extern BOOL string_is_utf8(const uschar *);
512 extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
513 extern const uschar *string_printing2(const uschar *, BOOL);
514 extern uschar *string_split_message(uschar *);
515 extern uschar *string_unprinting(uschar *);
517 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
518 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
519 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
520 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
521 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
524 #define string_format(buf, siz, fmt, ...) \
525 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
526 extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
527 const char *, ...) ALMOST_PRINTF(5,6);
529 #define string_vformat(g, flgs, fmt, ap) \
530 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
531 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
532 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
533 unsigned, unsigned, const char *, va_list);
535 #define string_open_failed(eno, fmt, ...) \
536 string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
537 extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
538 const char *, ...) PRINTF_FUNCTION(4,5);
540 extern int strcmpic(const uschar *, const uschar *);
541 extern int strncmpic(const uschar *, const uschar *, int);
542 extern uschar *strstric(uschar *, uschar *, BOOL);
544 extern void tcp_init(void);
545 #ifdef EXIM_TFO_PROBE
546 extern void tfo_probe(void);
548 extern void tls_modify_variables(tls_support *);
549 extern uschar *tod_stamp(int);
551 extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
552 BOOL *, oicf, void*);
553 extern void transport_init(void);
554 extern void transport_do_pass_socket(const uschar *, const uschar *,
555 const uschar *, uschar *, int);
556 extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
558 extern uschar *transport_rcpt_address(address_item *, BOOL);
559 extern BOOL transport_set_up_command(const uschar ***, uschar *,
560 BOOL, int, address_item *, uschar *, uschar **);
561 extern void transport_update_waiting(host_item *, uschar *);
562 extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
563 extern void transport_write_reset(int);
564 extern BOOL transport_write_string(int, const char *, ...);
565 extern BOOL transport_headers_send(transport_ctx *,
566 BOOL (*)(transport_ctx *, uschar *, int));
567 extern void transport_show_supported(FILE *);
568 extern BOOL transport_write_message(transport_ctx *, int);
569 extern void tree_add_duplicate(uschar *, address_item *);
570 extern void tree_add_nonrecipient(uschar *);
571 extern void tree_add_unusable(host_item *);
572 extern void tree_dup(tree_node **, tree_node *);
573 extern int tree_insertnode(tree_node **, tree_node *);
574 extern tree_node *tree_search(tree_node *, const uschar *);
575 extern void tree_write(tree_node *, FILE *);
576 extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
578 #ifdef WITH_CONTENT_SCAN
579 extern void unspool_mbox(void);
582 extern void utf8_version_report(FILE *);
585 extern int verify_address(address_item *, FILE *, int, int, int, int,
586 uschar *, uschar *, BOOL *);
587 extern int verify_check_dnsbl(int, const uschar **, uschar **);
588 extern int verify_check_header_address(uschar **, uschar **, int, int, int,
589 uschar *, uschar *, int, int *);
590 extern int verify_check_headers(uschar **);
591 extern int verify_check_header_names_ascii(uschar **);
592 extern int verify_check_host(uschar **);
593 extern int verify_check_notblind(BOOL);
594 extern int verify_check_given_host(const uschar **, const host_item *);
595 extern int verify_check_this_host(const uschar **, unsigned int *,
596 const uschar*, const uschar *, const uschar **);
597 extern address_item *verify_checked_sender(uschar *);
598 extern void verify_get_ident(int);
599 extern BOOL verify_sender(int *, uschar **);
600 extern BOOL verify_sender_preliminary(int *, uschar **);
601 extern void version_init(void);
603 extern BOOL write_chunk(transport_ctx *, uschar *, int);
604 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
607 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
608 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
609 chown(<exim-uid>, <exim-gid>).
611 Probably because the idmapping is broken, misconfigured or set up in
612 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
613 case of misconfiguration, or if there are more such broken systems
614 out, I try to impose as least impact as possible and for now just write
615 a panic log entry pointing to the bug report. You're encouraged to
616 contact the developers, if you experience this issue.
618 fd the file descriptor (or -1 if not valid)
619 name the file name for error messages or for file operations,
624 returns 0 on success, -1 on failure */
627 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
629 return fchown(fd, owner, group)
630 ? exim_chown_failure(fd, name, owner, group) : 0;
634 exim_chown(const uschar *name, uid_t owner, gid_t group)
636 return chown(CCS name, owner, group)
637 ? exim_chown_failure(-1, name, owner, group) : 0;
640 #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
641 /******************************************************************************/
642 /* String functions */
644 #if !defined(MACRO_PREDEF)
645 /*************************************************
646 * Copy and save string *
647 *************************************************/
649 /* This function assumes that memcpy() is faster than strcpy().
652 static inline uschar *
653 string_copy_taint_trc(const uschar *s, BOOL tainted, const char * func, int line)
655 int len = Ustrlen(s) + 1;
656 uschar *ss = store_get_3(len, tainted, func, line);
661 #define string_copy_taint(s, tainted) \
662 string_copy_taint_trc((s), tainted, __FUNCTION__, __LINE__)
664 static inline uschar *
665 string_copy(const uschar * s)
667 return string_copy_taint((s), is_tainted(s));
671 /*************************************************
672 * Copy, lowercase and save string *
673 *************************************************/
676 Argument: string to copy
677 Returns: copy of string in new store, with letters lowercased
680 static inline uschar *
681 string_copylc(const uschar *s)
683 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
685 while (*s != 0) *p++ = tolower(*s++);
692 /*************************************************
693 * Copy and save string, given length *
694 *************************************************/
696 /* It is assumed the data contains no zeros. A zero is added
701 n number of characters
703 Returns: copy of string in new store
705 This is an API for local_scan hence not static.
708 static inline uschar *
709 string_copyn(const uschar *s, int n)
711 uschar *ss = store_get(n + 1, is_tainted(s));
717 /*************************************************
718 * Copy, lowercase, and save string, given length *
719 *************************************************/
721 /* It is assumed the data contains no zeros. A zero is added
726 n number of characters
728 Returns: copy of string in new store, with letters lowercased
731 static inline uschar *
732 string_copynlc(uschar *s, int n)
734 uschar *ss = store_get(n + 1, is_tainted(s));
736 while (n-- > 0) *p++ = tolower(*s++);
742 # ifndef COMPILE_UTILITY
743 /*************************************************
744 * Copy and save string in longterm store *
745 *************************************************/
747 /* This function assumes that memcpy() is faster than strcpy().
749 Argument: string to copy
750 Returns: copy of string in new store
753 static inline uschar *
754 string_copy_perm(const uschar *s, BOOL force_taint)
756 int old_pool = store_pool;
757 int len = Ustrlen(s) + 1;
760 store_pool = POOL_PERM;
761 ss = store_get(len, force_taint || is_tainted(s));
763 store_pool = old_pool;
770 /* sprintf into a buffer, taint-unchecked */
773 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
775 gstring gs = { .size = siz, .ptr = 0, .s = buf };
778 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
784 /******************************************************************************/
785 /* Growable-string functions */
787 /* Create a growable-string with some preassigned space */
789 #define string_get_tainted(size, tainted) \
790 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
792 static inline gstring *
793 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
795 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
802 #define string_get(size) \
803 string_get_trc((size), __FUNCTION__, __LINE__)
805 static inline gstring *
806 string_get_trc(unsigned size, const char * func, unsigned line)
808 return string_get_tainted_trc(size, FALSE, func, line);
811 /* NUL-terminate the C string in the growable-string, and return it. */
813 static inline uschar *
814 string_from_gstring(gstring * g)
822 #define gstring_release_unused(g) \
823 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
826 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
828 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
832 /* sprintf-append to a growable-string */
834 #define string_fmt_append(g, fmt, ...) \
835 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
836 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
838 #define string_fmt_append_f(g, flgs, fmt, ...) \
839 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
840 flgs, fmt, __VA_ARGS__)
842 static inline gstring *
843 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
844 unsigned flags, const char *format, ...)
847 va_start(ap, format);
848 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
854 /******************************************************************************/
856 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
858 static inline dns_answer *
859 store_get_dns_answer_trc(const uschar * func, unsigned line)
861 return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */
864 /******************************************************************************/
865 /* Routines with knowledge of spool layout */
867 # ifndef COMPILE_UTILITY
869 spool_pname_buf(uschar * buf, int len)
871 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
874 static inline uschar *
875 spool_dname(const uschar * purpose, uschar * subdir)
877 return string_sprintf("%s/%s/%s/%s",
878 spool_directory, queue_name, purpose, subdir);
882 static inline uschar *
883 spool_sname(const uschar * purpose, uschar * subdir)
885 return string_sprintf("%s%s%s%s%s",
886 queue_name, *queue_name ? "/" : "",
888 *subdir ? "/" : "", subdir);
891 static inline uschar *
892 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
893 const uschar * suffix)
895 return string_sprintf("%s/%s/%s/%s/%s%s",
896 spool_directory, queue_name, purpose, subdir, fname, suffix);
900 set_subdir_str(uschar * subdir_str, const uschar * name,
903 subdir_str[0] = split_spool_directory == (search_sequence == 0)
905 subdir_str[1] = '\0';
908 /******************************************************************************/
910 timesince(struct timeval * diff, struct timeval * then)
912 gettimeofday(diff, NULL);
913 diff->tv_sec -= then->tv_sec;
914 if ((diff->tv_usec -= then->tv_usec) < 0)
917 diff->tv_usec += 1000*1000;
921 static inline uschar *
922 string_timediff(struct timeval * diff)
924 static uschar buf[sizeof("0.000s")];
926 if (diff->tv_sec >= 5 || !LOGGING(millisec))
927 return readconf_printtime((int)diff->tv_sec);
929 sprintf(CS buf, "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
934 static inline uschar *
935 string_timesince(struct timeval * then)
938 timesince(&diff, then);
939 return string_timediff(&diff);
943 report_time_since(struct timeval * t0, uschar * where)
945 # ifdef MEASURE_TIMING
947 timesince(&diff, t0);
948 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
949 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
955 testharness_pause_ms(int millisec)
957 #ifndef MEASURE_TIMING
958 if (f.running_in_test_harness) millisleep(millisec);
962 #endif /* !MACRO_PREDEF */
964 #endif /* _FUNCTIONS_H_ */
968 /* End of functions.h */