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 BOOL    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 SUPPORT_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 time_t  dns_expire_from_soa(dns_answer *);
 199 extern void    dns_init(BOOL, BOOL, BOOL);
 200 extern BOOL    dns_is_aa(const dns_answer *);
 201 extern BOOL    dns_is_secure(const dns_answer *);
 202 extern int     dns_lookup(dns_answer *, const uschar *, int, const uschar **);
 203 extern void    dns_pattern_init(void);
 204 extern int     dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
 205 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
 206 extern uschar *dns_text_type(int);
 207 extern void    dscp_list_to_stream(FILE *);
 208 extern BOOL    dscp_lookup(const uschar *, int, int *, int *, int *);
 209
 210 extern void    enq_end(uschar *);
 211 extern BOOL    enq_start(uschar *, unsigned);
 212 #ifndef DISABLE_EVENT
 213 extern uschar *event_raise(uschar *, const uschar *, uschar *);
 214 extern void    msg_event_raise(const uschar *, const address_item *);
 215 #endif
 216
 217 extern int     exim_chown_failure(int, const uschar*, uid_t, gid_t);
 218 extern const uschar * exim_errstr(int);
 219 extern void    exim_exit(int, const uschar *) NORETURN;
 220 extern void    exim_nullstd(void);
 221 extern void    exim_setugid(uid_t, gid_t, BOOL, uschar *);
 222 extern void    exim_underbar_exit(int);
 223 extern void    exim_wait_tick(struct timeval *, int);
 224 extern int     exp_bool(address_item *addr,
 225   uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
 226   uschar *svalue, BOOL *rvalue);
 227 extern BOOL    expand_check_condition(uschar *, uschar *, uschar *);
 228 extern uschar *expand_file_big_buffer(const uschar *);
 229 extern uschar *expand_string(uschar *); /* public, cannot make const */
 230 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
 231 extern uschar *expand_hide_passwords(uschar * );
 232 extern uschar *expand_string_copy(const uschar *);
 233 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
 234 extern void    modify_variable(uschar *, void *);
 235
 236 extern BOOL    fd_ready(int, time_t);
 237
 238 extern int     filter_interpret(uschar *, int, address_item **, uschar **);
 239 extern BOOL    filter_personal(string_item *, BOOL);
 240 extern BOOL    filter_runtest(int, uschar *, BOOL, BOOL);
 241 extern BOOL    filter_system_interpret(address_item **, uschar **);
 242
 243 extern uschar * fn_hdrs_added(void);
 244
 245 extern void    header_add(int, const char *, ...);
 246 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
 247 extern int     header_checkname(header_line *, BOOL);
 248 extern BOOL    header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
 249 extern int     host_address_extract_port(uschar *);
 250 extern uschar *host_and_ident(BOOL);
 251 extern int     host_aton(const uschar *, int *);
 252 extern void    host_build_hostlist(host_item **, const uschar *, BOOL);
 253 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
 254 extern void    host_build_log_info(void);
 255 extern void    host_build_sender_fullhost(void);
 256 extern int     host_find_byname(host_item *, const uschar *, int,
 257                                 const uschar **, BOOL);
 258 extern int     host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
 259                  uschar *, const dnssec_domains *, const uschar **, BOOL *);
 260 extern ip_address_item *host_find_interfaces(void);
 261 extern BOOL    host_is_in_net(const uschar *, const uschar *, int);
 262 extern BOOL    host_is_tls_on_connect_port(int);
 263 extern int     host_item_get_port(host_item *);
 264 extern void    host_mask(int, int *, int);
 265 extern int     host_name_lookup(void);
 266 extern int     host_nmtoa(int, int *, int, uschar *, int);
 267 extern uschar *host_ntoa(int, const void *, uschar *, int *);
 268 extern int     host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
 269
 270 extern uschar *imap_utf7_encode(uschar *, const uschar *,
 271                                  uschar, uschar *, uschar **);
 272
 273 extern void    invert_address(uschar *, uschar *);
 274 extern int     ip_addr(void *, int, const uschar *, int);
 275 extern int     ip_bind(int, int, uschar *, int);
 276 extern int     ip_connect(int, int, const uschar *, int, int, const blob *);
 277 extern int     ip_connectedsocket(int, const uschar *, int, int,
 278                  int, host_item *, uschar **, const blob *);
 279 extern int     ip_get_address_family(int);
 280 extern void    ip_keepalive(int, const uschar *, BOOL);
 281 extern int     ip_recv(client_conn_ctx *, uschar *, int, time_t);
 282 extern int     ip_socket(int, int);
 283
 284 extern int     ip_tcpsocket(const uschar *, uschar **, int);
 285 extern int     ip_unixsocket(const uschar *, uschar **);
 286 extern int     ip_streamsocket(const uschar *, uschar **, int);
 287
 288 extern int     ipv6_nmtoa(int *, uschar *);
 289
 290 extern uschar *local_part_quote(uschar *);
 291 extern int     log_create(uschar *);
 292 extern int     log_create_as_exim(uschar *);
 293 extern void    log_close_all(void);
 294
 295 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
 296 extern BOOL    macro_read_assignment(uschar *);
 297 extern uschar *macros_expand(int, int *, BOOL *);
 298 extern void    mainlog_close(void);
 299 #ifdef WITH_CONTENT_SCAN
 300 extern int     malware(const uschar *, int);
 301 extern int     malware_in_file(uschar *);
 302 extern void    malware_init(void);
 303 extern void    malware_show_supported(FILE *);
 304 #endif
 305 extern int     match_address_list(const uschar *, BOOL, BOOL, const uschar **,
 306                  unsigned int *, int, int, const uschar **);
 307 extern int     match_address_list_basic(const uschar *, const uschar **, int);
 308 extern int     match_check_list(const uschar **, int, tree_node **, unsigned int **,
 309                  int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
 310                  const uschar *, const uschar **);
 311 extern int     match_isinlist(const uschar *, const uschar **, int, tree_node **,
 312                  unsigned int *, int, BOOL, const uschar **);
 313 extern int     match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
 314                  const uschar **);
 315 extern void    md5_end(md5 *, const uschar *, int, uschar *);
 316 extern void    md5_mid(md5 *, const uschar *);
 317 extern void    md5_start(md5 *);
 318 extern void    millisleep(int);
 319 #ifdef WITH_CONTENT_SCAN
 320 struct mime_boundary_context;
 321 extern int     mime_acl_check(uschar *acl, FILE *f,
 322                  struct mime_boundary_context *, uschar **, uschar **);
 323 extern int     mime_decode(const uschar **);
 324 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
 325 extern int     mime_regex(const uschar **);
 326 extern void    mime_set_anomaly(int);
 327 #endif
 328 extern uschar *moan_check_errorcopy(uschar *);
 329 extern BOOL    moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
 330                  BOOL, uschar *);
 331 extern void    moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
 332 extern BOOL    moan_send_message(uschar *, int, error_block *eblock,
 333                  header_line *, FILE *, uschar *);
 334 extern void    moan_tell_someone(uschar *, address_item *,
 335                  const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
 336 extern BOOL    moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
 337 extern void    moan_write_from(FILE *);
 338 extern FILE   *modefopen(const uschar *, const char *, mode_t);
 339
 340 extern int     open_cutthrough_connection( address_item * addr );
 341
 342 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
 343                  BOOL);
 344 extern int     parse_forward_list(uschar *, int, address_item **, uschar **,
 345                  const uschar *, uschar *, error_block **);
 346 extern uschar *parse_find_address_end(uschar *, BOOL);
 347 extern uschar *parse_find_at(uschar *);
 348 extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
 349 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
 350 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
 351 extern uschar *parse_date_time(uschar *str, time_t *t);
 352 extern int     vaguely_random_number(int);
 353 #ifndef DISABLE_TLS
 354 extern int     vaguely_random_number_fallback(int);
 355 #endif
 356
 357 extern BOOL    queue_action(uschar *, int, uschar **, int, int);
 358 extern void    queue_check_only(void);
 359 extern void    queue_list(int, uschar **, int);
 360 extern void    queue_count(void);
 361 extern void    queue_run(uschar *, uschar *, BOOL);
 362
 363 extern int     random_number(int);
 364 extern const uschar *rc_to_string(int);
 365 extern int     rda_interpret(redirect_block *, int, uschar *, uschar *,
 366                  uschar *, uschar *, uschar *, ugid_block *, address_item **,
 367                  uschar **, error_block **, int *, uschar *);
 368 extern int     rda_is_filter(const uschar *);
 369 extern BOOL    readconf_depends(driver_instance *, uschar *);
 370 extern void    readconf_driver_init(uschar *, driver_instance **,
 371                  driver_info *, int, void *, int, optionlist *, int);
 372 extern uschar *readconf_find_option(void *);
 373 extern void    readconf_main(BOOL);
 374 extern void    readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
 375 extern BOOL    readconf_print(uschar *, uschar *, BOOL);
 376 extern uschar *readconf_printtime(int);
 377 extern uschar *readconf_readname(uschar *, int, uschar *);
 378 extern int     readconf_readtime(const uschar *, int, BOOL);
 379 extern void    readconf_rest(void);
 380 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
 381 extern void    readconf_save_config(const uschar *);
 382 extern void    read_message_body(BOOL);
 383 extern void    receive_bomb_out(uschar *, uschar *) NORETURN;
 384 extern BOOL    receive_check_fs(int);
 385 extern BOOL    receive_check_set_sender(uschar *);
 386 extern BOOL    receive_msg(BOOL);
 387 extern int_eximarith_t receive_statvfs(BOOL, int *);
 388 extern void    receive_swallow_smtp(void);
 389 #ifdef WITH_CONTENT_SCAN
 390 extern int     regex(const uschar **);
 391 #endif
 392 extern BOOL    regex_match_and_setup(const pcre *, const uschar *, int, int);
 393 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
 394 extern void    retry_add_item(address_item *, uschar *, int);
 395 extern BOOL    retry_check_address(const uschar *, host_item *, uschar *, BOOL,
 396                  uschar **, uschar **);
 397 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
 398 extern BOOL    retry_ultimate_address_timeout(uschar *, const uschar *,
 399                  dbdata_retry *, time_t);
 400 extern void    retry_update(address_item **, address_item **, address_item **);
 401 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
 402 extern uschar *rewrite_address_qualify(uschar *, BOOL);
 403 extern header_line *rewrite_header(header_line *,
 404                const uschar *, const uschar *,
 405                rewrite_rule *, int, BOOL);
 406 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
 407                  rewrite_rule *);
 408 extern void    rewrite_test(uschar *);
 409 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
 410                  uschar **);
 411 extern int     route_address(address_item *, address_item **, address_item **,
 412                  address_item **, address_item **, int);
 413 extern int     route_check_prefix(const uschar *, const uschar *);
 414 extern int     route_check_suffix(const uschar *, const uschar *);
 415 extern BOOL    route_findgroup(uschar *, gid_t *);
 416 extern BOOL    route_finduser(const uschar *, struct passwd **, uid_t *);
 417 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 418                  uschar **);
 419 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 420                  struct passwd **, uid_t *, uschar **);
 421 extern void    route_init(void);
 422 extern void    route_show_supported(FILE *);
 423 extern void    route_tidyup(void);
 424
 425 extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
 426                  int, int *);
 427 extern int     search_findtype(const uschar *, int);
 428 extern int     search_findtype_partial(const uschar *, int *, const uschar **, int *,
 429                  int *);
 430 extern void   *search_open(uschar *, int, int, uid_t *, gid_t *);
 431 extern void    search_tidyup(void);
 432 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
 433 extern void    sha1_end(hctx *, const uschar *, int, uschar *);
 434 extern void    sha1_mid(hctx *, const uschar *);
 435 extern void    sha1_start(hctx *);
 436 extern int     sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
 437                  uschar *, address_item **, uschar **);
 438 extern void    sigalrm_handler(int);
 439 extern BOOL    smtp_buffered(void);
 440 extern void    smtp_closedown(uschar *);
 441 extern void    smtp_command_timeout_exit(void) NORETURN;
 442 extern void    smtp_command_sigterm_exit(void) NORETURN;
 443 extern void    smtp_data_timeout_exit(void) NORETURN;
 444 extern void    smtp_data_sigint_exit(void) NORETURN;
 445 extern uschar *smtp_cmd_hist(void);
 446 extern int     smtp_connect(smtp_connect_args *, const blob *);
 447 extern int     smtp_sock_connect(host_item *, int, int, uschar *,
 448                  transport_instance * tb, int, const blob *);
 449 extern int     smtp_feof(void);
 450 extern int     smtp_ferror(void);
 451 extern uschar *smtp_get_connection_info(void);
 452 extern BOOL    smtp_get_interface(uschar *, int, address_item *,
 453                  uschar **, uschar *);
 454 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 455 extern int     smtp_getc(unsigned);
 456 extern uschar *smtp_getbuf(unsigned *);
 457 extern void    smtp_get_cache(void);
 458 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 459 extern void    smtp_log_no_mail(void);
 460 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
 461 extern void    smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
 462 extern BOOL    smtp_read_response(void *, uschar *, int, int, int);
 463 extern void   *smtp_reset(void *);
 464 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 465 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
 466 extern void    smtp_port_for_connect(host_item *, int);
 467 extern void    smtp_send_prohibition_message(int, uschar *);
 468 extern int     smtp_setup_msg(void);
 469 extern BOOL    smtp_start_session(void);
 470 extern int     smtp_ungetc(int);
 471 extern BOOL    smtp_verify_helo(void);
 472 extern int     smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
 473 #ifdef WITH_CONTENT_SCAN
 474 extern int     spam(const uschar **);
 475 extern FILE   *spool_mbox(unsigned long *, const uschar *, uschar **);
 476 #endif
 477 extern void    spool_clear_header_globals(void);
 478 extern BOOL    spool_move_message(uschar *, uschar *, uschar *, uschar *);
 479 extern int     spool_open_datafile(uschar *);
 480 extern int     spool_open_temp(uschar *);
 481 extern int     spool_read_header(uschar *, BOOL, BOOL);
 482 extern int     spool_write_header(uschar *, int, uschar **);
 483 extern int     stdin_getc(unsigned);
 484 extern int     stdin_feof(void);
 485 extern int     stdin_ferror(void);
 486 extern int     stdin_ungetc(int);
 487
 488 extern void    store_exit(void);
 489 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
 490 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
 491 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
 492 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
 493 extern uschar *string_base62(unsigned long int);
 494 extern gstring *string_cat (gstring *, const uschar *     ) WARN_UNUSED_RESULT;
 495 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
 496 extern int     string_compare_by_pointer(const void *, const void *);
 497 extern uschar *string_copy_dnsdomain(uschar *);
 498 extern uschar *string_copy_malloc(const uschar *);
 499 extern uschar *string_dequote(const uschar **);
 500 extern uschar *string_format_size(int, uschar *);
 501 extern int     string_interpret_escape(const uschar **);
 502 extern int     string_is_ip_address(const uschar *, int *);
 503 #ifdef SUPPORT_I18N
 504 extern BOOL    string_is_utf8(const uschar *);
 505 #endif
 506 extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
 507 extern const uschar *string_printing2(const uschar *, BOOL);
 508 extern uschar *string_split_message(uschar *);
 509 extern uschar *string_timediff(struct timeval *);
 510 extern uschar *string_timesince(struct timeval *);
 511 extern uschar *string_unprinting(uschar *);
 512 #ifdef SUPPORT_I18N
 513 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
 514 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
 515 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
 516 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
 517 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
 518 #endif
 519
 520 #define string_format(buf, siz, fmt, ...) \
 521         string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 522 extern BOOL    string_format_trc(uschar *, int, const uschar *, unsigned,
 523                         const char *, ...) ALMOST_PRINTF(5,6);
 524
 525 #define string_vformat(g, flgs, fmt, ap) \
 526         string_vformat_trc(g, US __FUNCTION__, __LINE__, \
 527                          STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
 528 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
 529                         unsigned, unsigned, const char *, va_list);
 530
 531 #define string_open_failed(eno, fmt, ...) \
 532         string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
 533 extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
 534                         const char *, ...) PRINTF_FUNCTION(4,5);
 535
 536 extern int     strcmpic(const uschar *, const uschar *);
 537 extern int     strncmpic(const uschar *, const uschar *, int);
 538 extern uschar *strstric(uschar *, uschar *, BOOL);
 539
 540 #ifdef EXIM_TFO_PROBE
 541 extern void    tfo_probe(void);
 542 #endif
 543 extern void    timesince(struct timeval * diff, struct timeval * then);
 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 #endif  /* !MACRO_PREDEF */
 906
 907 #endif  /* _FUNCTIONS_H_ */
 908
 909 /* vi: aw
 910 */
 911 /* End of functions.h */