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
  17 #ifdef EXIM_PERL
  18 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
  19                  uschar **) WARN_UNUSED_RESULT;
  20 extern void    cleanup_perl(void);
  21 extern uschar *init_perl(uschar *);
  22 #endif
  23
  24
  25 #ifdef SUPPORT_TLS
  26 extern const char *
  27                std_dh_prime_default(void);
  28 extern const char *
  29                std_dh_prime_named(const uschar *);
  30
  31 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
  32 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
  33 extern uschar * tls_cert_issuer(void *, uschar * mod);
  34 extern uschar * tls_cert_not_before(void *, uschar * mod);
  35 extern uschar * tls_cert_not_after(void *, uschar * mod);
  36 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
  37 extern uschar * tls_cert_serial_number(void *, uschar * mod);
  38 extern uschar * tls_cert_signature(void *, uschar * mod);
  39 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
  40 extern uschar * tls_cert_subject(void *, uschar * mod);
  41 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
  42 extern uschar * tls_cert_version(void *, uschar * mod);
  43
  44 extern uschar * tls_cert_der_b64(void * cert);
  45 extern uschar * tls_cert_fprt_md5(void *);
  46 extern uschar * tls_cert_fprt_sha1(void *);
  47 extern uschar * tls_cert_fprt_sha256(void *);
  48
  49 extern BOOL    tls_client_start(client_conn_ctx *, smtp_connect_args *,
  50                   void *, tls_support *, uschar **);
  51
  52 extern void    tls_close(void *, int);
  53 extern BOOL    tls_could_read(void);
  54 extern int     tls_export_cert(uschar *, size_t, void *);
  55 extern int     tls_feof(void);
  56 extern int     tls_ferror(void);
  57 extern void    tls_free_cert(void **);
  58 extern int     tls_getc(unsigned);
  59 extern uschar *tls_getbuf(unsigned *);
  60 extern void    tls_get_cache(void);
  61 extern int     tls_import_cert(const uschar *, void **);
  62 extern int     tls_read(void *, uschar *, size_t);
  63 extern int     tls_server_start(const uschar *, uschar **);
  64 extern BOOL    tls_smtp_buffered(void);
  65 extern int     tls_ungetc(int);
  66 extern int     tls_write(void *, const uschar *, size_t, BOOL);
  67 extern uschar *tls_validate_require_cipher(void);
  68 extern void    tls_version_report(FILE *);
  69 # ifndef USE_GNUTLS
  70 extern BOOL    tls_openssl_options_parse(uschar *, long *);
  71 # endif
  72 extern uschar * tls_field_from_dn(uschar *, const uschar *);
  73 extern BOOL    tls_is_name_for_cert(const uschar *, void *);
  74
  75 # ifdef SUPPORT_DANE
  76 extern int     tlsa_lookup(const host_item *, dns_answer *, BOOL);
  77 # endif
  78
  79 #endif  /*SUPPORT_TLS*/
  80
  81
  82 /* Everything else... */
  83
  84 extern acl_block *acl_read(uschar *(*)(void), uschar **);
  85 extern int     acl_check(int, uschar *, uschar *, uschar **, uschar **);
  86 extern int     acl_eval(int, uschar *, uschar **, uschar **);
  87
  88 extern tree_node *acl_var_create(uschar *);
  89 extern void    acl_var_write(uschar *, uschar *, void *);
  90
  91 #ifdef EXPERIMENTAL_ARC
  92 extern void   *arc_ams_setup_sign_bodyhash(void);
  93 extern const uschar *arc_header_feed(gstring *, BOOL);
  94 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
  95 extern void     arc_sign_init(void);
  96 extern const uschar *acl_verify_arc(void);
  97 extern uschar * fn_arc_domains(void);
  98 #endif
  99
 100 extern void    assert_no_variables(void *, int, const char *, int);
 101 extern int     auth_call_pam(const uschar *, uschar **);
 102 extern int     auth_call_pwcheck(uschar *, uschar **);
 103 extern int     auth_call_radius(const uschar *, uschar **);
 104 extern int     auth_call_saslauthd(const uschar *, const uschar *,
 105                  const uschar *, const uschar *, uschar **);
 106 extern int     auth_check_serv_cond(auth_instance *);
 107 extern int     auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
 108 extern int     auth_client_item(void *, auth_instance *, const uschar **,
 109                  unsigned, int, uschar *, int);
 110
 111
 112 extern int     auth_get_data(uschar **, const uschar *, int);
 113 extern int     auth_get_no64_data(uschar **, uschar *);
 114 extern int     auth_prompt(const uschar *);
 115 extern int     auth_read_input(const uschar *);
 116 extern void    auth_show_supported(FILE *);
 117 extern uschar *auth_xtextencode(uschar *, int);
 118 extern int     auth_xtextdecode(uschar *, uschar **);
 119
 120 #ifdef EXPERIMENTAL_ARC
 121 extern gstring *authres_arc(gstring *);
 122 #endif
 123 #ifndef DISABLE_DKIM
 124 extern gstring *authres_dkim(gstring *);
 125 #endif
 126 #ifdef EXPERIMENTAL_DMARC
 127 extern gstring *authres_dmarc(gstring *);
 128 #endif
 129 extern gstring *authres_smtpauth(gstring *);
 130 #ifdef SUPPORT_SPF
 131 extern gstring *authres_spf(gstring *);
 132 #endif
 133
 134 extern uschar *b64encode(const uschar *, int);
 135 extern int     b64decode(const uschar *, uschar **);
 136 extern int     bdat_getc(unsigned);
 137 extern uschar *bdat_getbuf(unsigned *);
 138 extern int     bdat_ungetc(int);
 139 extern void    bdat_flush_data(void);
 140
 141 extern void    bits_clear(unsigned int *, size_t, int *);
 142 extern void    bits_set(unsigned int *, size_t, int *);
 143
 144 extern void    cancel_cutthrough_connection(BOOL, const uschar *);
 145 extern int     check_host(void *, const uschar *, const uschar **, uschar **);
 146 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
 147 extern pid_t   child_open_uid(const uschar **, const uschar **, int,
 148                  uid_t *, gid_t *, int *, int *, uschar *, BOOL);
 149 extern BOOL    cleanup_environment(void);
 150 extern void    cutthrough_data_puts(uschar *, int);
 151 extern void    cutthrough_data_put_nl(void);
 152 extern uschar *cutthrough_finaldot(void);
 153 extern BOOL    cutthrough_flush_send(void);
 154 extern BOOL    cutthrough_headers_send(void);
 155 extern BOOL    cutthrough_predata(void);
 156 extern void    release_cutthrough_connection(const uschar *);
 157
 158 extern void    daemon_go(void);
 159
 160 #ifdef EXPERIMENTAL_DCC
 161 extern int     dcc_process(uschar **);
 162 #endif
 163
 164 extern void    debug_logging_activate(uschar *, uschar *);
 165 extern void    debug_logging_stop(void);
 166 extern void    debug_print_argv(const uschar **);
 167 extern void    debug_print_ids(uschar *);
 168 extern void    debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
 169 extern void    debug_print_string(uschar *);
 170 extern void    debug_print_tree(tree_node *);
 171 extern void    debug_vprintf(int, const char *, va_list);
 172 extern void    decode_bits(unsigned int *, size_t, int *,
 173                    uschar *, bit_table *, int, uschar *, int);
 174 extern address_item *deliver_make_addr(uschar *, BOOL);
 175 extern void    deliver_init(void);
 176 extern void    delivery_log(int, address_item *, int, uschar *);
 177 extern int     deliver_message(uschar *, BOOL, BOOL);
 178 extern void    deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
 179 extern void    deliver_set_expansions(address_item *);
 180 extern int     deliver_split_address(address_item *);
 181 extern void    deliver_succeeded(address_item *);
 182
 183 extern uschar *deliver_get_sender_address (uschar *id);
 184 extern void    delivery_re_exec(int);
 185
 186 extern BOOL    directory_make(const uschar *, const uschar *, int, BOOL);
 187 #ifndef DISABLE_DKIM
 188 extern uschar *dkim_exim_query_dns_txt(uschar *);
 189 extern void    dkim_exim_sign_init(void);
 190
 191 extern BOOL    dkim_transport_write_message(transport_ctx *,
 192                   struct ob_dkim *, const uschar ** errstr);
 193 #endif
 194 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
 195 extern int     dns_basic_lookup(dns_answer *, const uschar *, int);
 196 extern void    dns_build_reverse(const uschar *, uschar *);
 197 extern void    dns_init(BOOL, BOOL, BOOL);
 198 extern BOOL    dns_is_aa(const dns_answer *);
 199 extern BOOL    dns_is_secure(const dns_answer *);
 200 extern int     dns_lookup(dns_answer *, const uschar *, int, const uschar **);
 201 extern void    dns_pattern_init(void);
 202 extern int     dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
 203 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
 204 extern uschar *dns_text_type(int);
 205 extern void    dscp_list_to_stream(FILE *);
 206 extern BOOL    dscp_lookup(const uschar *, int, int *, int *, int *);
 207
 208 extern void    enq_end(uschar *);
 209 extern BOOL    enq_start(uschar *, unsigned);
 210 #ifndef DISABLE_EVENT
 211 extern uschar *event_raise(uschar *, const uschar *, uschar *);
 212 extern void    msg_event_raise(const uschar *, const address_item *);
 213 #endif
 214
 215 extern int     exim_chown_failure(int, const uschar*, uid_t, gid_t);
 216 inline int     exim_chown(const uschar*, uid_t, gid_t);
 217 inline int     exim_fchown(int, uid_t, gid_t, const uschar*);
 218 extern const uschar * exim_errstr(int);
 219 extern void    exim_exit(int, const uschar *);
 220 extern void    exim_nullstd(void);
 221 extern void    exim_setugid(uid_t, gid_t, BOOL, uschar *);
 222 extern void    exim_wait_tick(struct timeval *, int);
 223 extern int     exp_bool(address_item *addr,
 224   uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
 225   uschar *svalue, BOOL *rvalue);
 226 extern BOOL    expand_check_condition(uschar *, uschar *, uschar *);
 227 extern uschar *expand_file_big_buffer(const uschar *);
 228 extern uschar *expand_string(uschar *); /* public, cannot make const */
 229 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
 230 extern uschar *expand_hide_passwords(uschar * );
 231 extern uschar *expand_string_copy(const uschar *);
 232 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
 233 extern void    modify_variable(uschar *, void *);
 234
 235 extern BOOL    fd_ready(int, int);
 236
 237 extern int     filter_interpret(uschar *, int, address_item **, uschar **);
 238 extern BOOL    filter_personal(string_item *, BOOL);
 239 extern BOOL    filter_runtest(int, uschar *, BOOL, BOOL);
 240 extern BOOL    filter_system_interpret(address_item **, uschar **);
 241
 242 extern uschar * fn_hdrs_added(void);
 243
 244 extern void    gstring_reset_unused(gstring *);
 245
 246 extern void    header_add(int, const char *, ...);
 247 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
 248 extern int     header_checkname(header_line *, BOOL);
 249 extern BOOL    header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
 250 extern int     host_address_extract_port(uschar *);
 251 extern uschar *host_and_ident(BOOL);
 252 extern int     host_aton(const uschar *, int *);
 253 extern void    host_build_hostlist(host_item **, const uschar *, BOOL);
 254 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
 255 extern void    host_build_log_info(void);
 256 extern void    host_build_sender_fullhost(void);
 257 extern int     host_find_byname(host_item *, const uschar *, int,
 258                                 const uschar **, BOOL);
 259 extern int     host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
 260                  uschar *, const dnssec_domains *, const uschar **, BOOL *);
 261 extern ip_address_item *host_find_interfaces(void);
 262 extern BOOL    host_is_in_net(const uschar *, const uschar *, int);
 263 extern BOOL    host_is_tls_on_connect_port(int);
 264 extern int     host_item_get_port(host_item *);
 265 extern void    host_mask(int, int *, int);
 266 extern int     host_name_lookup(void);
 267 extern int     host_nmtoa(int, int *, int, uschar *, int);
 268 extern uschar *host_ntoa(int, const void *, uschar *, int *);
 269 extern int     host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
 270
 271 extern uschar *imap_utf7_encode(uschar *, const uschar *,
 272                                  uschar, uschar *, uschar **);
 273
 274 extern void    invert_address(uschar *, uschar *);
 275 extern int     ip_addr(void *, int, const uschar *, int);
 276 extern int     ip_bind(int, int, uschar *, int);
 277 extern int     ip_connect(int, int, const uschar *, int, int, const blob *);
 278 extern int     ip_connectedsocket(int, const uschar *, int, int,
 279                  int, host_item *, uschar **, const blob *);
 280 extern int     ip_get_address_family(int);
 281 extern void    ip_keepalive(int, const uschar *, BOOL);
 282 extern int     ip_recv(client_conn_ctx *, uschar *, int, int);
 283 extern int     ip_socket(int, int);
 284
 285 extern int     ip_tcpsocket(const uschar *, uschar **, int);
 286 extern int     ip_unixsocket(const uschar *, uschar **);
 287 extern int     ip_streamsocket(const uschar *, uschar **, int);
 288
 289 extern int     ipv6_nmtoa(int *, uschar *);
 290
 291 extern uschar *local_part_quote(uschar *);
 292 extern int     log_create(uschar *);
 293 extern int     log_create_as_exim(uschar *);
 294 extern void    log_close_all(void);
 295
 296 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
 297 extern BOOL    macro_read_assignment(uschar *);
 298 extern uschar *macros_expand(int, int *, BOOL *);
 299 extern void    mainlog_close(void);
 300 #ifdef WITH_CONTENT_SCAN
 301 extern int     malware(const uschar *, int);
 302 extern int     malware_in_file(uschar *);
 303 extern void    malware_init(void);
 304 extern void    malware_show_supported(FILE *);
 305 #endif
 306 extern int     match_address_list(const uschar *, BOOL, BOOL, const uschar **,
 307                  unsigned int *, int, int, const uschar **);
 308 extern int     match_address_list_basic(const uschar *, const uschar **, int);
 309 extern int     match_check_list(const uschar **, int, tree_node **, unsigned int **,
 310                  int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
 311                  const uschar *, const uschar **);
 312 extern int     match_isinlist(const uschar *, const uschar **, int, tree_node **,
 313                  unsigned int *, int, BOOL, const uschar **);
 314 extern int     match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
 315                  const uschar **);
 316 extern void    md5_end(md5 *, const uschar *, int, uschar *);
 317 extern void    md5_mid(md5 *, const uschar *);
 318 extern void    md5_start(md5 *);
 319 extern void    millisleep(int);
 320 #ifdef WITH_CONTENT_SCAN
 321 struct mime_boundary_context;
 322 extern int     mime_acl_check(uschar *acl, FILE *f,
 323                  struct mime_boundary_context *, uschar **, uschar **);
 324 extern int     mime_decode(const uschar **);
 325 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
 326 extern int     mime_regex(const uschar **);
 327 extern void    mime_set_anomaly(int);
 328 #endif
 329 extern uschar *moan_check_errorcopy(uschar *);
 330 extern BOOL    moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
 331                  BOOL, uschar *);
 332 extern void    moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
 333 extern BOOL    moan_send_message(uschar *, int, error_block *eblock,
 334                  header_line *, FILE *, uschar *);
 335 extern void    moan_tell_someone(uschar *, address_item *,
 336                  const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
 337 extern BOOL    moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
 338 extern void    moan_write_from(FILE *);
 339 extern FILE   *modefopen(const uschar *, const char *, mode_t);
 340
 341 extern int     open_cutthrough_connection( address_item * addr );
 342
 343 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
 344                  BOOL);
 345 extern int     parse_forward_list(uschar *, int, address_item **, uschar **,
 346                  const uschar *, uschar *, error_block **);
 347 extern uschar *parse_find_address_end(uschar *, BOOL);
 348 extern uschar *parse_find_at(uschar *);
 349 extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
 350 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
 351 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
 352 extern uschar *parse_date_time(uschar *str, time_t *t);
 353 extern int     vaguely_random_number(int);
 354 #ifdef SUPPORT_TLS
 355 extern int     vaguely_random_number_fallback(int);
 356 #endif
 357
 358 extern BOOL    queue_action(uschar *, int, uschar **, int, int);
 359 extern void    queue_check_only(void);
 360 extern void    queue_list(int, uschar **, int);
 361 extern void    queue_count(void);
 362 extern void    queue_run(uschar *, uschar *, BOOL);
 363
 364 extern int     random_number(int);
 365 extern const uschar *rc_to_string(int);
 366 extern int     rda_interpret(redirect_block *, int, uschar *, uschar *,
 367                  uschar *, uschar *, uschar *, ugid_block *, address_item **,
 368                  uschar **, error_block **, int *, uschar *);
 369 extern int     rda_is_filter(const uschar *);
 370 extern BOOL    readconf_depends(driver_instance *, uschar *);
 371 extern void    readconf_driver_init(uschar *, driver_instance **,
 372                  driver_info *, int, void *, int, optionlist *, int);
 373 extern uschar *readconf_find_option(void *);
 374 extern void    readconf_main(BOOL);
 375 extern void    readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
 376 extern BOOL    readconf_print(uschar *, uschar *, BOOL);
 377 extern uschar *readconf_printtime(int);
 378 extern uschar *readconf_readname(uschar *, int, uschar *);
 379 extern int     readconf_readtime(const uschar *, int, BOOL);
 380 extern void    readconf_rest(void);
 381 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
 382 extern void    readconf_save_config(const uschar *);
 383 extern void    read_message_body(BOOL);
 384 extern void    receive_bomb_out(uschar *, uschar *);
 385 extern BOOL    receive_check_fs(int);
 386 extern BOOL    receive_check_set_sender(uschar *);
 387 extern BOOL    receive_msg(BOOL);
 388 extern int_eximarith_t receive_statvfs(BOOL, int *);
 389 extern void    receive_swallow_smtp(void);
 390 #ifdef WITH_CONTENT_SCAN
 391 extern int     regex(const uschar **);
 392 #endif
 393 extern BOOL    regex_match_and_setup(const pcre *, const uschar *, int, int);
 394 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
 395 extern void    retry_add_item(address_item *, uschar *, int);
 396 extern BOOL    retry_check_address(const uschar *, host_item *, uschar *, BOOL,
 397                  uschar **, uschar **);
 398 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
 399 extern BOOL    retry_ultimate_address_timeout(uschar *, const uschar *,
 400                  dbdata_retry *, time_t);
 401 extern void    retry_update(address_item **, address_item **, address_item **);
 402 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
 403 extern uschar *rewrite_address_qualify(uschar *, BOOL);
 404 extern header_line *rewrite_header(header_line *,
 405                const uschar *, const uschar *,
 406                rewrite_rule *, int, BOOL);
 407 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
 408                  rewrite_rule *);
 409 extern void    rewrite_test(uschar *);
 410 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
 411                  uschar **);
 412 extern int     route_address(address_item *, address_item **, address_item **,
 413                  address_item **, address_item **, int);
 414 extern int     route_check_prefix(const uschar *, const uschar *);
 415 extern int     route_check_suffix(const uschar *, const uschar *);
 416 extern BOOL    route_findgroup(uschar *, gid_t *);
 417 extern BOOL    route_finduser(const uschar *, struct passwd **, uid_t *);
 418 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 419                  uschar **);
 420 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 421                  struct passwd **, uid_t *, uschar **);
 422 extern void    route_init(void);
 423 extern void    route_show_supported(FILE *);
 424 extern void    route_tidyup(void);
 425
 426 extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
 427                  int, int *);
 428 extern int     search_findtype(const uschar *, int);
 429 extern int     search_findtype_partial(const uschar *, int *, const uschar **, int *,
 430                  int *);
 431 extern void   *search_open(uschar *, int, int, uid_t *, gid_t *);
 432 extern void    search_tidyup(void);
 433 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
 434 extern void    sha1_end(hctx *, const uschar *, int, uschar *);
 435 extern void    sha1_mid(hctx *, const uschar *);
 436 extern void    sha1_start(hctx *);
 437 extern int     sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
 438                  uschar *, address_item **, uschar **);
 439 extern void    sigalrm_handler(int);
 440 extern BOOL    smtp_buffered(void);
 441 extern void    smtp_closedown(uschar *);
 442 extern void    smtp_command_timeout_exit(void);
 443 extern void    smtp_command_sigterm_exit(void);
 444 extern void    smtp_data_timeout_exit(void);
 445 extern void    smtp_data_sigint_exit(void);
 446 extern uschar *smtp_cmd_hist(void);
 447 extern int     smtp_connect(smtp_connect_args *, const blob *);
 448 extern int     smtp_sock_connect(host_item *, int, int, uschar *,
 449                  transport_instance * tb, int, const blob *);
 450 extern int     smtp_feof(void);
 451 extern int     smtp_ferror(void);
 452 extern uschar *smtp_get_connection_info(void);
 453 extern BOOL    smtp_get_interface(uschar *, int, address_item *,
 454                  uschar **, uschar *);
 455 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 456 extern int     smtp_getc(unsigned);
 457 extern uschar *smtp_getbuf(unsigned *);
 458 extern void    smtp_get_cache(void);
 459 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 460 extern void    smtp_log_no_mail(void);
 461 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
 462 extern void    smtp_proxy_tls(void *, uschar *, size_t, int *, int);
 463 extern BOOL    smtp_read_response(void *, uschar *, int, int, int);
 464 extern void    smtp_reset(void *);
 465 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 466 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
 467 extern void    smtp_port_for_connect(host_item *, int);
 468 extern void    smtp_send_prohibition_message(int, uschar *);
 469 extern int     smtp_setup_msg(void);
 470 extern BOOL    smtp_start_session(void);
 471 extern int     smtp_ungetc(int);
 472 extern BOOL    smtp_verify_helo(void);
 473 extern int     smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
 474 #ifdef WITH_CONTENT_SCAN
 475 extern int     spam(const uschar **);
 476 extern FILE   *spool_mbox(unsigned long *, const uschar *, uschar **);
 477 #endif
 478 extern void    spool_clear_header_globals(void);
 479 extern uschar *spool_dname(const uschar *, uschar *);
 480 extern uschar *spool_fname(const uschar *, const uschar *, const uschar *, const uschar *);
 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 uschar *spool_sname(const uschar *, uschar *);
 486 extern int     spool_write_header(uschar *, int, uschar **);
 487 extern int     stdin_getc(unsigned);
 488 extern int     stdin_feof(void);
 489 extern int     stdin_ferror(void);
 490 extern int     stdin_ungetc(int);
 491 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
 492 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
 493 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
 494 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
 495 extern uschar *string_base62(unsigned long int);
 496 extern gstring *string_cat (gstring *, const uschar *     ) WARN_UNUSED_RESULT;
 497 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
 498 extern int     string_compare_by_pointer(const void *, const void *);
 499 extern uschar *string_copy_dnsdomain(uschar *);
 500 extern uschar *string_copy_malloc(const uschar *);
 501 extern uschar *string_copylc(const uschar *);
 502 extern uschar *string_copynlc(uschar *, int);
 503 extern uschar *string_dequote(const uschar **);
 504 extern gstring *string_fmt_append(gstring *, const char *, ...) ALMOST_PRINTF(2,3);
 505 extern BOOL    string_format(uschar *, int, const char *, ...) ALMOST_PRINTF(3,4);
 506 extern uschar *string_format_size(int, uschar *);
 507 extern uschar *string_from_gstring(gstring *);
 508 extern gstring *string_get(unsigned);
 509 extern int     string_interpret_escape(const uschar **);
 510 extern int     string_is_ip_address(const uschar *, int *);
 511 #ifdef SUPPORT_I18N
 512 extern BOOL    string_is_utf8(const uschar *);
 513 #endif
 514 extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
 515 extern uschar *string_open_failed(int, const char *, ...) PRINTF_FUNCTION(2,3);
 516 extern const uschar *string_printing2(const uschar *, BOOL);
 517 extern uschar *string_split_message(uschar *);
 518 extern uschar *string_timediff(struct timeval *);
 519 extern uschar *string_timesince(struct timeval *);
 520 extern uschar *string_unprinting(uschar *);
 521 #ifdef SUPPORT_I18N
 522 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
 523 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
 524 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
 525 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
 526 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
 527 #endif
 528 extern gstring *string_vformat(gstring *, BOOL, const char *, va_list);
 529 extern int     strcmpic(const uschar *, const uschar *);
 530 extern int     strncmpic(const uschar *, const uschar *, int);
 531 extern uschar *strstric(uschar *, uschar *, BOOL);
 532
 533 #ifdef EXIM_TFO_PROBE
 534 extern void    tfo_probe(void);
 535 #endif
 536 extern void    timesince(struct timeval * diff, struct timeval * then);
 537 extern void    tls_modify_variables(tls_support *);
 538 extern uschar *tod_stamp(int);
 539
 540 extern BOOL    transport_check_waiting(const uschar *, const uschar *, int, uschar *,
 541                  BOOL *, oicf, void*);
 542 extern void    transport_init(void);
 543 extern void    transport_do_pass_socket(const uschar *, const uschar *,
 544                  const uschar *, uschar *, int);
 545 extern BOOL    transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
 546                  int);
 547 extern uschar *transport_rcpt_address(address_item *, BOOL);
 548 extern BOOL    transport_set_up_command(const uschar ***, uschar *,
 549                  BOOL, int, address_item *, uschar *, uschar **);
 550 extern void    transport_update_waiting(host_item *, uschar *);
 551 extern BOOL    transport_write_block(transport_ctx *, uschar *, int, BOOL);
 552 extern void    transport_write_reset(int);
 553 extern BOOL    transport_write_string(int, const char *, ...);
 554 extern BOOL    transport_headers_send(transport_ctx *,
 555                  BOOL (*)(transport_ctx *, uschar *, int));
 556 extern void    transport_show_supported(FILE *);
 557 extern BOOL    transport_write_message(transport_ctx *, int);
 558 extern void    tree_add_duplicate(uschar *, address_item *);
 559 extern void    tree_add_nonrecipient(uschar *);
 560 extern void    tree_add_unusable(host_item *);
 561 extern int     tree_insertnode(tree_node **, tree_node *);
 562 extern tree_node *tree_search(tree_node *, const uschar *);
 563 extern void    tree_write(tree_node *, FILE *);
 564 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 565
 566 #ifdef WITH_CONTENT_SCAN
 567 extern void    unspool_mbox(void);
 568 #endif
 569 #ifdef SUPPORT_I18N
 570 extern void    utf8_version_report(FILE *);
 571 #endif
 572
 573 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 574                  uschar *, uschar *, BOOL *);
 575 extern int     verify_check_dnsbl(int, const uschar **, uschar **);
 576 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 577                  uschar *, uschar *, int, int *);
 578 extern int     verify_check_headers(uschar **);
 579 extern int     verify_check_header_names_ascii(uschar **);
 580 extern int     verify_check_host(uschar **);
 581 extern int     verify_check_notblind(BOOL);
 582 extern int     verify_check_given_host(const uschar **, const host_item *);
 583 extern int     verify_check_this_host(const uschar **, unsigned int *,
 584                  const uschar*, const uschar *, const uschar **);
 585 extern address_item *verify_checked_sender(uschar *);
 586 extern void    verify_get_ident(int);
 587 extern BOOL    verify_sender(int *, uschar **);
 588 extern BOOL    verify_sender_preliminary(int *, uschar **);
 589 extern void    version_init(void);
 590
 591 extern BOOL    write_chunk(transport_ctx *, uschar *, int);
 592 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
 593
 594 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
 595    chown(<exim-uid>, <exim-gid>).
 596
 597    Probably because the idmapping is broken, misconfigured or set up in
 598    an unusal way. (see Bug 2931). As I'm not sure, if this was a single
 599    case of misconfiguration, or if there are more such broken systems
 600    out, I try to impose as least impact as possible and for now just write
 601    a panic log entry pointing to the bug report. You're encouraged to
 602    contact the developers, if you experience this issue.
 603
 604    fd     the file descriptor (or -1 if not valid)
 605    name   the file name for error messages or for file operations,
 606           if fd is < 0
 607    owner  the owner
 608    group  the group
 609
 610    returns 0 on success, -1 on failure */
 611
 612 inline int
 613 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
 614 {
 615 return (0 == fchown(fd, owner, group))
 616   ? 0 : exim_chown_failure(fd, name, owner, group);
 617 }
 618
 619 inline int
 620 exim_chown(const uschar *name, uid_t owner, gid_t group)
 621 {
 622 return (0 == chown(name, owner, group))
 623   ? 0 : exim_chown_failure(-1, name, owner, group);
 624 }
 625
 626 #endif  /* _FUNCTIONS_H_ */
 627
 628 /* vi: aw
 629 */
 630 /* End of functions.h */