src/src/functions.h

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