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