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