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