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 BOOL
directory_make(const uschar
*, const uschar
*, int, BOOL
);
194 extern uschar
*dkim_exim_query_dns_txt(const uschar
*);
195 extern void dkim_exim_sign_init(void);
197 extern BOOL
dkim_transport_write_message(transport_ctx
*,
198 struct ob_dkim
*, const uschar
** errstr
);
200 extern dns_address
*dns_address_from_rr(dns_answer
*, dns_record
*);
201 extern int dns_basic_lookup(dns_answer
*, const uschar
*, int);
202 extern uschar
*dns_build_reverse(const uschar
*);
203 extern time_t dns_expire_from_soa(dns_answer
*, int);
204 extern void dns_init(BOOL
, BOOL
, BOOL
);
205 extern BOOL
dns_is_aa(const dns_answer
*);
206 extern BOOL
dns_is_secure(const dns_answer
*);
207 extern int dns_lookup(dns_answer
*, const uschar
*, int, const uschar
**);
208 extern void dns_pattern_init(void);
209 extern int dns_special_lookup(dns_answer
*, const uschar
*, int, const uschar
**);
210 extern dns_record
*dns_next_rr(const dns_answer
*, dns_scan
*, int);
211 extern uschar
*dns_text_type(int);
212 extern void dscp_list_to_stream(FILE *);
213 extern BOOL
dscp_lookup(const uschar
*, int, int *, int *, int *);
215 extern void enq_end(uschar
*);
216 extern BOOL
enq_start(uschar
*, unsigned);
217 #ifndef DISABLE_EVENT
218 extern uschar
*event_raise(uschar
*, const uschar
*, uschar
*);
219 extern void msg_event_raise(const uschar
*, const address_item
*);
222 extern int exim_chown_failure(int, const uschar
*, uid_t
, gid_t
);
223 extern const uschar
* exim_errstr(int);
224 extern void exim_exit(int, const uschar
*) NORETURN
;
225 extern void exim_nullstd(void);
226 extern void exim_setugid(uid_t
, gid_t
, BOOL
, uschar
*);
227 extern void exim_underbar_exit(int);
228 extern void exim_wait_tick(struct timeval
*, int);
229 extern int exp_bool(address_item
*addr
,
230 uschar
*mtype
, uschar
*mname
, unsigned dgb_opt
, uschar
*oname
, BOOL bvalue
,
231 uschar
*svalue
, BOOL
*rvalue
);
232 extern BOOL
expand_check_condition(uschar
*, uschar
*, uschar
*);
233 extern uschar
*expand_file_big_buffer(const uschar
*);
234 extern uschar
*expand_string(uschar
*); /* public, cannot make const */
235 extern const uschar
*expand_cstring(const uschar
*); /* ... so use this one */
236 extern uschar
*expand_hide_passwords(uschar
* );
237 extern uschar
*expand_string_copy(const uschar
*);
238 extern int_eximarith_t
expand_string_integer(uschar
*, BOOL
);
239 extern void modify_variable(uschar
*, void *);
241 extern BOOL
fd_ready(int, time_t);
243 extern int filter_interpret(uschar
*, int, address_item
**, uschar
**);
244 extern BOOL
filter_personal(string_item
*, BOOL
);
245 extern BOOL
filter_runtest(int, uschar
*, BOOL
, BOOL
);
246 extern BOOL
filter_system_interpret(address_item
**, uschar
**);
248 extern uschar
* fn_hdrs_added(void);
250 extern void header_add(int, const char *, ...);
251 extern header_line
*header_add_at_position_internal(BOOL
, uschar
*, BOOL
, int, const char *, ...);
252 extern int header_checkname(header_line
*, BOOL
);
253 extern BOOL
header_match(uschar
*, BOOL
, BOOL
, string_item
*, int, ...);
254 extern int host_address_extract_port(uschar
*);
255 extern uschar
*host_and_ident(BOOL
);
256 extern int host_aton(const uschar
*, int *);
257 extern void host_build_hostlist(host_item
**, const uschar
*, BOOL
);
258 extern ip_address_item
*host_build_ifacelist(const uschar
*, uschar
*);
259 extern void host_build_log_info(void);
260 extern void host_build_sender_fullhost(void);
261 extern int host_find_byname(host_item
*, const uschar
*, int,
262 const uschar
**, BOOL
);
263 extern int host_find_bydns(host_item
*, const uschar
*, int, uschar
*, uschar
*,
264 uschar
*, const dnssec_domains
*, const uschar
**, BOOL
*);
265 extern ip_address_item
*host_find_interfaces(void);
266 extern BOOL
host_is_in_net(const uschar
*, const uschar
*, int);
267 extern BOOL
host_is_tls_on_connect_port(int);
268 extern int host_item_get_port(host_item
*);
269 extern void host_mask(int, int *, int);
270 extern int host_name_lookup(void);
271 extern int host_nmtoa(int, int *, int, uschar
*, int);
272 extern uschar
*host_ntoa(int, const void *, uschar
*, int *);
273 extern int host_scan_for_local_hosts(host_item
*, host_item
**, BOOL
*);
275 extern uschar
*imap_utf7_encode(uschar
*, const uschar
*,
276 uschar
, uschar
*, uschar
**);
278 extern void invert_address(uschar
*, uschar
*);
279 extern int ip_addr(void *, int, const uschar
*, int);
280 extern int ip_bind(int, int, uschar
*, int);
281 extern int ip_connect(int, int, const uschar
*, int, int, const blob
*);
282 extern int ip_connectedsocket(int, const uschar
*, int, int,
283 int, host_item
*, uschar
**, const blob
*);
284 extern int ip_get_address_family(int);
285 extern void ip_keepalive(int, const uschar
*, BOOL
);
286 extern int ip_recv(client_conn_ctx
*, uschar
*, int, time_t);
287 extern int ip_socket(int, int);
289 extern int ip_tcpsocket(const uschar
*, uschar
**, int);
290 extern int ip_unixsocket(const uschar
*, uschar
**);
291 extern int ip_streamsocket(const uschar
*, uschar
**, int);
293 extern int ipv6_nmtoa(int *, uschar
*);
295 extern uschar
*local_part_quote(uschar
*);
296 extern int log_create(uschar
*);
297 extern int log_create_as_exim(uschar
*);
298 extern void log_close_all(void);
300 extern macro_item
* macro_create(const uschar
*, const uschar
*, BOOL
);
301 extern BOOL
macro_read_assignment(uschar
*);
302 extern uschar
*macros_expand(int, int *, BOOL
*);
303 extern void mainlog_close(void);
304 #ifdef WITH_CONTENT_SCAN
305 extern int malware(const uschar
*, int);
306 extern int malware_in_file(uschar
*);
307 extern void malware_init(void);
308 extern void malware_show_supported(FILE *);
310 extern int match_address_list(const uschar
*, BOOL
, BOOL
, const uschar
**,
311 unsigned int *, int, int, const uschar
**);
312 extern int match_address_list_basic(const uschar
*, const uschar
**, int);
313 extern int match_check_list(const uschar
**, int, tree_node
**, unsigned int **,
314 int(*)(void *, const uschar
*, const uschar
**, uschar
**), void *, int,
315 const uschar
*, const uschar
**);
316 extern int match_isinlist(const uschar
*, const uschar
**, int, tree_node
**,
317 unsigned int *, int, BOOL
, const uschar
**);
318 extern int match_check_string(const uschar
*, const uschar
*, int, BOOL
, BOOL
, BOOL
,
320 extern void md5_end(md5
*, const uschar
*, int, uschar
*);
321 extern void md5_mid(md5
*, const uschar
*);
322 extern void md5_start(md5
*);
323 extern void millisleep(int);
324 #ifdef WITH_CONTENT_SCAN
325 struct mime_boundary_context
;
326 extern int mime_acl_check(uschar
*acl
, FILE *f
,
327 struct mime_boundary_context
*, uschar
**, uschar
**);
328 extern int mime_decode(const uschar
**);
329 extern ssize_t
mime_decode_base64(FILE *, FILE *, uschar
*);
330 extern int mime_regex(const uschar
**);
331 extern void mime_set_anomaly(int);
333 extern uschar
*moan_check_errorcopy(uschar
*);
334 extern BOOL
moan_skipped_syntax_errors(uschar
*, error_block
*, uschar
*,
336 extern void moan_smtp_batch(uschar
*, const char *, ...) PRINTF_FUNCTION(2,3);
337 extern BOOL
moan_send_message(uschar
*, int, error_block
*eblock
,
338 header_line
*, FILE *, uschar
*);
339 extern void moan_tell_someone(uschar
*, address_item
*,
340 const uschar
*, const char *, ...) PRINTF_FUNCTION(4,5);
341 extern BOOL
moan_to_sender(int, error_block
*, header_line
*, FILE *, BOOL
);
342 extern void moan_write_from(FILE *);
343 extern void moan_write_references(FILE *, uschar
*);
344 extern FILE *modefopen(const uschar
*, const char *, mode_t
);
346 extern int open_cutthrough_connection( address_item
* addr
);
348 extern uschar
*parse_extract_address(uschar
*, uschar
**, int *, int *, int *,
350 extern int parse_forward_list(uschar
*, int, address_item
**, uschar
**,
351 const uschar
*, uschar
*, error_block
**);
352 extern uschar
*parse_find_address_end(uschar
*, BOOL
);
353 extern uschar
*parse_find_at(uschar
*);
354 extern const uschar
*parse_fix_phrase(const uschar
*, int, uschar
*, int);
355 extern uschar
*parse_message_id(uschar
*, uschar
**, uschar
**);
356 extern const uschar
*parse_quote_2047(const uschar
*, int, uschar
*, uschar
*, int, BOOL
);
357 extern uschar
*parse_date_time(uschar
*str
, time_t *t
);
358 extern int vaguely_random_number(int);
360 extern int vaguely_random_number_fallback(int);
363 extern BOOL
queue_action(uschar
*, int, uschar
**, int, int);
364 extern void queue_check_only(void);
365 extern void queue_list(int, uschar
**, int);
366 extern void queue_count(void);
367 extern void queue_run(uschar
*, uschar
*, BOOL
);
369 extern int random_number(int);
370 extern const uschar
*rc_to_string(int);
371 extern int rda_interpret(redirect_block
*, int, uschar
*, uschar
*,
372 uschar
*, uschar
*, uschar
*, ugid_block
*, address_item
**,
373 uschar
**, error_block
**, int *, uschar
*);
374 extern int rda_is_filter(const uschar
*);
375 extern BOOL
readconf_depends(driver_instance
*, uschar
*);
376 extern void readconf_driver_init(uschar
*, driver_instance
**,
377 driver_info
*, int, void *, int, optionlist
*, int);
378 extern uschar
*readconf_find_option(void *);
379 extern void readconf_main(BOOL
);
380 extern void readconf_options_from_list(optionlist
*, unsigned, const uschar
*, uschar
*);
381 extern BOOL
readconf_print(uschar
*, uschar
*, BOOL
);
382 extern uschar
*readconf_printtime(int);
383 extern uschar
*readconf_readname(uschar
*, int, uschar
*);
384 extern int readconf_readtime(const uschar
*, int, BOOL
);
385 extern void readconf_rest(void);
386 extern uschar
*readconf_retry_error(const uschar
*, const uschar
*, int *, int *);
387 extern void readconf_save_config(const uschar
*);
388 extern void read_message_body(BOOL
);
389 extern void receive_bomb_out(uschar
*, uschar
*) NORETURN
;
390 extern BOOL
receive_check_fs(int);
391 extern BOOL
receive_check_set_sender(uschar
*);
392 extern BOOL
receive_msg(BOOL
);
393 extern int_eximarith_t
receive_statvfs(BOOL
, int *);
394 extern void receive_swallow_smtp(void);
395 #ifdef WITH_CONTENT_SCAN
396 extern int regex(const uschar
**);
398 extern BOOL
regex_match_and_setup(const pcre
*, const uschar
*, int, int);
399 extern const pcre
*regex_must_compile(const uschar
*, BOOL
, BOOL
);
400 extern void retry_add_item(address_item
*, uschar
*, int);
401 extern BOOL
retry_check_address(const uschar
*, host_item
*, uschar
*, BOOL
,
402 uschar
**, uschar
**);
403 extern retry_config
*retry_find_config(const uschar
*, const uschar
*, int, int);
404 extern BOOL
retry_ultimate_address_timeout(uschar
*, const uschar
*,
405 dbdata_retry
*, time_t);
406 extern void retry_update(address_item
**, address_item
**, address_item
**);
407 extern uschar
*rewrite_address(uschar
*, BOOL
, BOOL
, rewrite_rule
*, int);
408 extern uschar
*rewrite_address_qualify(uschar
*, BOOL
);
409 extern header_line
*rewrite_header(header_line
*,
410 const uschar
*, const uschar
*,
411 rewrite_rule
*, int, BOOL
);
412 extern uschar
*rewrite_one(uschar
*, int, BOOL
*, BOOL
, uschar
*,
414 extern void rewrite_test(uschar
*);
415 extern uschar
*rfc2047_decode2(uschar
*, BOOL
, uschar
*, int, int *, int *,
417 extern int route_address(address_item
*, address_item
**, address_item
**,
418 address_item
**, address_item
**, int);
419 extern int route_check_prefix(const uschar
*, const uschar
*);
420 extern int route_check_suffix(const uschar
*, const uschar
*);
421 extern BOOL
route_findgroup(uschar
*, gid_t
*);
422 extern BOOL
route_finduser(const uschar
*, struct passwd
**, uid_t
*);
423 extern BOOL
route_find_expanded_group(uschar
*, uschar
*, uschar
*, gid_t
*,
425 extern BOOL
route_find_expanded_user(uschar
*, uschar
*, uschar
*,
426 struct passwd
**, uid_t
*, uschar
**);
427 extern void route_init(void);
428 extern void route_show_supported(FILE *);
429 extern void route_tidyup(void);
431 extern uschar
*search_find(void *, uschar
*, uschar
*, int, const uschar
*, int,
433 extern int search_findtype(const uschar
*, int);
434 extern int search_findtype_partial(const uschar
*, int *, const uschar
**, int *,
436 extern void *search_open(uschar
*, int, int, uid_t
*, gid_t
*);
437 extern void search_tidyup(void);
438 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
439 extern void sha1_end(hctx
*, const uschar
*, int, uschar
*);
440 extern void sha1_mid(hctx
*, const uschar
*);
441 extern void sha1_start(hctx
*);
442 extern int sieve_interpret(uschar
*, int, uschar
*, uschar
*, uschar
*,
443 uschar
*, address_item
**, uschar
**);
444 extern void sigalrm_handler(int);
445 extern BOOL
smtp_buffered(void);
446 extern void smtp_closedown(uschar
*);
447 extern void smtp_command_timeout_exit(void) NORETURN
;
448 extern void smtp_command_sigterm_exit(void) NORETURN
;
449 extern void smtp_data_timeout_exit(void) NORETURN
;
450 extern void smtp_data_sigint_exit(void) NORETURN
;
451 extern void smtp_deliver_init(void);
452 extern uschar
*smtp_cmd_hist(void);
453 extern int smtp_connect(smtp_connect_args
*, const blob
*);
454 extern int smtp_sock_connect(host_item
*, int, int, uschar
*,
455 transport_instance
* tb
, int, const blob
*);
456 extern int smtp_feof(void);
457 extern int smtp_ferror(void);
458 extern uschar
*smtp_get_connection_info(void);
459 extern BOOL
smtp_get_interface(uschar
*, int, address_item
*,
460 uschar
**, uschar
*);
461 extern BOOL
smtp_get_port(uschar
*, address_item
*, int *, uschar
*);
462 extern int smtp_getc(unsigned);
463 extern uschar
*smtp_getbuf(unsigned *);
464 extern void smtp_get_cache(void);
465 extern int smtp_handle_acl_fail(int, int, uschar
*, uschar
*);
466 extern void smtp_log_no_mail(void);
467 extern void smtp_message_code(uschar
**, int *, uschar
**, uschar
**, BOOL
);
468 extern void smtp_proxy_tls(void *, uschar
*, size_t, int *, int) NORETURN
;
469 extern BOOL
smtp_read_response(void *, uschar
*, int, int, int);
470 extern void *smtp_reset(void *);
471 extern void smtp_respond(uschar
*, int, BOOL
, uschar
*);
472 extern void smtp_notquit_exit(uschar
*, uschar
*, uschar
*, ...);
473 extern void smtp_port_for_connect(host_item
*, int);
474 extern void smtp_send_prohibition_message(int, uschar
*);
475 extern int smtp_setup_msg(void);
476 extern BOOL
smtp_start_session(void);
477 extern int smtp_ungetc(int);
478 extern BOOL
smtp_verify_helo(void);
479 extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
480 #ifdef WITH_CONTENT_SCAN
481 extern int spam(const uschar
**);
482 extern FILE *spool_mbox(unsigned long *, const uschar
*, uschar
**);
484 extern void spool_clear_header_globals(void);
485 extern BOOL
spool_move_message(uschar
*, uschar
*, uschar
*, uschar
*);
486 extern int spool_open_datafile(uschar
*);
487 extern int spool_open_temp(uschar
*);
488 extern int spool_read_header(uschar
*, BOOL
, BOOL
);
489 extern int spool_write_header(uschar
*, int, uschar
**);
490 extern int stdin_getc(unsigned);
491 extern int stdin_feof(void);
492 extern int stdin_ferror(void);
493 extern int stdin_ungetc(int);
495 extern void store_exit(void);
496 extern gstring
*string_append(gstring
*, int, ...) WARN_UNUSED_RESULT
;
497 extern gstring
*string_append_listele(gstring
*, uschar
, const uschar
*) WARN_UNUSED_RESULT
;
498 extern gstring
*string_append_listele_n(gstring
*, uschar
, const uschar
*, unsigned) WARN_UNUSED_RESULT
;
499 extern gstring
*string_append2_listele_n(gstring
*, const uschar
*, const uschar
*, unsigned) WARN_UNUSED_RESULT
;
500 extern uschar
*string_base62(unsigned long int);
501 extern gstring
*string_cat (gstring
*, const uschar
* ) WARN_UNUSED_RESULT
;
502 extern gstring
*string_catn(gstring
*, const uschar
*, int) WARN_UNUSED_RESULT
;
503 extern int string_compare_by_pointer(const void *, const void *);
504 extern uschar
*string_copy_dnsdomain(uschar
*);
505 extern uschar
*string_copy_malloc(const uschar
*);
506 extern uschar
*string_dequote(const uschar
**);
507 extern uschar
*string_format_size(int, uschar
*);
508 extern int string_interpret_escape(const uschar
**);
509 extern int string_is_ip_address(const uschar
*, int *);
511 extern BOOL
string_is_utf8(const uschar
*);
513 extern uschar
*string_nextinlist(const uschar
**, int *, uschar
*, int);
514 extern const uschar
*string_printing2(const uschar
*, BOOL
);
515 extern uschar
*string_split_message(uschar
*);
516 extern uschar
*string_unprinting(uschar
*);
518 extern uschar
*string_address_utf8_to_alabel(const uschar
*, uschar
**);
519 extern uschar
*string_domain_alabel_to_utf8(const uschar
*, uschar
**);
520 extern uschar
*string_domain_utf8_to_alabel(const uschar
*, uschar
**);
521 extern uschar
*string_localpart_alabel_to_utf8(const uschar
*, uschar
**);
522 extern uschar
*string_localpart_utf8_to_alabel(const uschar
*, uschar
**);
525 #define string_format(buf, siz, fmt, ...) \
526 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
527 extern BOOL
string_format_trc(uschar
*, int, const uschar
*, unsigned,
528 const char *, ...) ALMOST_PRINTF(5,6);
530 #define string_vformat(g, flgs, fmt, ap) \
531 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
532 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
533 extern gstring
*string_vformat_trc(gstring
*, const uschar
*, unsigned,
534 unsigned, unsigned, const char *, va_list);
536 #define string_open_failed(eno, fmt, ...) \
537 string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
538 extern uschar
*string_open_failed_trc(int, const uschar
*, unsigned,
539 const char *, ...) PRINTF_FUNCTION(4,5);
541 extern int strcmpic(const uschar
*, const uschar
*);
542 extern int strncmpic(const uschar
*, const uschar
*, int);
543 extern uschar
*strstric(uschar
*, uschar
*, BOOL
);
545 extern int test_harness_fudged_queue_time(int);
546 extern void tcp_init(void);
547 #ifdef EXIM_TFO_PROBE
548 extern void tfo_probe(void);
550 extern void tls_modify_variables(tls_support
*);
551 extern uschar
*tod_stamp(int);
553 extern BOOL
transport_check_waiting(const uschar
*, const uschar
*, int, uschar
*,
554 BOOL
*, oicf
, void*);
555 extern void transport_init(void);
556 extern void transport_do_pass_socket(const uschar
*, const uschar
*,
557 const uschar
*, uschar
*, int);
558 extern BOOL
transport_pass_socket(const uschar
*, const uschar
*, const uschar
*, uschar
*,
560 extern uschar
*transport_rcpt_address(address_item
*, BOOL
);
561 extern BOOL
transport_set_up_command(const uschar
***, uschar
*,
562 BOOL
, int, address_item
*, uschar
*, uschar
**);
563 extern void transport_update_waiting(host_item
*, uschar
*);
564 extern BOOL
transport_write_block(transport_ctx
*, uschar
*, int, BOOL
);
565 extern void transport_write_reset(int);
566 extern BOOL
transport_write_string(int, const char *, ...);
567 extern BOOL
transport_headers_send(transport_ctx
*,
568 BOOL (*)(transport_ctx
*, uschar
*, int));
569 extern void transport_show_supported(FILE *);
570 extern BOOL
transport_write_message(transport_ctx
*, int);
571 extern void tree_add_duplicate(uschar
*, address_item
*);
572 extern void tree_add_nonrecipient(uschar
*);
573 extern void tree_add_unusable(host_item
*);
574 extern void tree_dup(tree_node
**, tree_node
*);
575 extern int tree_insertnode(tree_node
**, tree_node
*);
576 extern tree_node
*tree_search(tree_node
*, const uschar
*);
577 extern void tree_write(tree_node
*, FILE *);
578 extern void tree_walk(tree_node
*, void (*)(uschar
*, uschar
*, void*), void *);
580 #ifdef WITH_CONTENT_SCAN
581 extern void unspool_mbox(void);
584 extern void utf8_version_report(FILE *);
587 extern int verify_address(address_item
*, FILE *, int, int, int, int,
588 uschar
*, uschar
*, BOOL
*);
589 extern int verify_check_dnsbl(int, const uschar
**, uschar
**);
590 extern int verify_check_header_address(uschar
**, uschar
**, int, int, int,
591 uschar
*, uschar
*, int, int *);
592 extern int verify_check_headers(uschar
**);
593 extern int verify_check_header_names_ascii(uschar
**);
594 extern int verify_check_host(uschar
**);
595 extern int verify_check_notblind(BOOL
);
596 extern int verify_check_given_host(const uschar
**, const host_item
*);
597 extern int verify_check_this_host(const uschar
**, unsigned int *,
598 const uschar
*, const uschar
*, const uschar
**);
599 extern address_item
*verify_checked_sender(uschar
*);
600 extern void verify_get_ident(int);
601 extern BOOL
verify_sender(int *, uschar
**);
602 extern BOOL
verify_sender_preliminary(int *, uschar
**);
603 extern void version_init(void);
605 extern BOOL
write_chunk(transport_ctx
*, uschar
*, int);
606 extern ssize_t
write_to_fd_buf(int, const uschar
*, size_t);
609 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
610 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
611 chown(<exim-uid>, <exim-gid>).
613 Probably because the idmapping is broken, misconfigured or set up in
614 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
615 case of misconfiguration, or if there are more such broken systems
616 out, I try to impose as least impact as possible and for now just write
617 a panic log entry pointing to the bug report. You're encouraged to
618 contact the developers, if you experience this issue.
620 fd the file descriptor (or -1 if not valid)
621 name the file name for error messages or for file operations,
626 returns 0 on success, -1 on failure */
629 exim_fchown(int fd
, uid_t owner
, gid_t group
, const uschar
*name
)
631 return fchown(fd
, owner
, group
)
632 ? exim_chown_failure(fd
, name
, owner
, group
) : 0;
636 exim_chown(const uschar
*name
, uid_t owner
, gid_t group
)
638 return chown(CCS name
, owner
, group
)
639 ? exim_chown_failure(-1, name
, owner
, group
) : 0;
642 #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
643 /******************************************************************************/
644 /* String functions */
646 #if !defined(MACRO_PREDEF)
647 /*************************************************
648 * Copy and save string *
649 *************************************************/
651 /* This function assumes that memcpy() is faster than strcpy().
654 static inline uschar
*
655 string_copy_taint_trc(const uschar
*s
, BOOL tainted
, const char * func
, int line
)
657 int len
= Ustrlen(s
) + 1;
658 uschar
*ss
= store_get_3(len
, tainted
, func
, line
);
663 #define string_copy_taint(s, tainted) \
664 string_copy_taint_trc((s), tainted, __FUNCTION__, __LINE__)
666 static inline uschar
*
667 string_copy(const uschar
* s
)
669 return string_copy_taint((s
), is_tainted(s
));
673 /*************************************************
674 * Copy, lowercase and save string *
675 *************************************************/
678 Argument: string to copy
679 Returns: copy of string in new store, with letters lowercased
682 static inline uschar
*
683 string_copylc(const uschar
*s
)
685 uschar
*ss
= store_get(Ustrlen(s
) + 1, is_tainted(s
));
687 while (*s
!= 0) *p
++ = tolower(*s
++);
694 /*************************************************
695 * Copy and save string, given length *
696 *************************************************/
698 /* It is assumed the data contains no zeros. A zero is added
703 n number of characters
705 Returns: copy of string in new store
707 This is an API for local_scan hence not static.
710 static inline uschar
*
711 string_copyn(const uschar
*s
, int n
)
713 uschar
*ss
= store_get(n
+ 1, is_tainted(s
));
719 /*************************************************
720 * Copy, lowercase, and save string, given length *
721 *************************************************/
723 /* It is assumed the data contains no zeros. A zero is added
728 n number of characters
730 Returns: copy of string in new store, with letters lowercased
733 static inline uschar
*
734 string_copynlc(uschar
*s
, int n
)
736 uschar
*ss
= store_get(n
+ 1, is_tainted(s
));
738 while (n
-- > 0) *p
++ = tolower(*s
++);
744 # ifndef COMPILE_UTILITY
745 /*************************************************
746 * Copy and save string in longterm store *
747 *************************************************/
749 /* This function assumes that memcpy() is faster than strcpy().
751 Argument: string to copy
752 Returns: copy of string in new store
755 static inline uschar
*
756 string_copy_perm(const uschar
*s
, BOOL force_taint
)
758 int old_pool
= store_pool
;
759 int len
= Ustrlen(s
) + 1;
762 store_pool
= POOL_PERM
;
763 ss
= store_get(len
, force_taint
|| is_tainted(s
));
765 store_pool
= old_pool
;
772 /* sprintf into a buffer, taint-unchecked */
775 string_format_nt(uschar
* buf
, int siz
, const char * fmt
, ...)
777 gstring gs
= { .size
= siz
, .ptr
= 0, .s
= buf
};
780 (void) string_vformat(&gs
, SVFMT_TAINT_NOCHK
, fmt
, ap
);
786 /******************************************************************************/
787 /* Growable-string functions */
789 /* Create a growable-string with some preassigned space */
791 #define string_get_tainted(size, tainted) \
792 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
794 static inline gstring
*
795 string_get_tainted_trc(unsigned size
, BOOL tainted
, const char * func
, unsigned line
)
797 gstring
* g
= store_get_3(sizeof(gstring
) + size
, tainted
, func
, line
);
804 #define string_get(size) \
805 string_get_trc((size), __FUNCTION__, __LINE__)
807 static inline gstring
*
808 string_get_trc(unsigned size
, const char * func
, unsigned line
)
810 return string_get_tainted_trc(size
, FALSE
, func
, line
);
813 /* NUL-terminate the C string in the growable-string, and return it. */
815 static inline uschar
*
816 string_from_gstring(gstring
* g
)
824 #define gstring_release_unused(g) \
825 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
828 gstring_release_unused_trc(gstring
* g
, const char * file
, unsigned line
)
830 if (g
) store_release_above_3(g
->s
+ (g
->size
= g
->ptr
+ 1), file
, line
);
834 /* sprintf-append to a growable-string */
836 #define string_fmt_append(g, fmt, ...) \
837 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
838 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
840 #define string_fmt_append_f(g, flgs, fmt, ...) \
841 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
842 flgs, fmt, __VA_ARGS__)
844 static inline gstring
*
845 string_fmt_append_f_trc(gstring
* g
, const uschar
* func
, unsigned line
,
846 unsigned flags
, const char *format
, ...)
849 va_start(ap
, format
);
850 g
= string_vformat_trc(g
, func
, line
, STRING_SPRINTF_BUFFER_SIZE
,
856 /******************************************************************************/
858 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
860 static inline dns_answer
*
861 store_get_dns_answer_trc(const uschar
* func
, unsigned line
)
863 return store_get_3(sizeof(dns_answer
), TRUE
, CCS func
, line
); /* use tainted mem */
866 /******************************************************************************/
867 /* Routines with knowledge of spool layout */
869 # ifndef COMPILE_UTILITY
871 spool_pname_buf(uschar
* buf
, int len
)
873 snprintf(CS buf
, len
, "%s/%s/input", spool_directory
, queue_name
);
876 static inline uschar
*
877 spool_dname(const uschar
* purpose
, uschar
* subdir
)
879 return string_sprintf("%s/%s/%s/%s",
880 spool_directory
, queue_name
, purpose
, subdir
);
884 static inline uschar
*
885 spool_q_sname(const uschar
* purpose
, const uschar
* q
, uschar
* subdir
)
887 return string_sprintf("%s%s%s%s%s",
890 *subdir
? "/" : "", subdir
);
893 static inline uschar
*
894 spool_sname(const uschar
* purpose
, uschar
* subdir
)
896 return spool_q_sname(purpose
, queue_name
, subdir
);
899 static inline uschar
*
900 spool_q_fname(const uschar
* purpose
, const uschar
* q
,
901 const uschar
* subdir
, const uschar
* fname
, const uschar
* suffix
)
903 return string_sprintf("%s/%s/%s/%s/%s%s",
904 spool_directory
, q
, purpose
, subdir
, fname
, suffix
);
907 static inline uschar
*
908 spool_fname(const uschar
* purpose
, const uschar
* subdir
, const uschar
* fname
,
909 const uschar
* suffix
)
911 #ifdef COMPILE_UTILITY /* version avoiding string-extension */
912 int len
= Ustrlen(spool_directory
) + 1 + Ustrlen(queue_name
) + 1 + Ustrlen(purpose
) + 1
913 + Ustrlen(subdir
) + 1 + Ustrlen(fname
) + Ustrlen(suffix
) + 1;
914 uschar
* buf
= store_get(len
, FALSE
);
915 string_format(buf
, len
, "%s/%s/%s/%s/%s%s",
916 spool_directory
, queue_name
, purpose
, subdir
, fname
, suffix
);
919 return spool_q_fname(purpose
, queue_name
, subdir
, fname
, suffix
);
924 set_subdir_str(uschar
* subdir_str
, const uschar
* name
,
927 subdir_str
[0] = split_spool_directory
== (search_sequence
== 0)
929 subdir_str
[1] = '\0';
932 /******************************************************************************/
934 timesince(struct timeval
* diff
, const struct timeval
* then
)
936 gettimeofday(diff
, NULL
);
937 diff
->tv_sec
-= then
->tv_sec
;
938 if ((diff
->tv_usec
-= then
->tv_usec
) < 0)
941 diff
->tv_usec
+= 1000*1000;
945 static inline uschar
*
946 string_timediff(const struct timeval
* diff
)
948 static uschar buf
[sizeof("0.000s")];
950 if (diff
->tv_sec
>= 5 || !LOGGING(millisec
))
951 return readconf_printtime((int)diff
->tv_sec
);
953 snprintf(CS buf
, sizeof(buf
), "%u.%03us", (uint
)diff
->tv_sec
, (uint
)diff
->tv_usec
/1000);
958 static inline uschar
*
959 string_timesince(const struct timeval
* then
)
962 timesince(&diff
, then
);
963 return string_timediff(&diff
);
967 report_time_since(const struct timeval
* t0
, const uschar
* where
)
969 # ifdef MEASURE_TIMING
971 timesince(&diff
, t0
);
972 fprintf(stderr
, "%d %s:\t%ld.%06ld\n",
973 (uint
)getpid(), where
, (long)diff
.tv_sec
, (long)diff
.tv_usec
);
979 testharness_pause_ms(int millisec
)
981 #ifndef MEASURE_TIMING
982 if (f
.running_in_test_harness
) millisleep(millisec
);
986 #endif /* !MACRO_PREDEF */
988 #endif /* _FUNCTIONS_H_ */
992 /* End of functions.h */