src/src/functions.h

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