src/src/functions.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2018 */
   6 /* See the file NOTICE for conditions of use and distribution. */
   7
   8
   9 /* Prototypes for functions that appear in various modules. Gathered together
  10 to avoid having a lot of tiddly little headers with only a couple of lines in
  11 them. However, some functions that are used (or not used) by utility programs
  12 are in in fact in separate headers. */
  13 #ifndef _FUNCTIONS_H_
  14 #define _FUNCTIONS_H_
  15
  16 #include <sys/time.h>
  17
  18
  19 #ifdef EXIM_PERL
  20 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
  21                  uschar **) WARN_UNUSED_RESULT;
  22 extern void    cleanup_perl(void);
  23 extern uschar *init_perl(uschar *);
  24 #endif
  25
  26
  27 #ifndef DISABLE_TLS
  28 extern const char *
  29                std_dh_prime_default(void);
  30 extern const char *
  31                std_dh_prime_named(const uschar *);
  32
  33 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
  34 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
  35 extern uschar * tls_cert_issuer(void *, uschar * mod);
  36 extern uschar * tls_cert_not_before(void *, uschar * mod);
  37 extern uschar * tls_cert_not_after(void *, uschar * mod);
  38 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
  39 extern uschar * tls_cert_serial_number(void *, uschar * mod);
  40 extern uschar * tls_cert_signature(void *, uschar * mod);
  41 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
  42 extern uschar * tls_cert_subject(void *, uschar * mod);
  43 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
  44 extern uschar * tls_cert_version(void *, uschar * mod);
  45
  46 extern uschar * tls_cert_der_b64(void * cert);
  47 extern uschar * tls_cert_fprt_md5(void *);
  48 extern uschar * tls_cert_fprt_sha1(void *);
  49 extern uschar * tls_cert_fprt_sha256(void *);
  50
  51 extern BOOL    tls_client_start(client_conn_ctx *, smtp_connect_args *,
  52                   void *, tls_support *, uschar **);
  53
  54 extern void    tls_close(void *, int);
  55 extern BOOL    tls_could_read(void);
  56 extern void    tls_daemon_init(void);
  57 extern BOOL    tls_export_cert(uschar *, size_t, void *);
  58 extern int     tls_feof(void);
  59 extern int     tls_ferror(void);
  60 extern void    tls_free_cert(void **);
  61 extern int     tls_getc(unsigned);
  62 extern uschar *tls_getbuf(unsigned *);
  63 extern void    tls_get_cache(void);
  64 extern BOOL    tls_import_cert(const uschar *, void **);
  65 extern int     tls_read(void *, uschar *, size_t);
  66 extern int     tls_server_start(const uschar *, uschar **);
  67 extern BOOL    tls_smtp_buffered(void);
  68 extern int     tls_ungetc(int);
  69 extern int     tls_write(void *, const uschar *, size_t, BOOL);
  70 extern uschar *tls_validate_require_cipher(void);
  71 extern void    tls_version_report(FILE *);
  72 # ifdef USE_OPENSSL
  73 extern BOOL    tls_openssl_options_parse(uschar *, long *);
  74 # endif
  75 extern uschar * tls_field_from_dn(uschar *, const uschar *);
  76 extern BOOL    tls_is_name_for_cert(const uschar *, void *);
  77
  78 # ifdef SUPPORT_DANE
  79 extern int     tlsa_lookup(const host_item *, dns_answer *, BOOL);
  80 # endif
  81
  82 #endif  /*DISABLE_TLS*/
  83
  84
  85 /* Everything else... */
  86
  87 extern acl_block *acl_read(uschar *(*)(void), uschar **);
  88 extern int     acl_check(int, uschar *, uschar *, uschar **, uschar **);
  89 extern int     acl_eval(int, uschar *, uschar **, uschar **);
  90
  91 extern tree_node *acl_var_create(uschar *);
  92 extern void    acl_var_write(uschar *, uschar *, void *);
  93
  94 #ifdef EXPERIMENTAL_ARC
  95 extern void   *arc_ams_setup_sign_bodyhash(void);
  96 extern const uschar *arc_header_feed(gstring *, BOOL);
  97 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
  98 extern void     arc_sign_init(void);
  99 extern const uschar *acl_verify_arc(void);
 100 extern uschar * fn_arc_domains(void);
 101 #endif
 102
 103 extern void    assert_no_variables(void *, int, const char *, int);
 104 extern int     auth_call_pam(const uschar *, uschar **);
 105 extern int     auth_call_pwcheck(uschar *, uschar **);
 106 extern int     auth_call_radius(const uschar *, uschar **);
 107 extern int     auth_call_saslauthd(const uschar *, const uschar *,
 108                  const uschar *, const uschar *, uschar **);
 109 extern int     auth_check_serv_cond(auth_instance *);
 110 extern int     auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
 111 extern int     auth_client_item(void *, auth_instance *, const uschar **,
 112                  unsigned, int, uschar *, int);
 113
 114
 115 extern int     auth_get_data(uschar **, const uschar *, int);
 116 extern int     auth_get_no64_data(uschar **, uschar *);
 117 extern int     auth_prompt(const uschar *);
 118 extern int     auth_read_input(const uschar *);
 119 extern void    auth_show_supported(FILE *);
 120 extern uschar *auth_xtextencode(uschar *, int);
 121 extern int     auth_xtextdecode(uschar *, uschar **);
 122
 123 #ifdef EXPERIMENTAL_ARC
 124 extern gstring *authres_arc(gstring *);
 125 #endif
 126 #ifndef DISABLE_DKIM
 127 extern gstring *authres_dkim(gstring *);
 128 #endif
 129 #ifdef SUPPORT_DMARC
 130 extern gstring *authres_dmarc(gstring *);
 131 #endif
 132 extern gstring *authres_smtpauth(gstring *);
 133 #ifdef SUPPORT_SPF
 134 extern gstring *authres_spf(gstring *);
 135 #endif
 136
 137 extern uschar *b64encode(const uschar *, int);
 138 extern int     b64decode(const uschar *, uschar **);
 139 extern int     bdat_getc(unsigned);
 140 extern uschar *bdat_getbuf(unsigned *);
 141 extern int     bdat_ungetc(int);
 142 extern void    bdat_flush_data(void);
 143
 144 extern void    bits_clear(unsigned int *, size_t, int *);
 145 extern void    bits_set(unsigned int *, size_t, int *);
 146
 147 extern void    cancel_cutthrough_connection(BOOL, const uschar *);
 148 extern int     check_host(void *, const uschar *, const uschar **, uschar **);
 149 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
 150 extern pid_t   child_open_uid(const uschar **, const uschar **, int,
 151                  uid_t *, gid_t *, int *, int *, uschar *, BOOL);
 152 extern BOOL    cleanup_environment(void);
 153 extern void    cutthrough_data_puts(uschar *, int);
 154 extern void    cutthrough_data_put_nl(void);
 155 extern uschar *cutthrough_finaldot(void);
 156 extern BOOL    cutthrough_flush_send(void);
 157 extern BOOL    cutthrough_headers_send(void);
 158 extern BOOL    cutthrough_predata(void);
 159 extern void    release_cutthrough_connection(const uschar *);
 160
 161 extern void    daemon_go(void);
 162
 163 #ifdef EXPERIMENTAL_DCC
 164 extern int     dcc_process(uschar **);
 165 #endif
 166
 167 extern void    debug_logging_activate(uschar *, uschar *);
 168 extern void    debug_logging_stop(void);
 169 extern void    debug_print_argv(const uschar **);
 170 extern void    debug_print_ids(uschar *);
 171 extern void    debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
 172 extern void    debug_print_string(uschar *);
 173 extern void    debug_print_tree(tree_node *);
 174 extern void    debug_vprintf(int, const char *, va_list);
 175 extern void    decode_bits(unsigned int *, size_t, int *,
 176                    uschar *, bit_table *, int, uschar *, int);
 177 extern address_item *deliver_make_addr(uschar *, BOOL);
 178 extern void    deliver_init(void);
 179 extern void    delivery_log(int, address_item *, int, uschar *);
 180 extern int     deliver_message(uschar *, BOOL, BOOL);
 181 extern void    deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
 182 extern void    deliver_set_expansions(address_item *);
 183 extern int     deliver_split_address(address_item *);
 184 extern void    deliver_succeeded(address_item *);
 185
 186 extern uschar *deliver_get_sender_address (uschar *id);
 187 extern void    delivery_re_exec(int);
 188
 189 extern BOOL    directory_make(const uschar *, const uschar *, int, BOOL);
 190 #ifndef DISABLE_DKIM
 191 extern uschar *dkim_exim_query_dns_txt(const uschar *);
 192 extern void    dkim_exim_sign_init(void);
 193
 194 extern BOOL    dkim_transport_write_message(transport_ctx *,
 195                   struct ob_dkim *, const uschar ** errstr);
 196 #endif
 197 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
 198 extern int     dns_basic_lookup(dns_answer *, const uschar *, int);
 199 extern void    dns_build_reverse(const uschar *, uschar *);
 200 extern time_t  dns_expire_from_soa(dns_answer *);
 201 extern void    dns_init(BOOL, BOOL, BOOL);
 202 extern BOOL    dns_is_aa(const dns_answer *);
 203 extern BOOL    dns_is_secure(const dns_answer *);
 204 extern int     dns_lookup(dns_answer *, const uschar *, int, const uschar **);
 205 extern void    dns_pattern_init(void);
 206 extern int     dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
 207 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
 208 extern uschar *dns_text_type(int);
 209 extern void    dscp_list_to_stream(FILE *);
 210 extern BOOL    dscp_lookup(const uschar *, int, int *, int *, int *);
 211
 212 extern void    enq_end(uschar *);
 213 extern BOOL    enq_start(uschar *, unsigned);
 214 #ifndef DISABLE_EVENT
 215 extern uschar *event_raise(uschar *, const uschar *, uschar *);
 216 extern void    msg_event_raise(const uschar *, const address_item *);
 217 #endif
 218
 219 extern int     exim_chown_failure(int, const uschar*, uid_t, gid_t);
 220 extern const uschar * exim_errstr(int);
 221 extern void    exim_exit(int, const uschar *) NORETURN;
 222 extern void    exim_nullstd(void);
 223 extern void    exim_setugid(uid_t, gid_t, BOOL, uschar *);
 224 extern void    exim_underbar_exit(int);
 225 extern void    exim_wait_tick(struct timeval *, int);
 226 extern int     exp_bool(address_item *addr,
 227   uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
 228   uschar *svalue, BOOL *rvalue);
 229 extern BOOL    expand_check_condition(uschar *, uschar *, uschar *);
 230 extern uschar *expand_file_big_buffer(const uschar *);
 231 extern uschar *expand_string(uschar *); /* public, cannot make const */
 232 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
 233 extern uschar *expand_hide_passwords(uschar * );
 234 extern uschar *expand_string_copy(const uschar *);
 235 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
 236 extern void    modify_variable(uschar *, void *);
 237
 238 extern BOOL    fd_ready(int, time_t);
 239
 240 extern int     filter_interpret(uschar *, int, address_item **, uschar **);
 241 extern BOOL    filter_personal(string_item *, BOOL);
 242 extern BOOL    filter_runtest(int, uschar *, BOOL, BOOL);
 243 extern BOOL    filter_system_interpret(address_item **, uschar **);
 244
 245 extern uschar * fn_hdrs_added(void);
 246
 247 extern void    header_add(int, const char *, ...);
 248 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
 249 extern int     header_checkname(header_line *, BOOL);
 250 extern BOOL    header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
 251 extern int     host_address_extract_port(uschar *);
 252 extern uschar *host_and_ident(BOOL);
 253 extern int     host_aton(const uschar *, int *);
 254 extern void    host_build_hostlist(host_item **, const uschar *, BOOL);
 255 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
 256 extern void    host_build_log_info(void);
 257 extern void    host_build_sender_fullhost(void);
 258 extern int     host_find_byname(host_item *, const uschar *, int,
 259                                 const uschar **, BOOL);
 260 extern int     host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
 261                  uschar *, const dnssec_domains *, const uschar **, BOOL *);
 262 extern ip_address_item *host_find_interfaces(void);
 263 extern BOOL    host_is_in_net(const uschar *, const uschar *, int);
 264 extern BOOL    host_is_tls_on_connect_port(int);
 265 extern int     host_item_get_port(host_item *);
 266 extern void    host_mask(int, int *, int);
 267 extern int     host_name_lookup(void);
 268 extern int     host_nmtoa(int, int *, int, uschar *, int);
 269 extern uschar *host_ntoa(int, const void *, uschar *, int *);
 270 extern int     host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
 271
 272 extern uschar *imap_utf7_encode(uschar *, const uschar *,
 273                                  uschar, uschar *, uschar **);
 274
 275 extern void    invert_address(uschar *, uschar *);
 276 extern int     ip_addr(void *, int, const uschar *, int);
 277 extern int     ip_bind(int, int, uschar *, int);
 278 extern int     ip_connect(int, int, const uschar *, int, int, const blob *);
 279 extern int     ip_connectedsocket(int, const uschar *, int, int,
 280                  int, host_item *, uschar **, const blob *);
 281 extern int     ip_get_address_family(int);
 282 extern void    ip_keepalive(int, const uschar *, BOOL);
 283 extern int     ip_recv(client_conn_ctx *, uschar *, int, time_t);
 284 extern int     ip_socket(int, int);
 285
 286 extern int     ip_tcpsocket(const uschar *, uschar **, int);
 287 extern int     ip_unixsocket(const uschar *, uschar **);
 288 extern int     ip_streamsocket(const uschar *, uschar **, int);
 289
 290 extern int     ipv6_nmtoa(int *, uschar *);
 291
 292 extern uschar *local_part_quote(uschar *);
 293 extern int     log_create(uschar *);
 294 extern int     log_create_as_exim(uschar *);
 295 extern void    log_close_all(void);
 296
 297 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
 298 extern BOOL    macro_read_assignment(uschar *);
 299 extern uschar *macros_expand(int, int *, BOOL *);
 300 extern void    mainlog_close(void);
 301 #ifdef WITH_CONTENT_SCAN
 302 extern int     malware(const uschar *, int);
 303 extern int     malware_in_file(uschar *);
 304 extern void    malware_init(void);
 305 extern void    malware_show_supported(FILE *);
 306 #endif
 307 extern int     match_address_list(const uschar *, BOOL, BOOL, const uschar **,
 308                  unsigned int *, int, int, const uschar **);
 309 extern int     match_address_list_basic(const uschar *, const uschar **, int);
 310 extern int     match_check_list(const uschar **, int, tree_node **, unsigned int **,
 311                  int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
 312                  const uschar *, const uschar **);
 313 extern int     match_isinlist(const uschar *, const uschar **, int, tree_node **,
 314                  unsigned int *, int, BOOL, const uschar **);
 315 extern int     match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
 316                  const uschar **);
 317 extern void    md5_end(md5 *, const uschar *, int, uschar *);
 318 extern void    md5_mid(md5 *, const uschar *);
 319 extern void    md5_start(md5 *);
 320 extern void    millisleep(int);
 321 #ifdef WITH_CONTENT_SCAN
 322 struct mime_boundary_context;
 323 extern int     mime_acl_check(uschar *acl, FILE *f,
 324                  struct mime_boundary_context *, uschar **, uschar **);
 325 extern int     mime_decode(const uschar **);
 326 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
 327 extern int     mime_regex(const uschar **);
 328 extern void    mime_set_anomaly(int);
 329 #endif
 330 extern uschar *moan_check_errorcopy(uschar *);
 331 extern BOOL    moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
 332                  BOOL, uschar *);
 333 extern void    moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
 334 extern BOOL    moan_send_message(uschar *, int, error_block *eblock,
 335                  header_line *, FILE *, uschar *);
 336 extern void    moan_tell_someone(uschar *, address_item *,
 337                  const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
 338 extern BOOL    moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
 339 extern void    moan_write_from(FILE *);
 340 extern void    moan_write_references(FILE *, uschar *);
 341 extern FILE   *modefopen(const uschar *, const char *, mode_t);
 342
 343 extern int     open_cutthrough_connection( address_item * addr );
 344
 345 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
 346                  BOOL);
 347 extern int     parse_forward_list(uschar *, int, address_item **, uschar **,
 348                  const uschar *, uschar *, error_block **);
 349 extern uschar *parse_find_address_end(uschar *, BOOL);
 350 extern uschar *parse_find_at(uschar *);
 351 extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
 352 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
 353 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
 354 extern uschar *parse_date_time(uschar *str, time_t *t);
 355 extern int     vaguely_random_number(int);
 356 #ifndef DISABLE_TLS
 357 extern int     vaguely_random_number_fallback(int);
 358 #endif
 359
 360 extern BOOL    queue_action(uschar *, int, uschar **, int, int);
 361 extern void    queue_check_only(void);
 362 extern void    queue_list(int, uschar **, int);
 363 extern void    queue_count(void);
 364 extern void    queue_run(uschar *, uschar *, BOOL);
 365
 366 extern int     random_number(int);
 367 extern const uschar *rc_to_string(int);
 368 extern int     rda_interpret(redirect_block *, int, uschar *, uschar *,
 369                  uschar *, uschar *, uschar *, ugid_block *, address_item **,
 370                  uschar **, error_block **, int *, uschar *);
 371 extern int     rda_is_filter(const uschar *);
 372 extern BOOL    readconf_depends(driver_instance *, uschar *);
 373 extern void    readconf_driver_init(uschar *, driver_instance **,
 374                  driver_info *, int, void *, int, optionlist *, int);
 375 extern uschar *readconf_find_option(void *);
 376 extern void    readconf_main(BOOL);
 377 extern void    readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
 378 extern BOOL    readconf_print(uschar *, uschar *, BOOL);
 379 extern uschar *readconf_printtime(int);
 380 extern uschar *readconf_readname(uschar *, int, uschar *);
 381 extern int     readconf_readtime(const uschar *, int, BOOL);
 382 extern void    readconf_rest(void);
 383 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
 384 extern void    readconf_save_config(const uschar *);
 385 extern void    read_message_body(BOOL);
 386 extern void    receive_bomb_out(uschar *, uschar *) NORETURN;
 387 extern BOOL    receive_check_fs(int);
 388 extern BOOL    receive_check_set_sender(uschar *);
 389 extern BOOL    receive_msg(BOOL);
 390 extern int_eximarith_t receive_statvfs(BOOL, int *);
 391 extern void    receive_swallow_smtp(void);
 392 #ifdef WITH_CONTENT_SCAN
 393 extern int     regex(const uschar **);
 394 #endif
 395 extern BOOL    regex_match_and_setup(const pcre *, const uschar *, int, int);
 396 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
 397 extern void    retry_add_item(address_item *, uschar *, int);
 398 extern BOOL    retry_check_address(const uschar *, host_item *, uschar *, BOOL,
 399                  uschar **, uschar **);
 400 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
 401 extern BOOL    retry_ultimate_address_timeout(uschar *, const uschar *,
 402                  dbdata_retry *, time_t);
 403 extern void    retry_update(address_item **, address_item **, address_item **);
 404 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
 405 extern uschar *rewrite_address_qualify(uschar *, BOOL);
 406 extern header_line *rewrite_header(header_line *,
 407                const uschar *, const uschar *,
 408                rewrite_rule *, int, BOOL);
 409 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
 410                  rewrite_rule *);
 411 extern void    rewrite_test(uschar *);
 412 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
 413                  uschar **);
 414 extern int     route_address(address_item *, address_item **, address_item **,
 415                  address_item **, address_item **, int);
 416 extern int     route_check_prefix(const uschar *, const uschar *);
 417 extern int     route_check_suffix(const uschar *, const uschar *);
 418 extern BOOL    route_findgroup(uschar *, gid_t *);
 419 extern BOOL    route_finduser(const uschar *, struct passwd **, uid_t *);
 420 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 421                  uschar **);
 422 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 423                  struct passwd **, uid_t *, uschar **);
 424 extern void    route_init(void);
 425 extern void    route_show_supported(FILE *);
 426 extern void    route_tidyup(void);
 427
 428 extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
 429                  int, int *);
 430 extern int     search_findtype(const uschar *, int);
 431 extern int     search_findtype_partial(const uschar *, int *, const uschar **, int *,
 432                  int *);
 433 extern void   *search_open(uschar *, int, int, uid_t *, gid_t *);
 434 extern void    search_tidyup(void);
 435 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
 436 extern void    sha1_end(hctx *, const uschar *, int, uschar *);
 437 extern void    sha1_mid(hctx *, const uschar *);
 438 extern void    sha1_start(hctx *);
 439 extern int     sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
 440                  uschar *, address_item **, uschar **);
 441 extern void    sigalrm_handler(int);
 442 extern BOOL    smtp_buffered(void);
 443 extern void    smtp_closedown(uschar *);
 444 extern void    smtp_command_timeout_exit(void) NORETURN;
 445 extern void    smtp_command_sigterm_exit(void) NORETURN;
 446 extern void    smtp_data_timeout_exit(void) NORETURN;
 447 extern void    smtp_data_sigint_exit(void) NORETURN;
 448 extern uschar *smtp_cmd_hist(void);
 449 extern int     smtp_connect(smtp_connect_args *, const blob *);
 450 extern int     smtp_sock_connect(host_item *, int, int, uschar *,
 451                  transport_instance * tb, int, const blob *);
 452 extern int     smtp_feof(void);
 453 extern int     smtp_ferror(void);
 454 extern uschar *smtp_get_connection_info(void);
 455 extern BOOL    smtp_get_interface(uschar *, int, address_item *,
 456                  uschar **, uschar *);
 457 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 458 extern int     smtp_getc(unsigned);
 459 extern uschar *smtp_getbuf(unsigned *);
 460 extern void    smtp_get_cache(void);
 461 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 462 extern void    smtp_log_no_mail(void);
 463 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
 464 extern void    smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
 465 extern BOOL    smtp_read_response(void *, uschar *, int, int, int);
 466 extern void   *smtp_reset(void *);
 467 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 468 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
 469 extern void    smtp_port_for_connect(host_item *, int);
 470 extern void    smtp_send_prohibition_message(int, uschar *);
 471 extern int     smtp_setup_msg(void);
 472 extern BOOL    smtp_start_session(void);
 473 extern int     smtp_ungetc(int);
 474 extern BOOL    smtp_verify_helo(void);
 475 extern int     smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
 476 #ifdef WITH_CONTENT_SCAN
 477 extern int     spam(const uschar **);
 478 extern FILE   *spool_mbox(unsigned long *, const uschar *, uschar **);
 479 #endif
 480 extern void    spool_clear_header_globals(void);
 481 extern BOOL    spool_move_message(uschar *, uschar *, uschar *, uschar *);
 482 extern int     spool_open_datafile(uschar *);
 483 extern int     spool_open_temp(uschar *);
 484 extern int     spool_read_header(uschar *, BOOL, BOOL);
 485 extern int     spool_write_header(uschar *, int, uschar **);
 486 extern int     stdin_getc(unsigned);
 487 extern int     stdin_feof(void);
 488 extern int     stdin_ferror(void);
 489 extern int     stdin_ungetc(int);
 490
 491 extern void    store_exit(void);
 492 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
 493 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
 494 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
 495 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
 496 extern uschar *string_base62(unsigned long int);
 497 extern gstring *string_cat (gstring *, const uschar *     ) WARN_UNUSED_RESULT;
 498 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
 499 extern int     string_compare_by_pointer(const void *, const void *);
 500 extern uschar *string_copy_dnsdomain(uschar *);
 501 extern uschar *string_copy_malloc(const uschar *);
 502 extern uschar *string_dequote(const uschar **);
 503 extern uschar *string_format_size(int, uschar *);
 504 extern int     string_interpret_escape(const uschar **);
 505 extern int     string_is_ip_address(const uschar *, int *);
 506 #ifdef SUPPORT_I18N
 507 extern BOOL    string_is_utf8(const uschar *);
 508 #endif
 509 extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
 510 extern const uschar *string_printing2(const uschar *, BOOL);
 511 extern uschar *string_split_message(uschar *);
 512 extern uschar *string_unprinting(uschar *);
 513 #ifdef SUPPORT_I18N
 514 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
 515 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
 516 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
 517 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
 518 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
 519 #endif
 520
 521 #define string_format(buf, siz, fmt, ...) \
 522         string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 523 extern BOOL    string_format_trc(uschar *, int, const uschar *, unsigned,
 524                         const char *, ...) ALMOST_PRINTF(5,6);
 525
 526 #define string_vformat(g, flgs, fmt, ap) \
 527         string_vformat_trc(g, US __FUNCTION__, __LINE__, \
 528                          STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
 529 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
 530                         unsigned, unsigned, const char *, va_list);
 531
 532 #define string_open_failed(eno, fmt, ...) \
 533         string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 534 extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
 535                         const char *, ...) PRINTF_FUNCTION(4,5);
 536
 537 extern int     strcmpic(const uschar *, const uschar *);
 538 extern int     strncmpic(const uschar *, const uschar *, int);
 539 extern uschar *strstric(uschar *, uschar *, BOOL);
 540
 541 #ifdef EXIM_TFO_PROBE
 542 extern void    tfo_probe(void);
 543 #endif
 544 extern void    tls_modify_variables(tls_support *);
 545 extern uschar *tod_stamp(int);
 546
 547 extern BOOL    transport_check_waiting(const uschar *, const uschar *, int, uschar *,
 548                  BOOL *, oicf, void*);
 549 extern void    transport_init(void);
 550 extern void    transport_do_pass_socket(const uschar *, const uschar *,
 551                  const uschar *, uschar *, int);
 552 extern BOOL    transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
 553                  int);
 554 extern uschar *transport_rcpt_address(address_item *, BOOL);
 555 extern BOOL    transport_set_up_command(const uschar ***, uschar *,
 556                  BOOL, int, address_item *, uschar *, uschar **);
 557 extern void    transport_update_waiting(host_item *, uschar *);
 558 extern BOOL    transport_write_block(transport_ctx *, uschar *, int, BOOL);
 559 extern void    transport_write_reset(int);
 560 extern BOOL    transport_write_string(int, const char *, ...);
 561 extern BOOL    transport_headers_send(transport_ctx *,
 562                  BOOL (*)(transport_ctx *, uschar *, int));
 563 extern void    transport_show_supported(FILE *);
 564 extern BOOL    transport_write_message(transport_ctx *, int);
 565 extern void    tree_add_duplicate(uschar *, address_item *);
 566 extern void    tree_add_nonrecipient(uschar *);
 567 extern void    tree_add_unusable(host_item *);
 568 extern void    tree_dup(tree_node **, tree_node *);
 569 extern int     tree_insertnode(tree_node **, tree_node *);
 570 extern tree_node *tree_search(tree_node *, const uschar *);
 571 extern void    tree_write(tree_node *, FILE *);
 572 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 573
 574 #ifdef WITH_CONTENT_SCAN
 575 extern void    unspool_mbox(void);
 576 #endif
 577 #ifdef SUPPORT_I18N
 578 extern void    utf8_version_report(FILE *);
 579 #endif
 580
 581 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 582                  uschar *, uschar *, BOOL *);
 583 extern int     verify_check_dnsbl(int, const uschar **, uschar **);
 584 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 585                  uschar *, uschar *, int, int *);
 586 extern int     verify_check_headers(uschar **);
 587 extern int     verify_check_header_names_ascii(uschar **);
 588 extern int     verify_check_host(uschar **);
 589 extern int     verify_check_notblind(BOOL);
 590 extern int     verify_check_given_host(const uschar **, const host_item *);
 591 extern int     verify_check_this_host(const uschar **, unsigned int *,
 592                  const uschar*, const uschar *, const uschar **);
 593 extern address_item *verify_checked_sender(uschar *);
 594 extern void    verify_get_ident(int);
 595 extern BOOL    verify_sender(int *, uschar **);
 596 extern BOOL    verify_sender_preliminary(int *, uschar **);
 597 extern void    version_init(void);
 598
 599 extern BOOL    write_chunk(transport_ctx *, uschar *, int);
 600 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
 601
 602
 603 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
 604 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
 605 chown(<exim-uid>, <exim-gid>).
 606
 607 Probably because the idmapping is broken, misconfigured or set up in
 608 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
 609 case of misconfiguration, or if there are more such broken systems
 610 out, I try to impose as least impact as possible and for now just write
 611 a panic log entry pointing to the bug report. You're encouraged to
 612 contact the developers, if you experience this issue.
 613
 614 fd     the file descriptor (or -1 if not valid)
 615 name   the file name for error messages or for file operations,
 616   if fd is < 0
 617 owner  the owner
 618 group  the group
 619
 620 returns 0 on success, -1 on failure */
 621
 622 static inline int
 623 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
 624 {
 625 return fchown(fd, owner, group)
 626   ? exim_chown_failure(fd, name, owner, group) : 0;
 627 }
 628
 629 static inline int
 630 exim_chown(const uschar *name, uid_t owner, gid_t group)
 631 {
 632 return chown(CCS name, owner, group)
 633   ? exim_chown_failure(-1, name, owner, group) : 0;
 634 }
 635
 636 #endif  /* !MACRO_PREDEF && !COMPILE_UTILITY */
 637 /******************************************************************************/
 638 /* String functions */
 639
 640 #if !defined(MACRO_PREDEF)
 641 /*************************************************
 642 *            Copy and save string                *
 643 *************************************************/
 644
 645 /* This function assumes that memcpy() is faster than strcpy().
 646 */
 647
 648 static inline uschar *
 649 string_copy_taint_trc(const uschar *s, BOOL tainted, const char * func, int line)
 650 {
 651 int len = Ustrlen(s) + 1;
 652 uschar *ss = store_get_3(len, tainted, func, line);
 653 memcpy(ss, s, len);
 654 return ss;
 655 }
 656
 657 #define string_copy_taint(s, tainted) \
 658         string_copy_taint_trc((s), tainted, __FUNCTION__, __LINE__)
 659
 660 static inline uschar *
 661 string_copy(const uschar * s)
 662 {
 663 return string_copy_taint((s), is_tainted(s));
 664 }
 665
 666
 667 /*************************************************
 668 *       Copy, lowercase and save string          *
 669 *************************************************/
 670
 671 /*
 672 Argument: string to copy
 673 Returns:  copy of string in new store, with letters lowercased
 674 */
 675
 676 static inline uschar *
 677 string_copylc(const uschar *s)
 678 {
 679 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
 680 uschar *p = ss;
 681 while (*s != 0) *p++ = tolower(*s++);
 682 *p = 0;
 683 return ss;
 684 }
 685
 686
 687
 688 /*************************************************
 689 *       Copy and save string, given length       *
 690 *************************************************/
 691
 692 /* It is assumed the data contains no zeros. A zero is added
 693 onto the end.
 694
 695 Arguments:
 696   s         string to copy
 697   n         number of characters
 698
 699 Returns:    copy of string in new store
 700
 701 This is an API for local_scan hence not static.
 702 */
 703
 704 static inline uschar *
 705 string_copyn(const uschar *s, int n)
 706 {
 707 uschar *ss = store_get(n + 1, is_tainted(s));
 708 Ustrncpy(ss, s, n);
 709 ss[n] = 0;
 710 return ss;
 711 }
 712
 713 /*************************************************
 714 * Copy, lowercase, and save string, given length *
 715 *************************************************/
 716
 717 /* It is assumed the data contains no zeros. A zero is added
 718 onto the end.
 719
 720 Arguments:
 721   s         string to copy
 722   n         number of characters
 723
 724 Returns:    copy of string in new store, with letters lowercased
 725 */
 726
 727 static inline uschar *
 728 string_copynlc(uschar *s, int n)
 729 {
 730 uschar *ss = store_get(n + 1, is_tainted(s));
 731 uschar *p = ss;
 732 while (n-- > 0) *p++ = tolower(*s++);
 733 *p = 0;
 734 return ss;
 735 }
 736
 737
 738 # ifndef COMPILE_UTILITY
 739 /*************************************************
 740 *     Copy and save string in longterm store     *
 741 *************************************************/
 742
 743 /* This function assumes that memcpy() is faster than strcpy().
 744
 745 Argument: string to copy
 746 Returns:  copy of string in new store
 747 */
 748
 749 static inline uschar *
 750 string_copy_perm(const uschar *s, BOOL force_taint)
 751 {
 752 int old_pool = store_pool;
 753 int len = Ustrlen(s) + 1;
 754 uschar *ss;
 755
 756 store_pool = POOL_PERM;
 757 ss = store_get(len, force_taint || is_tainted(s));
 758 memcpy(ss, s, len);
 759 store_pool = old_pool;
 760 return ss;
 761 }
 762 # endif
 763
 764
 765
 766 /* sprintf into a buffer, taint-unchecked */
 767
 768 static inline void
 769 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
 770 {
 771 gstring gs = { .size = siz, .ptr = 0, .s = buf };
 772 va_list ap;
 773 va_start(ap, fmt);
 774 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
 775 va_end(ap);
 776 }
 777
 778
 779
 780 /******************************************************************************/
 781 /* Growable-string functions */
 782
 783 /* Create a growable-string with some preassigned space */
 784
 785 #define string_get_tainted(size, tainted) \
 786         string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
 787
 788 static inline gstring *
 789 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
 790 {
 791 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
 792 g->size = size;
 793 g->ptr = 0;
 794 g->s = US(g + 1);
 795 return g;
 796 }
 797
 798 #define string_get(size) \
 799         string_get_trc((size), __FUNCTION__, __LINE__)
 800
 801 static inline gstring *
 802 string_get_trc(unsigned size, const char * func, unsigned line)
 803 {
 804 return string_get_tainted_trc(size, FALSE, func, line);
 805 }
 806
 807 /* NUL-terminate the C string in the growable-string, and return it. */
 808
 809 static inline uschar *
 810 string_from_gstring(gstring * g)
 811 {
 812 if (!g) return NULL;
 813 g->s[g->ptr] = '\0';
 814 return g->s;
 815 }
 816
 817
 818 #define gstring_release_unused(g) \
 819         gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
 820
 821 static inline void
 822 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
 823 {
 824 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
 825 }
 826
 827
 828 /* sprintf-append to a growable-string */
 829
 830 #define string_fmt_append(g, fmt, ...) \
 831         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
 832         SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
 833
 834 #define string_fmt_append_f(g, flgs, fmt, ...) \
 835         string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
 836         flgs,         fmt, __VA_ARGS__)
 837
 838 static inline gstring *
 839 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
 840   unsigned flags, const char *format, ...)
 841 {
 842 va_list ap;
 843 va_start(ap, format);
 844 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
 845                         flags, format, ap);
 846 va_end(ap);
 847 return g;
 848 }
 849
 850 /******************************************************************************/
 851
 852 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
 853
 854 static inline dns_answer *
 855 store_get_dns_answer_trc(const uschar * func, unsigned line)
 856 {
 857 return store_get_3(sizeof(dns_answer), TRUE, CCS func, line);  /* use tainted mem */
 858 }
 859
 860 /******************************************************************************/
 861 /* Routines with knowledge of spool layout */
 862
 863 # ifndef COMPILE_UTILITY
 864 static inline void
 865 spool_pname_buf(uschar * buf, int len)
 866 {
 867 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
 868 }
 869
 870 static inline uschar *
 871 spool_dname(const uschar * purpose, uschar * subdir)
 872 {
 873 return string_sprintf("%s/%s/%s/%s",
 874         spool_directory, queue_name, purpose, subdir);
 875 }
 876 # endif
 877
 878 static inline uschar *
 879 spool_sname(const uschar * purpose, uschar * subdir)
 880 {
 881 return string_sprintf("%s%s%s%s%s",
 882                     queue_name, *queue_name ? "/" : "",
 883                     purpose,
 884                     *subdir ? "/" : "", subdir);
 885 }
 886
 887 static inline uschar *
 888 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
 889         const uschar * suffix)
 890 {
 891 return string_sprintf("%s/%s/%s/%s/%s%s",
 892         spool_directory, queue_name, purpose, subdir, fname, suffix);
 893 }
 894
 895 static inline void
 896 set_subdir_str(uschar * subdir_str, const uschar * name,
 897         int search_sequence)
 898 {
 899 subdir_str[0] = split_spool_directory == (search_sequence == 0)
 900        ? name[5] : '\0';
 901 subdir_str[1] = '\0';
 902 }
 903
 904 /******************************************************************************/
 905 static inline void
 906 timesince(struct timeval * diff, struct timeval * then)
 907 {
 908 gettimeofday(diff, NULL);
 909 diff->tv_sec -= then->tv_sec;
 910 if ((diff->tv_usec -= then->tv_usec) < 0)
 911   {
 912   diff->tv_sec--;
 913   diff->tv_usec += 1000*1000;
 914   }
 915 }
 916
 917 static inline uschar *
 918 string_timediff(struct timeval * diff)
 919 {
 920 static uschar buf[sizeof("0.000s")];
 921
 922 if (diff->tv_sec >= 5 || !LOGGING(millisec))
 923   return readconf_printtime((int)diff->tv_sec);
 924
 925 sprintf(CS buf, "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
 926 return buf;
 927 }
 928
 929
 930 static inline uschar *
 931 string_timesince(struct timeval * then)
 932 {
 933 struct timeval diff;
 934 timesince(&diff, then);
 935 return string_timediff(&diff);
 936 }
 937
 938 static inline void
 939 report_time_since(struct timeval * t0, uschar * where)
 940 {
 941 # ifdef MEASURE_TIMING
 942 struct timeval diff;
 943 timesince(&diff, t0);
 944 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
 945        (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
 946 # endif
 947 }
 948
 949
 950 static inline void
 951 testharness_pause_ms(int millisec)
 952 {
 953 #ifndef MEASURE_TIMING
 954 if (f.running_in_test_harness) millisleep(millisec);
 955 #endif
 956 }
 957
 958 #endif  /* !MACRO_PREDEF */
 959
 960 #endif  /* _FUNCTIONS_H_ */
 961
 962 /* vi: aw
 963 */
 964 /* End of functions.h */