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