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