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