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