src/src/functions.h

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