1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
6 /* See the file NOTICE for conditions of use and distribution. */
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. */
16 extern uschar *call_perl_cat(uschar *, int *, int *, uschar **, uschar *,
18 extern void cleanup_perl(void);
19 extern uschar *init_perl(uschar *);
25 std_dh_prime_default(void);
27 std_dh_prime_named(const uschar *);
29 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
30 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
31 extern uschar * tls_cert_issuer(void *, uschar * mod);
32 extern uschar * tls_cert_not_before(void *, uschar * mod);
33 extern uschar * tls_cert_not_after(void *, uschar * mod);
34 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
35 extern uschar * tls_cert_serial_number(void *, uschar * mod);
36 extern uschar * tls_cert_signature(void *, uschar * mod);
37 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
38 extern uschar * tls_cert_subject(void *, uschar * mod);
39 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
40 extern uschar * tls_cert_version(void *, uschar * mod);
42 extern uschar * tls_cert_fprt_md5(void *);
43 extern uschar * tls_cert_fprt_sha1(void *);
44 extern uschar * tls_cert_fprt_sha256(void *);
46 extern int tls_client_start(int, host_item *, address_item *,
48 #ifdef EXPERIMENTAL_DANE
52 extern void tls_close(BOOL, BOOL);
53 extern int tls_export_cert(uschar *, size_t, void *);
54 extern int tls_feof(void);
55 extern int tls_ferror(void);
56 extern void tls_free_cert(void *);
57 extern int tls_getc(void);
58 extern int tls_import_cert(const uschar *, void **);
59 extern int tls_read(BOOL, uschar *, size_t);
60 extern int tls_server_start(const uschar *);
61 extern BOOL tls_smtp_buffered(void);
62 extern int tls_ungetc(int);
63 extern int tls_write(BOOL, const uschar *, size_t);
64 extern uschar *tls_validate_require_cipher(void);
65 extern void tls_version_report(FILE *);
67 extern BOOL tls_openssl_options_parse(uschar *, long *);
69 extern uschar * tls_field_from_dn(uschar *, const uschar *);
70 extern BOOL tls_is_name_for_cert(const uschar *, void *);
72 # ifdef EXPERIMENTAL_DANE
73 extern int tlsa_lookup(const host_item *, dns_answer *, BOOL, BOOL *);
76 #endif /*SUPPORT_TLS*/
79 /* Everything else... */
81 extern acl_block *acl_read(uschar *(*)(void), uschar **);
82 extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
83 extern int acl_eval(int, uschar *, uschar **, uschar **);
85 extern tree_node *acl_var_create(uschar *);
86 extern void acl_var_write(uschar *, uschar *, void *);
87 extern uschar *auth_b64encode(uschar *, int);
88 extern int auth_b64decode(uschar *, uschar **);
89 extern int auth_call_pam(const uschar *, uschar **);
90 extern int auth_call_pwcheck(uschar *, uschar **);
91 extern int auth_call_radius(const uschar *, uschar **);
92 extern int auth_call_saslauthd(const uschar *, const uschar *,
93 const uschar *, const uschar *, uschar **);
94 extern int auth_check_serv_cond(auth_instance *);
95 extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
97 extern int auth_get_data(uschar **, uschar *, int);
98 extern int auth_get_no64_data(uschar **, uschar *);
99 extern uschar *auth_xtextencode(uschar *, int);
100 extern int auth_xtextdecode(uschar *, uschar **);
102 extern void cancel_cutthrough_connection(const char *);
103 extern int check_host(void *, const uschar *, const uschar **, uschar **);
104 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
105 extern pid_t child_open_uid(const uschar **, const uschar **, int,
106 uid_t *, gid_t *, int *, int *, uschar *, BOOL);
107 extern uschar *cutthrough_finaldot(void);
108 extern BOOL cutthrough_flush_send(void);
109 extern BOOL cutthrough_headers_send(void);
110 extern BOOL cutthrough_predata(void);
111 extern BOOL cutthrough_puts(uschar *, int);
112 extern BOOL cutthrough_put_nl(void);
114 extern void daemon_go(void);
116 #ifdef EXPERIMENTAL_DCC
117 extern int dcc_process(uschar **);
120 extern void debug_logging_activate(uschar *, uschar *);
121 extern void debug_print_argv(const uschar **);
122 extern void debug_print_ids(uschar *);
123 extern void debug_print_string(uschar *);
124 extern void debug_print_tree(tree_node *);
125 extern void debug_vprintf(const char *, va_list);
126 extern void decode_bits(unsigned int *, unsigned int *,
127 int, int, uschar *, bit_table *, int, uschar *, int);
128 extern address_item *deliver_make_addr(uschar *, BOOL);
129 extern void deliver_init(void);
130 extern void delivery_log(int, address_item *, int, uschar *);
131 extern int deliver_message(uschar *, BOOL, BOOL);
132 extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
133 extern void deliver_set_expansions(address_item *);
134 extern int deliver_split_address(address_item *);
135 extern void deliver_succeeded(address_item *);
137 extern uschar *deliver_get_sender_address (uschar *id);
139 #ifdef WITH_OLD_DEMIME
140 extern int demime(uschar **);
142 extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
144 extern BOOL dkim_transport_write_message(address_item *, int, int,
145 int, uschar *, uschar *, uschar *, uschar *, rewrite_rule *,
146 int, uschar *, uschar *, uschar *, uschar *, uschar *, uschar *);
148 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
149 extern int dns_basic_lookup(dns_answer *, const uschar *, int);
150 extern void dns_build_reverse(const uschar *, uschar *);
151 extern void dns_init(BOOL, BOOL, BOOL);
152 extern BOOL dns_is_secure(const dns_answer *);
153 extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
154 extern void dns_pattern_init(void);
155 extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
156 extern dns_record *dns_next_rr(dns_answer *, dns_scan *, int);
157 extern uschar *dns_text_type(int);
158 extern void dscp_list_to_stream(FILE *);
159 extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
161 extern void enq_end(uschar *);
162 extern BOOL enq_start(uschar *);
163 #ifdef EXPERIMENTAL_EVENT
164 extern uschar *event_raise(uschar *, const uschar *, uschar *);
166 extern void exim_exit(int);
167 extern void exim_nullstd(void);
168 extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
169 extern int exim_tvcmp(struct timeval *, struct timeval *);
170 extern void exim_wait_tick(struct timeval *, int);
171 extern int exp_bool(address_item *addr,
172 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
173 uschar *svalue, BOOL *rvalue);
174 extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
175 extern uschar *expand_string(uschar *); /* public, cannot make const */
176 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
177 extern uschar *expand_string_copy(const uschar *);
178 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
179 extern void modify_variable(uschar *, void *);
181 extern BOOL fd_ready(int, int);
183 extern int filter_interpret(uschar *, int, address_item **, uschar **);
184 extern BOOL filter_personal(string_item *, BOOL);
185 extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
186 extern BOOL filter_system_interpret(address_item **, uschar **);
188 extern uschar * fn_hdrs_added(void);
190 extern void header_add(int, const char *, ...);
191 extern int header_checkname(header_line *, BOOL);
192 extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
193 extern int host_address_extract_port(uschar *);
194 extern uschar *host_and_ident(BOOL);
195 extern int host_aton(const uschar *, int *);
196 extern void host_build_hostlist(host_item **, const uschar *, BOOL);
197 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
198 extern void host_build_log_info(void);
199 extern void host_build_sender_fullhost(void);
200 extern BOOL host_find_byname(host_item *, const uschar *, int, const uschar **, BOOL);
201 extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
202 uschar *, uschar *, uschar *, const uschar **, BOOL *);
203 extern ip_address_item *host_find_interfaces(void);
204 extern BOOL host_is_in_net(const uschar *, const uschar *, int);
205 extern BOOL host_is_tls_on_connect_port(int);
206 extern int host_item_get_port(host_item *);
207 extern void host_mask(int, int *, int);
208 extern int host_name_lookup(void);
209 extern int host_nmtoa(int, int *, int, uschar *, int);
210 extern uschar *host_ntoa(int, const void *, uschar *, int *);
211 extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
213 extern void invert_address(uschar *, uschar *);
214 extern int ip_addr(void *, int, const uschar *, int);
215 extern int ip_bind(int, int, uschar *, int);
216 extern int ip_connect(int, int, const uschar *, int, int);
217 extern int ip_connectedsocket(int, const uschar *, int, int,
218 int, host_item *, uschar **);
219 extern int ip_get_address_family(int);
220 extern void ip_keepalive(int, const uschar *, BOOL);
221 extern int ip_recv(int, uschar *, int, int);
222 extern int ip_socket(int, int);
224 extern int ip_tcpsocket(const uschar *, uschar **, int);
225 extern int ip_unixsocket(const uschar *, uschar **);
226 extern int ip_streamsocket(const uschar *, uschar **, int);
228 extern uschar *local_part_quote(uschar *);
229 extern int log_create(uschar *);
230 extern int log_create_as_exim(uschar *);
231 extern void log_close_all(void);
233 #ifdef WITH_CONTENT_SCAN
234 extern int malware(const uschar *, int);
235 extern int malware_in_file(uschar *);
236 extern void malware_init(void);
238 extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
239 unsigned int *, int, int, const uschar **);
240 extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
241 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
242 const uschar *, const uschar **);
243 extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
244 unsigned int *, int, BOOL, const uschar **);
245 extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
247 extern void md5_end(md5 *, const uschar *, int, uschar *);
248 extern void md5_mid(md5 *, const uschar *);
249 extern void md5_start(md5 *);
250 extern void millisleep(int);
251 #ifdef WITH_CONTENT_SCAN
252 struct mime_boundary_context;
253 extern int mime_acl_check(uschar *acl, FILE *f,
254 struct mime_boundary_context *, uschar **, uschar **);
255 extern int mime_decode(const uschar **);
256 extern int mime_regex(const uschar **);
258 extern uschar *moan_check_errorcopy(uschar *);
259 extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
261 extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
262 extern void moan_tell_someone(uschar *, address_item *,
263 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
264 extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
265 extern void moan_write_from(FILE *);
266 extern FILE *modefopen(const uschar *, const char *, mode_t);
268 extern void open_cutthrough_connection( address_item * addr );
270 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
272 extern int parse_forward_list(uschar *, int, address_item **, uschar **,
273 const uschar *, uschar *, error_block **);
274 extern uschar *parse_find_address_end(uschar *, BOOL);
275 extern uschar *parse_find_at(uschar *);
276 extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
277 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
278 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
279 extern uschar *parse_date_time(uschar *str, time_t *t);
280 extern int vaguely_random_number(int);
282 extern int vaguely_random_number_fallback(int);
285 extern BOOL queue_action(uschar *, int, uschar **, int, int);
286 extern void queue_check_only(void);
287 extern void queue_list(int, uschar **, int);
288 extern void queue_count(void);
289 extern void queue_run(uschar *, uschar *, BOOL);
291 extern int random_number(int);
292 extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
293 uschar *, uschar *, uschar *, ugid_block *, address_item **,
294 uschar **, error_block **, int *, uschar *);
295 extern int rda_is_filter(const uschar *);
296 extern BOOL readconf_depends(driver_instance *, uschar *);
297 extern void readconf_driver_init(uschar *, driver_instance **,
298 driver_info *, int, void *, int, optionlist *, int);
299 extern uschar *readconf_find_option(void *);
300 extern void readconf_main(void);
301 extern void readconf_print(uschar *, uschar *, BOOL);
302 extern uschar *readconf_printtime(int);
303 extern uschar *readconf_readname(uschar *, int, uschar *);
304 extern int readconf_readtime(const uschar *, int, BOOL);
305 extern void readconf_rest();
306 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
307 extern void read_message_body(BOOL);
308 extern void receive_bomb_out(uschar *, uschar *);
309 extern BOOL receive_check_fs(int);
310 extern BOOL receive_check_set_sender(uschar *);
311 extern BOOL receive_msg(BOOL);
312 extern int receive_statvfs(BOOL, int *);
313 extern void receive_swallow_smtp(void);
314 #ifdef WITH_CONTENT_SCAN
315 extern int regex(const uschar **);
317 extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
318 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
319 extern void retry_add_item(address_item *, uschar *, int);
320 extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
321 uschar **, uschar **);
322 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
323 extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
324 dbdata_retry *, time_t);
325 extern void retry_update(address_item **, address_item **, address_item **);
326 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
327 extern uschar *rewrite_address_qualify(uschar *, BOOL);
328 extern header_line *rewrite_header(header_line *,
329 const uschar *, const uschar *,
330 rewrite_rule *, int, BOOL);
331 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
333 extern void rewrite_test(uschar *);
334 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
336 extern int route_address(address_item *, address_item **, address_item **,
337 address_item **, address_item **, int);
338 extern int route_check_prefix(const uschar *, const uschar *);
339 extern int route_check_suffix(const uschar *, const uschar *);
340 extern BOOL route_findgroup(uschar *, gid_t *);
341 extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
342 extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
344 extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
345 struct passwd **, uid_t *, uschar **);
346 extern void route_init(void);
347 extern void route_tidyup(void);
349 extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
351 extern int search_findtype(const uschar *, int);
352 extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
354 extern void *search_open(uschar *, int, int, uid_t *, gid_t *);
355 extern void search_tidyup(void);
356 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
357 extern void sha1_end(sha1 *, const uschar *, int, uschar *);
358 extern void sha1_mid(sha1 *, const uschar *);
359 extern void sha1_start(sha1 *);
360 extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
361 uschar *, address_item **, uschar **);
362 extern void sigalrm_handler(int);
363 extern BOOL smtp_buffered(void);
364 extern void smtp_closedown(uschar *);
365 extern int smtp_connect(host_item *, int, int, uschar *, int,
366 transport_instance *);
367 extern int smtp_sock_connect(host_item *, int, int, uschar *,
368 transport_instance * tb, int);
369 extern int smtp_feof(void);
370 extern int smtp_ferror(void);
371 extern uschar *smtp_get_connection_info(void);
372 extern BOOL smtp_get_interface(uschar *, int, address_item *, BOOL *,
373 uschar **, uschar *);
374 extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
375 extern int smtp_getc(void);
376 extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
377 extern void smtp_log_no_mail(void);
378 extern void smtp_message_code(uschar **, int *, uschar **, uschar **);
379 extern BOOL smtp_read_response(smtp_inblock *, uschar *, int, int, int);
380 extern void smtp_respond(uschar *, int, BOOL, uschar *);
381 extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
382 extern void smtp_send_prohibition_message(int, uschar *);
383 extern int smtp_setup_msg(void);
384 extern BOOL smtp_start_session(void);
385 extern int smtp_ungetc(int);
386 extern BOOL smtp_verify_helo(void);
387 extern int smtp_write_command(smtp_outblock *, BOOL, const char *, ...) PRINTF_FUNCTION(3,4);
388 #ifdef WITH_CONTENT_SCAN
389 extern int spam(const uschar **);
390 extern FILE *spool_mbox(unsigned long *, const uschar *);
392 extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
393 extern BOOL spool_open_datafile(uschar *);
394 extern int spool_open_temp(uschar *);
395 extern int spool_read_header(uschar *, BOOL, BOOL);
396 extern int spool_write_header(uschar *, int, uschar **);
397 extern int stdin_getc(void);
398 extern int stdin_feof(void);
399 extern int stdin_ferror(void);
400 extern int stdin_ungetc(int);
401 extern uschar *string_append(uschar *, int *, int *, int, ...);
402 extern uschar *string_append_listele(uschar *, uschar, const uschar *);
403 extern uschar *string_append_listele_n(uschar *, uschar, const uschar *, unsigned);
404 extern uschar *string_base62(unsigned long int);
405 extern uschar *string_cat(uschar *, int *, int *, const uschar *, int);
406 extern uschar *string_copy_dnsdomain(uschar *);
407 extern uschar *string_copy_malloc(const uschar *);
408 extern uschar *string_copylc(const uschar *);
409 extern uschar *string_copynlc(uschar *, int);
410 extern uschar *string_dequote(const uschar **);
411 extern BOOL string_format(uschar *, int, const char *, ...) ALMOST_PRINTF(3,4);
412 extern uschar *string_format_size(int, uschar *);
413 extern int string_interpret_escape(const uschar **);
414 extern int string_is_ip_address(const uschar *, int *);
415 #ifdef EXPERIMENTAL_INTERNATIONAL
416 extern BOOL string_is_utf8(const uschar *);
418 extern uschar *string_log_address(address_item *, BOOL, BOOL);
419 extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
420 extern uschar *string_open_failed(int, const char *, ...) PRINTF_FUNCTION(2,3);
421 extern const uschar *string_printing2(const uschar *, BOOL);
422 extern uschar *string_split_message(uschar *);
423 extern uschar *string_unprinting(uschar *);
424 #ifdef EXPERIMENTAL_INTERNATIONAL
425 extern uschar *string_address_alabel_to_utf8(const uschar *, uschar **);
426 extern uschar *string_address_utf8_to_alabel(uschar *, uschar **, int *);
427 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
428 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
429 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
430 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
432 extern BOOL string_vformat(uschar *, int, const char *, va_list);
433 extern int strcmpic(const uschar *, const uschar *);
434 extern int strncmpic(const uschar *, const uschar *, int);
435 extern uschar *strstric(uschar *, uschar *, BOOL);
437 extern uschar *tod_stamp(int);
439 extern void tls_modify_variables(tls_support *);
440 extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
441 BOOL *, oicf, void*);
442 extern void transport_init(void);
443 extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
445 extern uschar *transport_rcpt_address(address_item *, BOOL);
446 extern BOOL transport_set_up_command(const uschar ***, uschar *,
447 BOOL, int, address_item *, uschar *, uschar **);
448 extern void transport_update_waiting(host_item *, uschar *);
449 extern BOOL transport_write_block(int, uschar *, int);
450 extern BOOL transport_write_string(int, const char *, ...);
451 extern BOOL transport_headers_send(address_item *, int, uschar *, uschar *,
452 BOOL (*)(int, uschar *, int, BOOL), BOOL, rewrite_rule *, int);
453 extern BOOL transport_write_message(address_item *, int, int, int, uschar *,
454 uschar *, uschar *, uschar *, rewrite_rule *, int);
455 extern void tree_add_duplicate(uschar *, address_item *);
456 extern void tree_add_nonrecipient(uschar *);
457 extern void tree_add_unusable(host_item *);
458 extern int tree_insertnode(tree_node **, tree_node *);
459 extern tree_node *tree_search(tree_node *, const uschar *);
460 extern void tree_write(tree_node *, FILE *);
461 extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
463 #ifdef WITH_CONTENT_SCAN
464 extern void unspool_mbox(void);
467 extern int verify_address(address_item *, FILE *, int, int, int, int,
468 uschar *, uschar *, BOOL *);
469 extern int verify_check_dnsbl(const uschar **);
470 extern int verify_check_header_address(uschar **, uschar **, int, int, int,
471 uschar *, uschar *, int, int *);
472 extern int verify_check_headers(uschar **);
473 extern int verify_check_header_names_ascii(uschar **);
474 extern int verify_check_host(uschar **);
475 extern int verify_check_notblind(void);
476 extern int verify_check_given_host(uschar **, host_item *);
477 extern int verify_check_this_host(const uschar **, unsigned int *,
478 const uschar*, const uschar *, const uschar **);
479 extern address_item *verify_checked_sender(uschar *);
480 extern void verify_get_ident(int);
481 extern BOOL verify_sender(int *, uschar **);
482 extern BOOL verify_sender_preliminary(int *, uschar **);
483 extern void version_init(void);
485 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
489 /* End of functions.h */