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