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