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