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