src/src/functions.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
   6 /* Copyright (c) University of Cambridge 1995 - 2018 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8 /* SPDX-License-Identifier: GPL-2.0-or-later */
   9
  10
  11 /* Prototypes for functions that appear in various modules. Gathered together
  12 to avoid having a lot of tiddly little headers with only a couple of lines in
  13 them. However, some functions that are used (or not used) by utility programs
  14 are in in fact in separate headers. */
  15 #ifndef _FUNCTIONS_H_
  16 #define _FUNCTIONS_H_
  17
  18 #include <ctype.h>
  19 #include <sys/time.h>
  20
  21
  22 #ifdef EXIM_PERL
  23 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
  24                  uschar **) WARN_UNUSED_RESULT;
  25 extern void    cleanup_perl(void);
  26 extern uschar *init_perl(uschar *);
  27 #endif
  28
  29
  30 #ifndef DISABLE_TLS
  31 extern const char *
  32                std_dh_prime_default(void);
  33 extern const char *
  34                std_dh_prime_named(const uschar *);
  35
  36 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
  37 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
  38 extern uschar * tls_cert_issuer(void *, uschar * mod);
  39 extern uschar * tls_cert_not_before(void *, uschar * mod);
  40 extern uschar * tls_cert_not_after(void *, uschar * mod);
  41 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
  42 extern uschar * tls_cert_serial_number(void *, uschar * mod);
  43 extern uschar * tls_cert_signature(void *, uschar * mod);
  44 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
  45 extern uschar * tls_cert_subject(void *, uschar * mod);
  46 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
  47 extern uschar * tls_cert_version(void *, uschar * mod);
  48
  49 extern uschar * tls_cert_der_b64(void * cert);
  50 extern uschar * tls_cert_fprt_md5(void *);
  51 extern uschar * tls_cert_fprt_sha1(void *);
  52 extern uschar * tls_cert_fprt_sha256(void *);
  53
  54 extern void    tls_clean_env(void);
  55 extern BOOL    tls_client_start(client_conn_ctx *, smtp_connect_args *,
  56                   void *, tls_support *, uschar **);
  57 extern BOOL    tls_client_adjunct_start(host_item *, client_conn_ctx *,
  58                   const uschar *, uschar **);
  59 extern void    tls_client_creds_reload(BOOL);
  60
  61 extern void    tls_close(void *, int);
  62 extern BOOL    tls_could_getc(void);
  63 extern void    tls_daemon_init(void);
  64 extern int     tls_daemon_tick(void);
  65 extern BOOL    tls_dropprivs_validate_require_cipher(BOOL);
  66 extern BOOL    tls_export_cert(uschar *, size_t, void *);
  67 extern int     tls_feof(void);
  68 extern int     tls_ferror(void);
  69 extern uschar *tls_field_from_dn(uschar *, const uschar *);
  70 extern void    tls_free_cert(void **);
  71 extern int     tls_getc(unsigned);
  72 extern uschar *tls_getbuf(unsigned *);
  73 extern void    tls_get_cache(unsigned);
  74 extern BOOL    tls_hasc(void);
  75 extern BOOL    tls_import_cert(const uschar *, void **);
  76 extern BOOL    tls_is_name_for_cert(const uschar *, void *);
  77 # ifdef USE_OPENSSL
  78 extern BOOL    tls_openssl_options_parse(uschar *, long *);
  79 # endif
  80 extern int     tls_read(void *, uschar *, size_t);
  81 extern int     tls_server_start(uschar **);
  82 extern void    tls_shutdown_wr(void *);
  83 extern BOOL    tls_smtp_buffered(void);
  84 extern int     tls_ungetc(int);
  85 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
  86 extern void    tls_watch_discard_event(int);
  87 extern void    tls_watch_invalidate(void);
  88 #endif
  89 extern int     tls_write(void *, const uschar *, size_t, BOOL);
  90 extern uschar *tls_validate_require_cipher(void);
  91 extern gstring *tls_version_report(gstring *);
  92
  93 # ifdef SUPPORT_DANE
  94 extern int     tlsa_lookup(const host_item *, dns_answer *, BOOL);
  95 # endif
  96
  97 #endif  /*DISABLE_TLS*/
  98
  99
 100 /* Everything else... */
 101
 102 extern acl_block *acl_read(uschar *(*)(void), uschar **);
 103 extern int     acl_check(int, const uschar *, uschar *, uschar **, uschar **);
 104 extern uschar *acl_current_verb(void);
 105 extern int     acl_eval(int, uschar *, uschar **, uschar **);
 106 extern uschar *acl_standalone_setvar(const uschar *, BOOL);
 107
 108 extern tree_node *acl_var_create(uschar *);
 109 extern void    acl_var_write(uschar *, uschar *, void *);
 110 extern void    add_driver_info(driver_info **, const driver_info *, size_t);
 111
 112
 113 #ifdef EXPERIMENTAL_ARC
 114 # ifdef SUPPORT_DMARC
 115 extern gstring *arc_dmarc_hist_append(gstring *);
 116 # endif
 117 extern void   *arc_ams_setup_sign_bodyhash(void);
 118 extern const uschar *arc_header_feed(gstring *, BOOL);
 119 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
 120 extern void     arc_sign_init(void);
 121 extern const uschar *acl_verify_arc(void);
 122 extern uschar * fn_arc_domains(void);
 123 #endif
 124
 125 extern void    assert_no_variables(void *, int, const char *, int);
 126 extern int     auth_call_pam(const uschar *, uschar **);
 127 extern int     auth_call_pwcheck(uschar *, uschar **);
 128 extern int     auth_call_radius(const uschar *, uschar **);
 129 extern int     auth_call_saslauthd(const uschar *, const uschar *,
 130                  const uschar *, const uschar *, uschar **);
 131 extern int     auth_check_serv_cond(auth_instance *);
 132 extern int     auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
 133 extern int     auth_client_item(void *, auth_instance *, const uschar **,
 134                  unsigned, int, uschar *, int);
 135
 136
 137 extern int     auth_get_data(uschar **, const uschar *, int);
 138 extern int     auth_get_no64_data(uschar **, uschar *);
 139 extern int     auth_prompt(const uschar *);
 140 extern int     auth_read_input(const uschar *);
 141 extern gstring * auth_show_supported(gstring *);
 142 extern uschar *authenticator_current_name(void);
 143
 144 #ifdef EXPERIMENTAL_ARC
 145 extern gstring *authres_arc(gstring *);
 146 #endif
 147 #ifndef DISABLE_DKIM
 148 extern gstring *authres_dkim(gstring *);
 149 #endif
 150 extern gstring *authres_smtpauth(gstring *);
 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 **, const void *);
 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(const uschar *, BOOL);
 214 extern void    delivery_log(int, address_item *, int, uschar *);
 215 extern int     deliver_message(const 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(const uschar *, const uschar *, const 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 *,
 263   const uschar *, const uschar *, unsigned, uschar *, BOOL bvalue,
 264   const uschar *, BOOL *);
 265 extern BOOL    expand_check_condition(const uschar *, const uschar *, const 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, const 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, const 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 const uschar *local_part_quote(const uschar *);
 333 extern int     log_open_as_exim(const uschar * const);
 334 extern void    log_close_all(void);
 335 extern const lookup_info * lookup_with_acq_num(unsigned);
 336 #ifdef LOOKUP_MODULE_DIR
 337 extern BOOL    lookup_one_mod_load(const uschar *, uschar **);
 338 #endif
 339
 340
 341 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
 342 extern BOOL    macro_read_assignment(uschar *);
 343 extern uschar *macros_expand(int, int *, BOOL *);
 344 extern void    mainlog_close(void);
 345 #ifdef WITH_CONTENT_SCAN
 346 extern int     malware(const uschar *, BOOL, int);
 347 extern int     malware_in_file(const uschar *);
 348 extern void    malware_init(void);
 349 extern gstring * malware_show_supported(gstring *);
 350 #endif
 351 extern int     match_address_list(const uschar *, BOOL, BOOL, const uschar **,
 352                  unsigned int *, int, int, const uschar **);
 353 extern int     match_address_list_basic(const uschar *, const uschar **, int);
 354 extern int     match_check_list(const uschar **, int, tree_node **, unsigned int **,
 355                  int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
 356                  const uschar *, const uschar **);
 357 extern int     match_isinlist(const uschar *, const uschar **, int, tree_node **,
 358                  unsigned int *, int, BOOL, const uschar **);
 359 extern int     match_check_string(const uschar *, const uschar *, int, mcs_flags,
 360                  const uschar **);
 361
 362 extern void    message_start(void);
 363 extern void    message_tidyup(void);
 364 extern void    md5_end(md5 *, const uschar *, int, uschar *);
 365 extern void    md5_mid(md5 *, const uschar *);
 366 extern void    md5_start(md5 *);
 367 extern void    millisleep(int);
 368 #ifdef WITH_CONTENT_SCAN
 369 struct mime_boundary_context;
 370 extern int     mime_acl_check(uschar *acl, FILE *f,
 371                  struct mime_boundary_context *, uschar **, uschar **);
 372 extern int     mime_decode(const uschar **);
 373 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
 374 extern int     mime_regex(const uschar **, BOOL);
 375 extern void    mime_set_anomaly(int);
 376 #endif
 377
 378 extern int     misc_mod_conn_init(const uschar *, const uschar *);
 379 extern misc_module_info * misc_mod_find(const uschar * modname, uschar **);
 380 extern misc_module_info * misc_mod_findonly(const uschar * modname);
 381 extern int     misc_mod_msg_init(void);
 382 extern void    misc_mod_smtp_reset(void);
 383
 384 extern uschar *moan_check_errorcopy(const uschar *);
 385 extern BOOL    moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
 386                  BOOL, uschar *);
 387 extern void    moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
 388 extern BOOL    moan_send_message(const uschar *, int, error_block *eblock,
 389                  header_line *, FILE *, uschar *);
 390 extern void    moan_tell_someone(uschar *, address_item *,
 391                  const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
 392 extern BOOL    moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
 393 extern void    moan_write_from(FILE *);
 394 extern void    moan_write_references(FILE *, uschar *);
 395 #ifdef LOOKUP_MODULE_DIR
 396 //extern void    mod_load_check(const uschar *);
 397 #endif
 398 extern FILE   *modefopen(const uschar *, const char *, mode_t);
 399
 400 extern int     open_cutthrough_connection( address_item * addr );
 401
 402 extern uschar *parse_extract_address(const uschar *, uschar **, int *, int *, int *,
 403                  BOOL);
 404 extern int     parse_forward_list(const uschar *, int, address_item **, uschar **,
 405                  const uschar *, const uschar *, error_block **);
 406 extern uschar *parse_find_address_end(const uschar *, BOOL);
 407 extern const uschar *parse_find_at(const uschar *);
 408 extern const uschar *parse_fix_phrase(const uschar *, int);
 409 extern const uschar *parse_message_id(const uschar *, uschar **, uschar **);
 410 extern const uschar *parse_quote_2047(const uschar *, int, const uschar *,
 411                                       BOOL);
 412 extern const uschar *parse_date_time(const uschar *str, time_t *t);
 413 extern void priv_drop_temp(const uid_t, const gid_t);
 414 extern void priv_restore(void);
 415 #ifdef SUPPORT_PROXY
 416 extern BOOL     proxy_protocol_host(void);
 417 extern void     proxy_protocol_setup(void);
 418 #endif
 419
 420 extern BOOL    queue_action(const uschar *, int, const uschar **, int, int);
 421 extern void    queue_check_only(void);
 422 extern unsigned queue_count(void);
 423 extern unsigned queue_count_cached(void);
 424 extern void    queue_list(int, const uschar **, int);
 425 #ifndef DISABLE_QUEUE_RAMP
 426 extern void    queue_notify_daemon(const uschar * hostname);
 427 #endif
 428 extern void    queue_run(qrunner *, const uschar *, const uschar *, BOOL);
 429
 430 extern int     random_number(int);
 431 extern const uschar *rc_to_string(int);
 432 extern int     rda_interpret(redirect_block *, int, const uschar *,
 433                 const sieve_block *, const ugid_block *, address_item **,
 434                 uschar **, error_block **, int *, const uschar *);
 435 extern int     rda_is_filter(const uschar *);
 436 extern BOOL    readconf_depends(driver_instance *, uschar *);
 437 extern void    readconf_driver_init(driver_instance **, driver_info **, int,
 438                 void *, int, optionlist *, int, const uschar *);
 439 extern const uschar *readconf_find_option(void *);
 440 extern void    readconf_main(BOOL);
 441 extern void    readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
 442 extern BOOL    readconf_print(const uschar *, const uschar *, BOOL);
 443 extern uschar *readconf_printtime(int);
 444 extern const uschar *readconf_readname(uschar *, int, const uschar *);
 445 extern int     readconf_readtime(const uschar *, int, BOOL);
 446 extern void    readconf_rest(void);
 447 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
 448 extern void    readconf_save_config(const uschar *);
 449 extern void    read_message_body(BOOL);
 450 extern void    receive_bomb_out(uschar *, uschar *) NORETURN;
 451 extern BOOL    receive_check_fs(int);
 452 extern BOOL    receive_check_set_sender(const uschar *);
 453 extern BOOL    receive_msg(BOOL);
 454 extern int_eximarith_t receive_statvfs(BOOL, int *);
 455 extern void    receive_swallow_smtp(void);
 456 extern int     recv_fd_from_sock(int);
 457 #ifdef WITH_CONTENT_SCAN
 458 extern int     regex(const uschar **, BOOL);
 459 extern void    regex_vars_clear(void);
 460 #endif
 461 extern void    regex_at_daemon(const uschar *);
 462 extern BOOL    regex_match(const pcre2_code *, const uschar *, int, uschar **);
 463 extern BOOL    regex_match_and_setup(const pcre2_code *, const uschar *, int, int);
 464 extern const pcre2_code *regex_compile(const uschar *, mcs_flags, uschar **,
 465                 pcre2_compile_context *);
 466 extern const pcre2_code *regex_must_compile(const uschar *, mcs_flags, BOOL);
 467
 468 extern void    retry_add_item(address_item *, const uschar *, int);
 469 extern BOOL    retry_check_address(const uschar *, host_item *, uschar *, BOOL,
 470                  const uschar **, const uschar **);
 471 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
 472 extern const uschar *retry_host_key_build(const host_item *, BOOL,
 473                   const uschar *);
 474 extern BOOL    retry_ultimate_address_timeout(const uschar *, const uschar *,
 475                  dbdata_retry *, time_t);
 476 extern void    retry_update(address_item **, address_item **, address_item **);
 477 extern const uschar *rewrite_address(const uschar *, BOOL, BOOL, rewrite_rule *, int);
 478 extern const uschar *rewrite_address_qualify(const uschar *, BOOL);
 479 extern header_line *rewrite_header(header_line *,
 480                const uschar *, const uschar *,
 481                rewrite_rule *, int, BOOL);
 482 extern const uschar *rewrite_one(const uschar *, int, BOOL *, BOOL, uschar *,
 483                  rewrite_rule *);
 484 extern void    rewrite_test(const uschar *);
 485 extern uschar *rfc2047_decode2(uschar *, BOOL, const uschar *, int, int *,
 486                                      int *, uschar **);
 487 extern int     route_address(address_item *, address_item **, address_item **,
 488                  address_item **, address_item **, int);
 489 extern int     route_check_prefix(const uschar *, const uschar *, unsigned *);
 490 extern int     route_check_suffix(const uschar *, const uschar *, unsigned *);
 491 extern BOOL    route_findgroup(uschar *, gid_t *);
 492 extern BOOL    route_finduser(const uschar *, struct passwd **, uid_t *);
 493 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 494                  uschar **);
 495 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 496                  struct passwd **, uid_t *, uschar **);
 497 extern void    route_init(void);
 498 extern gstring * route_show_supported(gstring *);
 499 extern void    route_tidyup(void);
 500 extern uschar *router_current_name(void);
 501
 502 extern uschar *search_args(const lookup_info *, uschar *, uschar *, uschar **,
 503                 const uschar *);
 504 extern uschar *search_find(void *, const uschar *, const uschar *, int,
 505                  const uschar *, int, int, int *, const uschar *);
 506 extern const lookup_info * search_findtype(const uschar *, int);
 507 extern const lookup_info * search_findtype_partial(const uschar *, int *,
 508                 const uschar **, int *, int *, const uschar **);
 509 extern void   *search_open(const uschar *, const lookup_info *, int,
 510                 uid_t *, gid_t *);
 511 extern void    search_tidyup(void);
 512 extern BOOL    send_fd_over_socket(int, int);
 513 extern uschar *sender_helo_verified_boolstr(void);
 514 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
 515 extern void    sha1_end(hctx *, const uschar *, int, uschar *);
 516 extern void    sha1_mid(hctx *, const uschar *);
 517 extern void    sha1_start(hctx *);
 518 extern int     sieve_interpret(const uschar *, int, const sieve_block *,
 519                  address_item **, uschar **);
 520 extern void    sigalrm_handler(int);
 521 extern void    single_queue_run(qrunner *, const uschar *, const uschar *);
 522 extern int     smtp_boundsock(smtp_connect_args *);
 523 extern void    smtp_closedown(uschar *);
 524 extern void    smtp_command_timeout_exit(void) NORETURN;
 525 extern void    smtp_command_sigterm_exit(void) NORETURN;
 526 extern void    smtp_data_timeout_exit(void) NORETURN;
 527 extern void    smtp_data_sigint_exit(void) NORETURN;
 528 extern void    smtp_deliver_init(void);
 529 extern uschar *smtp_cmd_hist(void);
 530 extern int     smtp_connect(smtp_connect_args *, const blob *);
 531 extern int     smtp_feof(void);
 532 extern int     smtp_ferror(void);
 533 extern uschar *smtp_get_connection_info(void);
 534 extern BOOL    smtp_get_interface(uschar *, int, address_item *,
 535                  uschar **, uschar *);
 536 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 537 extern int     smtp_getc(unsigned);
 538 extern uschar *smtp_getbuf(unsigned *);
 539 extern void    smtp_get_cache(unsigned);
 540 extern BOOL    smtp_hasc(void);
 541 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 542 extern void    smtp_log_no_mail(void);
 543 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
 544 extern void    smtp_proxy_tls(void *, uschar *, size_t, int *, int, const uschar *) NORETURN;
 545 extern BOOL    smtp_read_response(void *, uschar *, int, int, int);
 546 extern void   *smtp_reset(void *);
 547 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 548 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
 549 extern void    smtp_port_for_connect(host_item *, int);
 550 extern void    smtp_send_prohibition_message(int, uschar *);
 551 extern int     smtp_setup_msg(void);
 552 extern int     smtp_sock_connect(smtp_connect_args *, int, const blob *);
 553 extern BOOL    smtp_start_session(void);
 554 extern int     smtp_ungetc(int);
 555 extern BOOL    smtp_verify_helo(void);
 556 extern int     smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
 557 #ifdef WITH_CONTENT_SCAN
 558 extern int     spam(const uschar **);
 559 extern FILE   *spool_mbox(unsigned long *, const uschar *, uschar **);
 560 #endif
 561 extern void    spool_clear_header_globals(void);
 562 extern BOOL    spool_move_message(const uschar *, const uschar *, const uschar *, const uschar *);
 563 extern int     spool_open_datafile(const uschar *);
 564 extern int     spool_open_temp(uschar *);
 565 extern int     spool_read_header(uschar *, BOOL, BOOL);
 566 extern uschar *spool_sender_from_msgid(const uschar *);
 567 extern int     spool_write_header(const uschar *, int, uschar **);
 568 extern int     stdin_getc(unsigned);
 569 extern int     stdin_feof(void);
 570 extern int     stdin_ferror(void);
 571 extern BOOL    stdin_hasc(void);
 572 extern int     stdin_ungetc(int);
 573
 574 extern void    stackdump(void);
 575 extern void    store_exit(void);
 576 extern void    store_init(void);
 577 extern void    store_writeprotect(int);
 578
 579 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
 580 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
 581 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
 582 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
 583 extern uschar *string_base62_32(unsigned long int);
 584 extern uschar *string_base62_64(unsigned long int);
 585 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
 586 extern int     string_compare_by_pointer(const void *, const void *);
 587 extern uschar *string_copy_dnsdomain(uschar *);
 588 extern uschar *string_copy_malloc(const uschar *);
 589 extern uschar *string_dequote(const uschar **);
 590 extern uschar *string_format_size(int, uschar *);
 591 extern int     string_interpret_escape(const uschar **);
 592 extern int     string_is_ip_address(const uschar *, int *);
 593 extern int     string_is_ip_addressX(const uschar *, int *, const uschar **);
 594 #ifdef SUPPORT_I18N
 595 extern BOOL    string_is_utf8(const uschar *);
 596 #endif
 597 extern const uschar *string_printing2(const uschar *, int);
 598 extern uschar *string_split_message(uschar *);
 599 extern uschar *string_unprinting(uschar *);
 600 #ifdef SUPPORT_I18N
 601 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
 602 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
 603 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
 604 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
 605 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
 606 #endif
 607
 608 #define string_format(buf, siz, fmt, ...) \
 609         string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 610 extern BOOL    string_format_trc(uschar *, int, const uschar *, unsigned,
 611                         const char *, ...) ALMOST_PRINTF(5,6);
 612
 613 #define string_vformat(g, flgs, fmt, ap) \
 614         string_vformat_trc(g, US __FUNCTION__, __LINE__, \
 615                          STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
 616 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
 617                         unsigned, unsigned, const char *, va_list);
 618
 619 #define string_open_failed(fmt, ...) \
 620         string_open_failed_trc(US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 621 extern uschar *string_open_failed_trc(const uschar *, unsigned,
 622                         const char *, ...) PRINTF_FUNCTION(3,4);
 623
 624 #define string_nextinlist(lp, sp, b, l) \
 625         string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
 626 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
 627                         const uschar * func, int line);
 628
 629 extern int     strcmpic(const uschar *, const uschar *);
 630 extern int     strncmpic(const uschar *, const uschar *, int);
 631 extern uschar *strstric(uschar *, uschar *, BOOL);
 632 extern const uschar *strstric_c(const uschar *, const uschar *, BOOL);
 633
 634 extern int     test_harness_fudged_queue_time(int);
 635 extern void    tcp_init(void);
 636 #ifdef EXIM_TFO_PROBE
 637 extern void    tfo_probe(void);
 638 #endif
 639 extern void    tls_modify_variables(tls_support *);
 640 extern uschar *tod_stamp(int);
 641
 642 extern BOOL    transport_check_waiting(const uschar *, const uschar *, int, uschar *,
 643                  oicf, void*);
 644 extern uschar *transport_current_name(void);
 645 extern void    transport_do_pass_socket(const uschar *, const uschar *,
 646                  const uschar *, uschar *, int);
 647 extern void    transport_init(void);
 648 extern const uschar *transport_rcpt_address(address_item *, BOOL);
 649 extern BOOL    transport_set_up_command(const uschar ***, const uschar *,
 650                  unsigned, int, address_item *, const uschar *, uschar **);
 651 extern void    transport_update_waiting(host_item *, const uschar *);
 652 extern BOOL    transport_write_block(transport_ctx *, uschar *, int, BOOL);
 653 extern void    transport_write_reset(int);
 654 extern BOOL    transport_write_string(int, const char *, ...);
 655 extern BOOL    transport_headers_send(transport_ctx *,
 656                  BOOL (*)(transport_ctx *, const uschar *, int));
 657 extern gstring * transport_show_supported(gstring *);
 658 extern BOOL    transport_write_message(transport_ctx *, int);
 659 extern void    tree_add_duplicate(const uschar *, address_item *);
 660 extern void    tree_add_nonrecipient(const uschar *);
 661 extern void    tree_add_unusable(const host_item *);
 662 extern void    tree_dup(tree_node **, tree_node *);
 663 extern int     tree_insertnode(tree_node **, tree_node *);
 664 extern tree_node *tree_search(tree_node *, const uschar *);
 665 extern void    tree_write(tree_node *, FILE *);
 666 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 667
 668 #ifdef WITH_CONTENT_SCAN
 669 extern void    unspool_mbox(void);
 670 #endif
 671 #ifdef SUPPORT_I18N
 672 extern gstring *utf8_version_report(gstring *);
 673 #endif
 674
 675 extern int     vaguely_random_number(int);
 676 #ifndef DISABLE_TLS
 677 extern int     vaguely_random_number_fallback(int);
 678 #endif
 679 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 680                  uschar *, uschar *, BOOL *);
 681 extern int     verify_check_dnsbl(int, const uschar **, uschar **);
 682 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 683                  uschar *, uschar *, int, int *);
 684 extern int     verify_check_headers(uschar **);
 685 extern int     verify_check_header_names_ascii(uschar **);
 686 extern int     verify_check_host(uschar **);
 687 extern int     verify_check_notblind(BOOL);
 688 extern int     verify_check_given_host(const uschar **, const host_item *);
 689 extern int     verify_check_this_host(const uschar **, unsigned int *,
 690                  const uschar*, const uschar *, const uschar **);
 691 extern address_item *verify_checked_sender(const uschar *);
 692 extern void    verify_get_ident(int);
 693 extern void    verify_quota(uschar *);
 694 extern int     verify_quota_call(const uschar *, int, int, uschar **);
 695 extern BOOL    verify_sender(int *, uschar **);
 696 extern BOOL    verify_sender_preliminary(int *, uschar **);
 697 extern void    version_init(void);
 698
 699 extern BOOL    write_chunk(transport_ctx *, const uschar *, int);
 700 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
 701 extern uschar *wrap_header(const uschar *, unsigned, unsigned, const uschar *, unsigned);
 702
 703 #ifdef EXPERIMENTAL_XCLIENT
 704 extern uschar * xclient_smtp_command(uschar *, int *, BOOL *);
 705 extern gstring * xclient_smtp_advertise_str(gstring *);
 706 #endif
 707 extern uschar *xtextencode(uschar *, int);
 708 extern int     xtextdecode(uschar *, uschar **);
 709
 710
 711 /******************************************************************************/
 712 /* Predicate: if an address is in a tainted pool.
 713 By extension, a variable pointing to this address is tainted.
 714 */
 715
 716 static inline BOOL
 717 is_tainted(const void * p)
 718 {
 719 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
 720 return FALSE;
 721
 722 #else
 723 extern BOOL is_tainted_fn(const void *);
 724 return is_tainted_fn(p);
 725 #endif
 726 }
 727
 728 static inline BOOL
 729 is_incompatible(const void * old, const void * new)
 730 {
 731 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
 732 return FALSE;
 733
 734 #else
 735 extern BOOL is_incompatible_fn(const void *, const void *);
 736 return is_incompatible_fn(old, new);
 737 #endif
 738 }
 739
 740 /******************************************************************************/
 741 /* String functions */
 742 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
 743 {
 744 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 745 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
 746 #endif
 747 return US strcat(CS dst, CCS src);
 748 }
 749 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
 750 {
 751 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 752 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
 753 #endif
 754 return US strcpy(CS dst, CCS src);
 755 }
 756 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 757 {
 758 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 759 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
 760 #endif
 761 return US strncat(CS dst, CCS src, n);
 762 }
 763 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 764 {
 765 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 766 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
 767 #endif
 768 return US strncpy(CS dst, CCS src, n);
 769 }
 770 /*XXX will likely need unchecked copy also */
 771
 772
 773 /* Advance the string pointer given over any whitespace.
 774 Return the next char as there's enough places using it to be useful. */
 775
 776 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
 777
 778 static inline uschar skip_whitespace(const uschar ** sp)
 779 { while (isspace(**sp)) (*sp)++; return **sp; }
 780
 781 /* Ditto, non-whitespace */
 782
 783 #define Uskip_nonwhite(sp) skip_nonwhite(CUSS sp)
 784 static inline uschar skip_nonwhite(const uschar ** sp)
 785 { while (**sp && !isspace(**sp)) (*sp)++; return **sp; }
 786
 787
 788 /******************************************************************************/
 789
 790 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
 791 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
 792 chown(<exim-uid>, <exim-gid>).
 793
 794 Probably because the idmapping is broken, misconfigured or set up in
 795 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
 796 case of misconfiguration, or if there are more such broken systems
 797 out, I try to impose as least impact as possible and for now just write
 798 a panic log entry pointing to the bug report. You're encouraged to
 799 contact the developers, if you experience this issue.
 800
 801 fd     the file descriptor (or -1 if not valid)
 802 name   the file name for error messages or for file operations,
 803   if fd is < 0
 804 owner  the owner
 805 group  the group
 806
 807 returns 0 on success, -1 on failure */
 808
 809 static inline int
 810 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
 811 {
 812 return fchown(fd, owner, group)
 813   ? exim_chown_failure(fd, name, owner, group) : 0;
 814 }
 815
 816 static inline int
 817 exim_chown(const uschar *name, uid_t owner, gid_t group)
 818 {
 819 return chown(CCS name, owner, group)
 820   ? exim_chown_failure(-1, name, owner, group) : 0;
 821 }
 822 #endif  /* !MACRO_PREDEF && !COMPILE_UTILITY */
 823
 824 /******************************************************************************/
 825 /* String functions */
 826
 827 #if !defined(MACRO_PREDEF)
 828 /*************************************************
 829 *            Copy and save string                *
 830 *************************************************/
 831
 832 /* This function assumes that memcpy() is faster than strcpy().
 833 The result is explicitly nul-terminated.
 834 */
 835
 836 static inline uschar *
 837 string_copyn_taint_trc(const uschar * s, unsigned len,
 838         const void * proto_mem, const char * func, int line)
 839 {
 840 uschar * ss;
 841 unsigned slen = Ustrlen(s);
 842 if (len > slen) len = slen;
 843 ss = store_get_3(len + 1, proto_mem, func, line);
 844 memcpy(ss, s, len);
 845 ss[len] = '\0';
 846 return ss;
 847 }
 848
 849 static inline uschar *
 850 string_copy_taint_trc(const uschar * s, const void * proto_mem, const char * func, int line)
 851 { return string_copyn_taint_trc(s, Ustrlen(s), proto_mem, func, line); }
 852
 853 static inline uschar *
 854 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
 855 { return string_copyn_taint_trc(s, len, s, func, line); }
 856 static inline uschar *
 857 string_copy_trc(const uschar * s, const char * func, int line)
 858 { return string_copy_taint_trc(s, s, func, line); }
 859
 860
 861 /* String-copy functions explicitly setting the taint status */
 862
 863 #define string_copyn_taint(s, len, proto_mem) \
 864         string_copyn_taint_trc((s), (len), (proto_mem), __FUNCTION__, __LINE__)
 865 #define string_copy_taint(s, proto_mem) \
 866         string_copy_taint_trc((s), (proto_mem), __FUNCTION__, __LINE__)
 867
 868 /* Simple string-copy functions maintaining the taint */
 869
 870 #define string_copyn(s, len) \
 871         string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
 872 #define string_copy(s) \
 873         string_copy_trc((s), __FUNCTION__, __LINE__)
 874
 875
 876 /*************************************************
 877 *       Copy, lowercase and save string          *
 878 *************************************************/
 879
 880 /*
 881 Argument: string to copy
 882 Returns:  copy of string in new store, with letters lowercased
 883 */
 884
 885 static inline uschar *
 886 string_copylc(const uschar * s)
 887 {
 888 uschar * ss = store_get(Ustrlen(s) + 1, s);
 889 uschar * p = ss;
 890 while (*s) *p++ = tolower(*s++);
 891 *p = 0;
 892 return ss;
 893 }
 894
 895
 896
 897 /*************************************************
 898 * Copy, lowercase, and save string, given length *
 899 *************************************************/
 900
 901 /* It is assumed the data contains no zeros. A zero is added
 902 onto the end.
 903
 904 Arguments:
 905   s         string to copy
 906   n         number of characters
 907
 908 Returns:    copy of string in new store, with letters lowercased
 909 */
 910
 911 static inline uschar *
 912 string_copynlc(uschar * s, int n)
 913 {
 914 uschar * ss = store_get(n + 1, s);
 915 uschar * p = ss;
 916 while (n-- > 0) *p++ = tolower(*s++);
 917 *p = 0;
 918 return ss;
 919 }
 920
 921
 922 # ifndef COMPILE_UTILITY
 923 /*************************************************
 924 *     Copy and save string in longterm store     *
 925 *************************************************/
 926
 927 /* This function assumes that memcpy() is faster than strcpy().
 928
 929 Argument: string to copy
 930 Returns:  copy of string in new store
 931 */
 932
 933 static inline uschar *
 934 string_copy_perm(const uschar *s, BOOL force_taint)
 935 {
 936 int old_pool = store_pool;
 937 int len = Ustrlen(s) + 1;
 938 uschar *ss;
 939
 940 store_pool = POOL_PERM;
 941 ss = store_get(len, force_taint ? GET_TAINTED : s);
 942 memcpy(ss, s, len);
 943 store_pool = old_pool;
 944 return ss;
 945 }
 946 # endif
 947
 948
 949
 950 /* sprintf into a buffer, taint-unchecked */
 951
 952 static inline void
 953 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
 954 {
 955 gstring gs = { .size = siz, .ptr = 0, .s = buf };
 956 va_list ap;
 957 va_start(ap, fmt);
 958 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
 959 va_end(ap);
 960 }
 961
 962
 963
 964 /******************************************************************************/
 965 /* Growable-string functions */
 966
 967 /* Create a growable-string with some preassigned space */
 968
 969 #define string_get_tainted(size, proto_mem) \
 970         string_get_tainted_trc((size), (proto_mem), __FUNCTION__, __LINE__)
 971
 972 static inline gstring *
 973 string_get_tainted_trc(unsigned size, const void * proto_mem, const char * func, unsigned line)
 974 {
 975 gstring * g = store_get_3(sizeof(gstring) + size, proto_mem, func, line);
 976 g->size = size;         /*XXX would be good if we could see the actual alloc size */
 977 g->ptr = 0;
 978 g->s = US(g + 1);
 979 return g;
 980 }
 981
 982 #define string_get(size) \
 983         string_get_trc((size), __FUNCTION__, __LINE__)
 984
 985 static inline gstring *
 986 string_get_trc(unsigned size, const char * func, unsigned line)
 987 {
 988 return string_get_tainted_trc(size, GET_UNTAINTED, func, line);
 989 }
 990
 991 /* NUL-terminate the C string in the growable-string, and return it. */
 992
 993 static inline uschar *
 994 string_from_gstring(gstring * g)
 995 {
 996 if (!g) return NULL;
 997 g->s[g->ptr] = '\0';
 998 return g->s;
 999 }
1000
1001 static inline int
1002 len_string_from_gstring(gstring * g, uschar ** sp)
1003 {
1004 if (g)
1005   {
1006   *sp = g->s;
1007   g->s[g->ptr] = '\0';
1008   return g->ptr;
1009   }
1010 else
1011   {
1012   *sp = NULL;
1013   return 0;
1014   }
1015 }
1016
1017 static inline uschar *
1018 string_copy_from_gstring(gstring * g)
1019 {
1020 return g ? string_copyn(g->s, g->ptr) : NULL;
1021 }
1022
1023 static inline unsigned
1024 gstring_length(const gstring * g)
1025 {
1026 return g ? (unsigned)g->ptr : 0;
1027 }
1028
1029 static inline uschar
1030 gstring_last_char(gstring * g)
1031 {
1032 return g->s[g->ptr-1];
1033 }
1034
1035 static inline void
1036 gstring_trim(gstring * g, unsigned amount)
1037 {
1038 g->ptr -= amount;
1039 }
1040
1041 static inline void
1042 gstring_trim_trailing(gstring * g, uschar c)
1043 {
1044 if (gstring_last_char(g) == c) gstring_trim(g, 1);
1045 }
1046
1047 static inline void
1048 gstring_reset(gstring * g)
1049 {
1050 g->ptr = 0;
1051 }
1052
1053
1054 #define gstring_release_unused(g) \
1055         gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
1056
1057 static inline void
1058 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
1059 {
1060 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
1061 }
1062
1063
1064 /* plain string append to a growable-string */
1065
1066 static inline gstring * string_cat(gstring * g, const uschar * s)
1067  WARN_UNUSED_RESULT;
1068
1069 static inline gstring *
1070 string_cat(gstring * g, const uschar * s)
1071 {
1072 return string_catn(g, s, Ustrlen(s));
1073 }
1074
1075
1076 /* sprintf-append to a growable-string */
1077
1078 #define string_fmt_append(g, fmt, ...) \
1079         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
1080         SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
1081
1082 #define string_fmt_append_f(g, flgs, fmt, ...) \
1083         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
1084         flgs,         fmt, __VA_ARGS__)
1085
1086 static inline gstring *
1087 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
1088   unsigned flags, const char *format, ...)
1089 {
1090 va_list ap;
1091 va_start(ap, format);
1092 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
1093                         flags, format, ap);
1094 va_end(ap);
1095 return g;
1096 }
1097
1098
1099 /* Copy the content of a string to tainted memory.  The proto_mem arg
1100 will always be tainted, and suitable as a prototype. */
1101
1102 static inline void
1103 gstring_rebuffer(gstring * g, const void * proto_mem)
1104 {
1105 uschar * s = store_get_3(g->size, proto_mem, __FUNCTION__, __LINE__);
1106 memcpy(s, g->s, g->ptr);
1107 g->s = s;
1108 }
1109
1110 /* Append one gstring to another */
1111
1112 static inline gstring *
1113 gstring_append(gstring * dest, gstring * item)
1114 {
1115 return string_catn(dest, item->s, item->ptr);
1116 }
1117
1118
1119 # ifndef COMPILE_UTILITY
1120 /******************************************************************************/
1121 /* Use store_malloc for DNSA structs, and explicit frees. Using the same pool
1122 for them as the strings we proceed to copy from them meant they could not be
1123 released, hence blowing 64k for every DNS lookup. That mounted up. With malloc
1124 we do have to take care over marking tainted all copied strings.  A separate pool
1125 could be used and would handle that implicitly. */
1126
1127 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
1128
1129 static inline dns_answer *
1130 store_get_dns_answer_trc(const uschar * func, unsigned line)
1131 {
1132 return store_malloc_3(sizeof(dns_answer), CCS func, line);
1133 }
1134
1135 #define store_free_dns_answer(dnsa) store_free_dns_answer_trc(dnsa, CUS __FUNCTION__, __LINE__)
1136
1137 static inline void
1138 store_free_dns_answer_trc(dns_answer * dnsa, const uschar * func, unsigned line)
1139 {
1140 store_free_3(dnsa, CCS func, line);
1141 }
1142
1143
1144 /* Check for an RR being large enough.  Return TRUE iff bad. */
1145 static inline BOOL
1146 rr_bad_size(const dns_record * rr, size_t minbytes)
1147 {
1148 return rr->size < minbytes;
1149 }
1150
1151 /* Check for an RR having further data beyond a given pointer.
1152 Return TRUE iff bad. */
1153 static inline BOOL
1154 rr_bad_increment(const dns_record * rr, const uschar * ptr, size_t minbytes)
1155 {
1156 return rr_bad_size(rr, ptr - rr->data + minbytes);
1157 }
1158
1159 /******************************************************************************/
1160 /* Routines with knowledge of spool layout */
1161
1162 static inline void
1163 spool_pname_buf(uschar * buf, int len)
1164 {
1165 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
1166 }
1167
1168 static inline uschar *
1169 spool_dname(const uschar * purpose, uschar * subdir)
1170 {
1171 return string_sprintf("%s/%s/%s/%s",
1172         spool_directory, queue_name, purpose, subdir);
1173 }
1174 # endif
1175
1176 static inline uschar *
1177 spool_q_sname(const uschar * purpose, const uschar * q, const uschar * subdir)
1178 {
1179 return string_sprintf("%s%s%s%s%s",
1180                     q, *q ? "/" : "",
1181                     purpose,
1182                     *subdir ? "/" : "", subdir);
1183 }
1184
1185 static inline uschar *
1186 spool_sname(const uschar * purpose, const uschar * subdir)
1187 {
1188 return spool_q_sname(purpose, queue_name, subdir);
1189 }
1190
1191 static inline uschar *
1192 spool_q_fname(const uschar * purpose, const uschar * q,
1193         const uschar * subdir, const uschar * fname, const uschar * suffix)
1194 {
1195 return string_sprintf("%s/%s/%s/%s/%s%s",
1196         spool_directory, q, purpose, subdir, fname, suffix);
1197 }
1198
1199 static inline uschar *
1200 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1201         const uschar * suffix)
1202 {
1203 #ifdef COMPILE_UTILITY          /* version avoiding string-extension */
1204 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1205         + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1206 uschar * buf = store_get(len, GET_UNTAINTED);
1207 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1208         spool_directory, queue_name, purpose, subdir, fname, suffix);
1209 return buf;
1210 #else
1211 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1212 #endif
1213 }
1214
1215 static inline void
1216 set_subdir_str(uschar * subdir_str, const uschar * name,
1217         int search_sequence)
1218 {
1219 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1220        ? name[MESSAGE_ID_TIME_LEN-1] : '\0';
1221 subdir_str[1] = '\0';
1222 }
1223
1224 /******************************************************************************/
1225 /* Message-ID format transition knowlege */
1226
1227 static inline BOOL
1228 is_new_message_id(const uschar * id)
1229 {
1230 return id[MESSAGE_ID_TIME_LEN + 1 + MESSAGE_ID_PID_LEN] == '-';
1231 }
1232
1233 static inline BOOL
1234 is_old_message_id(const uschar * id)
1235 {
1236 return id[MESSAGE_ID_TIME_LEN + 1 + MESSAGE_ID_PID_LEN_OLD] == '-';
1237 }
1238
1239 static inline unsigned
1240 spool_data_start_offset(const uschar * id)
1241 {
1242 if (is_old_message_id(id)) return SPOOL_DATA_START_OFFSET_OLD;
1243 return SPOOL_DATA_START_OFFSET;
1244 }
1245
1246 /******************************************************************************/
1247 /* Time calculations */
1248
1249 /* Diff two times (later, earlier) returning diff in 1st arg */
1250 static inline void
1251 timediff(struct timeval * later, const struct timeval * earlier)
1252 {
1253 later->tv_sec -= earlier->tv_sec;
1254 if ((later->tv_usec -= earlier->tv_usec) < 0)
1255   {
1256   later->tv_sec--;
1257   later->tv_usec += 1000*1000;
1258   }
1259 }
1260
1261 static inline void
1262 timesince(struct timeval * diff, const struct timeval * then)
1263 {
1264 gettimeofday(diff, NULL);
1265 timediff(diff, then);
1266 }
1267
1268 static inline uschar *
1269 string_timediff(const struct timeval * diff)
1270 {
1271 static uschar buf[16];
1272
1273 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1274   return readconf_printtime((int)diff->tv_sec);
1275
1276 snprintf(CS buf, sizeof(buf), "%u.%03us",
1277           (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1278 return buf;
1279 }
1280
1281
1282 static inline uschar *
1283 string_timesince(const struct timeval * then)
1284 {
1285 struct timeval diff;
1286 timesince(&diff, then);
1287 return string_timediff(&diff);
1288 }
1289
1290 static inline void
1291 report_time_since(const struct timeval * t0, const uschar * where)
1292 {
1293 # ifdef MEASURE_TIMING
1294 struct timeval diff;
1295 timesince(&diff, t0);
1296 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1297        (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1298 # endif
1299 }
1300
1301
1302 static inline void
1303 testharness_pause_ms(int millisec)
1304 {
1305 #ifndef MEASURE_TIMING
1306 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1307 #endif
1308 }
1309
1310 /******************************************************************************/
1311 /* Taint-checked file opens */
1312
1313 static inline int
1314 exim_open2(const char *pathname, int flags)
1315 {
1316 if (!is_tainted(pathname)) return open(pathname, flags);
1317 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1318 errno = EACCES;
1319 return -1;
1320 }
1321 static inline int
1322 exim_open(const char *pathname, int flags, mode_t mode)
1323 {
1324 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1325 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1326 errno = EACCES;
1327 return -1;
1328 }
1329 #ifdef EXIM_HAVE_OPENAT
1330 static inline int
1331 exim_openat(int dirfd, const char *pathname, int flags)
1332 {
1333 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1334 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1335 errno = EACCES;
1336 return -1;
1337 }
1338 static inline int
1339 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1340 {
1341 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1342 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1343 errno = EACCES;
1344 return -1;
1345 }
1346 #endif
1347
1348 static inline FILE *
1349 exim_fopen(const char *pathname, const char *mode)
1350 {
1351 if (!is_tainted(pathname)) return fopen(pathname, mode);
1352 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1353 errno = EACCES;
1354 return NULL;
1355 }
1356
1357 static inline DIR *
1358 exim_opendir(const uschar * name)
1359 {
1360 if (!is_tainted(name)) return opendir(CCS name);
1361 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name);
1362 errno = EACCES;
1363 return NULL;
1364 }
1365
1366 /******************************************************************************/
1367 # if !defined(COMPILE_UTILITY)
1368
1369 /* We use the PID of the head process for a connection-id.  Note that
1370 this is only for tracking a received connection and what it directly
1371 causes; there is no inttent to describe transport-initiated TCP connections.
1372 The value is intented to be a cookie usable for logging, and we might change
1373 the generator for it at any time. */
1374
1375 static inline void
1376 set_connection_id(void)
1377 {
1378 connection_id = string_sprintf("%lu", (u_long)getpid());
1379 }
1380
1381
1382 /* Process manipulation */
1383
1384 static inline pid_t
1385 exim_fork(const unsigned char * purpose)
1386 {
1387 pid_t pid;
1388 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1389 if ((pid = fork()) == 0)
1390   {
1391   f.daemon_listen = FALSE;
1392   process_purpose = purpose;
1393   DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1394   }
1395 else
1396   {
1397   testharness_pause_ms(100); /* let child work */
1398   DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1399   }
1400 return pid;
1401 }
1402
1403
1404 static inline pid_t
1405 child_open_exim(int * fdptr, const uschar * purpose)
1406 { return child_open_exim_function(fdptr, purpose); }
1407
1408 static inline pid_t
1409 child_open_exim2(int * fdptr, uschar * sender,
1410   uschar * sender_auth, const uschar * purpose)
1411 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1412
1413 static inline pid_t
1414 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1415   int *outfdptr, BOOL make_leader, const uschar * purpose)
1416 { return child_open_function(argv, envp, newumask, infdptr,
1417   outfdptr, make_leader, purpose);
1418 }
1419
1420 /* Return 1 if fd is usable per pollbits, else 0 */
1421 static inline int
1422 poll_one_fd(int fd, short pollbits, int tmo_millisec)
1423 {
1424 struct pollfd p = {.fd = fd, .events = pollbits};
1425 return poll(&p, 1, tmo_millisec);
1426 }
1427
1428 /******************************************************************************/
1429 /* Client-side smtp log string, for debug */
1430
1431 static inline void
1432 smtp_debug_cmd_log_init(void)
1433 {
1434 #  ifndef DISABLE_CLIENT_CMD_LOG
1435 int old_pool = store_pool;
1436 store_pool = POOL_PERM;
1437 client_cmd_log = string_get_tainted(56, GET_TAINTED);
1438 *client_cmd_log->s = '\0';
1439 store_pool = old_pool;
1440 #  endif
1441 }
1442
1443
1444 static inline void
1445 smtp_debug_cmd(const uschar * buf, int mode)
1446 {
1447 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent("  SMTP%c> %s\n",
1448   mode == SCMD_BUFFER ? '|' : mode == SCMD_MORE ? '+' : '>', buf);
1449
1450 #  ifndef DISABLE_CLIENT_CMD_LOG
1451   {
1452   int len = Ustrcspn(buf, " \n"), old_pool = store_pool;
1453   store_pool = POOL_PERM;       /* Main pool ACL allocations eg. callouts get released */
1454   client_cmd_log = string_append_listele_n(client_cmd_log, ':', buf, MIN(len, 8));
1455   if (mode == SCMD_BUFFER)
1456     client_cmd_log = string_catn(client_cmd_log, US"|", 1);
1457   else if (mode == SCMD_MORE)
1458     client_cmd_log = string_catn(client_cmd_log, US"+", 1);
1459   store_pool = old_pool;
1460   }
1461 #  endif
1462 }
1463
1464
1465 /* This might be called both due to callout and then from delivery.
1466 Use memory that will not be released between those phases.
1467 */
1468 static inline void
1469 smtp_debug_resp(const uschar * buf)
1470 {
1471 #  ifndef DISABLE_CLIENT_CMD_LOG
1472 int old_pool = store_pool;
1473 store_pool = POOL_PERM;
1474 client_cmd_log = string_append_listele_n(client_cmd_log, ':', buf,
1475   buf[3] == '-' ? 4 : 3);
1476 store_pool = old_pool;
1477 #  endif
1478 }
1479
1480
1481 static inline void
1482 smtp_debug_cmd_report(void)
1483 {
1484 #  ifndef DISABLE_CLIENT_CMD_LOG
1485 if (client_cmd_log && *client_cmd_log->s)
1486   {
1487   debug_printf("cmdlog: '%Y'\n", client_cmd_log);
1488   gstring_reset(client_cmd_log);
1489   }
1490 else
1491   debug_printf("cmdlog: (unset)\n");
1492 #  endif
1493 }
1494
1495
1496
1497 static inline int
1498 expand_max_rcpt(const uschar * str_max_rcpt)
1499 {
1500 const uschar * s = expand_cstring(str_max_rcpt);
1501 int res;
1502 return !s || !*s || (res = Uatoi(s)) == 0 ? UNLIMITED_ADDRS : res;
1503 }
1504
1505 /******************************************************************************/
1506 /* Queue-runner operations */
1507
1508 static inline BOOL
1509 is_onetime_qrun(void)
1510 {
1511 return qrunners && !qrunners->next && qrunners->interval == 0;
1512 }
1513
1514 static inline BOOL
1515 is_multiple_qrun(void)
1516 {
1517 return qrunners && (qrunners->interval > 0 || qrunners->next);
1518 }
1519
1520
1521 # endif /* !COMPILE_UTILITY */
1522
1523 /******************************************************************************/
1524 #endif  /* !MACRO_PREDEF */
1525
1526 #endif  /* _FUNCTIONS_H_ */
1527
1528 /* vi: aw ai sw=2
1529 */
1530 /* End of functions.h */