Testsuite: output changes resulting
[exim.git] / src / src / functions.h
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
f9ba5e22 5/* Copyright (c) University of Cambridge 1995 - 2018 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8
9/* Prototypes for functions that appear in various modules. Gathered together
10to avoid having a lot of tiddly little headers with only a couple of lines in
11them. However, some functions that are used (or not used) by utility programs
12are in in fact in separate headers. */
b66fecb4
HSHR
13#ifndef _FUNCTIONS_H_
14#define _FUNCTIONS_H_
059ec3d9
PH
15
16
17#ifdef EXIM_PERL
acec9514 18extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
268d00ff 19 uschar **) WARN_UNUSED_RESULT;
059ec3d9
PH
20extern void cleanup_perl(void);
21extern uschar *init_perl(uschar *);
22#endif
23
24
25#ifdef SUPPORT_TLS
a799883d
PP
26extern const char *
27 std_dh_prime_default(void);
28extern const char *
29 std_dh_prime_named(const uschar *);
9d1c15ef 30
9e4dddbd 31extern uschar * tls_cert_crl_uri(void *, uschar * mod);
9d1c15ef 32extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
9e4dddbd
JH
33extern uschar * tls_cert_issuer(void *, uschar * mod);
34extern uschar * tls_cert_not_before(void *, uschar * mod);
35extern uschar * tls_cert_not_after(void *, uschar * mod);
36extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
37extern uschar * tls_cert_serial_number(void *, uschar * mod);
38extern uschar * tls_cert_signature(void *, uschar * mod);
39extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
40extern uschar * tls_cert_subject(void *, uschar * mod);
41extern uschar * tls_cert_subject_altname(void *, uschar * mod);
42extern uschar * tls_cert_version(void *, uschar * mod);
9d1c15ef 43
59b87190 44extern uschar * tls_cert_der_b64(void * cert);
6a8a60e0
JH
45extern uschar * tls_cert_fprt_md5(void *);
46extern uschar * tls_cert_fprt_sha1(void *);
9ef9101c 47extern uschar * tls_cert_fprt_sha256(void *);
6a8a60e0 48
c05bdbd6
JH
49extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
50 void *, tls_support *, uschar **);
51
74f1a423 52extern void tls_close(void *, int);
925ac8e4 53extern BOOL tls_could_read(void);
9d1c15ef 54extern int tls_export_cert(uschar *, size_t, void *);
059ec3d9
PH
55extern int tls_feof(void);
56extern int tls_ferror(void);
790fbb71 57extern void tls_free_cert(void **);
bd8fbe36 58extern int tls_getc(unsigned);
0d81dabc 59extern uschar *tls_getbuf(unsigned *);
584e96c6 60extern void tls_get_cache(void);
9d1c15ef 61extern int tls_import_cert(const uschar *, void **);
74f1a423 62extern int tls_read(void *, uschar *, size_t);
cf0c6164 63extern int tls_server_start(const uschar *, uschar **);
58eb016e 64extern BOOL tls_smtp_buffered(void);
059ec3d9 65extern int tls_ungetc(int);
74f1a423 66extern int tls_write(void *, const uschar *, size_t, BOOL);
3375e053 67extern uschar *tls_validate_require_cipher(void);
36f12725 68extern void tls_version_report(FILE *);
e51c7be2 69# ifndef USE_GNUTLS
77bb000f 70extern BOOL tls_openssl_options_parse(uschar *, long *);
e51c7be2 71# endif
55414b25
JH
72extern uschar * tls_field_from_dn(uschar *, const uschar *);
73extern BOOL tls_is_name_for_cert(const uschar *, void *);
0e66b3b6 74
c0635b6d 75# ifdef SUPPORT_DANE
4b0fe319 76extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
0e66b3b6
JH
77# endif
78
35aba663 79#endif /*SUPPORT_TLS*/
059ec3d9
PH
80
81
82/* Everything else... */
83
84extern acl_block *acl_read(uschar *(*)(void), uschar **);
85extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
05caaeaa 86extern int acl_eval(int, uschar *, uschar **, uschar **);
333eea9c 87
38a0a95f
PH
88extern tree_node *acl_var_create(uschar *);
89extern void acl_var_write(uschar *, uschar *, void *);
617d3932
JH
90
91#ifdef EXPERIMENTAL_ARC
92extern void *arc_ams_setup_sign_bodyhash(void);
93extern const uschar *arc_header_feed(gstring *, BOOL);
94extern gstring *arc_sign(const uschar *, gstring *, uschar **);
b3d9ebf5 95extern void arc_sign_init(void);
617d3932 96extern const uschar *acl_verify_arc(void);
9cffa436 97extern uschar * fn_arc_domains(void);
617d3932
JH
98#endif
99
cf0812d5 100extern void assert_no_variables(void *, int, const char *, int);
e1af7642 101extern int auth_call_pam(const uschar *, uschar **);
059ec3d9 102extern int auth_call_pwcheck(uschar *, uschar **);
93a6fce2
JH
103extern int auth_call_radius(const uschar *, uschar **);
104extern int auth_call_saslauthd(const uschar *, const uschar *,
105 const uschar *, const uschar *, uschar **);
16ff981e 106extern int auth_check_serv_cond(auth_instance *);
44bbabb5 107extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
37942ad8
JH
108extern int auth_client_item(void *, auth_instance *, const uschar **,
109 unsigned, int, uschar *, int);
44bbabb5 110
e1d04f48 111
1f20760b 112extern int auth_get_data(uschar **, const uschar *, int);
059ec3d9 113extern int auth_get_no64_data(uschar **, uschar *);
8238bc7b 114extern int auth_prompt(const uschar *);
37942ad8 115extern int auth_read_input(const uschar *);
adf73d37 116extern void auth_show_supported(FILE *);
059ec3d9
PH
117extern uschar *auth_xtextencode(uschar *, int);
118extern int auth_xtextdecode(uschar *, uschar **);
119
c9cf9ac4
JH
120#ifdef EXPERIMENTAL_ARC
121extern gstring *authres_arc(gstring *);
dfbcb5ac
JH
122#endif
123#ifndef DISABLE_DKIM
124extern gstring *authres_dkim(gstring *);
125#endif
c9cf9ac4
JH
126#ifdef EXPERIMENTAL_DMARC
127extern gstring *authres_dmarc(gstring *);
128#endif
129extern gstring *authres_smtpauth(gstring *);
130#ifdef SUPPORT_SPF
131extern gstring *authres_spf(gstring *);
617d3932 132#endif
dfbcb5ac 133
1f20760b 134extern uschar *b64encode(const uschar *, int);
35cf75e9 135extern int b64decode(const uschar *, uschar **);
bd8fbe36 136extern int bdat_getc(unsigned);
0d81dabc 137extern uschar *bdat_getbuf(unsigned *);
f6f4a58d 138extern int bdat_ungetc(int);
1ebe15c3
JH
139extern void bdat_flush_data(void);
140
6c6d6e48
TF
141extern void bits_clear(unsigned int *, size_t, int *);
142extern void bits_set(unsigned int *, size_t, int *);
143
57cc2785 144extern void cancel_cutthrough_connection(BOOL, const uschar *);
55414b25 145extern int check_host(void *, const uschar *, const uschar **, uschar **);
059ec3d9 146extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
55414b25
JH
147extern pid_t child_open_uid(const uschar **, const uschar **, int,
148 uid_t *, gid_t *, int *, int *, uschar *, BOOL);
bc3c7bb7 149extern BOOL cleanup_environment(void);
6851a9c5
JH
150extern void cutthrough_data_puts(uschar *, int);
151extern void cutthrough_data_put_nl(void);
e4bdf652
JH
152extern uschar *cutthrough_finaldot(void);
153extern BOOL cutthrough_flush_send(void);
154extern BOOL cutthrough_headers_send(void);
155extern BOOL cutthrough_predata(void);
57cc2785 156extern void release_cutthrough_connection(const uschar *);
059ec3d9
PH
157
158extern void daemon_go(void);
6a8f9482
TK
159
160#ifdef EXPERIMENTAL_DCC
161extern int dcc_process(uschar **);
162#endif
163
ed7f7860 164extern void debug_logging_activate(uschar *, uschar *);
b0d68adc 165extern void debug_logging_stop(void);
55414b25 166extern void debug_print_argv(const uschar **);
059ec3d9 167extern void debug_print_ids(uschar *);
e1d04f48 168extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
059ec3d9
PH
169extern void debug_print_string(uschar *);
170extern void debug_print_tree(tree_node *);
398f9af3 171extern void debug_vprintf(int, const char *, va_list);
6c6d6e48
TF
172extern void decode_bits(unsigned int *, size_t, int *,
173 uschar *, bit_table *, int, uschar *, int);
059ec3d9 174extern address_item *deliver_make_addr(uschar *, BOOL);
476be7e2 175extern void deliver_init(void);
817d9f57 176extern void delivery_log(int, address_item *, int, uschar *);
059ec3d9 177extern int deliver_message(uschar *, BOOL, BOOL);
e0df1c83 178extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
059ec3d9
PH
179extern void deliver_set_expansions(address_item *);
180extern int deliver_split_address(address_item *);
181extern void deliver_succeeded(address_item *);
a39bd74d
JB
182
183extern uschar *deliver_get_sender_address (uschar *id);
57cc2785 184extern void delivery_re_exec(int);
a39bd74d 185
1ba28e2b 186extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
80a47a2c 187#ifndef DISABLE_DKIM
617d3932
JH
188extern uschar *dkim_exim_query_dns_txt(uschar *);
189extern void dkim_exim_sign_init(void);
190
42055a33 191extern BOOL dkim_transport_write_message(transport_ctx *,
b9df1829 192 struct ob_dkim *, const uschar ** errstr);
f7572e5a 193#endif
059ec3d9 194extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
476be7e2 195extern int dns_basic_lookup(dns_answer *, const uschar *, int);
55414b25 196extern void dns_build_reverse(const uschar *, uschar *);
8c51eead 197extern void dns_init(BOOL, BOOL, BOOL);
0539a19d 198extern BOOL dns_is_aa(const dns_answer *);
1dc92d5a 199extern BOOL dns_is_secure(const dns_answer *);
55414b25 200extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
476be7e2 201extern void dns_pattern_init(void);
55414b25 202extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
dd708fd7 203extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
059ec3d9 204extern uschar *dns_text_type(int);
36a3ae5f 205extern void dscp_list_to_stream(FILE *);
9e4f5962 206extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
059ec3d9
PH
207
208extern void enq_end(uschar *);
e8ae7214 209extern BOOL enq_start(uschar *, unsigned);
0cbf2b82 210#ifndef DISABLE_EVENT
55414b25 211extern uschar *event_raise(uschar *, const uschar *, uschar *);
5ef5dd52 212extern void msg_event_raise(const uschar *, const address_item *);
774ef2d7 213#endif
b66fecb4
HSHR
214
215extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
216inline int exim_chown(const uschar*, uid_t, gid_t);
217inline int exim_fchown(int, uid_t, gid_t, const uschar*);
37f3dc43 218extern const uschar * exim_errstr(int);
9bfb7e1b 219extern void exim_exit(int, const uschar *);
059ec3d9
PH
220extern void exim_nullstd(void);
221extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
059ec3d9 222extern void exim_wait_tick(struct timeval *, int);
9c695f6d
JH
223extern int exp_bool(address_item *addr,
224 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
225 uschar *svalue, BOOL *rvalue);
059ec3d9 226extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
617d3932 227extern uschar *expand_file_big_buffer(const uschar *);
93a6fce2
JH
228extern uschar *expand_string(uschar *); /* public, cannot make const */
229extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
f42deca9 230extern uschar *expand_hide_passwords(uschar * );
55414b25 231extern uschar *expand_string_copy(const uschar *);
97d17305 232extern int_eximarith_t expand_string_integer(uschar *, BOOL);
d9b2312b 233extern void modify_variable(uschar *, void *);
059ec3d9 234
4e71661f
JH
235extern BOOL fd_ready(int, int);
236
059ec3d9
PH
237extern int filter_interpret(uschar *, int, address_item **, uschar **);
238extern BOOL filter_personal(string_item *, BOOL);
f05da2e8 239extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
059ec3d9
PH
240extern BOOL filter_system_interpret(address_item **, uschar **);
241
362145b5
JH
242extern uschar * fn_hdrs_added(void);
243
617d3932
JH
244extern void gstring_reset_unused(gstring *);
245
1ba28e2b 246extern void header_add(int, const char *, ...);
049782c0 247extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
059ec3d9
PH
248extern int header_checkname(header_line *, BOOL);
249extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
7cd1141b 250extern int host_address_extract_port(uschar *);
059ec3d9 251extern uschar *host_and_ident(BOOL);
55414b25
JH
252extern int host_aton(const uschar *, int *);
253extern void host_build_hostlist(host_item **, const uschar *, BOOL);
254extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
059ec3d9
PH
255extern void host_build_log_info(void);
256extern void host_build_sender_fullhost(void);
a207d5dd 257extern int host_find_byname(host_item *, const uschar *, int,
1f155f8e 258 const uschar **, BOOL);
55414b25 259extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
7cd171b7 260 uschar *, const dnssec_domains *, const uschar **, BOOL *);
059ec3d9 261extern ip_address_item *host_find_interfaces(void);
55414b25 262extern BOOL host_is_in_net(const uschar *, const uschar *, int);
059ec3d9 263extern BOOL host_is_tls_on_connect_port(int);
7cd1141b 264extern int host_item_get_port(host_item *);
059ec3d9
PH
265extern void host_mask(int, int *, int);
266extern int host_name_lookup(void);
6f0c9a4f 267extern int host_nmtoa(int, int *, int, uschar *, int);
059ec3d9
PH
268extern uschar *host_ntoa(int, const void *, uschar *, int *);
269extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
270
94431adb 271extern uschar *imap_utf7_encode(uschar *, const uschar *,
ed0512a1
JH
272 uschar, uschar *, uschar **);
273
83e029d5 274extern void invert_address(uschar *, uschar *);
7eb6c37c 275extern int ip_addr(void *, int, const uschar *, int);
059ec3d9 276extern int ip_bind(int, int, uschar *, int);
0ab63f3d 277extern int ip_connect(int, int, const uschar *, int, int, const blob *);
b1f8e4f8 278extern int ip_connectedsocket(int, const uschar *, int, int,
4a5cbaff 279 int, host_item *, uschar **, const blob *);
13363eba 280extern int ip_get_address_family(int);
55414b25 281extern void ip_keepalive(int, const uschar *, BOOL);
74f1a423 282extern int ip_recv(client_conn_ctx *, uschar *, int, int);
059ec3d9
PH
283extern int ip_socket(int, int);
284
3e60dd41
JH
285extern int ip_tcpsocket(const uschar *, uschar **, int);
286extern int ip_unixsocket(const uschar *, uschar **);
287extern int ip_streamsocket(const uschar *, uschar **, int);
288
fc4a7f70
JH
289extern int ipv6_nmtoa(int *, uschar *);
290
921b12ca 291extern uschar *local_part_quote(uschar *);
4840604e 292extern int log_create(uschar *);
921b12ca 293extern int log_create_as_exim(uschar *);
059ec3d9
PH
294extern void log_close_all(void);
295
d185889f 296extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
c246a1de
JH
297extern BOOL macro_read_assignment(uschar *);
298extern uschar *macros_expand(int, int *, BOOL *);
9cd319d9 299extern void mainlog_close(void);
8523533c 300#ifdef WITH_CONTENT_SCAN
0f0c8159 301extern int malware(const uschar *, int);
dbc4b90d 302extern int malware_in_file(uschar *);
476be7e2 303extern void malware_init(void);
c11d665d 304extern void malware_show_supported(FILE *);
8523533c 305#endif
55414b25
JH
306extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
307 unsigned int *, int, int, const uschar **);
36d295f1 308extern int match_address_list_basic(const uschar *, const uschar **, int);
55414b25
JH
309extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
310 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
311 const uschar *, const uschar **);
312extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
313 unsigned int *, int, BOOL, const uschar **);
314extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
315 const uschar **);
059ec3d9
PH
316extern void md5_end(md5 *, const uschar *, int, uschar *);
317extern void md5_mid(md5 *, const uschar *);
318extern void md5_start(md5 *);
319extern void millisleep(int);
8523533c
TK
320#ifdef WITH_CONTENT_SCAN
321struct mime_boundary_context;
54cdb463
PH
322extern int mime_acl_check(uschar *acl, FILE *f,
323 struct mime_boundary_context *, uschar **, uschar **);
55414b25 324extern int mime_decode(const uschar **);
f4d091fb 325extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
55414b25 326extern int mime_regex(const uschar **);
f4d091fb 327extern void mime_set_anomaly(int);
8523533c 328#endif
059ec3d9
PH
329extern uschar *moan_check_errorcopy(uschar *);
330extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
331 BOOL, uschar *);
e0df1c83 332extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
5455f548
JH
333extern BOOL moan_send_message(uschar *, int, error_block *eblock,
334 header_line *, FILE *, uschar *);
1ba28e2b 335extern void moan_tell_someone(uschar *, address_item *,
e0df1c83 336 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
059ec3d9 337extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
0e22dfd1 338extern void moan_write_from(FILE *);
1ba28e2b 339extern FILE *modefopen(const uschar *, const char *, mode_t);
059ec3d9 340
f9334a28 341extern int open_cutthrough_connection( address_item * addr );
e4bdf652 342
059ec3d9
PH
343extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
344 BOOL);
345extern int parse_forward_list(uschar *, int, address_item **, uschar **,
55414b25 346 const uschar *, uschar *, error_block **);
059ec3d9
PH
347extern uschar *parse_find_address_end(uschar *, BOOL);
348extern uschar *parse_find_at(uschar *);
55414b25 349extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
30dba1e6 350extern uschar *parse_message_id(uschar *, uschar **, uschar **);
55414b25 351extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
43ad7b7d 352extern uschar *parse_date_time(uschar *str, time_t *t);
17c76198
PP
353extern int vaguely_random_number(int);
354#ifdef SUPPORT_TLS
355extern int vaguely_random_number_fallback(int);
356#endif
059ec3d9
PH
357
358extern BOOL queue_action(uschar *, int, uschar **, int, int);
359extern void queue_check_only(void);
360extern void queue_list(int, uschar **, int);
361extern void queue_count(void);
362extern void queue_run(uschar *, uschar *, BOOL);
363
364extern int random_number(int);
aeb65e91 365extern const uschar *rc_to_string(int);
e4a89c47 366extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
efd9a422
MH
367 uschar *, uschar *, uschar *, ugid_block *, address_item **,
368 uschar **, error_block **, int *, uschar *);
059ec3d9
PH
369extern int rda_is_filter(const uschar *);
370extern BOOL readconf_depends(driver_instance *, uschar *);
371extern void readconf_driver_init(uschar *, driver_instance **,
372 driver_info *, int, void *, int, optionlist *, int);
373extern uschar *readconf_find_option(void *);
34e86e20 374extern void readconf_main(BOOL);
383832ef 375extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
2be324ee 376extern BOOL readconf_print(uschar *, uschar *, BOOL);
059ec3d9
PH
377extern uschar *readconf_printtime(int);
378extern uschar *readconf_readname(uschar *, int, uschar *);
1ad6489e 379extern int readconf_readtime(const uschar *, int, BOOL);
bf3c2c6b 380extern void readconf_rest(void);
55414b25 381extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
bf3c2c6b 382extern void readconf_save_config(const uschar *);
328895cc 383extern void read_message_body(BOOL);
8f128379 384extern void receive_bomb_out(uschar *, uschar *);
059ec3d9
PH
385extern BOOL receive_check_fs(int);
386extern BOOL receive_check_set_sender(uschar *);
387extern BOOL receive_msg(BOOL);
a45431fa 388extern int_eximarith_t receive_statvfs(BOOL, int *);
059ec3d9 389extern void receive_swallow_smtp(void);
8523533c 390#ifdef WITH_CONTENT_SCAN
55414b25 391extern int regex(const uschar **);
8523533c 392#endif
1dc92d5a 393extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
476be7e2 394extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
059ec3d9 395extern void retry_add_item(address_item *, uschar *, int);
55414b25 396extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
059ec3d9 397 uschar **, uschar **);
55414b25
JH
398extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
399extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
ba9af0af 400 dbdata_retry *, time_t);
059ec3d9
PH
401extern void retry_update(address_item **, address_item **, address_item **);
402extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
403extern uschar *rewrite_address_qualify(uschar *, BOOL);
55414b25
JH
404extern header_line *rewrite_header(header_line *,
405 const uschar *, const uschar *,
059ec3d9
PH
406 rewrite_rule *, int, BOOL);
407extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
408 rewrite_rule *);
409extern void rewrite_test(uschar *);
410extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
411 uschar **);
412extern int route_address(address_item *, address_item **, address_item **,
413 address_item **, address_item **, int);
55414b25
JH
414extern int route_check_prefix(const uschar *, const uschar *);
415extern int route_check_suffix(const uschar *, const uschar *);
059ec3d9 416extern BOOL route_findgroup(uschar *, gid_t *);
55414b25 417extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
059ec3d9
PH
418extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
419 uschar **);
420extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
421 struct passwd **, uid_t *, uschar **);
422extern void route_init(void);
adf73d37 423extern void route_show_supported(FILE *);
059ec3d9
PH
424extern void route_tidyup(void);
425
55414b25 426extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
059ec3d9 427 int, int *);
55414b25
JH
428extern int search_findtype(const uschar *, int);
429extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
059ec3d9
PH
430 int *);
431extern void *search_open(uschar *, int, int, uid_t *, gid_t *);
432extern void search_tidyup(void);
e0df1c83 433extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
5fb822fc
JH
434extern void sha1_end(hctx *, const uschar *, int, uschar *);
435extern void sha1_mid(hctx *, const uschar *);
436extern void sha1_start(hctx *);
e4a89c47 437extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
efd9a422 438 uschar *, address_item **, uschar **);
059ec3d9 439extern void sigalrm_handler(int);
58eb016e 440extern BOOL smtp_buffered(void);
059ec3d9 441extern void smtp_closedown(uschar *);
9723f966
JH
442extern void smtp_command_timeout_exit(void);
443extern void smtp_command_sigterm_exit(void);
444extern void smtp_data_timeout_exit(void);
445extern void smtp_data_sigint_exit(void);
a09f2942 446extern uschar *smtp_cmd_hist(void);
ee8b8090 447extern int smtp_connect(smtp_connect_args *, const blob *);
7eb6c37c 448extern int smtp_sock_connect(host_item *, int, int, uschar *,
0ab63f3d 449 transport_instance * tb, int, const blob *);
059ec3d9
PH
450extern int smtp_feof(void);
451extern int smtp_ferror(void);
452extern uschar *smtp_get_connection_info(void);
6f6dedcc 453extern BOOL smtp_get_interface(uschar *, int, address_item *,
059ec3d9
PH
454 uschar **, uschar *);
455extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
bd8fbe36 456extern int smtp_getc(unsigned);
0d81dabc 457extern uschar *smtp_getbuf(unsigned *);
584e96c6 458extern void smtp_get_cache(void);
059ec3d9 459extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
b4ed4da0 460extern void smtp_log_no_mail(void);
4f6ae5c3 461extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
74f1a423 462extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int);
251b9eb4 463extern BOOL smtp_read_response(void *, uschar *, int, int, int);
e04bfa34 464extern void smtp_reset(void *);
a5bd321b 465extern void smtp_respond(uschar *, int, BOOL, uschar *);
8f128379 466extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
58c30e47 467extern void smtp_port_for_connect(host_item *, int);
059ec3d9
PH
468extern void smtp_send_prohibition_message(int, uschar *);
469extern int smtp_setup_msg(void);
470extern BOOL smtp_start_session(void);
471extern int smtp_ungetc(int);
d7b47fd0 472extern BOOL smtp_verify_helo(void);
251b9eb4 473extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
8523533c 474#ifdef WITH_CONTENT_SCAN
55414b25 475extern int spam(const uschar **);
040721f2 476extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
8523533c 477#endif
4b4856ff 478extern void spool_clear_header_globals(void);
3369a853 479extern uschar *spool_dname(const uschar *, uschar *);
b4758425 480extern uschar *spool_fname(const uschar *, const uschar *, const uschar *, const uschar *);
4b4856ff 481extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
789f8a4f 482extern int spool_open_datafile(uschar *);
059ec3d9
PH
483extern int spool_open_temp(uschar *);
484extern int spool_read_header(uschar *, BOOL, BOOL);
4b4856ff 485extern uschar *spool_sname(const uschar *, uschar *);
059ec3d9 486extern int spool_write_header(uschar *, int, uschar **);
bd8fbe36 487extern int stdin_getc(unsigned);
059ec3d9
PH
488extern int stdin_feof(void);
489extern int stdin_ferror(void);
490extern int stdin_ungetc(int);
acec9514
JH
491extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
492extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
493extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
bce15b62 494extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
059ec3d9 495extern uschar *string_base62(unsigned long int);
acec9514
JH
496extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
497extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
84bbb4d8 498extern int string_compare_by_pointer(const void *, const void *);
059ec3d9 499extern uschar *string_copy_dnsdomain(uschar *);
55414b25 500extern uschar *string_copy_malloc(const uschar *);
1dc92d5a 501extern uschar *string_copylc(const uschar *);
059ec3d9 502extern uschar *string_copynlc(uschar *, int);
55414b25 503extern uschar *string_dequote(const uschar **);
d12746bc 504extern gstring *string_fmt_append(gstring *, const char *, ...) ALMOST_PRINTF(2,3);
81f91683 505extern BOOL string_format(uschar *, int, const char *, ...) ALMOST_PRINTF(3,4);
059ec3d9 506extern uschar *string_format_size(int, uschar *);
acec9514
JH
507extern uschar *string_from_gstring(gstring *);
508extern gstring *string_get(unsigned);
55414b25 509extern int string_interpret_escape(const uschar **);
b1f8e4f8 510extern int string_is_ip_address(const uschar *, int *);
8c5d388a 511#ifdef SUPPORT_I18N
0d7911ea
JH
512extern BOOL string_is_utf8(const uschar *);
513#endif
55414b25 514extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
e0df1c83 515extern uschar *string_open_failed(int, const char *, ...) PRINTF_FUNCTION(2,3);
55414b25 516extern const uschar *string_printing2(const uschar *, BOOL);
e28326d8 517extern uschar *string_split_message(uschar *);
306c6c77 518extern uschar *string_timediff(struct timeval *);
0f1a8658 519extern uschar *string_timesince(struct timeval *);
c7396ac5 520extern uschar *string_unprinting(uschar *);
8c5d388a 521#ifdef SUPPORT_I18N
3c8b3577 522extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
0d7911ea
JH
523extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
524extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
525extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
526extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
527#endif
d12746bc 528extern gstring *string_vformat(gstring *, BOOL, const char *, va_list);
1ba28e2b
PP
529extern int strcmpic(const uschar *, const uschar *);
530extern int strncmpic(const uschar *, const uschar *, int);
059ec3d9
PH
531extern uschar *strstric(uschar *, uschar *, BOOL);
532
10ac8d7f
JH
533#ifdef EXIM_TFO_PROBE
534extern void tfo_probe(void);
535#endif
32dfdf8b
JH
536extern void timesince(struct timeval * diff, struct timeval * then);
537extern void tls_modify_variables(tls_support *);
059ec3d9 538extern uschar *tod_stamp(int);
41afb5cb 539
55414b25 540extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
a39bd74d 541 BOOL *, oicf, void*);
059ec3d9 542extern void transport_init(void);
57cc2785
JH
543extern void transport_do_pass_socket(const uschar *, const uschar *,
544 const uschar *, uschar *, int);
55414b25 545extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
059ec3d9
PH
546 int);
547extern uschar *transport_rcpt_address(address_item *, BOOL);
55414b25
JH
548extern BOOL transport_set_up_command(const uschar ***, uschar *,
549 BOOL, int, address_item *, uschar *, uschar **);
059ec3d9 550extern void transport_update_waiting(host_item *, uschar *);
42055a33
JH
551extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
552extern void transport_write_reset(int);
1ba28e2b 553extern BOOL transport_write_string(int, const char *, ...);
42055a33
JH
554extern BOOL transport_headers_send(transport_ctx *,
555 BOOL (*)(transport_ctx *, uschar *, int));
adf73d37 556extern void transport_show_supported(FILE *);
42055a33 557extern BOOL transport_write_message(transport_ctx *, int);
059ec3d9
PH
558extern void tree_add_duplicate(uschar *, address_item *);
559extern void tree_add_nonrecipient(uschar *);
560extern void tree_add_unusable(host_item *);
561extern int tree_insertnode(tree_node **, tree_node *);
55414b25 562extern tree_node *tree_search(tree_node *, const uschar *);
059ec3d9 563extern void tree_write(tree_node *, FILE *);
38a0a95f 564extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
059ec3d9 565
8523533c
TK
566#ifdef WITH_CONTENT_SCAN
567extern void unspool_mbox(void);
568#endif
8c5d388a 569#ifdef SUPPORT_I18N
fc362fc5
JH
570extern void utf8_version_report(FILE *);
571#endif
8523533c 572
4deaf07d
PH
573extern int verify_address(address_item *, FILE *, int, int, int, int,
574 uschar *, uschar *, BOOL *);
379ba7d0 575extern int verify_check_dnsbl(int, const uschar **, uschar **);
4deaf07d 576extern int verify_check_header_address(uschar **, uschar **, int, int, int,
fe5b5d0b 577 uschar *, uschar *, int, int *);
059ec3d9 578extern int verify_check_headers(uschar **);
770747fd 579extern int verify_check_header_names_ascii(uschar **);
059ec3d9 580extern int verify_check_host(uschar **);
7c498df1 581extern int verify_check_notblind(BOOL);
3fb3231c 582extern int verify_check_given_host(const uschar **, const host_item *);
55414b25
JH
583extern int verify_check_this_host(const uschar **, unsigned int *,
584 const uschar*, const uschar *, const uschar **);
059ec3d9
PH
585extern address_item *verify_checked_sender(uschar *);
586extern void verify_get_ident(int);
587extern BOOL verify_sender(int *, uschar **);
588extern BOOL verify_sender_preliminary(int *, uschar **);
589extern void version_init(void);
590
42055a33 591extern BOOL write_chunk(transport_ctx *, uschar *, int);
17c76198
PP
592extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
593
b66fecb4
HSHR
594/* exim_chown - in some NFSv4 setups *seemes* to be an issue with
595 chown(<exim-uid>, <exim-gid>).
596
597 Probably because the idmapping is broken, misconfigured or set up in
598 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
599 case of misconfiguration, or if there are more such broken systems
600 out, I try to impose as least impact as possible and for now just write
601 a panic log entry pointing to the bug report. You're encouraged to
602 contact the developers, if you experience this issue.
603
604 fd the file descriptor (or -1 if not valid)
605 name the file name for error messages or for file operations,
606 if fd is < 0
607 owner the owner
608 group the group
609
610 returns 0 on success, -1 on failure */
611
612inline int
613exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
614{
615return (0 == fchown(fd, owner, group))
616 ? 0 : exim_chown_failure(fd, name, owner, group);
617}
618
619inline int
620exim_chown(const uschar *name, uid_t owner, gid_t group)
621{
622return (0 == chown(name, owner, group))
623 ? 0 : exim_chown_failure(-1, name, owner, group);
624}
625
626#endif /* _FUNCTIONS_H_ */
acec9514 627
9d1c15ef
JH
628/* vi: aw
629*/
059ec3d9 630/* End of functions.h */