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