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