X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/6a9cf7f890226aa085842cd3d94b13e78ea31637..3f77bd134b64c532748b83c3931df07058268b5e:/src/src/functions.h diff --git a/src/src/functions.h b/src/src/functions.h index c69851962..d811c62a3 100644 --- a/src/src/functions.h +++ b/src/src/functions.h @@ -2,9 +2,10 @@ * Exim - an Internet mail transport agent * *************************************************/ +/* Copyright (c) The Exim Maintainers 2020 - 2023 */ /* Copyright (c) University of Cambridge 1995 - 2018 */ -/* Copyright (c) The Exim Maintainers 2020 */ /* See the file NOTICE for conditions of use and distribution. */ +/* SPDX-License-Identifier: GPL-2.0-or-later */ /* Prototypes for functions that appear in various modules. Gathered together @@ -53,33 +54,41 @@ extern uschar * tls_cert_fprt_sha256(void *); extern void tls_clean_env(void); extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *, void *, tls_support *, uschar **); +extern BOOL tls_client_adjunct_start(host_item *, client_conn_ctx *, + const uschar *, uschar **); extern void tls_client_creds_reload(BOOL); extern void tls_close(void *, int); -extern BOOL tls_could_read(void); +extern BOOL tls_could_getc(void); extern void tls_daemon_init(void); -extern void tls_daemon_tick(void); +extern int tls_daemon_tick(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 uschar *tls_field_from_dn(uschar *, const uschar *); extern void tls_free_cert(void **); extern int tls_getc(unsigned); extern uschar *tls_getbuf(unsigned *); -extern void tls_get_cache(void); +extern void tls_get_cache(unsigned); +extern BOOL tls_hasc(void); extern BOOL tls_import_cert(const uschar *, void **); +extern BOOL tls_is_name_for_cert(const uschar *, void *); +# ifdef USE_OPENSSL +extern BOOL tls_openssl_options_parse(uschar *, long *); +# endif extern int tls_read(void *, uschar *, size_t); extern int tls_server_start(uschar **); +extern void tls_shutdown_wr(void *); extern BOOL tls_smtp_buffered(void); extern int tls_ungetc(int); +#if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT) +extern void tls_watch_discard_event(int); +extern void tls_watch_invalidate(void); +#endif extern int tls_write(void *, const uschar *, size_t, BOOL); extern uschar *tls_validate_require_cipher(void); -extern void tls_version_report(FILE *); -# 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 *); +extern gstring *tls_version_report(gstring *); # ifdef SUPPORT_DANE extern int tlsa_lookup(const host_item *, dns_answer *, BOOL); @@ -91,13 +100,18 @@ extern int tlsa_lookup(const host_item *, dns_answer *, BOOL); /* Everything else... */ extern acl_block *acl_read(uschar *(*)(void), uschar **); -extern int acl_check(int, uschar *, uschar *, uschar **, uschar **); +extern int acl_check(int, const uschar *, uschar *, uschar **, uschar **); +extern uschar *acl_current_verb(void); extern int acl_eval(int, uschar *, uschar **, uschar **); +extern uschar *acl_standalone_setvar(const uschar *, BOOL); extern tree_node *acl_var_create(uschar *); extern void acl_var_write(uschar *, uschar *, void *); #ifdef EXPERIMENTAL_ARC +# ifdef SUPPORT_DMARC +extern gstring *arc_dmarc_hist_append(gstring *); +# endif extern void *arc_ams_setup_sign_bodyhash(void); extern const uschar *arc_header_feed(gstring *, BOOL); extern gstring *arc_sign(const uschar *, gstring *, uschar **); @@ -125,6 +139,7 @@ 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 *authenticator_current_name(void); #ifdef EXPERIMENTAL_ARC extern gstring *authres_arc(gstring *); @@ -141,10 +156,11 @@ 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 uschar *b64encode_taint(const uschar *, int, const void *); +extern int b64decode(const uschar *, uschar **, const void *); extern int bdat_getc(unsigned); extern uschar *bdat_getbuf(unsigned *); +extern BOOL bdat_hasc(void); extern int bdat_ungetc(int); extern void bdat_flush_data(void); @@ -173,34 +189,41 @@ extern BOOL cutthrough_predata(void); extern void release_cutthrough_connection(const uschar *); extern void daemon_go(void); +#ifndef COMPILE_UTILITY +extern ssize_t daemon_client_sockname(struct sockaddr_un *, uschar **); +extern ssize_t daemon_notifier_sockname(struct sockaddr_un *); +#endif #ifdef EXPERIMENTAL_DCC extern int dcc_process(uschar **); #endif -extern void debug_logging_activate(uschar *, uschar *); -extern void debug_logging_stop(void); +extern void debug_logging_activate(const uschar *, const uschar *); +extern void debug_logging_from_spool(const uschar *); +extern void debug_logging_stop(BOOL); extern void debug_print_argv(const uschar **); extern void debug_print_ids(uschar *); extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2); extern void debug_print_string(uschar *); extern void debug_print_tree(const char *, tree_node *); extern void debug_vprintf(int, const char *, va_list); +extern void debug_pretrigger_setup(const uschar *); +extern void debug_pretrigger_discard(void); extern void debug_print_socket(int); +extern void debug_trigger_fire(void); extern void decode_bits(unsigned int *, size_t, int *, - uschar *, bit_table *, int, uschar *, int); + const 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 address_item *deliver_make_addr(const uschar *, BOOL); extern void delivery_log(int, address_item *, int, uschar *); -extern int deliver_message(uschar *, BOOL, BOOL); +extern int deliver_message(const uschar *, BOOL, BOOL); extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2); extern void deliver_set_expansions(address_item *); 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); @@ -230,7 +253,7 @@ extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *); extern void enq_end(uschar *); extern BOOL enq_start(uschar *, unsigned); #ifndef DISABLE_EVENT -extern uschar *event_raise(uschar *, const uschar *, uschar *); +extern uschar *event_raise(uschar *, const uschar *, uschar *, int *); extern void msg_event_raise(const uschar *, const address_item *); #endif @@ -239,7 +262,7 @@ extern const uschar * exim_errstr(int); extern void exim_exit(int) NORETURN; extern void exim_gettime(struct timeval *); extern void exim_nullstd(void); -extern void exim_setugid(uid_t, gid_t, BOOL, uschar *); +extern void exim_setugid(uid_t, gid_t, BOOL, const uschar *); extern void exim_underbar_exit(int) NORETURN; extern void exim_wait_tick(struct timeval *, int); extern int exp_bool(address_item *addr, @@ -248,6 +271,7 @@ extern int exp_bool(address_item *addr, 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_string_2(const uschar *, BOOL *); extern const uschar *expand_cstring(const uschar *); /* ... so use this one */ extern uschar *expand_getkeyed(const uschar *, const uschar *); @@ -258,9 +282,9 @@ extern void modify_variable(uschar *, void *); extern BOOL fd_ready(int, time_t); -extern int filter_interpret(uschar *, int, address_item **, uschar **); +extern int filter_interpret(const uschar *, int, address_item **, uschar **); extern BOOL filter_personal(string_item *, BOOL); -extern BOOL filter_runtest(int, uschar *, BOOL, BOOL); +extern BOOL filter_runtest(int, const uschar *, BOOL, BOOL); extern BOOL filter_system_interpret(address_item **, uschar **); extern uschar * fn_hdrs_added(void); @@ -311,9 +335,8 @@ extern int ip_streamsocket(const uschar *, uschar **, int, host_item *); extern int ipv6_nmtoa(int *, uschar *); -extern uschar *local_part_quote(uschar *); -extern int log_create(uschar *); -extern int log_create_as_exim(uschar *); +extern const uschar *local_part_quote(const uschar *); +extern int log_open_as_exim(const uschar * const); extern void log_close_all(void); extern macro_item * macro_create(const uschar *, const uschar *, BOOL); @@ -321,8 +344,8 @@ 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 int malware(const uschar *, BOOL, int); +extern int malware_in_file(const uschar *); extern void malware_init(void); extern gstring * malware_show_supported(gstring *); #endif @@ -334,8 +357,11 @@ extern int match_check_list(const uschar **, int, tree_node **, unsigned int const uschar *, const uschar **); extern int match_isinlist(const uschar *, const uschar **, int, tree_node **, unsigned int *, int, BOOL, const uschar **); -extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL, +extern int match_check_string(const uschar *, const uschar *, int, mcs_flags, const uschar **); + +extern void message_start(void); +extern void message_tidyup(void); extern void md5_end(md5 *, const uschar *, int, uschar *); extern void md5_mid(md5 *, const uschar *); extern void md5_start(md5 *); @@ -346,14 +372,14 @@ extern int mime_acl_check(uschar *acl, FILE *f, struct mime_boundary_context *, uschar **, uschar **); extern int mime_decode(const uschar **); extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *); -extern int mime_regex(const uschar **); +extern int mime_regex(const uschar **, BOOL); extern void mime_set_anomaly(int); #endif -extern uschar *moan_check_errorcopy(uschar *); +extern uschar *moan_check_errorcopy(const 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, +extern BOOL moan_send_message(const 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); @@ -364,36 +390,39 @@ extern FILE *modefopen(const uschar *, const char *, mode_t); extern int open_cutthrough_connection( address_item * addr ); -extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *, +extern uschar *parse_extract_address(const uschar *, uschar **, int *, int *, int *, BOOL); -extern int parse_forward_list(uschar *, int, address_item **, uschar **, - const uschar *, uschar *, error_block **); -extern uschar *parse_find_address_end(uschar *, BOOL); -extern uschar *parse_find_at(uschar *); +extern int parse_forward_list(const uschar *, int, address_item **, uschar **, + const uschar *, const uschar *, error_block **); +extern uschar *parse_find_address_end(const uschar *, BOOL); +extern const uschar *parse_find_at(const uschar *); extern const uschar *parse_fix_phrase(const uschar *, int); -extern uschar *parse_message_id(uschar *, uschar **, uschar **); -extern const uschar *parse_quote_2047(const uschar *, int, uschar *, BOOL); -extern uschar *parse_date_time(uschar *str, time_t *t); -extern int vaguely_random_number(int); -#ifndef DISABLE_TLS -extern int vaguely_random_number_fallback(int); +extern const uschar *parse_message_id(const uschar *, uschar **, uschar **); +extern const uschar *parse_quote_2047(const uschar *, int, const uschar *, + BOOL); +extern const uschar *parse_date_time(const uschar *str, time_t *t); +extern void priv_drop_temp(const uid_t, const gid_t); +extern void priv_restore(void); +#ifdef SUPPORT_PROXY +extern BOOL proxy_protocol_host(void); +extern void proxy_protocol_setup(void); #endif -extern BOOL queue_action(uschar *, int, uschar **, int, int); +extern BOOL queue_action(const uschar *, int, const 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_list(int, const uschar **, int); #ifndef DISABLE_QUEUE_RAMP extern void queue_notify_daemon(const uschar * hostname); #endif -extern void queue_run(uschar *, uschar *, BOOL); +extern void queue_run(qrunner *, const uschar *, const 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 *); +extern int rda_interpret(redirect_block *, int, const uschar *, const uschar *, + const uschar *, const uschar *, const uschar *, const ugid_block *, address_item **, + uschar **, error_block **, int *, const uschar *); extern int rda_is_filter(const uschar *); extern BOOL readconf_depends(driver_instance *, uschar *); extern void readconf_driver_init(uschar *, driver_instance **, @@ -401,9 +430,9 @@ 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 BOOL readconf_print(uschar *, uschar *, BOOL); +extern BOOL readconf_print(const uschar *, const uschar *, BOOL); extern uschar *readconf_printtime(int); -extern uschar *readconf_readname(uschar *, int, uschar *); +extern const uschar *readconf_readname(uschar *, int, const uschar *); extern int readconf_readtime(const uschar *, int, BOOL); extern void readconf_rest(void); extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *); @@ -411,15 +440,20 @@ extern void readconf_save_config(const uschar *); extern void read_message_body(BOOL); extern void receive_bomb_out(uschar *, uschar *) NORETURN; extern BOOL receive_check_fs(int); -extern BOOL receive_check_set_sender(uschar *); +extern BOOL receive_check_set_sender(const uschar *); extern BOOL receive_msg(BOOL); extern int_eximarith_t receive_statvfs(BOOL, int *); extern void receive_swallow_smtp(void); #ifdef WITH_CONTENT_SCAN -extern int regex(const uschar **); +extern int regex(const uschar **, BOOL); +extern void regex_vars_clear(void); #endif -extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int); -extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL); +extern void regex_at_daemon(const uschar *); +extern BOOL regex_match(const pcre2_code *, const uschar *, int, uschar **); +extern BOOL regex_match_and_setup(const pcre2_code *, const uschar *, int, int); +extern const pcre2_code *regex_compile(const uschar *, mcs_flags, uschar **, + pcre2_compile_context *); +extern const pcre2_code *regex_must_compile(const uschar *, mcs_flags, BOOL); extern void retry_add_item(address_item *, uschar *, int); extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL, uschar **, uschar **); @@ -427,16 +461,16 @@ extern retry_config *retry_find_config(const uschar *, const uschar *, int, int) extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *, dbdata_retry *, time_t); extern void retry_update(address_item **, address_item **, address_item **); -extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int); -extern uschar *rewrite_address_qualify(uschar *, BOOL); +extern const uschar *rewrite_address(const uschar *, BOOL, BOOL, rewrite_rule *, int); +extern const uschar *rewrite_address_qualify(const uschar *, BOOL); extern header_line *rewrite_header(header_line *, const uschar *, const uschar *, rewrite_rule *, int, BOOL); -extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *, +extern const uschar *rewrite_one(const uschar *, int, BOOL *, BOOL, uschar *, rewrite_rule *); -extern void rewrite_test(uschar *); -extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *, - uschar **); +extern void rewrite_test(const uschar *); +extern uschar *rfc2047_decode2(uschar *, BOOL, const 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 *, unsigned *); @@ -450,6 +484,7 @@ extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *, extern void route_init(void); extern gstring * route_show_supported(gstring *); extern void route_tidyup(void); +extern uschar *router_current_name(void); extern uschar *search_args(int, uschar *, uschar *, uschar **, const uschar *); extern uschar *search_find(void *, const uschar *, uschar *, int, @@ -459,14 +494,17 @@ extern int search_findtype_partial(const uschar *, int *, const uschar **, i int *, const uschar **); extern void *search_open(const uschar *, int, int, uid_t *, gid_t *); extern void search_tidyup(void); +extern uschar *sender_helo_verified_boolstr(void); extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2); extern void sha1_end(hctx *, const uschar *, int, uschar *); extern void sha1_mid(hctx *, const uschar *); extern void sha1_start(hctx *); -extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *, - uschar *, address_item **, uschar **); +extern int sieve_interpret(const uschar *, int, const uschar *, + const uschar *, const uschar *, const uschar *, + address_item **, uschar **); extern void sigalrm_handler(int); -extern BOOL smtp_buffered(void); +extern void single_queue_run(qrunner *, const uschar *, const uschar *); +extern int smtp_boundsock(smtp_connect_args *); extern void smtp_closedown(uschar *); extern void smtp_command_timeout_exit(void) NORETURN; extern void smtp_command_sigterm_exit(void) NORETURN; @@ -475,8 +513,6 @@ 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, const blob *); extern int smtp_feof(void); extern int smtp_ferror(void); extern uschar *smtp_get_connection_info(void); @@ -485,11 +521,12 @@ extern BOOL smtp_get_interface(uschar *, int, address_item *, 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 void smtp_get_cache(unsigned); +extern BOOL smtp_hasc(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 void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN; +extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int, const uschar *) NORETURN; extern BOOL smtp_read_response(void *, uschar *, int, int, int); extern void *smtp_reset(void *); extern void smtp_respond(uschar *, int, BOOL, uschar *); @@ -497,6 +534,7 @@ 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 int smtp_sock_connect(smtp_connect_args *, int, const blob *); extern BOOL smtp_start_session(void); extern int smtp_ungetc(int); extern BOOL smtp_verify_helo(void); @@ -506,22 +544,29 @@ extern int spam(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 int spool_open_datafile(uschar *); +extern BOOL spool_move_message(const uschar *, const uschar *, const uschar *, const uschar *); +extern int spool_open_datafile(const uschar *); extern int spool_open_temp(uschar *); extern int spool_read_header(uschar *, BOOL, BOOL); -extern int spool_write_header(uschar *, int, uschar **); +extern uschar *spool_sender_from_msgid(const uschar *); +extern int spool_write_header(const uschar *, int, uschar **); extern int stdin_getc(unsigned); extern int stdin_feof(void); extern int stdin_ferror(void); +extern BOOL stdin_hasc(void); extern int stdin_ungetc(int); +extern void stackdump(void); extern void store_exit(void); +extern void store_init(void); +extern void store_writeprotect(int); + 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_base62_32(unsigned long int); +extern uschar *string_base62_64(unsigned long 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 *); @@ -531,6 +576,7 @@ extern uschar *string_dequote(const uschar **); extern uschar *string_format_size(int, uschar *); extern int string_interpret_escape(const uschar **); extern int string_is_ip_address(const uschar *, int *); +extern int string_is_ip_addressX(const uschar *, int *, const uschar **); #ifdef SUPPORT_I18N extern BOOL string_is_utf8(const uschar *); #endif @@ -569,6 +615,7 @@ extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, usc extern int strcmpic(const uschar *, const uschar *); extern int strncmpic(const uschar *, const uschar *, int); extern uschar *strstric(uschar *, uschar *, BOOL); +extern const uschar *strstric_c(const uschar *, const uschar *, BOOL); extern int test_harness_fudged_queue_time(int); extern void tcp_init(void); @@ -580,25 +627,29 @@ extern uschar *tod_stamp(int); extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *, oicf, void*); -extern void transport_init(void); +extern uschar *transport_current_name(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_init(void); +extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *, int +#ifndef DISABLE_ESMTP_LIMITS + , unsigned, unsigned, unsigned +#endif + ); +extern const uschar *transport_rcpt_address(address_item *, BOOL); +extern BOOL transport_set_up_command(const uschar ***, const uschar *, + unsigned, int, address_item *, const uschar *, uschar **); extern void transport_update_waiting(host_item *, uschar *); 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(transport_ctx *, - BOOL (*)(transport_ctx *, uschar *, int)); + BOOL (*)(transport_ctx *, const 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_add_duplicate(const uschar *, address_item *); +extern void tree_add_nonrecipient(const uschar *); +extern void tree_add_unusable(const 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 *); @@ -609,9 +660,13 @@ extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *) extern void unspool_mbox(void); #endif #ifdef SUPPORT_I18N -extern void utf8_version_report(FILE *); +extern gstring *utf8_version_report(gstring *); #endif +extern int vaguely_random_number(int); +#ifndef DISABLE_TLS +extern int vaguely_random_number_fallback(int); +#endif extern int verify_address(address_item *, FILE *, int, int, int, int, uschar *, uschar *, BOOL *); extern int verify_check_dnsbl(int, const uschar **, uschar **); @@ -624,7 +679,7 @@ 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 address_item *verify_checked_sender(const uschar *); extern void verify_get_ident(int); extern void verify_quota(uschar *); extern int verify_quota_call(const uschar *, int, int, uschar **); @@ -632,8 +687,14 @@ 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 BOOL write_chunk(transport_ctx *, const uschar *, int); extern ssize_t write_to_fd_buf(int, const uschar *, size_t); +extern uschar *wrap_header(const uschar *, unsigned, unsigned, const uschar *, unsigned); + +#ifdef EXPERIMENTAL_XCLIENT +extern uschar * xclient_smtp_command(uschar *, int *, BOOL *); +extern gstring * xclient_smtp_advertise_str(gstring *); +#endif /******************************************************************************/ @@ -653,6 +714,18 @@ return is_tainted_fn(p); #endif } +static inline BOOL +is_incompatible(const void * old, const void * new) +{ +#if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C) +return FALSE; + +#else +extern BOOL is_incompatible_fn(const void *, const void *); +return is_incompatible_fn(old, new); +#endif +} + /******************************************************************************/ /* String functions */ static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line) @@ -687,13 +760,19 @@ return US strncpy(CS dst, CCS src, n); /* Advance the string pointer given over any whitespace. -Return the next char as there's enought places using it to be useful. */ +Return the next char as there's enough 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; } +/* Ditto, non-whitespace */ + +#define Uskip_nonwhite(sp) skip_nonwhite(CUSS sp) +static inline uschar skip_nonwhite(const uschar ** sp) +{ while (**sp && !isspace(**sp)) (*sp)++; return **sp; } + /******************************************************************************/ @@ -745,32 +824,35 @@ 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) + const void * proto_mem, const char * func, int line) { -uschar * ss = store_get_3(len + 1, tainted, func, line); +uschar * ss; +unsigned slen = Ustrlen(s); +if (len > slen) len = slen; +ss = store_get_3(len + 1, proto_mem, 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); } +string_copy_taint_trc(const uschar * s, const void * proto_mem, const char * func, int line) +{ return string_copyn_taint_trc(s, Ustrlen(s), proto_mem, 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); } +{ return string_copyn_taint_trc(s, len, 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); } +{ return string_copy_taint_trc(s, 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__) +#define string_copyn_taint(s, len, proto_mem) \ + string_copyn_taint_trc((s), (len), (proto_mem), __FUNCTION__, __LINE__) +#define string_copy_taint(s, proto_mem) \ + string_copy_taint_trc((s), (proto_mem), __FUNCTION__, __LINE__) /* Simple string-copy functions maintaining the taint */ @@ -790,11 +872,11 @@ Returns: copy of string in new store, with letters lowercased */ static inline uschar * -string_copylc(const uschar *s) +string_copylc(const uschar * s) { -uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s)); -uschar *p = ss; -while (*s != 0) *p++ = tolower(*s++); +uschar * ss = store_get(Ustrlen(s) + 1, s); +uschar * p = ss; +while (*s) *p++ = tolower(*s++); *p = 0; return ss; } @@ -816,10 +898,10 @@ Returns: copy of string in new store, with letters lowercased */ static inline uschar * -string_copynlc(uschar *s, int n) +string_copynlc(uschar * s, int n) { -uschar *ss = store_get(n + 1, is_tainted(s)); -uschar *p = ss; +uschar * ss = store_get(n + 1, s); +uschar * p = ss; while (n-- > 0) *p++ = tolower(*s++); *p = 0; return ss; @@ -845,7 +927,7 @@ int len = Ustrlen(s) + 1; uschar *ss; store_pool = POOL_PERM; -ss = store_get(len, force_taint || is_tainted(s)); +ss = store_get(len, force_taint ? GET_TAINTED : s); memcpy(ss, s, len); store_pool = old_pool; return ss; @@ -873,14 +955,14 @@ va_end(ap); /* Create a growable-string with some preassigned space */ -#define string_get_tainted(size, tainted) \ - string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__) +#define string_get_tainted(size, proto_mem) \ + string_get_tainted_trc((size), (proto_mem), __FUNCTION__, __LINE__) static inline gstring * -string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line) +string_get_tainted_trc(unsigned size, const void * proto_mem, const char * func, unsigned line) { -gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line); -g->size = size; +gstring * g = store_get_3(sizeof(gstring) + size, proto_mem, func, line); +g->size = size; /*XXX would be good if we could see the actual alloc size */ g->ptr = 0; g->s = US(g + 1); return g; @@ -892,7 +974,7 @@ return g; static inline gstring * string_get_trc(unsigned size, const char * func, unsigned line) { -return string_get_tainted_trc(size, FALSE, func, line); +return string_get_tainted_trc(size, GET_UNTAINTED, func, line); } /* NUL-terminate the C string in the growable-string, and return it. */ @@ -905,12 +987,58 @@ g->s[g->ptr] = '\0'; return g->s; } +static inline int +len_string_from_gstring(gstring * g, uschar ** sp) +{ +if (g) + { + *sp = g->s; + g->s[g->ptr] = '\0'; + return g->ptr; + } +else + { + *sp = NULL; + return 0; + } +} + +static inline uschar * +string_copy_from_gstring(gstring * g) +{ +return g ? string_copyn(g->s, g->ptr) : NULL; +} + static inline unsigned gstring_length(const gstring * g) { return g ? (unsigned)g->ptr : 0; } +static inline uschar +gstring_last_char(gstring * g) +{ +return g->s[g->ptr-1]; +} + +static inline void +gstring_trim(gstring * g, unsigned amount) +{ +g->ptr -= amount; +} + +static inline void +gstring_trim_trailing(gstring * g, uschar c) +{ +if (gstring_last_char(g) == c) gstring_trim(g, 1); +} + +static inline void +gstring_reset(gstring * g) +{ +g->ptr = 0; +} + #define gstring_release_unused(g) \ gstring_release_unused_trc(g, __FUNCTION__, __LINE__) @@ -945,31 +1073,68 @@ return g; } -/* Copy the content of a string to tainted memory */ +/* Copy the content of a string to tainted memory. The proto_mem arg +will always be tainted, and suitable as a prototype. */ static inline void -gstring_rebuffer(gstring * g) +gstring_rebuffer(gstring * g, const void * proto_mem) { -uschar * s = store_get(g->size, TRUE); +uschar * s = store_get_3(g->size, proto_mem, __FUNCTION__, __LINE__); memcpy(s, g->s, g->ptr); g->s = s; } +/* Append one gstring to another */ +static inline gstring * +gstring_append(gstring * dest, gstring * item) +{ +return string_catn(dest, item->s, item->ptr); +} + +# ifndef COMPILE_UTILITY /******************************************************************************/ +/* Use store_malloc for DNSA structs, and explicit frees. Using the same pool +for them as the strings we proceed to copy from them meant they could not be +released, hence blowing 64k for every DNS lookup. That mounted up. With malloc +we do have to take care over marking tainted all copied strings. A separate pool +could be used and would handle that implicitly. */ #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 */ +return store_malloc_3(sizeof(dns_answer), CCS func, line); +} + +#define store_free_dns_answer(dnsa) store_free_dns_answer_trc(dnsa, CUS __FUNCTION__, __LINE__) + +static inline void +store_free_dns_answer_trc(dns_answer * dnsa, const uschar * func, unsigned line) +{ +store_free_3(dnsa, CCS func, line); +} + + +/* Check for an RR being large enough. Return TRUE iff bad. */ +static inline BOOL +rr_bad_size(const dns_record * rr, size_t minbytes) +{ +return rr->size < minbytes; +} + +/* Check for an RR having further data beyond a given pointer. +Return TRUE iff bad. */ +static inline BOOL +rr_bad_increment(const dns_record * rr, const uschar * ptr, size_t minbytes) +{ +return rr_bad_size(rr, ptr - rr->data + minbytes); } /******************************************************************************/ /* Routines with knowledge of spool layout */ -# ifndef COMPILE_UTILITY static inline void spool_pname_buf(uschar * buf, int len) { @@ -985,7 +1150,7 @@ return string_sprintf("%s/%s/%s/%s", # endif static inline uschar * -spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir) +spool_q_sname(const uschar * purpose, const uschar * q, const uschar * subdir) { return string_sprintf("%s%s%s%s%s", q, *q ? "/" : "", @@ -994,7 +1159,7 @@ return string_sprintf("%s%s%s%s%s", } static inline uschar * -spool_sname(const uschar * purpose, uschar * subdir) +spool_sname(const uschar * purpose, const uschar * subdir) { return spool_q_sname(purpose, queue_name, subdir); } @@ -1014,7 +1179,7 @@ spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname, #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); +uschar * buf = store_get(len, GET_UNTAINTED); string_format(buf, len, "%s/%s/%s/%s/%s%s", spool_directory, queue_name, purpose, subdir, fname, suffix); return buf; @@ -1028,25 +1193,54 @@ set_subdir_str(uschar * subdir_str, const uschar * name, int search_sequence) { subdir_str[0] = split_spool_directory == (search_sequence == 0) - ? name[5] : '\0'; + ? name[MESSAGE_ID_TIME_LEN-1] : '\0'; subdir_str[1] = '\0'; } +/******************************************************************************/ +/* Message-ID format transition knowlege */ + +static inline BOOL +is_new_message_id(const uschar * id) +{ +return id[MESSAGE_ID_TIME_LEN + 1 + MESSAGE_ID_PID_LEN] == '-'; +} + +static inline BOOL +is_old_message_id(const uschar * id) +{ +return id[MESSAGE_ID_TIME_LEN + 1 + MESSAGE_ID_PID_LEN_OLD] == '-'; +} + +static inline unsigned +spool_data_start_offset(const uschar * id) +{ +if (is_old_message_id(id)) return SPOOL_DATA_START_OFFSET_OLD; +return SPOOL_DATA_START_OFFSET; +} + /******************************************************************************/ /* Time calculations */ +/* Diff two times (later, earlier) returning diff in 1st arg */ static inline void -timesince(struct timeval * diff, const struct timeval * then) +timediff(struct timeval * later, const struct timeval * earlier) { -gettimeofday(diff, NULL); -diff->tv_sec -= then->tv_sec; -if ((diff->tv_usec -= then->tv_usec) < 0) +later->tv_sec -= earlier->tv_sec; +if ((later->tv_usec -= earlier->tv_usec) < 0) { - diff->tv_sec--; - diff->tv_usec += 1000*1000; + later->tv_sec--; + later->tv_usec += 1000*1000; } } +static inline void +timesince(struct timeval * diff, const struct timeval * then) +{ +gettimeofday(diff, NULL); +timediff(diff, then); +} + static inline uschar * string_timediff(const struct timeval * diff) { @@ -1155,6 +1349,7 @@ pid_t pid; DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose); if ((pid = fork()) == 0) { + f.daemon_listen = FALSE; process_purpose = purpose; DEBUG(D_any) debug_printf("postfork: %s\n", purpose); } @@ -1183,6 +1378,79 @@ child_open(uschar **argv, uschar **envp, int newumask, int *infdptr, outfdptr, make_leader, purpose); } +/* Return 1 if fd is usable per pollbits, else 0 */ +static inline int +poll_one_fd(int fd, short pollbits, int tmo_millisec) +{ +struct pollfd p = {.fd = fd, .events = pollbits}; +return poll(&p, 1, tmo_millisec); +} + +/******************************************************************************/ +/* Client-side smtp log string, for debug */ + +static inline void +smtp_debug_cmd(const uschar * buf, int mode) +{ +HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP%c> %s\n", + mode == SCMD_BUFFER ? '|' : mode == SCMD_MORE ? '+' : '>', buf); + +# ifndef DISABLE_CLIENT_CMD_LOG + { + int len = Ustrcspn(buf, " \n"); + int old_pool = store_pool; + store_pool = POOL_PERM; /* Main pool ACL allocations eg. callouts get released */ + client_cmd_log = string_append_listele_n(client_cmd_log, ':', buf, MIN(len, 8)); + if (mode == SCMD_BUFFER) + { + client_cmd_log = string_catn(client_cmd_log, US"|", 1); + (void) string_from_gstring(client_cmd_log); + } + else if (mode == SCMD_MORE) + { + client_cmd_log = string_catn(client_cmd_log, US"+", 1); + (void) string_from_gstring(client_cmd_log); + } + store_pool = old_pool; + } +# endif +} + + +static inline void +smtp_debug_cmd_report(void) +{ +# ifndef DISABLE_CLIENT_CMD_LOG +debug_printf("cmdlog: '%s'\n", client_cmd_log ? client_cmd_log->s : US"(unset)"); +# endif +} + + + +static inline int +expand_max_rcpt(const uschar * str_max_rcpt) +{ +const uschar * s = expand_cstring(str_max_rcpt); +int res; +return !s || !*s || (res = Uatoi(s)) == 0 ? UNLIMITED_ADDRS : res; +} + +/******************************************************************************/ +/* Queue-runner operations */ + +static inline BOOL +is_onetime_qrun(void) +{ +return qrunners && !qrunners->next && qrunners->interval == 0; +} + +static inline BOOL +is_multiple_qrun(void) +{ +return qrunners && (qrunners->interval > 0 || qrunners->next); +} + + # endif /* !COMPILE_UTILITY */ /******************************************************************************/ @@ -1190,6 +1458,6 @@ child_open(uschar **argv, uschar **envp, int newumask, int *infdptr, #endif /* _FUNCTIONS_H_ */ -/* vi: aw +/* vi: aw ai sw=2 */ /* End of functions.h */