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