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