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