5616db2dece2477dfdb582baab899b6e1d4ffd5f
1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
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
*);
28 extern int tls_client_start(int, host_item
*, address_item
*, uschar
*,
29 uschar
*, uschar
*, uschar
*, uschar
*, uschar
*, uschar
*,
31 extern void tls_close(BOOL
);
32 extern int tls_feof(void);
33 extern int tls_ferror(void);
34 extern int tls_getc(void);
35 extern int tls_read(uschar
*, size_t);
36 extern int tls_server_start(const uschar
*);
37 extern BOOL
tls_smtp_buffered(void);
38 extern int tls_ungetc(int);
39 extern int tls_write(const uschar
*, size_t);
40 extern uschar
*tls_validate_require_cipher(void);
41 extern void tls_version_report(FILE *);
43 extern BOOL
tls_openssl_options_parse(uschar
*, long *);
48 /* Everything else... */
50 extern acl_block
*acl_read(uschar
*(*)(void), uschar
**);
51 extern int acl_check(int, uschar
*, uschar
*, uschar
**, uschar
**);
52 extern tree_node
*acl_var_create(uschar
*);
53 extern void acl_var_write(uschar
*, uschar
*, void *);
54 extern uschar
*auth_b64encode(uschar
*, int);
55 extern int auth_b64decode(uschar
*, uschar
**);
56 extern int auth_call_pam(uschar
*, uschar
**);
57 extern int auth_call_pwcheck(uschar
*, uschar
**);
58 extern int auth_call_radius(uschar
*, uschar
**);
59 extern int auth_call_saslauthd(uschar
*, uschar
*, uschar
*, uschar
*,
61 extern int auth_check_serv_cond(auth_instance
*);
62 extern int auth_check_some_cond(auth_instance
*, uschar
*, uschar
*, int);
64 extern int auth_get_data(uschar
**, uschar
*, int);
65 extern int auth_get_no64_data(uschar
**, uschar
*);
66 extern uschar
*auth_xtextencode(uschar
*, int);
67 extern int auth_xtextdecode(uschar
*, uschar
**);
69 extern int check_host(void *, uschar
*, uschar
**, uschar
**);
70 extern uschar
**child_exec_exim(int, BOOL
, int *, BOOL
, int, ...);
71 extern pid_t
child_open_uid(uschar
**, uschar
**, int, uid_t
*, gid_t
*,
72 int *, int *, uschar
*, BOOL
);
74 extern void daemon_go(void);
76 #ifdef EXPERIMENTAL_DCC
77 extern int dcc_process(uschar
**);
80 extern void debug_logging_activate(uschar
*, uschar
*);
81 extern void debug_print_argv(uschar
**);
82 extern void debug_print_ids(uschar
*);
83 extern void debug_print_string(uschar
*);
84 extern void debug_print_tree(tree_node
*);
85 extern void debug_vprintf(const char *, va_list);
86 extern void decode_bits(unsigned int *, unsigned int *,
87 int, int, uschar
*, bit_table
*, int, uschar
*, int);
88 extern address_item
*deliver_make_addr(uschar
*, BOOL
);
89 extern int deliver_message(uschar
*, BOOL
, BOOL
);
90 extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
91 extern void deliver_set_expansions(address_item
*);
92 extern int deliver_split_address(address_item
*);
93 extern void deliver_succeeded(address_item
*);
94 #ifdef WITH_OLD_DEMIME
95 extern int demime(uschar
**);
97 extern BOOL
directory_make(const uschar
*, const uschar
*, int, BOOL
);
99 extern BOOL
dkim_transport_write_message(address_item
*, int, int,
100 int, uschar
*, uschar
*, uschar
*, uschar
*, rewrite_rule
*,
101 int, uschar
*, uschar
*, uschar
*, uschar
*, uschar
*, uschar
*);
103 extern dns_address
*dns_address_from_rr(dns_answer
*, dns_record
*);
104 extern void dns_build_reverse(uschar
*, uschar
*);
105 extern void dns_init(BOOL
, BOOL
);
106 extern int dns_basic_lookup(dns_answer
*, uschar
*, int);
107 extern BOOL
dns_is_secure(dns_answer
*);
108 extern int dns_lookup(dns_answer
*, uschar
*, int, uschar
**);
109 extern int dns_special_lookup(dns_answer
*, uschar
*, int, uschar
**);
110 extern dns_record
*dns_next_rr(dns_answer
*, dns_scan
*, int);
111 extern uschar
*dns_text_type(int);
113 extern void enq_end(uschar
*);
114 extern BOOL
enq_start(uschar
*);
115 extern void exim_exit(int);
116 extern void exim_nullstd(void);
117 extern void exim_setugid(uid_t
, gid_t
, BOOL
, uschar
*);
118 extern int exim_tvcmp(struct timeval
*, struct timeval
*);
119 extern void exim_wait_tick(struct timeval
*, int);
120 extern BOOL
expand_check_condition(uschar
*, uschar
*, uschar
*);
121 extern uschar
*expand_string(uschar
*);
122 extern uschar
*expand_string_copy(uschar
*);
123 extern int_eximarith_t
expand_string_integer(uschar
*, BOOL
);
125 extern int filter_interpret(uschar
*, int, address_item
**, uschar
**);
126 extern BOOL
filter_personal(string_item
*, BOOL
);
127 extern BOOL
filter_runtest(int, uschar
*, BOOL
, BOOL
);
128 extern BOOL
filter_system_interpret(address_item
**, uschar
**);
130 extern void header_add(int, const char *, ...);
131 extern int header_checkname(header_line
*, BOOL
);
132 extern BOOL
header_match(uschar
*, BOOL
, BOOL
, string_item
*, int, ...);
133 extern int host_address_extract_port(uschar
*);
134 extern uschar
*host_and_ident(BOOL
);
135 extern int host_aton(uschar
*, int *);
136 extern void host_build_hostlist(host_item
**, uschar
*, BOOL
);
137 extern ip_address_item
*host_build_ifacelist(uschar
*, uschar
*);
138 extern void host_build_log_info(void);
139 extern void host_build_sender_fullhost(void);
140 extern BOOL
host_find_byname(host_item
*, uschar
*, int, uschar
**, BOOL
);
141 extern int host_find_bydns(host_item
*, uschar
*, int, uschar
*, uschar
*,
142 uschar
*,uschar
**, BOOL
*);
143 extern ip_address_item
*host_find_interfaces(void);
144 extern BOOL
host_is_in_net(uschar
*, uschar
*, int);
145 extern BOOL
host_is_tls_on_connect_port(int);
146 extern int host_item_get_port(host_item
*);
147 extern void host_mask(int, int *, int);
148 extern int host_name_lookup(void);
149 extern int host_nmtoa(int, int *, int, uschar
*, int);
150 extern uschar
*host_ntoa(int, const void *, uschar
*, int *);
151 extern int host_scan_for_local_hosts(host_item
*, host_item
**, BOOL
*);
153 extern void invert_address(uschar
*, uschar
*);
154 extern int ip_bind(int, int, uschar
*, int);
155 extern int ip_connect(int, int, uschar
*, int, int);
156 extern void ip_keepalive(int, uschar
*, BOOL
);
157 extern int ip_recv(int, uschar
*, int, int);
158 extern int ip_socket(int, int);
160 extern uschar
*local_part_quote(uschar
*);
161 extern int log_create_as_exim(uschar
*);
162 extern void log_close_all(void);
164 #ifdef WITH_CONTENT_SCAN
165 extern int malware(uschar
**);
166 extern int malware_in_file(uschar
*);
168 extern int match_address_list(uschar
*, BOOL
, BOOL
, uschar
**,
169 unsigned int *, int, int, uschar
**);
170 extern int match_check_list(uschar
**, int, tree_node
**, unsigned int **,
171 int(*)(void *, uschar
*, uschar
**, uschar
**), void *, int,
172 uschar
*, uschar
**);
173 extern int match_isinlist(uschar
*, uschar
**, int, tree_node
**,
174 unsigned int *, int, BOOL
, uschar
**);
175 extern int match_check_string(uschar
*, uschar
*, int, BOOL
, BOOL
, BOOL
,
177 extern void md5_end(md5
*, const uschar
*, int, uschar
*);
178 extern void md5_mid(md5
*, const uschar
*);
179 extern void md5_start(md5
*);
180 extern void millisleep(int);
181 #ifdef WITH_CONTENT_SCAN
182 struct mime_boundary_context
;
183 extern int mime_acl_check(uschar
*acl
, FILE *f
,
184 struct mime_boundary_context
*, uschar
**, uschar
**);
185 extern int mime_decode(uschar
**);
186 extern int mime_regex(uschar
**);
188 extern uschar
*moan_check_errorcopy(uschar
*);
189 extern BOOL
moan_skipped_syntax_errors(uschar
*, error_block
*, uschar
*,
191 extern void moan_smtp_batch(uschar
*, const char *, ...) PRINTF_FUNCTION(2,3);
192 extern void moan_tell_someone(uschar
*, address_item
*,
193 const uschar
*, const char *, ...) PRINTF_FUNCTION(4,5);
194 extern BOOL
moan_to_sender(int, error_block
*, header_line
*, FILE *, BOOL
);
195 extern void moan_write_from(FILE *);
196 extern FILE *modefopen(const uschar
*, const char *, mode_t
);
198 extern uschar
*parse_extract_address(uschar
*, uschar
**, int *, int *, int *,
200 extern int parse_forward_list(uschar
*, int, address_item
**, uschar
**,
201 uschar
*, uschar
*, error_block
**);
202 extern uschar
*parse_find_address_end(uschar
*, BOOL
);
203 extern uschar
*parse_find_at(uschar
*);
204 extern uschar
*parse_fix_phrase(uschar
*, int, uschar
*, int);
205 extern uschar
*parse_message_id(uschar
*, uschar
**, uschar
**);
206 extern uschar
*parse_quote_2047(uschar
*, int, uschar
*, uschar
*, int, BOOL
);
207 extern uschar
*parse_date_time(uschar
*str
, time_t *t
);
208 extern int vaguely_random_number(int);
210 extern int vaguely_random_number_fallback(int);
213 extern BOOL
queue_action(uschar
*, int, uschar
**, int, int);
214 extern void queue_check_only(void);
215 extern void queue_list(int, uschar
**, int);
216 extern void queue_count(void);
217 extern void queue_run(uschar
*, uschar
*, BOOL
);
219 extern int random_number(int);
220 #ifdef WITH_CONTENT_SCAN
221 extern int recv_line(int, uschar
*, int);
223 extern int rda_interpret(redirect_block
*, int, uschar
*, uschar
*,
224 uschar
*, uschar
*, uschar
*, ugid_block
*, address_item
**,
225 uschar
**, error_block
**, int *, uschar
*);
226 extern int rda_is_filter(const uschar
*);
227 extern BOOL
readconf_depends(driver_instance
*, uschar
*);
228 extern void readconf_driver_init(uschar
*, driver_instance
**,
229 driver_info
*, int, void *, int, optionlist
*, int);
230 extern uschar
*readconf_find_option(void *);
231 extern void readconf_main(void);
232 extern void readconf_print(uschar
*, uschar
*, BOOL
);
233 extern uschar
*readconf_printtime(int);
234 extern uschar
*readconf_readname(uschar
*, int, uschar
*);
235 extern int readconf_readtime(uschar
*, int, BOOL
);
236 extern void readconf_rest(BOOL
);
237 extern uschar
*readconf_retry_error(uschar
*, uschar
*, int *, int *);
238 extern void read_message_body(BOOL
);
239 extern void receive_bomb_out(uschar
*, uschar
*);
240 extern BOOL
receive_check_fs(int);
241 extern BOOL
receive_check_set_sender(uschar
*);
242 extern BOOL
receive_msg(BOOL
);
243 extern int receive_statvfs(BOOL
, int *);
244 extern void receive_swallow_smtp(void);
245 #ifdef WITH_CONTENT_SCAN
246 extern int regex(uschar
**);
248 extern BOOL
regex_match_and_setup(const pcre
*, uschar
*, int, int);
249 extern const pcre
*regex_must_compile(uschar
*, BOOL
, BOOL
);
250 extern void retry_add_item(address_item
*, uschar
*, int);
251 extern BOOL
retry_check_address(uschar
*, host_item
*, uschar
*, BOOL
,
252 uschar
**, uschar
**);
253 extern retry_config
*retry_find_config(uschar
*, uschar
*, int, int);
254 extern void retry_update(address_item
**, address_item
**, address_item
**);
255 extern uschar
*rewrite_address(uschar
*, BOOL
, BOOL
, rewrite_rule
*, int);
256 extern uschar
*rewrite_address_qualify(uschar
*, BOOL
);
257 extern header_line
*rewrite_header(header_line
*, uschar
*, uschar
*,
258 rewrite_rule
*, int, BOOL
);
259 extern uschar
*rewrite_one(uschar
*, int, BOOL
*, BOOL
, uschar
*,
261 extern void rewrite_test(uschar
*);
262 extern uschar
*rfc2047_decode2(uschar
*, BOOL
, uschar
*, int, int *, int *,
264 extern int route_address(address_item
*, address_item
**, address_item
**,
265 address_item
**, address_item
**, int);
266 extern int route_check_prefix(uschar
*, uschar
*);
267 extern int route_check_suffix(uschar
*, uschar
*);
268 extern BOOL
route_findgroup(uschar
*, gid_t
*);
269 extern BOOL
route_finduser(uschar
*, struct passwd
**, uid_t
*);
270 extern BOOL
route_find_expanded_group(uschar
*, uschar
*, uschar
*, gid_t
*,
272 extern BOOL
route_find_expanded_user(uschar
*, uschar
*, uschar
*,
273 struct passwd
**, uid_t
*, uschar
**);
274 extern void route_init(void);
275 extern void route_tidyup(void);
277 extern uschar
*search_find(void *, uschar
*, uschar
*, int, uschar
*, int,
279 extern int search_findtype(uschar
*, int);
280 extern int search_findtype_partial(uschar
*, int *, uschar
**, int *,
282 extern void *search_open(uschar
*, int, int, uid_t
*, gid_t
*);
283 extern void search_tidyup(void);
284 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
285 extern void sha1_end(sha1
*, const uschar
*, int, uschar
*);
286 extern void sha1_mid(sha1
*, const uschar
*);
287 extern void sha1_start(sha1
*);
288 extern int sieve_interpret(uschar
*, int, uschar
*, uschar
*, uschar
*,
289 uschar
*, address_item
**, uschar
**);
290 extern void sigalrm_handler(int);
291 extern BOOL
smtp_buffered(void);
292 extern void smtp_closedown(uschar
*);
293 extern int smtp_connect(host_item
*, int, int, uschar
*, int, BOOL
);
294 extern int smtp_feof(void);
295 extern int smtp_ferror(void);
296 extern uschar
*smtp_get_connection_info(void);
297 extern BOOL
smtp_get_interface(uschar
*, int, address_item
*, BOOL
*,
298 uschar
**, uschar
*);
299 extern BOOL
smtp_get_port(uschar
*, address_item
*, int *, uschar
*);
300 extern int smtp_getc(void);
301 extern int smtp_handle_acl_fail(int, int, uschar
*, uschar
*);
302 extern void smtp_log_no_mail(void);
303 extern void smtp_message_code(uschar
**, int *, uschar
**, uschar
**);
304 extern BOOL
smtp_read_response(smtp_inblock
*, uschar
*, int, int, int);
305 extern void smtp_respond(uschar
*, int, BOOL
, uschar
*);
306 extern void smtp_notquit_exit(uschar
*, uschar
*, uschar
*, ...);
307 extern void smtp_send_prohibition_message(int, uschar
*);
308 extern int smtp_setup_msg(void);
309 extern BOOL
smtp_start_session(void);
310 extern int smtp_ungetc(int);
311 extern BOOL
smtp_verify_helo(void);
312 extern int smtp_write_command(smtp_outblock
*, BOOL
, const char *, ...) PRINTF_FUNCTION(3,4);
313 #ifdef WITH_CONTENT_SCAN
314 extern int spam(uschar
**);
315 extern FILE *spool_mbox(unsigned long *, uschar
*);
317 extern BOOL
spool_move_message(uschar
*, uschar
*, uschar
*, uschar
*);
318 extern BOOL
spool_open_datafile(uschar
*);
319 extern int spool_open_temp(uschar
*);
320 extern int spool_read_header(uschar
*, BOOL
, BOOL
);
321 extern int spool_write_header(uschar
*, int, uschar
**);
322 extern int stdin_getc(void);
323 extern int stdin_feof(void);
324 extern int stdin_ferror(void);
325 extern int stdin_ungetc(int);
326 extern uschar
*string_append(uschar
*, int *, int *, int, ...);
327 extern uschar
*string_base62(unsigned long int);
328 extern uschar
*string_cat(uschar
*, int *, int *, const uschar
*, int);
329 extern uschar
*string_copy_dnsdomain(uschar
*);
330 extern uschar
*string_copy_malloc(uschar
*);
331 extern uschar
*string_copylc(uschar
*);
332 extern uschar
*string_copynlc(uschar
*, int);
333 extern uschar
*string_dequote(uschar
**);
334 extern BOOL
string_format(uschar
*, int, const char *, ...) ALMOST_PRINTF(3,4);
335 extern uschar
*string_format_size(int, uschar
*);
336 extern int string_interpret_escape(uschar
**);
337 extern int string_is_ip_address(uschar
*, int *);
338 extern uschar
*string_log_address(address_item
*, BOOL
, BOOL
);
339 extern uschar
*string_nextinlist(uschar
**, int *, uschar
*, int);
340 extern uschar
*string_open_failed(int, const char *, ...) PRINTF_FUNCTION(2,3);
341 extern uschar
*string_printing2(uschar
*, BOOL
);
342 extern uschar
*string_split_message(uschar
*);
343 extern uschar
*string_unprinting(uschar
*);
344 extern BOOL
string_vformat(uschar
*, int, const char *, va_list);
345 extern int strcmpic(const uschar
*, const uschar
*);
346 extern int strncmpic(const uschar
*, const uschar
*, int);
347 extern uschar
*strstric(uschar
*, uschar
*, BOOL
);
349 extern uschar
*tod_stamp(int);
350 extern BOOL
transport_check_waiting(uschar
*, uschar
*, int, uschar
*,
352 extern void transport_init(void);
353 extern BOOL
transport_pass_socket(uschar
*, uschar
*, uschar
*, uschar
*,
355 extern uschar
*transport_rcpt_address(address_item
*, BOOL
);
356 extern BOOL
transport_set_up_command(uschar
***, uschar
*, BOOL
, int,
357 address_item
*, uschar
*, uschar
**);
358 extern void transport_update_waiting(host_item
*, uschar
*);
359 extern BOOL
transport_write_block(int, uschar
*, int);
360 extern BOOL
transport_write_string(int, const char *, ...);
361 extern BOOL
transport_write_message(address_item
*, int, int, int, uschar
*,
362 uschar
*, uschar
*, uschar
*, rewrite_rule
*, int);
363 extern void tree_add_duplicate(uschar
*, address_item
*);
364 extern void tree_add_nonrecipient(uschar
*);
365 extern void tree_add_unusable(host_item
*);
366 extern int tree_insertnode(tree_node
**, tree_node
*);
367 extern tree_node
*tree_search(tree_node
*, uschar
*);
368 extern void tree_write(tree_node
*, FILE *);
369 extern void tree_walk(tree_node
*, void (*)(uschar
*, uschar
*, void*), void *);
371 #ifdef WITH_CONTENT_SCAN
372 extern void unspool_mbox(void);
375 extern int verify_address(address_item
*, FILE *, int, int, int, int,
376 uschar
*, uschar
*, BOOL
*);
377 extern int verify_check_dnsbl(uschar
**);
378 extern int verify_check_header_address(uschar
**, uschar
**, int, int, int,
379 uschar
*, uschar
*, int, int *);
380 extern int verify_check_headers(uschar
**);
381 extern int verify_check_host(uschar
**);
382 extern int verify_check_notblind(void);
383 extern int verify_check_this_host(uschar
**, unsigned int *, uschar
*,
384 uschar
*, uschar
**);
385 extern address_item
*verify_checked_sender(uschar
*);
386 extern void verify_get_ident(int);
387 extern BOOL
verify_sender(int *, uschar
**);
388 extern BOOL
verify_sender_preliminary(int *, uschar
**);
389 extern void version_init(void);
391 extern ssize_t
write_to_fd_buf(int, const uschar
*, size_t);
393 /* End of functions.h */