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