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(void);
  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, uschar *, BOOL);
 382 extern const uschar *parse_date_time(const uschar *str, time_t *t);
 383 extern void priv_drop_temp(const uid_t, const gid_t);
 384 extern void priv_restore(void);
 385 extern int     vaguely_random_number(int);
 386 #ifndef DISABLE_TLS
 387 extern int     vaguely_random_number_fallback(int);
 388 #endif
 389
 390 extern BOOL    queue_action(uschar *, int, uschar **, int, int);
 391 extern void    queue_check_only(void);
 392 extern unsigned queue_count(void);
 393 extern unsigned queue_count_cached(void);
 394 extern void    queue_list(int, uschar **, int);
 395 #ifndef DISABLE_QUEUE_RAMP
 396 extern void    queue_notify_daemon(const uschar * hostname);
 397 #endif
 398 extern void    queue_run(uschar *, uschar *, BOOL);
 399
 400 extern int     random_number(int);
 401 extern const uschar *rc_to_string(int);
 402 extern int     rda_interpret(redirect_block *, int, uschar *, uschar *,
 403                  uschar *, uschar *, uschar *, ugid_block *, address_item **,
 404                  uschar **, error_block **, int *, uschar *);
 405 extern int     rda_is_filter(const uschar *);
 406 extern BOOL    readconf_depends(driver_instance *, uschar *);
 407 extern void    readconf_driver_init(uschar *, driver_instance **,
 408                  driver_info *, int, void *, int, optionlist *, int);
 409 extern uschar *readconf_find_option(void *);
 410 extern void    readconf_main(BOOL);
 411 extern void    readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
 412 extern BOOL    readconf_print(const uschar *, uschar *, BOOL);
 413 extern uschar *readconf_printtime(int);
 414 extern uschar *readconf_readname(uschar *, int, uschar *);
 415 extern int     readconf_readtime(const uschar *, int, BOOL);
 416 extern void    readconf_rest(void);
 417 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
 418 extern void    readconf_save_config(const uschar *);
 419 extern void    read_message_body(BOOL);
 420 extern void    receive_bomb_out(uschar *, uschar *) NORETURN;
 421 extern BOOL    receive_check_fs(int);
 422 extern BOOL    receive_check_set_sender(uschar *);
 423 extern BOOL    receive_msg(BOOL);
 424 extern int_eximarith_t receive_statvfs(BOOL, int *);
 425 extern void    receive_swallow_smtp(void);
 426 #ifdef WITH_CONTENT_SCAN
 427 extern int     regex(const uschar **);
 428 #endif
 429 extern BOOL    regex_match(const pcre2_code *, const uschar *, int, uschar **);
 430 extern BOOL    regex_match_and_setup(const pcre2_code *, const uschar *, int, int);
 431 extern const pcre2_code *regex_must_compile(const uschar *, BOOL, BOOL);
 432 extern void    retry_add_item(address_item *, uschar *, int);
 433 extern BOOL    retry_check_address(const uschar *, host_item *, uschar *, BOOL,
 434                  uschar **, uschar **);
 435 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
 436 extern BOOL    retry_ultimate_address_timeout(uschar *, const uschar *,
 437                  dbdata_retry *, time_t);
 438 extern void    retry_update(address_item **, address_item **, address_item **);
 439 extern const uschar *rewrite_address(const uschar *, BOOL, BOOL, rewrite_rule *, int);
 440 extern const uschar *rewrite_address_qualify(const uschar *, BOOL);
 441 extern header_line *rewrite_header(header_line *,
 442                const uschar *, const uschar *,
 443                rewrite_rule *, int, BOOL);
 444 extern const uschar *rewrite_one(const uschar *, int, BOOL *, BOOL, uschar *,
 445                  rewrite_rule *);
 446 extern void    rewrite_test(const uschar *);
 447 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
 448                  uschar **);
 449 extern int     route_address(address_item *, address_item **, address_item **,
 450                  address_item **, address_item **, int);
 451 extern int     route_check_prefix(const uschar *, const uschar *, unsigned *);
 452 extern int     route_check_suffix(const uschar *, const uschar *, unsigned *);
 453 extern BOOL    route_findgroup(uschar *, gid_t *);
 454 extern BOOL    route_finduser(const uschar *, struct passwd **, uid_t *);
 455 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 456                  uschar **);
 457 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 458                  struct passwd **, uid_t *, uschar **);
 459 extern void    route_init(void);
 460 extern gstring * route_show_supported(gstring *);
 461 extern void    route_tidyup(void);
 462
 463 extern uschar *search_args(int, uschar *, uschar *, uschar **, const uschar *);
 464 extern uschar *search_find(void *, const uschar *, uschar *, int,
 465                  const uschar *, int, int, int *, const uschar *);
 466 extern int     search_findtype(const uschar *, int);
 467 extern int     search_findtype_partial(const uschar *, int *, const uschar **, int *,
 468                  int *, const uschar **);
 469 extern void   *search_open(const uschar *, int, int, uid_t *, gid_t *);
 470 extern void    search_tidyup(void);
 471 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
 472 extern void    sha1_end(hctx *, const uschar *, int, uschar *);
 473 extern void    sha1_mid(hctx *, const uschar *);
 474 extern void    sha1_start(hctx *);
 475 extern int     sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
 476                  uschar *, address_item **, uschar **);
 477 extern void    sigalrm_handler(int);
 478 extern BOOL    smtp_buffered(void);
 479 extern void    smtp_closedown(uschar *);
 480 extern void    smtp_command_timeout_exit(void) NORETURN;
 481 extern void    smtp_command_sigterm_exit(void) NORETURN;
 482 extern void    smtp_data_timeout_exit(void) NORETURN;
 483 extern void    smtp_data_sigint_exit(void) NORETURN;
 484 extern void    smtp_deliver_init(void);
 485 extern uschar *smtp_cmd_hist(void);
 486 extern int     smtp_connect(smtp_connect_args *, const blob *);
 487 extern int     smtp_sock_connect(host_item *, int, int, uschar *,
 488                  transport_instance * tb, int, const blob *);
 489 extern int     smtp_feof(void);
 490 extern int     smtp_ferror(void);
 491 extern uschar *smtp_get_connection_info(void);
 492 extern BOOL    smtp_get_interface(uschar *, int, address_item *,
 493                  uschar **, uschar *);
 494 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 495 extern int     smtp_getc(unsigned);
 496 extern uschar *smtp_getbuf(unsigned *);
 497 extern void    smtp_get_cache(void);
 498 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 499 extern void    smtp_log_no_mail(void);
 500 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
 501 extern void    smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
 502 extern BOOL    smtp_read_response(void *, uschar *, int, int, int);
 503 extern void   *smtp_reset(void *);
 504 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 505 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
 506 extern void    smtp_port_for_connect(host_item *, int);
 507 extern void    smtp_send_prohibition_message(int, uschar *);
 508 extern int     smtp_setup_msg(void);
 509 extern BOOL    smtp_start_session(void);
 510 extern int     smtp_ungetc(int);
 511 extern BOOL    smtp_verify_helo(void);
 512 extern int     smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
 513 #ifdef WITH_CONTENT_SCAN
 514 extern int     spam(const uschar **);
 515 extern FILE   *spool_mbox(unsigned long *, const uschar *, uschar **);
 516 #endif
 517 extern void    spool_clear_header_globals(void);
 518 extern BOOL    spool_move_message(uschar *, uschar *, uschar *, uschar *);
 519 extern int     spool_open_datafile(uschar *);
 520 extern int     spool_open_temp(uschar *);
 521 extern int     spool_read_header(uschar *, BOOL, BOOL);
 522 extern uschar *spool_sender_from_msgid(const uschar *);
 523 extern int     spool_write_header(uschar *, int, uschar **);
 524 extern int     stdin_getc(unsigned);
 525 extern int     stdin_feof(void);
 526 extern int     stdin_ferror(void);
 527 extern int     stdin_ungetc(int);
 528
 529 extern void    store_exit(void);
 530 extern void    store_init(void);
 531 extern void    store_writeprotect(int);
 532
 533 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
 534 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
 535 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
 536 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
 537 extern uschar *string_base62(unsigned long int);
 538 extern gstring *string_cat (gstring *, const uschar *     ) WARN_UNUSED_RESULT;
 539 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
 540 extern int     string_compare_by_pointer(const void *, const void *);
 541 extern uschar *string_copy_dnsdomain(uschar *);
 542 extern uschar *string_copy_malloc(const uschar *);
 543 extern uschar *string_dequote(const uschar **);
 544 extern uschar *string_format_size(int, uschar *);
 545 extern int     string_interpret_escape(const uschar **);
 546 extern int     string_is_ip_address(const uschar *, int *);
 547 #ifdef SUPPORT_I18N
 548 extern BOOL    string_is_utf8(const uschar *);
 549 #endif
 550 extern const uschar *string_printing2(const uschar *, int);
 551 extern uschar *string_split_message(uschar *);
 552 extern uschar *string_unprinting(uschar *);
 553 #ifdef SUPPORT_I18N
 554 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
 555 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
 556 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
 557 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
 558 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
 559 #endif
 560
 561 #define string_format(buf, siz, fmt, ...) \
 562         string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 563 extern BOOL    string_format_trc(uschar *, int, const uschar *, unsigned,
 564                         const char *, ...) ALMOST_PRINTF(5,6);
 565
 566 #define string_vformat(g, flgs, fmt, ap) \
 567         string_vformat_trc(g, US __FUNCTION__, __LINE__, \
 568                          STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
 569 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
 570                         unsigned, unsigned, const char *, va_list);
 571
 572 #define string_open_failed(fmt, ...) \
 573         string_open_failed_trc(US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 574 extern uschar *string_open_failed_trc(const uschar *, unsigned,
 575                         const char *, ...) PRINTF_FUNCTION(3,4);
 576
 577 #define string_nextinlist(lp, sp, b, l) \
 578         string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
 579 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
 580                         const uschar * func, int line);
 581
 582 extern int     strcmpic(const uschar *, const uschar *);
 583 extern int     strncmpic(const uschar *, const uschar *, int);
 584 extern uschar *strstric(uschar *, uschar *, BOOL);
 585
 586 extern int     test_harness_fudged_queue_time(int);
 587 extern void    tcp_init(void);
 588 #ifdef EXIM_TFO_PROBE
 589 extern void    tfo_probe(void);
 590 #endif
 591 extern void    tls_modify_variables(tls_support *);
 592 extern uschar *tod_stamp(int);
 593
 594 extern BOOL    transport_check_waiting(const uschar *, const uschar *, int, uschar *,
 595                  oicf, void*);
 596 extern void    transport_init(void);
 597 extern void    transport_do_pass_socket(const uschar *, const uschar *,
 598                  const uschar *, uschar *, int);
 599 extern BOOL    transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *, int
 600 #ifdef EXPERIMENTAL_ESMTP_LIMITS
 601                         , unsigned, unsigned, unsigned
 602 #endif
 603                         );
 604 extern uschar *transport_rcpt_address(address_item *, BOOL);
 605 extern BOOL    transport_set_up_command(const uschar ***, uschar *,
 606                  BOOL, int, address_item *, uschar *, uschar **);
 607 extern void    transport_update_waiting(host_item *, uschar *);
 608 extern BOOL    transport_write_block(transport_ctx *, uschar *, int, BOOL);
 609 extern void    transport_write_reset(int);
 610 extern BOOL    transport_write_string(int, const char *, ...);
 611 extern BOOL    transport_headers_send(transport_ctx *,
 612                  BOOL (*)(transport_ctx *, uschar *, int));
 613 extern gstring * transport_show_supported(gstring *);
 614 extern BOOL    transport_write_message(transport_ctx *, int);
 615 extern void    tree_add_duplicate(const uschar *, address_item *);
 616 extern void    tree_add_nonrecipient(const uschar *);
 617 extern void    tree_add_unusable(const host_item *);
 618 extern void    tree_dup(tree_node **, tree_node *);
 619 extern int     tree_insertnode(tree_node **, tree_node *);
 620 extern tree_node *tree_search(tree_node *, const uschar *);
 621 extern void    tree_write(tree_node *, FILE *);
 622 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 623
 624 #ifdef WITH_CONTENT_SCAN
 625 extern void    unspool_mbox(void);
 626 #endif
 627 #ifdef SUPPORT_I18N
 628 extern void    utf8_version_report(FILE *);
 629 #endif
 630
 631 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 632                  uschar *, uschar *, BOOL *);
 633 extern int     verify_check_dnsbl(int, const uschar **, uschar **);
 634 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 635                  uschar *, uschar *, int, int *);
 636 extern int     verify_check_headers(uschar **);
 637 extern int     verify_check_header_names_ascii(uschar **);
 638 extern int     verify_check_host(uschar **);
 639 extern int     verify_check_notblind(BOOL);
 640 extern int     verify_check_given_host(const uschar **, const host_item *);
 641 extern int     verify_check_this_host(const uschar **, unsigned int *,
 642                  const uschar*, const uschar *, const uschar **);
 643 extern address_item *verify_checked_sender(uschar *);
 644 extern void    verify_get_ident(int);
 645 extern void    verify_quota(uschar *);
 646 extern int     verify_quota_call(const uschar *, int, int, uschar **);
 647 extern BOOL    verify_sender(int *, uschar **);
 648 extern BOOL    verify_sender_preliminary(int *, uschar **);
 649 extern void    version_init(void);
 650
 651 extern BOOL    write_chunk(transport_ctx *, uschar *, int);
 652 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
 653
 654
 655 /******************************************************************************/
 656 /* Predicate: if an address is in a tainted pool.
 657 By extension, a variable pointing to this address is tainted.
 658 */
 659
 660 static inline BOOL
 661 is_tainted(const void * p)
 662 {
 663 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
 664 return FALSE;
 665
 666 #else
 667 extern BOOL is_tainted_fn(const void *);
 668 return is_tainted_fn(p);
 669 #endif
 670 }
 671
 672 /******************************************************************************/
 673 /* String functions */
 674 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
 675 {
 676 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 677 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
 678 #endif
 679 return US strcat(CS dst, CCS src);
 680 }
 681 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
 682 {
 683 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 684 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
 685 #endif
 686 return US strcpy(CS dst, CCS src);
 687 }
 688 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 689 {
 690 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 691 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
 692 #endif
 693 return US strncat(CS dst, CCS src, n);
 694 }
 695 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 696 {
 697 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 698 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
 699 #endif
 700 return US strncpy(CS dst, CCS src, n);
 701 }
 702 /*XXX will likely need unchecked copy also */
 703
 704
 705 /* Advance the string pointer given over any whitespace.
 706 Return the next char as there's enought places using it to be useful. */
 707
 708 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
 709
 710 static inline uschar skip_whitespace(const uschar ** sp)
 711 { while (isspace(**sp)) (*sp)++; return **sp; }
 712
 713
 714 /******************************************************************************/
 715
 716 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
 717 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
 718 chown(<exim-uid>, <exim-gid>).
 719
 720 Probably because the idmapping is broken, misconfigured or set up in
 721 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
 722 case of misconfiguration, or if there are more such broken systems
 723 out, I try to impose as least impact as possible and for now just write
 724 a panic log entry pointing to the bug report. You're encouraged to
 725 contact the developers, if you experience this issue.
 726
 727 fd     the file descriptor (or -1 if not valid)
 728 name   the file name for error messages or for file operations,
 729   if fd is < 0
 730 owner  the owner
 731 group  the group
 732
 733 returns 0 on success, -1 on failure */
 734
 735 static inline int
 736 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
 737 {
 738 return fchown(fd, owner, group)
 739   ? exim_chown_failure(fd, name, owner, group) : 0;
 740 }
 741
 742 static inline int
 743 exim_chown(const uschar *name, uid_t owner, gid_t group)
 744 {
 745 return chown(CCS name, owner, group)
 746   ? exim_chown_failure(-1, name, owner, group) : 0;
 747 }
 748 #endif  /* !MACRO_PREDEF && !COMPILE_UTILITY */
 749
 750 /******************************************************************************/
 751 /* String functions */
 752
 753 #if !defined(MACRO_PREDEF)
 754 /*************************************************
 755 *            Copy and save string                *
 756 *************************************************/
 757
 758 /* This function assumes that memcpy() is faster than strcpy().
 759 The result is explicitly nul-terminated.
 760 */
 761
 762 static inline uschar *
 763 string_copyn_taint_trc(const uschar * s, unsigned len,
 764         BOOL tainted, const char * func, int line)
 765 {
 766 uschar * ss = store_get_3(len + 1, tainted, func, line);
 767 memcpy(ss, s, len);
 768 ss[len] = '\0';
 769 return ss;
 770 }
 771
 772 static inline uschar *
 773 string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line)
 774 { return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); }
 775
 776 static inline uschar *
 777 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
 778 { return string_copyn_taint_trc(s, len, is_tainted(s), func, line); }
 779 static inline uschar *
 780 string_copy_trc(const uschar * s, const char * func, int line)
 781 { return string_copy_taint_trc(s, is_tainted(s), func, line); }
 782
 783
 784 /* String-copy functions explicitly setting the taint status */
 785
 786 #define string_copyn_taint(s, len, tainted) \
 787         string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__)
 788 #define string_copy_taint(s, tainted) \
 789         string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__)
 790
 791 /* Simple string-copy functions maintaining the taint */
 792
 793 #define string_copyn(s, len) \
 794         string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
 795 #define string_copy(s) \
 796         string_copy_trc((s), __FUNCTION__, __LINE__)
 797
 798
 799 /*************************************************
 800 *       Copy, lowercase and save string          *
 801 *************************************************/
 802
 803 /*
 804 Argument: string to copy
 805 Returns:  copy of string in new store, with letters lowercased
 806 */
 807
 808 static inline uschar *
 809 string_copylc(const uschar *s)
 810 {
 811 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
 812 uschar *p = ss;
 813 while (*s != 0) *p++ = tolower(*s++);
 814 *p = 0;
 815 return ss;
 816 }
 817
 818
 819
 820 /*************************************************
 821 * Copy, lowercase, and save string, given length *
 822 *************************************************/
 823
 824 /* It is assumed the data contains no zeros. A zero is added
 825 onto the end.
 826
 827 Arguments:
 828   s         string to copy
 829   n         number of characters
 830
 831 Returns:    copy of string in new store, with letters lowercased
 832 */
 833
 834 static inline uschar *
 835 string_copynlc(uschar *s, int n)
 836 {
 837 uschar *ss = store_get(n + 1, is_tainted(s));
 838 uschar *p = ss;
 839 while (n-- > 0) *p++ = tolower(*s++);
 840 *p = 0;
 841 return ss;
 842 }
 843
 844
 845 # ifndef COMPILE_UTILITY
 846 /*************************************************
 847 *     Copy and save string in longterm store     *
 848 *************************************************/
 849
 850 /* This function assumes that memcpy() is faster than strcpy().
 851
 852 Argument: string to copy
 853 Returns:  copy of string in new store
 854 */
 855
 856 static inline uschar *
 857 string_copy_perm(const uschar *s, BOOL force_taint)
 858 {
 859 int old_pool = store_pool;
 860 int len = Ustrlen(s) + 1;
 861 uschar *ss;
 862
 863 store_pool = POOL_PERM;
 864 ss = store_get(len, force_taint || is_tainted(s));
 865 memcpy(ss, s, len);
 866 store_pool = old_pool;
 867 return ss;
 868 }
 869 # endif
 870
 871
 872
 873 /* sprintf into a buffer, taint-unchecked */
 874
 875 static inline void
 876 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
 877 {
 878 gstring gs = { .size = siz, .ptr = 0, .s = buf };
 879 va_list ap;
 880 va_start(ap, fmt);
 881 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
 882 va_end(ap);
 883 }
 884
 885
 886
 887 /******************************************************************************/
 888 /* Growable-string functions */
 889
 890 /* Create a growable-string with some preassigned space */
 891
 892 #define string_get_tainted(size, tainted) \
 893         string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
 894
 895 static inline gstring *
 896 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
 897 {
 898 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
 899 g->size = size;
 900 g->ptr = 0;
 901 g->s = US(g + 1);
 902 return g;
 903 }
 904
 905 #define string_get(size) \
 906         string_get_trc((size), __FUNCTION__, __LINE__)
 907
 908 static inline gstring *
 909 string_get_trc(unsigned size, const char * func, unsigned line)
 910 {
 911 return string_get_tainted_trc(size, FALSE, func, line);
 912 }
 913
 914 /* NUL-terminate the C string in the growable-string, and return it. */
 915
 916 static inline uschar *
 917 string_from_gstring(gstring * g)
 918 {
 919 if (!g) return NULL;
 920 g->s[g->ptr] = '\0';
 921 return g->s;
 922 }
 923
 924 static inline unsigned
 925 gstring_length(const gstring * g)
 926 {
 927 return g ? (unsigned)g->ptr : 0;
 928 }
 929
 930
 931 #define gstring_release_unused(g) \
 932         gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
 933
 934 static inline void
 935 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
 936 {
 937 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
 938 }
 939
 940
 941 /* sprintf-append to a growable-string */
 942
 943 #define string_fmt_append(g, fmt, ...) \
 944         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
 945         SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
 946
 947 #define string_fmt_append_f(g, flgs, fmt, ...) \
 948         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
 949         flgs,         fmt, __VA_ARGS__)
 950
 951 static inline gstring *
 952 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
 953   unsigned flags, const char *format, ...)
 954 {
 955 va_list ap;
 956 va_start(ap, format);
 957 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
 958                         flags, format, ap);
 959 va_end(ap);
 960 return g;
 961 }
 962
 963
 964 /* Copy the content of a string to tainted memory */
 965
 966 static inline void
 967 gstring_rebuffer(gstring * g)
 968 {
 969 uschar * s = store_get(g->size, TRUE);
 970 memcpy(s, g->s, g->ptr);
 971 g->s = s;
 972 }
 973
 974
 975 # ifndef COMPILE_UTILITY
 976 /******************************************************************************/
 977 /* Use store_malloc for DNSA structs, and explicit frees. Using the same pool
 978 for them as the strings we proceed to copy from them meant they could not be
 979 released, hence blowing 64k for every DNS lookup. That mounted up. With malloc
 980 we do have to take care over marking tainted all copied strings.  A separate pool
 981 could be used and would handle that implicitly. */
 982
 983 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
 984
 985 static inline dns_answer *
 986 store_get_dns_answer_trc(const uschar * func, unsigned line)
 987 {
 988 /* return store_get_3(sizeof(dns_answer), TRUE, CCS func, line);   use tainted mem */
 989 return store_malloc_3(sizeof(dns_answer), CCS func, line);
 990 }
 991
 992 #define store_free_dns_answer(dnsa) store_free_dns_answer_trc(dnsa, CUS __FUNCTION__, __LINE__)
 993
 994 static inline void
 995 store_free_dns_answer_trc(dns_answer * dnsa, const uschar * func, unsigned line)
 996 {
 997 store_free_3(dnsa, CCS func, line);
 998 }
 999
1000 /******************************************************************************/
1001 /* Routines with knowledge of spool layout */
1002
1003 static inline void
1004 spool_pname_buf(uschar * buf, int len)
1005 {
1006 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
1007 }
1008
1009 static inline uschar *
1010 spool_dname(const uschar * purpose, uschar * subdir)
1011 {
1012 return string_sprintf("%s/%s/%s/%s",
1013         spool_directory, queue_name, purpose, subdir);
1014 }
1015 # endif
1016
1017 static inline uschar *
1018 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
1019 {
1020 return string_sprintf("%s%s%s%s%s",
1021                     q, *q ? "/" : "",
1022                     purpose,
1023                     *subdir ? "/" : "", subdir);
1024 }
1025
1026 static inline uschar *
1027 spool_sname(const uschar * purpose, uschar * subdir)
1028 {
1029 return spool_q_sname(purpose, queue_name, subdir);
1030 }
1031
1032 static inline uschar *
1033 spool_q_fname(const uschar * purpose, const uschar * q,
1034         const uschar * subdir, const uschar * fname, const uschar * suffix)
1035 {
1036 return string_sprintf("%s/%s/%s/%s/%s%s",
1037         spool_directory, q, purpose, subdir, fname, suffix);
1038 }
1039
1040 static inline uschar *
1041 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1042         const uschar * suffix)
1043 {
1044 #ifdef COMPILE_UTILITY          /* version avoiding string-extension */
1045 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1046         + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1047 uschar * buf = store_get(len, FALSE);
1048 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1049         spool_directory, queue_name, purpose, subdir, fname, suffix);
1050 return buf;
1051 #else
1052 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1053 #endif
1054 }
1055
1056 static inline void
1057 set_subdir_str(uschar * subdir_str, const uschar * name,
1058         int search_sequence)
1059 {
1060 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1061        ? name[5] : '\0';
1062 subdir_str[1] = '\0';
1063 }
1064
1065 /******************************************************************************/
1066 /* Time calculations */
1067
1068 /* Diff two times (later, earlier) returning diff in 1st arg */
1069 static inline void
1070 timediff(struct timeval * later, const struct timeval * earlier)
1071 {
1072 later->tv_sec -= earlier->tv_sec;
1073 if ((later->tv_usec -= earlier->tv_usec) < 0)
1074   {
1075   later->tv_sec--;
1076   later->tv_usec += 1000*1000;
1077   }
1078 }
1079
1080 static inline void
1081 timesince(struct timeval * diff, const struct timeval * then)
1082 {
1083 gettimeofday(diff, NULL);
1084 timediff(diff, then);
1085 }
1086
1087 static inline uschar *
1088 string_timediff(const struct timeval * diff)
1089 {
1090 static uschar buf[sizeof("0.000s")];
1091
1092 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1093   return readconf_printtime((int)diff->tv_sec);
1094
1095 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1096 return buf;
1097 }
1098
1099
1100 static inline uschar *
1101 string_timesince(const struct timeval * then)
1102 {
1103 struct timeval diff;
1104 timesince(&diff, then);
1105 return string_timediff(&diff);
1106 }
1107
1108 static inline void
1109 report_time_since(const struct timeval * t0, const uschar * where)
1110 {
1111 # ifdef MEASURE_TIMING
1112 struct timeval diff;
1113 timesince(&diff, t0);
1114 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1115        (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1116 # endif
1117 }
1118
1119
1120 static inline void
1121 testharness_pause_ms(int millisec)
1122 {
1123 #ifndef MEASURE_TIMING
1124 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1125 #endif
1126 }
1127
1128 /******************************************************************************/
1129 /* Taint-checked file opens */
1130 static inline uschar *
1131 is_tainted2(const void *p, int lflags, const char* fmt, ...)
1132 {
1133 va_list ap;
1134 uschar *msg;
1135 rmark mark;
1136
1137 if (!is_tainted(p))
1138   return NULL;
1139
1140 mark = store_mark();
1141 va_start(ap, fmt);
1142 msg = string_from_gstring(string_vformat(NULL, SVFMT_TAINT_NOCHK|SVFMT_EXTEND, fmt, ap));
1143 va_end(ap);
1144
1145 #ifdef ALLOW_INSECURE_TAINTED_DATA
1146 if (allow_insecure_tainted_data)
1147   {
1148   if LOGGING(tainted) log_write(0, LOG_MAIN, "Warning: %s", msg);
1149   store_reset(mark);
1150   return NULL;
1151   }
1152 #endif
1153
1154 if (lflags) log_write(0, lflags, "%s", msg);
1155 return msg; /* no store_reset(), as the message might be used afterwards and Exim
1156             is expected to exit anyway, so we do not care about the leaked
1157             storage */
1158 }
1159
1160 static inline int
1161 exim_open2(const char *pathname, int flags)
1162 {
1163 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1164   return open(pathname, flags);
1165 errno = EACCES;
1166 return -1;
1167 }
1168
1169 static inline int
1170 exim_open(const char *pathname, int flags, mode_t mode)
1171 {
1172 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1173   return open(pathname, flags, mode);
1174 errno = EACCES;
1175 return -1;
1176 }
1177 #ifdef EXIM_HAVE_OPENAT
1178 static inline int
1179 exim_openat(int dirfd, const char *pathname, int flags)
1180 {
1181 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1182   return openat(dirfd, pathname, flags);
1183 errno = EACCES;
1184 return -1;
1185 }
1186 static inline int
1187 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1188 {
1189 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1190   return openat(dirfd, pathname, flags, mode);
1191 errno = EACCES;
1192 return -1;
1193 }
1194 #endif
1195
1196 static inline FILE *
1197 exim_fopen(const char *pathname, const char *mode)
1198 {
1199 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1200   return fopen(pathname, mode);
1201 errno = EACCES;
1202 return NULL;
1203 }
1204
1205 static inline DIR *
1206 exim_opendir(const uschar * name)
1207 {
1208 if (!is_tainted2(name, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name))
1209   return opendir(CCS name);
1210 errno = EACCES;
1211 return NULL;
1212 }
1213
1214 /******************************************************************************/
1215 # if !defined(COMPILE_UTILITY)
1216 /* Process manipulation */
1217
1218 static inline pid_t
1219 exim_fork(const unsigned char * purpose)
1220 {
1221 pid_t pid;
1222 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1223 if ((pid = fork()) == 0)
1224   {
1225   process_purpose = purpose;
1226   DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1227   }
1228 else
1229   {
1230   testharness_pause_ms(100); /* let child work */
1231   DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1232   }
1233 return pid;
1234 }
1235
1236
1237 static inline pid_t
1238 child_open_exim(int * fdptr, const uschar * purpose)
1239 { return child_open_exim_function(fdptr, purpose); }
1240
1241 static inline pid_t
1242 child_open_exim2(int * fdptr, uschar * sender,
1243   uschar * sender_auth, const uschar * purpose)
1244 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1245
1246 static inline pid_t
1247 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1248   int *outfdptr, BOOL make_leader, const uschar * purpose)
1249 { return child_open_function(argv, envp, newumask, infdptr,
1250   outfdptr, make_leader, purpose);
1251 }
1252
1253 # endif /* !COMPILE_UTILITY */
1254
1255 /******************************************************************************/
1256 #endif  /* !MACRO_PREDEF */
1257
1258 #endif  /* _FUNCTIONS_H_ */
1259
1260 /* vi: aw
1261 */
1262 /* End of functions.h */