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