1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
8
9
10 /* Prototypes for functions that appear in various modules. Gathered together
11 to avoid having a lot of tiddly little headers with only a couple of lines in
12 them. However, some functions that are used (or not used) by utility programs
13 are in in fact in separate headers. */
14 #ifndef _FUNCTIONS_H_
15 #define _FUNCTIONS_H_
16
17 #include <ctype.h>
18 #include <sys/time.h>
19
20
21 #ifdef EXIM_PERL
22 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
23 uschar **) WARN_UNUSED_RESULT;
24 extern void cleanup_perl(void);
25 extern uschar *init_perl(uschar *);
26 #endif
27
28
29 #ifndef DISABLE_TLS
30 extern const char *
31 std_dh_prime_default(void);
32 extern const char *
33 std_dh_prime_named(const uschar *);
34
35 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
36 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
37 extern uschar * tls_cert_issuer(void *, uschar * mod);
38 extern uschar * tls_cert_not_before(void *, uschar * mod);
39 extern uschar * tls_cert_not_after(void *, uschar * mod);
40 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
41 extern uschar * tls_cert_serial_number(void *, uschar * mod);
42 extern uschar * tls_cert_signature(void *, uschar * mod);
43 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
44 extern uschar * tls_cert_subject(void *, uschar * mod);
45 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
46 extern uschar * tls_cert_version(void *, uschar * mod);
47
48 extern uschar * tls_cert_der_b64(void * cert);
49 extern uschar * tls_cert_fprt_md5(void *);
50 extern uschar * tls_cert_fprt_sha1(void *);
51 extern uschar * tls_cert_fprt_sha256(void *);
52
53 extern void tls_clean_env(void);
54 extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *,
55 void *, tls_support *, uschar **);
56 extern void tls_client_creds_reload(BOOL);
57
58 extern void tls_close(void *, int);
59 extern BOOL tls_could_read(void);
60 extern void tls_daemon_init(void);
61 extern int tls_daemon_tick(void);
62 extern BOOL tls_dropprivs_validate_require_cipher(BOOL);
63 extern BOOL tls_export_cert(uschar *, size_t, void *);
64 extern int tls_feof(void);
65 extern int tls_ferror(void);
66 extern uschar *tls_field_from_dn(uschar *, const uschar *);
67 extern void tls_free_cert(void **);
68 extern int tls_getc(unsigned);
69 extern uschar *tls_getbuf(unsigned *);
70 extern void tls_get_cache(unsigned);
71 extern BOOL tls_hasc(void);
72 extern BOOL tls_import_cert(const uschar *, void **);
73 extern BOOL tls_is_name_for_cert(const uschar *, void *);
74 # ifdef USE_OPENSSL
75 extern BOOL tls_openssl_options_parse(uschar *, long *);
76 # endif
77 extern int tls_read(void *, uschar *, size_t);
78 extern int tls_server_start(uschar **);
79 extern void tls_shutdown_wr(void *);
80 extern BOOL tls_smtp_buffered(void);
81 extern int tls_ungetc(int);
82 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
83 extern void tls_watch_discard_event(int);
84 extern void tls_watch_invalidate(void);
85 #endif
86 extern int tls_write(void *, const uschar *, size_t, BOOL);
87 extern uschar *tls_validate_require_cipher(void);
88 extern void tls_version_report(FILE *);
89
90 # ifdef SUPPORT_DANE
91 extern int tlsa_lookup(const host_item *, dns_answer *, BOOL);
92 # endif
93
94 #endif /*DISABLE_TLS*/
95
96
97 /* Everything else... */
98
99 extern acl_block *acl_read(uschar *(*)(void), uschar **);
100 extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
101 extern int acl_eval(int, uschar *, uschar **, uschar **);
102
103 extern tree_node *acl_var_create(uschar *);
104 extern void acl_var_write(uschar *, uschar *, void *);
105
106 #ifdef EXPERIMENTAL_ARC
107 extern void *arc_ams_setup_sign_bodyhash(void);
108 extern const uschar *arc_header_feed(gstring *, BOOL);
109 extern gstring *arc_sign(const uschar *, gstring *, uschar **);
110 extern void arc_sign_init(void);
111 extern const uschar *acl_verify_arc(void);
112 extern uschar * fn_arc_domains(void);
113 #endif
114
115 extern void assert_no_variables(void *, int, const char *, int);
116 extern int auth_call_pam(const uschar *, uschar **);
117 extern int auth_call_pwcheck(uschar *, uschar **);
118 extern int auth_call_radius(const uschar *, uschar **);
119 extern int auth_call_saslauthd(const uschar *, const uschar *,
120 const uschar *, const uschar *, uschar **);
121 extern int auth_check_serv_cond(auth_instance *);
122 extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
123 extern int auth_client_item(void *, auth_instance *, const uschar **,
124 unsigned, int, uschar *, int);
125
126
127 extern int auth_get_data(uschar **, const uschar *, int);
128 extern int auth_get_no64_data(uschar **, uschar *);
129 extern int auth_prompt(const uschar *);
130 extern int auth_read_input(const uschar *);
131 extern gstring * auth_show_supported(gstring *);
132 extern uschar *auth_xtextencode(uschar *, int);
133 extern int auth_xtextdecode(uschar *, uschar **);
134
135 #ifdef EXPERIMENTAL_ARC
136 extern gstring *authres_arc(gstring *);
137 #endif
138 #ifndef DISABLE_DKIM
139 extern gstring *authres_dkim(gstring *);
140 #endif
141 #ifdef SUPPORT_DMARC
142 extern gstring *authres_dmarc(gstring *);
143 #endif
144 extern gstring *authres_smtpauth(gstring *);
145 #ifdef SUPPORT_SPF
146 extern gstring *authres_spf(gstring *);
147 #endif
148
149 extern uschar *b64encode(const uschar *, int);
150 extern uschar *b64encode_taint(const uschar *, int, BOOL);
151 extern int b64decode(const uschar *, uschar **);
152 extern int bdat_getc(unsigned);
153 extern uschar *bdat_getbuf(unsigned *);
154 extern BOOL bdat_hasc(void);
155 extern int bdat_ungetc(int);
156 extern void bdat_flush_data(void);
157
158 extern void bits_clear(unsigned int *, size_t, int *);
159 extern void bits_set(unsigned int *, size_t, int *);
160
161 extern void cancel_cutthrough_connection(BOOL, const uschar *);
162 extern gstring *cat_file(FILE *, gstring *, uschar *);
163 extern gstring *cat_file_tls(void *, gstring *, uschar *);
164 extern int check_host(void *, const uschar *, const uschar **, uschar **);
165 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
166 extern pid_t child_open_exim_function(int *, const uschar *);
167 extern pid_t child_open_exim2_function(int *, uschar *, uschar *,
168 const uschar *);
169 extern pid_t child_open_function(uschar **, uschar **, int,
170 int *, int *, BOOL, const uschar *);
171 extern pid_t child_open_uid(const uschar **, const uschar **, int,
172 uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *);
173 extern BOOL cleanup_environment(void);
174 extern void cutthrough_data_puts(uschar *, int);
175 extern void cutthrough_data_put_nl(void);
176 extern uschar *cutthrough_finaldot(void);
177 extern BOOL cutthrough_flush_send(void);
178 extern BOOL cutthrough_headers_send(void);
179 extern BOOL cutthrough_predata(void);
180 extern void release_cutthrough_connection(const uschar *);
181
182 extern void daemon_go(void);
183
184 #ifdef EXPERIMENTAL_DCC
185 extern int dcc_process(uschar **);
186 #endif
187
188 extern void debug_logging_activate(uschar *, uschar *);
189 extern void debug_logging_stop(void);
190 extern void debug_print_argv(const uschar **);
191 extern void debug_print_ids(uschar *);
192 extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
193 extern void debug_print_string(uschar *);
194 extern void debug_print_tree(const char *, tree_node *);
195 extern void debug_vprintf(int, const char *, va_list);
196 extern void debug_print_socket(int);
197
198 extern void decode_bits(unsigned int *, size_t, int *,
199 uschar *, bit_table *, int, uschar *, int);
200 extern void delete_pid_file(void);
201 extern void deliver_local(address_item *, BOOL);
202 extern address_item *deliver_make_addr(uschar *, BOOL);
203 extern void delivery_log(int, address_item *, int, uschar *);
204 extern int deliver_message(uschar *, BOOL, BOOL);
205 extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
206 extern void deliver_set_expansions(address_item *);
207 extern int deliver_split_address(address_item *);
208 extern void deliver_succeeded(address_item *);
209
210 extern void delivery_re_exec(int);
211
212 extern void die_tainted(const uschar *, const uschar *, int);
213 extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
214 #ifndef DISABLE_DKIM
215 extern uschar *dkim_exim_query_dns_txt(const uschar *);
216 extern void dkim_exim_sign_init(void);
217
218 extern BOOL dkim_transport_write_message(transport_ctx *,
219 struct ob_dkim *, const uschar ** errstr);
220 #endif
221 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
222 extern int dns_basic_lookup(dns_answer *, const uschar *, int);
223 extern uschar *dns_build_reverse(const uschar *);
224 extern time_t dns_expire_from_soa(dns_answer *, int);
225 extern void dns_init(BOOL, BOOL, BOOL);
226 extern BOOL dns_is_aa(const dns_answer *);
227 extern BOOL dns_is_secure(const dns_answer *);
228 extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **);
229 extern void dns_pattern_init(void);
230 extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
231 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
232 extern uschar *dns_text_type(int);
233 extern void dscp_list_to_stream(FILE *);
234 extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
235
236 extern void enq_end(uschar *);
237 extern BOOL enq_start(uschar *, unsigned);
238 #ifndef DISABLE_EVENT
239 extern uschar *event_raise(uschar *, const uschar *, uschar *);
240 extern void msg_event_raise(const uschar *, const address_item *);
241 #endif
242
243 extern int exim_chown_failure(int, const uschar*, uid_t, gid_t);
244 extern const uschar * exim_errstr(int);
245 extern void exim_exit(int) NORETURN;
246 extern void exim_gettime(struct timeval *);
247 extern void exim_nullstd(void);
248 extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
249 extern void exim_underbar_exit(int) NORETURN;
250 extern void exim_wait_tick(struct timeval *, int);
251 extern int exp_bool(address_item *addr,
252 uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
253 uschar *svalue, BOOL *rvalue);
254 extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
255 extern uschar *expand_file_big_buffer(const uschar *);
256 extern uschar *expand_string(uschar *); /* public, cannot make const */
257 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
258 extern uschar *expand_getkeyed(const uschar *, const uschar *);
259
260 extern uschar *expand_hide_passwords(uschar * );
261 extern uschar *expand_string_copy(const uschar *);
262 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
263 extern void modify_variable(uschar *, void *);
264
265 extern BOOL fd_ready(int, time_t);
266
267 extern int filter_interpret(uschar *, int, address_item **, uschar **);
268 extern BOOL filter_personal(string_item *, BOOL);
269 extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
270 extern BOOL filter_system_interpret(address_item **, uschar **);
271
272 extern uschar * fn_hdrs_added(void);
273 extern void force_fd(int, int);
274
275 extern void header_add(int, const char *, ...);
276 extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...);
277 extern int header_checkname(header_line *, BOOL);
278 extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
279 extern int host_address_extract_port(uschar *);
280 extern uschar *host_and_ident(BOOL);
281 extern int host_aton(const uschar *, int *);
282 extern void host_build_hostlist(host_item **, const uschar *, BOOL);
283 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
284 extern void host_build_log_info(void);
285 extern void host_build_sender_fullhost(void);
286 extern int host_find_byname(host_item *, const uschar *, int,
287 const uschar **, BOOL);
288 extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
289 uschar *, const dnssec_domains *, const uschar **, BOOL *);
290 extern ip_address_item *host_find_interfaces(void);
291 extern BOOL host_is_in_net(const uschar *, const uschar *, int);
292 extern BOOL host_is_tls_on_connect_port(int);
293 extern int host_item_get_port(host_item *);
294 extern void host_mask(int, int *, int);
295 extern int host_name_lookup(void);
296 extern int host_nmtoa(int, int *, int, uschar *, int);
297 extern uschar *host_ntoa(int, const void *, uschar *, int *);
298 extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
299
300 extern uschar *imap_utf7_encode(uschar *, const uschar *,
301 uschar, uschar *, uschar **);
302
303 extern void invert_address(uschar *, uschar *);
304 extern int ip_addr(void *, int, const uschar *, int);
305 extern int ip_bind(int, int, uschar *, int);
306 extern int ip_connect(int, int, const uschar *, int, int, const blob *);
307 extern int ip_connectedsocket(int, const uschar *, int, int,
308 int, host_item *, uschar **, const blob *);
309 extern int ip_get_address_family(int);
310 extern void ip_keepalive(int, const uschar *, BOOL);
311 extern int ip_recv(client_conn_ctx *, uschar *, int, time_t);
312 extern int ip_socket(int, int);
313
314 extern int ip_tcpsocket(const uschar *, uschar **, int, host_item *);
315 extern int ip_unixsocket(const uschar *, uschar **);
316 extern int ip_streamsocket(const uschar *, uschar **, int, host_item *);
317
318 extern int ipv6_nmtoa(int *, uschar *);
319
320 extern uschar *local_part_quote(uschar *);
321 extern int log_open_as_exim(uschar * const);
322 extern void log_close_all(void);
323
324 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
325 extern BOOL macro_read_assignment(uschar *);
326 extern uschar *macros_expand(int, int *, BOOL *);
327 extern void mainlog_close(void);
328 #ifdef WITH_CONTENT_SCAN
329 extern int malware(const uschar *, int);
330 extern int malware_in_file(uschar *);
331 extern void malware_init(void);
332 extern gstring * malware_show_supported(gstring *);
333 #endif
334 extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **,
335 unsigned int *, int, int, const uschar **);
336 extern int match_address_list_basic(const uschar *, const uschar **, int);
337 extern int match_check_list(const uschar **, int, tree_node **, unsigned int **,
338 int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
339 const uschar *, const uschar **);
340 extern int match_isinlist(const uschar *, const uschar **, int, tree_node **,
341 unsigned int *, int, BOOL, const uschar **);
342 extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
343 const uschar **);
344
345 extern void message_start(void);
346 extern void message_tidyup(void);
347 extern void md5_end(md5 *, const uschar *, int, uschar *);
348 extern void md5_mid(md5 *, const uschar *);
349 extern void md5_start(md5 *);
350 extern void millisleep(int);
351 #ifdef WITH_CONTENT_SCAN
352 struct mime_boundary_context;
353 extern int mime_acl_check(uschar *acl, FILE *f,
354 struct mime_boundary_context *, uschar **, uschar **);
355 extern int mime_decode(const uschar **);
356 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
357 extern int mime_regex(const uschar **);
358 extern void mime_set_anomaly(int);
359 #endif
360 extern uschar *moan_check_errorcopy(uschar *);
361 extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
362 BOOL, uschar *);
363 extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
364 extern BOOL moan_send_message(uschar *, int, error_block *eblock,
365 header_line *, FILE *, uschar *);
366 extern void moan_tell_someone(uschar *, address_item *,
367 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
368 extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
369 extern void moan_write_from(FILE *);
370 extern void moan_write_references(FILE *, uschar *);
371 extern FILE *modefopen(const uschar *, const char *, mode_t);
372
373 extern int open_cutthrough_connection( address_item * addr );
374
375 extern uschar *parse_extract_address(const uschar *, uschar **, int *, int *, int *,
376 BOOL);
377 extern int parse_forward_list(const uschar *, int, address_item **, uschar **,
378 const uschar *, uschar *, error_block **);
379 extern uschar *parse_find_address_end(const uschar *, BOOL);
380 extern const uschar *parse_find_at(const uschar *);
381 extern const uschar *parse_fix_phrase(const uschar *, int);
382 extern const uschar *parse_message_id(const uschar *, uschar **, uschar **);
383 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, BOOL);
384 extern const uschar *parse_date_time(const uschar *str, time_t *t);
385 extern void priv_drop_temp(const uid_t, const gid_t);
386 extern void priv_restore(void);
387 extern int vaguely_random_number(int);
388 #ifndef DISABLE_TLS
389 extern int vaguely_random_number_fallback(int);
390 #endif
391
392 extern BOOL queue_action(uschar *, int, uschar **, int, int);
393 extern void queue_check_only(void);
394 extern unsigned queue_count(void);
395 extern unsigned queue_count_cached(void);
396 extern void queue_list(int, uschar **, int);
397 #ifndef DISABLE_QUEUE_RAMP
398 extern void queue_notify_daemon(const uschar * hostname);
399 #endif
400 extern void queue_run(uschar *, uschar *, BOOL);
401
402 extern int random_number(int);
403 extern const uschar *rc_to_string(int);
404 extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
405 uschar *, uschar *, uschar *, ugid_block *, address_item **,
406 uschar **, error_block **, int *, uschar *);
407 extern int rda_is_filter(const uschar *);
408 extern BOOL readconf_depends(driver_instance *, uschar *);
409 extern void readconf_driver_init(uschar *, driver_instance **,
410 driver_info *, int, void *, int, optionlist *, int);
411 extern uschar *readconf_find_option(void *);
412 extern void readconf_main(BOOL);
413 extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
414 extern BOOL readconf_print(const uschar *, uschar *, BOOL);
415 extern uschar *readconf_printtime(int);
416 extern uschar *readconf_readname(uschar *, int, uschar *);
417 extern int readconf_readtime(const uschar *, int, BOOL);
418 extern void readconf_rest(void);
419 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
420 extern void readconf_save_config(const uschar *);
421 extern void read_message_body(BOOL);
422 extern void receive_bomb_out(uschar *, uschar *) NORETURN;
423 extern BOOL receive_check_fs(int);
424 extern BOOL receive_check_set_sender(uschar *);
425 extern BOOL receive_msg(BOOL);
426 extern int_eximarith_t receive_statvfs(BOOL, int *);
427 extern void receive_swallow_smtp(void);
428 #ifdef WITH_CONTENT_SCAN
429 extern int regex(const uschar **);
430 #endif
431 extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int);
432 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
433 extern void retry_add_item(address_item *, uschar *, int);
434 extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL,
435 uschar **, uschar **);
436 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
437 extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *,
438 dbdata_retry *, time_t);
439 extern void retry_update(address_item **, address_item **, address_item **);
440 extern const uschar *rewrite_address(const uschar *, BOOL, BOOL, rewrite_rule *, int);
441 extern const uschar *rewrite_address_qualify(const uschar *, BOOL);
442 extern header_line *rewrite_header(header_line *,
443 const uschar *, const uschar *,
444 rewrite_rule *, int, BOOL);
445 extern const uschar *rewrite_one(const uschar *, int, BOOL *, BOOL, uschar *,
446 rewrite_rule *);
447 extern void rewrite_test(const uschar *);
448 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
449 uschar **);
450 extern int route_address(address_item *, address_item **, address_item **,
451 address_item **, address_item **, int);
452 extern int route_check_prefix(const uschar *, const uschar *, unsigned *);
453 extern int route_check_suffix(const uschar *, const uschar *, unsigned *);
454 extern BOOL route_findgroup(uschar *, gid_t *);
455 extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *);
456 extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
457 uschar **);
458 extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
459 struct passwd **, uid_t *, uschar **);
460 extern void route_init(void);
461 extern gstring * route_show_supported(gstring *);
462 extern void route_tidyup(void);
463
464 extern uschar *search_args(int, uschar *, uschar *, uschar **, const uschar *);
465 extern uschar *search_find(void *, const uschar *, uschar *, int,
466 const uschar *, int, int, int *, const uschar *);
467 extern int search_findtype(const uschar *, int);
468 extern int search_findtype_partial(const uschar *, int *, const uschar **, int *,
469 int *, const uschar **);
470 extern void *search_open(const uschar *, int, int, uid_t *, gid_t *);
471 extern void search_tidyup(void);
472 extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
473 extern void sha1_end(hctx *, const uschar *, int, uschar *);
474 extern void sha1_mid(hctx *, const uschar *);
475 extern void sha1_start(hctx *);
476 extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
477 uschar *, address_item **, uschar **);
478 extern void sigalrm_handler(int);
479 extern BOOL smtp_buffered(void);
480 extern void smtp_closedown(uschar *);
481 extern void smtp_command_timeout_exit(void) NORETURN;
482 extern void smtp_command_sigterm_exit(void) NORETURN;
483 extern void smtp_data_timeout_exit(void) NORETURN;
484 extern void smtp_data_sigint_exit(void) NORETURN;
485 extern void smtp_deliver_init(void);
486 extern uschar *smtp_cmd_hist(void);
487 extern int smtp_connect(smtp_connect_args *, const blob *);
488 extern int smtp_sock_connect(host_item *, int, int, uschar *,
489 transport_instance * tb, int, const blob *);
490 extern int smtp_feof(void);
491 extern int smtp_ferror(void);
492 extern uschar *smtp_get_connection_info(void);
493 extern BOOL smtp_get_interface(uschar *, int, address_item *,
494 uschar **, uschar *);
495 extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
496 extern int smtp_getc(unsigned);
497 extern uschar *smtp_getbuf(unsigned *);
498 extern void smtp_get_cache(unsigned);
499 extern BOOL smtp_hasc(void);
500 extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
501 extern void smtp_log_no_mail(void);
502 extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
503 extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN;
504 extern BOOL smtp_read_response(void *, uschar *, int, int, int);
505 extern void *smtp_reset(void *);
506 extern void smtp_respond(uschar *, int, BOOL, uschar *);
507 extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
508 extern void smtp_port_for_connect(host_item *, int);
509 extern void smtp_send_prohibition_message(int, uschar *);
510 extern int smtp_setup_msg(void);
511 extern BOOL smtp_start_session(void);
512 extern int smtp_ungetc(int);
513 extern BOOL smtp_verify_helo(void);
514 extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4);
515 #ifdef WITH_CONTENT_SCAN
516 extern int spam(const uschar **);
517 extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **);
518 #endif
519 extern void spool_clear_header_globals(void);
520 extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
521 extern int spool_open_datafile(uschar *);
522 extern int spool_open_temp(uschar *);
523 extern int spool_read_header(uschar *, BOOL, BOOL);
524 extern uschar *spool_sender_from_msgid(const uschar *);
525 extern int spool_write_header(uschar *, int, uschar **);
526 extern int stdin_getc(unsigned);
527 extern int stdin_feof(void);
528 extern int stdin_ferror(void);
529 extern BOOL stdin_hasc(void);
530 extern int stdin_ungetc(int);
531
532 extern void store_exit(void);
533 extern void store_init(void);
534 extern void store_writeprotect(int);
535
536 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
537 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
538 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
539 extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT;
540 extern uschar *string_base62(unsigned long int);
541 extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT;
542 extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT;
543 extern int string_compare_by_pointer(const void *, const void *);
544 extern uschar *string_copy_dnsdomain(uschar *);
545 extern uschar *string_copy_malloc(const uschar *);
546 extern uschar *string_dequote(const uschar **);
547 extern uschar *string_format_size(int, uschar *);
548 extern int string_interpret_escape(const uschar **);
549 extern int string_is_ip_address(const uschar *, int *);
550 #ifdef SUPPORT_I18N
551 extern BOOL string_is_utf8(const uschar *);
552 #endif
553 extern const uschar *string_printing2(const uschar *, int);
554 extern uschar *string_split_message(uschar *);
555 extern uschar *string_unprinting(uschar *);
556 #ifdef SUPPORT_I18N
557 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
558 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
559 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
560 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
561 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
562 #endif
563
564 #define string_format(buf, siz, fmt, ...) \
565 string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
566 extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned,
567 const char *, ...) ALMOST_PRINTF(5,6);
568
569 #define string_vformat(g, flgs, fmt, ap) \
570 string_vformat_trc(g, US __FUNCTION__, __LINE__, \
571 STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap)
572 extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned,
573 unsigned, unsigned, const char *, va_list);
574
575 #define string_open_failed(fmt, ...) \
576 string_open_failed_trc(US __FUNCTION__, __LINE__, fmt, __VA_ARGS__)
577 extern uschar *string_open_failed_trc(const uschar *, unsigned,
578 const char *, ...) PRINTF_FUNCTION(3,4);
579
580 #define string_nextinlist(lp, sp, b, l) \
581 string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__)
582 extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen,
583 const uschar * func, int line);
584
585 extern int strcmpic(const uschar *, const uschar *);
586 extern int strncmpic(const uschar *, const uschar *, int);
587 extern uschar *strstric(uschar *, uschar *, BOOL);
588
589 extern int test_harness_fudged_queue_time(int);
590 extern void tcp_init(void);
591 #ifdef EXIM_TFO_PROBE
592 extern void tfo_probe(void);
593 #endif
594 extern void tls_modify_variables(tls_support *);
595 extern uschar *tod_stamp(int);
596
597 extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *,
598 oicf, void*);
599 extern void transport_init(void);
600 extern void transport_do_pass_socket(const uschar *, const uschar *,
601 const uschar *, uschar *, int);
602 extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *, int
603 #ifdef EXPERIMENTAL_ESMTP_LIMITS
604 , unsigned, unsigned, unsigned
605 #endif
606 );
607 extern uschar *transport_rcpt_address(address_item *, BOOL);
608 extern BOOL transport_set_up_command(const uschar ***, uschar *,
609 BOOL, int, address_item *, uschar *, uschar **);
610 extern void transport_update_waiting(host_item *, uschar *);
611 extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL);
612 extern void transport_write_reset(int);
613 extern BOOL transport_write_string(int, const char *, ...);
614 extern BOOL transport_headers_send(transport_ctx *,
615 BOOL (*)(transport_ctx *, uschar *, int));
616 extern gstring * transport_show_supported(gstring *);
617 extern BOOL transport_write_message(transport_ctx *, int);
618 extern void tree_add_duplicate(const uschar *, address_item *);
619 extern void tree_add_nonrecipient(const uschar *);
620 extern void tree_add_unusable(const host_item *);
621 extern void tree_dup(tree_node **, tree_node *);
622 extern int tree_insertnode(tree_node **, tree_node *);
623 extern tree_node *tree_search(tree_node *, const uschar *);
624 extern void tree_write(tree_node *, FILE *);
625 extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
626
627 #ifdef WITH_CONTENT_SCAN
628 extern void unspool_mbox(void);
629 #endif
630 #ifdef SUPPORT_I18N
631 extern void utf8_version_report(FILE *);
632 #endif
633
634 extern int verify_address(address_item *, FILE *, int, int, int, int,
635 uschar *, uschar *, BOOL *);
636 extern int verify_check_dnsbl(int, const uschar **, uschar **);
637 extern int verify_check_header_address(uschar **, uschar **, int, int, int,
638 uschar *, uschar *, int, int *);
639 extern int verify_check_headers(uschar **);
640 extern int verify_check_header_names_ascii(uschar **);
641 extern int verify_check_host(uschar **);
642 extern int verify_check_notblind(BOOL);
643 extern int verify_check_given_host(const uschar **, const host_item *);
644 extern int verify_check_this_host(const uschar **, unsigned int *,
645 const uschar*, const uschar *, const uschar **);
646 extern address_item *verify_checked_sender(uschar *);
647 extern void verify_get_ident(int);
648 extern void verify_quota(uschar *);
649 extern int verify_quota_call(const uschar *, int, int, uschar **);
650 extern BOOL verify_sender(int *, uschar **);
651 extern BOOL verify_sender_preliminary(int *, uschar **);
652 extern void version_init(void);
653
654 extern BOOL write_chunk(transport_ctx *, uschar *, int);
655 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
656
657
658 /******************************************************************************/
659 /* Predicate: if an address is in a tainted pool.
660 By extension, a variable pointing to this address is tainted.
661 */
662
663 static inline BOOL
is_tainted(const void * p)664 is_tainted(const void * p)
665 {
666 #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C)
667 return FALSE;
668
669 #else
670 extern BOOL is_tainted_fn(const void *);
671 return is_tainted_fn(p);
672 #endif
673 }
674
675 /******************************************************************************/
676 /* String functions */
__Ustrcat(uschar * dst,const uschar * src,const char * func,int line)677 static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line)
678 {
679 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
680 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line);
681 #endif
682 return US strcat(CS dst, CCS src);
683 }
__Ustrcpy(uschar * dst,const uschar * src,const char * func,int line)684 static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line)
685 {
686 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
687 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line);
688 #endif
689 return US strcpy(CS dst, CCS src);
690 }
__Ustrncat(uschar * dst,const uschar * src,size_t n,const char * func,int line)691 static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line)
692 {
693 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
694 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line);
695 #endif
696 return US strncat(CS dst, CCS src, n);
697 }
__Ustrncpy(uschar * dst,const uschar * src,size_t n,const char * func,int line)698 static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line)
699 {
700 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
701 if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line);
702 #endif
703 return US strncpy(CS dst, CCS src, n);
704 }
705 /*XXX will likely need unchecked copy also */
706
707
708 /* Advance the string pointer given over any whitespace.
709 Return the next char as there's enought places using it to be useful. */
710
711 #define Uskip_whitespace(sp) skip_whitespace(CUSS sp)
712
skip_whitespace(const uschar ** sp)713 static inline uschar skip_whitespace(const uschar ** sp)
714 { while (isspace(**sp)) (*sp)++; return **sp; }
715
716
717 /******************************************************************************/
718
719 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
720 /* exim_chown - in some NFSv4 setups *seemes* to be an issue with
721 chown(<exim-uid>, <exim-gid>).
722
723 Probably because the idmapping is broken, misconfigured or set up in
724 an unusal way. (see Bug 2931). As I'm not sure, if this was a single
725 case of misconfiguration, or if there are more such broken systems
726 out, I try to impose as least impact as possible and for now just write
727 a panic log entry pointing to the bug report. You're encouraged to
728 contact the developers, if you experience this issue.
729
730 fd the file descriptor (or -1 if not valid)
731 name the file name for error messages or for file operations,
732 if fd is < 0
733 owner the owner
734 group the group
735
736 returns 0 on success, -1 on failure */
737
738 static inline int
exim_fchown(int fd,uid_t owner,gid_t group,const uschar * name)739 exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name)
740 {
741 return fchown(fd, owner, group)
742 ? exim_chown_failure(fd, name, owner, group) : 0;
743 }
744
745 static inline int
exim_chown(const uschar * name,uid_t owner,gid_t group)746 exim_chown(const uschar *name, uid_t owner, gid_t group)
747 {
748 return chown(CCS name, owner, group)
749 ? exim_chown_failure(-1, name, owner, group) : 0;
750 }
751 #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */
752
753 /******************************************************************************/
754 /* String functions */
755
756 #if !defined(MACRO_PREDEF)
757 /*************************************************
758 * Copy and save string *
759 *************************************************/
760
761 /* This function assumes that memcpy() is faster than strcpy().
762 The result is explicitly nul-terminated.
763 */
764
765 static inline uschar *
string_copyn_taint_trc(const uschar * s,unsigned len,BOOL tainted,const char * func,int line)766 string_copyn_taint_trc(const uschar * s, unsigned len,
767 BOOL tainted, const char * func, int line)
768 {
769 uschar * ss = store_get_3(len + 1, tainted, func, line);
770 memcpy(ss, s, len);
771 ss[len] = '\0';
772 return ss;
773 }
774
775 static inline uschar *
string_copy_taint_trc(const uschar * s,BOOL tainted,const char * func,int line)776 string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line)
777 { return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); }
778
779 static inline uschar *
string_copyn_trc(const uschar * s,unsigned len,const char * func,int line)780 string_copyn_trc(const uschar * s, unsigned len, const char * func, int line)
781 { return string_copyn_taint_trc(s, len, is_tainted(s), func, line); }
782 static inline uschar *
string_copy_trc(const uschar * s,const char * func,int line)783 string_copy_trc(const uschar * s, const char * func, int line)
784 { return string_copy_taint_trc(s, is_tainted(s), func, line); }
785
786
787 /* String-copy functions explicitly setting the taint status */
788
789 #define string_copyn_taint(s, len, tainted) \
790 string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__)
791 #define string_copy_taint(s, tainted) \
792 string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__)
793
794 /* Simple string-copy functions maintaining the taint */
795
796 #define string_copyn(s, len) \
797 string_copyn_trc((s), (len), __FUNCTION__, __LINE__)
798 #define string_copy(s) \
799 string_copy_trc((s), __FUNCTION__, __LINE__)
800
801
802 /*************************************************
803 * Copy, lowercase and save string *
804 *************************************************/
805
806 /*
807 Argument: string to copy
808 Returns: copy of string in new store, with letters lowercased
809 */
810
811 static inline uschar *
string_copylc(const uschar * s)812 string_copylc(const uschar *s)
813 {
814 uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s));
815 uschar *p = ss;
816 while (*s != 0) *p++ = tolower(*s++);
817 *p = 0;
818 return ss;
819 }
820
821
822
823 /*************************************************
824 * Copy, lowercase, and save string, given length *
825 *************************************************/
826
827 /* It is assumed the data contains no zeros. A zero is added
828 onto the end.
829
830 Arguments:
831 s string to copy
832 n number of characters
833
834 Returns: copy of string in new store, with letters lowercased
835 */
836
837 static inline uschar *
string_copynlc(uschar * s,int n)838 string_copynlc(uschar *s, int n)
839 {
840 uschar *ss = store_get(n + 1, is_tainted(s));
841 uschar *p = ss;
842 while (n-- > 0) *p++ = tolower(*s++);
843 *p = 0;
844 return ss;
845 }
846
847
848 # ifndef COMPILE_UTILITY
849 /*************************************************
850 * Copy and save string in longterm store *
851 *************************************************/
852
853 /* This function assumes that memcpy() is faster than strcpy().
854
855 Argument: string to copy
856 Returns: copy of string in new store
857 */
858
859 static inline uschar *
string_copy_perm(const uschar * s,BOOL force_taint)860 string_copy_perm(const uschar *s, BOOL force_taint)
861 {
862 int old_pool = store_pool;
863 int len = Ustrlen(s) + 1;
864 uschar *ss;
865
866 store_pool = POOL_PERM;
867 ss = store_get(len, force_taint || is_tainted(s));
868 memcpy(ss, s, len);
869 store_pool = old_pool;
870 return ss;
871 }
872 # endif
873
874
875
876 /* sprintf into a buffer, taint-unchecked */
877
878 static inline void
string_format_nt(uschar * buf,int siz,const char * fmt,...)879 string_format_nt(uschar * buf, int siz, const char * fmt, ...)
880 {
881 gstring gs = { .size = siz, .ptr = 0, .s = buf };
882 va_list ap;
883 va_start(ap, fmt);
884 (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap);
885 va_end(ap);
886 }
887
888
889
890 /******************************************************************************/
891 /* Growable-string functions */
892
893 /* Create a growable-string with some preassigned space */
894
895 #define string_get_tainted(size, tainted) \
896 string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__)
897
898 static inline gstring *
string_get_tainted_trc(unsigned size,BOOL tainted,const char * func,unsigned line)899 string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line)
900 {
901 gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line);
902 g->size = size;
903 g->ptr = 0;
904 g->s = US(g + 1);
905 return g;
906 }
907
908 #define string_get(size) \
909 string_get_trc((size), __FUNCTION__, __LINE__)
910
911 static inline gstring *
string_get_trc(unsigned size,const char * func,unsigned line)912 string_get_trc(unsigned size, const char * func, unsigned line)
913 {
914 return string_get_tainted_trc(size, FALSE, func, line);
915 }
916
917 /* NUL-terminate the C string in the growable-string, and return it. */
918
919 static inline uschar *
string_from_gstring(gstring * g)920 string_from_gstring(gstring * g)
921 {
922 if (!g) return NULL;
923 g->s[g->ptr] = '\0';
924 return g->s;
925 }
926
927 static inline unsigned
gstring_length(const gstring * g)928 gstring_length(const gstring * g)
929 {
930 return g ? (unsigned)g->ptr : 0;
931 }
932
933
934 #define gstring_release_unused(g) \
935 gstring_release_unused_trc(g, __FUNCTION__, __LINE__)
936
937 static inline void
gstring_release_unused_trc(gstring * g,const char * file,unsigned line)938 gstring_release_unused_trc(gstring * g, const char * file, unsigned line)
939 {
940 if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line);
941 }
942
943
944 /* sprintf-append to a growable-string */
945
946 #define string_fmt_append(g, fmt, ...) \
947 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
948 SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__)
949
950 #define string_fmt_append_f(g, flgs, fmt, ...) \
951 string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \
952 flgs, fmt, __VA_ARGS__)
953
954 static inline gstring *
string_fmt_append_f_trc(gstring * g,const uschar * func,unsigned line,unsigned flags,const char * format,...)955 string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line,
956 unsigned flags, const char *format, ...)
957 {
958 va_list ap;
959 va_start(ap, format);
960 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
961 flags, format, ap);
962 va_end(ap);
963 return g;
964 }
965
966
967 /* Copy the content of a string to tainted memory */
968
969 static inline void
gstring_rebuffer(gstring * g)970 gstring_rebuffer(gstring * g)
971 {
972 uschar * s = store_get(g->size, TRUE);
973 memcpy(s, g->s, g->ptr);
974 g->s = s;
975 }
976
977
978 # ifndef COMPILE_UTILITY
979 /******************************************************************************/
980 /* Use store_malloc for DNSA structs, and explicit frees. Using the same pool
981 for them as the strings we proceed to copy from them meant they could not be
982 released, hence blowing 64k for every DNS lookup. That mounted up. With malloc
983 we do have to take care over marking tainted all copied strings. A separate pool
984 could be used and would handle that implicitly. */
985
986 #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__)
987
988 static inline dns_answer *
store_get_dns_answer_trc(const uschar * func,unsigned line)989 store_get_dns_answer_trc(const uschar * func, unsigned line)
990 {
991 /* return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); use tainted mem */
992 return store_malloc_3(sizeof(dns_answer), CCS func, line);
993 }
994
995 #define store_free_dns_answer(dnsa) store_free_dns_answer_trc(dnsa, CUS __FUNCTION__, __LINE__)
996
997 static inline void
store_free_dns_answer_trc(dns_answer * dnsa,const uschar * func,unsigned line)998 store_free_dns_answer_trc(dns_answer * dnsa, const uschar * func, unsigned line)
999 {
1000 store_free_3(dnsa, CCS func, line);
1001 }
1002
1003 /******************************************************************************/
1004 /* Routines with knowledge of spool layout */
1005
1006 static inline void
spool_pname_buf(uschar * buf,int len)1007 spool_pname_buf(uschar * buf, int len)
1008 {
1009 snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name);
1010 }
1011
1012 static inline uschar *
spool_dname(const uschar * purpose,uschar * subdir)1013 spool_dname(const uschar * purpose, uschar * subdir)
1014 {
1015 return string_sprintf("%s/%s/%s/%s",
1016 spool_directory, queue_name, purpose, subdir);
1017 }
1018 # endif
1019
1020 static inline uschar *
spool_q_sname(const uschar * purpose,const uschar * q,uschar * subdir)1021 spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir)
1022 {
1023 return string_sprintf("%s%s%s%s%s",
1024 q, *q ? "/" : "",
1025 purpose,
1026 *subdir ? "/" : "", subdir);
1027 }
1028
1029 static inline uschar *
spool_sname(const uschar * purpose,uschar * subdir)1030 spool_sname(const uschar * purpose, uschar * subdir)
1031 {
1032 return spool_q_sname(purpose, queue_name, subdir);
1033 }
1034
1035 static inline uschar *
spool_q_fname(const uschar * purpose,const uschar * q,const uschar * subdir,const uschar * fname,const uschar * suffix)1036 spool_q_fname(const uschar * purpose, const uschar * q,
1037 const uschar * subdir, const uschar * fname, const uschar * suffix)
1038 {
1039 return string_sprintf("%s/%s/%s/%s/%s%s",
1040 spool_directory, q, purpose, subdir, fname, suffix);
1041 }
1042
1043 static inline uschar *
spool_fname(const uschar * purpose,const uschar * subdir,const uschar * fname,const uschar * suffix)1044 spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname,
1045 const uschar * suffix)
1046 {
1047 #ifdef COMPILE_UTILITY /* version avoiding string-extension */
1048 int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1
1049 + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1;
1050 uschar * buf = store_get(len, FALSE);
1051 string_format(buf, len, "%s/%s/%s/%s/%s%s",
1052 spool_directory, queue_name, purpose, subdir, fname, suffix);
1053 return buf;
1054 #else
1055 return spool_q_fname(purpose, queue_name, subdir, fname, suffix);
1056 #endif
1057 }
1058
1059 static inline void
set_subdir_str(uschar * subdir_str,const uschar * name,int search_sequence)1060 set_subdir_str(uschar * subdir_str, const uschar * name,
1061 int search_sequence)
1062 {
1063 subdir_str[0] = split_spool_directory == (search_sequence == 0)
1064 ? name[5] : '\0';
1065 subdir_str[1] = '\0';
1066 }
1067
1068 /******************************************************************************/
1069 /* Time calculations */
1070
1071 /* Diff two times (later, earlier) returning diff in 1st arg */
1072 static inline void
timediff(struct timeval * later,const struct timeval * earlier)1073 timediff(struct timeval * later, const struct timeval * earlier)
1074 {
1075 later->tv_sec -= earlier->tv_sec;
1076 if ((later->tv_usec -= earlier->tv_usec) < 0)
1077 {
1078 later->tv_sec--;
1079 later->tv_usec += 1000*1000;
1080 }
1081 }
1082
1083 static inline void
timesince(struct timeval * diff,const struct timeval * then)1084 timesince(struct timeval * diff, const struct timeval * then)
1085 {
1086 gettimeofday(diff, NULL);
1087 timediff(diff, then);
1088 }
1089
1090 static inline uschar *
string_timediff(const struct timeval * diff)1091 string_timediff(const struct timeval * diff)
1092 {
1093 static uschar buf[sizeof("0.000s")];
1094
1095 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1096 return readconf_printtime((int)diff->tv_sec);
1097
1098 snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1099 return buf;
1100 }
1101
1102
1103 static inline uschar *
string_timesince(const struct timeval * then)1104 string_timesince(const struct timeval * then)
1105 {
1106 struct timeval diff;
1107 timesince(&diff, then);
1108 return string_timediff(&diff);
1109 }
1110
1111 static inline void
report_time_since(const struct timeval * t0,const uschar * where)1112 report_time_since(const struct timeval * t0, const uschar * where)
1113 {
1114 # ifdef MEASURE_TIMING
1115 struct timeval diff;
1116 timesince(&diff, t0);
1117 fprintf(stderr, "%d %s:\t%ld.%06ld\n",
1118 (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec);
1119 # endif
1120 }
1121
1122
1123 static inline void
testharness_pause_ms(int millisec)1124 testharness_pause_ms(int millisec)
1125 {
1126 #ifndef MEASURE_TIMING
1127 if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec);
1128 #endif
1129 }
1130
1131 /******************************************************************************/
1132 /* Taint-checked file opens */
1133 static inline uschar *
is_tainted2(const void * p,int lflags,const char * fmt,...)1134 is_tainted2(const void *p, int lflags, const char* fmt, ...)
1135 {
1136 va_list ap;
1137 uschar *msg;
1138 rmark mark;
1139
1140 if (!is_tainted(p))
1141 return NULL;
1142
1143 mark = store_mark();
1144 va_start(ap, fmt);
1145 msg = string_from_gstring(string_vformat(NULL, SVFMT_TAINT_NOCHK|SVFMT_EXTEND, fmt, ap));
1146 va_end(ap);
1147
1148 #ifdef ALLOW_INSECURE_TAINTED_DATA
1149 if (allow_insecure_tainted_data)
1150 {
1151 if LOGGING(tainted) log_write(0, LOG_MAIN, "Warning: %s", msg);
1152 store_reset(mark);
1153 return NULL;
1154 }
1155 #endif
1156
1157 if (lflags) log_write(0, lflags, "%s", msg);
1158 return msg; /* no store_reset(), as the message might be used afterwards and Exim
1159 is expected to exit anyway, so we do not care about the leaked
1160 storage */
1161 }
1162
1163 static inline int
exim_open2(const char * pathname,int flags)1164 exim_open2(const char *pathname, int flags)
1165 {
1166 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1167 return open(pathname, flags);
1168 errno = EACCES;
1169 return -1;
1170 }
1171
1172 static inline int
exim_open(const char * pathname,int flags,mode_t mode)1173 exim_open(const char *pathname, int flags, mode_t mode)
1174 {
1175 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1176 return open(pathname, flags, mode);
1177 errno = EACCES;
1178 return -1;
1179 }
1180 #ifdef EXIM_HAVE_OPENAT
1181 static inline int
exim_openat(int dirfd,const char * pathname,int flags)1182 exim_openat(int dirfd, const char *pathname, int flags)
1183 {
1184 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1185 return openat(dirfd, pathname, flags);
1186 errno = EACCES;
1187 return -1;
1188 }
1189 static inline int
exim_openat4(int dirfd,const char * pathname,int flags,mode_t mode)1190 exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode)
1191 {
1192 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1193 return openat(dirfd, pathname, flags, mode);
1194 errno = EACCES;
1195 return -1;
1196 }
1197 #endif
1198
1199 static inline FILE *
exim_fopen(const char * pathname,const char * mode)1200 exim_fopen(const char *pathname, const char *mode)
1201 {
1202 if (!is_tainted2(pathname, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname))
1203 return fopen(pathname, mode);
1204 errno = EACCES;
1205 return NULL;
1206 }
1207
1208 static inline DIR *
exim_opendir(const uschar * name)1209 exim_opendir(const uschar * name)
1210 {
1211 if (!is_tainted2(name, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name))
1212 return opendir(CCS name);
1213 errno = EACCES;
1214 return NULL;
1215 }
1216
1217 /******************************************************************************/
1218 # if !defined(COMPILE_UTILITY)
1219 /* Process manipulation */
1220
1221 static inline pid_t
exim_fork(const unsigned char * purpose)1222 exim_fork(const unsigned char * purpose)
1223 {
1224 pid_t pid;
1225 DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose);
1226 if ((pid = fork()) == 0)
1227 {
1228 process_purpose = purpose;
1229 DEBUG(D_any) debug_printf("postfork: %s\n", purpose);
1230 }
1231 else
1232 {
1233 testharness_pause_ms(100); /* let child work */
1234 DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid);
1235 }
1236 return pid;
1237 }
1238
1239
1240 static inline pid_t
child_open_exim(int * fdptr,const uschar * purpose)1241 child_open_exim(int * fdptr, const uschar * purpose)
1242 { return child_open_exim_function(fdptr, purpose); }
1243
1244 static inline pid_t
child_open_exim2(int * fdptr,uschar * sender,uschar * sender_auth,const uschar * purpose)1245 child_open_exim2(int * fdptr, uschar * sender,
1246 uschar * sender_auth, const uschar * purpose)
1247 { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); }
1248
1249 static inline pid_t
child_open(uschar ** argv,uschar ** envp,int newumask,int * infdptr,int * outfdptr,BOOL make_leader,const uschar * purpose)1250 child_open(uschar **argv, uschar **envp, int newumask, int *infdptr,
1251 int *outfdptr, BOOL make_leader, const uschar * purpose)
1252 { return child_open_function(argv, envp, newumask, infdptr,
1253 outfdptr, make_leader, purpose);
1254 }
1255
1256 static inline int
poll_one_fd(int fd,short pollbits,int tmo_millisec)1257 poll_one_fd(int fd, short pollbits, int tmo_millisec)
1258 {
1259 struct pollfd p = {.fd = fd, .events = pollbits};
1260 return poll(&p, 1, tmo_millisec);
1261 }
1262
1263 # endif /* !COMPILE_UTILITY */
1264
1265 /******************************************************************************/
1266 #endif /* !MACRO_PREDEF */
1267
1268 #endif /* _FUNCTIONS_H_ */
1269
1270 /* vi: aw
1271 */
1272 /* End of functions.h */
1273