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