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