X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/398f9af3b35c79d142dcbfd7b56758eea88c8f43..4a7dca52352d0976f200b89a50825433b7551554:/src/src/functions.h diff --git a/src/src/functions.h b/src/src/functions.h index 2ff6017d8..e6b78dbe6 100644 --- a/src/src/functions.h +++ b/src/src/functions.h @@ -2,7 +2,8 @@ * Exim - an Internet mail transport agent * *************************************************/ -/* Copyright (c) University of Cambridge 1995 - 2017 */ +/* Copyright (c) University of Cambridge 1995 - 2018 */ +/* Copyright (c) The Exim Maintainers 2020 */ /* See the file NOTICE for conditions of use and distribution. */ @@ -10,17 +11,22 @@ to avoid having a lot of tiddly little headers with only a couple of lines in them. However, some functions that are used (or not used) by utility programs are in in fact in separate headers. */ +#ifndef _FUNCTIONS_H_ +#define _FUNCTIONS_H_ + +#include +#include #ifdef EXIM_PERL -extern uschar *call_perl_cat(uschar *, int *, int *, uschar **, uschar *, - uschar **); +extern gstring *call_perl_cat(gstring *, uschar **, uschar *, + uschar **) WARN_UNUSED_RESULT; extern void cleanup_perl(void); extern uschar *init_perl(uschar *); #endif -#ifdef SUPPORT_TLS +#ifndef DISABLE_TLS extern const char * std_dh_prime_default(void); extern const char * @@ -44,38 +50,40 @@ extern uschar * tls_cert_fprt_md5(void *); extern uschar * tls_cert_fprt_sha1(void *); extern uschar * tls_cert_fprt_sha256(void *); -extern int tls_client_start(int, host_item *, address_item *, - transport_instance *, -# ifdef EXPERIMENTAL_DANE - dns_answer *, -# endif - uschar **); -extern void tls_close(BOOL, BOOL); -extern int tls_export_cert(uschar *, size_t, void *); +extern void tls_clean_env(void); +extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *, + void *, tls_support *, uschar **); + +extern void tls_close(void *, int); +extern BOOL tls_could_read(void); +extern void tls_daemon_init(void); +extern BOOL tls_dropprivs_validate_require_cipher(BOOL); +extern BOOL tls_export_cert(uschar *, size_t, void *); extern int tls_feof(void); extern int tls_ferror(void); extern void tls_free_cert(void **); extern int tls_getc(unsigned); +extern uschar *tls_getbuf(unsigned *); extern void tls_get_cache(void); -extern int tls_import_cert(const uschar *, void **); -extern int tls_read(BOOL, uschar *, size_t); +extern BOOL tls_import_cert(const uschar *, void **); +extern int tls_read(void *, uschar *, size_t); extern int tls_server_start(const uschar *, uschar **); extern BOOL tls_smtp_buffered(void); extern int tls_ungetc(int); -extern int tls_write(BOOL, const uschar *, size_t); +extern int tls_write(void *, const uschar *, size_t, BOOL); extern uschar *tls_validate_require_cipher(void); extern void tls_version_report(FILE *); -# ifndef USE_GNUTLS +# ifdef USE_OPENSSL extern BOOL tls_openssl_options_parse(uschar *, long *); # endif extern uschar * tls_field_from_dn(uschar *, const uschar *); extern BOOL tls_is_name_for_cert(const uschar *, void *); -# ifdef EXPERIMENTAL_DANE +# ifdef SUPPORT_DANE extern int tlsa_lookup(const host_item *, dns_answer *, BOOL); # endif -#endif /*SUPPORT_TLS*/ +#endif /*DISABLE_TLS*/ /* Everything else... */ @@ -86,6 +94,16 @@ extern int acl_eval(int, uschar *, uschar **, uschar **); extern tree_node *acl_var_create(uschar *); extern void acl_var_write(uschar *, uschar *, void *); + +#ifdef EXPERIMENTAL_ARC +extern void *arc_ams_setup_sign_bodyhash(void); +extern const uschar *arc_header_feed(gstring *, BOOL); +extern gstring *arc_sign(const uschar *, gstring *, uschar **); +extern void arc_sign_init(void); +extern const uschar *acl_verify_arc(void); +extern uschar * fn_arc_domains(void); +#endif + extern void assert_no_variables(void *, int, const char *, int); extern int auth_call_pam(const uschar *, uschar **); extern int auth_call_pwcheck(uschar *, uschar **); @@ -94,33 +112,63 @@ extern int auth_call_saslauthd(const uschar *, const uschar *, const uschar *, const uschar *, uschar **); extern int auth_check_serv_cond(auth_instance *); extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int); +extern int auth_client_item(void *, auth_instance *, const uschar **, + unsigned, int, uschar *, int); -extern int auth_get_data(uschar **, uschar *, int); +extern int auth_get_data(uschar **, const uschar *, int); extern int auth_get_no64_data(uschar **, uschar *); +extern int auth_prompt(const uschar *); +extern int auth_read_input(const uschar *); +extern gstring * auth_show_supported(gstring *); extern uschar *auth_xtextencode(uschar *, int); extern int auth_xtextdecode(uschar *, uschar **); -extern uschar *b64encode(uschar *, int); -extern int b64decode(uschar *, uschar **); +#ifdef EXPERIMENTAL_ARC +extern gstring *authres_arc(gstring *); +#endif +#ifndef DISABLE_DKIM +extern gstring *authres_dkim(gstring *); +#endif +#ifdef SUPPORT_DMARC +extern gstring *authres_dmarc(gstring *); +#endif +extern gstring *authres_smtpauth(gstring *); +#ifdef SUPPORT_SPF +extern gstring *authres_spf(gstring *); +#endif + +extern uschar *b64encode(const uschar *, int); +extern uschar *b64encode_taint(const uschar *, int, BOOL); +extern int b64decode(const uschar *, uschar **); extern int bdat_getc(unsigned); +extern uschar *bdat_getbuf(unsigned *); +extern int bdat_ungetc(int); extern void bdat_flush_data(void); extern void bits_clear(unsigned int *, size_t, int *); extern void bits_set(unsigned int *, size_t, int *); -extern void cancel_cutthrough_connection(const char *); +extern void cancel_cutthrough_connection(BOOL, const uschar *); +extern gstring *cat_file(FILE *, gstring *, uschar *); +extern gstring *cat_file_tls(void *, gstring *, uschar *); extern int check_host(void *, const uschar *, const uschar **, uschar **); extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...); +extern pid_t child_open_exim_function(int *, const uschar *); +extern pid_t child_open_exim2_function(int *, uschar *, uschar *, + const uschar *); +extern pid_t child_open_function(uschar **, uschar **, int, + int *, int *, BOOL, const uschar *); extern pid_t child_open_uid(const uschar **, const uschar **, int, - uid_t *, gid_t *, int *, int *, uschar *, BOOL); + uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *); extern BOOL cleanup_environment(void); +extern void cutthrough_data_puts(uschar *, int); +extern void cutthrough_data_put_nl(void); extern uschar *cutthrough_finaldot(void); extern BOOL cutthrough_flush_send(void); extern BOOL cutthrough_headers_send(void); extern BOOL cutthrough_predata(void); -extern BOOL cutthrough_puts(uschar *, int); -extern BOOL cutthrough_put_nl(void); +extern void release_cutthrough_connection(const uschar *); extern void daemon_go(void); @@ -136,10 +184,13 @@ extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2); extern void debug_print_string(uschar *); extern void debug_print_tree(tree_node *); extern void debug_vprintf(int, const char *, va_list); +extern void debug_print_socket(int); + extern void decode_bits(unsigned int *, size_t, int *, uschar *, bit_table *, int, uschar *, int); +extern void delete_pid_file(void); +extern void deliver_local(address_item *, BOOL); extern address_item *deliver_make_addr(uschar *, BOOL); -extern void deliver_init(void); extern void delivery_log(int, address_item *, int, uschar *); extern int deliver_message(uschar *, BOOL, BOOL); extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2); @@ -148,15 +199,21 @@ extern int deliver_split_address(address_item *); extern void deliver_succeeded(address_item *); extern uschar *deliver_get_sender_address (uschar *id); +extern void delivery_re_exec(int); +extern void die_tainted(const uschar *, const uschar *, int); extern BOOL directory_make(const uschar *, const uschar *, int, BOOL); #ifndef DISABLE_DKIM -extern BOOL dkim_transport_write_message(int, transport_ctx *, - struct ob_dkim *); +extern uschar *dkim_exim_query_dns_txt(const uschar *); +extern void dkim_exim_sign_init(void); + +extern BOOL dkim_transport_write_message(transport_ctx *, + struct ob_dkim *, const uschar ** errstr); #endif extern dns_address *dns_address_from_rr(dns_answer *, dns_record *); extern int dns_basic_lookup(dns_answer *, const uschar *, int); -extern void dns_build_reverse(const uschar *, uschar *); +extern uschar *dns_build_reverse(const uschar *); +extern time_t dns_expire_from_soa(dns_answer *, int); extern void dns_init(BOOL, BOOL, BOOL); extern BOOL dns_is_aa(const dns_answer *); extern BOOL dns_is_secure(const dns_answer *); @@ -174,24 +231,29 @@ extern BOOL enq_start(uschar *, unsigned); extern uschar *event_raise(uschar *, const uschar *, uschar *); extern void msg_event_raise(const uschar *, const address_item *); #endif + +extern int exim_chown_failure(int, const uschar*, uid_t, gid_t); extern const uschar * exim_errstr(int); -extern void exim_exit(int); +extern void exim_exit(int) NORETURN; extern void exim_nullstd(void); extern void exim_setugid(uid_t, gid_t, BOOL, uschar *); -extern int exim_tvcmp(struct timeval *, struct timeval *); +extern void exim_underbar_exit(int) NORETURN; extern void exim_wait_tick(struct timeval *, int); extern int exp_bool(address_item *addr, uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue, uschar *svalue, BOOL *rvalue); extern BOOL expand_check_condition(uschar *, uschar *, uschar *); +extern uschar *expand_file_big_buffer(const uschar *); extern uschar *expand_string(uschar *); /* public, cannot make const */ extern const uschar *expand_cstring(const uschar *); /* ... so use this one */ +extern uschar *expand_getkeyed(const uschar *, const uschar *); + extern uschar *expand_hide_passwords(uschar * ); extern uschar *expand_string_copy(const uschar *); extern int_eximarith_t expand_string_integer(uschar *, BOOL); extern void modify_variable(uschar *, void *); -extern BOOL fd_ready(int, int); +extern BOOL fd_ready(int, time_t); extern int filter_interpret(uschar *, int, address_item **, uschar **); extern BOOL filter_personal(string_item *, BOOL); @@ -199,8 +261,10 @@ extern BOOL filter_runtest(int, uschar *, BOOL, BOOL); extern BOOL filter_system_interpret(address_item **, uschar **); extern uschar * fn_hdrs_added(void); +extern void force_fd(int, int); extern void header_add(int, const char *, ...); +extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...); extern int header_checkname(header_line *, BOOL); extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...); extern int host_address_extract_port(uschar *); @@ -230,17 +294,17 @@ extern uschar *imap_utf7_encode(uschar *, const uschar *, extern void invert_address(uschar *, uschar *); extern int ip_addr(void *, int, const uschar *, int); extern int ip_bind(int, int, uschar *, int); -extern int ip_connect(int, int, const uschar *, int, int, BOOL); +extern int ip_connect(int, int, const uschar *, int, int, const blob *); extern int ip_connectedsocket(int, const uschar *, int, int, - int, host_item *, uschar **); + int, host_item *, uschar **, const blob *); extern int ip_get_address_family(int); extern void ip_keepalive(int, const uschar *, BOOL); -extern int ip_recv(int, uschar *, int, int); +extern int ip_recv(client_conn_ctx *, uschar *, int, time_t); extern int ip_socket(int, int); -extern int ip_tcpsocket(const uschar *, uschar **, int); +extern int ip_tcpsocket(const uschar *, uschar **, int, host_item *); extern int ip_unixsocket(const uschar *, uschar **); -extern int ip_streamsocket(const uschar *, uschar **, int); +extern int ip_streamsocket(const uschar *, uschar **, int, host_item *); extern int ipv6_nmtoa(int *, uschar *); @@ -249,15 +313,19 @@ extern int log_create(uschar *); extern int log_create_as_exim(uschar *); extern void log_close_all(void); -extern macro_item * macro_create(const uschar *, const uschar *, BOOL, BOOL); +extern macro_item * macro_create(const uschar *, const uschar *, BOOL); +extern BOOL macro_read_assignment(uschar *); +extern uschar *macros_expand(int, int *, BOOL *); extern void mainlog_close(void); #ifdef WITH_CONTENT_SCAN extern int malware(const uschar *, int); extern int malware_in_file(uschar *); extern void malware_init(void); +extern gstring * malware_show_supported(gstring *); #endif extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **, unsigned int *, int, int, const uschar **); +extern int match_address_list_basic(const uschar *, const uschar **, int); extern int match_check_list(const uschar **, int, tree_node **, unsigned int **, int(*)(void *, const uschar *, const uschar **, uschar **), void *, int, const uschar *, const uschar **); @@ -282,10 +350,13 @@ extern uschar *moan_check_errorcopy(uschar *); extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *, BOOL, uschar *); extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3); +extern BOOL moan_send_message(uschar *, int, error_block *eblock, + header_line *, FILE *, uschar *); extern void moan_tell_someone(uschar *, address_item *, const uschar *, const char *, ...) PRINTF_FUNCTION(4,5); extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL); extern void moan_write_from(FILE *); +extern void moan_write_references(FILE *, uschar *); extern FILE *modefopen(const uschar *, const char *, mode_t); extern int open_cutthrough_connection( address_item * addr ); @@ -301,17 +372,22 @@ extern uschar *parse_message_id(uschar *, uschar **, uschar **); extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL); extern uschar *parse_date_time(uschar *str, time_t *t); extern int vaguely_random_number(int); -#ifdef SUPPORT_TLS +#ifndef DISABLE_TLS extern int vaguely_random_number_fallback(int); #endif extern BOOL queue_action(uschar *, int, uschar **, int, int); extern void queue_check_only(void); +extern unsigned queue_count(void); +extern unsigned queue_count_cached(void); extern void queue_list(int, uschar **, int); -extern void queue_count(void); +#ifndef DISABLE_QUEUE_RAMP +extern void queue_notify_daemon(const uschar * hostname); +#endif extern void queue_run(uschar *, uschar *, BOOL); extern int random_number(int); +extern const uschar *rc_to_string(int); extern int rda_interpret(redirect_block *, int, uschar *, uschar *, uschar *, uschar *, uschar *, ugid_block *, address_item **, uschar **, error_block **, int *, uschar *); @@ -322,9 +398,7 @@ extern void readconf_driver_init(uschar *, driver_instance **, extern uschar *readconf_find_option(void *); extern void readconf_main(BOOL); extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *); -extern void readconf_options_routers(void); -extern void readconf_options_transports(void); -extern void readconf_print(uschar *, uschar *, BOOL); +extern BOOL readconf_print(uschar *, uschar *, BOOL); extern uschar *readconf_printtime(int); extern uschar *readconf_readname(uschar *, int, uschar *); extern int readconf_readtime(const uschar *, int, BOOL); @@ -332,11 +406,11 @@ extern void readconf_rest(void); extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *); extern void readconf_save_config(const uschar *); extern void read_message_body(BOOL); -extern void receive_bomb_out(uschar *, uschar *); +extern void receive_bomb_out(uschar *, uschar *) NORETURN; extern BOOL receive_check_fs(int); extern BOOL receive_check_set_sender(uschar *); extern BOOL receive_msg(BOOL); -extern int receive_statvfs(BOOL, int *); +extern int_eximarith_t receive_statvfs(BOOL, int *); extern void receive_swallow_smtp(void); #ifdef WITH_CONTENT_SCAN extern int regex(const uschar **); @@ -362,8 +436,8 @@ extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *, uschar **); extern int route_address(address_item *, address_item **, address_item **, address_item **, address_item **, int); -extern int route_check_prefix(const uschar *, const uschar *); -extern int route_check_suffix(const uschar *, const uschar *); +extern int route_check_prefix(const uschar *, const uschar *, unsigned *); +extern int route_check_suffix(const uschar *, const uschar *, unsigned *); extern BOOL route_findgroup(uschar *, gid_t *); extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *); extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *, @@ -371,14 +445,16 @@ extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *, extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *, struct passwd **, uid_t *, uschar **); extern void route_init(void); +extern gstring * route_show_supported(gstring *); extern void route_tidyup(void); -extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int, - int, int *); +extern uschar *search_args(int, uschar *, uschar *, uschar **); +extern uschar *search_find(void *, const uschar *, uschar *, int, + const uschar *, int, int, int *, const uschar *); extern int search_findtype(const uschar *, int); extern int search_findtype_partial(const uschar *, int *, const uschar **, int *, - int *); -extern void *search_open(uschar *, int, int, uid_t *, gid_t *); + int *, const uschar **); +extern void *search_open(const uschar *, int, int, uid_t *, gid_t *); extern void search_tidyup(void); extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2); extern void sha1_end(hctx *, const uschar *, int, uschar *); @@ -389,10 +465,15 @@ extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *, extern void sigalrm_handler(int); extern BOOL smtp_buffered(void); extern void smtp_closedown(uschar *); -extern int smtp_connect(host_item *, int, int, uschar *, int, - transport_instance *); +extern void smtp_command_timeout_exit(void) NORETURN; +extern void smtp_command_sigterm_exit(void) NORETURN; +extern void smtp_data_timeout_exit(void) NORETURN; +extern void smtp_data_sigint_exit(void) NORETURN; +extern void smtp_deliver_init(void); +extern uschar *smtp_cmd_hist(void); +extern int smtp_connect(smtp_connect_args *, const blob *); extern int smtp_sock_connect(host_item *, int, int, uschar *, - transport_instance * tb, int); + transport_instance * tb, int, const blob *); extern int smtp_feof(void); extern int smtp_ferror(void); extern uschar *smtp_get_connection_info(void); @@ -400,27 +481,29 @@ extern BOOL smtp_get_interface(uschar *, int, address_item *, uschar **, uschar *); extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *); extern int smtp_getc(unsigned); +extern uschar *smtp_getbuf(unsigned *); extern void smtp_get_cache(void); extern int smtp_handle_acl_fail(int, int, uschar *, uschar *); extern void smtp_log_no_mail(void); extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL); -extern BOOL smtp_read_response(smtp_inblock *, uschar *, int, int, int); +extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN; +extern BOOL smtp_read_response(void *, uschar *, int, int, int); +extern void *smtp_reset(void *); extern void smtp_respond(uschar *, int, BOOL, uschar *); extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...); +extern void smtp_port_for_connect(host_item *, int); extern void smtp_send_prohibition_message(int, uschar *); extern int smtp_setup_msg(void); extern BOOL smtp_start_session(void); extern int smtp_ungetc(int); extern BOOL smtp_verify_helo(void); -extern int smtp_write_command(smtp_outblock *, BOOL, const char *, ...) PRINTF_FUNCTION(3,4); +extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4); #ifdef WITH_CONTENT_SCAN extern int spam(const uschar **); -extern FILE *spool_mbox(unsigned long *, const uschar *); +extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **); #endif +extern void spool_clear_header_globals(void); extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *); -extern uschar *spool_dname(const uschar *, uschar *); -extern uschar *spool_fname(const uschar *, const uschar *, const uschar *, const uschar *); -extern uschar *spool_sname(const uschar *, uschar *); extern int spool_open_datafile(uschar *); extern int spool_open_temp(uschar *); extern int spool_read_header(uschar *, BOOL, BOOL); @@ -429,27 +512,25 @@ extern int stdin_getc(unsigned); extern int stdin_feof(void); extern int stdin_ferror(void); extern int stdin_ungetc(int); -extern uschar *string_append(uschar *, int *, int *, int, ...); -extern uschar *string_append_listele(uschar *, uschar, const uschar *); -extern uschar *string_append_listele_n(uschar *, uschar, const uschar *, unsigned); + +extern void store_exit(void); +extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT; +extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT; +extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT; +extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT; extern uschar *string_base62(unsigned long int); -extern uschar *string_cat(uschar *, int *, int *, const uschar *); -extern uschar *string_catn(uschar *, int *, int *, const uschar *, int); +extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT; +extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT; extern int string_compare_by_pointer(const void *, const void *); extern uschar *string_copy_dnsdomain(uschar *); extern uschar *string_copy_malloc(const uschar *); -extern uschar *string_copylc(const uschar *); -extern uschar *string_copynlc(uschar *, int); extern uschar *string_dequote(const uschar **); -extern BOOL string_format(uschar *, int, const char *, ...) ALMOST_PRINTF(3,4); extern uschar *string_format_size(int, uschar *); extern int string_interpret_escape(const uschar **); extern int string_is_ip_address(const uschar *, int *); #ifdef SUPPORT_I18N extern BOOL string_is_utf8(const uschar *); #endif -extern uschar *string_nextinlist(const uschar **, int *, uschar *, int); -extern uschar *string_open_failed(int, const char *, ...) PRINTF_FUNCTION(2,3); extern const uschar *string_printing2(const uschar *, BOOL); extern uschar *string_split_message(uschar *); extern uschar *string_unprinting(uschar *); @@ -460,31 +541,62 @@ extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **); extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **); extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **); #endif -extern BOOL string_vformat(uschar *, int, const char *, va_list); + +#define string_format(buf, siz, fmt, ...) \ + string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__) +extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned, + const char *, ...) ALMOST_PRINTF(5,6); + +#define string_vformat(g, flgs, fmt, ap) \ + string_vformat_trc(g, US __FUNCTION__, __LINE__, \ + STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap) +extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned, + unsigned, unsigned, const char *, va_list); + +#define string_open_failed(eno, fmt, ...) \ + string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__) +extern uschar *string_open_failed_trc(int, const uschar *, unsigned, + const char *, ...) PRINTF_FUNCTION(4,5); + +#define string_nextinlist(lp, sp, b, l) \ + string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__) +extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen, + const uschar * func, int line); + extern int strcmpic(const uschar *, const uschar *); extern int strncmpic(const uschar *, const uschar *, int); extern uschar *strstric(uschar *, uschar *, BOOL); +extern int test_harness_fudged_queue_time(int); +extern void tcp_init(void); +#ifdef EXIM_TFO_PROBE +extern void tfo_probe(void); +#endif +extern void tls_modify_variables(tls_support *); extern uschar *tod_stamp(int); -extern void tls_modify_variables(tls_support *); extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *, BOOL *, oicf, void*); extern void transport_init(void); +extern void transport_do_pass_socket(const uschar *, const uschar *, + const uschar *, uschar *, int); extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *, int); extern uschar *transport_rcpt_address(address_item *, BOOL); extern BOOL transport_set_up_command(const uschar ***, uschar *, BOOL, int, address_item *, uschar *, uschar **); extern void transport_update_waiting(host_item *, uschar *); -extern BOOL transport_write_block(int, uschar *, int); +extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL); +extern void transport_write_reset(int); extern BOOL transport_write_string(int, const char *, ...); -extern BOOL transport_headers_send(int, transport_ctx *, - BOOL (*)(int, transport_ctx *, uschar *, int)); -extern BOOL transport_write_message(int, transport_ctx *, int); +extern BOOL transport_headers_send(transport_ctx *, + BOOL (*)(transport_ctx *, uschar *, int)); +extern gstring * transport_show_supported(gstring *); +extern BOOL transport_write_message(transport_ctx *, int); extern void tree_add_duplicate(uschar *, address_item *); extern void tree_add_nonrecipient(uschar *); extern void tree_add_unusable(host_item *); +extern void tree_dup(tree_node **, tree_node *); extern int tree_insertnode(tree_node **, tree_node *); extern tree_node *tree_search(tree_node *, const uschar *); extern void tree_write(tree_node *, FILE *); @@ -505,18 +617,574 @@ extern int verify_check_header_address(uschar **, uschar **, int, int, int, extern int verify_check_headers(uschar **); extern int verify_check_header_names_ascii(uschar **); extern int verify_check_host(uschar **); -extern int verify_check_notblind(void); -extern int verify_check_given_host(uschar **, host_item *); +extern int verify_check_notblind(BOOL); +extern int verify_check_given_host(const uschar **, const host_item *); extern int verify_check_this_host(const uschar **, unsigned int *, const uschar*, const uschar *, const uschar **); extern address_item *verify_checked_sender(uschar *); extern void verify_get_ident(int); +extern void verify_quota(uschar *); +extern int verify_quota_call(const uschar *, int, int, uschar **); extern BOOL verify_sender(int *, uschar **); extern BOOL verify_sender_preliminary(int *, uschar **); extern void version_init(void); +extern BOOL write_chunk(transport_ctx *, uschar *, int); extern ssize_t write_to_fd_buf(int, const uschar *, size_t); + +/******************************************************************************/ +/* Predicate: if an address is in a tainted pool. +By extension, a variable pointing to this address is tainted. +*/ + +static inline BOOL +is_tainted(const void * p) +{ +#if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C) +return FALSE; + +#else +extern BOOL is_tainted_fn(const void *); +return is_tainted_fn(p); +#endif +} + +/******************************************************************************/ +/* String functions */ +static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line) +{ +#if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF) +if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line); +#endif +return US strcat(CS dst, CCS src); +} +static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line) +{ +#if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF) +if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line); +#endif +return US strcpy(CS dst, CCS src); +} +static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line) +{ +#if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF) +if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line); +#endif +return US strncat(CS dst, CCS src, n); +} +static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line) +{ +#if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF) +if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line); +#endif +return US strncpy(CS dst, CCS src, n); +} +/*XXX will likely need unchecked copy also */ + + +/* Advance the string pointer given over any whitespace. +Return the next char as there's enought places using it to be useful. */ + +#define Uskip_whitespace(sp) skip_whitespace(CUSS sp) + +static inline uschar skip_whitespace(const uschar ** sp) +{ while (isspace(**sp)) (*sp)++; return **sp; } + + +/******************************************************************************/ + +#if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY) +/* exim_chown - in some NFSv4 setups *seemes* to be an issue with +chown(, ). + +Probably because the idmapping is broken, misconfigured or set up in +an unusal way. (see Bug 2931). As I'm not sure, if this was a single +case of misconfiguration, or if there are more such broken systems +out, I try to impose as least impact as possible and for now just write +a panic log entry pointing to the bug report. You're encouraged to +contact the developers, if you experience this issue. + +fd the file descriptor (or -1 if not valid) +name the file name for error messages or for file operations, + if fd is < 0 +owner the owner +group the group + +returns 0 on success, -1 on failure */ + +static inline int +exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name) +{ +return fchown(fd, owner, group) + ? exim_chown_failure(fd, name, owner, group) : 0; +} + +static inline int +exim_chown(const uschar *name, uid_t owner, gid_t group) +{ +return chown(CCS name, owner, group) + ? exim_chown_failure(-1, name, owner, group) : 0; +} +#endif /* !MACRO_PREDEF && !COMPILE_UTILITY */ + +/******************************************************************************/ +/* String functions */ + +#if !defined(MACRO_PREDEF) +/************************************************* +* Copy and save string * +*************************************************/ + +/* This function assumes that memcpy() is faster than strcpy(). +The result is explicitly nul-terminated. +*/ + +static inline uschar * +string_copyn_taint_trc(const uschar * s, unsigned len, + BOOL tainted, const char * func, int line) +{ +uschar * ss = store_get_3(len + 1, tainted, func, line); +memcpy(ss, s, len); +ss[len] = '\0'; +return ss; +} + +static inline uschar * +string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line) +{ return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); } + +static inline uschar * +string_copyn_trc(const uschar * s, unsigned len, const char * func, int line) +{ return string_copyn_taint_trc(s, len, is_tainted(s), func, line); } +static inline uschar * +string_copy_trc(const uschar * s, const char * func, int line) +{ return string_copy_taint_trc(s, is_tainted(s), func, line); } + + +/* String-copy functions explicitly setting the taint status */ + +#define string_copyn_taint(s, len, tainted) \ + string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__) +#define string_copy_taint(s, tainted) \ + string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__) + +/* Simple string-copy functions maintaining the taint */ + +#define string_copyn(s, len) \ + string_copyn_taint_trc((s), (len), is_tainted(s), __FUNCTION__, __LINE__) +#define string_copy(s) \ + string_copy_taint_trc((s), is_tainted(s), __FUNCTION__, __LINE__) + + +/************************************************* +* Copy, lowercase and save string * +*************************************************/ + +/* +Argument: string to copy +Returns: copy of string in new store, with letters lowercased +*/ + +static inline uschar * +string_copylc(const uschar *s) +{ +uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s)); +uschar *p = ss; +while (*s != 0) *p++ = tolower(*s++); +*p = 0; +return ss; +} + + + +/************************************************* +* Copy, lowercase, and save string, given length * +*************************************************/ + +/* It is assumed the data contains no zeros. A zero is added +onto the end. + +Arguments: + s string to copy + n number of characters + +Returns: copy of string in new store, with letters lowercased +*/ + +static inline uschar * +string_copynlc(uschar *s, int n) +{ +uschar *ss = store_get(n + 1, is_tainted(s)); +uschar *p = ss; +while (n-- > 0) *p++ = tolower(*s++); +*p = 0; +return ss; +} + + +# ifndef COMPILE_UTILITY +/************************************************* +* Copy and save string in longterm store * +*************************************************/ + +/* This function assumes that memcpy() is faster than strcpy(). + +Argument: string to copy +Returns: copy of string in new store +*/ + +static inline uschar * +string_copy_perm(const uschar *s, BOOL force_taint) +{ +int old_pool = store_pool; +int len = Ustrlen(s) + 1; +uschar *ss; + +store_pool = POOL_PERM; +ss = store_get(len, force_taint || is_tainted(s)); +memcpy(ss, s, len); +store_pool = old_pool; +return ss; +} +# endif + + + +/* sprintf into a buffer, taint-unchecked */ + +static inline void +string_format_nt(uschar * buf, int siz, const char * fmt, ...) +{ +gstring gs = { .size = siz, .ptr = 0, .s = buf }; +va_list ap; +va_start(ap, fmt); +(void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap); +va_end(ap); +} + + + +/******************************************************************************/ +/* Growable-string functions */ + +/* Create a growable-string with some preassigned space */ + +#define string_get_tainted(size, tainted) \ + string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__) + +static inline gstring * +string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line) +{ +gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line); +g->size = size; +g->ptr = 0; +g->s = US(g + 1); +return g; +} + +#define string_get(size) \ + string_get_trc((size), __FUNCTION__, __LINE__) + +static inline gstring * +string_get_trc(unsigned size, const char * func, unsigned line) +{ +return string_get_tainted_trc(size, FALSE, func, line); +} + +/* NUL-terminate the C string in the growable-string, and return it. */ + +static inline uschar * +string_from_gstring(gstring * g) +{ +if (!g) return NULL; +g->s[g->ptr] = '\0'; +return g->s; +} + +static inline unsigned +gstring_length(const gstring * g) +{ +return g ? (unsigned)g->ptr : 0; +} + + +#define gstring_release_unused(g) \ + gstring_release_unused_trc(g, __FUNCTION__, __LINE__) + +static inline void +gstring_release_unused_trc(gstring * g, const char * file, unsigned line) +{ +if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line); +} + + +/* sprintf-append to a growable-string */ + +#define string_fmt_append(g, fmt, ...) \ + string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \ + SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__) + +#define string_fmt_append_f(g, flgs, fmt, ...) \ + string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \ + flgs, fmt, __VA_ARGS__) + +static inline gstring * +string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line, + unsigned flags, const char *format, ...) +{ +va_list ap; +va_start(ap, format); +g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE, + flags, format, ap); +va_end(ap); +return g; +} + + +/* Copy the content of a string to tainted memory */ + +static inline void +gstring_rebuffer(gstring * g) +{ +uschar * s = store_get(g->size, TRUE); +memcpy(s, g->s, g->ptr); +g->s = s; +} + + +/******************************************************************************/ + +#define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__) + +static inline dns_answer * +store_get_dns_answer_trc(const uschar * func, unsigned line) +{ +return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */ +} + +/******************************************************************************/ +/* Routines with knowledge of spool layout */ + +# ifndef COMPILE_UTILITY +static inline void +spool_pname_buf(uschar * buf, int len) +{ +snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name); +} + +static inline uschar * +spool_dname(const uschar * purpose, uschar * subdir) +{ +return string_sprintf("%s/%s/%s/%s", + spool_directory, queue_name, purpose, subdir); +} +# endif + +static inline uschar * +spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir) +{ +return string_sprintf("%s%s%s%s%s", + q, *q ? "/" : "", + purpose, + *subdir ? "/" : "", subdir); +} + +static inline uschar * +spool_sname(const uschar * purpose, uschar * subdir) +{ +return spool_q_sname(purpose, queue_name, subdir); +} + +static inline uschar * +spool_q_fname(const uschar * purpose, const uschar * q, + const uschar * subdir, const uschar * fname, const uschar * suffix) +{ +return string_sprintf("%s/%s/%s/%s/%s%s", + spool_directory, q, purpose, subdir, fname, suffix); +} + +static inline uschar * +spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname, + const uschar * suffix) +{ +#ifdef COMPILE_UTILITY /* version avoiding string-extension */ +int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1 + + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1; +uschar * buf = store_get(len, FALSE); +string_format(buf, len, "%s/%s/%s/%s/%s%s", + spool_directory, queue_name, purpose, subdir, fname, suffix); +return buf; +#else +return spool_q_fname(purpose, queue_name, subdir, fname, suffix); +#endif +} + +static inline void +set_subdir_str(uschar * subdir_str, const uschar * name, + int search_sequence) +{ +subdir_str[0] = split_spool_directory == (search_sequence == 0) + ? name[5] : '\0'; +subdir_str[1] = '\0'; +} + +/******************************************************************************/ +/* Time calculations */ + +static inline void +timesince(struct timeval * diff, const struct timeval * then) +{ +gettimeofday(diff, NULL); +diff->tv_sec -= then->tv_sec; +if ((diff->tv_usec -= then->tv_usec) < 0) + { + diff->tv_sec--; + diff->tv_usec += 1000*1000; + } +} + +static inline uschar * +string_timediff(const struct timeval * diff) +{ +static uschar buf[sizeof("0.000s")]; + +if (diff->tv_sec >= 5 || !LOGGING(millisec)) + return readconf_printtime((int)diff->tv_sec); + +snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000); +return buf; +} + + +static inline uschar * +string_timesince(const struct timeval * then) +{ +struct timeval diff; +timesince(&diff, then); +return string_timediff(&diff); +} + +static inline void +report_time_since(const struct timeval * t0, const uschar * where) +{ +# ifdef MEASURE_TIMING +struct timeval diff; +timesince(&diff, t0); +fprintf(stderr, "%d %s:\t%ld.%06ld\n", + (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec); +# endif +} + + +static inline void +testharness_pause_ms(int millisec) +{ +#ifndef MEASURE_TIMING +if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec); +#endif +} + +/******************************************************************************/ +/* Taint-checked file opens */ + +static inline int +exim_open2(const char *pathname, int flags) +{ +if (!is_tainted(pathname)) return open(pathname, flags); +log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname); +errno = EACCES; +return -1; +} +static inline int +exim_open(const char *pathname, int flags, mode_t mode) +{ +if (!is_tainted(pathname)) return open(pathname, flags, mode); +log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname); +errno = EACCES; +return -1; +} +static inline int +exim_openat(int dirfd, const char *pathname, int flags) +{ +if (!is_tainted(pathname)) return openat(dirfd, pathname, flags); +log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname); +errno = EACCES; +return -1; +} +static inline int +exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode) +{ +if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode); +log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname); +errno = EACCES; +return -1; +} + +static inline FILE * +exim_fopen(const char *pathname, const char *mode) +{ +if (!is_tainted(pathname)) return fopen(pathname, mode); +log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname); +errno = EACCES; +return NULL; +} + +static inline DIR * +exim_opendir(const uschar * name) +{ +if (!is_tainted(name)) return opendir(CCS name); +log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name); +errno = EACCES; +return NULL; +} + +/******************************************************************************/ +# if !defined(COMPILE_UTILITY) +/* Process manipulation */ + +static inline pid_t +exim_fork(const unsigned char * purpose) +{ +pid_t pid; +DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose); +if ((pid = fork()) == 0) + { + process_purpose = purpose; + DEBUG(D_any) debug_printf("postfork: %s\n", purpose); + } +else + { + testharness_pause_ms(100); /* let child work */ + DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid); + } +return pid; +} + + +static inline pid_t +child_open_exim(int * fdptr, const uschar * purpose) +{ return child_open_exim_function(fdptr, purpose); } + +static inline pid_t +child_open_exim2(int * fdptr, uschar * sender, + uschar * sender_auth, const uschar * purpose) +{ return child_open_exim2_function(fdptr, sender, sender_auth, purpose); } + +static inline pid_t +child_open(uschar **argv, uschar **envp, int newumask, int *infdptr, + int *outfdptr, BOOL make_leader, const uschar * purpose) +{ return child_open_function(argv, envp, newumask, infdptr, + outfdptr, make_leader, purpose); +} + +# endif /* !COMPILE_UTILITY */ + +/******************************************************************************/ +#endif /* !MACRO_PREDEF */ + +#endif /* _FUNCTIONS_H_ */ + /* vi: aw */ /* End of functions.h */