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