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