projects / exim.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Appendfile: when evaluating quota use attemd to link counts
[exim.git] / src / src / functions.h
... / ...
CommitLineData
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
5/* Copyright (c) University of Cambridge 1995 - 2018 */
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#ifndef _FUNCTIONS_H_
14#define _FUNCTIONS_H_
15
16
17#ifdef EXIM_PERL
18extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
19 uschar **) WARN_UNUSED_RESULT;
20extern void cleanup_perl(void);
21extern uschar *init_perl(uschar *);
22#endif
23
24
25#ifndef DISABLE_TLS
26extern const char *
27 std_dh_prime_default(void);
28extern const char *
29 std_dh_prime_named(const uschar *);
30
31extern uschar * tls_cert_crl_uri(void *, uschar * mod);
32extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
33extern uschar * tls_cert_issuer(void *, uschar * mod);
34extern uschar * tls_cert_not_before(void *, uschar * mod);
35extern uschar * tls_cert_not_after(void *, uschar * mod);
36extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
37extern uschar * tls_cert_serial_number(void *, uschar * mod);
38extern uschar * tls_cert_signature(void *, uschar * mod);
39extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
40extern uschar * tls_cert_subject(void *, uschar * mod);
41extern uschar * tls_cert_subject_altname(void *, uschar * mod);
42extern uschar * tls_cert_version(void *, uschar * mod);
43
44extern uschar * tls_cert_der_b64(void * cert);
45extern uschar * tls_cert_fprt_md5(void *);
46extern uschar * tls_cert_fprt_sha1(void *);
47extern uschar * tls_cert_fprt_sha256(void *);
48
49extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
50 void *, tls_support *, uschar **);
51
52extern void tls_close(void *, int);
53extern BOOL tls_could_read(void);
54extern void tls_daemon_init(void);
55extern int tls_export_cert(uschar *, size_t, void *);
56extern int tls_feof(void);
57extern int tls_ferror(void);
58extern void tls_free_cert(void **);
59extern int tls_getc(unsigned);
60extern uschar *tls_getbuf(unsigned *);
61extern void tls_get_cache(void);
62extern int tls_import_cert(const uschar *, void **);
63extern int tls_read(void *, uschar *, size_t);
64extern int tls_server_start(const uschar *, uschar **);
65extern BOOL tls_smtp_buffered(void);
66extern int tls_ungetc(int);
67extern int tls_write(void *, const uschar *, size_t, BOOL);
68extern uschar *tls_validate_require_cipher(void);
69extern void tls_version_report(FILE *);
70# ifdef USE_OPENSSL
71extern BOOL tls_openssl_options_parse(uschar *, long *);
72# endif
73extern uschar * tls_field_from_dn(uschar *, const uschar *);
74extern BOOL tls_is_name_for_cert(const uschar *, void *);
75
76# ifdef SUPPORT_DANE
77extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
78# endif
79
80#endif /*DISABLE_TLS*/
81
82
83/* Everything else... */
84
85extern acl_block *acl_read(uschar *(*)(void), uschar **);
86extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
87extern int acl_eval(int, uschar *, uschar **, uschar **);
88
89extern tree_node *acl_var_create(uschar *);
90extern void acl_var_write(uschar *, uschar *, void *);
91
92#ifdef EXPERIMENTAL_ARC
93extern void *arc_ams_setup_sign_bodyhash(void);
94extern const uschar *arc_header_feed(gstring *, BOOL);
95extern gstring *arc_sign(const uschar *, gstring *, uschar **);
96extern void arc_sign_init(void);
97extern const uschar *acl_verify_arc(void);
98extern uschar * fn_arc_domains(void);
99#endif
100
101extern void assert_no_variables(void *, int, const char *, int);
102extern int auth_call_pam(const uschar *, uschar **);
103extern int auth_call_pwcheck(uschar *, uschar **);
104extern int auth_call_radius(const uschar *, uschar **);
105extern int auth_call_saslauthd(const uschar *, const uschar *,
106 const uschar *, const uschar *, uschar **);
107extern int auth_check_serv_cond(auth_instance *);
108extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
109extern int auth_client_item(void *, auth_instance *, const uschar **,
110 unsigned, int, uschar *, int);
111
112
113extern int auth_get_data(uschar **, const uschar *, int);
114extern int auth_get_no64_data(uschar **, uschar *);
115extern int auth_prompt(const uschar *);
116extern int auth_read_input(const uschar *);
117extern void auth_show_supported(FILE *);
118extern uschar *auth_xtextencode(uschar *, int);
119extern int auth_xtextdecode(uschar *, uschar **);
120
121#ifdef EXPERIMENTAL_ARC
122extern gstring *authres_arc(gstring *);
123#endif
124#ifndef DISABLE_DKIM
125extern gstring *authres_dkim(gstring *);
126#endif
127#ifdef EXPERIMENTAL_DMARC
128extern gstring *authres_dmarc(gstring *);
129#endif
130extern gstring *authres_smtpauth(gstring *);
131#ifdef SUPPORT_SPF
132extern gstring *authres_spf(gstring *);
133#endif
134
135extern uschar *b64encode(const uschar *, int);
136extern int b64decode(const uschar *, uschar **);
137extern int bdat_getc(unsigned);
138extern uschar *bdat_getbuf(unsigned *);
139extern int bdat_ungetc(int);
140extern void bdat_flush_data(void);
141
142extern void bits_clear(unsigned int *, size_t, int *);
143extern void bits_set(unsigned int *, size_t, int *);
144
145extern void cancel_cutthrough_connection(BOOL, const uschar *);
146extern int check_host(void *, const uschar *, const uschar **, uschar **);
147extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
148extern pid_t child_open_uid(const uschar **, const uschar **, int,
149 uid_t *, gid_t *, int *, int *, uschar *, BOOL);
150extern BOOL cleanup_environment(void);
151extern void cutthrough_data_puts(uschar *, int);
152extern void cutthrough_data_put_nl(void);
153extern uschar *cutthrough_finaldot(void);
154extern BOOL cutthrough_flush_send(void);
155extern BOOL cutthrough_headers_send(void);
156extern BOOL cutthrough_predata(void);
157extern void release_cutthrough_connection(const uschar *);
158
159extern void daemon_go(void);
160
161#ifdef EXPERIMENTAL_DCC
162extern int dcc_process(uschar **);
163#endif
164
165extern void debug_logging_activate(uschar *, uschar *);
166extern void debug_logging_stop(void);
167extern void debug_print_argv(const uschar **);
168extern void debug_print_ids(uschar *);
169extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
170extern void debug_print_string(uschar *);
171extern void debug_print_tree(tree_node *);
172extern void debug_vprintf(int, const char *, va_list);
173extern void decode_bits(unsigned int *, size_t, int *,
174 uschar *, bit_table *, int, uschar *, int);
175extern address_item *deliver_make_addr(uschar *, BOOL);
176extern void deliver_init(void);
177extern void delivery_log(int, address_item *, int, uschar *);
178extern int deliver_message(uschar *, BOOL, BOOL);
179extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
180extern void deliver_set_expansions(address_item *);
181extern int deliver_split_address(address_item *);
182extern void deliver_succeeded(address_item *);
183
184extern uschar *deliver_get_sender_address (uschar *id);
185extern void delivery_re_exec(int);
186
187extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
188#ifndef DISABLE_DKIM
189extern uschar *dkim_exim_query_dns_txt(const uschar *);
190extern void dkim_exim_sign_init(void);
191
192extern BOOL dkim_transport_write_message(transport_ctx *,
193 struct ob_dkim *, const uschar ** errstr);
194#endif
195extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
196extern int dns_basic_lookup(dns_answer *, const uschar *, int);
197extern void dns_build_reverse(const uschar *, uschar *);
198extern void dns_init(BOOL, BOOL, BOOL);
199extern BOOL dns_is_aa(const dns_answer *);
200extern BOOL dns_is_secure(const dns_answer *);
201extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
202extern void dns_pattern_init(void);
203extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
204extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
205extern uschar *dns_text_type(int);
206extern void dscp_list_to_stream(FILE *);
207extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
208
209extern void enq_end(uschar *);
210extern BOOL enq_start(uschar *, unsigned);
211#ifndef DISABLE_EVENT
212extern uschar *event_raise(uschar *, const uschar *, uschar *);
213extern void msg_event_raise(const uschar *, const address_item *);
214#endif
215
216extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
217extern const uschar * exim_errstr(int);
218extern void exim_exit(int, const uschar *) NORETURN;
219extern void exim_nullstd(void);
220extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
221extern void exim_underbar_exit(int);
222extern void exim_wait_tick(struct timeval *, int);
223extern int exp_bool(address_item *addr,
224 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
225 uschar *svalue, BOOL *rvalue);
226extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
227extern uschar *expand_file_big_buffer(const uschar *);
228extern uschar *expand_string(uschar *); /* public, cannot make const */
229extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
230extern uschar *expand_hide_passwords(uschar * );
231extern uschar *expand_string_copy(const uschar *);
232extern int_eximarith_t expand_string_integer(uschar *, BOOL);
233extern void modify_variable(uschar *, void *);
234
235extern BOOL fd_ready(int, time_t);
236
237extern int filter_interpret(uschar *, int, address_item **, uschar **);
238extern BOOL filter_personal(string_item *, BOOL);
239extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
240extern BOOL filter_system_interpret(address_item **, uschar **);
241
242extern uschar * fn_hdrs_added(void);
243
244extern void header_add(int, const char *, ...);
245extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
246extern int header_checkname(header_line *, BOOL);
247extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
248extern int host_address_extract_port(uschar *);
249extern uschar *host_and_ident(BOOL);
250extern int host_aton(const uschar *, int *);
251extern void host_build_hostlist(host_item **, const uschar *, BOOL);
252extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
253extern void host_build_log_info(void);
254extern void host_build_sender_fullhost(void);
255extern int host_find_byname(host_item *, const uschar *, int,
256 const uschar **, BOOL);
257extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
258 uschar *, const dnssec_domains *, const uschar **, BOOL *);
259extern ip_address_item *host_find_interfaces(void);
260extern BOOL host_is_in_net(const uschar *, const uschar *, int);
261extern BOOL host_is_tls_on_connect_port(int);
262extern int host_item_get_port(host_item *);
263extern void host_mask(int, int *, int);
264extern int host_name_lookup(void);
265extern int host_nmtoa(int, int *, int, uschar *, int);
266extern uschar *host_ntoa(int, const void *, uschar *, int *);
267extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
268
269extern uschar *imap_utf7_encode(uschar *, const uschar *,
270 uschar, uschar *, uschar **);
271
272extern void invert_address(uschar *, uschar *);
273extern int ip_addr(void *, int, const uschar *, int);
274extern int ip_bind(int, int, uschar *, int);
275extern int ip_connect(int, int, const uschar *, int, int, const blob *);
276extern int ip_connectedsocket(int, const uschar *, int, int,
277 int, host_item *, uschar **, const blob *);
278extern int ip_get_address_family(int);
279extern void ip_keepalive(int, const uschar *, BOOL);
280extern int ip_recv(client_conn_ctx *, uschar *, int, time_t);
281extern int ip_socket(int, int);
282
283extern int ip_tcpsocket(const uschar *, uschar **, int);
284extern int ip_unixsocket(const uschar *, uschar **);
285extern int ip_streamsocket(const uschar *, uschar **, int);
286
287extern int ipv6_nmtoa(int *, uschar *);
288
289extern uschar *local_part_quote(uschar *);
290extern int log_create(uschar *);
291extern int log_create_as_exim(uschar *);
292extern void log_close_all(void);
293
294extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
295extern BOOL macro_read_assignment(uschar *);
296extern uschar *macros_expand(int, int *, BOOL *);
297extern void mainlog_close(void);
298#ifdef WITH_CONTENT_SCAN
299extern int malware(const uschar *, int);
300extern int malware_in_file(uschar *);
301extern void malware_init(void);
302extern void malware_show_supported(FILE *);
303#endif
304extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
305 unsigned int *, int, int, const uschar **);
306extern int match_address_list_basic(const uschar *, const uschar **, int);
307extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
308 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
309 const uschar *, const uschar **);
310extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
311 unsigned int *, int, BOOL, const uschar **);
312extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
313 const uschar **);
314extern void md5_end(md5 *, const uschar *, int, uschar *);
315extern void md5_mid(md5 *, const uschar *);
316extern void md5_start(md5 *);
317extern void millisleep(int);
318#ifdef WITH_CONTENT_SCAN
319struct mime_boundary_context;
320extern int mime_acl_check(uschar *acl, FILE *f,
321 struct mime_boundary_context *, uschar **, uschar **);
322extern int mime_decode(const uschar **);
323extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
324extern int mime_regex(const uschar **);
325extern void mime_set_anomaly(int);
326#endif
327extern uschar *moan_check_errorcopy(uschar *);
328extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
329 BOOL, uschar *);
330extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
331extern BOOL moan_send_message(uschar *, int, error_block *eblock,
332 header_line *, FILE *, uschar *);
333extern void moan_tell_someone(uschar *, address_item *,
334 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
335extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
336extern void moan_write_from(FILE *);
337extern FILE *modefopen(const uschar *, const char *, mode_t);
338
339extern int open_cutthrough_connection( address_item * addr );
340
341extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
342 BOOL);
343extern int parse_forward_list(uschar *, int, address_item **, uschar **,
344 const uschar *, uschar *, error_block **);
345extern uschar *parse_find_address_end(uschar *, BOOL);
346extern uschar *parse_find_at(uschar *);
347extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
348extern uschar *parse_message_id(uschar *, uschar **, uschar **);
349extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
350extern uschar *parse_date_time(uschar *str, time_t *t);
351extern int vaguely_random_number(int);
352#ifndef DISABLE_TLS
353extern int vaguely_random_number_fallback(int);
354#endif
355
356extern BOOL queue_action(uschar *, int, uschar **, int, int);
357extern void queue_check_only(void);
358extern void queue_list(int, uschar **, int);
359extern void queue_count(void);
360extern void queue_run(uschar *, uschar *, BOOL);
361
362extern int random_number(int);
363extern const uschar *rc_to_string(int);
364extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
365 uschar *, uschar *, uschar *, ugid_block *, address_item **,
366 uschar **, error_block **, int *, uschar *);
367extern int rda_is_filter(const uschar *);
368extern BOOL readconf_depends(driver_instance *, uschar *);
369extern void readconf_driver_init(uschar *, driver_instance **,
370 driver_info *, int, void *, int, optionlist *, int);
371extern uschar *readconf_find_option(void *);
372extern void readconf_main(BOOL);
373extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
374extern BOOL readconf_print(uschar *, uschar *, BOOL);
375extern uschar *readconf_printtime(int);
376extern uschar *readconf_readname(uschar *, int, uschar *);
377extern int readconf_readtime(const uschar *, int, BOOL);
378extern void readconf_rest(void);
379extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
380extern void readconf_save_config(const uschar *);
381extern void read_message_body(BOOL);
382extern void receive_bomb_out(uschar *, uschar *) NORETURN;
383extern BOOL receive_check_fs(int);
384extern BOOL receive_check_set_sender(uschar *);
385extern BOOL receive_msg(BOOL);
386extern int_eximarith_t receive_statvfs(BOOL, int *);
387extern void receive_swallow_smtp(void);
388#ifdef WITH_CONTENT_SCAN
389extern int regex(const uschar **);
390#endif
391extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
392extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
393extern void retry_add_item(address_item *, uschar *, int);
394extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
395 uschar **, uschar **);
396extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
397extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
398 dbdata_retry *, time_t);
399extern void retry_update(address_item **, address_item **, address_item **);
400extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
401extern uschar *rewrite_address_qualify(uschar *, BOOL);
402extern header_line *rewrite_header(header_line *,
403 const uschar *, const uschar *,
404 rewrite_rule *, int, BOOL);
405extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
406 rewrite_rule *);
407extern void rewrite_test(uschar *);
408extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
409 uschar **);
410extern int route_address(address_item *, address_item **, address_item **,
411 address_item **, address_item **, int);
412extern int route_check_prefix(const uschar *, const uschar *);
413extern int route_check_suffix(const uschar *, const uschar *);
414extern BOOL route_findgroup(uschar *, gid_t *);
415extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
416extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
417 uschar **);
418extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
419 struct passwd **, uid_t *, uschar **);
420extern void route_init(void);
421extern void route_show_supported(FILE *);
422extern void route_tidyup(void);
423
424extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
425 int, int *);
426extern int search_findtype(const uschar *, int);
427extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
428 int *);
429extern void *search_open(uschar *, int, int, uid_t *, gid_t *);
430extern void search_tidyup(void);
431extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
432extern void sha1_end(hctx *, const uschar *, int, uschar *);
433extern void sha1_mid(hctx *, const uschar *);
434extern void sha1_start(hctx *);
435extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
436 uschar *, address_item **, uschar **);
437extern void sigalrm_handler(int);
438extern BOOL smtp_buffered(void);
439extern void smtp_closedown(uschar *);
440extern void smtp_command_timeout_exit(void) NORETURN;
441extern void smtp_command_sigterm_exit(void) NORETURN;
442extern void smtp_data_timeout_exit(void) NORETURN;
443extern void smtp_data_sigint_exit(void) NORETURN;
444extern uschar *smtp_cmd_hist(void);
445extern int smtp_connect(smtp_connect_args *, const blob *);
446extern int smtp_sock_connect(host_item *, int, int, uschar *,
447 transport_instance * tb, int, const blob *);
448extern int smtp_feof(void);
449extern int smtp_ferror(void);
450extern uschar *smtp_get_connection_info(void);
451extern BOOL smtp_get_interface(uschar *, int, address_item *,
452 uschar **, uschar *);
453extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
454extern int smtp_getc(unsigned);
455extern uschar *smtp_getbuf(unsigned *);
456extern void smtp_get_cache(void);
457extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
458extern void smtp_log_no_mail(void);
459extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
460extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
461extern BOOL smtp_read_response(void *, uschar *, int, int, int);
462extern void *smtp_reset(void *);
463extern void smtp_respond(uschar *, int, BOOL, uschar *);
464extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
465extern void smtp_port_for_connect(host_item *, int);
466extern void smtp_send_prohibition_message(int, uschar *);
467extern int smtp_setup_msg(void);
468extern BOOL smtp_start_session(void);
469extern int smtp_ungetc(int);
470extern BOOL smtp_verify_helo(void);
471extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
472#ifdef WITH_CONTENT_SCAN
473extern int spam(const uschar **);
474extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
475#endif
476extern void spool_clear_header_globals(void);
477extern uschar *spool_dname(const uschar *, uschar *);
478extern uschar *spool_fname(const uschar *, const uschar *, const uschar *, const uschar *);
479extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
480extern int spool_open_datafile(uschar *);
481extern int spool_open_temp(uschar *);
482extern int spool_read_header(uschar *, BOOL, BOOL);
483extern uschar *spool_sname(const uschar *, uschar *);
484extern int spool_write_header(uschar *, int, uschar **);
485extern int stdin_getc(unsigned);
486extern int stdin_feof(void);
487extern int stdin_ferror(void);
488extern int stdin_ungetc(int);
489
490extern void store_exit(void);
491extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
492extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
493extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
494extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
495extern uschar *string_base62(unsigned long int);
496extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
497extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
498extern int string_compare_by_pointer(const void *, const void *);
499extern uschar *string_copy_dnsdomain(uschar *);
500extern uschar *string_copy_malloc(const uschar *);
501extern uschar *string_dequote(const uschar **);
502extern uschar *string_format_size(int, uschar *);
503extern int string_interpret_escape(const uschar **);
504extern int string_is_ip_address(const uschar *, int *);
505#ifdef SUPPORT_I18N
506extern BOOL string_is_utf8(const uschar *);
507#endif
508extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
509extern const uschar *string_printing2(const uschar *, BOOL);
510extern uschar *string_split_message(uschar *);
511extern uschar *string_timediff(struct timeval *);
512extern uschar *string_timesince(struct timeval *);
513extern uschar *string_unprinting(uschar *);
514#ifdef SUPPORT_I18N
515extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
516extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
517extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
518extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
519extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
520#endif
521
522#define string_format(buf, siz, fmt, ...) \
523 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
524extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
525 const char *, ...) ALMOST_PRINTF(5,6);
526
527#define string_vformat(g, flgs, fmt, ap) \
528 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
529 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
530extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
531 unsigned, unsigned, const char *, va_list);
532
533#define string_open_failed(eno, fmt, ...) \
534 string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
535extern uschar *string_open_failed_trc(int, const uschar *, unsigned,
536 const char *, ...) PRINTF_FUNCTION(4,5);
537
538extern int strcmpic(const uschar *, const uschar *);
539extern int strncmpic(const uschar *, const uschar *, int);
540extern uschar *strstric(uschar *, uschar *, BOOL);
541
542#ifdef EXIM_TFO_PROBE
543extern void tfo_probe(void);
544#endif
545extern void timesince(struct timeval * diff, struct timeval * then);
546extern void tls_modify_variables(tls_support *);
547extern uschar *tod_stamp(int);
548
549extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
550 BOOL *, oicf, void*);
551extern void transport_init(void);
552extern void transport_do_pass_socket(const uschar *, const uschar *,
553 const uschar *, uschar *, int);
554extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
555 int);
556extern uschar *transport_rcpt_address(address_item *, BOOL);
557extern BOOL transport_set_up_command(const uschar ***, uschar *,
558 BOOL, int, address_item *, uschar *, uschar **);
559extern void transport_update_waiting(host_item *, uschar *);
560extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
561extern void transport_write_reset(int);
562extern BOOL transport_write_string(int, const char *, ...);
563extern BOOL transport_headers_send(transport_ctx *,
564 BOOL (*)(transport_ctx *, uschar *, int));
565extern void transport_show_supported(FILE *);
566extern BOOL transport_write_message(transport_ctx *, int);
567extern void tree_add_duplicate(uschar *, address_item *);
568extern void tree_add_nonrecipient(uschar *);
569extern void tree_add_unusable(host_item *);
570extern void tree_dup(tree_node **, tree_node *);
571extern int tree_insertnode(tree_node **, tree_node *);
572extern tree_node *tree_search(tree_node *, const uschar *);
573extern void tree_write(tree_node *, FILE *);
574extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
575
576#ifdef WITH_CONTENT_SCAN
577extern void unspool_mbox(void);
578#endif
579#ifdef SUPPORT_I18N
580extern void utf8_version_report(FILE *);
581#endif
582
583extern int verify_address(address_item *, FILE *, int, int, int, int,
584 uschar *, uschar *, BOOL *);
585extern int verify_check_dnsbl(int, const uschar **, uschar **);
586extern int verify_check_header_address(uschar **, uschar **, int, int, int,
587 uschar *, uschar *, int, int *);
588extern int verify_check_headers(uschar **);
589extern int verify_check_header_names_ascii(uschar **);
590extern int verify_check_host(uschar **);
591extern int verify_check_notblind(BOOL);
592extern int verify_check_given_host(const uschar **, const host_item *);
593extern int verify_check_this_host(const uschar **, unsigned int *,
594 const uschar*, const uschar *, const uschar **);
595extern address_item *verify_checked_sender(uschar *);
596extern void verify_get_ident(int);
597extern BOOL verify_sender(int *, uschar **);
598extern BOOL verify_sender_preliminary(int *, uschar **);
599extern void version_init(void);
600
601extern BOOL write_chunk(transport_ctx *, uschar *, int);
602extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
603
604
605#if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
606/* exim_chown - in some NFSv4 setups *seemes* to be an issue with
607chown(<exim-uid>, <exim-gid>).
608
609Probably because the idmapping is broken, misconfigured or set up in
610an unusal way. (see Bug 2931). As I'm not sure, if this was a single
611case of misconfiguration, or if there are more such broken systems
612out, I try to impose as least impact as possible and for now just write
613a panic log entry pointing to the bug report. You're encouraged to
614contact the developers, if you experience this issue.
615
616fd the file descriptor (or -1 if not valid)
617name the file name for error messages or for file operations,
618 if fd is < 0
619owner the owner
620group the group
621
622returns 0 on success, -1 on failure */
623
624static inline int
625exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
626{
627return fchown(fd, owner, group)
628 ? exim_chown_failure(fd, name, owner, group) : 0;
629}
630
631static inline int
632exim_chown(const uschar *name, uid_t owner, gid_t group)
633{
634return chown(CCS name, owner, group)
635 ? exim_chown_failure(-1, name, owner, group) : 0;
636}
637
638#endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
639/******************************************************************************/
640/* String functions */
641
642#if !defined(MACRO_PREDEF)
643/*************************************************
644* Copy and save string *
645*************************************************/
646
647/* This function assumes that memcpy() is faster than strcpy().
648*/
649
650static inline uschar *
651string_copy_taint_trc(const uschar *s, BOOL tainted, const char * func, int line)
652{
653int len = Ustrlen(s) + 1;
654uschar *ss = store_get_3(len, tainted, func, line);
655memcpy(ss, s, len);
656return ss;
657}
658
659#define string_copy_taint(s, tainted) \
660 string_copy_taint_trc((s), tainted, __FUNCTION__, __LINE__)
661
662static inline uschar *
663string_copy(const uschar * s)
664{
665return string_copy_taint((s), is_tainted(s));
666}
667
668
669/*************************************************
670* Copy, lowercase and save string *
671*************************************************/
672
673/*
674Argument: string to copy
675Returns: copy of string in new store, with letters lowercased
676*/
677
678static inline uschar *
679string_copylc(const uschar *s)
680{
681uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
682uschar *p = ss;
683while (*s != 0) *p++ = tolower(*s++);
684*p = 0;
685return ss;
686}
687
688
689
690/*************************************************
691* Copy and save string, given length *
692*************************************************/
693
694/* It is assumed the data contains no zeros. A zero is added
695onto the end.
696
697Arguments:
698 s string to copy
699 n number of characters
700
701Returns: copy of string in new store
702
703This is an API for local_scan hence not static.
704*/
705
706static inline uschar *
707string_copyn(const uschar *s, int n)
708{
709uschar *ss = store_get(n + 1, is_tainted(s));
710Ustrncpy(ss, s, n);
711ss[n] = 0;
712return ss;
713}
714
715/*************************************************
716* Copy, lowercase, and save string, given length *
717*************************************************/
718
719/* It is assumed the data contains no zeros. A zero is added
720onto the end.
721
722Arguments:
723 s string to copy
724 n number of characters
725
726Returns: copy of string in new store, with letters lowercased
727*/
728
729static inline uschar *
730string_copynlc(uschar *s, int n)
731{
732uschar *ss = store_get(n + 1, is_tainted(s));
733uschar *p = ss;
734while (n-- > 0) *p++ = tolower(*s++);
735*p = 0;
736return ss;
737}
738
739
740# ifndef COMPILE_UTILITY
741/*************************************************
742* Copy and save string in longterm store *
743*************************************************/
744
745/* This function assumes that memcpy() is faster than strcpy().
746
747Argument: string to copy
748Returns: copy of string in new store
749*/
750
751static inline uschar *
752string_copy_perm(const uschar *s, BOOL force_taint)
753{
754int old_pool = store_pool;
755int len = Ustrlen(s) + 1;
756uschar *ss;
757
758store_pool = POOL_PERM;
759ss = store_get(len, force_taint || is_tainted(s));
760memcpy(ss, s, len);
761store_pool = old_pool;
762return ss;
763}
764# endif
765
766
767
768/* sprintf into a buffer, taint-unchecked */
769
770static inline void
771string_format_nt(uschar * buf, int siz, const char * fmt, ...)
772{
773gstring gs = { .size = siz, .ptr = 0, .s = buf };
774va_list ap;
775va_start(ap, fmt);
776(void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
777va_end(ap);
778}
779
780
781
782/******************************************************************************/
783/* Growable-string functions */
784
785/* Create a growable-string with some preassigned space */
786
787#define string_get_tainted(size, tainted) \
788 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
789
790static inline gstring *
791string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
792{
793gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
794g->size = size;
795g->ptr = 0;
796g->s = US(g + 1);
797return g;
798}
799
800#define string_get(size) \
801 string_get_trc((size), __FUNCTION__, __LINE__)
802
803static inline gstring *
804string_get_trc(unsigned size, const char * func, unsigned line)
805{
806return string_get_tainted_trc(size, FALSE, func, line);
807}
808
809/* NUL-terminate the C string in the growable-string, and return it. */
810
811static inline uschar *
812string_from_gstring(gstring * g)
813{
814if (!g) return NULL;
815g->s[g->ptr] = '\0';
816return g->s;
817}
818
819
820#define gstring_release_unused(g) \
821 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
822
823static inline void
824gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
825{
826if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
827}
828
829
830/* sprintf-append to a growable-string */
831
832#define string_fmt_append(g, fmt, ...) \
833 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
834 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
835
836#define string_fmt_append_f(g, flgs, fmt, ...) \
837 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
838 flgs, fmt, __VA_ARGS__)
839
840static inline gstring *
841string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
842 unsigned flags, const char *format, ...)
843{
844va_list ap;
845va_start(ap, format);
846g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
847 flags, format, ap);
848va_end(ap);
849return g;
850}
851
852/******************************************************************************/
853
854#define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
855
856static inline dns_answer *
857store_get_dns_answer_trc(const uschar * func, unsigned line)
858{
859return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */
860}
861
862#endif /* !MACRO_PREDEF */
863
864#endif /* _FUNCTIONS_H_ */
865
866/* vi: aw
867*/
868/* End of functions.h */
Unnamed repository; edit this file 'description' to name the repository.