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