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