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