src/src/functions.h

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