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