src/src/functions.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2012 */
   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
  14
  15 #ifdef EXIM_PERL
  16 extern uschar *call_perl_cat(uschar *, int *, int *, uschar **, uschar *,
  17                  uschar **);
  18 extern void    cleanup_perl(void);
  19 extern uschar *init_perl(uschar *);
  20 #endif
  21
  22
  23 #ifdef SUPPORT_TLS
  24 extern const char *
  25                std_dh_prime_default(void);
  26 extern const char *
  27                std_dh_prime_named(const uschar *);
  28 extern int     tls_client_start(int, host_item *, address_item *,
  29                  uschar *, uschar *, uschar *, uschar *, uschar *, uschar *,
  30 # ifdef EXPERIMENTAL_OCSP
  31                  uschar *,
  32 # endif
  33                  int, int);
  34 extern void    tls_close(BOOL, BOOL);
  35 extern int     tls_feof(void);
  36 extern int     tls_ferror(void);
  37 extern int     tls_getc(void);
  38 extern int     tls_read(BOOL, uschar *, size_t);
  39 extern int     tls_server_start(const uschar *);
  40 extern BOOL    tls_smtp_buffered(void);
  41 extern int     tls_ungetc(int);
  42 extern int     tls_write(BOOL, const uschar *, size_t);
  43 extern uschar *tls_validate_require_cipher(void);
  44 extern void    tls_version_report(FILE *);
  45 #ifndef USE_GNUTLS
  46 extern BOOL    tls_openssl_options_parse(uschar *, long *);
  47 #endif
  48 #endif
  49
  50
  51 /* Everything else... */
  52
  53 extern acl_block *acl_read(uschar *(*)(void), uschar **);
  54 extern int     acl_check(int, uschar *, uschar *, uschar **, uschar **);
  55 extern int     acl_eval(int, uschar *, uschar **, uschar **);
  56
  57 extern tree_node *acl_var_create(uschar *);
  58 extern void    acl_var_write(uschar *, uschar *, void *);
  59 extern uschar *auth_b64encode(uschar *, int);
  60 extern int     auth_b64decode(uschar *, uschar **);
  61 extern int     auth_call_pam(uschar *, uschar **);
  62 extern int     auth_call_pwcheck(uschar *, uschar **);
  63 extern int     auth_call_radius(uschar *, uschar **);
  64 extern int     auth_call_saslauthd(uschar *, uschar *, uschar *, uschar *,
  65                  uschar **);
  66 extern int     auth_check_serv_cond(auth_instance *);
  67 extern int     auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
  68
  69 extern int     auth_get_data(uschar **, uschar *, int);
  70 extern int     auth_get_no64_data(uschar **, uschar *);
  71 extern uschar *auth_xtextencode(uschar *, int);
  72 extern int     auth_xtextdecode(uschar *, uschar **);
  73
  74 extern void    cancel_cutthrough_connection(const char *);
  75 extern int     check_host(void *, uschar *, uschar **, uschar **);
  76 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
  77 extern pid_t   child_open_uid(uschar **, uschar **, int, uid_t *, gid_t *,
  78                  int *, int *, uschar *, BOOL);
  79 extern uschar *cutthrough_finaldot(void);
  80 extern BOOL    cutthrough_flush_send(void);
  81 extern BOOL    cutthrough_headers_send(void);
  82 extern BOOL    cutthrough_predata(void);
  83 extern BOOL    cutthrough_puts(uschar *, int);
  84 extern BOOL    cutthrough_put_nl(void);
  85
  86 extern void    daemon_go(void);
  87
  88 #ifdef EXPERIMENTAL_DCC
  89 extern int     dcc_process(uschar **);
  90 #endif
  91
  92 extern void    debug_logging_activate(uschar *, uschar *);
  93 extern void    debug_print_argv(uschar **);
  94 extern void    debug_print_ids(uschar *);
  95 extern void    debug_print_string(uschar *);
  96 extern void    debug_print_tree(tree_node *);
  97 extern void    debug_vprintf(const char *, va_list);
  98 extern void    decode_bits(unsigned int *, unsigned int *,
  99                   int, int, uschar *, bit_table *, int, uschar *, int);
 100 extern address_item *deliver_make_addr(uschar *, BOOL);
 101 extern void    delivery_log(int, address_item *, int, uschar *);
 102 extern int     deliver_message(uschar *, BOOL, BOOL);
 103 extern void    deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
 104 extern void    deliver_set_expansions(address_item *);
 105 extern int     deliver_split_address(address_item *);
 106 extern void    deliver_succeeded(address_item *);
 107 #ifdef WITH_OLD_DEMIME
 108 extern int     demime(uschar **);
 109 #endif
 110 extern BOOL    directory_make(const uschar *, const uschar *, int, BOOL);
 111 #ifndef DISABLE_DKIM
 112 extern BOOL    dkim_transport_write_message(address_item *, int, int,
 113                    int, uschar *, uschar *, uschar *, uschar *, rewrite_rule *,
 114                    int, uschar *, uschar *, uschar *, uschar *, uschar *, uschar *);
 115 #endif
 116 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
 117 extern void    dns_build_reverse(uschar *, uschar *);
 118 extern void    dns_init(BOOL, BOOL);
 119 extern int     dns_basic_lookup(dns_answer *, uschar *, int);
 120 extern BOOL    dns_is_secure(dns_answer *);
 121 extern int     dns_lookup(dns_answer *, uschar *, int, uschar **);
 122 extern int     dns_special_lookup(dns_answer *, uschar *, int, uschar **);
 123 extern dns_record *dns_next_rr(dns_answer *, dns_scan *, int);
 124 extern uschar *dns_text_type(int);
 125 extern void    dscp_list_to_stream(FILE *);
 126 extern BOOL    dscp_lookup(const uschar *, int, int *, int *, int *);
 127
 128 extern void    enq_end(uschar *);
 129 extern BOOL    enq_start(uschar *);
 130 extern void    exim_exit(int);
 131 extern void    exim_nullstd(void);
 132 extern void    exim_setugid(uid_t, gid_t, BOOL, uschar *);
 133 extern int     exim_tvcmp(struct timeval *, struct timeval *);
 134 extern void    exim_wait_tick(struct timeval *, int);
 135 extern BOOL    expand_check_condition(uschar *, uschar *, uschar *);
 136 extern uschar *expand_string(uschar *);
 137 extern uschar *expand_string_copy(uschar *);
 138 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
 139 extern void    modify_variable(uschar *, void *);
 140
 141 extern int     filter_interpret(uschar *, int, address_item **, uschar **);
 142 extern BOOL    filter_personal(string_item *, BOOL);
 143 extern BOOL    filter_runtest(int, uschar *, BOOL, BOOL);
 144 extern BOOL    filter_system_interpret(address_item **, uschar **);
 145
 146 extern uschar * fn_hdrs_added(void);
 147
 148 extern void    header_add(int, const char *, ...);
 149 extern int     header_checkname(header_line *, BOOL);
 150 extern BOOL    header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
 151 extern int     host_address_extract_port(uschar *);
 152 extern uschar *host_and_ident(BOOL);
 153 extern int     host_aton(uschar *, int *);
 154 extern void    host_build_hostlist(host_item **, uschar *, BOOL);
 155 extern ip_address_item *host_build_ifacelist(uschar *, uschar *);
 156 extern void    host_build_log_info(void);
 157 extern void    host_build_sender_fullhost(void);
 158 extern BOOL    host_find_byname(host_item *, uschar *, int, uschar **, BOOL);
 159 extern int     host_find_bydns(host_item *, uschar *, int, uschar *, uschar *,
 160                  uschar *,uschar **, BOOL *);
 161 extern ip_address_item *host_find_interfaces(void);
 162 extern BOOL    host_is_in_net(uschar *, uschar *, int);
 163 extern BOOL    host_is_tls_on_connect_port(int);
 164 extern int     host_item_get_port(host_item *);
 165 extern void    host_mask(int, int *, int);
 166 extern int     host_name_lookup(void);
 167 extern int     host_nmtoa(int, int *, int, uschar *, int);
 168 extern uschar *host_ntoa(int, const void *, uschar *, int *);
 169 extern int     host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
 170
 171 extern void    invert_address(uschar *, uschar *);
 172 extern int     ip_bind(int, int, uschar *, int);
 173 extern int     ip_connect(int, int, uschar *, int, int);
 174 extern int     ip_get_address_family(int);
 175 extern void    ip_keepalive(int, uschar *, BOOL);
 176 extern int     ip_recv(int, uschar *, int, int);
 177 extern int     ip_socket(int, int);
 178
 179 extern uschar *local_part_quote(uschar *);
 180 extern int     log_create(uschar *);
 181 extern int     log_create_as_exim(uschar *);
 182 extern void    log_close_all(void);
 183
 184 #ifdef WITH_CONTENT_SCAN
 185 extern int     malware(uschar **);
 186 extern int     malware_in_file(uschar *);
 187 #endif
 188 extern int     match_address_list(uschar *, BOOL, BOOL, uschar **,
 189                  unsigned int *, int, int, uschar **);
 190 extern int     match_check_list(uschar **, int, tree_node **, unsigned int **,
 191                  int(*)(void *, uschar *, uschar **, uschar **), void *, int,
 192                  uschar *, uschar **);
 193 extern int     match_isinlist(uschar *, uschar **, int, tree_node **,
 194                  unsigned int *, int, BOOL, uschar **);
 195 extern int     match_check_string(uschar *, uschar *, int, BOOL, BOOL, BOOL,
 196                  uschar **);
 197 extern void    md5_end(md5 *, const uschar *, int, uschar *);
 198 extern void    md5_mid(md5 *, const uschar *);
 199 extern void    md5_start(md5 *);
 200 extern void    millisleep(int);
 201 #ifdef WITH_CONTENT_SCAN
 202 struct mime_boundary_context;
 203 extern int     mime_acl_check(uschar *acl, FILE *f,
 204                  struct mime_boundary_context *, uschar **, uschar **);
 205 extern int     mime_decode(uschar **);
 206 extern int     mime_regex(uschar **);
 207 #endif
 208 extern uschar *moan_check_errorcopy(uschar *);
 209 extern BOOL    moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
 210                  BOOL, uschar *);
 211 extern void    moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
 212 extern void    moan_tell_someone(uschar *, address_item *,
 213                  const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
 214 extern BOOL    moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
 215 extern void    moan_write_from(FILE *);
 216 extern FILE   *modefopen(const uschar *, const char *, mode_t);
 217
 218 extern void   open_cutthrough_connection( address_item * addr );
 219
 220 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
 221                  BOOL);
 222 extern int     parse_forward_list(uschar *, int, address_item **, uschar **,
 223                  uschar *, uschar *, error_block **);
 224 extern uschar *parse_find_address_end(uschar *, BOOL);
 225 extern uschar *parse_find_at(uschar *);
 226 extern uschar *parse_fix_phrase(uschar *, int, uschar *, int);
 227 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
 228 extern uschar *parse_quote_2047(uschar *, int, uschar *, uschar *, int, BOOL);
 229 extern uschar *parse_date_time(uschar *str, time_t *t);
 230 extern int     vaguely_random_number(int);
 231 #ifdef SUPPORT_TLS
 232 extern int     vaguely_random_number_fallback(int);
 233 #endif
 234
 235 extern BOOL    queue_action(uschar *, int, uschar **, int, int);
 236 extern void    queue_check_only(void);
 237 extern void    queue_list(int, uschar **, int);
 238 extern void    queue_count(void);
 239 extern void    queue_run(uschar *, uschar *, BOOL);
 240
 241 extern int     random_number(int);
 242 #ifdef WITH_CONTENT_SCAN
 243 extern int     recv_line(int, uschar *, int);
 244 #endif
 245 extern int     rda_interpret(redirect_block *, int, uschar *, uschar *,
 246                  uschar *, uschar *, uschar *, ugid_block *, address_item **,
 247                  uschar **, error_block **, int *, uschar *);
 248 extern int     rda_is_filter(const uschar *);
 249 extern BOOL    readconf_depends(driver_instance *, uschar *);
 250 extern void    readconf_driver_init(uschar *, driver_instance **,
 251                  driver_info *, int, void *, int, optionlist *, int);
 252 extern uschar *readconf_find_option(void *);
 253 extern void    readconf_main(void);
 254 extern void    readconf_print(uschar *, uschar *, BOOL);
 255 extern uschar *readconf_printtime(int);
 256 extern uschar *readconf_readname(uschar *, int, uschar *);
 257 extern int     readconf_readtime(uschar *, int, BOOL);
 258 extern void    readconf_rest(BOOL);
 259 extern uschar *readconf_retry_error(uschar *, uschar *, int *, int *);
 260 extern void    read_message_body(BOOL);
 261 extern void    receive_bomb_out(uschar *, uschar *);
 262 extern BOOL    receive_check_fs(int);
 263 extern BOOL    receive_check_set_sender(uschar *);
 264 extern BOOL    receive_msg(BOOL);
 265 extern int     receive_statvfs(BOOL, int *);
 266 extern void    receive_swallow_smtp(void);
 267 #ifdef WITH_CONTENT_SCAN
 268 extern int     regex(uschar **);
 269 #endif
 270 extern BOOL    regex_match_and_setup(const pcre *, uschar *, int, int);
 271 extern const pcre *regex_must_compile(uschar *, BOOL, BOOL);
 272 extern void    retry_add_item(address_item *, uschar *, int);
 273 extern BOOL    retry_check_address(uschar *, host_item *, uschar *, BOOL,
 274                  uschar **, uschar **);
 275 extern retry_config *retry_find_config(uschar *, uschar *, int, int);
 276 extern BOOL    retry_ultimate_address_timeout(uschar *, uschar *,
 277                  dbdata_retry *, time_t);
 278 extern void    retry_update(address_item **, address_item **, address_item **);
 279 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
 280 extern uschar *rewrite_address_qualify(uschar *, BOOL);
 281 extern header_line *rewrite_header(header_line *, uschar *, uschar *,
 282                rewrite_rule *, int, BOOL);
 283 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
 284                  rewrite_rule *);
 285 extern void    rewrite_test(uschar *);
 286 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
 287                  uschar **);
 288 extern int     route_address(address_item *, address_item **, address_item **,
 289                  address_item **, address_item **, int);
 290 extern int     route_check_prefix(uschar *, uschar *);
 291 extern int     route_check_suffix(uschar *, uschar *);
 292 extern BOOL    route_findgroup(uschar *, gid_t *);
 293 extern BOOL    route_finduser(uschar *, struct passwd **, uid_t *);
 294 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 295                  uschar **);
 296 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 297                  struct passwd **, uid_t *, uschar **);
 298 extern void    route_init(void);
 299 extern void    route_tidyup(void);
 300
 301 extern uschar *search_find(void *, uschar *, uschar *, int, uschar *, int,
 302                  int, int *);
 303 extern int     search_findtype(uschar *, int);
 304 extern int     search_findtype_partial(uschar *, int *, uschar **, int *,
 305                  int *);
 306 extern void   *search_open(uschar *, int, int, uid_t *, gid_t *);
 307 extern void    search_tidyup(void);
 308 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
 309 extern void    sha1_end(sha1 *, const uschar *, int, uschar *);
 310 extern void    sha1_mid(sha1 *, const uschar *);
 311 extern void    sha1_start(sha1 *);
 312 extern int     sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
 313                  uschar *, address_item **, uschar **);
 314 extern void    sigalrm_handler(int);
 315 extern BOOL    smtp_buffered(void);
 316 extern void    smtp_closedown(uschar *);
 317 extern int     smtp_connect(host_item *, int, int, uschar *, int, BOOL, const uschar *);
 318 extern int     smtp_feof(void);
 319 extern int     smtp_ferror(void);
 320 extern uschar *smtp_get_connection_info(void);
 321 extern BOOL    smtp_get_interface(uschar *, int, address_item *, BOOL *,
 322                  uschar **, uschar *);
 323 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 324 extern int     smtp_getc(void);
 325 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 326 extern void    smtp_log_no_mail(void);
 327 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **);
 328 extern BOOL    smtp_read_response(smtp_inblock *, uschar *, int, int, int);
 329 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 330 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
 331 extern void    smtp_send_prohibition_message(int, uschar *);
 332 extern int     smtp_setup_msg(void);
 333 extern BOOL    smtp_start_session(void);
 334 extern int     smtp_ungetc(int);
 335 extern BOOL    smtp_verify_helo(void);
 336 extern int     smtp_write_command(smtp_outblock *, BOOL, const char *, ...) PRINTF_FUNCTION(3,4);
 337 #ifdef WITH_CONTENT_SCAN
 338 extern int     spam(uschar **);
 339 extern FILE   *spool_mbox(unsigned long *, uschar *);
 340 #endif
 341 extern BOOL    spool_move_message(uschar *, uschar *, uschar *, uschar *);
 342 extern BOOL    spool_open_datafile(uschar *);
 343 extern int     spool_open_temp(uschar *);
 344 extern int     spool_read_header(uschar *, BOOL, BOOL);
 345 extern int     spool_write_header(uschar *, int, uschar **);
 346 extern int     stdin_getc(void);
 347 extern int     stdin_feof(void);
 348 extern int     stdin_ferror(void);
 349 extern int     stdin_ungetc(int);
 350 extern uschar *string_append(uschar *, int *, int *, int, ...);
 351 extern uschar *string_base62(unsigned long int);
 352 extern uschar *string_cat(uschar *, int *, int *, const uschar *, int);
 353 extern uschar *string_copy_dnsdomain(uschar *);
 354 extern uschar *string_copy_malloc(uschar *);
 355 extern uschar *string_copylc(uschar *);
 356 extern uschar *string_copynlc(uschar *, int);
 357 extern uschar *string_dequote(uschar **);
 358 extern BOOL    string_format(uschar *, int, const char *, ...) ALMOST_PRINTF(3,4);
 359 extern uschar *string_format_size(int, uschar *);
 360 extern int     string_interpret_escape(uschar **);
 361 extern int     string_is_ip_address(uschar *, int *);
 362 extern uschar *string_log_address(address_item *, BOOL, BOOL);
 363 extern uschar *string_nextinlist(uschar **, int *, uschar *, int);
 364 extern uschar *string_open_failed(int, const char *, ...) PRINTF_FUNCTION(2,3);
 365 extern uschar *string_printing2(uschar *, BOOL);
 366 extern uschar *string_split_message(uschar *);
 367 extern uschar *string_unprinting(uschar *);
 368 extern BOOL    string_vformat(uschar *, int, const char *, va_list);
 369 extern int     strcmpic(const uschar *, const uschar *);
 370 extern int     strncmpic(const uschar *, const uschar *, int);
 371 extern uschar *strstric(uschar *, uschar *, BOOL);
 372
 373 extern uschar *tod_stamp(int);
 374 extern BOOL    transport_check_waiting(uschar *, uschar *, int, uschar *,
 375                  BOOL *);
 376 extern void    transport_init(void);
 377 extern BOOL    transport_pass_socket(uschar *, uschar *, uschar *, uschar *,
 378                  int);
 379 extern uschar *transport_rcpt_address(address_item *, BOOL);
 380 extern BOOL    transport_set_up_command(uschar ***, uschar *, BOOL, int,
 381                  address_item *, uschar *, uschar **);
 382 extern void    transport_update_waiting(host_item *, uschar *);
 383 extern BOOL    transport_write_block(int, uschar *, int);
 384 extern BOOL    transport_write_string(int, const char *, ...);
 385 extern BOOL    transport_write_message(address_item *, int, int, int, uschar *,
 386                  uschar *, uschar *, uschar *, rewrite_rule *, int);
 387 extern void    tree_add_duplicate(uschar *, address_item *);
 388 extern void    tree_add_nonrecipient(uschar *);
 389 extern void    tree_add_unusable(host_item *);
 390 extern int     tree_insertnode(tree_node **, tree_node *);
 391 extern tree_node *tree_search(tree_node *, uschar *);
 392 extern void    tree_write(tree_node *, FILE *);
 393 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 394
 395 #ifdef WITH_CONTENT_SCAN
 396 extern void    unspool_mbox(void);
 397 #endif
 398
 399 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 400                  uschar *, uschar *, BOOL *);
 401 extern int     verify_check_dnsbl(uschar **);
 402 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 403                  uschar *, uschar *, int, int *);
 404 extern int     verify_check_headers(uschar **);
 405 extern int     verify_check_host(uschar **);
 406 extern int     verify_check_notblind(void);
 407 extern int     verify_check_this_host(uschar **, unsigned int *, uschar*,
 408                  uschar *, uschar **);
 409 extern address_item *verify_checked_sender(uschar *);
 410 extern void    verify_get_ident(int);
 411 extern BOOL    verify_sender(int *, uschar **);
 412 extern BOOL    verify_sender_preliminary(int *, uschar **);
 413 extern void    version_init(void);
 414
 415 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
 416
 417 /* End of functions.h */