src/src/functions.h

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