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 BOOL    tls_smtp_buffered(void);
  79 extern int     tls_ungetc(int);
  80 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
  81 extern void    tls_watch_discard_event(int);
  82 extern void    tls_watch_invalidate(void);
  83 #endif
  84 extern int     tls_write(void *, const uschar *, size_t, BOOL);
  85 extern uschar *tls_validate_require_cipher(void);
  86 extern void    tls_version_report(FILE *);
  87
  88 # ifdef SUPPORT_DANE
  89 extern int     tlsa_lookup(const host_item *, dns_answer *, BOOL);
  90 # endif
  91
  92 #endif  /*DISABLE_TLS*/
  93
  94
  95 /* Everything else... */
  96
  97 extern acl_block *acl_read(uschar *(*)(void), uschar **);
  98 extern int     acl_check(int, uschar *, uschar *, uschar **, uschar **);
  99 extern int     acl_eval(int, uschar *, uschar **, uschar **);
 100
 101 extern tree_node *acl_var_create(uschar *);
 102 extern void    acl_var_write(uschar *, uschar *, void *);
 103
 104 #ifdef EXPERIMENTAL_ARC
 105 extern void   *arc_ams_setup_sign_bodyhash(void);
 106 extern const uschar *arc_header_feed(gstring *, BOOL);
 107 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
 108 extern void     arc_sign_init(void);
 109 extern const uschar *acl_verify_arc(void);
 110 extern uschar * fn_arc_domains(void);
 111 #endif
 112
 113 extern void    assert_no_variables(void *, int, const char *, int);
 114 extern int     auth_call_pam(const uschar *, uschar **);
 115 extern int     auth_call_pwcheck(uschar *, uschar **);
 116 extern int     auth_call_radius(const uschar *, uschar **);
 117 extern int     auth_call_saslauthd(const uschar *, const uschar *,
 118                  const uschar *, const uschar *, uschar **);
 119 extern int     auth_check_serv_cond(auth_instance *);
 120 extern int     auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
 121 extern int     auth_client_item(void *, auth_instance *, const uschar **,
 122                  unsigned, int, uschar *, int);
 123
 124
 125 extern int     auth_get_data(uschar **, const uschar *, int);
 126 extern int     auth_get_no64_data(uschar **, uschar *);
 127 extern int     auth_prompt(const uschar *);
 128 extern int     auth_read_input(const uschar *);
 129 extern gstring * auth_show_supported(gstring *);
 130 extern uschar *auth_xtextencode(uschar *, int);
 131 extern int     auth_xtextdecode(uschar *, uschar **);
 132
 133 #ifdef EXPERIMENTAL_ARC
 134 extern gstring *authres_arc(gstring *);
 135 #endif
 136 #ifndef DISABLE_DKIM
 137 extern gstring *authres_dkim(gstring *);
 138 #endif
 139 #ifdef SUPPORT_DMARC
 140 extern gstring *authres_dmarc(gstring *);
 141 #endif
 142 extern gstring *authres_smtpauth(gstring *);
 143 #ifdef SUPPORT_SPF
 144 extern gstring *authres_spf(gstring *);
 145 #endif
 146
 147 extern uschar *b64encode(const uschar *, int);
 148 extern uschar *b64encode_taint(const uschar *, int, BOOL);
 149 extern int     b64decode(const uschar *, uschar **);
 150 extern int     bdat_getc(unsigned);
 151 extern uschar *bdat_getbuf(unsigned *);
 152 extern int     bdat_ungetc(int);
 153 extern void    bdat_flush_data(void);
 154
 155 extern void    bits_clear(unsigned int *, size_t, int *);
 156 extern void    bits_set(unsigned int *, size_t, int *);
 157
 158 extern void    cancel_cutthrough_connection(BOOL, const uschar *);
 159 extern gstring *cat_file(FILE *, gstring *, uschar *);
 160 extern gstring *cat_file_tls(void *, gstring *, uschar *);
 161 extern int     check_host(void *, const uschar *, const uschar **, uschar **);
 162 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
 163 extern pid_t   child_open_exim_function(int *, const uschar *);
 164 extern pid_t   child_open_exim2_function(int *, uschar *, uschar *,
 165                  const uschar *);
 166 extern pid_t   child_open_function(uschar **, uschar **, int,
 167                  int *, int *, BOOL, const uschar *);
 168 extern pid_t   child_open_uid(const uschar **, const uschar **, int,
 169                  uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *);
 170 extern BOOL    cleanup_environment(void);
 171 extern void    cutthrough_data_puts(uschar *, int);
 172 extern void    cutthrough_data_put_nl(void);
 173 extern uschar *cutthrough_finaldot(void);
 174 extern BOOL    cutthrough_flush_send(void);
 175 extern BOOL    cutthrough_headers_send(void);
 176 extern BOOL    cutthrough_predata(void);
 177 extern void    release_cutthrough_connection(const uschar *);
 178
 179 extern void    daemon_go(void);
 180
 181 #ifdef EXPERIMENTAL_DCC
 182 extern int     dcc_process(uschar **);
 183 #endif
 184
 185 extern void    debug_logging_activate(uschar *, uschar *);
 186 extern void    debug_logging_stop(void);
 187 extern void    debug_print_argv(const uschar **);
 188 extern void    debug_print_ids(uschar *);
 189 extern void    debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
 190 extern void    debug_print_string(uschar *);
 191 extern void    debug_print_tree(const char *, tree_node *);
 192 extern void    debug_vprintf(int, const char *, va_list);
 193 extern void    debug_print_socket(int);
 194
 195 extern void    decode_bits(unsigned int *, size_t, int *,
 196                    uschar *, bit_table *, int, uschar *, int);
 197 extern void    delete_pid_file(void);
 198 extern void    deliver_local(address_item *, BOOL);
 199 extern address_item *deliver_make_addr(uschar *, BOOL);
 200 extern void    delivery_log(int, address_item *, int, uschar *);
 201 extern int     deliver_message(uschar *, BOOL, BOOL);
 202 extern void    deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
 203 extern void    deliver_set_expansions(address_item *);
 204 extern int     deliver_split_address(address_item *);
 205 extern void    deliver_succeeded(address_item *);
 206
 207 extern uschar *deliver_get_sender_address (uschar *id);
 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 int     spool_write_header(uschar *, int, uschar **);
 518 extern int     stdin_getc(unsigned);
 519 extern int     stdin_feof(void);
 520 extern int     stdin_ferror(void);
 521 extern int     stdin_ungetc(int);
 522
 523 extern void    store_exit(void);
 524 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
 525 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
 526 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
 527 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
 528 extern uschar *string_base62(unsigned long int);
 529 extern gstring *string_cat (gstring *, const uschar *     ) WARN_UNUSED_RESULT;
 530 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
 531 extern int     string_compare_by_pointer(const void *, const void *);
 532 extern uschar *string_copy_dnsdomain(uschar *);
 533 extern uschar *string_copy_malloc(const uschar *);
 534 extern uschar *string_dequote(const uschar **);
 535 extern uschar *string_format_size(int, uschar *);
 536 extern int     string_interpret_escape(const uschar **);
 537 extern int     string_is_ip_address(const uschar *, int *);
 538 #ifdef SUPPORT_I18N
 539 extern BOOL    string_is_utf8(const uschar *);
 540 #endif
 541 extern const uschar *string_printing2(const uschar *, int);
 542 extern uschar *string_split_message(uschar *);
 543 extern uschar *string_unprinting(uschar *);
 544 #ifdef SUPPORT_I18N
 545 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
 546 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
 547 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
 548 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
 549 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
 550 #endif
 551
 552 #define string_format(buf, siz, fmt, ...) \
 553         string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 554 extern BOOL    string_format_trc(uschar *, int, const uschar *, unsigned,
 555                         const char *, ...) ALMOST_PRINTF(5,6);
 556
 557 #define string_vformat(g, flgs, fmt, ap) \
 558         string_vformat_trc(g, US __FUNCTION__, __LINE__, \
 559                          STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
 560 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
 561                         unsigned, unsigned, const char *, va_list);
 562
 563 #define string_open_failed(fmt, ...) \
 564         string_open_failed_trc(US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 565 extern uschar *string_open_failed_trc(const uschar *, unsigned,
 566                         const char *, ...) PRINTF_FUNCTION(3,4);
 567
 568 #define string_nextinlist(lp, sp, b, l) \
 569         string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
 570 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
 571                         const uschar * func, int line);
 572
 573 extern int     strcmpic(const uschar *, const uschar *);
 574 extern int     strncmpic(const uschar *, const uschar *, int);
 575 extern uschar *strstric(uschar *, uschar *, BOOL);
 576
 577 extern int     test_harness_fudged_queue_time(int);
 578 extern void    tcp_init(void);
 579 #ifdef EXIM_TFO_PROBE
 580 extern void    tfo_probe(void);
 581 #endif
 582 extern void    tls_modify_variables(tls_support *);
 583 extern uschar *tod_stamp(int);
 584
 585 extern BOOL    transport_check_waiting(const uschar *, const uschar *, int, uschar *,
 586                  oicf, void*);
 587 extern void    transport_init(void);
 588 extern void    transport_do_pass_socket(const uschar *, const uschar *,
 589                  const uschar *, uschar *, int);
 590 extern BOOL    transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
 591                  int);
 592 extern uschar *transport_rcpt_address(address_item *, BOOL);
 593 extern BOOL    transport_set_up_command(const uschar ***, uschar *,
 594                  BOOL, int, address_item *, uschar *, uschar **);
 595 extern void    transport_update_waiting(host_item *, uschar *);
 596 extern BOOL    transport_write_block(transport_ctx *, uschar *, int, BOOL);
 597 extern void    transport_write_reset(int);
 598 extern BOOL    transport_write_string(int, const char *, ...);
 599 extern BOOL    transport_headers_send(transport_ctx *,
 600                  BOOL (*)(transport_ctx *, uschar *, int));
 601 extern gstring * transport_show_supported(gstring *);
 602 extern BOOL    transport_write_message(transport_ctx *, int);
 603 extern void    tree_add_duplicate(uschar *, address_item *);
 604 extern void    tree_add_nonrecipient(uschar *);
 605 extern void    tree_add_unusable(host_item *);
 606 extern void    tree_dup(tree_node **, tree_node *);
 607 extern int     tree_insertnode(tree_node **, tree_node *);
 608 extern tree_node *tree_search(tree_node *, const uschar *);
 609 extern void    tree_write(tree_node *, FILE *);
 610 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 611
 612 #ifdef WITH_CONTENT_SCAN
 613 extern void    unspool_mbox(void);
 614 #endif
 615 #ifdef SUPPORT_I18N
 616 extern void    utf8_version_report(FILE *);
 617 #endif
 618
 619 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 620                  uschar *, uschar *, BOOL *);
 621 extern int     verify_check_dnsbl(int, const uschar **, uschar **);
 622 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 623                  uschar *, uschar *, int, int *);
 624 extern int     verify_check_headers(uschar **);
 625 extern int     verify_check_header_names_ascii(uschar **);
 626 extern int     verify_check_host(uschar **);
 627 extern int     verify_check_notblind(BOOL);
 628 extern int     verify_check_given_host(const uschar **, const host_item *);
 629 extern int     verify_check_this_host(const uschar **, unsigned int *,
 630                  const uschar*, const uschar *, const uschar **);
 631 extern address_item *verify_checked_sender(uschar *);
 632 extern void    verify_get_ident(int);
 633 extern void    verify_quota(uschar *);
 634 extern int     verify_quota_call(const uschar *, int, int, uschar **);
 635 extern BOOL    verify_sender(int *, uschar **);
 636 extern BOOL    verify_sender_preliminary(int *, uschar **);
 637 extern void    version_init(void);
 638
 639 extern BOOL    write_chunk(transport_ctx *, uschar *, int);
 640 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
 641
 642
 643 /******************************************************************************/
 644 /* Predicate: if an address is in a tainted pool.
 645 By extension, a variable pointing to this address is tainted.
 646 */
 647
 648 static inline BOOL
 649 is_tainted(const void * p)
 650 {
 651 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
 652 return FALSE;
 653
 654 #else
 655 extern BOOL is_tainted_fn(const void *);
 656 return is_tainted_fn(p);
 657 #endif
 658 }
 659
 660 /******************************************************************************/
 661 /* String functions */
 662 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
 663 {
 664 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 665 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
 666 #endif
 667 return US strcat(CS dst, CCS src);
 668 }
 669 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
 670 {
 671 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 672 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
 673 #endif
 674 return US strcpy(CS dst, CCS src);
 675 }
 676 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 677 {
 678 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 679 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
 680 #endif
 681 return US strncat(CS dst, CCS src, n);
 682 }
 683 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 684 {
 685 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 686 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
 687 #endif
 688 return US strncpy(CS dst, CCS src, n);
 689 }
 690 /*XXX will likely need unchecked copy also */
 691
 692
 693 /* Advance the string pointer given over any whitespace.
 694 Return the next char as there's enought places using it to be useful. */
 695
 696 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
 697
 698 static inline uschar skip_whitespace(const uschar ** sp)
 699 { while (isspace(**sp)) (*sp)++; return **sp; }
 700
 701
 702 /******************************************************************************/
 703
 704 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
 705 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
 706 chown(<exim-uid>, <exim-gid>).
 707
 708 Probably because the idmapping is broken, misconfigured or set up in
 709 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
 710 case of misconfiguration, or if there are more such broken systems
 711 out, I try to impose as least impact as possible and for now just write
 712 a panic log entry pointing to the bug report. You're encouraged to
 713 contact the developers, if you experience this issue.
 714
 715 fd     the file descriptor (or -1 if not valid)
 716 name   the file name for error messages or for file operations,
 717   if fd is < 0
 718 owner  the owner
 719 group  the group
 720
 721 returns 0 on success, -1 on failure */
 722
 723 static inline int
 724 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
 725 {
 726 return fchown(fd, owner, group)
 727   ? exim_chown_failure(fd, name, owner, group) : 0;
 728 }
 729
 730 static inline int
 731 exim_chown(const uschar *name, uid_t owner, gid_t group)
 732 {
 733 return chown(CCS name, owner, group)
 734   ? exim_chown_failure(-1, name, owner, group) : 0;
 735 }
 736 #endif  /* !MACRO_PREDEF && !COMPILE_UTILITY */
 737
 738 /******************************************************************************/
 739 /* String functions */
 740
 741 #if !defined(MACRO_PREDEF)
 742 /*************************************************
 743 *            Copy and save string                *
 744 *************************************************/
 745
 746 /* This function assumes that memcpy() is faster than strcpy().
 747 The result is explicitly nul-terminated.
 748 */
 749
 750 static inline uschar *
 751 string_copyn_taint_trc(const uschar * s, unsigned len,
 752         BOOL tainted, const char * func, int line)
 753 {
 754 uschar * ss = store_get_3(len + 1, tainted, func, line);
 755 memcpy(ss, s, len);
 756 ss[len] = '\0';
 757 return ss;
 758 }
 759
 760 static inline uschar *
 761 string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line)
 762 { return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); }
 763
 764 static inline uschar *
 765 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
 766 { return string_copyn_taint_trc(s, len, is_tainted(s), func, line); }
 767 static inline uschar *
 768 string_copy_trc(const uschar * s, const char * func, int line)
 769 { return string_copy_taint_trc(s, is_tainted(s), func, line); }
 770
 771
 772 /* String-copy functions explicitly setting the taint status */
 773
 774 #define string_copyn_taint(s, len, tainted) \
 775         string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__)
 776 #define string_copy_taint(s, tainted) \
 777         string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__)
 778
 779 /* Simple string-copy functions maintaining the taint */
 780
 781 #define string_copyn(s, len) \
 782         string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
 783 #define string_copy(s) \
 784         string_copy_trc((s), __FUNCTION__, __LINE__)
 785
 786
 787 /*************************************************
 788 *       Copy, lowercase and save string          *
 789 *************************************************/
 790
 791 /*
 792 Argument: string to copy
 793 Returns:  copy of string in new store, with letters lowercased
 794 */
 795
 796 static inline uschar *
 797 string_copylc(const uschar *s)
 798 {
 799 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
 800 uschar *p = ss;
 801 while (*s != 0) *p++ = tolower(*s++);
 802 *p = 0;
 803 return ss;
 804 }
 805
 806
 807
 808 /*************************************************
 809 * Copy, lowercase, and save string, given length *
 810 *************************************************/
 811
 812 /* It is assumed the data contains no zeros. A zero is added
 813 onto the end.
 814
 815 Arguments:
 816   s         string to copy
 817   n         number of characters
 818
 819 Returns:    copy of string in new store, with letters lowercased
 820 */
 821
 822 static inline uschar *
 823 string_copynlc(uschar *s, int n)
 824 {
 825 uschar *ss = store_get(n + 1, is_tainted(s));
 826 uschar *p = ss;
 827 while (n-- > 0) *p++ = tolower(*s++);
 828 *p = 0;
 829 return ss;
 830 }
 831
 832
 833 # ifndef COMPILE_UTILITY
 834 /*************************************************
 835 *     Copy and save string in longterm store     *
 836 *************************************************/
 837
 838 /* This function assumes that memcpy() is faster than strcpy().
 839
 840 Argument: string to copy
 841 Returns:  copy of string in new store
 842 */
 843
 844 static inline uschar *
 845 string_copy_perm(const uschar *s, BOOL force_taint)
 846 {
 847 int old_pool = store_pool;
 848 int len = Ustrlen(s) + 1;
 849 uschar *ss;
 850
 851 store_pool = POOL_PERM;
 852 ss = store_get(len, force_taint || is_tainted(s));
 853 memcpy(ss, s, len);
 854 store_pool = old_pool;
 855 return ss;
 856 }
 857 # endif
 858
 859
 860
 861 /* sprintf into a buffer, taint-unchecked */
 862
 863 static inline void
 864 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
 865 {
 866 gstring gs = { .size = siz, .ptr = 0, .s = buf };
 867 va_list ap;
 868 va_start(ap, fmt);
 869 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
 870 va_end(ap);
 871 }
 872
 873
 874
 875 /******************************************************************************/
 876 /* Growable-string functions */
 877
 878 /* Create a growable-string with some preassigned space */
 879
 880 #define string_get_tainted(size, tainted) \
 881         string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
 882
 883 static inline gstring *
 884 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
 885 {
 886 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
 887 g->size = size;
 888 g->ptr = 0;
 889 g->s = US(g + 1);
 890 return g;
 891 }
 892
 893 #define string_get(size) \
 894         string_get_trc((size), __FUNCTION__, __LINE__)
 895
 896 static inline gstring *
 897 string_get_trc(unsigned size, const char * func, unsigned line)
 898 {
 899 return string_get_tainted_trc(size, FALSE, func, line);
 900 }
 901
 902 /* NUL-terminate the C string in the growable-string, and return it. */
 903
 904 static inline uschar *
 905 string_from_gstring(gstring * g)
 906 {
 907 if (!g) return NULL;
 908 g->s[g->ptr] = '\0';
 909 return g->s;
 910 }
 911
 912 static inline unsigned
 913 gstring_length(const gstring * g)
 914 {
 915 return g ? (unsigned)g->ptr : 0;
 916 }
 917
 918
 919 #define gstring_release_unused(g) \
 920         gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
 921
 922 static inline void
 923 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
 924 {
 925 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
 926 }
 927
 928
 929 /* sprintf-append to a growable-string */
 930
 931 #define string_fmt_append(g, fmt, ...) \
 932         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
 933         SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
 934
 935 #define string_fmt_append_f(g, flgs, fmt, ...) \
 936         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
 937         flgs,         fmt, __VA_ARGS__)
 938
 939 static inline gstring *
 940 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
 941   unsigned flags, const char *format, ...)
 942 {
 943 va_list ap;
 944 va_start(ap, format);
 945 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
 946                         flags, format, ap);
 947 va_end(ap);
 948 return g;
 949 }
 950
 951
 952 /* Copy the content of a string to tainted memory */
 953
 954 static inline void
 955 gstring_rebuffer(gstring * g)
 956 {
 957 uschar * s = store_get(g->size, TRUE);
 958 memcpy(s, g->s, g->ptr);
 959 g->s = s;
 960 }
 961
 962
 963 /******************************************************************************/
 964
 965 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
 966
 967 static inline dns_answer *
 968 store_get_dns_answer_trc(const uschar * func, unsigned line)
 969 {
 970 return store_get_3(sizeof(dns_answer), TRUE, CCS func, line);  /* use tainted mem */
 971 }
 972
 973 /******************************************************************************/
 974 /* Routines with knowledge of spool layout */
 975
 976 # ifndef COMPILE_UTILITY
 977 static inline void
 978 spool_pname_buf(uschar * buf, int len)
 979 {
 980 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
 981 }
 982
 983 static inline uschar *
 984 spool_dname(const uschar * purpose, uschar * subdir)
 985 {
 986 return string_sprintf("%s/%s/%s/%s",
 987         spool_directory, queue_name, purpose, subdir);
 988 }
 989 # endif
 990
 991 static inline uschar *
 992 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
 993 {
 994 return string_sprintf("%s%s%s%s%s",
 995                     q, *q ? "/" : "",
 996                     purpose,
 997                     *subdir ? "/" : "", subdir);
 998 }
 999
1000 static inline uschar *
1001 spool_sname(const uschar * purpose, uschar * subdir)
1002 {
1003 return spool_q_sname(purpose, queue_name, subdir);
1004 }
1005
1006 static inline uschar *
1007 spool_q_fname(const uschar * purpose, const uschar * q,
1008         const uschar * subdir, const uschar * fname, const uschar * suffix)
1009 {
1010 return string_sprintf("%s/%s/%s/%s/%s%s",
1011         spool_directory, q, purpose, subdir, fname, suffix);
1012 }
1013
1014 static inline uschar *
1015 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1016         const uschar * suffix)
1017 {
1018 #ifdef COMPILE_UTILITY          /* version avoiding string-extension */
1019 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1020         + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1021 uschar * buf = store_get(len, FALSE);
1022 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1023         spool_directory, queue_name, purpose, subdir, fname, suffix);
1024 return buf;
1025 #else
1026 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1027 #endif
1028 }
1029
1030 static inline void
1031 set_subdir_str(uschar * subdir_str, const uschar * name,
1032         int search_sequence)
1033 {
1034 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1035        ? name[5] : '\0';
1036 subdir_str[1] = '\0';
1037 }
1038
1039 /******************************************************************************/
1040 /* Time calculations */
1041
1042 static inline void
1043 timesince(struct timeval * diff, const struct timeval * then)
1044 {
1045 gettimeofday(diff, NULL);
1046 diff->tv_sec -= then->tv_sec;
1047 if ((diff->tv_usec -= then->tv_usec) < 0)
1048   {
1049   diff->tv_sec--;
1050   diff->tv_usec += 1000*1000;
1051   }
1052 }
1053
1054 static inline uschar *
1055 string_timediff(const struct timeval * diff)
1056 {
1057 static uschar buf[sizeof("0.000s")];
1058
1059 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1060   return readconf_printtime((int)diff->tv_sec);
1061
1062 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1063 return buf;
1064 }
1065
1066
1067 static inline uschar *
1068 string_timesince(const struct timeval * then)
1069 {
1070 struct timeval diff;
1071 timesince(&diff, then);
1072 return string_timediff(&diff);
1073 }
1074
1075 static inline void
1076 report_time_since(const struct timeval * t0, const uschar * where)
1077 {
1078 # ifdef MEASURE_TIMING
1079 struct timeval diff;
1080 timesince(&diff, t0);
1081 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1082        (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1083 # endif
1084 }
1085
1086
1087 static inline void
1088 testharness_pause_ms(int millisec)
1089 {
1090 #ifndef MEASURE_TIMING
1091 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1092 #endif
1093 }
1094
1095 /******************************************************************************/
1096 /* Taint-checked file opens */
1097
1098 static inline int
1099 exim_open2(const char *pathname, int flags)
1100 {
1101 if (!is_tainted(pathname)) return open(pathname, flags);
1102 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1103 errno = EACCES;
1104 return -1;
1105 }
1106 static inline int
1107 exim_open(const char *pathname, int flags, mode_t mode)
1108 {
1109 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1110 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1111 errno = EACCES;
1112 return -1;
1113 }
1114 #ifdef EXIM_HAVE_OPENAT
1115 static inline int
1116 exim_openat(int dirfd, const char *pathname, int flags)
1117 {
1118 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1119 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1120 errno = EACCES;
1121 return -1;
1122 }
1123 static inline int
1124 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1125 {
1126 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1127 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1128 errno = EACCES;
1129 return -1;
1130 }
1131 #endif
1132
1133 static inline FILE *
1134 exim_fopen(const char *pathname, const char *mode)
1135 {
1136 if (!is_tainted(pathname)) return fopen(pathname, mode);
1137 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1138 errno = EACCES;
1139 return NULL;
1140 }
1141
1142 static inline DIR *
1143 exim_opendir(const uschar * name)
1144 {
1145 if (!is_tainted(name)) return opendir(CCS name);
1146 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name);
1147 errno = EACCES;
1148 return NULL;
1149 }
1150
1151 /******************************************************************************/
1152 # if !defined(COMPILE_UTILITY)
1153 /* Process manipulation */
1154
1155 static inline pid_t
1156 exim_fork(const unsigned char * purpose)
1157 {
1158 pid_t pid;
1159 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1160 if ((pid = fork()) == 0)
1161   {
1162   process_purpose = purpose;
1163   DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1164   }
1165 else
1166   {
1167   testharness_pause_ms(100); /* let child work */
1168   DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1169   }
1170 return pid;
1171 }
1172
1173
1174 static inline pid_t
1175 child_open_exim(int * fdptr, const uschar * purpose)
1176 { return child_open_exim_function(fdptr, purpose); }
1177
1178 static inline pid_t
1179 child_open_exim2(int * fdptr, uschar * sender,
1180   uschar * sender_auth, const uschar * purpose)
1181 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1182
1183 static inline pid_t
1184 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1185   int *outfdptr, BOOL make_leader, const uschar * purpose)
1186 { return child_open_function(argv, envp, newumask, infdptr,
1187   outfdptr, make_leader, purpose);
1188 }
1189
1190 # endif /* !COMPILE_UTILITY */
1191
1192 /******************************************************************************/
1193 #endif  /* !MACRO_PREDEF */
1194
1195 #endif  /* _FUNCTIONS_H_ */
1196
1197 /* vi: aw
1198 */
1199 /* End of functions.h */