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