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