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 void cancel_cutthrough_connection(void);
70 extern int check_host(void *, uschar
*, uschar
**, uschar
**);
71 extern uschar
**child_exec_exim(int, BOOL
, int *, BOOL
, int, ...);
72 extern pid_t
child_open_uid(uschar
**, uschar
**, int, uid_t
*, gid_t
*,
73 int *, int *, uschar
*, BOOL
);
74 extern uschar
*cutthrough_finaldot(void);
75 extern BOOL
cutthrough_flush_send(void);
76 extern BOOL
cutthrough_headers_send(void);
77 extern BOOL
cutthrough_predata(void);
78 extern BOOL
cutthrough_puts(uschar
*, int);
79 extern BOOL
cutthrough_put_nl(void);
81 extern void daemon_go(void);
83 #ifdef EXPERIMENTAL_DCC
84 extern int dcc_process(uschar
**);
87 extern void debug_logging_activate(uschar
*, uschar
*);
88 extern void debug_print_argv(uschar
**);
89 extern void debug_print_ids(uschar
*);
90 extern void debug_print_string(uschar
*);
91 extern void debug_print_tree(tree_node
*);
92 extern void debug_vprintf(const char *, va_list);
93 extern void decode_bits(unsigned int *, unsigned int *,
94 int, int, uschar
*, bit_table
*, int, uschar
*, int);
95 extern address_item
*deliver_make_addr(uschar
*, BOOL
);
96 extern void delivery_log(address_item
*, int);
97 extern int deliver_message(uschar
*, BOOL
, BOOL
);
98 extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
99 extern void deliver_set_expansions(address_item
*);
100 extern int deliver_split_address(address_item
*);
101 extern void deliver_succeeded(address_item
*);
102 #ifdef WITH_OLD_DEMIME
103 extern int demime(uschar
**);
105 extern BOOL
directory_make(const uschar
*, const uschar
*, int, BOOL
);
107 extern BOOL
dkim_transport_write_message(address_item
*, int, int,
108 int, uschar
*, uschar
*, uschar
*, uschar
*, rewrite_rule
*,
109 int, uschar
*, uschar
*, uschar
*, uschar
*, uschar
*, uschar
*);
111 extern dns_address
*dns_address_from_rr(dns_answer
*, dns_record
*);
112 extern void dns_build_reverse(uschar
*, uschar
*);
113 extern void dns_init(BOOL
, BOOL
);
114 extern int dns_basic_lookup(dns_answer
*, uschar
*, int);
115 extern BOOL
dns_is_secure(dns_answer
*);
116 extern int dns_lookup(dns_answer
*, uschar
*, int, uschar
**);
117 extern int dns_special_lookup(dns_answer
*, uschar
*, int, uschar
**);
118 extern dns_record
*dns_next_rr(dns_answer
*, dns_scan
*, int);
119 extern uschar
*dns_text_type(int);
120 extern void dscp_list_to_stream(FILE *);
121 extern BOOL
dscp_lookup(const uschar
*, int, int *, int *, int *);
123 extern void enq_end(uschar
*);
124 extern BOOL
enq_start(uschar
*);
125 extern void exim_exit(int);
126 extern void exim_nullstd(void);
127 extern void exim_setugid(uid_t
, gid_t
, BOOL
, uschar
*);
128 extern int exim_tvcmp(struct timeval
*, struct timeval
*);
129 extern void exim_wait_tick(struct timeval
*, int);
130 extern BOOL
expand_check_condition(uschar
*, uschar
*, uschar
*);
131 extern uschar
*expand_string(uschar
*);
132 extern uschar
*expand_string_copy(uschar
*);
133 extern int_eximarith_t
expand_string_integer(uschar
*, BOOL
);
135 extern int filter_interpret(uschar
*, int, address_item
**, uschar
**);
136 extern BOOL
filter_personal(string_item
*, BOOL
);
137 extern BOOL
filter_runtest(int, uschar
*, BOOL
, BOOL
);
138 extern BOOL
filter_system_interpret(address_item
**, uschar
**);
140 extern void header_add(int, const char *, ...);
141 extern int header_checkname(header_line
*, BOOL
);
142 extern BOOL
header_match(uschar
*, BOOL
, BOOL
, string_item
*, int, ...);
143 extern int host_address_extract_port(uschar
*);
144 extern uschar
*host_and_ident(BOOL
);
145 extern int host_aton(uschar
*, int *);
146 extern void host_build_hostlist(host_item
**, uschar
*, BOOL
);
147 extern ip_address_item
*host_build_ifacelist(uschar
*, uschar
*);
148 extern void host_build_log_info(void);
149 extern void host_build_sender_fullhost(void);
150 extern BOOL
host_find_byname(host_item
*, uschar
*, int, uschar
**, BOOL
);
151 extern int host_find_bydns(host_item
*, uschar
*, int, uschar
*, uschar
*,
152 uschar
*,uschar
**, BOOL
*);
153 extern ip_address_item
*host_find_interfaces(void);
154 extern BOOL
host_is_in_net(uschar
*, uschar
*, int);
155 extern BOOL
host_is_tls_on_connect_port(int);
156 extern int host_item_get_port(host_item
*);
157 extern void host_mask(int, int *, int);
158 extern int host_name_lookup(void);
159 extern int host_nmtoa(int, int *, int, uschar
*, int);
160 extern uschar
*host_ntoa(int, const void *, uschar
*, int *);
161 extern int host_scan_for_local_hosts(host_item
*, host_item
**, BOOL
*);
163 extern void invert_address(uschar
*, uschar
*);
164 extern int ip_bind(int, int, uschar
*, int);
165 extern int ip_connect(int, int, uschar
*, int, int);
166 extern int ip_get_address_family(int);
167 extern void ip_keepalive(int, uschar
*, BOOL
);
168 extern int ip_recv(int, uschar
*, int, int);
169 extern int ip_socket(int, int);
171 extern uschar
*local_part_quote(uschar
*);
172 extern int log_create_as_exim(uschar
*);
173 extern void log_close_all(void);
175 #ifdef WITH_CONTENT_SCAN
176 extern int malware(uschar
**);
177 extern int malware_in_file(uschar
*);
179 extern int match_address_list(uschar
*, BOOL
, BOOL
, uschar
**,
180 unsigned int *, int, int, uschar
**);
181 extern int match_check_list(uschar
**, int, tree_node
**, unsigned int **,
182 int(*)(void *, uschar
*, uschar
**, uschar
**), void *, int,
183 uschar
*, uschar
**);
184 extern int match_isinlist(uschar
*, uschar
**, int, tree_node
**,
185 unsigned int *, int, BOOL
, uschar
**);
186 extern int match_check_string(uschar
*, uschar
*, int, BOOL
, BOOL
, BOOL
,
188 extern void md5_end(md5
*, const uschar
*, int, uschar
*);
189 extern void md5_mid(md5
*, const uschar
*);
190 extern void md5_start(md5
*);
191 extern void millisleep(int);
192 #ifdef WITH_CONTENT_SCAN
193 struct mime_boundary_context
;
194 extern int mime_acl_check(uschar
*acl
, FILE *f
,
195 struct mime_boundary_context
*, uschar
**, uschar
**);
196 extern int mime_decode(uschar
**);
197 extern int mime_regex(uschar
**);
199 extern uschar
*moan_check_errorcopy(uschar
*);
200 extern BOOL
moan_skipped_syntax_errors(uschar
*, error_block
*, uschar
*,
202 extern void moan_smtp_batch(uschar
*, const char *, ...) PRINTF_FUNCTION(2,3);
203 extern void moan_tell_someone(uschar
*, address_item
*,
204 const uschar
*, const char *, ...) PRINTF_FUNCTION(4,5);
205 extern BOOL
moan_to_sender(int, error_block
*, header_line
*, FILE *, BOOL
);
206 extern void moan_write_from(FILE *);
207 extern FILE *modefopen(const uschar
*, const char *, mode_t
);
209 extern void open_cutthrough_connection( address_item
* addr
);
211 extern uschar
*parse_extract_address(uschar
*, uschar
**, int *, int *, int *,
213 extern int parse_forward_list(uschar
*, int, address_item
**, uschar
**,
214 uschar
*, uschar
*, error_block
**);
215 extern uschar
*parse_find_address_end(uschar
*, BOOL
);
216 extern uschar
*parse_find_at(uschar
*);
217 extern uschar
*parse_fix_phrase(uschar
*, int, uschar
*, int);
218 extern uschar
*parse_message_id(uschar
*, uschar
**, uschar
**);
219 extern uschar
*parse_quote_2047(uschar
*, int, uschar
*, uschar
*, int, BOOL
);
220 extern uschar
*parse_date_time(uschar
*str
, time_t *t
);
221 extern int vaguely_random_number(int);
223 extern int vaguely_random_number_fallback(int);
226 extern BOOL
queue_action(uschar
*, int, uschar
**, int, int);
227 extern void queue_check_only(void);
228 extern void queue_list(int, uschar
**, int);
229 extern void queue_count(void);
230 extern void queue_run(uschar
*, uschar
*, BOOL
);
232 extern int random_number(int);
233 #ifdef WITH_CONTENT_SCAN
234 extern int recv_line(int, uschar
*, int);
236 extern int rda_interpret(redirect_block
*, int, uschar
*, uschar
*,
237 uschar
*, uschar
*, uschar
*, ugid_block
*, address_item
**,
238 uschar
**, error_block
**, int *, uschar
*);
239 extern int rda_is_filter(const uschar
*);
240 extern BOOL
readconf_depends(driver_instance
*, uschar
*);
241 extern void readconf_driver_init(uschar
*, driver_instance
**,
242 driver_info
*, int, void *, int, optionlist
*, int);
243 extern uschar
*readconf_find_option(void *);
244 extern void readconf_main(void);
245 extern void readconf_print(uschar
*, uschar
*, BOOL
);
246 extern uschar
*readconf_printtime(int);
247 extern uschar
*readconf_readname(uschar
*, int, uschar
*);
248 extern int readconf_readtime(uschar
*, int, BOOL
);
249 extern void readconf_rest(BOOL
);
250 extern uschar
*readconf_retry_error(uschar
*, uschar
*, int *, int *);
251 extern void read_message_body(BOOL
);
252 extern void receive_bomb_out(uschar
*, uschar
*);
253 extern BOOL
receive_check_fs(int);
254 extern BOOL
receive_check_set_sender(uschar
*);
255 extern BOOL
receive_msg(BOOL
);
256 extern int receive_statvfs(BOOL
, int *);
257 extern void receive_swallow_smtp(void);
258 #ifdef WITH_CONTENT_SCAN
259 extern int regex(uschar
**);
261 extern BOOL
regex_match_and_setup(const pcre
*, uschar
*, int, int);
262 extern const pcre
*regex_must_compile(uschar
*, BOOL
, BOOL
);
263 extern void retry_add_item(address_item
*, uschar
*, int);
264 extern BOOL
retry_check_address(uschar
*, host_item
*, uschar
*, BOOL
,
265 uschar
**, uschar
**);
266 extern retry_config
*retry_find_config(uschar
*, uschar
*, int, int);
267 extern void retry_update(address_item
**, address_item
**, address_item
**);
268 extern uschar
*rewrite_address(uschar
*, BOOL
, BOOL
, rewrite_rule
*, int);
269 extern uschar
*rewrite_address_qualify(uschar
*, BOOL
);
270 extern header_line
*rewrite_header(header_line
*, uschar
*, uschar
*,
271 rewrite_rule
*, int, BOOL
);
272 extern uschar
*rewrite_one(uschar
*, int, BOOL
*, BOOL
, uschar
*,
274 extern void rewrite_test(uschar
*);
275 extern uschar
*rfc2047_decode2(uschar
*, BOOL
, uschar
*, int, int *, int *,
277 extern int route_address(address_item
*, address_item
**, address_item
**,
278 address_item
**, address_item
**, int);
279 extern int route_check_prefix(uschar
*, uschar
*);
280 extern int route_check_suffix(uschar
*, uschar
*);
281 extern BOOL
route_findgroup(uschar
*, gid_t
*);
282 extern BOOL
route_finduser(uschar
*, struct passwd
**, uid_t
*);
283 extern BOOL
route_find_expanded_group(uschar
*, uschar
*, uschar
*, gid_t
*,
285 extern BOOL
route_find_expanded_user(uschar
*, uschar
*, uschar
*,
286 struct passwd
**, uid_t
*, uschar
**);
287 extern void route_init(void);
288 extern void route_tidyup(void);
290 extern uschar
*search_find(void *, uschar
*, uschar
*, int, uschar
*, int,
292 extern int search_findtype(uschar
*, int);
293 extern int search_findtype_partial(uschar
*, int *, uschar
**, int *,
295 extern void *search_open(uschar
*, int, int, uid_t
*, gid_t
*);
296 extern void search_tidyup(void);
297 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
298 extern void sha1_end(sha1
*, const uschar
*, int, uschar
*);
299 extern void sha1_mid(sha1
*, const uschar
*);
300 extern void sha1_start(sha1
*);
301 extern int sieve_interpret(uschar
*, int, uschar
*, uschar
*, uschar
*,
302 uschar
*, address_item
**, uschar
**);
303 extern void sigalrm_handler(int);
304 extern BOOL
smtp_buffered(void);
305 extern void smtp_closedown(uschar
*);
306 extern int smtp_connect(host_item
*, int, int, uschar
*, int, BOOL
, const uschar
*);
307 extern int smtp_feof(void);
308 extern int smtp_ferror(void);
309 extern uschar
*smtp_get_connection_info(void);
310 extern BOOL
smtp_get_interface(uschar
*, int, address_item
*, BOOL
*,
311 uschar
**, uschar
*);
312 extern BOOL
smtp_get_port(uschar
*, address_item
*, int *, uschar
*);
313 extern int smtp_getc(void);
314 extern int smtp_handle_acl_fail(int, int, uschar
*, uschar
*);
315 extern void smtp_log_no_mail(void);
316 extern void smtp_message_code(uschar
**, int *, uschar
**, uschar
**);
317 extern BOOL
smtp_read_response(smtp_inblock
*, uschar
*, int, int, int);
318 extern void smtp_respond(uschar
*, int, BOOL
, uschar
*);
319 extern void smtp_notquit_exit(uschar
*, uschar
*, uschar
*, ...);
320 extern void smtp_send_prohibition_message(int, uschar
*);
321 extern int smtp_setup_msg(void);
322 extern BOOL
smtp_start_session(void);
323 extern int smtp_ungetc(int);
324 extern BOOL
smtp_verify_helo(void);
325 extern int smtp_write_command(smtp_outblock
*, BOOL
, const char *, ...) PRINTF_FUNCTION(3,4);
326 #ifdef WITH_CONTENT_SCAN
327 extern int spam(uschar
**);
328 extern FILE *spool_mbox(unsigned long *, uschar
*);
330 extern BOOL
spool_move_message(uschar
*, uschar
*, uschar
*, uschar
*);
331 extern BOOL
spool_open_datafile(uschar
*);
332 extern int spool_open_temp(uschar
*);
333 extern int spool_read_header(uschar
*, BOOL
, BOOL
);
334 extern int spool_write_header(uschar
*, int, uschar
**);
335 extern int stdin_getc(void);
336 extern int stdin_feof(void);
337 extern int stdin_ferror(void);
338 extern int stdin_ungetc(int);
339 extern uschar
*string_append(uschar
*, int *, int *, int, ...);
340 extern uschar
*string_base62(unsigned long int);
341 extern uschar
*string_cat(uschar
*, int *, int *, const uschar
*, int);
342 extern uschar
*string_copy_dnsdomain(uschar
*);
343 extern uschar
*string_copy_malloc(uschar
*);
344 extern uschar
*string_copylc(uschar
*);
345 extern uschar
*string_copynlc(uschar
*, int);
346 extern uschar
*string_dequote(uschar
**);
347 extern BOOL
string_format(uschar
*, int, const char *, ...) ALMOST_PRINTF(3,4);
348 extern uschar
*string_format_size(int, uschar
*);
349 extern int string_interpret_escape(uschar
**);
350 extern int string_is_ip_address(uschar
*, int *);
351 extern uschar
*string_log_address(address_item
*, BOOL
, BOOL
);
352 extern uschar
*string_nextinlist(uschar
**, int *, uschar
*, int);
353 extern uschar
*string_open_failed(int, const char *, ...) PRINTF_FUNCTION(2,3);
354 extern uschar
*string_printing2(uschar
*, BOOL
);
355 extern uschar
*string_split_message(uschar
*);
356 extern uschar
*string_unprinting(uschar
*);
357 extern BOOL
string_vformat(uschar
*, int, const char *, va_list);
358 extern int strcmpic(const uschar
*, const uschar
*);
359 extern int strncmpic(const uschar
*, const uschar
*, int);
360 extern uschar
*strstric(uschar
*, uschar
*, BOOL
);
362 extern uschar
*tod_stamp(int);
363 extern BOOL
transport_check_waiting(uschar
*, uschar
*, int, uschar
*,
365 extern void transport_init(void);
366 extern BOOL
transport_pass_socket(uschar
*, uschar
*, uschar
*, uschar
*,
368 extern uschar
*transport_rcpt_address(address_item
*, BOOL
);
369 extern BOOL
transport_set_up_command(uschar
***, uschar
*, BOOL
, int,
370 address_item
*, uschar
*, uschar
**);
371 extern void transport_update_waiting(host_item
*, uschar
*);
372 extern BOOL
transport_write_block(int, uschar
*, int);
373 extern BOOL
transport_write_string(int, const char *, ...);
374 extern BOOL
transport_write_message(address_item
*, int, int, int, uschar
*,
375 uschar
*, uschar
*, uschar
*, rewrite_rule
*, int);
376 extern void tree_add_duplicate(uschar
*, address_item
*);
377 extern void tree_add_nonrecipient(uschar
*);
378 extern void tree_add_unusable(host_item
*);
379 extern int tree_insertnode(tree_node
**, tree_node
*);
380 extern tree_node
*tree_search(tree_node
*, uschar
*);
381 extern void tree_write(tree_node
*, FILE *);
382 extern void tree_walk(tree_node
*, void (*)(uschar
*, uschar
*, void*), void *);
384 #ifdef WITH_CONTENT_SCAN
385 extern void unspool_mbox(void);
388 extern int verify_address(address_item
*, FILE *, int, int, int, int,
389 uschar
*, uschar
*, BOOL
*);
390 extern int verify_check_dnsbl(uschar
**);
391 extern int verify_check_header_address(uschar
**, uschar
**, int, int, int,
392 uschar
*, uschar
*, int, int *);
393 extern int verify_check_headers(uschar
**);
394 extern int verify_check_host(uschar
**);
395 extern int verify_check_notblind(void);
396 extern int verify_check_this_host(uschar
**, unsigned int *, uschar
*,
397 uschar
*, uschar
**);
398 extern address_item
*verify_checked_sender(uschar
*);
399 extern void verify_get_ident(int);
400 extern BOOL
verify_sender(int *, uschar
**);
401 extern BOOL
verify_sender_preliminary(int *, uschar
**);
402 extern void version_init(void);
404 extern ssize_t
write_to_fd_buf(int, const uschar
*, size_t);
406 /* End of functions.h */