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