src/src/functions.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
   6 /* Copyright (c) University of Cambridge 1995 - 2018 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8 /* SPDX-License-Identifier: GPL-2.0-only */
   9
  10
  11 /* Prototypes for functions that appear in various modules. Gathered together
  12 to avoid having a lot of tiddly little headers with only a couple of lines in
  13 them. However, some functions that are used (or not used) by utility programs
  14 are in in fact in separate headers. */
  15 #ifndef _FUNCTIONS_H_
  16 #define _FUNCTIONS_H_
  17
  18 #include <ctype.h>
  19 #include <sys/time.h>
  20
  21
  22 #ifdef EXIM_PERL
  23 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
  24                  uschar **) WARN_UNUSED_RESULT;
  25 extern void    cleanup_perl(void);
  26 extern uschar *init_perl(uschar *);
  27 #endif
  28
  29
  30 #ifndef DISABLE_TLS
  31 extern const char *
  32                std_dh_prime_default(void);
  33 extern const char *
  34                std_dh_prime_named(const uschar *);
  35
  36 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
  37 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
  38 extern uschar * tls_cert_issuer(void *, uschar * mod);
  39 extern uschar * tls_cert_not_before(void *, uschar * mod);
  40 extern uschar * tls_cert_not_after(void *, uschar * mod);
  41 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
  42 extern uschar * tls_cert_serial_number(void *, uschar * mod);
  43 extern uschar * tls_cert_signature(void *, uschar * mod);
  44 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
  45 extern uschar * tls_cert_subject(void *, uschar * mod);
  46 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
  47 extern uschar * tls_cert_version(void *, uschar * mod);
  48
  49 extern uschar * tls_cert_der_b64(void * cert);
  50 extern uschar * tls_cert_fprt_md5(void *);
  51 extern uschar * tls_cert_fprt_sha1(void *);
  52 extern uschar * tls_cert_fprt_sha256(void *);
  53
  54 extern void    tls_clean_env(void);
  55 extern BOOL    tls_client_start(client_conn_ctx *, smtp_connect_args *,
  56                   void *, tls_support *, uschar **);
  57 extern void    tls_client_creds_reload(BOOL);
  58
  59 extern void    tls_close(void *, int);
  60 extern BOOL    tls_could_getc(void);
  61 extern void    tls_daemon_init(void);
  62 extern int     tls_daemon_tick(void);
  63 extern BOOL    tls_dropprivs_validate_require_cipher(BOOL);
  64 extern BOOL    tls_export_cert(uschar *, size_t, void *);
  65 extern int     tls_feof(void);
  66 extern int     tls_ferror(void);
  67 extern uschar *tls_field_from_dn(uschar *, const uschar *);
  68 extern void    tls_free_cert(void **);
  69 extern int     tls_getc(unsigned);
  70 extern uschar *tls_getbuf(unsigned *);
  71 extern void    tls_get_cache(unsigned);
  72 extern BOOL    tls_hasc(void);
  73 extern BOOL    tls_import_cert(const uschar *, void **);
  74 extern BOOL    tls_is_name_for_cert(const uschar *, void *);
  75 # ifdef USE_OPENSSL
  76 extern BOOL    tls_openssl_options_parse(uschar *, long *);
  77 # endif
  78 extern int     tls_read(void *, uschar *, size_t);
  79 extern int     tls_server_start(uschar **);
  80 extern void    tls_shutdown_wr(void *);
  81 extern BOOL    tls_smtp_buffered(void);
  82 extern int     tls_ungetc(int);
  83 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
  84 extern void    tls_watch_discard_event(int);
  85 extern void    tls_watch_invalidate(void);
  86 #endif
  87 extern int     tls_write(void *, const uschar *, size_t, BOOL);
  88 extern uschar *tls_validate_require_cipher(void);
  89 extern gstring *tls_version_report(gstring *);
  90
  91 # ifdef SUPPORT_DANE
  92 extern int     tlsa_lookup(const host_item *, dns_answer *, BOOL);
  93 # endif
  94
  95 #endif  /*DISABLE_TLS*/
  96
  97
  98 /* Everything else... */
  99
 100 extern acl_block *acl_read(uschar *(*)(void), uschar **);
 101 extern int     acl_check(int, uschar *, uschar *, uschar **, uschar **);
 102 extern uschar *acl_current_verb(void);
 103 extern int     acl_eval(int, uschar *, uschar **, uschar **);
 104 extern uschar *acl_standalone_setvar(const uschar *);
 105
 106 extern tree_node *acl_var_create(uschar *);
 107 extern void    acl_var_write(uschar *, uschar *, void *);
 108
 109 #ifdef EXPERIMENTAL_ARC
 110 extern void   *arc_ams_setup_sign_bodyhash(void);
 111 extern const uschar *arc_header_feed(gstring *, BOOL);
 112 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
 113 extern void     arc_sign_init(void);
 114 extern const uschar *acl_verify_arc(void);
 115 extern uschar * fn_arc_domains(void);
 116 #endif
 117
 118 extern void    assert_no_variables(void *, int, const char *, int);
 119 extern int     auth_call_pam(const uschar *, uschar **);
 120 extern int     auth_call_pwcheck(uschar *, uschar **);
 121 extern int     auth_call_radius(const uschar *, uschar **);
 122 extern int     auth_call_saslauthd(const uschar *, const uschar *,
 123                  const uschar *, const uschar *, uschar **);
 124 extern int     auth_check_serv_cond(auth_instance *);
 125 extern int     auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
 126 extern int     auth_client_item(void *, auth_instance *, const uschar **,
 127                  unsigned, int, uschar *, int);
 128
 129
 130 extern int     auth_get_data(uschar **, const uschar *, int);
 131 extern int     auth_get_no64_data(uschar **, uschar *);
 132 extern int     auth_prompt(const uschar *);
 133 extern int     auth_read_input(const uschar *);
 134 extern gstring * auth_show_supported(gstring *);
 135 extern uschar *auth_xtextencode(uschar *, int);
 136 extern int     auth_xtextdecode(uschar *, uschar **);
 137 extern uschar *authenticator_current_name(void);
 138
 139 #ifdef EXPERIMENTAL_ARC
 140 extern gstring *authres_arc(gstring *);
 141 #endif
 142 #ifndef DISABLE_DKIM
 143 extern gstring *authres_dkim(gstring *);
 144 #endif
 145 #ifdef SUPPORT_DMARC
 146 extern gstring *authres_dmarc(gstring *);
 147 #endif
 148 extern gstring *authres_smtpauth(gstring *);
 149 #ifdef SUPPORT_SPF
 150 extern gstring *authres_spf(gstring *);
 151 #endif
 152
 153 extern uschar *b64encode(const uschar *, int);
 154 extern uschar *b64encode_taint(const uschar *, int, const void *);
 155 extern int     b64decode(const uschar *, uschar **);
 156 extern int     bdat_getc(unsigned);
 157 extern uschar *bdat_getbuf(unsigned *);
 158 extern BOOL    bdat_hasc(void);
 159 extern int     bdat_ungetc(int);
 160 extern void    bdat_flush_data(void);
 161
 162 extern void    bits_clear(unsigned int *, size_t, int *);
 163 extern void    bits_set(unsigned int *, size_t, int *);
 164
 165 extern void    cancel_cutthrough_connection(BOOL, const uschar *);
 166 extern gstring *cat_file(FILE *, gstring *, uschar *);
 167 extern gstring *cat_file_tls(void *, gstring *, uschar *);
 168 extern int     check_host(void *, const uschar *, const uschar **, uschar **);
 169 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
 170 extern pid_t   child_open_exim_function(int *, const uschar *);
 171 extern pid_t   child_open_exim2_function(int *, uschar *, uschar *,
 172                  const uschar *);
 173 extern pid_t   child_open_function(uschar **, uschar **, int,
 174                  int *, int *, BOOL, const uschar *);
 175 extern pid_t   child_open_uid(const uschar **, const uschar **, int,
 176                  uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *);
 177 extern BOOL    cleanup_environment(void);
 178 extern void    cutthrough_data_puts(uschar *, int);
 179 extern void    cutthrough_data_put_nl(void);
 180 extern uschar *cutthrough_finaldot(void);
 181 extern BOOL    cutthrough_flush_send(void);
 182 extern BOOL    cutthrough_headers_send(void);
 183 extern BOOL    cutthrough_predata(void);
 184 extern void    release_cutthrough_connection(const uschar *);
 185
 186 extern void    daemon_go(void);
 187 #ifndef COMPILE_UTILITY
 188 extern ssize_t daemon_client_sockname(struct sockaddr_un *, uschar **);
 189 extern ssize_t daemon_notifier_sockname(struct sockaddr_un *);
 190 #endif
 191
 192 #ifdef EXPERIMENTAL_DCC
 193 extern int     dcc_process(uschar **);
 194 #endif
 195
 196 extern void    debug_logging_activate(const uschar *, const uschar *);
 197 extern void    debug_logging_from_spool(const uschar *);
 198 extern void    debug_logging_stop(BOOL);
 199 extern void    debug_print_argv(const uschar **);
 200 extern void    debug_print_ids(uschar *);
 201 extern void    debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
 202 extern void    debug_print_string(uschar *);
 203 extern void    debug_print_tree(const char *, tree_node *);
 204 extern void    debug_vprintf(int, const char *, va_list);
 205 extern void    debug_pretrigger_setup(const uschar *);
 206 extern void    debug_pretrigger_discard(void);
 207 extern void    debug_print_socket(int);
 208 extern void    debug_trigger_fire(void);
 209
 210 extern void    decode_bits(unsigned int *, size_t, int *,
 211                    const uschar *, bit_table *, int, uschar *, int);
 212 extern void    delete_pid_file(void);
 213 extern void    deliver_local(address_item *, BOOL);
 214 extern address_item *deliver_make_addr(uschar *, BOOL);
 215 extern void    delivery_log(int, address_item *, int, uschar *);
 216 extern int     deliver_message(uschar *, BOOL, BOOL);
 217 extern void    deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
 218 extern void    deliver_set_expansions(address_item *);
 219 extern int     deliver_split_address(address_item *);
 220 extern void    deliver_succeeded(address_item *);
 221
 222 extern void    delivery_re_exec(int);
 223
 224 extern void    die_tainted(const uschar *, const uschar *, int);
 225 extern BOOL    directory_make(const uschar *, const uschar *, int, BOOL);
 226 #ifndef DISABLE_DKIM
 227 extern uschar *dkim_exim_query_dns_txt(const uschar *);
 228 extern void    dkim_exim_sign_init(void);
 229
 230 extern BOOL    dkim_transport_write_message(transport_ctx *,
 231                   struct ob_dkim *, const uschar ** errstr);
 232 #endif
 233 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
 234 extern int     dns_basic_lookup(dns_answer *, const uschar *, int);
 235 extern uschar *dns_build_reverse(const uschar *);
 236 extern time_t  dns_expire_from_soa(dns_answer *, int);
 237 extern void    dns_init(BOOL, BOOL, BOOL);
 238 extern BOOL    dns_is_aa(const dns_answer *);
 239 extern BOOL    dns_is_secure(const dns_answer *);
 240 extern int     dns_lookup(dns_answer *, const uschar *, int, const uschar **);
 241 extern void    dns_pattern_init(void);
 242 extern int     dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
 243 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
 244 extern uschar *dns_text_type(int);
 245 extern void    dscp_list_to_stream(FILE *);
 246 extern BOOL    dscp_lookup(const uschar *, int, int *, int *, int *);
 247
 248 extern void    enq_end(uschar *);
 249 extern BOOL    enq_start(uschar *, unsigned);
 250 #ifndef DISABLE_EVENT
 251 extern uschar *event_raise(uschar *, const uschar *, uschar *, int *);
 252 extern void    msg_event_raise(const uschar *, const address_item *);
 253 #endif
 254
 255 extern int     exim_chown_failure(int, const uschar*, uid_t, gid_t);
 256 extern const uschar * exim_errstr(int);
 257 extern void    exim_exit(int) NORETURN;
 258 extern void    exim_gettime(struct timeval *);
 259 extern void    exim_nullstd(void);
 260 extern void    exim_setugid(uid_t, gid_t, BOOL, const uschar *);
 261 extern void    exim_underbar_exit(int) NORETURN;
 262 extern void    exim_wait_tick(struct timeval *, int);
 263 extern int     exp_bool(address_item *addr,
 264   uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
 265   uschar *svalue, BOOL *rvalue);
 266 extern BOOL    expand_check_condition(uschar *, uschar *, uschar *);
 267 extern uschar *expand_file_big_buffer(const uschar *);
 268 extern uschar *expand_string(uschar *); /* public, cannot make const */
 269 extern const uschar *expand_string_2(const uschar *, BOOL *);
 270 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
 271 extern uschar *expand_getkeyed(const uschar *, const uschar *);
 272
 273 extern uschar *expand_hide_passwords(uschar * );
 274 extern uschar *expand_string_copy(const uschar *);
 275 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
 276 extern void    modify_variable(uschar *, void *);
 277
 278 extern BOOL    fd_ready(int, time_t);
 279
 280 extern int     filter_interpret(const uschar *, int, address_item **, uschar **);
 281 extern BOOL    filter_personal(string_item *, BOOL);
 282 extern BOOL    filter_runtest(int, uschar *, BOOL, BOOL);
 283 extern BOOL    filter_system_interpret(address_item **, uschar **);
 284
 285 extern uschar * fn_hdrs_added(void);
 286 extern void    force_fd(int, int);
 287
 288 extern void    header_add(int, const char *, ...);
 289 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
 290 extern int     header_checkname(header_line *, BOOL);
 291 extern BOOL    header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
 292 extern int     host_address_extract_port(uschar *);
 293 extern uschar *host_and_ident(BOOL);
 294 extern int     host_aton(const uschar *, int *);
 295 extern void    host_build_hostlist(host_item **, const uschar *, BOOL);
 296 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
 297 extern void    host_build_log_info(void);
 298 extern void    host_build_sender_fullhost(void);
 299 extern int     host_find_byname(host_item *, const uschar *, int,
 300                                 const uschar **, BOOL);
 301 extern int     host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
 302                  uschar *, const dnssec_domains *, const uschar **, BOOL *);
 303 extern ip_address_item *host_find_interfaces(void);
 304 extern BOOL    host_is_in_net(const uschar *, const uschar *, int);
 305 extern BOOL    host_is_tls_on_connect_port(int);
 306 extern int     host_item_get_port(host_item *);
 307 extern void    host_mask(int, int *, int);
 308 extern int     host_name_lookup(void);
 309 extern int     host_nmtoa(int, int *, int, uschar *, int);
 310 extern uschar *host_ntoa(int, const void *, uschar *, int *);
 311 extern int     host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
 312
 313 extern uschar *imap_utf7_encode(uschar *, const uschar *,
 314                                  uschar, uschar *, uschar **);
 315
 316 extern void    invert_address(uschar *, uschar *);
 317 extern int     ip_addr(void *, int, const uschar *, int);
 318 extern int     ip_bind(int, int, uschar *, int);
 319 extern int     ip_connect(int, int, const uschar *, int, int, const blob *);
 320 extern int     ip_connectedsocket(int, const uschar *, int, int,
 321                  int, host_item *, uschar **, const blob *);
 322 extern int     ip_get_address_family(int);
 323 extern void    ip_keepalive(int, const uschar *, BOOL);
 324 extern int     ip_recv(client_conn_ctx *, uschar *, int, time_t);
 325 extern int     ip_socket(int, int);
 326
 327 extern int     ip_tcpsocket(const uschar *, uschar **, int, host_item *);
 328 extern int     ip_unixsocket(const uschar *, uschar **);
 329 extern int     ip_streamsocket(const uschar *, uschar **, int, host_item *);
 330
 331 extern int     ipv6_nmtoa(int *, uschar *);
 332
 333 extern uschar *local_part_quote(uschar *);
 334 extern int     log_open_as_exim(const uschar * const);
 335 extern void    log_close_all(void);
 336
 337 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
 338 extern BOOL    macro_read_assignment(uschar *);
 339 extern uschar *macros_expand(int, int *, BOOL *);
 340 extern void    mainlog_close(void);
 341 #ifdef WITH_CONTENT_SCAN
 342 extern int     malware(const uschar *, BOOL, int);
 343 extern int     malware_in_file(uschar *);
 344 extern void    malware_init(void);
 345 extern gstring * malware_show_supported(gstring *);
 346 #endif
 347 extern int     match_address_list(const uschar *, BOOL, BOOL, const uschar **,
 348                  unsigned int *, int, int, const uschar **);
 349 extern int     match_address_list_basic(const uschar *, const uschar **, int);
 350 extern int     match_check_list(const uschar **, int, tree_node **, unsigned int **,
 351                  int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
 352                  const uschar *, const uschar **);
 353 extern int     match_isinlist(const uschar *, const uschar **, int, tree_node **,
 354                  unsigned int *, int, BOOL, const uschar **);
 355 extern int     match_check_string(const uschar *, const uschar *, int, mcs_flags,
 356                  const uschar **);
 357
 358 extern void    message_start(void);
 359 extern void    message_tidyup(void);
 360 extern void    md5_end(md5 *, const uschar *, int, uschar *);
 361 extern void    md5_mid(md5 *, const uschar *);
 362 extern void    md5_start(md5 *);
 363 extern void    millisleep(int);
 364 #ifdef WITH_CONTENT_SCAN
 365 struct mime_boundary_context;
 366 extern int     mime_acl_check(uschar *acl, FILE *f,
 367                  struct mime_boundary_context *, uschar **, uschar **);
 368 extern int     mime_decode(const uschar **);
 369 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
 370 extern int     mime_regex(const uschar **, BOOL);
 371 extern void    mime_set_anomaly(int);
 372 #endif
 373 extern uschar *moan_check_errorcopy(uschar *);
 374 extern BOOL    moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
 375                  BOOL, uschar *);
 376 extern void    moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
 377 extern BOOL    moan_send_message(uschar *, int, error_block *eblock,
 378                  header_line *, FILE *, uschar *);
 379 extern void    moan_tell_someone(uschar *, address_item *,
 380                  const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
 381 extern BOOL    moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
 382 extern void    moan_write_from(FILE *);
 383 extern void    moan_write_references(FILE *, uschar *);
 384 extern FILE   *modefopen(const uschar *, const char *, mode_t);
 385
 386 extern int     open_cutthrough_connection( address_item * addr );
 387
 388 extern uschar *parse_extract_address(const uschar *, uschar **, int *, int *, int *,
 389                  BOOL);
 390 extern int     parse_forward_list(const uschar *, int, address_item **, uschar **,
 391                  const uschar *, const uschar *, error_block **);
 392 extern uschar *parse_find_address_end(const uschar *, BOOL);
 393 extern const uschar *parse_find_at(const uschar *);
 394 extern const uschar *parse_fix_phrase(const uschar *, int);
 395 extern const uschar *parse_message_id(const uschar *, uschar **, uschar **);
 396 extern const uschar *parse_quote_2047(const uschar *, int, const uschar *,
 397                                       BOOL);
 398 extern const uschar *parse_date_time(const uschar *str, time_t *t);
 399 extern void priv_drop_temp(const uid_t, const gid_t);
 400 extern void priv_restore(void);
 401 extern int     vaguely_random_number(int);
 402 #ifndef DISABLE_TLS
 403 extern int     vaguely_random_number_fallback(int);
 404 #endif
 405
 406 extern BOOL    queue_action(uschar *, int, uschar **, int, int);
 407 extern void    queue_check_only(void);
 408 extern unsigned queue_count(void);
 409 extern unsigned queue_count_cached(void);
 410 extern void    queue_list(int, uschar **, int);
 411 #ifndef DISABLE_QUEUE_RAMP
 412 extern void    queue_notify_daemon(const uschar * hostname);
 413 #endif
 414 extern void    queue_run(uschar *, uschar *, BOOL);
 415
 416 extern int     random_number(int);
 417 extern const uschar *rc_to_string(int);
 418 extern int     rda_interpret(redirect_block *, int, const uschar *, const uschar *,
 419                  const uschar *, const uschar *, const uschar *, const ugid_block *, address_item **,
 420                  uschar **, error_block **, int *, const uschar *);
 421 extern int     rda_is_filter(const uschar *);
 422 extern BOOL    readconf_depends(driver_instance *, uschar *);
 423 extern void    readconf_driver_init(uschar *, driver_instance **,
 424                  driver_info *, int, void *, int, optionlist *, int);
 425 extern uschar *readconf_find_option(void *);
 426 extern void    readconf_main(BOOL);
 427 extern void    readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
 428 extern BOOL    readconf_print(const uschar *, uschar *, BOOL);
 429 extern uschar *readconf_printtime(int);
 430 extern const uschar *readconf_readname(uschar *, int, const uschar *);
 431 extern int     readconf_readtime(const uschar *, int, BOOL);
 432 extern void    readconf_rest(void);
 433 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
 434 extern void    readconf_save_config(const uschar *);
 435 extern void    read_message_body(BOOL);
 436 extern void    receive_bomb_out(uschar *, uschar *) NORETURN;
 437 extern BOOL    receive_check_fs(int);
 438 extern BOOL    receive_check_set_sender(uschar *);
 439 extern BOOL    receive_msg(BOOL);
 440 extern int_eximarith_t receive_statvfs(BOOL, int *);
 441 extern void    receive_swallow_smtp(void);
 442 #ifdef WITH_CONTENT_SCAN
 443 extern int     regex(const uschar **, BOOL);
 444 extern void    regex_vars_clear(void);
 445 #endif
 446 extern void    regex_at_daemon(const uschar *);
 447 extern BOOL    regex_match(const pcre2_code *, const uschar *, int, uschar **);
 448 extern BOOL    regex_match_and_setup(const pcre2_code *, const uschar *, int, int);
 449 extern const pcre2_code *regex_compile(const uschar *, mcs_flags, uschar **,
 450                 pcre2_compile_context *);
 451 extern const pcre2_code *regex_must_compile(const uschar *, mcs_flags, BOOL);
 452 extern void    retry_add_item(address_item *, uschar *, int);
 453 extern BOOL    retry_check_address(const uschar *, host_item *, uschar *, BOOL,
 454                  uschar **, uschar **);
 455 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
 456 extern BOOL    retry_ultimate_address_timeout(uschar *, const uschar *,
 457                  dbdata_retry *, time_t);
 458 extern void    retry_update(address_item **, address_item **, address_item **);
 459 extern const uschar *rewrite_address(const uschar *, BOOL, BOOL, rewrite_rule *, int);
 460 extern const uschar *rewrite_address_qualify(const uschar *, BOOL);
 461 extern header_line *rewrite_header(header_line *,
 462                const uschar *, const uschar *,
 463                rewrite_rule *, int, BOOL);
 464 extern const uschar *rewrite_one(const uschar *, int, BOOL *, BOOL, uschar *,
 465                  rewrite_rule *);
 466 extern void    rewrite_test(const uschar *);
 467 extern uschar *rfc2047_decode2(uschar *, BOOL, const uschar *, int, int *,
 468                                      int *, uschar **);
 469 extern int     route_address(address_item *, address_item **, address_item **,
 470                  address_item **, address_item **, int);
 471 extern int     route_check_prefix(const uschar *, const uschar *, unsigned *);
 472 extern int     route_check_suffix(const uschar *, const uschar *, unsigned *);
 473 extern BOOL    route_findgroup(uschar *, gid_t *);
 474 extern BOOL    route_finduser(const uschar *, struct passwd **, uid_t *);
 475 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 476                  uschar **);
 477 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 478                  struct passwd **, uid_t *, uschar **);
 479 extern void    route_init(void);
 480 extern gstring * route_show_supported(gstring *);
 481 extern void    route_tidyup(void);
 482 extern uschar *router_current_name(void);
 483
 484 extern uschar *search_args(int, uschar *, uschar *, uschar **, const uschar *);
 485 extern uschar *search_find(void *, const uschar *, uschar *, int,
 486                  const uschar *, int, int, int *, const uschar *);
 487 extern int     search_findtype(const uschar *, int);
 488 extern int     search_findtype_partial(const uschar *, int *, const uschar **, int *,
 489                  int *, const uschar **);
 490 extern void   *search_open(const uschar *, int, int, uid_t *, gid_t *);
 491 extern void    search_tidyup(void);
 492 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
 493 extern void    sha1_end(hctx *, const uschar *, int, uschar *);
 494 extern void    sha1_mid(hctx *, const uschar *);
 495 extern void    sha1_start(hctx *);
 496 extern int     sieve_interpret(const uschar *, int, const uschar *,
 497                  const uschar *, const uschar *, const uschar *,
 498                  address_item **, uschar **);
 499 extern void    sigalrm_handler(int);
 500 extern int     smtp_boundsock(smtp_connect_args *);
 501 extern void    smtp_closedown(uschar *);
 502 extern void    smtp_command_timeout_exit(void) NORETURN;
 503 extern void    smtp_command_sigterm_exit(void) NORETURN;
 504 extern void    smtp_data_timeout_exit(void) NORETURN;
 505 extern void    smtp_data_sigint_exit(void) NORETURN;
 506 extern void    smtp_deliver_init(void);
 507 extern uschar *smtp_cmd_hist(void);
 508 extern int     smtp_connect(smtp_connect_args *, const blob *);
 509 extern int     smtp_feof(void);
 510 extern int     smtp_ferror(void);
 511 extern uschar *smtp_get_connection_info(void);
 512 extern BOOL    smtp_get_interface(uschar *, int, address_item *,
 513                  uschar **, uschar *);
 514 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 515 extern int     smtp_getc(unsigned);
 516 extern uschar *smtp_getbuf(unsigned *);
 517 extern void    smtp_get_cache(unsigned);
 518 extern BOOL    smtp_hasc(void);
 519 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 520 extern void    smtp_log_no_mail(void);
 521 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
 522 extern void    smtp_proxy_tls(void *, uschar *, size_t, int *, int, const uschar *) NORETURN;
 523 extern BOOL    smtp_read_response(void *, uschar *, int, int, int);
 524 extern void   *smtp_reset(void *);
 525 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 526 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
 527 extern void    smtp_port_for_connect(host_item *, int);
 528 extern void    smtp_send_prohibition_message(int, uschar *);
 529 extern int     smtp_setup_msg(void);
 530 extern int     smtp_sock_connect(smtp_connect_args *, int, const blob *);
 531 extern BOOL    smtp_start_session(void);
 532 extern int     smtp_ungetc(int);
 533 extern BOOL    smtp_verify_helo(void);
 534 extern int     smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
 535 #ifdef WITH_CONTENT_SCAN
 536 extern int     spam(const uschar **);
 537 extern FILE   *spool_mbox(unsigned long *, const uschar *, uschar **);
 538 #endif
 539 extern void    spool_clear_header_globals(void);
 540 extern BOOL    spool_move_message(uschar *, uschar *, uschar *, uschar *);
 541 extern int     spool_open_datafile(uschar *);
 542 extern int     spool_open_temp(uschar *);
 543 extern int     spool_read_header(uschar *, BOOL, BOOL);
 544 extern uschar *spool_sender_from_msgid(const uschar *);
 545 extern int     spool_write_header(uschar *, int, uschar **);
 546 extern int     stdin_getc(unsigned);
 547 extern int     stdin_feof(void);
 548 extern int     stdin_ferror(void);
 549 extern BOOL    stdin_hasc(void);
 550 extern int     stdin_ungetc(int);
 551
 552 extern void    stackdump(void);
 553 extern void    store_exit(void);
 554 extern void    store_init(void);
 555 extern void    store_writeprotect(int);
 556
 557 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
 558 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
 559 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
 560 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
 561 extern uschar *string_base62(unsigned long int);
 562 extern gstring *string_cat (gstring *, const uschar *     ) WARN_UNUSED_RESULT;
 563 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
 564 extern int     string_compare_by_pointer(const void *, const void *);
 565 extern uschar *string_copy_dnsdomain(uschar *);
 566 extern uschar *string_copy_malloc(const uschar *);
 567 extern uschar *string_dequote(const uschar **);
 568 extern uschar *string_format_size(int, uschar *);
 569 extern int     string_interpret_escape(const uschar **);
 570 extern int     string_is_ip_address(const uschar *, int *);
 571 #ifdef SUPPORT_I18N
 572 extern BOOL    string_is_utf8(const uschar *);
 573 #endif
 574 extern const uschar *string_printing2(const uschar *, int);
 575 extern uschar *string_split_message(uschar *);
 576 extern uschar *string_unprinting(uschar *);
 577 #ifdef SUPPORT_I18N
 578 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
 579 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
 580 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
 581 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
 582 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
 583 #endif
 584
 585 #define string_format(buf, siz, fmt, ...) \
 586         string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 587 extern BOOL    string_format_trc(uschar *, int, const uschar *, unsigned,
 588                         const char *, ...) ALMOST_PRINTF(5,6);
 589
 590 #define string_vformat(g, flgs, fmt, ap) \
 591         string_vformat_trc(g, US __FUNCTION__, __LINE__, \
 592                          STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
 593 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
 594                         unsigned, unsigned, const char *, va_list);
 595
 596 #define string_open_failed(fmt, ...) \
 597         string_open_failed_trc(US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 598 extern uschar *string_open_failed_trc(const uschar *, unsigned,
 599                         const char *, ...) PRINTF_FUNCTION(3,4);
 600
 601 #define string_nextinlist(lp, sp, b, l) \
 602         string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
 603 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
 604                         const uschar * func, int line);
 605
 606 extern int     strcmpic(const uschar *, const uschar *);
 607 extern int     strncmpic(const uschar *, const uschar *, int);
 608 extern uschar *strstric(uschar *, uschar *, BOOL);
 609 extern const uschar *strstric_c(const uschar *, const uschar *, BOOL);
 610
 611 extern int     test_harness_fudged_queue_time(int);
 612 extern void    tcp_init(void);
 613 #ifdef EXIM_TFO_PROBE
 614 extern void    tfo_probe(void);
 615 #endif
 616 extern void    tls_modify_variables(tls_support *);
 617 extern uschar *tod_stamp(int);
 618
 619 extern BOOL    transport_check_waiting(const uschar *, const uschar *, int, uschar *,
 620                  oicf, void*);
 621 extern uschar *transport_current_name(void);
 622 extern void    transport_do_pass_socket(const uschar *, const uschar *,
 623                  const uschar *, uschar *, int);
 624 extern void    transport_init(void);
 625 extern BOOL    transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *, int
 626 #ifdef EXPERIMENTAL_ESMTP_LIMITS
 627                         , unsigned, unsigned, unsigned
 628 #endif
 629                         );
 630 extern uschar *transport_rcpt_address(address_item *, BOOL);
 631 extern BOOL    transport_set_up_command(const uschar ***, const uschar *,
 632                  BOOL, int, address_item *, BOOL, const uschar *, uschar **);
 633 extern void    transport_update_waiting(host_item *, uschar *);
 634 extern BOOL    transport_write_block(transport_ctx *, uschar *, int, BOOL);
 635 extern void    transport_write_reset(int);
 636 extern BOOL    transport_write_string(int, const char *, ...);
 637 extern BOOL    transport_headers_send(transport_ctx *,
 638                  BOOL (*)(transport_ctx *, uschar *, int));
 639 extern gstring * transport_show_supported(gstring *);
 640 extern BOOL    transport_write_message(transport_ctx *, int);
 641 extern void    tree_add_duplicate(const uschar *, address_item *);
 642 extern void    tree_add_nonrecipient(const uschar *);
 643 extern void    tree_add_unusable(const host_item *);
 644 extern void    tree_dup(tree_node **, tree_node *);
 645 extern int     tree_insertnode(tree_node **, tree_node *);
 646 extern tree_node *tree_search(tree_node *, const uschar *);
 647 extern void    tree_write(tree_node *, FILE *);
 648 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 649
 650 #ifdef WITH_CONTENT_SCAN
 651 extern void    unspool_mbox(void);
 652 #endif
 653 #ifdef SUPPORT_I18N
 654 extern gstring *utf8_version_report(gstring *);
 655 #endif
 656
 657 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 658                  uschar *, uschar *, BOOL *);
 659 extern int     verify_check_dnsbl(int, const uschar **, uschar **);
 660 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 661                  uschar *, uschar *, int, int *);
 662 extern int     verify_check_headers(uschar **);
 663 extern int     verify_check_header_names_ascii(uschar **);
 664 extern int     verify_check_host(uschar **);
 665 extern int     verify_check_notblind(BOOL);
 666 extern int     verify_check_given_host(const uschar **, const host_item *);
 667 extern int     verify_check_this_host(const uschar **, unsigned int *,
 668                  const uschar*, const uschar *, const uschar **);
 669 extern address_item *verify_checked_sender(uschar *);
 670 extern void    verify_get_ident(int);
 671 extern void    verify_quota(uschar *);
 672 extern int     verify_quota_call(const uschar *, int, int, uschar **);
 673 extern BOOL    verify_sender(int *, uschar **);
 674 extern BOOL    verify_sender_preliminary(int *, uschar **);
 675 extern void    version_init(void);
 676
 677 extern BOOL    write_chunk(transport_ctx *, uschar *, int);
 678 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
 679
 680
 681 /******************************************************************************/
 682 /* Predicate: if an address is in a tainted pool.
 683 By extension, a variable pointing to this address is tainted.
 684 */
 685
 686 static inline BOOL
 687 is_tainted(const void * p)
 688 {
 689 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
 690 return FALSE;
 691
 692 #else
 693 extern BOOL is_tainted_fn(const void *);
 694 return is_tainted_fn(p);
 695 #endif
 696 }
 697
 698 static inline BOOL
 699 is_incompatible(const void * old, const void * new)
 700 {
 701 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
 702 return FALSE;
 703
 704 #else
 705 extern BOOL is_incompatible_fn(const void *, const void *);
 706 return is_incompatible_fn(old, new);
 707 #endif
 708 }
 709
 710 /******************************************************************************/
 711 /* String functions */
 712 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
 713 {
 714 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 715 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
 716 #endif
 717 return US strcat(CS dst, CCS src);
 718 }
 719 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
 720 {
 721 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 722 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
 723 #endif
 724 return US strcpy(CS dst, CCS src);
 725 }
 726 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 727 {
 728 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 729 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
 730 #endif
 731 return US strncat(CS dst, CCS src, n);
 732 }
 733 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 734 {
 735 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 736 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
 737 #endif
 738 return US strncpy(CS dst, CCS src, n);
 739 }
 740 /*XXX will likely need unchecked copy also */
 741
 742
 743 /* Advance the string pointer given over any whitespace.
 744 Return the next char as there's enought places using it to be useful. */
 745
 746 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
 747
 748 static inline uschar skip_whitespace(const uschar ** sp)
 749 { while (isspace(**sp)) (*sp)++; return **sp; }
 750
 751
 752 /******************************************************************************/
 753
 754 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
 755 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
 756 chown(<exim-uid>, <exim-gid>).
 757
 758 Probably because the idmapping is broken, misconfigured or set up in
 759 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
 760 case of misconfiguration, or if there are more such broken systems
 761 out, I try to impose as least impact as possible and for now just write
 762 a panic log entry pointing to the bug report. You're encouraged to
 763 contact the developers, if you experience this issue.
 764
 765 fd     the file descriptor (or -1 if not valid)
 766 name   the file name for error messages or for file operations,
 767   if fd is < 0
 768 owner  the owner
 769 group  the group
 770
 771 returns 0 on success, -1 on failure */
 772
 773 static inline int
 774 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
 775 {
 776 return fchown(fd, owner, group)
 777   ? exim_chown_failure(fd, name, owner, group) : 0;
 778 }
 779
 780 static inline int
 781 exim_chown(const uschar *name, uid_t owner, gid_t group)
 782 {
 783 return chown(CCS name, owner, group)
 784   ? exim_chown_failure(-1, name, owner, group) : 0;
 785 }
 786 #endif  /* !MACRO_PREDEF && !COMPILE_UTILITY */
 787
 788 /******************************************************************************/
 789 /* String functions */
 790
 791 #if !defined(MACRO_PREDEF)
 792 /*************************************************
 793 *            Copy and save string                *
 794 *************************************************/
 795
 796 /* This function assumes that memcpy() is faster than strcpy().
 797 The result is explicitly nul-terminated.
 798 */
 799
 800 static inline uschar *
 801 string_copyn_taint_trc(const uschar * s, unsigned len,
 802         const void * proto_mem, const char * func, int line)
 803 {
 804 uschar * ss;
 805 unsigned slen = Ustrlen(s);
 806 if (len > slen) len = slen;
 807 ss = store_get_3(len + 1, proto_mem, func, line);
 808 memcpy(ss, s, len);
 809 ss[len] = '\0';
 810 return ss;
 811 }
 812
 813 static inline uschar *
 814 string_copy_taint_trc(const uschar * s, const void * proto_mem, const char * func, int line)
 815 { return string_copyn_taint_trc(s, Ustrlen(s), proto_mem, func, line); }
 816
 817 static inline uschar *
 818 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
 819 { return string_copyn_taint_trc(s, len, s, func, line); }
 820 static inline uschar *
 821 string_copy_trc(const uschar * s, const char * func, int line)
 822 { return string_copy_taint_trc(s, s, func, line); }
 823
 824
 825 /* String-copy functions explicitly setting the taint status */
 826
 827 #define string_copyn_taint(s, len, proto_mem) \
 828         string_copyn_taint_trc((s), (len), (proto_mem), __FUNCTION__, __LINE__)
 829 #define string_copy_taint(s, proto_mem) \
 830         string_copy_taint_trc((s), (proto_mem), __FUNCTION__, __LINE__)
 831
 832 /* Simple string-copy functions maintaining the taint */
 833
 834 #define string_copyn(s, len) \
 835         string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
 836 #define string_copy(s) \
 837         string_copy_trc((s), __FUNCTION__, __LINE__)
 838
 839
 840 /*************************************************
 841 *       Copy, lowercase and save string          *
 842 *************************************************/
 843
 844 /*
 845 Argument: string to copy
 846 Returns:  copy of string in new store, with letters lowercased
 847 */
 848
 849 static inline uschar *
 850 string_copylc(const uschar * s)
 851 {
 852 uschar * ss = store_get(Ustrlen(s) + 1, s);
 853 uschar * p = ss;
 854 while (*s) *p++ = tolower(*s++);
 855 *p = 0;
 856 return ss;
 857 }
 858
 859
 860
 861 /*************************************************
 862 * Copy, lowercase, and save string, given length *
 863 *************************************************/
 864
 865 /* It is assumed the data contains no zeros. A zero is added
 866 onto the end.
 867
 868 Arguments:
 869   s         string to copy
 870   n         number of characters
 871
 872 Returns:    copy of string in new store, with letters lowercased
 873 */
 874
 875 static inline uschar *
 876 string_copynlc(uschar * s, int n)
 877 {
 878 uschar * ss = store_get(n + 1, s);
 879 uschar * p = ss;
 880 while (n-- > 0) *p++ = tolower(*s++);
 881 *p = 0;
 882 return ss;
 883 }
 884
 885
 886 # ifndef COMPILE_UTILITY
 887 /*************************************************
 888 *     Copy and save string in longterm store     *
 889 *************************************************/
 890
 891 /* This function assumes that memcpy() is faster than strcpy().
 892
 893 Argument: string to copy
 894 Returns:  copy of string in new store
 895 */
 896
 897 static inline uschar *
 898 string_copy_perm(const uschar *s, BOOL force_taint)
 899 {
 900 int old_pool = store_pool;
 901 int len = Ustrlen(s) + 1;
 902 uschar *ss;
 903
 904 store_pool = POOL_PERM;
 905 ss = store_get(len, force_taint ? GET_TAINTED : s);
 906 memcpy(ss, s, len);
 907 store_pool = old_pool;
 908 return ss;
 909 }
 910 # endif
 911
 912
 913
 914 /* sprintf into a buffer, taint-unchecked */
 915
 916 static inline void
 917 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
 918 {
 919 gstring gs = { .size = siz, .ptr = 0, .s = buf };
 920 va_list ap;
 921 va_start(ap, fmt);
 922 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
 923 va_end(ap);
 924 }
 925
 926
 927
 928 /******************************************************************************/
 929 /* Growable-string functions */
 930
 931 /* Create a growable-string with some preassigned space */
 932
 933 #define string_get_tainted(size, proto_mem) \
 934         string_get_tainted_trc((size), (proto_mem), __FUNCTION__, __LINE__)
 935
 936 static inline gstring *
 937 string_get_tainted_trc(unsigned size, const void * proto_mem, const char * func, unsigned line)
 938 {
 939 gstring * g = store_get_3(sizeof(gstring) + size, proto_mem, func, line);
 940 g->size = size;         /*XXX would be good if we could see the actual alloc size */
 941 g->ptr = 0;
 942 g->s = US(g + 1);
 943 return g;
 944 }
 945
 946 #define string_get(size) \
 947         string_get_trc((size), __FUNCTION__, __LINE__)
 948
 949 static inline gstring *
 950 string_get_trc(unsigned size, const char * func, unsigned line)
 951 {
 952 return string_get_tainted_trc(size, GET_UNTAINTED, func, line);
 953 }
 954
 955 /* NUL-terminate the C string in the growable-string, and return it. */
 956
 957 static inline uschar *
 958 string_from_gstring(gstring * g)
 959 {
 960 if (!g) return NULL;
 961 g->s[g->ptr] = '\0';
 962 return g->s;
 963 }
 964
 965 static inline unsigned
 966 gstring_length(const gstring * g)
 967 {
 968 return g ? (unsigned)g->ptr : 0;
 969 }
 970
 971
 972 #define gstring_release_unused(g) \
 973         gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
 974
 975 static inline void
 976 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
 977 {
 978 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
 979 }
 980
 981
 982 /* sprintf-append to a growable-string */
 983
 984 #define string_fmt_append(g, fmt, ...) \
 985         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
 986         SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
 987
 988 #define string_fmt_append_f(g, flgs, fmt, ...) \
 989         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
 990         flgs,         fmt, __VA_ARGS__)
 991
 992 static inline gstring *
 993 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
 994   unsigned flags, const char *format, ...)
 995 {
 996 va_list ap;
 997 va_start(ap, format);
 998 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
 999                         flags, format, ap);
1000 va_end(ap);
1001 return g;
1002 }
1003
1004
1005 /* Copy the content of a string to tainted memory.  The proto_mem arg
1006 will always be tainted, and suitable as a prototype. */
1007
1008 static inline void
1009 gstring_rebuffer(gstring * g, const void * proto_mem)
1010 {
1011 uschar * s = store_get_3(g->size, proto_mem, __FUNCTION__, __LINE__);
1012 memcpy(s, g->s, g->ptr);
1013 g->s = s;
1014 }
1015
1016
1017 # ifndef COMPILE_UTILITY
1018 /******************************************************************************/
1019 /* Use store_malloc for DNSA structs, and explicit frees. Using the same pool
1020 for them as the strings we proceed to copy from them meant they could not be
1021 released, hence blowing 64k for every DNS lookup. That mounted up. With malloc
1022 we do have to take care over marking tainted all copied strings.  A separate pool
1023 could be used and would handle that implicitly. */
1024
1025 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
1026
1027 static inline dns_answer *
1028 store_get_dns_answer_trc(const uschar * func, unsigned line)
1029 {
1030 return store_malloc_3(sizeof(dns_answer), CCS func, line);
1031 }
1032
1033 #define store_free_dns_answer(dnsa) store_free_dns_answer_trc(dnsa, CUS __FUNCTION__, __LINE__)
1034
1035 static inline void
1036 store_free_dns_answer_trc(dns_answer * dnsa, const uschar * func, unsigned line)
1037 {
1038 store_free_3(dnsa, CCS func, line);
1039 }
1040
1041 /******************************************************************************/
1042 /* Routines with knowledge of spool layout */
1043
1044 static inline void
1045 spool_pname_buf(uschar * buf, int len)
1046 {
1047 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
1048 }
1049
1050 static inline uschar *
1051 spool_dname(const uschar * purpose, uschar * subdir)
1052 {
1053 return string_sprintf("%s/%s/%s/%s",
1054         spool_directory, queue_name, purpose, subdir);
1055 }
1056 # endif
1057
1058 static inline uschar *
1059 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
1060 {
1061 return string_sprintf("%s%s%s%s%s",
1062                     q, *q ? "/" : "",
1063                     purpose,
1064                     *subdir ? "/" : "", subdir);
1065 }
1066
1067 static inline uschar *
1068 spool_sname(const uschar * purpose, uschar * subdir)
1069 {
1070 return spool_q_sname(purpose, queue_name, subdir);
1071 }
1072
1073 static inline uschar *
1074 spool_q_fname(const uschar * purpose, const uschar * q,
1075         const uschar * subdir, const uschar * fname, const uschar * suffix)
1076 {
1077 return string_sprintf("%s/%s/%s/%s/%s%s",
1078         spool_directory, q, purpose, subdir, fname, suffix);
1079 }
1080
1081 static inline uschar *
1082 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1083         const uschar * suffix)
1084 {
1085 #ifdef COMPILE_UTILITY          /* version avoiding string-extension */
1086 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1087         + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1088 uschar * buf = store_get(len, GET_UNTAINTED);
1089 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1090         spool_directory, queue_name, purpose, subdir, fname, suffix);
1091 return buf;
1092 #else
1093 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1094 #endif
1095 }
1096
1097 static inline void
1098 set_subdir_str(uschar * subdir_str, const uschar * name,
1099         int search_sequence)
1100 {
1101 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1102        ? name[5] : '\0';
1103 subdir_str[1] = '\0';
1104 }
1105
1106 /******************************************************************************/
1107 /* Time calculations */
1108
1109 /* Diff two times (later, earlier) returning diff in 1st arg */
1110 static inline void
1111 timediff(struct timeval * later, const struct timeval * earlier)
1112 {
1113 later->tv_sec -= earlier->tv_sec;
1114 if ((later->tv_usec -= earlier->tv_usec) < 0)
1115   {
1116   later->tv_sec--;
1117   later->tv_usec += 1000*1000;
1118   }
1119 }
1120
1121 static inline void
1122 timesince(struct timeval * diff, const struct timeval * then)
1123 {
1124 gettimeofday(diff, NULL);
1125 timediff(diff, then);
1126 }
1127
1128 static inline uschar *
1129 string_timediff(const struct timeval * diff)
1130 {
1131 static uschar buf[sizeof("0.000s")];
1132
1133 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1134   return readconf_printtime((int)diff->tv_sec);
1135
1136 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1137 return buf;
1138 }
1139
1140
1141 static inline uschar *
1142 string_timesince(const struct timeval * then)
1143 {
1144 struct timeval diff;
1145 timesince(&diff, then);
1146 return string_timediff(&diff);
1147 }
1148
1149 static inline void
1150 report_time_since(const struct timeval * t0, const uschar * where)
1151 {
1152 # ifdef MEASURE_TIMING
1153 struct timeval diff;
1154 timesince(&diff, t0);
1155 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1156        (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1157 # endif
1158 }
1159
1160
1161 static inline void
1162 testharness_pause_ms(int millisec)
1163 {
1164 #ifndef MEASURE_TIMING
1165 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1166 #endif
1167 }
1168
1169 /******************************************************************************/
1170 /* Taint-checked file opens */
1171
1172 static inline int
1173 exim_open2(const char *pathname, int flags)
1174 {
1175 if (!is_tainted(pathname)) return open(pathname, flags);
1176 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1177 errno = EACCES;
1178 return -1;
1179 }
1180 static inline int
1181 exim_open(const char *pathname, int flags, mode_t mode)
1182 {
1183 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1184 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1185 errno = EACCES;
1186 return -1;
1187 }
1188 #ifdef EXIM_HAVE_OPENAT
1189 static inline int
1190 exim_openat(int dirfd, const char *pathname, int flags)
1191 {
1192 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1193 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1194 errno = EACCES;
1195 return -1;
1196 }
1197 static inline int
1198 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1199 {
1200 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1201 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1202 errno = EACCES;
1203 return -1;
1204 }
1205 #endif
1206
1207 static inline FILE *
1208 exim_fopen(const char *pathname, const char *mode)
1209 {
1210 if (!is_tainted(pathname)) return fopen(pathname, mode);
1211 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1212 errno = EACCES;
1213 return NULL;
1214 }
1215
1216 static inline DIR *
1217 exim_opendir(const uschar * name)
1218 {
1219 if (!is_tainted(name)) return opendir(CCS name);
1220 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name);
1221 errno = EACCES;
1222 return NULL;
1223 }
1224
1225 /******************************************************************************/
1226 # if !defined(COMPILE_UTILITY)
1227 /* Process manipulation */
1228
1229 static inline pid_t
1230 exim_fork(const unsigned char * purpose)
1231 {
1232 pid_t pid;
1233 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1234 if ((pid = fork()) == 0)
1235   {
1236   f.daemon_listen = FALSE;
1237   process_purpose = purpose;
1238   DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1239   }
1240 else
1241   {
1242   testharness_pause_ms(100); /* let child work */
1243   DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1244   }
1245 return pid;
1246 }
1247
1248
1249 static inline pid_t
1250 child_open_exim(int * fdptr, const uschar * purpose)
1251 { return child_open_exim_function(fdptr, purpose); }
1252
1253 static inline pid_t
1254 child_open_exim2(int * fdptr, uschar * sender,
1255   uschar * sender_auth, const uschar * purpose)
1256 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1257
1258 static inline pid_t
1259 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1260   int *outfdptr, BOOL make_leader, const uschar * purpose)
1261 { return child_open_function(argv, envp, newumask, infdptr,
1262   outfdptr, make_leader, purpose);
1263 }
1264
1265 /* Return 1 if fd is usable per pollbits, else 0 */
1266 static inline int
1267 poll_one_fd(int fd, short pollbits, int tmo_millisec)
1268 {
1269 struct pollfd p = {.fd = fd, .events = pollbits};
1270 return poll(&p, 1, tmo_millisec);
1271 }
1272
1273 /******************************************************************************/
1274 /* Client-side smtp log string, for debug */
1275
1276 static inline void
1277 smtp_debug_cmd(const uschar * buf, int mode)
1278 {
1279 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent("  SMTP%c> %s\n",
1280   mode == SCMD_BUFFER ? '|' : mode == SCMD_MORE ? '+' : '>', buf);
1281
1282 #  ifndef DISABLE_CLIENT_CMD_LOG
1283   {
1284   int len = Ustrcspn(buf, " \n");
1285   int old_pool = store_pool;
1286   store_pool = POOL_PERM;       /* Main pool ACL allocations eg. callouts get released */
1287   client_cmd_log = string_append_listele_n(client_cmd_log, ':', buf, MIN(len, 8));
1288   if (mode == SCMD_BUFFER)
1289     {
1290     client_cmd_log = string_catn(client_cmd_log, US"|", 1);
1291     (void) string_from_gstring(client_cmd_log);
1292     }
1293   store_pool = old_pool;
1294   }
1295 #  endif
1296 }
1297
1298
1299 static inline void
1300 smtp_debug_cmd_report(void)
1301 {
1302 #  ifndef DISABLE_CLIENT_CMD_LOG
1303 debug_printf("cmdlog: '%s'\n", client_cmd_log ? client_cmd_log->s : US"(unset)");
1304 #  endif
1305 }
1306
1307
1308
1309 # endif /* !COMPILE_UTILITY */
1310
1311 /******************************************************************************/
1312 #endif  /* !MACRO_PREDEF */
1313
1314 #endif  /* _FUNCTIONS_H_ */
1315
1316 /* vi: aw
1317 */
1318 /* End of functions.h */