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