src/src/functions.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2020 - 2023 */
   6 /* Copyright (c) University of Cambridge 1995 - 2018 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8 /* SPDX-License-Identifier: GPL-2.0-or-later */
   9
  10
  11 /* Prototypes for functions that appear in various modules. Gathered together
  12 to avoid having a lot of tiddly little headers with only a couple of lines in
  13 them. However, some functions that are used (or not used) by utility programs
  14 are in in fact in separate headers. */
  15 #ifndef _FUNCTIONS_H_
  16 #define _FUNCTIONS_H_
  17
  18 #include <ctype.h>
  19 #include <sys/time.h>
  20
  21
  22 #ifdef EXIM_PERL
  23 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
  24                  uschar **) WARN_UNUSED_RESULT;
  25 extern void    cleanup_perl(void);
  26 extern uschar *init_perl(uschar *);
  27 #endif
  28
  29
  30 #ifndef DISABLE_TLS
  31 extern const char *
  32                std_dh_prime_default(void);
  33 extern const char *
  34                std_dh_prime_named(const uschar *);
  35
  36 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
  37 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
  38 extern uschar * tls_cert_issuer(void *, uschar * mod);
  39 extern uschar * tls_cert_not_before(void *, uschar * mod);
  40 extern uschar * tls_cert_not_after(void *, uschar * mod);
  41 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
  42 extern uschar * tls_cert_serial_number(void *, uschar * mod);
  43 extern uschar * tls_cert_signature(void *, uschar * mod);
  44 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
  45 extern uschar * tls_cert_subject(void *, uschar * mod);
  46 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
  47 extern uschar * tls_cert_version(void *, uschar * mod);
  48
  49 extern uschar * tls_cert_der_b64(void * cert);
  50 extern uschar * tls_cert_fprt_md5(void *);
  51 extern uschar * tls_cert_fprt_sha1(void *);
  52 extern uschar * tls_cert_fprt_sha256(void *);
  53
  54 extern void    tls_clean_env(void);
  55 extern BOOL    tls_client_start(client_conn_ctx *, smtp_connect_args *,
  56                   void *, tls_support *, uschar **);
  57 extern BOOL    tls_client_adjunct_start(host_item *, client_conn_ctx *,
  58                   const uschar *, uschar **);
  59 extern void    tls_client_creds_reload(BOOL);
  60
  61 extern void    tls_close(void *, int);
  62 extern BOOL    tls_could_getc(void);
  63 extern void    tls_daemon_init(void);
  64 extern int     tls_daemon_tick(void);
  65 extern BOOL    tls_dropprivs_validate_require_cipher(BOOL);
  66 extern BOOL    tls_export_cert(uschar *, size_t, void *);
  67 extern int     tls_feof(void);
  68 extern int     tls_ferror(void);
  69 extern uschar *tls_field_from_dn(uschar *, const uschar *);
  70 extern void    tls_free_cert(void **);
  71 extern int     tls_getc(unsigned);
  72 extern uschar *tls_getbuf(unsigned *);
  73 extern void    tls_get_cache(unsigned);
  74 extern BOOL    tls_hasc(void);
  75 extern BOOL    tls_import_cert(const uschar *, void **);
  76 extern BOOL    tls_is_name_for_cert(const uschar *, void *);
  77 # ifdef USE_OPENSSL
  78 extern BOOL    tls_openssl_options_parse(uschar *, long *);
  79 # endif
  80 extern int     tls_read(void *, uschar *, size_t);
  81 extern int     tls_server_start(uschar **);
  82 extern void    tls_shutdown_wr(void *);
  83 extern BOOL    tls_smtp_buffered(void);
  84 extern int     tls_ungetc(int);
  85 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
  86 extern void    tls_watch_discard_event(int);
  87 extern void    tls_watch_invalidate(void);
  88 #endif
  89 extern int     tls_write(void *, const uschar *, size_t, BOOL);
  90 extern uschar *tls_validate_require_cipher(void);
  91 extern gstring *tls_version_report(gstring *);
  92
  93 # ifdef SUPPORT_DANE
  94 extern int     tlsa_lookup(const host_item *, dns_answer *, BOOL);
  95 # endif
  96
  97 #endif  /*DISABLE_TLS*/
  98
  99
 100 /* Everything else... */
 101
 102 extern acl_block *acl_read(uschar *(*)(void), uschar **);
 103 extern int     acl_check(int, uschar *, uschar *, uschar **, uschar **);
 104 extern uschar *acl_current_verb(void);
 105 extern int     acl_eval(int, uschar *, uschar **, uschar **);
 106 extern uschar *acl_standalone_setvar(const uschar *);
 107
 108 extern tree_node *acl_var_create(uschar *);
 109 extern void    acl_var_write(uschar *, uschar *, void *);
 110
 111 #ifdef EXPERIMENTAL_ARC
 112 # 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 **);
 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(uschar *, BOOL);
 220 extern void    delivery_log(int, address_item *, int, uschar *);
 221 extern int     deliver_message(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(uschar *, const uschar *, 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, 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, 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 uschar *local_part_quote(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(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(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(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(uschar *, int, 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, uschar **, int);
 416 #ifndef DISABLE_QUEUE_RAMP
 417 extern void    queue_notify_daemon(const uschar * hostname);
 418 #endif
 419 extern void    queue_run(qrunner *, uschar *, 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 *, const uschar *,
 424                  const uschar *, const uschar *, const uschar *, 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 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 *, 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(uschar *);
 444 extern BOOL    receive_msg(BOOL);
 445 extern int_eximarith_t receive_statvfs(BOOL, int *);
 446 extern void    receive_swallow_smtp(void);
 447 #ifdef WITH_CONTENT_SCAN
 448 extern int     regex(const uschar **, BOOL);
 449 extern void    regex_vars_clear(void);
 450 #endif
 451 extern void    regex_at_daemon(const uschar *);
 452 extern BOOL    regex_match(const pcre2_code *, const uschar *, int, uschar **);
 453 extern BOOL    regex_match_and_setup(const pcre2_code *, const uschar *, int, int);
 454 extern const pcre2_code *regex_compile(const uschar *, mcs_flags, uschar **,
 455                 pcre2_compile_context *);
 456 extern const pcre2_code *regex_must_compile(const uschar *, mcs_flags, BOOL);
 457 extern void    retry_add_item(address_item *, uschar *, int);
 458 extern BOOL    retry_check_address(const uschar *, host_item *, uschar *, BOOL,
 459                  uschar **, uschar **);
 460 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
 461 extern BOOL    retry_ultimate_address_timeout(uschar *, const uschar *,
 462                  dbdata_retry *, time_t);
 463 extern void    retry_update(address_item **, address_item **, address_item **);
 464 extern const uschar *rewrite_address(const uschar *, BOOL, BOOL, rewrite_rule *, int);
 465 extern const uschar *rewrite_address_qualify(const uschar *, BOOL);
 466 extern header_line *rewrite_header(header_line *,
 467                const uschar *, const uschar *,
 468                rewrite_rule *, int, BOOL);
 469 extern const uschar *rewrite_one(const uschar *, int, BOOL *, BOOL, uschar *,
 470                  rewrite_rule *);
 471 extern void    rewrite_test(const uschar *);
 472 extern uschar *rfc2047_decode2(uschar *, BOOL, const uschar *, int, int *,
 473                                      int *, uschar **);
 474 extern int     route_address(address_item *, address_item **, address_item **,
 475                  address_item **, address_item **, int);
 476 extern int     route_check_prefix(const uschar *, const uschar *, unsigned *);
 477 extern int     route_check_suffix(const uschar *, const uschar *, unsigned *);
 478 extern BOOL    route_findgroup(uschar *, gid_t *);
 479 extern BOOL    route_finduser(const uschar *, struct passwd **, uid_t *);
 480 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 481                  uschar **);
 482 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 483                  struct passwd **, uid_t *, uschar **);
 484 extern void    route_init(void);
 485 extern gstring * route_show_supported(gstring *);
 486 extern void    route_tidyup(void);
 487 extern uschar *router_current_name(void);
 488
 489 extern uschar *search_args(int, uschar *, uschar *, uschar **, const uschar *);
 490 extern uschar *search_find(void *, const uschar *, uschar *, int,
 491                  const uschar *, int, int, int *, const uschar *);
 492 extern int     search_findtype(const uschar *, int);
 493 extern int     search_findtype_partial(const uschar *, int *, const uschar **, int *,
 494                  int *, const uschar **);
 495 extern void   *search_open(const uschar *, int, int, uid_t *, gid_t *);
 496 extern void    search_tidyup(void);
 497 extern uschar *sender_helo_verified_boolstr(void);
 498 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
 499 extern void    sha1_end(hctx *, const uschar *, int, uschar *);
 500 extern void    sha1_mid(hctx *, const uschar *);
 501 extern void    sha1_start(hctx *);
 502 extern int     sieve_interpret(const uschar *, int, const uschar *,
 503                  const uschar *, const uschar *, const uschar *,
 504                  address_item **, uschar **);
 505 extern void    sigalrm_handler(int);
 506 extern void    single_queue_run(qrunner *, uschar *, uschar *);
 507 extern int     smtp_boundsock(smtp_connect_args *);
 508 extern void    smtp_closedown(uschar *);
 509 extern void    smtp_command_timeout_exit(void) NORETURN;
 510 extern void    smtp_command_sigterm_exit(void) NORETURN;
 511 extern void    smtp_data_timeout_exit(void) NORETURN;
 512 extern void    smtp_data_sigint_exit(void) NORETURN;
 513 extern void    smtp_deliver_init(void);
 514 extern uschar *smtp_cmd_hist(void);
 515 extern int     smtp_connect(smtp_connect_args *, const blob *);
 516 extern int     smtp_feof(void);
 517 extern int     smtp_ferror(void);
 518 extern uschar *smtp_get_connection_info(void);
 519 extern BOOL    smtp_get_interface(uschar *, int, address_item *,
 520                  uschar **, uschar *);
 521 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 522 extern int     smtp_getc(unsigned);
 523 extern uschar *smtp_getbuf(unsigned *);
 524 extern void    smtp_get_cache(unsigned);
 525 extern BOOL    smtp_hasc(void);
 526 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 527 extern void    smtp_log_no_mail(void);
 528 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
 529 extern void    smtp_proxy_tls(void *, uschar *, size_t, int *, int, const uschar *) NORETURN;
 530 extern BOOL    smtp_read_response(void *, uschar *, int, int, int);
 531 extern void   *smtp_reset(void *);
 532 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 533 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
 534 extern void    smtp_port_for_connect(host_item *, int);
 535 extern void    smtp_send_prohibition_message(int, uschar *);
 536 extern int     smtp_setup_msg(void);
 537 extern int     smtp_sock_connect(smtp_connect_args *, int, const blob *);
 538 extern BOOL    smtp_start_session(void);
 539 extern int     smtp_ungetc(int);
 540 extern BOOL    smtp_verify_helo(void);
 541 extern int     smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
 542 #ifdef WITH_CONTENT_SCAN
 543 extern int     spam(const uschar **);
 544 extern FILE   *spool_mbox(unsigned long *, const uschar *, uschar **);
 545 #endif
 546 extern void    spool_clear_header_globals(void);
 547 extern BOOL    spool_move_message(uschar *, uschar *, uschar *, uschar *);
 548 extern int     spool_open_datafile(uschar *);
 549 extern int     spool_open_temp(uschar *);
 550 extern int     spool_read_header(uschar *, BOOL, BOOL);
 551 extern uschar *spool_sender_from_msgid(const uschar *);
 552 extern int     spool_write_header(uschar *, int, uschar **);
 553 extern int     stdin_getc(unsigned);
 554 extern int     stdin_feof(void);
 555 extern int     stdin_ferror(void);
 556 extern BOOL    stdin_hasc(void);
 557 extern int     stdin_ungetc(int);
 558
 559 extern void    stackdump(void);
 560 extern void    store_exit(void);
 561 extern void    store_init(void);
 562 extern void    store_writeprotect(int);
 563
 564 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
 565 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
 566 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
 567 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
 568 extern uschar *string_base62_32(unsigned long int);
 569 extern uschar *string_base62_64(unsigned long int);
 570 extern gstring *string_cat (gstring *, const uschar *     ) WARN_UNUSED_RESULT;
 571 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
 572 extern int     string_compare_by_pointer(const void *, const void *);
 573 extern uschar *string_copy_dnsdomain(uschar *);
 574 extern uschar *string_copy_malloc(const uschar *);
 575 extern uschar *string_dequote(const uschar **);
 576 extern uschar *string_format_size(int, uschar *);
 577 extern int     string_interpret_escape(const uschar **);
 578 extern int     string_is_ip_address(const uschar *, int *);
 579 #ifdef SUPPORT_I18N
 580 extern BOOL    string_is_utf8(const uschar *);
 581 #endif
 582 extern const uschar *string_printing2(const uschar *, int);
 583 extern uschar *string_split_message(uschar *);
 584 extern uschar *string_unprinting(uschar *);
 585 #ifdef SUPPORT_I18N
 586 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
 587 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
 588 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
 589 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
 590 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
 591 #endif
 592
 593 #define string_format(buf, siz, fmt, ...) \
 594         string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 595 extern BOOL    string_format_trc(uschar *, int, const uschar *, unsigned,
 596                         const char *, ...) ALMOST_PRINTF(5,6);
 597
 598 #define string_vformat(g, flgs, fmt, ap) \
 599         string_vformat_trc(g, US __FUNCTION__, __LINE__, \
 600                          STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
 601 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
 602                         unsigned, unsigned, const char *, va_list);
 603
 604 #define string_open_failed(fmt, ...) \
 605         string_open_failed_trc(US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 606 extern uschar *string_open_failed_trc(const uschar *, unsigned,
 607                         const char *, ...) PRINTF_FUNCTION(3,4);
 608
 609 #define string_nextinlist(lp, sp, b, l) \
 610         string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
 611 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
 612                         const uschar * func, int line);
 613
 614 extern int     strcmpic(const uschar *, const uschar *);
 615 extern int     strncmpic(const uschar *, const uschar *, int);
 616 extern uschar *strstric(uschar *, uschar *, BOOL);
 617 extern const uschar *strstric_c(const uschar *, const uschar *, BOOL);
 618
 619 extern int     test_harness_fudged_queue_time(int);
 620 extern void    tcp_init(void);
 621 #ifdef EXIM_TFO_PROBE
 622 extern void    tfo_probe(void);
 623 #endif
 624 extern void    tls_modify_variables(tls_support *);
 625 extern uschar *tod_stamp(int);
 626
 627 extern BOOL    transport_check_waiting(const uschar *, const uschar *, int, uschar *,
 628                  oicf, void*);
 629 extern uschar *transport_current_name(void);
 630 extern void    transport_do_pass_socket(const uschar *, const uschar *,
 631                  const uschar *, uschar *, int);
 632 extern void    transport_init(void);
 633 extern BOOL    transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *, int
 634 #ifdef EXPERIMENTAL_ESMTP_LIMITS
 635                         , unsigned, unsigned, unsigned
 636 #endif
 637                         );
 638 extern uschar *transport_rcpt_address(address_item *, BOOL);
 639 extern BOOL    transport_set_up_command(const uschar ***, const uschar *,
 640                  unsigned, int, address_item *, const uschar *, uschar **);
 641 extern void    transport_update_waiting(host_item *, uschar *);
 642 extern BOOL    transport_write_block(transport_ctx *, uschar *, int, BOOL);
 643 extern void    transport_write_reset(int);
 644 extern BOOL    transport_write_string(int, const char *, ...);
 645 extern BOOL    transport_headers_send(transport_ctx *,
 646                  BOOL (*)(transport_ctx *, uschar *, int));
 647 extern gstring * transport_show_supported(gstring *);
 648 extern BOOL    transport_write_message(transport_ctx *, int);
 649 extern void    tree_add_duplicate(const uschar *, address_item *);
 650 extern void    tree_add_nonrecipient(const uschar *);
 651 extern void    tree_add_unusable(const host_item *);
 652 extern void    tree_dup(tree_node **, tree_node *);
 653 extern int     tree_insertnode(tree_node **, tree_node *);
 654 extern tree_node *tree_search(tree_node *, const uschar *);
 655 extern void    tree_write(tree_node *, FILE *);
 656 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 657
 658 #ifdef WITH_CONTENT_SCAN
 659 extern void    unspool_mbox(void);
 660 #endif
 661 #ifdef SUPPORT_I18N
 662 extern gstring *utf8_version_report(gstring *);
 663 #endif
 664
 665 extern int     vaguely_random_number(int);
 666 #ifndef DISABLE_TLS
 667 extern int     vaguely_random_number_fallback(int);
 668 #endif
 669 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 670                  uschar *, uschar *, BOOL *);
 671 extern int     verify_check_dnsbl(int, const uschar **, uschar **);
 672 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 673                  uschar *, uschar *, int, int *);
 674 extern int     verify_check_headers(uschar **);
 675 extern int     verify_check_header_names_ascii(uschar **);
 676 extern int     verify_check_host(uschar **);
 677 extern int     verify_check_notblind(BOOL);
 678 extern int     verify_check_given_host(const uschar **, const host_item *);
 679 extern int     verify_check_this_host(const uschar **, unsigned int *,
 680                  const uschar*, const uschar *, const uschar **);
 681 extern address_item *verify_checked_sender(uschar *);
 682 extern void    verify_get_ident(int);
 683 extern void    verify_quota(uschar *);
 684 extern int     verify_quota_call(const uschar *, int, int, uschar **);
 685 extern BOOL    verify_sender(int *, uschar **);
 686 extern BOOL    verify_sender_preliminary(int *, uschar **);
 687 extern void    version_init(void);
 688
 689 extern BOOL    write_chunk(transport_ctx *, uschar *, int);
 690 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
 691 extern uschar *wrap_header(const uschar *, unsigned, unsigned, const uschar *, unsigned);
 692
 693 #ifdef EXPERIMENTAL_XCLIENT
 694 extern uschar * xclient_smtp_command(uschar *, int *, BOOL *);
 695 extern gstring * xclient_smtp_advertise_str(gstring *);
 696 #endif
 697
 698
 699 /******************************************************************************/
 700 /* Predicate: if an address is in a tainted pool.
 701 By extension, a variable pointing to this address is tainted.
 702 */
 703
 704 static inline BOOL
 705 is_tainted(const void * p)
 706 {
 707 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
 708 return FALSE;
 709
 710 #else
 711 extern BOOL is_tainted_fn(const void *);
 712 return is_tainted_fn(p);
 713 #endif
 714 }
 715
 716 static inline BOOL
 717 is_incompatible(const void * old, const void * new)
 718 {
 719 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
 720 return FALSE;
 721
 722 #else
 723 extern BOOL is_incompatible_fn(const void *, const void *);
 724 return is_incompatible_fn(old, new);
 725 #endif
 726 }
 727
 728 /******************************************************************************/
 729 /* String functions */
 730 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
 731 {
 732 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 733 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
 734 #endif
 735 return US strcat(CS dst, CCS src);
 736 }
 737 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
 738 {
 739 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 740 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
 741 #endif
 742 return US strcpy(CS dst, CCS src);
 743 }
 744 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 745 {
 746 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 747 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
 748 #endif
 749 return US strncat(CS dst, CCS src, n);
 750 }
 751 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
 752 {
 753 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 754 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
 755 #endif
 756 return US strncpy(CS dst, CCS src, n);
 757 }
 758 /*XXX will likely need unchecked copy also */
 759
 760
 761 /* Advance the string pointer given over any whitespace.
 762 Return the next char as there's enought places using it to be useful. */
 763
 764 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
 765
 766 static inline uschar skip_whitespace(const uschar ** sp)
 767 { while (isspace(**sp)) (*sp)++; return **sp; }
 768
 769
 770 /******************************************************************************/
 771
 772 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
 773 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
 774 chown(<exim-uid>, <exim-gid>).
 775
 776 Probably because the idmapping is broken, misconfigured or set up in
 777 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
 778 case of misconfiguration, or if there are more such broken systems
 779 out, I try to impose as least impact as possible and for now just write
 780 a panic log entry pointing to the bug report. You're encouraged to
 781 contact the developers, if you experience this issue.
 782
 783 fd     the file descriptor (or -1 if not valid)
 784 name   the file name for error messages or for file operations,
 785   if fd is < 0
 786 owner  the owner
 787 group  the group
 788
 789 returns 0 on success, -1 on failure */
 790
 791 static inline int
 792 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
 793 {
 794 return fchown(fd, owner, group)
 795   ? exim_chown_failure(fd, name, owner, group) : 0;
 796 }
 797
 798 static inline int
 799 exim_chown(const uschar *name, uid_t owner, gid_t group)
 800 {
 801 return chown(CCS name, owner, group)
 802   ? exim_chown_failure(-1, name, owner, group) : 0;
 803 }
 804 #endif  /* !MACRO_PREDEF && !COMPILE_UTILITY */
 805
 806 /******************************************************************************/
 807 /* String functions */
 808
 809 #if !defined(MACRO_PREDEF)
 810 /*************************************************
 811 *            Copy and save string                *
 812 *************************************************/
 813
 814 /* This function assumes that memcpy() is faster than strcpy().
 815 The result is explicitly nul-terminated.
 816 */
 817
 818 static inline uschar *
 819 string_copyn_taint_trc(const uschar * s, unsigned len,
 820         const void * proto_mem, const char * func, int line)
 821 {
 822 uschar * ss;
 823 unsigned slen = Ustrlen(s);
 824 if (len > slen) len = slen;
 825 ss = store_get_3(len + 1, proto_mem, func, line);
 826 memcpy(ss, s, len);
 827 ss[len] = '\0';
 828 return ss;
 829 }
 830
 831 static inline uschar *
 832 string_copy_taint_trc(const uschar * s, const void * proto_mem, const char * func, int line)
 833 { return string_copyn_taint_trc(s, Ustrlen(s), proto_mem, func, line); }
 834
 835 static inline uschar *
 836 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
 837 { return string_copyn_taint_trc(s, len, s, func, line); }
 838 static inline uschar *
 839 string_copy_trc(const uschar * s, const char * func, int line)
 840 { return string_copy_taint_trc(s, s, func, line); }
 841
 842
 843 /* String-copy functions explicitly setting the taint status */
 844
 845 #define string_copyn_taint(s, len, proto_mem) \
 846         string_copyn_taint_trc((s), (len), (proto_mem), __FUNCTION__, __LINE__)
 847 #define string_copy_taint(s, proto_mem) \
 848         string_copy_taint_trc((s), (proto_mem), __FUNCTION__, __LINE__)
 849
 850 /* Simple string-copy functions maintaining the taint */
 851
 852 #define string_copyn(s, len) \
 853         string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
 854 #define string_copy(s) \
 855         string_copy_trc((s), __FUNCTION__, __LINE__)
 856
 857
 858 /*************************************************
 859 *       Copy, lowercase and save string          *
 860 *************************************************/
 861
 862 /*
 863 Argument: string to copy
 864 Returns:  copy of string in new store, with letters lowercased
 865 */
 866
 867 static inline uschar *
 868 string_copylc(const uschar * s)
 869 {
 870 uschar * ss = store_get(Ustrlen(s) + 1, s);
 871 uschar * p = ss;
 872 while (*s) *p++ = tolower(*s++);
 873 *p = 0;
 874 return ss;
 875 }
 876
 877
 878
 879 /*************************************************
 880 * Copy, lowercase, and save string, given length *
 881 *************************************************/
 882
 883 /* It is assumed the data contains no zeros. A zero is added
 884 onto the end.
 885
 886 Arguments:
 887   s         string to copy
 888   n         number of characters
 889
 890 Returns:    copy of string in new store, with letters lowercased
 891 */
 892
 893 static inline uschar *
 894 string_copynlc(uschar * s, int n)
 895 {
 896 uschar * ss = store_get(n + 1, s);
 897 uschar * p = ss;
 898 while (n-- > 0) *p++ = tolower(*s++);
 899 *p = 0;
 900 return ss;
 901 }
 902
 903
 904 # ifndef COMPILE_UTILITY
 905 /*************************************************
 906 *     Copy and save string in longterm store     *
 907 *************************************************/
 908
 909 /* This function assumes that memcpy() is faster than strcpy().
 910
 911 Argument: string to copy
 912 Returns:  copy of string in new store
 913 */
 914
 915 static inline uschar *
 916 string_copy_perm(const uschar *s, BOOL force_taint)
 917 {
 918 int old_pool = store_pool;
 919 int len = Ustrlen(s) + 1;
 920 uschar *ss;
 921
 922 store_pool = POOL_PERM;
 923 ss = store_get(len, force_taint ? GET_TAINTED : s);
 924 memcpy(ss, s, len);
 925 store_pool = old_pool;
 926 return ss;
 927 }
 928 # endif
 929
 930
 931
 932 /* sprintf into a buffer, taint-unchecked */
 933
 934 static inline void
 935 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
 936 {
 937 gstring gs = { .size = siz, .ptr = 0, .s = buf };
 938 va_list ap;
 939 va_start(ap, fmt);
 940 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
 941 va_end(ap);
 942 }
 943
 944
 945
 946 /******************************************************************************/
 947 /* Growable-string functions */
 948
 949 /* Create a growable-string with some preassigned space */
 950
 951 #define string_get_tainted(size, proto_mem) \
 952         string_get_tainted_trc((size), (proto_mem), __FUNCTION__, __LINE__)
 953
 954 static inline gstring *
 955 string_get_tainted_trc(unsigned size, const void * proto_mem, const char * func, unsigned line)
 956 {
 957 gstring * g = store_get_3(sizeof(gstring) + size, proto_mem, func, line);
 958 g->size = size;         /*XXX would be good if we could see the actual alloc size */
 959 g->ptr = 0;
 960 g->s = US(g + 1);
 961 return g;
 962 }
 963
 964 #define string_get(size) \
 965         string_get_trc((size), __FUNCTION__, __LINE__)
 966
 967 static inline gstring *
 968 string_get_trc(unsigned size, const char * func, unsigned line)
 969 {
 970 return string_get_tainted_trc(size, GET_UNTAINTED, func, line);
 971 }
 972
 973 /* NUL-terminate the C string in the growable-string, and return it. */
 974
 975 static inline uschar *
 976 string_from_gstring(gstring * g)
 977 {
 978 if (!g) return NULL;
 979 g->s[g->ptr] = '\0';
 980 return g->s;
 981 }
 982
 983 static inline int
 984 len_string_from_gstring(gstring * g, uschar ** sp)
 985 {
 986 if (g)
 987   {
 988   *sp = g->s;
 989   g->s[g->ptr] = '\0';
 990   return g->ptr;
 991   }
 992 else
 993   {
 994   *sp = NULL;
 995   return 0;
 996   }
 997 }
 998
 999 static inline uschar *
1000 string_copy_from_gstring(gstring * g)
1001 {
1002 return g ? string_copyn(g->s, g->ptr) : NULL;
1003 }
1004
1005 static inline unsigned
1006 gstring_length(const gstring * g)
1007 {
1008 return g ? (unsigned)g->ptr : 0;
1009 }
1010
1011 static inline uschar
1012 gstring_last_char(gstring * g)
1013 {
1014 return g->s[g->ptr-1];
1015 }
1016
1017 static inline void
1018 gstring_trim(gstring * g, unsigned amount)
1019 {
1020 g->ptr -= amount;
1021 }
1022
1023 static inline void
1024 gstring_trim_trailing(gstring * g, uschar c)
1025 {
1026 if (gstring_last_char(g) == c) gstring_trim(g, 1);
1027 }
1028
1029 static inline void
1030 gstring_reset(gstring * g)
1031 {
1032 g->ptr = 0;
1033 }
1034
1035
1036 #define gstring_release_unused(g) \
1037         gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
1038
1039 static inline void
1040 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
1041 {
1042 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
1043 }
1044
1045
1046 /* sprintf-append to a growable-string */
1047
1048 #define string_fmt_append(g, fmt, ...) \
1049         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
1050         SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
1051
1052 #define string_fmt_append_f(g, flgs, fmt, ...) \
1053         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
1054         flgs,         fmt, __VA_ARGS__)
1055
1056 static inline gstring *
1057 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
1058   unsigned flags, const char *format, ...)
1059 {
1060 va_list ap;
1061 va_start(ap, format);
1062 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
1063                         flags, format, ap);
1064 va_end(ap);
1065 return g;
1066 }
1067
1068
1069 /* Copy the content of a string to tainted memory.  The proto_mem arg
1070 will always be tainted, and suitable as a prototype. */
1071
1072 static inline void
1073 gstring_rebuffer(gstring * g, const void * proto_mem)
1074 {
1075 uschar * s = store_get_3(g->size, proto_mem, __FUNCTION__, __LINE__);
1076 memcpy(s, g->s, g->ptr);
1077 g->s = s;
1078 }
1079
1080 /* Append one gstring to another */
1081 static inline gstring *
1082 gstring_append(gstring * dest, gstring * item)
1083 {
1084 return string_catn(dest, item->s, item->ptr);
1085 }
1086
1087
1088 # ifndef COMPILE_UTILITY
1089 /******************************************************************************/
1090 /* Use store_malloc for DNSA structs, and explicit frees. Using the same pool
1091 for them as the strings we proceed to copy from them meant they could not be
1092 released, hence blowing 64k for every DNS lookup. That mounted up. With malloc
1093 we do have to take care over marking tainted all copied strings.  A separate pool
1094 could be used and would handle that implicitly. */
1095
1096 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
1097
1098 static inline dns_answer *
1099 store_get_dns_answer_trc(const uschar * func, unsigned line)
1100 {
1101 return store_malloc_3(sizeof(dns_answer), CCS func, line);
1102 }
1103
1104 #define store_free_dns_answer(dnsa) store_free_dns_answer_trc(dnsa, CUS __FUNCTION__, __LINE__)
1105
1106 static inline void
1107 store_free_dns_answer_trc(dns_answer * dnsa, const uschar * func, unsigned line)
1108 {
1109 store_free_3(dnsa, CCS func, line);
1110 }
1111
1112 /******************************************************************************/
1113 /* Routines with knowledge of spool layout */
1114
1115 static inline void
1116 spool_pname_buf(uschar * buf, int len)
1117 {
1118 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
1119 }
1120
1121 static inline uschar *
1122 spool_dname(const uschar * purpose, uschar * subdir)
1123 {
1124 return string_sprintf("%s/%s/%s/%s",
1125         spool_directory, queue_name, purpose, subdir);
1126 }
1127 # endif
1128
1129 static inline uschar *
1130 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
1131 {
1132 return string_sprintf("%s%s%s%s%s",
1133                     q, *q ? "/" : "",
1134                     purpose,
1135                     *subdir ? "/" : "", subdir);
1136 }
1137
1138 static inline uschar *
1139 spool_sname(const uschar * purpose, uschar * subdir)
1140 {
1141 return spool_q_sname(purpose, queue_name, subdir);
1142 }
1143
1144 static inline uschar *
1145 spool_q_fname(const uschar * purpose, const uschar * q,
1146         const uschar * subdir, const uschar * fname, const uschar * suffix)
1147 {
1148 return string_sprintf("%s/%s/%s/%s/%s%s",
1149         spool_directory, q, purpose, subdir, fname, suffix);
1150 }
1151
1152 static inline uschar *
1153 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1154         const uschar * suffix)
1155 {
1156 #ifdef COMPILE_UTILITY          /* version avoiding string-extension */
1157 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1158         + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1159 uschar * buf = store_get(len, GET_UNTAINTED);
1160 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1161         spool_directory, queue_name, purpose, subdir, fname, suffix);
1162 return buf;
1163 #else
1164 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1165 #endif
1166 }
1167
1168 static inline void
1169 set_subdir_str(uschar * subdir_str, const uschar * name,
1170         int search_sequence)
1171 {
1172 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1173        ? name[MESSAGE_ID_TIME_LEN-1] : '\0';
1174 subdir_str[1] = '\0';
1175 }
1176
1177 /******************************************************************************/
1178 /* Message-ID format transition knowlege */
1179
1180 static inline BOOL
1181 is_new_message_id(const uschar * id)
1182 {
1183 return id[MESSAGE_ID_TIME_LEN + 1 + MESSAGE_ID_PID_LEN] == '-';
1184 }
1185
1186 static inline BOOL
1187 is_old_message_id(const uschar * id)
1188 {
1189 return id[MESSAGE_ID_TIME_LEN + 1 + MESSAGE_ID_PID_LEN_OLD] == '-';
1190 }
1191
1192 static inline unsigned
1193 spool_data_start_offset(const uschar * id)
1194 {
1195 if (is_old_message_id(id)) return SPOOL_DATA_START_OFFSET_OLD;
1196 return SPOOL_DATA_START_OFFSET;
1197 }
1198
1199 /******************************************************************************/
1200 /* Time calculations */
1201
1202 /* Diff two times (later, earlier) returning diff in 1st arg */
1203 static inline void
1204 timediff(struct timeval * later, const struct timeval * earlier)
1205 {
1206 later->tv_sec -= earlier->tv_sec;
1207 if ((later->tv_usec -= earlier->tv_usec) < 0)
1208   {
1209   later->tv_sec--;
1210   later->tv_usec += 1000*1000;
1211   }
1212 }
1213
1214 static inline void
1215 timesince(struct timeval * diff, const struct timeval * then)
1216 {
1217 gettimeofday(diff, NULL);
1218 timediff(diff, then);
1219 }
1220
1221 static inline uschar *
1222 string_timediff(const struct timeval * diff)
1223 {
1224 static uschar buf[sizeof("0.000s")];
1225
1226 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1227   return readconf_printtime((int)diff->tv_sec);
1228
1229 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1230 return buf;
1231 }
1232
1233
1234 static inline uschar *
1235 string_timesince(const struct timeval * then)
1236 {
1237 struct timeval diff;
1238 timesince(&diff, then);
1239 return string_timediff(&diff);
1240 }
1241
1242 static inline void
1243 report_time_since(const struct timeval * t0, const uschar * where)
1244 {
1245 # ifdef MEASURE_TIMING
1246 struct timeval diff;
1247 timesince(&diff, t0);
1248 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1249        (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1250 # endif
1251 }
1252
1253
1254 static inline void
1255 testharness_pause_ms(int millisec)
1256 {
1257 #ifndef MEASURE_TIMING
1258 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1259 #endif
1260 }
1261
1262 /******************************************************************************/
1263 /* Taint-checked file opens */
1264
1265 static inline int
1266 exim_open2(const char *pathname, int flags)
1267 {
1268 if (!is_tainted(pathname)) return open(pathname, flags);
1269 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1270 errno = EACCES;
1271 return -1;
1272 }
1273 static inline int
1274 exim_open(const char *pathname, int flags, mode_t mode)
1275 {
1276 if (!is_tainted(pathname)) return open(pathname, flags, mode);
1277 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1278 errno = EACCES;
1279 return -1;
1280 }
1281 #ifdef EXIM_HAVE_OPENAT
1282 static inline int
1283 exim_openat(int dirfd, const char *pathname, int flags)
1284 {
1285 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags);
1286 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1287 errno = EACCES;
1288 return -1;
1289 }
1290 static inline int
1291 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1292 {
1293 if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode);
1294 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1295 errno = EACCES;
1296 return -1;
1297 }
1298 #endif
1299
1300 static inline FILE *
1301 exim_fopen(const char *pathname, const char *mode)
1302 {
1303 if (!is_tainted(pathname)) return fopen(pathname, mode);
1304 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname);
1305 errno = EACCES;
1306 return NULL;
1307 }
1308
1309 static inline DIR *
1310 exim_opendir(const uschar * name)
1311 {
1312 if (!is_tainted(name)) return opendir(CCS name);
1313 log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name);
1314 errno = EACCES;
1315 return NULL;
1316 }
1317
1318 /******************************************************************************/
1319 # if !defined(COMPILE_UTILITY)
1320 /* Process manipulation */
1321
1322 static inline pid_t
1323 exim_fork(const unsigned char * purpose)
1324 {
1325 pid_t pid;
1326 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1327 if ((pid = fork()) == 0)
1328   {
1329   f.daemon_listen = FALSE;
1330   process_purpose = purpose;
1331   DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1332   }
1333 else
1334   {
1335   testharness_pause_ms(100); /* let child work */
1336   DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1337   }
1338 return pid;
1339 }
1340
1341
1342 static inline pid_t
1343 child_open_exim(int * fdptr, const uschar * purpose)
1344 { return child_open_exim_function(fdptr, purpose); }
1345
1346 static inline pid_t
1347 child_open_exim2(int * fdptr, uschar * sender,
1348   uschar * sender_auth, const uschar * purpose)
1349 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1350
1351 static inline pid_t
1352 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1353   int *outfdptr, BOOL make_leader, const uschar * purpose)
1354 { return child_open_function(argv, envp, newumask, infdptr,
1355   outfdptr, make_leader, purpose);
1356 }
1357
1358 /* Return 1 if fd is usable per pollbits, else 0 */
1359 static inline int
1360 poll_one_fd(int fd, short pollbits, int tmo_millisec)
1361 {
1362 struct pollfd p = {.fd = fd, .events = pollbits};
1363 return poll(&p, 1, tmo_millisec);
1364 }
1365
1366 /******************************************************************************/
1367 /* Client-side smtp log string, for debug */
1368
1369 static inline void
1370 smtp_debug_cmd(const uschar * buf, int mode)
1371 {
1372 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent("  SMTP%c> %s\n",
1373   mode == SCMD_BUFFER ? '|' : mode == SCMD_MORE ? '+' : '>', buf);
1374
1375 #  ifndef DISABLE_CLIENT_CMD_LOG
1376   {
1377   int len = Ustrcspn(buf, " \n");
1378   int old_pool = store_pool;
1379   store_pool = POOL_PERM;       /* Main pool ACL allocations eg. callouts get released */
1380   client_cmd_log = string_append_listele_n(client_cmd_log, ':', buf, MIN(len, 8));
1381   if (mode == SCMD_BUFFER)
1382     {
1383     client_cmd_log = string_catn(client_cmd_log, US"|", 1);
1384     (void) string_from_gstring(client_cmd_log);
1385     }
1386   store_pool = old_pool;
1387   }
1388 #  endif
1389 }
1390
1391
1392 static inline void
1393 smtp_debug_cmd_report(void)
1394 {
1395 #  ifndef DISABLE_CLIENT_CMD_LOG
1396 debug_printf("cmdlog: '%s'\n", client_cmd_log ? client_cmd_log->s : US"(unset)");
1397 #  endif
1398 }
1399
1400
1401
1402 static inline int
1403 expand_max_rcpt(const uschar * str_max_rcpt)
1404 {
1405 const uschar * s = expand_cstring(str_max_rcpt);
1406 int res;
1407 return !s || !*s || (res = Uatoi(s)) == 0 ? UNLIMITED_ADDRS : res;
1408 }
1409
1410 /******************************************************************************/
1411 /* Queue-runner operations */
1412
1413 static inline BOOL
1414 is_onetime_qrun(void)
1415 {
1416 return qrunners && !qrunners->next && qrunners->interval == 0;
1417 }
1418
1419 static inline BOOL
1420 is_multiple_qrun(void)
1421 {
1422 return qrunners && (qrunners->interval > 0 || qrunners->next);
1423 }
1424
1425
1426 # endif /* !COMPILE_UTILITY */
1427
1428 /******************************************************************************/
1429 #endif  /* !MACRO_PREDEF */
1430
1431 #endif  /* _FUNCTIONS_H_ */
1432
1433 /* vi: aw ai sw=2
1434 */
1435 /* End of functions.h */