projects / exim.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
environment grooming
[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 15
9f01e50d
JH		 16#include <sys/time.h>
17
059ec3d9
PH		 18
19#ifdef EXIM_PERL
acec9514 20extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
268d00ff 21 uschar **) WARN_UNUSED_RESULT;
059ec3d9
PH		 22extern void cleanup_perl(void);
23extern uschar *init_perl(uschar *);
24#endif
25
26
01603eec 27#ifndef DISABLE_TLS
a799883d
PP		 28extern const char *
29 std_dh_prime_default(void);
30extern const char *
31 std_dh_prime_named(const uschar *);
9d1c15ef 32
9e4dddbd 33extern uschar * tls_cert_crl_uri(void *, uschar * mod);
9d1c15ef 34extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
9e4dddbd
JH		 35extern uschar * tls_cert_issuer(void *, uschar * mod);
36extern uschar * tls_cert_not_before(void *, uschar * mod);
37extern uschar * tls_cert_not_after(void *, uschar * mod);
38extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
39extern uschar * tls_cert_serial_number(void *, uschar * mod);
40extern uschar * tls_cert_signature(void *, uschar * mod);
41extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
42extern uschar * tls_cert_subject(void *, uschar * mod);
43extern uschar * tls_cert_subject_altname(void *, uschar * mod);
44extern uschar * tls_cert_version(void *, uschar * mod);
9d1c15ef 45
59b87190 46extern uschar * tls_cert_der_b64(void * cert);
6a8a60e0
JH		 47extern uschar * tls_cert_fprt_md5(void *);
48extern uschar * tls_cert_fprt_sha1(void *);
9ef9101c 49extern uschar * tls_cert_fprt_sha256(void *);
6a8a60e0 50
6b5cbf74 51extern void tls_clean_env(void);
c05bdbd6
JH		 52extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
53 void *, tls_support *, uschar **);
54
74f1a423 55extern void tls_close(void *, int);
925ac8e4 56extern BOOL tls_could_read(void);
b10c87b3 57extern void tls_daemon_init(void);
2944124c 58extern BOOL tls_export_cert(uschar *, size_t, void *);
059ec3d9
PH		 59extern int tls_feof(void);
60extern int tls_ferror(void);
790fbb71 61extern void tls_free_cert(void **);
bd8fbe36 62extern int tls_getc(unsigned);
0d81dabc 63extern uschar *tls_getbuf(unsigned *);
584e96c6 64extern void tls_get_cache(void);
b2827658 65extern BOOL tls_import_cert(const uschar *, void **);
74f1a423 66extern int tls_read(void *, uschar *, size_t);
cf0c6164 67extern int tls_server_start(const uschar *, uschar **);
58eb016e 68extern BOOL tls_smtp_buffered(void);
059ec3d9 69extern int tls_ungetc(int);
74f1a423 70extern int tls_write(void *, const uschar *, size_t, BOOL);
3375e053 71extern uschar *tls_validate_require_cipher(void);
36f12725 72extern void tls_version_report(FILE *);
de517fd3 73# ifdef USE_OPENSSL
77bb000f 74extern BOOL tls_openssl_options_parse(uschar *, long *);
e51c7be2 75# endif
55414b25
JH		 76extern uschar * tls_field_from_dn(uschar *, const uschar *);
77extern BOOL tls_is_name_for_cert(const uschar *, void *);
0e66b3b6 78
c0635b6d 79# ifdef SUPPORT_DANE
4b0fe319 80extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
0e66b3b6
JH		 81# endif
82
01603eec 83#endif /*DISABLE_TLS*/
059ec3d9
PH		 84
85
86/* Everything else... */
87
88extern acl_block *acl_read(uschar *(*)(void), uschar **);
89extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
05caaeaa 90extern int acl_eval(int, uschar *, uschar **, uschar **);
333eea9c 91
38a0a95f
PH		 92extern tree_node *acl_var_create(uschar *);
93extern void acl_var_write(uschar *, uschar *, void *);
617d3932
JH		 94
95#ifdef EXPERIMENTAL_ARC
96extern void *arc_ams_setup_sign_bodyhash(void);
97extern const uschar *arc_header_feed(gstring *, BOOL);
98extern gstring *arc_sign(const uschar *, gstring *, uschar **);
b3d9ebf5 99extern void arc_sign_init(void);
617d3932 100extern const uschar *acl_verify_arc(void);
9cffa436 101extern uschar * fn_arc_domains(void);
617d3932
JH		 102#endif
103
cf0812d5 104extern void assert_no_variables(void *, int, const char *, int);
e1af7642 105extern int auth_call_pam(const uschar *, uschar **);
059ec3d9 106extern int auth_call_pwcheck(uschar *, uschar **);
93a6fce2
JH		 107extern int auth_call_radius(const uschar *, uschar **);
108extern int auth_call_saslauthd(const uschar *, const uschar *,
109 const uschar *, const uschar *, uschar **);
16ff981e 110extern int auth_check_serv_cond(auth_instance *);
44bbabb5 111extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
37942ad8
JH		 112extern int auth_client_item(void *, auth_instance *, const uschar **,
113 unsigned, int, uschar *, int);
44bbabb5 114
e1d04f48 115
1f20760b 116extern int auth_get_data(uschar **, const uschar *, int);
059ec3d9 117extern int auth_get_no64_data(uschar **, uschar *);
8238bc7b 118extern int auth_prompt(const uschar *);
37942ad8 119extern int auth_read_input(const uschar *);
adf73d37 120extern void auth_show_supported(FILE *);
059ec3d9
PH		 121extern uschar *auth_xtextencode(uschar *, int);
122extern int auth_xtextdecode(uschar *, uschar **);
123
c9cf9ac4
JH		 124#ifdef EXPERIMENTAL_ARC
125extern gstring *authres_arc(gstring *);
dfbcb5ac
JH		 126#endif
127#ifndef DISABLE_DKIM
128extern gstring *authres_dkim(gstring *);
129#endif
1a2e76e1 130#ifdef SUPPORT_DMARC
c9cf9ac4
JH		 131extern gstring *authres_dmarc(gstring *);
132#endif
133extern gstring *authres_smtpauth(gstring *);
134#ifdef SUPPORT_SPF
135extern gstring *authres_spf(gstring *);
617d3932 136#endif
dfbcb5ac 137
1f20760b 138extern uschar *b64encode(const uschar *, int);
35cf75e9 139extern int b64decode(const uschar *, uschar **);
bd8fbe36 140extern int bdat_getc(unsigned);
0d81dabc 141extern uschar *bdat_getbuf(unsigned *);
f6f4a58d 142extern int bdat_ungetc(int);
1ebe15c3
JH		 143extern void bdat_flush_data(void);
144
6c6d6e48
TF		 145extern void bits_clear(unsigned int *, size_t, int *);
146extern void bits_set(unsigned int *, size_t, int *);
147
57cc2785 148extern void cancel_cutthrough_connection(BOOL, const uschar *);
55414b25 149extern int check_host(void *, const uschar *, const uschar **, uschar **);
059ec3d9 150extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
55414b25
JH		 151extern pid_t child_open_uid(const uschar **, const uschar **, int,
152 uid_t *, gid_t *, int *, int *, uschar *, BOOL);
bc3c7bb7 153extern BOOL cleanup_environment(void);
6851a9c5
JH		 154extern void cutthrough_data_puts(uschar *, int);
155extern void cutthrough_data_put_nl(void);
e4bdf652
JH		 156extern uschar *cutthrough_finaldot(void);
157extern BOOL cutthrough_flush_send(void);
158extern BOOL cutthrough_headers_send(void);
159extern BOOL cutthrough_predata(void);
57cc2785 160extern void release_cutthrough_connection(const uschar *);
059ec3d9
PH		 161
162extern void daemon_go(void);
6a8f9482
TK		 163
164#ifdef EXPERIMENTAL_DCC
165extern int dcc_process(uschar **);
166#endif
167
ed7f7860 168extern void debug_logging_activate(uschar *, uschar *);
b0d68adc 169extern void debug_logging_stop(void);
55414b25 170extern void debug_print_argv(const uschar **);
059ec3d9 171extern void debug_print_ids(uschar *);
e1d04f48 172extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
059ec3d9
PH		 173extern void debug_print_string(uschar *);
174extern void debug_print_tree(tree_node *);
398f9af3 175extern void debug_vprintf(int, const char *, va_list);
6c6d6e48
TF		 176extern void decode_bits(unsigned int *, size_t, int *,
177 uschar *, bit_table *, int, uschar *, int);
059ec3d9 178extern address_item *deliver_make_addr(uschar *, BOOL);
476be7e2 179extern void deliver_init(void);
817d9f57 180extern void delivery_log(int, address_item *, int, uschar *);
059ec3d9 181extern int deliver_message(uschar *, BOOL, BOOL);
e0df1c83 182extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
059ec3d9
PH		 183extern void deliver_set_expansions(address_item *);
184extern int deliver_split_address(address_item *);
185extern void deliver_succeeded(address_item *);
a39bd74d
JB		 186
187extern uschar *deliver_get_sender_address (uschar *id);
57cc2785 188extern void delivery_re_exec(int);
a39bd74d 189
1ba28e2b 190extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
80a47a2c 191#ifndef DISABLE_DKIM
fc2ba7b9 192extern uschar *dkim_exim_query_dns_txt(const uschar *);
617d3932
JH		 193extern void dkim_exim_sign_init(void);
194
42055a33 195extern BOOL dkim_transport_write_message(transport_ctx *,
b9df1829 196 struct ob_dkim *, const uschar ** errstr);
f7572e5a 197#endif
059ec3d9 198extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
476be7e2 199extern int dns_basic_lookup(dns_answer *, const uschar *, int);
55414b25 200extern void dns_build_reverse(const uschar *, uschar *);
3462da30 201extern time_t dns_expire_from_soa(dns_answer *);
8c51eead 202extern void dns_init(BOOL, BOOL, BOOL);
0539a19d 203extern BOOL dns_is_aa(const dns_answer *);
1dc92d5a 204extern BOOL dns_is_secure(const dns_answer *);
55414b25 205extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
476be7e2 206extern void dns_pattern_init(void);
55414b25 207extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
dd708fd7 208extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
059ec3d9 209extern uschar *dns_text_type(int);
36a3ae5f 210extern void dscp_list_to_stream(FILE *);
9e4f5962 211extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
059ec3d9
PH		 212
213extern void enq_end(uschar *);
e8ae7214 214extern BOOL enq_start(uschar *, unsigned);
0cbf2b82 215#ifndef DISABLE_EVENT
55414b25 216extern uschar *event_raise(uschar *, const uschar *, uschar *);
5ef5dd52 217extern void msg_event_raise(const uschar *, const address_item *);
774ef2d7 218#endif
b66fecb4
HSHR		 219
220extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
37f3dc43 221extern const uschar * exim_errstr(int);
1d1e7973 222extern void exim_exit(int, const uschar *) NORETURN;
059ec3d9
PH		 223extern void exim_nullstd(void);
224extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
f3ebb786 225extern void exim_underbar_exit(int);
059ec3d9 226extern void exim_wait_tick(struct timeval *, int);
9c695f6d
JH		 227extern int exp_bool(address_item *addr,
228 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
229 uschar *svalue, BOOL *rvalue);
059ec3d9 230extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
617d3932 231extern uschar *expand_file_big_buffer(const uschar *);
93a6fce2
JH		 232extern uschar *expand_string(uschar *); /* public, cannot make const */
233extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
f42deca9 234extern uschar *expand_hide_passwords(uschar * );
55414b25 235extern uschar *expand_string_copy(const uschar *);
97d17305 236extern int_eximarith_t expand_string_integer(uschar *, BOOL);
d9b2312b 237extern void modify_variable(uschar *, void *);
059ec3d9 238
0a5441fc 239extern BOOL fd_ready(int, time_t);
4e71661f 240
059ec3d9
PH		 241extern int filter_interpret(uschar *, int, address_item **, uschar **);
242extern BOOL filter_personal(string_item *, BOOL);
f05da2e8 243extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
059ec3d9
PH		 244extern BOOL filter_system_interpret(address_item **, uschar **);
245
362145b5
JH		 246extern uschar * fn_hdrs_added(void);
247
1ba28e2b 248extern void header_add(int, const char *, ...);
049782c0 249extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
059ec3d9
PH		 250extern int header_checkname(header_line *, BOOL);
251extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
7cd1141b 252extern int host_address_extract_port(uschar *);
059ec3d9 253extern uschar *host_and_ident(BOOL);
55414b25
JH		 254extern int host_aton(const uschar *, int *);
255extern void host_build_hostlist(host_item **, const uschar *, BOOL);
256extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
059ec3d9
PH		 257extern void host_build_log_info(void);
258extern void host_build_sender_fullhost(void);
a207d5dd 259extern int host_find_byname(host_item *, const uschar *, int,
1f155f8e 260 const uschar **, BOOL);
55414b25 261extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
7cd171b7 262 uschar *, const dnssec_domains *, const uschar **, BOOL *);
059ec3d9 263extern ip_address_item *host_find_interfaces(void);
55414b25 264extern BOOL host_is_in_net(const uschar *, const uschar *, int);
059ec3d9 265extern BOOL host_is_tls_on_connect_port(int);
7cd1141b 266extern int host_item_get_port(host_item *);
059ec3d9
PH		 267extern void host_mask(int, int *, int);
268extern int host_name_lookup(void);
6f0c9a4f 269extern int host_nmtoa(int, int *, int, uschar *, int);
059ec3d9
PH		 270extern uschar *host_ntoa(int, const void *, uschar *, int *);
271extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
272
94431adb 273extern uschar *imap_utf7_encode(uschar *, const uschar *,
ed0512a1
JH		 274 uschar, uschar *, uschar **);
275
83e029d5 276extern void invert_address(uschar *, uschar *);
7eb6c37c 277extern int ip_addr(void *, int, const uschar *, int);
059ec3d9 278extern int ip_bind(int, int, uschar *, int);
0ab63f3d 279extern int ip_connect(int, int, const uschar *, int, int, const blob *);
b1f8e4f8 280extern int ip_connectedsocket(int, const uschar *, int, int,
4a5cbaff 281 int, host_item *, uschar **, const blob *);
13363eba 282extern int ip_get_address_family(int);
55414b25 283extern void ip_keepalive(int, const uschar *, BOOL);
0a5441fc 284extern int ip_recv(client_conn_ctx *, uschar *, int, time_t);
059ec3d9
PH		 285extern int ip_socket(int, int);
286
3e60dd41
JH		 287extern int ip_tcpsocket(const uschar *, uschar **, int);
288extern int ip_unixsocket(const uschar *, uschar **);
289extern int ip_streamsocket(const uschar *, uschar **, int);
290
fc4a7f70
JH		 291extern int ipv6_nmtoa(int *, uschar *);
292
921b12ca 293extern uschar *local_part_quote(uschar *);
4840604e 294extern int log_create(uschar *);
921b12ca 295extern int log_create_as_exim(uschar *);
059ec3d9
PH		 296extern void log_close_all(void);
297
d185889f 298extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
c246a1de
JH		 299extern BOOL macro_read_assignment(uschar *);
300extern uschar *macros_expand(int, int *, BOOL *);
9cd319d9 301extern void mainlog_close(void);
8523533c 302#ifdef WITH_CONTENT_SCAN
0f0c8159 303extern int malware(const uschar *, int);
dbc4b90d 304extern int malware_in_file(uschar *);
476be7e2 305extern void malware_init(void);
c11d665d 306extern void malware_show_supported(FILE *);
8523533c 307#endif
55414b25
JH		 308extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
309 unsigned int *, int, int, const uschar **);
36d295f1 310extern int match_address_list_basic(const uschar *, const uschar **, int);
55414b25
JH		 311extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
312 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
313 const uschar *, const uschar **);
314extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
315 unsigned int *, int, BOOL, const uschar **);
316extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
317 const uschar **);
059ec3d9
PH		 318extern void md5_end(md5 *, const uschar *, int, uschar *);
319extern void md5_mid(md5 *, const uschar *);
320extern void md5_start(md5 *);
321extern void millisleep(int);
8523533c
TK		 322#ifdef WITH_CONTENT_SCAN
323struct mime_boundary_context;
54cdb463
PH		 324extern int mime_acl_check(uschar *acl, FILE *f,
325 struct mime_boundary_context *, uschar **, uschar **);
55414b25 326extern int mime_decode(const uschar **);
f4d091fb 327extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
55414b25 328extern int mime_regex(const uschar **);
f4d091fb 329extern void mime_set_anomaly(int);
8523533c 330#endif
059ec3d9
PH		 331extern uschar *moan_check_errorcopy(uschar *);
332extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
333 BOOL, uschar *);
e0df1c83 334extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
5455f548
JH		 335extern BOOL moan_send_message(uschar *, int, error_block *eblock,
336 header_line *, FILE *, uschar *);
1ba28e2b 337extern void moan_tell_someone(uschar *, address_item *,
e0df1c83 338 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
059ec3d9 339extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
0e22dfd1 340extern void moan_write_from(FILE *);
d6c829b9 341extern void moan_write_references(FILE *, uschar *);
1ba28e2b 342extern FILE *modefopen(const uschar *, const char *, mode_t);
059ec3d9 343
f9334a28 344extern int open_cutthrough_connection( address_item * addr );
e4bdf652 345
059ec3d9
PH		 346extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
347 BOOL);
348extern int parse_forward_list(uschar *, int, address_item **, uschar **,
55414b25 349 const uschar *, uschar *, error_block **);
059ec3d9
PH		 350extern uschar *parse_find_address_end(uschar *, BOOL);
351extern uschar *parse_find_at(uschar *);
55414b25 352extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
30dba1e6 353extern uschar *parse_message_id(uschar *, uschar **, uschar **);
55414b25 354extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
43ad7b7d 355extern uschar *parse_date_time(uschar *str, time_t *t);
17c76198 356extern int vaguely_random_number(int);
01603eec 357#ifndef DISABLE_TLS
17c76198
PP		 358extern int vaguely_random_number_fallback(int);
359#endif
059ec3d9
PH		 360
361extern BOOL queue_action(uschar *, int, uschar **, int, int);
362extern void queue_check_only(void);
363extern void queue_list(int, uschar **, int);
364extern void queue_count(void);
365extern void queue_run(uschar *, uschar *, BOOL);
366
367extern int random_number(int);
aeb65e91 368extern const uschar *rc_to_string(int);
e4a89c47 369extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
efd9a422
MH		 370 uschar *, uschar *, uschar *, ugid_block *, address_item **,
371 uschar **, error_block **, int *, uschar *);
059ec3d9
PH		 372extern int rda_is_filter(const uschar *);
373extern BOOL readconf_depends(driver_instance *, uschar *);
374extern void readconf_driver_init(uschar *, driver_instance **,
375 driver_info *, int, void *, int, optionlist *, int);
376extern uschar *readconf_find_option(void *);
34e86e20 377extern void readconf_main(BOOL);
383832ef 378extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
2be324ee 379extern BOOL readconf_print(uschar *, uschar *, BOOL);
059ec3d9
PH		 380extern uschar *readconf_printtime(int);
381extern uschar *readconf_readname(uschar *, int, uschar *);
1ad6489e 382extern int readconf_readtime(const uschar *, int, BOOL);
bf3c2c6b 383extern void readconf_rest(void);
55414b25 384extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
bf3c2c6b 385extern void readconf_save_config(const uschar *);
328895cc 386extern void read_message_body(BOOL);
1d1e7973 387extern void receive_bomb_out(uschar *, uschar *) NORETURN;
059ec3d9
PH		 388extern BOOL receive_check_fs(int);
389extern BOOL receive_check_set_sender(uschar *);
390extern BOOL receive_msg(BOOL);
a45431fa 391extern int_eximarith_t receive_statvfs(BOOL, int *);
059ec3d9 392extern void receive_swallow_smtp(void);
8523533c 393#ifdef WITH_CONTENT_SCAN
55414b25 394extern int regex(const uschar **);
8523533c 395#endif
1dc92d5a 396extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
476be7e2 397extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
059ec3d9 398extern void retry_add_item(address_item *, uschar *, int);
55414b25 399extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
059ec3d9 400 uschar **, uschar **);
55414b25
JH		 401extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
402extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
ba9af0af 403 dbdata_retry *, time_t);
059ec3d9
PH		 404extern void retry_update(address_item **, address_item **, address_item **);
405extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
406extern uschar *rewrite_address_qualify(uschar *, BOOL);
55414b25
JH		 407extern header_line *rewrite_header(header_line *,
408 const uschar *, const uschar *,
059ec3d9
PH		 409 rewrite_rule *, int, BOOL);
410extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
411 rewrite_rule *);
412extern void rewrite_test(uschar *);
413extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
414 uschar **);
415extern int route_address(address_item *, address_item **, address_item **,
416 address_item **, address_item **, int);
55414b25
JH		 417extern int route_check_prefix(const uschar *, const uschar *);
418extern int route_check_suffix(const uschar *, const uschar *);
059ec3d9 419extern BOOL route_findgroup(uschar *, gid_t *);
55414b25 420extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
059ec3d9
PH		 421extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
422 uschar **);
423extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
424 struct passwd **, uid_t *, uschar **);
425extern void route_init(void);
adf73d37 426extern void route_show_supported(FILE *);
059ec3d9
PH		 427extern void route_tidyup(void);
428
55414b25 429extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
059ec3d9 430 int, int *);
55414b25
JH		 431extern int search_findtype(const uschar *, int);
432extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
059ec3d9
PH		 433 int *);
434extern void *search_open(uschar *, int, int, uid_t *, gid_t *);
435extern void search_tidyup(void);
e0df1c83 436extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
5fb822fc
JH		 437extern void sha1_end(hctx *, const uschar *, int, uschar *);
438extern void sha1_mid(hctx *, const uschar *);
439extern void sha1_start(hctx *);
e4a89c47 440extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
efd9a422 441 uschar *, address_item **, uschar **);
059ec3d9 442extern void sigalrm_handler(int);
58eb016e 443extern BOOL smtp_buffered(void);
059ec3d9 444extern void smtp_closedown(uschar *);
1d1e7973
JH		 445extern void smtp_command_timeout_exit(void) NORETURN;
446extern void smtp_command_sigterm_exit(void) NORETURN;
447extern void smtp_data_timeout_exit(void) NORETURN;
448extern void smtp_data_sigint_exit(void) NORETURN;
a09f2942 449extern uschar *smtp_cmd_hist(void);
ee8b8090 450extern int smtp_connect(smtp_connect_args *, const blob *);
7eb6c37c 451extern int smtp_sock_connect(host_item *, int, int, uschar *,
0ab63f3d 452 transport_instance * tb, int, const blob *);
059ec3d9
PH		 453extern int smtp_feof(void);
454extern int smtp_ferror(void);
455extern uschar *smtp_get_connection_info(void);
6f6dedcc 456extern BOOL smtp_get_interface(uschar *, int, address_item *,
059ec3d9
PH		 457 uschar **, uschar *);
458extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
bd8fbe36 459extern int smtp_getc(unsigned);
0d81dabc 460extern uschar *smtp_getbuf(unsigned *);
584e96c6 461extern void smtp_get_cache(void);
059ec3d9 462extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
b4ed4da0 463extern void smtp_log_no_mail(void);
4f6ae5c3 464extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
1d1e7973 465extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
251b9eb4 466extern BOOL smtp_read_response(void *, uschar *, int, int, int);
f3ebb786 467extern void *smtp_reset(void *);
a5bd321b 468extern void smtp_respond(uschar *, int, BOOL, uschar *);
8f128379 469extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
58c30e47 470extern void smtp_port_for_connect(host_item *, int);
059ec3d9
PH		 471extern void smtp_send_prohibition_message(int, uschar *);
472extern int smtp_setup_msg(void);
473extern BOOL smtp_start_session(void);
474extern int smtp_ungetc(int);
d7b47fd0 475extern BOOL smtp_verify_helo(void);
251b9eb4 476extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
8523533c 477#ifdef WITH_CONTENT_SCAN
55414b25 478extern int spam(const uschar **);
040721f2 479extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
8523533c 480#endif
4b4856ff 481extern void spool_clear_header_globals(void);
4b4856ff 482extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
789f8a4f 483extern int spool_open_datafile(uschar *);
059ec3d9
PH		 484extern int spool_open_temp(uschar *);
485extern int spool_read_header(uschar *, BOOL, BOOL);
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);
f3ebb786
JH		 491
492extern void store_exit(void);
acec9514
JH		 493extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
494extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
495extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
bce15b62 496extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
059ec3d9 497extern uschar *string_base62(unsigned long int);
acec9514
JH		 498extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
499extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
84bbb4d8 500extern int string_compare_by_pointer(const void *, const void *);
059ec3d9 501extern uschar *string_copy_dnsdomain(uschar *);
55414b25 502extern uschar *string_copy_malloc(const uschar *);
55414b25 503extern uschar *string_dequote(const uschar **);
059ec3d9 504extern uschar *string_format_size(int, uschar *);
55414b25 505extern int string_interpret_escape(const uschar **);
b1f8e4f8 506extern int string_is_ip_address(const uschar *, int *);
8c5d388a 507#ifdef SUPPORT_I18N
0d7911ea
JH		 508extern BOOL string_is_utf8(const uschar *);
509#endif
55414b25 510extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
55414b25 511extern const uschar *string_printing2(const uschar *, BOOL);
e28326d8 512extern uschar *string_split_message(uschar *);
c7396ac5 513extern uschar *string_unprinting(uschar *);
8c5d388a 514#ifdef SUPPORT_I18N
3c8b3577 515extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
0d7911ea
JH		 516extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
517extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
518extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
519extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
520#endif
f3ebb786
JH		 521
522#define string_format(buf, siz, fmt, ...) \
523 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
524extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
525 const char *, ...) ALMOST_PRINTF(5,6);
526
527#define string_vformat(g, flgs, fmt, ap) \
528 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
529 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
530extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
531 unsigned, unsigned, const char *, va_list);
532
533#define string_open_failed(eno, fmt, ...) \
534 string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
535extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
536 const char *, ...) PRINTF_FUNCTION(4,5);
537
1ba28e2b
PP		 538extern int strcmpic(const uschar *, const uschar *);
539extern int strncmpic(const uschar *, const uschar *, int);
059ec3d9
PH		 540extern uschar *strstric(uschar *, uschar *, BOOL);
541
10ac8d7f
JH		 542#ifdef EXIM_TFO_PROBE
543extern void tfo_probe(void);
544#endif
32dfdf8b 545extern void tls_modify_variables(tls_support *);
059ec3d9 546extern uschar *tod_stamp(int);
41afb5cb 547
55414b25 548extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
a39bd74d 549 BOOL *, oicf, void*);
059ec3d9 550extern void transport_init(void);
57cc2785
JH		 551extern void transport_do_pass_socket(const uschar *, const uschar *,
552 const uschar *, uschar *, int);
55414b25 553extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
059ec3d9
PH		 554 int);
555extern uschar *transport_rcpt_address(address_item *, BOOL);
55414b25
JH		 556extern BOOL transport_set_up_command(const uschar ***, uschar *,
557 BOOL, int, address_item *, uschar *, uschar **);
059ec3d9 558extern void transport_update_waiting(host_item *, uschar *);
42055a33
JH		 559extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
560extern void transport_write_reset(int);
1ba28e2b 561extern BOOL transport_write_string(int, const char *, ...);
42055a33
JH		 562extern BOOL transport_headers_send(transport_ctx *,
563 BOOL (*)(transport_ctx *, uschar *, int));
adf73d37 564extern void transport_show_supported(FILE *);
42055a33 565extern BOOL transport_write_message(transport_ctx *, int);
059ec3d9
PH		 566extern void tree_add_duplicate(uschar *, address_item *);
567extern void tree_add_nonrecipient(uschar *);
568extern void tree_add_unusable(host_item *);
b4f579d1 569extern void tree_dup(tree_node **, tree_node *);
059ec3d9 570extern int tree_insertnode(tree_node **, tree_node *);
55414b25 571extern tree_node *tree_search(tree_node *, const uschar *);
059ec3d9 572extern void tree_write(tree_node *, FILE *);
38a0a95f 573extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
059ec3d9 574
8523533c
TK		 575#ifdef WITH_CONTENT_SCAN
576extern void unspool_mbox(void);
577#endif
8c5d388a 578#ifdef SUPPORT_I18N
fc362fc5
JH		 579extern void utf8_version_report(FILE *);
580#endif
8523533c 581
4deaf07d
PH		 582extern int verify_address(address_item *, FILE *, int, int, int, int,
583 uschar *, uschar *, BOOL *);
379ba7d0 584extern int verify_check_dnsbl(int, const uschar **, uschar **);
4deaf07d 585extern int verify_check_header_address(uschar **, uschar **, int, int, int,
fe5b5d0b 586 uschar *, uschar *, int, int *);
059ec3d9 587extern int verify_check_headers(uschar **);
770747fd 588extern int verify_check_header_names_ascii(uschar **);
059ec3d9 589extern int verify_check_host(uschar **);
7c498df1 590extern int verify_check_notblind(BOOL);
3fb3231c 591extern int verify_check_given_host(const uschar **, const host_item *);
55414b25
JH		 592extern int verify_check_this_host(const uschar **, unsigned int *,
593 const uschar*, const uschar *, const uschar **);
059ec3d9
PH		 594extern address_item *verify_checked_sender(uschar *);
595extern void verify_get_ident(int);
596extern BOOL verify_sender(int *, uschar **);
597extern BOOL verify_sender_preliminary(int *, uschar **);
598extern void version_init(void);
599
42055a33 600extern BOOL write_chunk(transport_ctx *, uschar *, int);
17c76198
PP		 601extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
602
6940b3df 603
7172970e 604#if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
b66fecb4 605/* exim_chown - in some NFSv4 setups *seemes* to be an issue with
6940b3df 606chown(<exim-uid>, <exim-gid>).
b66fecb4 607
6940b3df
JH		 608Probably because the idmapping is broken, misconfigured or set up in
609an unusal way. (see Bug 2931). As I'm not sure, if this was a single
610case of misconfiguration, or if there are more such broken systems
611out, I try to impose as least impact as possible and for now just write
612a panic log entry pointing to the bug report. You're encouraged to
613contact the developers, if you experience this issue.
b66fecb4 614
6940b3df
JH		 615fd the file descriptor (or -1 if not valid)
616name the file name for error messages or for file operations,
617 if fd is < 0
618owner the owner
619group the group
b66fecb4 620
6940b3df 621returns 0 on success, -1 on failure */
b66fecb4 622
6940b3df 623static inline int
b66fecb4
HSHR		 624exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
625{
6940b3df
JH		 626return fchown(fd, owner, group)
627 ? exim_chown_failure(fd, name, owner, group) : 0;
b66fecb4
HSHR		 628}
629
6940b3df 630static inline int
b66fecb4
HSHR		 631exim_chown(const uschar *name, uid_t owner, gid_t group)
632{
6940b3df
JH		 633return chown(CCS name, owner, group)
634 ? exim_chown_failure(-1, name, owner, group) : 0;
b66fecb4 635}
e59797e3
JH		 636
637#endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
638/******************************************************************************/
639/* String functions */
640
f3ebb786 641#if !defined(MACRO_PREDEF)
e59797e3
JH		 642/*************************************************
643* Copy and save string *
644*************************************************/
645
646/* This function assumes that memcpy() is faster than strcpy().
647*/
648
e59797e3 649static inline uschar *
f3ebb786 650string_copy_taint_trc(const uschar *s, BOOL tainted, const char * func, int line)
e59797e3
JH		 651{
652int len = Ustrlen(s) + 1;
f3ebb786 653uschar *ss = store_get_3(len, tainted, func, line);
e59797e3
JH		 654memcpy(ss, s, len);
655return ss;
656}
657
f3ebb786
JH		 658#define string_copy_taint(s, tainted) \
659 string_copy_taint_trc((s), tainted, __FUNCTION__, __LINE__)
660
661static inline uschar *
662string_copy(const uschar * s)
663{
664return string_copy_taint((s), is_tainted(s));
665}
666
e59797e3
JH		 667
668/*************************************************
669* Copy, lowercase and save string *
670*************************************************/
671
672/*
673Argument: string to copy
674Returns: copy of string in new store, with letters lowercased
675*/
676
677static inline uschar *
678string_copylc(const uschar *s)
679{
f3ebb786 680uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
e59797e3
JH		 681uschar *p = ss;
682while (*s != 0) *p++ = tolower(*s++);
683*p = 0;
684return ss;
685}
686
687
688
689/*************************************************
690* Copy and save string, given length *
691*************************************************/
692
693/* It is assumed the data contains no zeros. A zero is added
694onto the end.
695
696Arguments:
697 s string to copy
698 n number of characters
699
700Returns: copy of string in new store
701
702This is an API for local_scan hence not static.
703*/
704
705static inline uschar *
706string_copyn(const uschar *s, int n)
707{
f3ebb786 708uschar *ss = store_get(n + 1, is_tainted(s));
e59797e3
JH		 709Ustrncpy(ss, s, n);
710ss[n] = 0;
711return ss;
712}
713
714/*************************************************
715* Copy, lowercase, and save string, given length *
716*************************************************/
717
718/* It is assumed the data contains no zeros. A zero is added
719onto the end.
720
721Arguments:
722 s string to copy
723 n number of characters
724
725Returns: copy of string in new store, with letters lowercased
726*/
727
728static inline uschar *
729string_copynlc(uschar *s, int n)
730{
f3ebb786 731uschar *ss = store_get(n + 1, is_tainted(s));
e59797e3
JH		 732uschar *p = ss;
733while (n-- > 0) *p++ = tolower(*s++);
734*p = 0;
735return ss;
736}
737
738
1a44d9d7 739# ifndef COMPILE_UTILITY
f3ebb786
JH		 740/*************************************************
741* Copy and save string in longterm store *
742*************************************************/
743
744/* This function assumes that memcpy() is faster than strcpy().
745
746Argument: string to copy
747Returns: copy of string in new store
748*/
749
750static inline uschar *
751string_copy_perm(const uschar *s, BOOL force_taint)
752{
753int old_pool = store_pool;
754int len = Ustrlen(s) + 1;
755uschar *ss;
756
757store_pool = POOL_PERM;
758ss = store_get(len, force_taint || is_tainted(s));
759memcpy(ss, s, len);
760store_pool = old_pool;
761return ss;
762}
1a44d9d7 763# endif
f3ebb786
JH		 764
765
766
767/* sprintf into a buffer, taint-unchecked */
768
769static inline void
770string_format_nt(uschar * buf, int siz, const char * fmt, ...)
771{
772gstring gs = { .size = siz, .ptr = 0, .s = buf };
773va_list ap;
774va_start(ap, fmt);
775(void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
776va_end(ap);
777}
778
779
780
e59797e3
JH		 781/******************************************************************************/
782/* Growable-string functions */
783
f3ebb786
JH		 784/* Create a growable-string with some preassigned space */
785
786#define string_get_tainted(size, tainted) \
787 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
e59797e3
JH		 788
789static inline gstring *
f3ebb786 790string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
e59797e3 791{
f3ebb786 792gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
e59797e3
JH		 793g->size = size;
794g->ptr = 0;
795g->s = US(g + 1);
796return g;
797}
798
f3ebb786
JH		 799#define string_get(size) \
800 string_get_trc((size), __FUNCTION__, __LINE__)
801
802static inline gstring *
803string_get_trc(unsigned size, const char * func, unsigned line)
804{
805return string_get_tainted_trc(size, FALSE, func, line);
806}
807
e59797e3
JH		 808/* NUL-terminate the C string in the growable-string, and return it. */
809
810static inline uschar *
811string_from_gstring(gstring * g)
812{
813if (!g) return NULL;
814g->s[g->ptr] = '\0';
815return g->s;
816}
817
f3ebb786
JH		 818
819#define gstring_release_unused(g) \
820 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
821
e59797e3 822static inline void
f3ebb786 823gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
e59797e3 824{
f3ebb786
JH		 825if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
826}
827
828
829/* sprintf-append to a growable-string */
830
831#define string_fmt_append(g, fmt, ...) \
832 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
833 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
834
835#define string_fmt_append_f(g, flgs, fmt, ...) \
836 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
837 flgs, fmt, __VA_ARGS__)
838
839static inline gstring *
840string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
841 unsigned flags, const char *format, ...)
842{
843va_list ap;
844va_start(ap, format);
845g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
846 flags, format, ap);
847va_end(ap);
848return g;
e59797e3
JH		 849}
850
851/******************************************************************************/
8743d3ac
JH		 852
853#define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
854
855static inline dns_answer *
856store_get_dns_answer_trc(const uschar * func, unsigned line)
857{
858return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */
859}
860
59a93276
JH		 861/******************************************************************************/
862/* Routines with knowledge of spool layout */
863
864# ifndef COMPILE_UTILITY
865static inline void
866spool_pname_buf(uschar * buf, int len)
867{
868snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
869}
870
871static inline uschar *
872spool_dname(const uschar * purpose, uschar * subdir)
873{
874return string_sprintf("%s/%s/%s/%s",
875 spool_directory, queue_name, purpose, subdir);
876}
877# endif
878
879static inline uschar *
880spool_sname(const uschar * purpose, uschar * subdir)
881{
882return string_sprintf("%s%s%s%s%s",
883 queue_name, *queue_name ? "/" : "",
884 purpose,
885 *subdir ? "/" : "", subdir);
886}
887
888static inline uschar *
889spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
890 const uschar * suffix)
891{
892return string_sprintf("%s/%s/%s/%s/%s%s",
893 spool_directory, queue_name, purpose, subdir, fname, suffix);
894}
895
9b62f401 896static inline void
59a93276
JH		 897set_subdir_str(uschar * subdir_str, const uschar * name,
898 int search_sequence)
899{
900subdir_str[0] = split_spool_directory == (search_sequence == 0)
901 ? name[5] : '\0';
902subdir_str[1] = '\0';
903}
904
905/******************************************************************************/
9f01e50d
JH		 906static inline void
907timesince(struct timeval * diff, struct timeval * then)
908{
909gettimeofday(diff, NULL);
910diff->tv_sec -= then->tv_sec;
911if ((diff->tv_usec -= then->tv_usec) < 0)
912 {
913 diff->tv_sec--;
914 diff->tv_usec += 1000*1000;
915 }
916}
917
918static inline uschar *
919string_timediff(struct timeval * diff)
920{
921static uschar buf[sizeof("0.000s")];
922
923if (diff->tv_sec >= 5 || !LOGGING(millisec))
924 return readconf_printtime((int)diff->tv_sec);
925
926sprintf(CS buf, "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
927return buf;
928}
929
930
931static inline uschar *
932string_timesince(struct timeval * then)
933{
934struct timeval diff;
935timesince(&diff, then);
936return string_timediff(&diff);
937}
938
939static inline void
940report_time_since(struct timeval * t0, uschar * where)
941{
942# ifdef MEASURE_TIMING
943struct timeval diff;
944timesince(&diff, t0);
945fprintf(stderr, "%d %s:\t%ld.%06ld\n",
946 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
947# endif
948}
949
950
951static inline void
952testharness_pause_ms(int millisec)
953{
954#ifndef MEASURE_TIMING
955if (f.running_in_test_harness) millisleep(millisec);
956#endif
957}
958
eb2fb50d 959#endif /* !MACRO_PREDEF */
b66fecb4
HSHR		 960
961#endif /* _FUNCTIONS_H_ */
acec9514 962
9d1c15ef
JH		 963/* vi: aw
964*/
059ec3d9 965/* End of functions.h */
Unnamed repository; edit this file 'description' to name the repository.