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