2a2c0dbb8f9fa5bc799253394f525f0c450712e2
[exim.git] / src / src / functions.h
1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
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. */
13 #ifndef _FUNCTIONS_H_
14 #define _FUNCTIONS_H_
15
16 #include <sys/time.h>
17
18
19 #ifdef EXIM_PERL
20 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
21 uschar **) WARN_UNUSED_RESULT;
22 extern void cleanup_perl(void);
23 extern uschar *init_perl(uschar *);
24 #endif
25
26
27 #ifndef DISABLE_TLS
28 extern const char *
29 std_dh_prime_default(void);
30 extern const char *
31 std_dh_prime_named(const uschar *);
32
33 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
34 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
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);
45
46 extern uschar * tls_cert_der_b64(void * cert);
47 extern uschar * tls_cert_fprt_md5(void *);
48 extern uschar * tls_cert_fprt_sha1(void *);
49 extern uschar * tls_cert_fprt_sha256(void *);
50
51 extern void tls_clean_env(void);
52 extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
53 void *, tls_support *, uschar **);
54
55 extern void tls_close(void *, int);
56 extern BOOL tls_could_read(void);
57 extern void tls_daemon_init(void);
58 extern BOOL tls_dropprivs_validate_require_cipher(BOOL);
59 extern BOOL tls_export_cert(uschar *, size_t, void *);
60 extern int tls_feof(void);
61 extern int tls_ferror(void);
62 extern void tls_free_cert(void **);
63 extern int tls_getc(unsigned);
64 extern uschar *tls_getbuf(unsigned *);
65 extern void tls_get_cache(void);
66 extern BOOL tls_import_cert(const uschar *, void **);
67 extern int tls_read(void *, uschar *, size_t);
68 extern int tls_server_start(const uschar *, uschar **);
69 extern BOOL tls_smtp_buffered(void);
70 extern int tls_ungetc(int);
71 extern int tls_write(void *, const uschar *, size_t, BOOL);
72 extern uschar *tls_validate_require_cipher(void);
73 extern void tls_version_report(FILE *);
74 # ifdef USE_OPENSSL
75 extern BOOL tls_openssl_options_parse(uschar *, long *);
76 # endif
77 extern uschar * tls_field_from_dn(uschar *, const uschar *);
78 extern BOOL tls_is_name_for_cert(const uschar *, void *);
79
80 # ifdef SUPPORT_DANE
81 extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
82 # endif
83
84 #endif /*DISABLE_TLS*/
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 **);
91 extern int acl_eval(int, uschar *, uschar **, uschar **);
92
93 extern tree_node *acl_var_create(uschar *);
94 extern void acl_var_write(uschar *, uschar *, void *);
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 **);
100 extern void arc_sign_init(void);
101 extern const uschar *acl_verify_arc(void);
102 extern uschar * fn_arc_domains(void);
103 #endif
104
105 extern void assert_no_variables(void *, int, const char *, int);
106 extern int auth_call_pam(const uschar *, uschar **);
107 extern int auth_call_pwcheck(uschar *, uschar **);
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 **);
111 extern int auth_check_serv_cond(auth_instance *);
112 extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
113 extern int auth_client_item(void *, auth_instance *, const uschar **,
114 unsigned, int, uschar *, int);
115
116
117 extern int auth_get_data(uschar **, const uschar *, int);
118 extern int auth_get_no64_data(uschar **, uschar *);
119 extern int auth_prompt(const uschar *);
120 extern int auth_read_input(const uschar *);
121 extern void auth_show_supported(FILE *);
122 extern uschar *auth_xtextencode(uschar *, int);
123 extern int auth_xtextdecode(uschar *, uschar **);
124
125 #ifdef EXPERIMENTAL_ARC
126 extern gstring *authres_arc(gstring *);
127 #endif
128 #ifndef DISABLE_DKIM
129 extern gstring *authres_dkim(gstring *);
130 #endif
131 #ifdef SUPPORT_DMARC
132 extern gstring *authres_dmarc(gstring *);
133 #endif
134 extern gstring *authres_smtpauth(gstring *);
135 #ifdef SUPPORT_SPF
136 extern gstring *authres_spf(gstring *);
137 #endif
138
139 extern uschar *b64encode(const uschar *, int);
140 extern uschar *b64encode_taint(const uschar *, int, BOOL);
141 extern int b64decode(const uschar *, uschar **);
142 extern int bdat_getc(unsigned);
143 extern uschar *bdat_getbuf(unsigned *);
144 extern int bdat_ungetc(int);
145 extern void bdat_flush_data(void);
146
147 extern void bits_clear(unsigned int *, size_t, int *);
148 extern void bits_set(unsigned int *, size_t, int *);
149
150 extern void cancel_cutthrough_connection(BOOL, const uschar *);
151 extern int check_host(void *, const uschar *, const uschar **, uschar **);
152 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
153 extern pid_t child_open_uid(const uschar **, const uschar **, int,
154 uid_t *, gid_t *, int *, int *, uschar *, BOOL);
155 extern BOOL cleanup_environment(void);
156 extern void cutthrough_data_puts(uschar *, int);
157 extern void cutthrough_data_put_nl(void);
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);
162 extern void release_cutthrough_connection(const uschar *);
163
164 extern void daemon_go(void);
165
166 #ifdef EXPERIMENTAL_DCC
167 extern int dcc_process(uschar **);
168 #endif
169
170 extern void debug_logging_activate(uschar *, uschar *);
171 extern void debug_logging_stop(void);
172 extern void debug_print_argv(const uschar **);
173 extern void debug_print_ids(uschar *);
174 extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
175 extern void debug_print_string(uschar *);
176 extern void debug_print_tree(tree_node *);
177 extern void debug_vprintf(int, const char *, va_list);
178 extern void decode_bits(unsigned int *, size_t, int *,
179 uschar *, bit_table *, int, uschar *, int);
180 extern void delete_pid_file(void);
181 extern address_item *deliver_make_addr(uschar *, BOOL);
182 extern void delivery_log(int, address_item *, int, uschar *);
183 extern int deliver_message(uschar *, BOOL, BOOL);
184 extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
185 extern void deliver_set_expansions(address_item *);
186 extern int deliver_split_address(address_item *);
187 extern void deliver_succeeded(address_item *);
188
189 extern uschar *deliver_get_sender_address (uschar *id);
190 extern void delivery_re_exec(int);
191
192 extern void die_tainted(const uschar *, const uschar *, int);
193 extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
194 #ifndef DISABLE_DKIM
195 extern uschar *dkim_exim_query_dns_txt(const uschar *);
196 extern void dkim_exim_sign_init(void);
197
198 extern BOOL dkim_transport_write_message(transport_ctx *,
199 struct ob_dkim *, const uschar ** errstr);
200 #endif
201 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
202 extern int dns_basic_lookup(dns_answer *, const uschar *, int);
203 extern uschar *dns_build_reverse(const uschar *);
204 extern time_t dns_expire_from_soa(dns_answer *, int);
205 extern void dns_init(BOOL, BOOL, BOOL);
206 extern BOOL dns_is_aa(const dns_answer *);
207 extern BOOL dns_is_secure(const dns_answer *);
208 extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
209 extern void dns_pattern_init(void);
210 extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
211 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
212 extern uschar *dns_text_type(int);
213 extern void dscp_list_to_stream(FILE *);
214 extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
215
216 extern void enq_end(uschar *);
217 extern BOOL enq_start(uschar *, unsigned);
218 #ifndef DISABLE_EVENT
219 extern uschar *event_raise(uschar *, const uschar *, uschar *);
220 extern void msg_event_raise(const uschar *, const address_item *);
221 #endif
222
223 extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
224 extern const uschar * exim_errstr(int);
225 extern void exim_exit(int, const uschar *) NORETURN;
226 extern void exim_nullstd(void);
227 extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
228 extern void exim_underbar_exit(int);
229 extern void exim_wait_tick(struct timeval *, int);
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);
233 extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
234 extern uschar *expand_file_big_buffer(const uschar *);
235 extern uschar *expand_string(uschar *); /* public, cannot make const */
236 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
237 extern uschar *expand_hide_passwords(uschar * );
238 extern uschar *expand_string_copy(const uschar *);
239 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
240 extern void modify_variable(uschar *, void *);
241
242 extern BOOL fd_ready(int, time_t);
243
244 extern int filter_interpret(uschar *, int, address_item **, uschar **);
245 extern BOOL filter_personal(string_item *, BOOL);
246 extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
247 extern BOOL filter_system_interpret(address_item **, uschar **);
248
249 extern uschar * fn_hdrs_added(void);
250
251 extern void header_add(int, const char *, ...);
252 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
253 extern int header_checkname(header_line *, BOOL);
254 extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
255 extern int host_address_extract_port(uschar *);
256 extern uschar *host_and_ident(BOOL);
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 *);
260 extern void host_build_log_info(void);
261 extern void host_build_sender_fullhost(void);
262 extern int host_find_byname(host_item *, const uschar *, int,
263 const uschar **, BOOL);
264 extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
265 uschar *, const dnssec_domains *, const uschar **, BOOL *);
266 extern ip_address_item *host_find_interfaces(void);
267 extern BOOL host_is_in_net(const uschar *, const uschar *, int);
268 extern BOOL host_is_tls_on_connect_port(int);
269 extern int host_item_get_port(host_item *);
270 extern void host_mask(int, int *, int);
271 extern int host_name_lookup(void);
272 extern int host_nmtoa(int, int *, int, uschar *, int);
273 extern uschar *host_ntoa(int, const void *, uschar *, int *);
274 extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
275
276 extern uschar *imap_utf7_encode(uschar *, const uschar *,
277 uschar, uschar *, uschar **);
278
279 extern void invert_address(uschar *, uschar *);
280 extern int ip_addr(void *, int, const uschar *, int);
281 extern int ip_bind(int, int, uschar *, int);
282 extern int ip_connect(int, int, const uschar *, int, int, const blob *);
283 extern int ip_connectedsocket(int, const uschar *, int, int,
284 int, host_item *, uschar **, const blob *);
285 extern int ip_get_address_family(int);
286 extern void ip_keepalive(int, const uschar *, BOOL);
287 extern int ip_recv(client_conn_ctx *, uschar *, int, time_t);
288 extern int ip_socket(int, int);
289
290 extern int ip_tcpsocket(const uschar *, uschar **, int);
291 extern int ip_unixsocket(const uschar *, uschar **);
292 extern int ip_streamsocket(const uschar *, uschar **, int);
293
294 extern int ipv6_nmtoa(int *, uschar *);
295
296 extern uschar *local_part_quote(uschar *);
297 extern int log_create(uschar *);
298 extern int log_create_as_exim(uschar *);
299 extern void log_close_all(void);
300
301 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
302 extern BOOL macro_read_assignment(uschar *);
303 extern uschar *macros_expand(int, int *, BOOL *);
304 extern void mainlog_close(void);
305 #ifdef WITH_CONTENT_SCAN
306 extern int malware(const uschar *, int);
307 extern int malware_in_file(uschar *);
308 extern void malware_init(void);
309 extern void malware_show_supported(FILE *);
310 #endif
311 extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
312 unsigned int *, int, int, const uschar **);
313 extern int match_address_list_basic(const uschar *, const uschar **, int);
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 **);
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);
325 #ifdef WITH_CONTENT_SCAN
326 struct mime_boundary_context;
327 extern int mime_acl_check(uschar *acl, FILE *f,
328 struct mime_boundary_context *, uschar **, uschar **);
329 extern int mime_decode(const uschar **);
330 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
331 extern int mime_regex(const uschar **);
332 extern void mime_set_anomaly(int);
333 #endif
334 extern uschar *moan_check_errorcopy(uschar *);
335 extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
336 BOOL, uschar *);
337 extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
338 extern BOOL moan_send_message(uschar *, int, error_block *eblock,
339 header_line *, FILE *, uschar *);
340 extern void moan_tell_someone(uschar *, address_item *,
341 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
342 extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
343 extern void moan_write_from(FILE *);
344 extern void moan_write_references(FILE *, uschar *);
345 extern FILE *modefopen(const uschar *, const char *, mode_t);
346
347 extern int open_cutthrough_connection( address_item * addr );
348
349 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
350 BOOL);
351 extern int parse_forward_list(uschar *, int, address_item **, uschar **,
352 const uschar *, uschar *, error_block **);
353 extern uschar *parse_find_address_end(uschar *, BOOL);
354 extern uschar *parse_find_at(uschar *);
355 extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
356 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
357 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
358 extern uschar *parse_date_time(uschar *str, time_t *t);
359 extern int vaguely_random_number(int);
360 #ifndef DISABLE_TLS
361 extern int vaguely_random_number_fallback(int);
362 #endif
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);
371 extern const uschar *rc_to_string(int);
372 extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
373 uschar *, uschar *, uschar *, ugid_block *, address_item **,
374 uschar **, error_block **, int *, uschar *);
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 *);
380 extern void readconf_main(BOOL);
381 extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
382 extern BOOL readconf_print(uschar *, uschar *, BOOL);
383 extern uschar *readconf_printtime(int);
384 extern uschar *readconf_readname(uschar *, int, uschar *);
385 extern int readconf_readtime(const uschar *, int, BOOL);
386 extern void readconf_rest(void);
387 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
388 extern void readconf_save_config(const uschar *);
389 extern void read_message_body(BOOL);
390 extern void receive_bomb_out(uschar *, uschar *) NORETURN;
391 extern BOOL receive_check_fs(int);
392 extern BOOL receive_check_set_sender(uschar *);
393 extern BOOL receive_msg(BOOL);
394 extern int_eximarith_t receive_statvfs(BOOL, int *);
395 extern void receive_swallow_smtp(void);
396 #ifdef WITH_CONTENT_SCAN
397 extern int regex(const uschar **);
398 #endif
399 extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
400 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
401 extern void retry_add_item(address_item *, uschar *, int);
402 extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
403 uschar **, uschar **);
404 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
405 extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
406 dbdata_retry *, time_t);
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);
410 extern header_line *rewrite_header(header_line *,
411 const uschar *, const uschar *,
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);
420 extern int route_check_prefix(const uschar *, const uschar *);
421 extern int route_check_suffix(const uschar *, const uschar *);
422 extern BOOL route_findgroup(uschar *, gid_t *);
423 extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
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);
429 extern void route_show_supported(FILE *);
430 extern void route_tidyup(void);
431
432 extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
433 int, int *);
434 extern int search_findtype(const uschar *, int);
435 extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
436 int *);
437 extern void *search_open(uschar *, int, int, uid_t *, gid_t *);
438 extern void search_tidyup(void);
439 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
440 extern void sha1_end(hctx *, const uschar *, int, uschar *);
441 extern void sha1_mid(hctx *, const uschar *);
442 extern void sha1_start(hctx *);
443 extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
444 uschar *, address_item **, uschar **);
445 extern void sigalrm_handler(int);
446 extern BOOL smtp_buffered(void);
447 extern void smtp_closedown(uschar *);
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;
452 extern void smtp_deliver_init(void);
453 extern uschar *smtp_cmd_hist(void);
454 extern int smtp_connect(smtp_connect_args *, const blob *);
455 extern int smtp_sock_connect(host_item *, int, int, uschar *,
456 transport_instance * tb, int, const blob *);
457 extern int smtp_feof(void);
458 extern int smtp_ferror(void);
459 extern uschar *smtp_get_connection_info(void);
460 extern BOOL smtp_get_interface(uschar *, int, address_item *,
461 uschar **, uschar *);
462 extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
463 extern int smtp_getc(unsigned);
464 extern uschar *smtp_getbuf(unsigned *);
465 extern void smtp_get_cache(void);
466 extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
467 extern void smtp_log_no_mail(void);
468 extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
469 extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
470 extern BOOL smtp_read_response(void *, uschar *, int, int, int);
471 extern void *smtp_reset(void *);
472 extern void smtp_respond(uschar *, int, BOOL, uschar *);
473 extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
474 extern void smtp_port_for_connect(host_item *, int);
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);
479 extern BOOL smtp_verify_helo(void);
480 extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
481 #ifdef WITH_CONTENT_SCAN
482 extern int spam(const uschar **);
483 extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
484 #endif
485 extern void spool_clear_header_globals(void);
486 extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
487 extern int spool_open_datafile(uschar *);
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 **);
491 extern int stdin_getc(unsigned);
492 extern int stdin_feof(void);
493 extern int stdin_ferror(void);
494 extern int stdin_ungetc(int);
495
496 extern void store_exit(void);
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;
500 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
501 extern uschar *string_base62(unsigned long int);
502 extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
503 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
504 extern int string_compare_by_pointer(const void *, const void *);
505 extern uschar *string_copy_dnsdomain(uschar *);
506 extern uschar *string_copy_malloc(const uschar *);
507 extern uschar *string_dequote(const uschar **);
508 extern uschar *string_format_size(int, uschar *);
509 extern int string_interpret_escape(const uschar **);
510 extern int string_is_ip_address(const uschar *, int *);
511 #ifdef SUPPORT_I18N
512 extern BOOL string_is_utf8(const uschar *);
513 #endif
514 extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
515 extern const uschar *string_printing2(const uschar *, BOOL);
516 extern uschar *string_split_message(uschar *);
517 extern uschar *string_unprinting(uschar *);
518 #ifdef SUPPORT_I18N
519 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
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
525
526 #define string_format(buf, siz, fmt, ...) \
527 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
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, ...) \
538 string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
539 extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
540 const char *, ...) PRINTF_FUNCTION(4,5);
541
542 extern int strcmpic(const uschar *, const uschar *);
543 extern int strncmpic(const uschar *, const uschar *, int);
544 extern uschar *strstric(uschar *, uschar *, BOOL);
545
546 extern int test_harness_fudged_queue_time(int);
547 extern void tcp_init(void);
548 #ifdef EXIM_TFO_PROBE
549 extern void tfo_probe(void);
550 #endif
551 extern void tls_modify_variables(tls_support *);
552 extern uschar *tod_stamp(int);
553
554 extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
555 BOOL *, oicf, void*);
556 extern void transport_init(void);
557 extern void transport_do_pass_socket(const uschar *, const uschar *,
558 const uschar *, uschar *, int);
559 extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
560 int);
561 extern uschar *transport_rcpt_address(address_item *, BOOL);
562 extern BOOL transport_set_up_command(const uschar ***, uschar *,
563 BOOL, int, address_item *, uschar *, uschar **);
564 extern void transport_update_waiting(host_item *, uschar *);
565 extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
566 extern void transport_write_reset(int);
567 extern BOOL transport_write_string(int, const char *, ...);
568 extern BOOL transport_headers_send(transport_ctx *,
569 BOOL (*)(transport_ctx *, uschar *, int));
570 extern void transport_show_supported(FILE *);
571 extern BOOL transport_write_message(transport_ctx *, int);
572 extern void tree_add_duplicate(uschar *, address_item *);
573 extern void tree_add_nonrecipient(uschar *);
574 extern void tree_add_unusable(host_item *);
575 extern void tree_dup(tree_node **, tree_node *);
576 extern int tree_insertnode(tree_node **, tree_node *);
577 extern tree_node *tree_search(tree_node *, const uschar *);
578 extern void tree_write(tree_node *, FILE *);
579 extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
580
581 #ifdef WITH_CONTENT_SCAN
582 extern void unspool_mbox(void);
583 #endif
584 #ifdef SUPPORT_I18N
585 extern void utf8_version_report(FILE *);
586 #endif
587
588 extern int verify_address(address_item *, FILE *, int, int, int, int,
589 uschar *, uschar *, BOOL *);
590 extern int verify_check_dnsbl(int, const uschar **, uschar **);
591 extern int verify_check_header_address(uschar **, uschar **, int, int, int,
592 uschar *, uschar *, int, int *);
593 extern int verify_check_headers(uschar **);
594 extern int verify_check_header_names_ascii(uschar **);
595 extern int verify_check_host(uschar **);
596 extern int verify_check_notblind(BOOL);
597 extern int verify_check_given_host(const uschar **, const host_item *);
598 extern int verify_check_this_host(const uschar **, unsigned int *,
599 const uschar*, const uschar *, const uschar **);
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
606 extern BOOL write_chunk(transport_ctx *, uschar *, int);
607 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
608
609
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
665 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
666 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
667 chown(<exim-uid>, <exim-gid>).
668
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.
675
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
681
682 returns 0 on success, -1 on failure */
683
684 static inline int
685 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
686 {
687 return fchown(fd, owner, group)
688 ? exim_chown_failure(fd, name, owner, group) : 0;
689 }
690
691 static inline int
692 exim_chown(const uschar *name, uid_t owner, gid_t group)
693 {
694 return chown(CCS name, owner, group)
695 ? exim_chown_failure(-1, name, owner, group) : 0;
696 }
697 #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
698
699 /******************************************************************************/
700 /* String functions */
701
702 #if !defined(MACRO_PREDEF)
703 /*************************************************
704 * Copy and save string *
705 *************************************************/
706
707 /* This function assumes that memcpy() is faster than strcpy().
708 */
709
710 static inline uschar *
711 string_copy_taint_trc(const uschar *s, BOOL tainted, const char * func, int line)
712 {
713 int len = Ustrlen(s) + 1;
714 uschar *ss = store_get_3(len, tainted, func, line);
715 memcpy(ss, s, len);
716 return ss;
717 }
718
719 #define string_copy_taint(s, tainted) \
720 string_copy_taint_trc((s), tainted, __FUNCTION__, __LINE__)
721
722 static inline uschar *
723 string_copy(const uschar * s)
724 {
725 return string_copy_taint((s), is_tainted(s));
726 }
727
728
729 /*************************************************
730 * Copy, lowercase and save string *
731 *************************************************/
732
733 /*
734 Argument: string to copy
735 Returns: copy of string in new store, with letters lowercased
736 */
737
738 static inline uschar *
739 string_copylc(const uschar *s)
740 {
741 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
742 uschar *p = ss;
743 while (*s != 0) *p++ = tolower(*s++);
744 *p = 0;
745 return ss;
746 }
747
748
749
750 /*************************************************
751 * Copy and save string, given length *
752 *************************************************/
753
754 /* It is assumed the data contains no zeros. A zero is added
755 onto the end.
756
757 Arguments:
758 s string to copy
759 n number of characters
760
761 Returns: copy of string in new store
762
763 This is an API for local_scan hence not static.
764 */
765
766 static inline uschar *
767 string_copyn(const uschar *s, int n)
768 {
769 uschar *ss = store_get(n + 1, is_tainted(s));
770 Ustrncpy(ss, s, n);
771 ss[n] = 0;
772 return ss;
773 }
774
775 /*************************************************
776 * Copy, lowercase, and save string, given length *
777 *************************************************/
778
779 /* It is assumed the data contains no zeros. A zero is added
780 onto the end.
781
782 Arguments:
783 s string to copy
784 n number of characters
785
786 Returns: copy of string in new store, with letters lowercased
787 */
788
789 static inline uschar *
790 string_copynlc(uschar *s, int n)
791 {
792 uschar *ss = store_get(n + 1, is_tainted(s));
793 uschar *p = ss;
794 while (n-- > 0) *p++ = tolower(*s++);
795 *p = 0;
796 return ss;
797 }
798
799
800 # ifndef COMPILE_UTILITY
801 /*************************************************
802 * Copy and save string in longterm store *
803 *************************************************/
804
805 /* This function assumes that memcpy() is faster than strcpy().
806
807 Argument: string to copy
808 Returns: copy of string in new store
809 */
810
811 static inline uschar *
812 string_copy_perm(const uschar *s, BOOL force_taint)
813 {
814 int old_pool = store_pool;
815 int len = Ustrlen(s) + 1;
816 uschar *ss;
817
818 store_pool = POOL_PERM;
819 ss = store_get(len, force_taint || is_tainted(s));
820 memcpy(ss, s, len);
821 store_pool = old_pool;
822 return ss;
823 }
824 # endif
825
826
827
828 /* sprintf into a buffer, taint-unchecked */
829
830 static inline void
831 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
832 {
833 gstring gs = { .size = siz, .ptr = 0, .s = buf };
834 va_list ap;
835 va_start(ap, fmt);
836 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
837 va_end(ap);
838 }
839
840
841
842 /******************************************************************************/
843 /* Growable-string functions */
844
845 /* Create a growable-string with some preassigned space */
846
847 #define string_get_tainted(size, tainted) \
848 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
849
850 static inline gstring *
851 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
852 {
853 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
854 g->size = size;
855 g->ptr = 0;
856 g->s = US(g + 1);
857 return g;
858 }
859
860 #define string_get(size) \
861 string_get_trc((size), __FUNCTION__, __LINE__)
862
863 static inline gstring *
864 string_get_trc(unsigned size, const char * func, unsigned line)
865 {
866 return string_get_tainted_trc(size, FALSE, func, line);
867 }
868
869 /* NUL-terminate the C string in the growable-string, and return it. */
870
871 static inline uschar *
872 string_from_gstring(gstring * g)
873 {
874 if (!g) return NULL;
875 g->s[g->ptr] = '\0';
876 return g->s;
877 }
878
879 static inline unsigned
880 gstring_length(const gstring * g)
881 {
882 return g ? (unsigned)g->ptr : 0;
883 }
884
885
886 #define gstring_release_unused(g) \
887 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
888
889 static inline void
890 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
891 {
892 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
893 }
894
895
896 /* sprintf-append to a growable-string */
897
898 #define string_fmt_append(g, fmt, ...) \
899 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
900 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
901
902 #define string_fmt_append_f(g, flgs, fmt, ...) \
903 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
904 flgs, fmt, __VA_ARGS__)
905
906 static inline gstring *
907 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
908 unsigned flags, const char *format, ...)
909 {
910 va_list ap;
911 va_start(ap, format);
912 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
913 flags, format, ap);
914 va_end(ap);
915 return g;
916 }
917
918 /******************************************************************************/
919
920 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
921
922 static inline dns_answer *
923 store_get_dns_answer_trc(const uschar * func, unsigned line)
924 {
925 return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */
926 }
927
928 /******************************************************************************/
929 /* Routines with knowledge of spool layout */
930
931 # ifndef COMPILE_UTILITY
932 static inline void
933 spool_pname_buf(uschar * buf, int len)
934 {
935 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
936 }
937
938 static inline uschar *
939 spool_dname(const uschar * purpose, uschar * subdir)
940 {
941 return string_sprintf("%s/%s/%s/%s",
942 spool_directory, queue_name, purpose, subdir);
943 }
944 # endif
945
946 static inline uschar *
947 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
948 {
949 return string_sprintf("%s%s%s%s%s",
950 q, *q ? "/" : "",
951 purpose,
952 *subdir ? "/" : "", subdir);
953 }
954
955 static inline uschar *
956 spool_sname(const uschar * purpose, uschar * subdir)
957 {
958 return spool_q_sname(purpose, queue_name, subdir);
959 }
960
961 static inline uschar *
962 spool_q_fname(const uschar * purpose, const uschar * q,
963 const uschar * subdir, const uschar * fname, const uschar * suffix)
964 {
965 return string_sprintf("%s/%s/%s/%s/%s%s",
966 spool_directory, q, purpose, subdir, fname, suffix);
967 }
968
969 static inline uschar *
970 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
971 const uschar * suffix)
972 {
973 #ifdef COMPILE_UTILITY /* version avoiding string-extension */
974 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
975 + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
976 uschar * buf = store_get(len, FALSE);
977 string_format(buf, len, "%s/%s/%s/%s/%s%s",
978 spool_directory, queue_name, purpose, subdir, fname, suffix);
979 return buf;
980 #else
981 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
982 #endif
983 }
984
985 static inline void
986 set_subdir_str(uschar * subdir_str, const uschar * name,
987 int search_sequence)
988 {
989 subdir_str[0] = split_spool_directory == (search_sequence == 0)
990 ? name[5] : '\0';
991 subdir_str[1] = '\0';
992 }
993
994 /******************************************************************************/
995 /* Time calculations */
996
997 static inline void
998 timesince(struct timeval * diff, const struct timeval * then)
999 {
1000 gettimeofday(diff, NULL);
1001 diff->tv_sec -= then->tv_sec;
1002 if ((diff->tv_usec -= then->tv_usec) < 0)
1003 {
1004 diff->tv_sec--;
1005 diff->tv_usec += 1000*1000;
1006 }
1007 }
1008
1009 static inline uschar *
1010 string_timediff(const struct timeval * diff)
1011 {
1012 static uschar buf[sizeof("0.000s")];
1013
1014 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1015 return readconf_printtime((int)diff->tv_sec);
1016
1017 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1018 return buf;
1019 }
1020
1021
1022 static inline uschar *
1023 string_timesince(const struct timeval * then)
1024 {
1025 struct timeval diff;
1026 timesince(&diff, then);
1027 return string_timediff(&diff);
1028 }
1029
1030 static inline void
1031 report_time_since(const struct timeval * t0, const uschar * where)
1032 {
1033 # ifdef MEASURE_TIMING
1034 struct timeval diff;
1035 timesince(&diff, t0);
1036 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1037 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1038 # endif
1039 }
1040
1041
1042 static inline void
1043 testharness_pause_ms(int millisec)
1044 {
1045 #ifndef MEASURE_TIMING
1046 if (f.running_in_test_harness) millisleep(millisec);
1047 #endif
1048 }
1049
1050 /******************************************************************************/
1051 /* Taint-checked file opens */
1052
1053 static inline int
1054 exim_open2(const char *pathname, int flags)
1055 {
1056 if (!is_tainted(pathname)) return open(pathname, flags);
1057 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'\n", pathname);
1058 errno = EACCES;
1059 return -1;
1060 }
1061 static inline int
1062 exim_open(const char *pathname, int flags, mode_t mode)
1063 {
1064 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1065 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'\n", pathname);
1066 errno = EACCES;
1067 return -1;
1068 }
1069 static inline int
1070 exim_openat(int dirfd, const char *pathname, int flags)
1071 {
1072 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1073 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'\n", pathname);
1074 errno = EACCES;
1075 return -1;
1076 }
1077 static inline int
1078 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1079 {
1080 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1081 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'\n", pathname);
1082 errno = EACCES;
1083 return -1;
1084 }
1085
1086 static inline FILE *
1087 exim_fopen(const char *pathname, const char *mode)
1088 {
1089 if (!is_tainted(pathname)) return fopen(pathname, mode);
1090 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'\n", pathname);
1091 errno = EACCES;
1092 return NULL;
1093 }
1094
1095 #endif /* !MACRO_PREDEF */
1096
1097 #endif /* _FUNCTIONS_H_ */
1098
1099 /* vi: aw
1100 */
1101 /* End of functions.h */