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