X-Git-Url: https://vcs.fsf.org/?p=exim.git;a=blobdiff_plain;f=src%2Fsrc%2Ftls-gnu.c;h=e08381344dd51e3967d5e7bf90b9378e016710a6;hp=e5a5fabccd606b2dc494e8bd5ed4ecfbc6399876;hb=b9c6f63cd56eaf62303792630a1fa5657499e7a6;hpb=06faf21f3a84a3ac4aa4f7b1512087423d8c8541 diff --git a/src/src/tls-gnu.c b/src/src/tls-gnu.c index e5a5fabcc..e08381344 100644 --- a/src/src/tls-gnu.c +++ b/src/src/tls-gnu.c @@ -67,6 +67,12 @@ require current GnuTLS, then we'll drop support for the ancient libraries). #if GNUTLS_VERSION_NUMBER >= 0x030109 # define SUPPORT_CORK #endif +#if GNUTLS_VERSION_NUMBER >= 0x03010a +# define SUPPORT_GNUTLS_SESS_DESC +#endif +#if GNUTLS_VERSION_NUMBER >= 0x030500 +# define SUPPORT_GNUTLS_KEYLOG +#endif #if GNUTLS_VERSION_NUMBER >= 0x030506 && !defined(DISABLE_OCSP) # define SUPPORT_SRV_OCSP_STACK #endif @@ -90,6 +96,9 @@ require current GnuTLS, then we'll drop support for the ancient libraries). # include #endif +#include "tls-cipher-stdname.c" + + /* GnuTLS 2 vs 3 GnuTLS 3 only: @@ -229,7 +238,7 @@ static gnutls_dh_params_t dh_server_params = NULL; static const int ssl_session_timeout = 200; -static const char * const exim_default_gnutls_priority = "NORMAL"; +static const uschar * const exim_default_gnutls_priority = US"NORMAL"; /* Guard library core initialisation */ @@ -247,8 +256,10 @@ static BOOL gnutls_buggy_ocsp = FALSE; /* Set this to control gnutls_global_set_log_level(); values 0 to 9 will setup the library logging; a value less than 0 disables the calls to set up logging -callbacks. Possibly GNuTLS also looks for an environment variable -"GNUTLS_DEBUG_LEVEL". */ +callbacks. GNuTLS also looks for an environment variable - except not for +setuid binaries, making it useless - "GNUTLS_DEBUG_LEVEL". +Allegedly the testscript line "GNUTLS_DEBUG_LEVEL=9 sudo exim ..." would work, +but the env var must be added to /etc/sudoers too. */ #ifndef EXIM_GNUTLS_LIBRARY_LOG_LEVEL # define EXIM_GNUTLS_LIBRARY_LOG_LEVEL -1 #endif @@ -264,11 +275,6 @@ before, for now. */ # define EXIM_SERVER_DH_BITS_PRE2_12 1024 #endif -#define exim_gnutls_err_check(rc, Label) do { \ - if ((rc) != GNUTLS_E_SUCCESS) \ - return tls_error((Label), US gnutls_strerror(rc), host, errstr); \ - } while (0) - #define expand_check_tlsvar(Varname, errstr) \ expand_check(state->Varname, US #Varname, &state->exp_##Varname, errstr) @@ -341,6 +347,19 @@ return host ? FAIL : DEFER; } +static int +tls_error_gnu(const uschar *prefix, int err, const host_item *host, + uschar ** errstr) +{ +return tls_error(prefix, US gnutls_strerror(err), host, errstr); +} + +static int +tls_error_sys(const uschar *prefix, int err, const host_item *host, + uschar ** errstr) +{ +return tls_error(prefix, US strerror(err), host, errstr); +} /************************************************* @@ -353,7 +372,7 @@ Argument: state the current GnuTLS exim state container rc the GnuTLS error code, or 0 if it's a local error when text identifying read or write - text local error text when ec is 0 + text local error text when rc is 0 Returns: nothing */ @@ -365,7 +384,7 @@ const uschar * msg; uschar * errstr; if (rc == GNUTLS_E_FATAL_ALERT_RECEIVED) - msg = string_sprintf("%s: %s", US gnutls_strerror(rc), + msg = string_sprintf("A TLS fatal alert has been received: %s", US gnutls_alert_get_name(gnutls_alert_get(state->session))); else msg = US gnutls_strerror(rc); @@ -475,16 +494,16 @@ tls_channelbinding_b64 = NULL; #ifdef HAVE_GNUTLS_SESSION_CHANNEL_BINDING channel.data = NULL; channel.size = 0; -rc = gnutls_session_channel_binding(state->session, GNUTLS_CB_TLS_UNIQUE, &channel); -if (rc) { - DEBUG(D_tls) debug_printf("Channel binding error: %s\n", gnutls_strerror(rc)); -} else { +if ((rc = gnutls_session_channel_binding(state->session, GNUTLS_CB_TLS_UNIQUE, &channel))) + { DEBUG(D_tls) debug_printf("Channel binding error: %s\n", gnutls_strerror(rc)); } +else + { old_pool = store_pool; store_pool = POOL_PERM; - tls_channelbinding_b64 = b64encode(channel.data, (int)channel.size); + tls_channelbinding_b64 = b64encode(CUS channel.data, (int)channel.size); store_pool = old_pool; DEBUG(D_tls) debug_printf("Have channel bindings cached for possible auth usage.\n"); -} + } #endif /* peercert is set in peer_status() */ @@ -531,13 +550,12 @@ uschar *filename = NULL; size_t sz; uschar *exp_tls_dhparam; BOOL use_file_in_spool = FALSE; -BOOL use_fixed_file = FALSE; host_item *host = NULL; /* dummy for macros */ DEBUG(D_tls) debug_printf("Initialising GnuTLS server params.\n"); -rc = gnutls_dh_params_init(&dh_server_params); -exim_gnutls_err_check(rc, US"gnutls_dh_params_init"); +if ((rc = gnutls_dh_params_init(&dh_server_params))) + return tls_error_gnu(US"gnutls_dh_params_init", rc, host, errstr); m.data = NULL; m.size = 0; @@ -565,15 +583,12 @@ else if (exp_tls_dhparam[0] != '/') m.size = Ustrlen(m.data); } else - { - use_fixed_file = TRUE; filename = exp_tls_dhparam; - } if (m.data) { - rc = gnutls_dh_params_import_pkcs3(dh_server_params, &m, GNUTLS_X509_FMT_PEM); - exim_gnutls_err_check(rc, US"gnutls_dh_params_import_pkcs3"); + if ((rc = gnutls_dh_params_import_pkcs3(dh_server_params, &m, GNUTLS_X509_FMT_PEM))) + return tls_error_gnu(US"gnutls_dh_params_import_pkcs3", rc, host, errstr); DEBUG(D_tls) debug_printf("Loaded fixed standard D-H parameters\n"); return OK; } @@ -581,8 +596,8 @@ if (m.data) #ifdef HAVE_GNUTLS_SEC_PARAM_CONSTANTS /* If you change this constant, also change dh_param_fn_ext so that we can use a different filename and ensure we have sufficient bits. */ -dh_bits = gnutls_sec_param_to_pk_bits(GNUTLS_PK_DH, GNUTLS_SEC_PARAM_NORMAL); -if (!dh_bits) + +if (!(dh_bits = gnutls_sec_param_to_pk_bits(GNUTLS_PK_DH, GNUTLS_SEC_PARAM_NORMAL))) return tls_error(US"gnutls_sec_param_to_pk_bits() failed", NULL, NULL, errstr); DEBUG(D_tls) debug_printf("GnuTLS tells us that for D-H PK, NORMAL is %d bits.\n", @@ -624,7 +639,7 @@ if ((fd = Uopen(filename, O_RDONLY, 0)) >= 0) { saved_errno = errno; (void)close(fd); - return tls_error(US"TLS cache stat failed", US strerror(saved_errno), NULL, errstr); + return tls_error_sys(US"TLS cache stat failed", saved_errno, NULL, errstr); } if (!S_ISREG(statbuf.st_mode)) { @@ -635,28 +650,29 @@ if ((fd = Uopen(filename, O_RDONLY, 0)) >= 0) { saved_errno = errno; (void)close(fd); - return tls_error(US"fdopen(TLS cache stat fd) failed", - US strerror(saved_errno), NULL, errstr); + return tls_error_sys(US"fdopen(TLS cache stat fd) failed", + saved_errno, NULL, errstr); } m.size = statbuf.st_size; if (!(m.data = malloc(m.size))) { fclose(fp); - return tls_error(US"malloc failed", US strerror(errno), NULL, errstr); + return tls_error_sys(US"malloc failed", errno, NULL, errstr); } if (!(sz = fread(m.data, m.size, 1, fp))) { saved_errno = errno; fclose(fp); free(m.data); - return tls_error(US"fread failed", US strerror(saved_errno), NULL, errstr); + return tls_error_sys(US"fread failed", saved_errno, NULL, errstr); } fclose(fp); rc = gnutls_dh_params_import_pkcs3(dh_server_params, &m, GNUTLS_X509_FMT_PEM); free(m.data); - exim_gnutls_err_check(rc, US"gnutls_dh_params_import_pkcs3"); + if (rc) + return tls_error_gnu(US"gnutls_dh_params_import_pkcs3", rc, host, errstr); DEBUG(D_tls) debug_printf("read D-H parameters from file \"%s\"\n", filename); } @@ -690,8 +706,8 @@ if (rc < 0) temp_fn = string_copy(US"%s.XXXXXXX"); if ((fd = mkstemp(CS temp_fn)) < 0) /* modifies temp_fn */ - return tls_error(US"Unable to open temp file", US strerror(errno), NULL, errstr); - (void)fchown(fd, exim_uid, exim_gid); /* Probably not necessary */ + return tls_error_sys(US"Unable to open temp file", errno, NULL, errstr); + (void)exim_chown(temp_fn, exim_uid, exim_gid); /* Probably not necessary */ /* GnuTLS overshoots! * If we ask for 2236, we might get 2237 or more. @@ -712,8 +728,8 @@ if (rc < 0) DEBUG(D_tls) debug_printf("requesting generation of %d bit Diffie-Hellman prime ...\n", dh_bits_gen); - rc = gnutls_dh_params_generate2(dh_server_params, dh_bits_gen); - exim_gnutls_err_check(rc, US"gnutls_dh_params_generate2"); + if ((rc = gnutls_dh_params_generate2(dh_server_params, dh_bits_gen))) + return tls_error_gnu(US"gnutls_dh_params_generate2", rc, host, errstr); /* gnutls_dh_params_export_pkcs3() will tell us the exact size, every time, and I confirmed that a NULL call to get the size first is how the GnuTLS @@ -721,41 +737,41 @@ if (rc < 0) sz = 0; m.data = NULL; - rc = gnutls_dh_params_export_pkcs3(dh_server_params, GNUTLS_X509_FMT_PEM, - m.data, &sz); - if (rc != GNUTLS_E_SHORT_MEMORY_BUFFER) - exim_gnutls_err_check(rc, US"gnutls_dh_params_export_pkcs3(NULL) sizing"); + if ( (rc = gnutls_dh_params_export_pkcs3(dh_server_params, + GNUTLS_X509_FMT_PEM, m.data, &sz)) + && rc != GNUTLS_E_SHORT_MEMORY_BUFFER) + return tls_error_gnu(US"gnutls_dh_params_export_pkcs3(NULL) sizing", + rc, host, errstr); m.size = sz; if (!(m.data = malloc(m.size))) - return tls_error(US"memory allocation failed", US strerror(errno), NULL, errstr); + return tls_error_sys(US"memory allocation failed", errno, NULL, errstr); /* this will return a size 1 less than the allocation size above */ - rc = gnutls_dh_params_export_pkcs3(dh_server_params, GNUTLS_X509_FMT_PEM, - m.data, &sz); - if (rc != GNUTLS_E_SUCCESS) + if ((rc = gnutls_dh_params_export_pkcs3(dh_server_params, GNUTLS_X509_FMT_PEM, + m.data, &sz))) { free(m.data); - exim_gnutls_err_check(rc, US"gnutls_dh_params_export_pkcs3() real"); + return tls_error_gnu(US"gnutls_dh_params_export_pkcs3() real", rc, host, errstr); } m.size = sz; /* shrink by 1, probably */ if ((sz = write_to_fd_buf(fd, m.data, (size_t) m.size)) != m.size) { free(m.data); - return tls_error(US"TLS cache write D-H params failed", - US strerror(errno), NULL, errstr); + return tls_error_sys(US"TLS cache write D-H params failed", + errno, NULL, errstr); } free(m.data); if ((sz = write_to_fd_buf(fd, US"\n", 1)) != 1) - return tls_error(US"TLS cache write D-H params final newline failed", - US strerror(errno), NULL, errstr); + return tls_error_sys(US"TLS cache write D-H params final newline failed", + errno, NULL, errstr); if ((rc = close(fd))) - return tls_error(US"TLS cache write close() failed", US strerror(errno), NULL, errstr); + return tls_error_sys(US"TLS cache write close() failed", errno, NULL, errstr); if (Urename(temp_fn, filename) < 0) - return tls_error(string_sprintf("failed to rename \"%s\" as \"%s\"", - temp_fn, filename), US strerror(errno), NULL, errstr); + return tls_error_sys(string_sprintf("failed to rename \"%s\" as \"%s\"", + temp_fn, filename), errno, NULL, errstr); DEBUG(D_tls) debug_printf("wrote D-H parameters to file \"%s\"\n", filename); } @@ -831,7 +847,7 @@ out: return rc; err: - rc = tls_error(where, US gnutls_strerror(rc), NULL, errstr); + rc = tls_error_gnu(where, rc, NULL, errstr); goto out; } @@ -852,9 +868,9 @@ tls_add_certfile(exim_gnutls_state_st * state, const host_item * host, int rc = gnutls_certificate_set_x509_key_file(state->x509_cred, CS certfile, CS keyfile, GNUTLS_X509_FMT_PEM); if (rc < 0) - return tls_error( + return tls_error_gnu( string_sprintf("cert/key setup: cert=%s key=%s", certfile, keyfile), - US gnutls_strerror(rc), host, errstr); + rc, host, errstr); return -rc; } @@ -913,8 +929,9 @@ if (!host) /* server */ saved_tls_crl = state->exp_tls_crl; } -rc = gnutls_certificate_allocate_credentials(&state->x509_cred); -exim_gnutls_err_check(rc, US"gnutls_certificate_allocate_credentials"); +if ((rc = gnutls_certificate_allocate_credentials(&state->x509_cred))) + return tls_error_gnu(US"gnutls_certificate_allocate_credentials", + rc, host, errstr); #ifdef SUPPORT_SRV_OCSP_STACK gnutls_certificate_set_flags(state->x509_cred, GNUTLS_CERTIFICATE_API_V2); @@ -1011,12 +1028,12 @@ if (state->exp_tls_certificate && *state->exp_tls_certificate) or watch datestamp. */ # ifdef SUPPORT_SRV_OCSP_STACK - rc = gnutls_certificate_set_ocsp_status_request_function2( - state->x509_cred, gnutls_cert_index, - server_ocsp_stapling_cb, ofile); - - exim_gnutls_err_check(rc, - US"gnutls_certificate_set_ocsp_status_request_function2"); + if ((rc = gnutls_certificate_set_ocsp_status_request_function2( + state->x509_cred, gnutls_cert_index, + server_ocsp_stapling_cb, ofile))) + return tls_error_gnu( + US"gnutls_certificate_set_ocsp_status_request_function2", + rc, host, errstr); # else if (cnt++ > 0) { @@ -1136,23 +1153,19 @@ else } if (cert_count < 0) - { - rc = cert_count; - exim_gnutls_err_check(rc, US"setting certificate trust"); - } -DEBUG(D_tls) debug_printf("Added %d certificate authorities.\n", cert_count); + return tls_error_gnu(US"setting certificate trust", cert_count, host, errstr); +DEBUG(D_tls) + debug_printf("Added %d certificate authorities.\n", cert_count); if (state->tls_crl && *state->tls_crl && state->exp_tls_crl && *state->exp_tls_crl) { DEBUG(D_tls) debug_printf("loading CRL file = %s\n", state->exp_tls_crl); - cert_count = gnutls_certificate_set_x509_crl_file(state->x509_cred, - CS state->exp_tls_crl, GNUTLS_X509_FMT_PEM); - if (cert_count < 0) - { - rc = cert_count; - exim_gnutls_err_check(rc, US"gnutls_certificate_set_x509_crl_file"); - } + if ((cert_count = gnutls_certificate_set_x509_crl_file(state->x509_cred, + CS state->exp_tls_crl, GNUTLS_X509_FMT_PEM)) < 0) + return tls_error_gnu(US"gnutls_certificate_set_x509_crl_file", + cert_count, host, errstr); + DEBUG(D_tls) debug_printf("Processed %d CRLs.\n", cert_count); } @@ -1192,17 +1205,15 @@ client-side params. */ if (!state->host) { if (!dh_server_params) - { - rc = init_server_dh(errstr); - if (rc != OK) return rc; - } + if ((rc = init_server_dh(errstr)) != OK) return rc; gnutls_certificate_set_dh_params(state->x509_cred, dh_server_params); } /* Link the credentials to the session. */ -rc = gnutls_credentials_set(state->session, GNUTLS_CRD_CERTIFICATE, state->x509_cred); -exim_gnutls_err_check(rc, US"gnutls_credentials_set"); +if ((rc = gnutls_credentials_set(state->session, + GNUTLS_CRD_CERTIFICATE, state->x509_cred))) + return tls_error_gnu(US"gnutls_credentials_set", rc, host, errstr); return OK; } @@ -1273,12 +1284,11 @@ tls_init( tls_support * tlsp, uschar ** errstr) { -exim_gnutls_state_st *state; +exim_gnutls_state_st * state; int rc; size_t sz; -const char *errpos; -uschar *p; -BOOL want_default_priorities; +const char * errpos; +const uschar * p; if (!exim_gnutls_base_init_done) { @@ -1291,20 +1301,18 @@ if (!exim_gnutls_base_init_done) environment variables are used and so breaks for users calling mailq. To prevent this, we init PKCS11 first, which is the documented approach. */ if (!gnutls_allow_auto_pkcs11) - { - rc = gnutls_pkcs11_init(GNUTLS_PKCS11_FLAG_MANUAL, NULL); - exim_gnutls_err_check(rc, US"gnutls_pkcs11_init"); - } + if ((rc = gnutls_pkcs11_init(GNUTLS_PKCS11_FLAG_MANUAL, NULL))) + return tls_error_gnu(US"gnutls_pkcs11_init", rc, host, errstr); #endif - rc = gnutls_global_init(); - exim_gnutls_err_check(rc, US"gnutls_global_init"); + if ((rc = gnutls_global_init())) + return tls_error_gnu(US"gnutls_global_init", rc, host, errstr); #if EXIM_GNUTLS_LIBRARY_LOG_LEVEL >= 0 DEBUG(D_tls) { gnutls_global_set_log_function(exim_gnutls_logger_cb); - /* arbitrarily chosen level; bump upto 9 for more */ + /* arbitrarily chosen level; bump up to 9 for more */ gnutls_global_set_log_level(EXIM_GNUTLS_LIBRARY_LOG_LEVEL); } #endif @@ -1339,7 +1347,8 @@ else DEBUG(D_tls) debug_printf("initialising GnuTLS server session\n"); rc = gnutls_init(&state->session, GNUTLS_SERVER); } -exim_gnutls_err_check(rc, US"gnutls_init"); +if (rc) + return tls_error_gnu(US"gnutls_init", rc, host, errstr); state->host = host; @@ -1372,9 +1381,9 @@ if (host) DEBUG(D_tls) debug_printf("Setting TLS client SNI to \"%s\"\n", state->tlsp->sni); sz = Ustrlen(state->tlsp->sni); - rc = gnutls_server_name_set(state->session, - GNUTLS_NAME_DNS, state->tlsp->sni, sz); - exim_gnutls_err_check(rc, US"gnutls_server_name_set"); + if ((rc = gnutls_server_name_set(state->session, + GNUTLS_NAME_DNS, state->tlsp->sni, sz))) + return tls_error_gnu(US"gnutls_server_name_set", rc, host, errstr); } } else if (state->tls_sni) @@ -1387,39 +1396,32 @@ and replaces gnutls_require_kx, gnutls_require_mac & gnutls_require_protocols. This was backwards incompatible, but means Exim no longer needs to track all algorithms and provide string forms for them. */ -want_default_priorities = TRUE; - +p = NULL; if (state->tls_require_ciphers && *state->tls_require_ciphers) { if (!expand_check_tlsvar(tls_require_ciphers, errstr)) return DEFER; if (state->exp_tls_require_ciphers && *state->exp_tls_require_ciphers) { - DEBUG(D_tls) debug_printf("GnuTLS session cipher/priority \"%s\"\n", - state->exp_tls_require_ciphers); - - rc = gnutls_priority_init(&state->priority_cache, - CS state->exp_tls_require_ciphers, &errpos); - want_default_priorities = FALSE; p = state->exp_tls_require_ciphers; + DEBUG(D_tls) debug_printf("GnuTLS session cipher/priority \"%s\"\n", p); } } -if (want_default_priorities) +if (!p) { + p = exim_default_gnutls_priority; DEBUG(D_tls) - debug_printf("GnuTLS using default session cipher/priority \"%s\"\n", - exim_default_gnutls_priority); - rc = gnutls_priority_init(&state->priority_cache, - exim_default_gnutls_priority, &errpos); - p = US exim_default_gnutls_priority; + debug_printf("GnuTLS using default session cipher/priority \"%s\"\n", p); } -exim_gnutls_err_check(rc, string_sprintf( - "gnutls_priority_init(%s) failed at offset %ld, \"%.6s..\"", - p, errpos - CS p, errpos)); +if ((rc = gnutls_priority_init(&state->priority_cache, CCS p, &errpos))) + return tls_error_gnu(string_sprintf( + "gnutls_priority_init(%s) failed at offset %ld, \"%.6s..\"", + p, errpos - CS p, errpos), + rc, host, errstr); -rc = gnutls_priority_set(state->session, state->priority_cache); -exim_gnutls_err_check(rc, US"gnutls_priority_set"); +if ((rc = gnutls_priority_set(state->session, state->priority_cache))) + return tls_error_gnu(US"gnutls_priority_set", rc, host, errstr); gnutls_db_set_cache_expiration(state->session, ssl_session_timeout); @@ -1445,6 +1447,25 @@ return OK; * Extract peer information * *************************************************/ +static const uschar * +cipher_stdname_kcm(gnutls_kx_algorithm_t kx, gnutls_cipher_algorithm_t cipher, + gnutls_mac_algorithm_t mac) +{ +uschar cs_id[2]; +gnutls_kx_algorithm_t kx_i; +gnutls_cipher_algorithm_t cipher_i; +gnutls_mac_algorithm_t mac_i; + +for (size_t i = 0; + gnutls_cipher_suite_info(i, cs_id, &kx_i, &cipher_i, &mac_i, NULL); + i++) + if (kx_i == kx && cipher_i == cipher && mac_i == mac) + return cipher_stdname(cs_id[0], cs_id[1]); +return NULL; +} + + + /* Called from both server and client code. Only this is allowed to set state->peerdn and state->have_set_peerdn and we use that to detect double-calls. @@ -1473,7 +1494,6 @@ Returns: OK/DEFER/FAIL static int peer_status(exim_gnutls_state_st *state, uschar ** errstr) { -uschar cipherbuf[256]; const gnutls_datum_t *cert_list; int old_pool, rc; unsigned int cert_list_size = 0; @@ -1496,30 +1516,69 @@ state->peerdn = NULL; cipher = gnutls_cipher_get(state->session); protocol = gnutls_protocol_get_version(state->session); mac = gnutls_mac_get(state->session); -kx = gnutls_kx_get(state->session); - -string_format(cipherbuf, sizeof(cipherbuf), - "%s:%s:%d", - gnutls_protocol_get_name(protocol), - gnutls_cipher_suite_get_name(kx, cipher, mac), - (int) gnutls_cipher_get_key_size(cipher) * 8); - -/* I don't see a way that spaces could occur, in the current GnuTLS -code base, but it was a concern in the old code and perhaps older GnuTLS -releases did return "TLS 1.0"; play it safe, just in case. */ -for (uschar * p = cipherbuf; *p != '\0'; ++p) - if (isspace(*p)) - *p = '-'; +kx = +#ifdef GNUTLS_TLS1_3 + protocol >= GNUTLS_TLS1_3 ? 0 : +#endif + gnutls_kx_get(state->session); + old_pool = store_pool; -store_pool = POOL_PERM; -state->ciphersuite = string_copy(cipherbuf); + { + store_pool = POOL_PERM; + +#ifdef SUPPORT_GNUTLS_SESS_DESC + { + gstring * g = NULL; + uschar * s = US gnutls_session_get_desc(state->session), c; + + /* Nikos M suggests we use this by preference. It returns like: + (TLS1.3)-(ECDHE-SECP256R1)-(RSA-PSS-RSAE-SHA256)-(AES-256-GCM) + + For partial back-compat, put a colon after the TLS version, replace the + )-( grouping with __, replace in-group - with _ and append the :keysize. */ + + /* debug_printf("peer_status: gnutls_session_get_desc %s\n", s); */ + + for (s++; (c = *s) && c != ')'; s++) g = string_catn(g, s, 1); + g = string_catn(g, US":", 1); + if (*s) s++; /* now on _ between groups */ + while ((c = *s)) + { + for (*++s && ++s; (c = *s) && c != ')'; s++) g = string_catn(g, c == '-' ? US"_" : s, 1); + /* now on ) closing group */ + if ((c = *s) && *++s == '-') g = string_catn(g, US"__", 2); + /* now on _ between groups */ + } + g = string_catn(g, US":", 1); + g = string_cat(g, string_sprintf("%d", (int) gnutls_cipher_get_key_size(cipher) * 8)); + state->ciphersuite = string_from_gstring(g); + } +#else + state->ciphersuite = string_sprintf("%s:%s:%d", + gnutls_protocol_get_name(protocol), + gnutls_cipher_suite_get_name(kx, cipher, mac), + (int) gnutls_cipher_get_key_size(cipher) * 8); + + /* I don't see a way that spaces could occur, in the current GnuTLS + code base, but it was a concern in the old code and perhaps older GnuTLS + releases did return "TLS 1.0"; play it safe, just in case. */ + + for (uschar * p = state->ciphersuite; *p; p++) if (isspace(*p)) *p = '-'; +#endif + +/* debug_printf("peer_status: ciphersuite %s\n", state->ciphersuite); */ + + state->tlsp->cipher = state->ciphersuite; + state->tlsp->bits = gnutls_cipher_get_key_size(cipher) * 8; + + state->tlsp->cipher_stdname = cipher_stdname_kcm(kx, cipher, mac); + } store_pool = old_pool; -state->tlsp->cipher = state->ciphersuite; /* tls_peerdn */ cert_list = gnutls_certificate_get_peers(state->session, &cert_list_size); -if (cert_list == NULL || cert_list_size == 0) +if (!cert_list || cert_list_size == 0) { DEBUG(D_tls) debug_printf("TLS: no certificate from peer (%p & %d)\n", cert_list, cert_list_size); @@ -1529,10 +1588,9 @@ if (cert_list == NULL || cert_list_size == 0) return OK; } -ct = gnutls_certificate_type_get(state->session); -if (ct != GNUTLS_CRT_X509) +if ((ct = gnutls_certificate_type_get(state->session)) != GNUTLS_CRT_X509) { - const uschar *ctn = US gnutls_certificate_type_get_name(ct); + const uschar * ctn = US gnutls_certificate_type_get_name(ct); DEBUG(D_tls) debug_printf("TLS: peer cert not X.509 but instead \"%s\"\n", ctn); if (state->verify_requirement >= VERIFY_REQUIRED) @@ -1548,7 +1606,7 @@ if (ct != GNUTLS_CRT_X509) DEBUG(D_tls) debug_printf("TLS: peer cert problem: %s: %s\n", \ (Label), gnutls_strerror(rc)); \ if (state->verify_requirement >= VERIFY_REQUIRED) \ - return tls_error((Label), US gnutls_strerror(rc), state->host, errstr); \ + return tls_error_gnu((Label), rc, state->host, errstr); \ return OK; \ } \ } while (0) @@ -1608,7 +1666,7 @@ if (state->verify_requirement == VERIFY_NONE) DEBUG(D_tls) debug_printf("TLS: checking peer certificate\n"); *errstr = NULL; -if ((rc = peer_status(state, errstr)) != OK) +if ((rc = peer_status(state, errstr)) != OK || !state->peerdn) { verify = GNUTLS_CERT_INVALID; *errstr = US"certificate not supplied"; @@ -1991,6 +2049,46 @@ return 0; #endif +static gstring * +ddump(gnutls_datum_t * d) +{ +gstring * g = string_get((d->size+1) * 2); +uschar * s = d->data; +for (unsigned i = d->size; i > 0; i--, s++) + { + g = string_catn(g, US "0123456789abcdef" + (*s >> 4), 1); + g = string_catn(g, US "0123456789abcdef" + (*s & 0xf), 1); + } +return g; +} + +static void +post_handshake_debug(exim_gnutls_state_st * state) +{ +debug_printf("gnutls_handshake was successful\n"); +#ifdef SUPPORT_GNUTLS_SESS_DESC +debug_printf("%s\n", gnutls_session_get_desc(state->session)); +#endif +#ifdef SUPPORT_GNUTLS_KEYLOG +if (gnutls_protocol_get_version(state->session) < GNUTLS_TLS1_3) + { + gnutls_datum_t c, s; + gstring * gc, * gs; + /* we only want the client random and the master secret */ + gnutls_session_get_random(state->session, &c, &s); + gnutls_session_get_master_secret(state->session, &s); + gc = ddump(&c); + gs = ddump(&s); + debug_printf("CLIENT_RANDOM %.*s %.*s\n", (int)gc->ptr, gc->s, (int)gs->ptr, gs->s); + } +else + debug_printf("To get keying info for TLS1.3 is hard:\n" + " set environment variable SSLKEYLOGFILE to a filename writable by uid exim\n" + " add SSLKEYLOGFILE to keep_environment in the exim config\n" + " run exim as root\n" + " if using sudo, add SSLKEYLOGFILE to env_keep in /etc/sudoers\n"); +#endif +} /* ------------------------------------------------------------------------ */ /* Exported functions */ @@ -2123,7 +2221,7 @@ if (rc != GNUTLS_E_SUCCESS) } else { - tls_error(US"gnutls_handshake", US gnutls_strerror(rc), NULL, errstr); + tls_error_gnu(US"gnutls_handshake", rc, NULL, errstr); (void) gnutls_alert_send_appropriate(state->session, rc); gnutls_deinit(state->session); gnutls_certificate_free_credentials(state->x509_cred); @@ -2138,7 +2236,7 @@ if (rc != GNUTLS_E_SUCCESS) return FAIL; } -DEBUG(D_tls) debug_printf("gnutls_handshake was successful\n"); +DEBUG(D_tls) post_handshake_debug(state); /* Verify after the fact */ @@ -2277,36 +2375,29 @@ return TRUE; /* Called from the smtp transport after STARTTLS has been accepted. Arguments: - fd the fd of the connection - host connected host (for messages and option-tests) - addr the first address (not used) - tb transport (always smtp) - tlsa_dnsa non-NULL, either request or require dane for this host, and - a TLSA record found. Therefore, dane verify required. - Which implies cert must be requested and supplied, dane - verify must pass, and cert verify irrelevant (incl. - hostnames), and (caller handled) require_tls - tlsp record details of channel configuration - errstr error string pointer - -Returns: Pointer to TLS session context, or NULL on error + cctx connection context + conn_args connection details + cookie datum for randomness (not used) + tlsp record details of channel configuration here; must be non-NULL + errstr error string pointer + +Returns: TRUE for success with TLS session context set in smtp context, + FALSE on error */ -void * -tls_client_start(int fd, host_item *host, - address_item *addr ARG_UNUSED, - transport_instance * tb, -#ifdef SUPPORT_DANE - dns_answer * tlsa_dnsa, -#endif - tls_support * tlsp, uschar ** errstr) +BOOL +tls_client_start(client_conn_ctx * cctx, smtp_connect_args * conn_args, + void * cookie ARG_UNUSED, + tls_support * tlsp, uschar ** errstr) { -smtp_transport_options_block *ob = tb +host_item * host = conn_args->host; /* for msgs and option-tests */ +transport_instance * tb = conn_args->tblock; /* always smtp or NULL */ +smtp_transport_options_block * ob = tb ? (smtp_transport_options_block *)tb->options_block : &smtp_transport_option_defaults; int rc; exim_gnutls_state_st * state = NULL; -uschar *cipher_list = NULL; +uschar * cipher_list = NULL; #ifndef DISABLE_OCSP BOOL require_ocsp = @@ -2315,15 +2406,20 @@ BOOL request_ocsp = require_ocsp ? TRUE : verify_check_given_host(CUSS &ob->hosts_request_ocsp, host) == OK; #endif -DEBUG(D_tls) debug_printf("initialising GnuTLS as a client on fd %d\n", fd); +DEBUG(D_tls) debug_printf("initialising GnuTLS as a client on fd %d\n", cctx->sock); #ifdef SUPPORT_DANE -if (tlsa_dnsa && ob->dane_require_tls_ciphers) +/* If dane is flagged, have either request or require dane for this host, and +a TLSA record found. Therefore, dane verify required. Which implies cert must +be requested and supplied, dane verify must pass, and cert verify irrelevant +(incl. hostnames), and (caller handled) require_tls */ + +if (conn_args->dane && ob->dane_require_tls_ciphers) { /* not using expand_check_tlsvar because not yet in state */ if (!expand_check(ob->dane_require_tls_ciphers, US"dane_require_tls_ciphers", &cipher_list, errstr)) - return NULL; + return FALSE; cipher_list = cipher_list && *cipher_list ? ob->dane_require_tls_ciphers : ob->tls_require_ciphers; } @@ -2335,7 +2431,7 @@ if (!cipher_list) if (tls_init(host, ob->tls_certificate, ob->tls_privatekey, ob->tls_sni, ob->tls_verify_certificates, ob->tls_crl, cipher_list, &state, tlsp, errstr) != OK) - return NULL; + return FALSE; { int dh_min_bits = ob->tls_dh_min_bits; @@ -2359,7 +2455,7 @@ set but both tls_verify_hosts and tls_try_verify_hosts are unset. Check only the specified host patterns if one of them is defined */ #ifdef SUPPORT_DANE -if (tlsa_dnsa && dane_tlsa_load(state, tlsa_dnsa)) +if (conn_args->dane && dane_tlsa_load(state, &conn_args->tlsa_dnsa)) { DEBUG(D_tls) debug_printf("TLS: server certificate DANE required.\n"); @@ -2405,8 +2501,8 @@ if (request_ocsp) if ((rc = gnutls_ocsp_status_request_enable_client(state->session, NULL, 0, NULL)) != OK) { - tls_error(US"cert-status-req", US gnutls_strerror(rc), state->host, errstr); - return NULL; + tls_error_gnu(US"cert-status-req", rc, state->host, errstr); + return FALSE; } tlsp->ocsp = OCSP_NOT_RESP; } @@ -2421,9 +2517,9 @@ if (tb && tb->event_action) } #endif -gnutls_transport_set_ptr(state->session, (gnutls_transport_ptr_t)(long) fd); -state->fd_in = fd; -state->fd_out = fd; +gnutls_transport_set_ptr(state->session, (gnutls_transport_ptr_t)(long) cctx->sock); +state->fd_in = cctx->sock; +state->fd_out = cctx->sock; DEBUG(D_tls) debug_printf("about to gnutls_handshake\n"); /* There doesn't seem to be a built-in timeout on connection. */ @@ -2443,18 +2539,18 @@ if (rc != GNUTLS_E_SUCCESS) tls_error(US"gnutls_handshake", US"timed out", state->host, errstr); } else - tls_error(US"gnutls_handshake", US gnutls_strerror(rc), state->host, errstr); - return NULL; + tls_error_gnu(US"gnutls_handshake", rc, state->host, errstr); + return FALSE; } -DEBUG(D_tls) debug_printf("gnutls_handshake was successful\n"); +DEBUG(D_tls) post_handshake_debug(state); /* Verify late */ if (!verify_certificate(state, errstr)) { tls_error(US"certificate verification failed", *errstr, state->host, errstr); - return NULL; + return FALSE; } #ifndef DISABLE_OCSP @@ -2475,14 +2571,14 @@ if (require_ocsp) gnutls_free(printed.data); } else - (void) tls_error(US"ocsp decode", US gnutls_strerror(rc), state->host, errstr); + (void) tls_error_gnu(US"ocsp decode", rc, state->host, errstr); } if (gnutls_ocsp_status_request_is_checked(state->session, 0) == 0) { tlsp->ocsp = OCSP_FAILED; tls_error(US"certificate status check failed", NULL, state->host, errstr); - return NULL; + return FALSE; } DEBUG(D_tls) debug_printf("Passed OCSP checking\n"); tlsp->ocsp = OCSP_VFIED; @@ -2492,13 +2588,14 @@ if (require_ocsp) /* Figure out peer DN, and if authenticated, etc. */ if (peer_status(state, errstr) != OK) - return NULL; + return FALSE; /* Sets various Exim expansion variables; may need to adjust for ACL callouts */ extract_exim_vars_from_tls_state(state); -return state; +cctx->tls_ctx = state; +return TRUE; } @@ -2621,7 +2718,7 @@ else if (inbytes == 0) else if (inbytes < 0) { - DEBUG(D_tls) debug_printf("%s: err from gnutls_record_recv(\n", __FUNCTION__); + DEBUG(D_tls) debug_printf("%s: err from gnutls_record_recv\n", __FUNCTION__); record_io_error(state, (int) inbytes, US"recv", NULL); state->xfer_error = TRUE; return FALSE; @@ -2644,7 +2741,7 @@ Only used by the server-side TLS. This feeds DKIM and should be used for all message-body reads. -Arguments: lim Maximum amount to read/bufffer +Arguments: lim Maximum amount to read/buffer Returns: the next character or EOF */ @@ -2754,7 +2851,7 @@ if (inbytes == 0) } else { - DEBUG(D_tls) debug_printf("%s: err from gnutls_record_recv(\n", __FUNCTION__); + DEBUG(D_tls) debug_printf("%s: err from gnutls_record_recv\n", __FUNCTION__); record_io_error(state, (int)inbytes, US"recv", NULL); }