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