X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/925ac8e4f1c5d365ddea2f7aee460cd0a3cd409d..7a501c874f028f689c44999ab05bb0d39da46941:/src/src/functions.h diff --git a/src/src/functions.h b/src/src/functions.h index 4be375d77..87953c413 100644 --- a/src/src/functions.h +++ b/src/src/functions.h @@ -2,7 +2,7 @@ * Exim - an Internet mail transport agent * *************************************************/ -/* Copyright (c) University of Cambridge 1995 - 2017 */ +/* Copyright (c) University of Cambridge 1995 - 2018 */ /* See the file NOTICE for conditions of use and distribution. */ @@ -10,11 +10,13 @@ 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_ #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 @@ -44,14 +46,12 @@ 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 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 int tls_export_cert(uschar *, size_t, void *); extern int tls_feof(void); extern int tls_ferror(void); @@ -60,11 +60,11 @@ 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 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, BOOL); +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 @@ -73,7 +73,7 @@ extern BOOL tls_openssl_options_parse(uschar *, long *); 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 @@ -88,6 +88,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 **); @@ -96,15 +106,34 @@ 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 void auth_show_supported(FILE *); 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 EXPERIMENTAL_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 int b64decode(const uschar *, uschar **); extern int bdat_getc(unsigned); extern uschar *bdat_getbuf(unsigned *); extern int bdat_ungetc(int); @@ -157,6 +186,9 @@ extern void delivery_re_exec(int); extern BOOL directory_make(const uschar *, const uschar *, int, BOOL); #ifndef DISABLE_DKIM +extern uschar *dkim_exim_query_dns_txt(uschar *); +extern void dkim_exim_sign_init(void); + extern BOOL dkim_transport_write_message(transport_ctx *, struct ob_dkim *, const uschar ** errstr); #endif @@ -180,16 +212,18 @@ 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, const uschar *); 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_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_hide_passwords(uschar * ); @@ -206,7 +240,10 @@ extern BOOL filter_system_interpret(address_item **, uschar **); extern uschar * fn_hdrs_added(void); +extern void gstring_reset_unused(gstring *); + 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 *); @@ -236,12 +273,12 @@ 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, int); extern int ip_socket(int, int); extern int ip_tcpsocket(const uschar *, uschar **, int); @@ -255,12 +292,15 @@ 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 void malware_show_supported(FILE *); #endif extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **, unsigned int *, int, int, const uschar **); @@ -289,6 +329,8 @@ 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); @@ -319,6 +361,7 @@ extern void queue_count(void); 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 *); @@ -329,9 +372,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); @@ -343,7 +384,7 @@ extern void receive_bomb_out(uschar *, uschar *); 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 **); @@ -378,6 +419,7 @@ 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 void route_show_supported(FILE *); extern void route_tidyup(void); extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int, @@ -396,10 +438,14 @@ 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, uschar *, int, - transport_instance *); +extern void smtp_command_timeout_exit(void); +extern void smtp_command_sigterm_exit(void); +extern void smtp_data_timeout_exit(void); +extern void smtp_data_sigint_exit(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); @@ -412,8 +458,9 @@ 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 void smtp_proxy_tls(uschar *, size_t, int, int); -extern BOOL smtp_read_response(smtp_inblock *, uschar *, int, int, int); +extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int); +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); @@ -422,37 +469,42 @@ 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 *, int, 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 *, uschar **); #endif -extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *); +extern void spool_clear_header_globals(void); 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 BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *); extern int spool_open_datafile(uschar *); extern int spool_open_temp(uschar *); extern int spool_read_header(uschar *, BOOL, BOOL); +extern uschar *spool_sname(const uschar *, uschar *); extern int spool_write_header(uschar *, int, uschar **); 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 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 gstring *string_fmt_append(gstring *, const char *, ...) ALMOST_PRINTF(2,3); extern BOOL string_format(uschar *, int, const char *, ...) ALMOST_PRINTF(3,4); extern uschar *string_format_size(int, uschar *); +extern uschar *string_from_gstring(gstring *); +extern gstring *string_get(unsigned); extern int string_interpret_escape(const uschar **); extern int string_is_ip_address(const uschar *, int *); #ifdef SUPPORT_I18N @@ -462,6 +514,8 @@ 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_timediff(struct timeval *); +extern uschar *string_timesince(struct timeval *); extern uschar *string_unprinting(uschar *); #ifdef SUPPORT_I18N extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **); @@ -470,14 +524,18 @@ 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); +extern gstring *string_vformat(gstring *, BOOL, const char *, va_list); extern int strcmpic(const uschar *, const uschar *); extern int strncmpic(const uschar *, const uschar *, int); extern uschar *strstric(uschar *, uschar *, BOOL); +#ifdef EXIM_TFO_PROBE +extern void tfo_probe(void); +#endif +extern void timesince(struct timeval * diff, struct timeval * then); +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); @@ -494,6 +552,7 @@ 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)); +extern void transport_show_supported(FILE *); extern BOOL transport_write_message(transport_ctx *, int); extern void tree_add_duplicate(uschar *, address_item *); extern void tree_add_nonrecipient(uschar *); @@ -518,8 +577,8 @@ 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 *); @@ -531,6 +590,43 @@ 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); + +#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 */ + +#endif /* _FUNCTIONS_H_ */ + /* vi: aw */ /* End of functions.h */