src/src/functions.h

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