1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
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. */
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
*);
29 std_dh_prime_default(void);
31 std_dh_prime_named(const uschar
*);
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
);
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 *);
51 extern void tls_clean_env(void);
52 extern BOOL
tls_client_start(client_conn_ctx
*, smtp_connect_args
*,
53 void *, tls_support
*, uschar
**);
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 *);
75 extern BOOL
tls_openssl_options_parse(uschar
*, long *);
77 extern uschar
* tls_field_from_dn(uschar
*, const uschar
*);
78 extern BOOL
tls_is_name_for_cert(const uschar
*, void *);
81 extern int tlsa_lookup(const host_item
*, dns_answer
*, BOOL
);
84 #endif /*DISABLE_TLS*/
87 /* Everything else... */
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
**);
93 extern tree_node
*acl_var_create(uschar
*);
94 extern void acl_var_write(uschar
*, uschar
*, void *);
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);
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);
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
**);
125 #ifdef EXPERIMENTAL_ARC
126 extern gstring
*authres_arc(gstring
*);
129 extern gstring
*authres_dkim(gstring
*);
132 extern gstring
*authres_dmarc(gstring
*);
134 extern gstring
*authres_smtpauth(gstring
*);
136 extern gstring
*authres_spf(gstring
*);
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);
147 extern void bits_clear(unsigned int *, size_t, int *);
148 extern void bits_set(unsigned int *, size_t, int *);
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
*);
164 extern void daemon_go(void);
166 #ifdef EXPERIMENTAL_DCC
167 extern int dcc_process(uschar
**);
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
*);
189 extern uschar
*deliver_get_sender_address (uschar
*id
);
190 extern void delivery_re_exec(int);
192 extern void die_tainted(const uschar
*, const uschar
*, int);
193 extern BOOL
directory_make(const uschar
*, const uschar
*, int, BOOL
);
195 extern uschar
*dkim_exim_query_dns_txt(const uschar
*);
196 extern void dkim_exim_sign_init(void);
198 extern BOOL
dkim_transport_write_message(transport_ctx
*,
199 struct ob_dkim
*, const uschar
** errstr
);
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 *);
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
*);
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 *);
242 extern BOOL
fd_ready(int, time_t);
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
**);
249 extern uschar
* fn_hdrs_added(void);
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
*);
276 extern uschar
*imap_utf7_encode(uschar
*, const uschar
*,
277 uschar
, uschar
*, uschar
**);
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);
290 extern int ip_tcpsocket(const uschar
*, uschar
**, int, host_item
*);
291 extern int ip_unixsocket(const uschar
*, uschar
**);
292 extern int ip_streamsocket(const uschar
*, uschar
**, int, host_item
*);
294 extern int ipv6_nmtoa(int *, uschar
*);
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);
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 *);
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
,
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);
334 extern uschar
*moan_check_errorcopy(uschar
*);
335 extern BOOL
moan_skipped_syntax_errors(uschar
*, error_block
*, 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
);
347 extern int open_cutthrough_connection( address_item
* addr
);
349 extern uschar
*parse_extract_address(uschar
*, uschar
**, int *, int *, int *,
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);
361 extern int vaguely_random_number_fallback(int);
364 extern BOOL
queue_action(uschar
*, int, uschar
**, int, int);
365 extern void queue_check_only(void);
366 extern unsigned queue_count(void);
367 extern unsigned queue_count_cached(void);
368 extern void queue_list(int, uschar
**, int);
369 #ifdef EXPERIMENTAL_QUEUE_RAMP
370 extern void queue_notify_daemon(const uschar
* hostname
);
372 extern void queue_run(uschar
*, uschar
*, BOOL
);
374 extern int random_number(int);
375 extern const uschar
*rc_to_string(int);
376 extern int rda_interpret(redirect_block
*, int, uschar
*, uschar
*,
377 uschar
*, uschar
*, uschar
*, ugid_block
*, address_item
**,
378 uschar
**, error_block
**, int *, uschar
*);
379 extern int rda_is_filter(const uschar
*);
380 extern BOOL
readconf_depends(driver_instance
*, uschar
*);
381 extern void readconf_driver_init(uschar
*, driver_instance
**,
382 driver_info
*, int, void *, int, optionlist
*, int);
383 extern uschar
*readconf_find_option(void *);
384 extern void readconf_main(BOOL
);
385 extern void readconf_options_from_list(optionlist
*, unsigned, const uschar
*, uschar
*);
386 extern BOOL
readconf_print(uschar
*, uschar
*, BOOL
);
387 extern uschar
*readconf_printtime(int);
388 extern uschar
*readconf_readname(uschar
*, int, uschar
*);
389 extern int readconf_readtime(const uschar
*, int, BOOL
);
390 extern void readconf_rest(void);
391 extern uschar
*readconf_retry_error(const uschar
*, const uschar
*, int *, int *);
392 extern void readconf_save_config(const uschar
*);
393 extern void read_message_body(BOOL
);
394 extern void receive_bomb_out(uschar
*, uschar
*) NORETURN
;
395 extern BOOL
receive_check_fs(int);
396 extern BOOL
receive_check_set_sender(uschar
*);
397 extern BOOL
receive_msg(BOOL
);
398 extern int_eximarith_t
receive_statvfs(BOOL
, int *);
399 extern void receive_swallow_smtp(void);
400 #ifdef WITH_CONTENT_SCAN
401 extern int regex(const uschar
**);
403 extern BOOL
regex_match_and_setup(const pcre
*, const uschar
*, int, int);
404 extern const pcre
*regex_must_compile(const uschar
*, BOOL
, BOOL
);
405 extern void retry_add_item(address_item
*, uschar
*, int);
406 extern BOOL
retry_check_address(const uschar
*, host_item
*, uschar
*, BOOL
,
407 uschar
**, uschar
**);
408 extern retry_config
*retry_find_config(const uschar
*, const uschar
*, int, int);
409 extern BOOL
retry_ultimate_address_timeout(uschar
*, const uschar
*,
410 dbdata_retry
*, time_t);
411 extern void retry_update(address_item
**, address_item
**, address_item
**);
412 extern uschar
*rewrite_address(uschar
*, BOOL
, BOOL
, rewrite_rule
*, int);
413 extern uschar
*rewrite_address_qualify(uschar
*, BOOL
);
414 extern header_line
*rewrite_header(header_line
*,
415 const uschar
*, const uschar
*,
416 rewrite_rule
*, int, BOOL
);
417 extern uschar
*rewrite_one(uschar
*, int, BOOL
*, BOOL
, uschar
*,
419 extern void rewrite_test(uschar
*);
420 extern uschar
*rfc2047_decode2(uschar
*, BOOL
, uschar
*, int, int *, int *,
422 extern int route_address(address_item
*, address_item
**, address_item
**,
423 address_item
**, address_item
**, int);
424 extern int route_check_prefix(const uschar
*, const uschar
*, unsigned *);
425 extern int route_check_suffix(const uschar
*, const uschar
*, unsigned *);
426 extern BOOL
route_findgroup(uschar
*, gid_t
*);
427 extern BOOL
route_finduser(const uschar
*, struct passwd
**, uid_t
*);
428 extern BOOL
route_find_expanded_group(uschar
*, uschar
*, uschar
*, gid_t
*,
430 extern BOOL
route_find_expanded_user(uschar
*, uschar
*, uschar
*,
431 struct passwd
**, uid_t
*, uschar
**);
432 extern void route_init(void);
433 extern void route_show_supported(FILE *);
434 extern void route_tidyup(void);
436 extern uschar
*search_find(void *, uschar
*, uschar
*, int, const uschar
*, int,
438 extern int search_findtype(const uschar
*, int);
439 extern int search_findtype_partial(const uschar
*, int *, const uschar
**, int *,
441 extern void *search_open(uschar
*, int, int, uid_t
*, gid_t
*);
442 extern void search_tidyup(void);
443 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
444 extern void sha1_end(hctx
*, const uschar
*, int, uschar
*);
445 extern void sha1_mid(hctx
*, const uschar
*);
446 extern void sha1_start(hctx
*);
447 extern int sieve_interpret(uschar
*, int, uschar
*, uschar
*, uschar
*,
448 uschar
*, address_item
**, uschar
**);
449 extern void sigalrm_handler(int);
450 extern BOOL
smtp_buffered(void);
451 extern void smtp_closedown(uschar
*);
452 extern void smtp_command_timeout_exit(void) NORETURN
;
453 extern void smtp_command_sigterm_exit(void) NORETURN
;
454 extern void smtp_data_timeout_exit(void) NORETURN
;
455 extern void smtp_data_sigint_exit(void) NORETURN
;
456 extern void smtp_deliver_init(void);
457 extern uschar
*smtp_cmd_hist(void);
458 extern int smtp_connect(smtp_connect_args
*, const blob
*);
459 extern int smtp_sock_connect(host_item
*, int, int, uschar
*,
460 transport_instance
* tb
, int, const blob
*);
461 extern int smtp_feof(void);
462 extern int smtp_ferror(void);
463 extern uschar
*smtp_get_connection_info(void);
464 extern BOOL
smtp_get_interface(uschar
*, int, address_item
*,
465 uschar
**, uschar
*);
466 extern BOOL
smtp_get_port(uschar
*, address_item
*, int *, uschar
*);
467 extern int smtp_getc(unsigned);
468 extern uschar
*smtp_getbuf(unsigned *);
469 extern void smtp_get_cache(void);
470 extern int smtp_handle_acl_fail(int, int, uschar
*, uschar
*);
471 extern void smtp_log_no_mail(void);
472 extern void smtp_message_code(uschar
**, int *, uschar
**, uschar
**, BOOL
);
473 extern void smtp_proxy_tls(void *, uschar
*, size_t, int *, int) NORETURN
;
474 extern BOOL
smtp_read_response(void *, uschar
*, int, int, int);
475 extern void *smtp_reset(void *);
476 extern void smtp_respond(uschar
*, int, BOOL
, uschar
*);
477 extern void smtp_notquit_exit(uschar
*, uschar
*, uschar
*, ...);
478 extern void smtp_port_for_connect(host_item
*, int);
479 extern void smtp_send_prohibition_message(int, uschar
*);
480 extern int smtp_setup_msg(void);
481 extern BOOL
smtp_start_session(void);
482 extern int smtp_ungetc(int);
483 extern BOOL
smtp_verify_helo(void);
484 extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
485 #ifdef WITH_CONTENT_SCAN
486 extern int spam(const uschar
**);
487 extern FILE *spool_mbox(unsigned long *, const uschar
*, uschar
**);
489 extern void spool_clear_header_globals(void);
490 extern BOOL
spool_move_message(uschar
*, uschar
*, uschar
*, uschar
*);
491 extern int spool_open_datafile(uschar
*);
492 extern int spool_open_temp(uschar
*);
493 extern int spool_read_header(uschar
*, BOOL
, BOOL
);
494 extern int spool_write_header(uschar
*, int, uschar
**);
495 extern int stdin_getc(unsigned);
496 extern int stdin_feof(void);
497 extern int stdin_ferror(void);
498 extern int stdin_ungetc(int);
500 extern void store_exit(void);
501 extern gstring
*string_append(gstring
*, int, ...) WARN_UNUSED_RESULT
;
502 extern gstring
*string_append_listele(gstring
*, uschar
, const uschar
*) WARN_UNUSED_RESULT
;
503 extern gstring
*string_append_listele_n(gstring
*, uschar
, const uschar
*, unsigned) WARN_UNUSED_RESULT
;
504 extern gstring
*string_append2_listele_n(gstring
*, const uschar
*, const uschar
*, unsigned) WARN_UNUSED_RESULT
;
505 extern uschar
*string_base62(unsigned long int);
506 extern gstring
*string_cat (gstring
*, const uschar
* ) WARN_UNUSED_RESULT
;
507 extern gstring
*string_catn(gstring
*, const uschar
*, int) WARN_UNUSED_RESULT
;
508 extern int string_compare_by_pointer(const void *, const void *);
509 extern uschar
*string_copy_dnsdomain(uschar
*);
510 extern uschar
*string_copy_malloc(const uschar
*);
511 extern uschar
*string_dequote(const uschar
**);
512 extern uschar
*string_format_size(int, uschar
*);
513 extern int string_interpret_escape(const uschar
**);
514 extern int string_is_ip_address(const uschar
*, int *);
516 extern BOOL
string_is_utf8(const uschar
*);
518 extern uschar
*string_nextinlist(const uschar
**, int *, uschar
*, int);
519 extern const uschar
*string_printing2(const uschar
*, BOOL
);
520 extern uschar
*string_split_message(uschar
*);
521 extern uschar
*string_unprinting(uschar
*);
523 extern uschar
*string_address_utf8_to_alabel(const uschar
*, uschar
**);
524 extern uschar
*string_domain_alabel_to_utf8(const uschar
*, uschar
**);
525 extern uschar
*string_domain_utf8_to_alabel(const uschar
*, uschar
**);
526 extern uschar
*string_localpart_alabel_to_utf8(const uschar
*, uschar
**);
527 extern uschar
*string_localpart_utf8_to_alabel(const uschar
*, uschar
**);
530 #define string_format(buf, siz, fmt, ...) \
531 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
532 extern BOOL
string_format_trc(uschar
*, int, const uschar
*, unsigned,
533 const char *, ...) ALMOST_PRINTF(5,6);
535 #define string_vformat(g, flgs, fmt, ap) \
536 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
537 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
538 extern gstring
*string_vformat_trc(gstring
*, const uschar
*, unsigned,
539 unsigned, unsigned, const char *, va_list);
541 #define string_open_failed(eno, fmt, ...) \
542 string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
543 extern uschar
*string_open_failed_trc(int, const uschar
*, unsigned,
544 const char *, ...) PRINTF_FUNCTION(4,5);
546 extern int strcmpic(const uschar
*, const uschar
*);
547 extern int strncmpic(const uschar
*, const uschar
*, int);
548 extern uschar
*strstric(uschar
*, uschar
*, BOOL
);
550 extern int test_harness_fudged_queue_time(int);
551 extern void tcp_init(void);
552 #ifdef EXIM_TFO_PROBE
553 extern void tfo_probe(void);
555 extern void tls_modify_variables(tls_support
*);
556 extern uschar
*tod_stamp(int);
558 extern BOOL
transport_check_waiting(const uschar
*, const uschar
*, int, uschar
*,
559 BOOL
*, oicf
, void*);
560 extern void transport_init(void);
561 extern void transport_do_pass_socket(const uschar
*, const uschar
*,
562 const uschar
*, uschar
*, int);
563 extern BOOL
transport_pass_socket(const uschar
*, const uschar
*, const uschar
*, uschar
*,
565 extern uschar
*transport_rcpt_address(address_item
*, BOOL
);
566 extern BOOL
transport_set_up_command(const uschar
***, uschar
*,
567 BOOL
, int, address_item
*, uschar
*, uschar
**);
568 extern void transport_update_waiting(host_item
*, uschar
*);
569 extern BOOL
transport_write_block(transport_ctx
*, uschar
*, int, BOOL
);
570 extern void transport_write_reset(int);
571 extern BOOL
transport_write_string(int, const char *, ...);
572 extern BOOL
transport_headers_send(transport_ctx
*,
573 BOOL (*)(transport_ctx
*, uschar
*, int));
574 extern void transport_show_supported(FILE *);
575 extern BOOL
transport_write_message(transport_ctx
*, int);
576 extern void tree_add_duplicate(uschar
*, address_item
*);
577 extern void tree_add_nonrecipient(uschar
*);
578 extern void tree_add_unusable(host_item
*);
579 extern void tree_dup(tree_node
**, tree_node
*);
580 extern int tree_insertnode(tree_node
**, tree_node
*);
581 extern tree_node
*tree_search(tree_node
*, const uschar
*);
582 extern void tree_write(tree_node
*, FILE *);
583 extern void tree_walk(tree_node
*, void (*)(uschar
*, uschar
*, void*), void *);
585 #ifdef WITH_CONTENT_SCAN
586 extern void unspool_mbox(void);
589 extern void utf8_version_report(FILE *);
592 extern int verify_address(address_item
*, FILE *, int, int, int, int,
593 uschar
*, uschar
*, BOOL
*);
594 extern int verify_check_dnsbl(int, const uschar
**, uschar
**);
595 extern int verify_check_header_address(uschar
**, uschar
**, int, int, int,
596 uschar
*, uschar
*, int, int *);
597 extern int verify_check_headers(uschar
**);
598 extern int verify_check_header_names_ascii(uschar
**);
599 extern int verify_check_host(uschar
**);
600 extern int verify_check_notblind(BOOL
);
601 extern int verify_check_given_host(const uschar
**, const host_item
*);
602 extern int verify_check_this_host(const uschar
**, unsigned int *,
603 const uschar
*, const uschar
*, const uschar
**);
604 extern address_item
*verify_checked_sender(uschar
*);
605 extern void verify_get_ident(int);
606 extern BOOL
verify_sender(int *, uschar
**);
607 extern BOOL
verify_sender_preliminary(int *, uschar
**);
608 extern void version_init(void);
610 extern BOOL
write_chunk(transport_ctx
*, uschar
*, int);
611 extern ssize_t
write_to_fd_buf(int, const uschar
*, size_t);
614 /******************************************************************************/
615 /* Predicate: if an address is in a tainted pool.
616 By extension, a variable pointing to this address is tainted.
620 is_tainted(const void * p
)
622 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
626 extern BOOL
is_tainted_fn(const void *);
627 return is_tainted_fn(p
);
631 /******************************************************************************/
632 /* String functions */
633 static inline uschar
* __Ustrcat(uschar
* dst
, const uschar
* src
, const char * func
, int line
)
635 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
636 if (!is_tainted(dst
) && is_tainted(src
)) die_tainted(US
"Ustrcat", CUS func
, line
);
638 return US
strcat(CS dst
, CCS src
);
640 static inline uschar
* __Ustrcpy(uschar
* dst
, const uschar
* src
, const char * func
, int line
)
642 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
643 if (!is_tainted(dst
) && is_tainted(src
)) die_tainted(US
"Ustrcpy", CUS func
, line
);
645 return US
strcpy(CS dst
, CCS src
);
647 static inline uschar
* __Ustrncat(uschar
* dst
, const uschar
* src
, size_t n
, const char * func
, int line
)
649 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
650 if (!is_tainted(dst
) && is_tainted(src
)) die_tainted(US
"Ustrncat", CUS func
, line
);
652 return US
strncat(CS dst
, CCS src
, n
);
654 static inline uschar
* __Ustrncpy(uschar
* dst
, const uschar
* src
, size_t n
, const char * func
, int line
)
656 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
657 if (!is_tainted(dst
) && is_tainted(src
)) die_tainted(US
"Ustrncpy", CUS func
, line
);
659 return US
strncpy(CS dst
, CCS src
, n
);
661 /*XXX will likely need unchecked copy also */
664 /******************************************************************************/
666 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
667 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
668 chown(<exim-uid>, <exim-gid>).
670 Probably because the idmapping is broken, misconfigured or set up in
671 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
672 case of misconfiguration, or if there are more such broken systems
673 out, I try to impose as least impact as possible and for now just write
674 a panic log entry pointing to the bug report. You're encouraged to
675 contact the developers, if you experience this issue.
677 fd the file descriptor (or -1 if not valid)
678 name the file name for error messages or for file operations,
683 returns 0 on success, -1 on failure */
686 exim_fchown(int fd
, uid_t owner
, gid_t group
, const uschar
*name
)
688 return fchown(fd
, owner
, group
)
689 ? exim_chown_failure(fd
, name
, owner
, group
) : 0;
693 exim_chown(const uschar
*name
, uid_t owner
, gid_t group
)
695 return chown(CCS name
, owner
, group
)
696 ? exim_chown_failure(-1, name
, owner
, group
) : 0;
698 #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
700 /******************************************************************************/
701 /* String functions */
703 #if !defined(MACRO_PREDEF)
704 /*************************************************
705 * Copy and save string *
706 *************************************************/
708 /* This function assumes that memcpy() is faster than strcpy().
711 static inline uschar
*
712 string_copy_taint_trc(const uschar
*s
, BOOL tainted
, const char * func
, int line
)
714 int len
= Ustrlen(s
) + 1;
715 uschar
*ss
= store_get_3(len
, tainted
, func
, line
);
720 #define string_copy_taint(s, tainted) \
721 string_copy_taint_trc((s), tainted, __FUNCTION__, __LINE__)
723 static inline uschar
*
724 string_copy_trc(const uschar
* s
, const char * func
, int line
)
726 return string_copy_taint_trc((s
), is_tainted(s
), func
, line
);
729 #define string_copy(s) \
730 string_copy_trc((s), __FUNCTION__, __LINE__)
733 /*************************************************
734 * Copy, lowercase and save string *
735 *************************************************/
738 Argument: string to copy
739 Returns: copy of string in new store, with letters lowercased
742 static inline uschar
*
743 string_copylc(const uschar
*s
)
745 uschar
*ss
= store_get(Ustrlen(s
) + 1, is_tainted(s
));
747 while (*s
!= 0) *p
++ = tolower(*s
++);
754 /*************************************************
755 * Copy and save string, given length *
756 *************************************************/
758 /* It is assumed the data contains no zeros. A zero is added
763 n number of characters
765 Returns: copy of string in new store
767 This is an API for local_scan hence not static.
770 static inline uschar
*
771 string_copyn(const uschar
*s
, int n
)
773 uschar
*ss
= store_get(n
+ 1, is_tainted(s
));
779 /*************************************************
780 * Copy, lowercase, and save string, given length *
781 *************************************************/
783 /* It is assumed the data contains no zeros. A zero is added
788 n number of characters
790 Returns: copy of string in new store, with letters lowercased
793 static inline uschar
*
794 string_copynlc(uschar
*s
, int n
)
796 uschar
*ss
= store_get(n
+ 1, is_tainted(s
));
798 while (n
-- > 0) *p
++ = tolower(*s
++);
804 # ifndef COMPILE_UTILITY
805 /*************************************************
806 * Copy and save string in longterm store *
807 *************************************************/
809 /* This function assumes that memcpy() is faster than strcpy().
811 Argument: string to copy
812 Returns: copy of string in new store
815 static inline uschar
*
816 string_copy_perm(const uschar
*s
, BOOL force_taint
)
818 int old_pool
= store_pool
;
819 int len
= Ustrlen(s
) + 1;
822 store_pool
= POOL_PERM
;
823 ss
= store_get(len
, force_taint
|| is_tainted(s
));
825 store_pool
= old_pool
;
832 /* sprintf into a buffer, taint-unchecked */
835 string_format_nt(uschar
* buf
, int siz
, const char * fmt
, ...)
837 gstring gs
= { .size
= siz
, .ptr
= 0, .s
= buf
};
840 (void) string_vformat(&gs
, SVFMT_TAINT_NOCHK
, fmt
, ap
);
846 /******************************************************************************/
847 /* Growable-string functions */
849 /* Create a growable-string with some preassigned space */
851 #define string_get_tainted(size, tainted) \
852 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
854 static inline gstring
*
855 string_get_tainted_trc(unsigned size
, BOOL tainted
, const char * func
, unsigned line
)
857 gstring
* g
= store_get_3(sizeof(gstring
) + size
, tainted
, func
, line
);
864 #define string_get(size) \
865 string_get_trc((size), __FUNCTION__, __LINE__)
867 static inline gstring
*
868 string_get_trc(unsigned size
, const char * func
, unsigned line
)
870 return string_get_tainted_trc(size
, FALSE
, func
, line
);
873 /* NUL-terminate the C string in the growable-string, and return it. */
875 static inline uschar
*
876 string_from_gstring(gstring
* g
)
883 static inline unsigned
884 gstring_length(const gstring
* g
)
886 return g
? (unsigned)g
->ptr
: 0;
890 #define gstring_release_unused(g) \
891 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
894 gstring_release_unused_trc(gstring
* g
, const char * file
, unsigned line
)
896 if (g
) store_release_above_3(g
->s
+ (g
->size
= g
->ptr
+ 1), file
, line
);
900 /* sprintf-append to a growable-string */
902 #define string_fmt_append(g, fmt, ...) \
903 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
904 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
906 #define string_fmt_append_f(g, flgs, fmt, ...) \
907 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
908 flgs, fmt, __VA_ARGS__)
910 static inline gstring
*
911 string_fmt_append_f_trc(gstring
* g
, const uschar
* func
, unsigned line
,
912 unsigned flags
, const char *format
, ...)
915 va_start(ap
, format
);
916 g
= string_vformat_trc(g
, func
, line
, STRING_SPRINTF_BUFFER_SIZE
,
922 /******************************************************************************/
924 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
926 static inline dns_answer
*
927 store_get_dns_answer_trc(const uschar
* func
, unsigned line
)
929 return store_get_3(sizeof(dns_answer
), TRUE
, CCS func
, line
); /* use tainted mem */
932 /******************************************************************************/
933 /* Routines with knowledge of spool layout */
935 # ifndef COMPILE_UTILITY
937 spool_pname_buf(uschar
* buf
, int len
)
939 snprintf(CS buf
, len
, "%s/%s/input", spool_directory
, queue_name
);
942 static inline uschar
*
943 spool_dname(const uschar
* purpose
, uschar
* subdir
)
945 return string_sprintf("%s/%s/%s/%s",
946 spool_directory
, queue_name
, purpose
, subdir
);
950 static inline uschar
*
951 spool_q_sname(const uschar
* purpose
, const uschar
* q
, uschar
* subdir
)
953 return string_sprintf("%s%s%s%s%s",
956 *subdir
? "/" : "", subdir
);
959 static inline uschar
*
960 spool_sname(const uschar
* purpose
, uschar
* subdir
)
962 return spool_q_sname(purpose
, queue_name
, subdir
);
965 static inline uschar
*
966 spool_q_fname(const uschar
* purpose
, const uschar
* q
,
967 const uschar
* subdir
, const uschar
* fname
, const uschar
* suffix
)
969 return string_sprintf("%s/%s/%s/%s/%s%s",
970 spool_directory
, q
, purpose
, subdir
, fname
, suffix
);
973 static inline uschar
*
974 spool_fname(const uschar
* purpose
, const uschar
* subdir
, const uschar
* fname
,
975 const uschar
* suffix
)
977 #ifdef COMPILE_UTILITY /* version avoiding string-extension */
978 int len
= Ustrlen(spool_directory
) + 1 + Ustrlen(queue_name
) + 1 + Ustrlen(purpose
) + 1
979 + Ustrlen(subdir
) + 1 + Ustrlen(fname
) + Ustrlen(suffix
) + 1;
980 uschar
* buf
= store_get(len
, FALSE
);
981 string_format(buf
, len
, "%s/%s/%s/%s/%s%s",
982 spool_directory
, queue_name
, purpose
, subdir
, fname
, suffix
);
985 return spool_q_fname(purpose
, queue_name
, subdir
, fname
, suffix
);
990 set_subdir_str(uschar
* subdir_str
, const uschar
* name
,
993 subdir_str
[0] = split_spool_directory
== (search_sequence
== 0)
995 subdir_str
[1] = '\0';
998 /******************************************************************************/
999 /* Time calculations */
1002 timesince(struct timeval
* diff
, const struct timeval
* then
)
1004 gettimeofday(diff
, NULL
);
1005 diff
->tv_sec
-= then
->tv_sec
;
1006 if ((diff
->tv_usec
-= then
->tv_usec
) < 0)
1009 diff
->tv_usec
+= 1000*1000;
1013 static inline uschar
*
1014 string_timediff(const struct timeval
* diff
)
1016 static uschar buf
[sizeof("0.000s")];
1018 if (diff
->tv_sec
>= 5 || !LOGGING(millisec
))
1019 return readconf_printtime((int)diff
->tv_sec
);
1021 snprintf(CS buf
, sizeof(buf
), "%u.%03us", (uint
)diff
->tv_sec
, (uint
)diff
->tv_usec
/1000);
1026 static inline uschar
*
1027 string_timesince(const struct timeval
* then
)
1029 struct timeval diff
;
1030 timesince(&diff
, then
);
1031 return string_timediff(&diff
);
1035 report_time_since(const struct timeval
* t0
, const uschar
* where
)
1037 # ifdef MEASURE_TIMING
1038 struct timeval diff
;
1039 timesince(&diff
, t0
);
1040 fprintf(stderr
, "%d %s:\t%ld.%06ld\n",
1041 (uint
)getpid(), where
, (long)diff
.tv_sec
, (long)diff
.tv_usec
);
1047 testharness_pause_ms(int millisec
)
1049 #ifndef MEASURE_TIMING
1050 if (f
.running_in_test_harness
&& f
.testsuite_delays
) millisleep(millisec
);
1054 /******************************************************************************/
1055 /* Taint-checked file opens */
1058 exim_open2(const char *pathname
, int flags
)
1060 if (!is_tainted(pathname
)) return open(pathname
, flags
);
1061 log_write(0, LOG_MAIN
|LOG_PANIC
, "Tainted filename '%s'\n", pathname
);
1066 exim_open(const char *pathname
, int flags
, mode_t mode
)
1068 if (!is_tainted(pathname
)) return open(pathname
, flags
, mode
);
1069 log_write(0, LOG_MAIN
|LOG_PANIC
, "Tainted filename '%s'\n", pathname
);
1074 exim_openat(int dirfd
, const char *pathname
, int flags
)
1076 if (!is_tainted(pathname
)) return openat(dirfd
, pathname
, flags
);
1077 log_write(0, LOG_MAIN
|LOG_PANIC
, "Tainted filename '%s'\n", pathname
);
1082 exim_openat4(int dirfd
, const char *pathname
, int flags
, mode_t mode
)
1084 if (!is_tainted(pathname
)) return openat(dirfd
, pathname
, flags
, mode
);
1085 log_write(0, LOG_MAIN
|LOG_PANIC
, "Tainted filename '%s'\n", pathname
);
1090 static inline FILE *
1091 exim_fopen(const char *pathname
, const char *mode
)
1093 if (!is_tainted(pathname
)) return fopen(pathname
, mode
);
1094 log_write(0, LOG_MAIN
|LOG_PANIC
, "Tainted filename '%s'\n", pathname
);
1099 #endif /* !MACRO_PREDEF */
1101 #endif /* _FUNCTIONS_H_ */
1105 /* End of functions.h */