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