src/src/functions.h

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