src/src/functions.h

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