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