src/src/functions.h

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