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