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