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