src/src/functions.h

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