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