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