1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2023 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* Copyright (c) Phil Pennock 2012 */
8 /* See the file NOTICE for conditions of use and distribution. */
9 /* SPDX-License-Identifier: GPL-2.0-or-later */
11 /* This file provides TLS/SSL support for Exim using the GnuTLS library,
12 one of the available supported implementations. This file is #included into
13 tls.c when USE_GNUTLS has been set.
15 The code herein is a revamp of GnuTLS integration using the current APIs; the
16 original tls-gnu.c was based on a patch which was contributed by Nikos
17 Mavrogiannopoulos. The revamp is partially a rewrite, partially cut&paste as
20 APIs current as of GnuTLS 2.12.18; note that the GnuTLS manual is for GnuTLS 3,
21 which is not widely deployed by OS vendors. Will note issues below, which may
22 assist in updating the code in the future. Another sources of hints is
23 mod_gnutls for Apache (SNI callback registration and handling).
25 Keeping client and server variables more split than before and is currently
26 the norm, in anticipation of TLS in ACL callouts.
28 I wanted to switch to gnutls_certificate_set_verify_function() so that
29 certificate rejection could happen during handshake where it belongs, rather
30 than being dropped afterwards, but that was introduced in 2.10.0 and Debian
31 (6.0.5) is still on 2.8.6. So for now we have to stick with sub-par behaviour.
33 (I wasn't looking for libraries quite that old, when updating to get rid of
34 compiler warnings of deprecated APIs. If it turns out that a lot of the rest
35 require current GnuTLS, then we'll drop support for the ancient libraries).
38 #include <gnutls/gnutls.h>
39 /* needed for cert checks in verification and DN extraction: */
40 #include <gnutls/x509.h>
41 /* man-page is incorrect, gnutls_rnd() is not in gnutls.h: */
42 #include <gnutls/crypto.h>
44 /* needed to disable PKCS11 autoload unless requested */
45 #if GNUTLS_VERSION_NUMBER >= 0x020c00
46 # include <gnutls/pkcs11.h>
47 # define SUPPORT_PARAM_TO_PK_BITS
49 #if GNUTLS_VERSION_NUMBER < 0x030103 && !defined(DISABLE_OCSP)
50 # warning "GnuTLS library version too old; define DISABLE_OCSP in Makefile"
53 #if GNUTLS_VERSION_NUMBER < 0x020a00 && !defined(DISABLE_EVENT)
54 # warning "GnuTLS library version too old; tls:cert event unsupported"
55 # define DISABLE_EVENT
57 #if GNUTLS_VERSION_NUMBER >= 0x030000
58 # define SUPPORT_SELFSIGN /* Uncertain what version is first usable but 2.12.23 is not */
60 #if GNUTLS_VERSION_NUMBER >= 0x030306
61 # define SUPPORT_CA_DIR
63 # undef SUPPORT_CA_DIR
65 #if GNUTLS_VERSION_NUMBER >= 0x030014
66 # define SUPPORT_SYSDEFAULT_CABUNDLE
68 #if GNUTLS_VERSION_NUMBER >= 0x030104
69 # define GNUTLS_CERT_VFY_STATUS_PRINT
71 #if GNUTLS_VERSION_NUMBER >= 0x030109
74 #if GNUTLS_VERSION_NUMBER >= 0x03010a
75 # define SUPPORT_GNUTLS_SESS_DESC
77 #if GNUTLS_VERSION_NUMBER >= 0x030300
78 # define GNUTLS_AUTO_GLOBAL_INIT
79 # define GNUTLS_AUTO_PKCS11_MANUAL
81 #if (GNUTLS_VERSION_NUMBER >= 0x030404) \
82 || (GNUTLS_VERSION_NUMBER >= 0x030311) && (GNUTLS_VERSION_NUMBER & 0xffff00 == 0x030300)
84 # define EXIM_HAVE_OCSP
87 #if GNUTLS_VERSION_NUMBER >= 0x030500
88 # define SUPPORT_GNUTLS_KEYLOG
90 #if GNUTLS_VERSION_NUMBER >= 0x030506 && !defined(DISABLE_OCSP)
91 # define SUPPORT_SRV_OCSP_STACK
93 #if GNUTLS_VERSION_NUMBER >= 0x030603
94 # define EXIM_HAVE_TLS1_3
95 # define SUPPORT_GNUTLS_EXT_RAW_PARSE
96 # define GNUTLS_OCSP_STATUS_REQUEST_GET2
100 # if GNUTLS_VERSION_NUMBER >= 0x030000
101 # define DANESSL_USAGE_DANE_TA 2
102 # define DANESSL_USAGE_DANE_EE 3
104 # error GnuTLS version too early for DANE
106 # if GNUTLS_VERSION_NUMBER < 0x999999
107 # define GNUTLS_BROKEN_DANE_VALIDATION
111 #ifndef DISABLE_TLS_RESUME
112 # if GNUTLS_VERSION_NUMBER >= 0x030603
113 # define EXIM_HAVE_TLS_RESUME
115 # warning "GnuTLS library version too old; resumption unsupported"
119 #if GNUTLS_VERSION_NUMBER >= 0x030200
120 # ifdef SUPPORT_GNUTLS_EXT_RAW_PARSE
121 # define EXIM_HAVE_ALPN
125 #if GNUTLS_VERSION_NUMBER >= 0x030702
126 # define HAVE_GNUTLS_EXPORTER
130 # include <gnutls/ocsp.h>
133 # include <gnutls/dane.h>
136 #include "tls-cipher-stdname.c"
143 # ifndef DISABLE_TLS_RESUME
144 builtin_macro_create_var(US"_RESUME_DECODE", RESUME_DECODE_STRING );
146 # ifdef EXIM_HAVE_TLS1_3
147 builtin_macro_create(US"_HAVE_TLS1_3");
149 # ifdef EXIM_HAVE_OCSP
150 builtin_macro_create(US"_HAVE_TLS_OCSP");
152 # ifdef SUPPORT_SRV_OCSP_STACK
153 builtin_macro_create(US"_HAVE_TLS_OCSP_LIST");
155 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
156 builtin_macro_create(US"_HAVE_TLS_CA_CACHE");
158 # ifdef EXIM_HAVE_ALPN
159 builtin_macro_create(US"_HAVE_TLS_ALPN");
168 gnutls_global_set_audit_log_function()
171 gnutls_certificate_verify_peers2(): is new, drop the 2 for old version
174 /* Local static variables for GnuTLS */
176 /* Values for verify_requirement */
178 enum peer_verify_requirement
179 { VERIFY_NONE, VERIFY_OPTIONAL, VERIFY_REQUIRED, VERIFY_DANE };
181 /* This holds most state for server or client; with this, we can set up an
182 outbound TLS-enabled connection in an ACL callout, while not stomping all
183 over the TLS variables available for expansion.
185 Some of these correspond to variables in globals.c; those variables will
186 be set to point to content in one of these instances, as appropriate for
187 the stage of the process lifetime.
189 Not handled here: global tlsp->tls_channelbinding.
192 typedef struct exim_gnutls_state {
193 gnutls_session_t session;
195 exim_tlslib_state lib_state;
196 #define x509_cred libdata0
197 #define pri_cache libdata1
199 enum peer_verify_requirement verify_requirement;
203 BOOL peer_cert_verified:1;
204 BOOL peer_dane_verified:1;
205 BOOL trigger_sni_changes:1;
206 BOOL have_set_peerdn:1;
207 BOOL xfer_eof:1; /*XXX never gets set! */
213 const struct host_item *host; /* NULL if server */
214 gnutls_x509_crt_t peercert;
217 uschar *received_sni;
219 const uschar *tls_certificate;
220 const uschar *tls_privatekey;
221 const uschar *tls_sni; /* client send only, not received */
222 const uschar *tls_verify_certificates;
223 const uschar *tls_crl;
224 const uschar *tls_require_ciphers;
226 uschar *exp_tls_certificate;
227 uschar *exp_tls_privatekey;
228 uschar *exp_tls_verify_certificates;
230 uschar *exp_tls_require_ciphers;
231 const uschar *exp_tls_verify_cert_hostnames;
232 #ifndef DISABLE_EVENT
233 uschar *event_action;
236 char * const * dane_data;
237 const int * dane_data_len;
240 tls_support *tlsp; /* set in tls_init() */
245 } exim_gnutls_state_st;
247 static const exim_gnutls_state_st exim_gnutls_state_init = {
248 /* all elements not explicitly intialised here get 0/NULL/FALSE */
253 /* Not only do we have our own APIs which don't pass around state, assuming
254 it's held in globals, GnuTLS doesn't appear to let us register callback data
255 for callbacks, or as part of the session, so we have to keep a "this is the
256 context we're currently dealing with" pointer and rely upon being
257 single-threaded to keep from processing data on an inbound TLS connection while
258 talking to another TLS connection for an outbound check. This does mean that
259 there's no way for heart-beats to be responded to, for the duration of the
261 XXX But see gnutls_session_get_ptr()
264 static exim_gnutls_state_st state_server = {
265 /* all elements not explicitly intialised here get 0/NULL/FALSE */
270 /* dh_params are initialised once within the lifetime of a process using TLS;
271 if we used TLS in a long-lived daemon, we'd have to reconsider this. But we
272 don't want to repeat this. */
274 static gnutls_dh_params_t dh_server_params = NULL;
276 static int ssl_session_timeout = 7200; /* Two hours */
278 static const uschar * const exim_default_gnutls_priority = US"NORMAL";
280 /* Guard library core initialisation */
282 static BOOL exim_gnutls_base_init_done = FALSE;
285 static BOOL gnutls_buggy_ocsp = FALSE;
286 static BOOL exim_testharness_disable_ocsp_validity_check = FALSE;
289 #ifdef EXIM_HAVE_ALPN
290 static int server_seen_alpn = -1; /* count of names */
292 #ifdef EXIM_HAVE_TLS_RESUME
293 static gnutls_datum_t server_sessticket_key;
297 /* ------------------------------------------------------------------------ */
300 #define MAX_HOST_LEN 255
302 /* Set this to control gnutls_global_set_log_level(); values 0 to 9 will setup
303 the library logging; a value less than 0 disables the calls to set up logging
304 callbacks. GNuTLS also looks for an environment variable - except not for
305 setuid binaries, making it useless - "GNUTLS_DEBUG_LEVEL".
306 Allegedly the testscript line "GNUTLS_DEBUG_LEVEL=9 sudo exim ..." would work,
307 but the env var must be added to /etc/sudoers too. */
308 #ifndef EXIM_GNUTLS_LIBRARY_LOG_LEVEL
309 # define EXIM_GNUTLS_LIBRARY_LOG_LEVEL -1
312 #ifndef EXIM_CLIENT_DH_MIN_BITS
313 # define EXIM_CLIENT_DH_MIN_BITS 1024
316 /* With GnuTLS 2.12.x+ we have gnutls_sec_param_to_pk_bits() with which we
317 can ask for a bit-strength. Without that, we stick to the constant we had
319 #ifndef EXIM_SERVER_DH_BITS_PRE2_12
320 # define EXIM_SERVER_DH_BITS_PRE2_12 1024
323 #define Expand_check_tlsvar(Varname, errstr) \
324 expand_check(state->Varname, US #Varname, &state->exp_##Varname, errstr)
326 #if GNUTLS_VERSION_NUMBER >= 0x020c00
327 # define HAVE_GNUTLS_SESSION_CHANNEL_BINDING
328 # define HAVE_GNUTLS_SEC_PARAM_CONSTANTS
329 # define HAVE_GNUTLS_RND
330 /* The security fix we provide with the gnutls_allow_auto_pkcs11 option
331 * (4.82 PP/09) introduces a compatibility regression. The symbol simply
332 * isn't available sometimes, so this needs to become a conditional
333 * compilation; the sanest way to deal with this being a problem on
334 * older OSes is to block it in the Local/Makefile with this compiler
336 # ifndef AVOID_GNUTLS_PKCS11
337 # define HAVE_GNUTLS_PKCS11
338 # endif /* AVOID_GNUTLS_PKCS11 */
341 #if GNUTLS_VERSION_NUMBER >= 0x030404
342 # define HAVE_GNUTLS_PRF_RFC5705
347 /* ------------------------------------------------------------------------ */
348 /* Callback declarations */
350 #if EXIM_GNUTLS_LIBRARY_LOG_LEVEL >= 0
351 static void exim_gnutls_logger_cb(int level, const char *message);
354 static int exim_sni_handling_cb(gnutls_session_t session);
356 #ifdef EXIM_HAVE_TLS_RESUME
358 tls_server_ticket_cb(gnutls_session_t sess, u_int htype, unsigned when,
359 unsigned incoming, const gnutls_datum_t * msg);
363 /*************************************************
365 *************************************************/
367 /* Called from lots of places when errors occur before actually starting to do
368 the TLS handshake, that is, while the session is still in clear. Always returns
369 DEFER for a server and FAIL for a client so that most calls can use "return
370 tls_error(...)" to do this processing and then give an appropriate return. A
371 single function is used for both server and client, because it is called from
372 some shared functions.
375 prefix text to include in the logged error
376 msg additional error string (may be NULL)
377 usually obtained from gnutls_strerror()
378 host NULL if setting up a server;
379 the connected host if setting up a client
380 errstr pointer to returned error string
386 tls_error(const uschar *prefix, const uschar *msg, const host_item *host,
390 *errstr = string_sprintf("(%s)%s%s", prefix, msg ? ": " : "", msg ? msg : US"");
391 return host ? FAIL : DEFER;
395 /* Returns: DEFER/FAIL */
397 tls_error_gnu(exim_gnutls_state_st * state, const uschar *prefix, int err,
400 return tls_error(prefix,
401 state && err == GNUTLS_E_FATAL_ALERT_RECEIVED
402 ? string_sprintf("rxd alert: %s",
403 US gnutls_alert_get_name(gnutls_alert_get(state->session)))
404 : US gnutls_strerror(err),
405 state ? state->host : NULL,
410 tls_error_sys(const uschar *prefix, int err, const host_item *host,
413 return tls_error(prefix, US strerror(err), host, errstr);
417 /* ------------------------------------------------------------------------ */
423 tls_is_buggy_ocsp(void)
426 uschar maj, mid, mic;
428 s = CUS gnutls_check_version(NULL);
432 while (*s && *s != '.') s++;
440 while (*s && *s != '.') s++;
442 return mic <= (mid == 3 ? 16 : 3);
452 tls_g_init(uschar ** errstr)
455 DEBUG(D_tls) debug_printf("GnuTLS global init required\n");
457 #if defined(HAVE_GNUTLS_PKCS11) && !defined(GNUTLS_AUTO_PKCS11_MANUAL)
458 /* By default, gnutls_global_init will init PKCS11 support in auto mode,
459 which loads modules from a config file, which sounds good and may be wanted
460 by some sysadmin, but also means in common configurations that GNOME keyring
461 environment variables are used and so breaks for users calling mailq.
462 To prevent this, we init PKCS11 first, which is the documented approach. */
464 if (!gnutls_allow_auto_pkcs11)
465 if ((rc = gnutls_pkcs11_init(GNUTLS_PKCS11_FLAG_MANUAL, NULL)))
466 return tls_error_gnu(NULL, US"gnutls_pkcs11_init", rc, errstr);
469 #ifndef GNUTLS_AUTO_GLOBAL_INIT
470 if ((rc = gnutls_global_init()))
471 return tls_error_gnu(NULL, US"gnutls_global_init", rc, errstr);
474 #if EXIM_GNUTLS_LIBRARY_LOG_LEVEL >= 0
477 gnutls_global_set_log_function(exim_gnutls_logger_cb);
478 /* arbitrarily chosen level; bump up to 9 for more */
479 gnutls_global_set_log_level(EXIM_GNUTLS_LIBRARY_LOG_LEVEL);
484 if (tls_ocsp_file && (gnutls_buggy_ocsp = tls_is_buggy_ocsp()))
485 log_write(0, LOG_MAIN, "OCSP unusable with this GnuTLS library version");
488 exim_gnutls_base_init_done = TRUE;
494 /* Daemon-call before each connection. Nothing to do for GnuTLS. */
497 tls_per_lib_daemon_tick(void)
501 /* Daemon one-time initialisation */
504 tls_per_lib_daemon_init(void)
506 uschar * dummy_errstr;
507 static BOOL once = FALSE;
509 if (!exim_gnutls_base_init_done)
510 tls_g_init(&dummy_errstr);
516 #ifdef EXIM_HAVE_TLS_RESUME
517 /* We are dependent on the GnuTLS implementation of the Session Ticket
518 encryption; both the strength and the key rotation period. We hope that
519 the strength at least matches that of the ciphersuite (but GnuTLS does not
522 gnutls_session_ticket_key_generate(&server_sessticket_key); /* >= 2.10.0 */
523 if (f.running_in_test_harness) ssl_session_timeout = 6;
526 tls_daemon_creds_reload();
530 /* ------------------------------------------------------------------------ */
532 /*************************************************
533 * Deal with logging errors during I/O *
534 *************************************************/
536 /* We have to get the identity of the peer from saved data.
539 state the current GnuTLS exim state container
540 rc the GnuTLS error code, or 0 if it's a local error
541 when text identifying read or write
542 text local error text when rc is 0
548 record_io_error(exim_gnutls_state_st *state, int rc, uschar *when, uschar *text)
553 msg = rc == GNUTLS_E_FATAL_ALERT_RECEIVED
554 ? string_sprintf("A TLS fatal alert has been received: %s",
555 US gnutls_alert_get_name(gnutls_alert_get(state->session)))
556 #ifdef GNUTLS_E_PREMATURE_TERMINATION
557 : rc == GNUTLS_E_PREMATURE_TERMINATION && errno
558 ? string_sprintf("%s: syscall: %s", US gnutls_strerror(rc), strerror(errno))
560 : US gnutls_strerror(rc);
562 (void) tls_error(when, msg, state->host, &errstr);
565 log_write(0, LOG_MAIN, "H=%s [%s] TLS error on connection %s",
566 state->host->name, state->host->address, errstr);
569 uschar * conn_info = smtp_get_connection_info();
570 if (Ustrncmp(conn_info, US"SMTP ", 5) == 0) conn_info += 5;
571 /* I'd like to get separated H= here, but too hard for now */
572 log_write(0, LOG_MAIN, "TLS error on %s %s", conn_info, errstr);
579 /*************************************************
580 * Set various Exim expansion vars *
581 *************************************************/
583 #define exim_gnutls_cert_err(Label) \
586 if (rc != GNUTLS_E_SUCCESS) \
588 DEBUG(D_tls) debug_printf("TLS: cert problem: %s: %s\n", \
589 (Label), gnutls_strerror(rc)); \
595 import_cert(const gnutls_datum_t * cert, gnutls_x509_crt_t * crtp)
599 rc = gnutls_x509_crt_init(crtp);
600 exim_gnutls_cert_err(US"gnutls_x509_crt_init (crt)");
602 rc = gnutls_x509_crt_import(*crtp, cert, GNUTLS_X509_FMT_DER);
603 exim_gnutls_cert_err(US"failed to import certificate [gnutls_x509_crt_import(cert)]");
608 #undef exim_gnutls_cert_err
611 /* We set various Exim global variables from the state, once a session has
612 been established. With TLS callouts, may need to change this to stack
613 variables, or just re-call it with the server state after client callout
616 Make sure anything set here is unset in tls_getc().
620 tls_bits strength indicator
621 tls_certificate_verified bool indicator
622 tls_channelbinding for some SASL mechanisms
625 tls_peercert pointer to library internal
627 tls_sni a (UTF-8) string
628 tls_ourcert pointer to library internal
631 state the relevant exim_gnutls_state_st *
635 extract_exim_vars_from_tls_state(exim_gnutls_state_st * state)
637 tls_support * tlsp = state->tlsp;
639 tlsp->active.sock = state->fd_out;
640 tlsp->active.tls_ctx = state;
642 DEBUG(D_tls) debug_printf("cipher: %s\n", state->ciphersuite);
644 tlsp->certificate_verified = state->peer_cert_verified;
646 tlsp->dane_verified = state->peer_dane_verified;
649 /* note that tls_channelbinding is not saved to the spool file, since it's
650 only available for use for authenticators while this TLS session is running. */
652 tlsp->channelbinding = NULL;
653 #ifdef HAVE_GNUTLS_SESSION_CHANNEL_BINDING
655 gnutls_datum_t channel = {.data = NULL, .size = 0};
658 # ifdef HAVE_GNUTLS_EXPORTER
659 if (gnutls_protocol_get_version(state->session) >= GNUTLS_TLS1_3)
661 rc = gnutls_session_channel_binding(state->session, GNUTLS_CB_TLS_EXPORTER, &channel);
662 tlsp->channelbind_exporter = TRUE;
665 # elif defined(HAVE_GNUTLS_PRF_RFC5705)
666 /* Older libraries may not have GNUTLS_TLS1_3 defined! */
667 if (gnutls_protocol_get_version(state->session) > GNUTLS_TLS1_2)
669 uschar * buf = store_get(32, state->host ? GET_TAINTED : GET_UNTAINTED);
670 rc = gnutls_prf_rfc5705(state->session,
671 (size_t)24, "EXPORTER-Channel-Binding", (size_t)0, "",
678 rc = gnutls_session_channel_binding(state->session, GNUTLS_CB_TLS_UNIQUE, &channel);
681 { DEBUG(D_tls) debug_printf("extracting channel binding: %s\n", gnutls_strerror(rc)); }
684 int old_pool = store_pool;
685 /* Declare the taintedness of the binding info. On server, untainted; on
686 client, tainted if we used the Finish msg from the server. */
688 store_pool = POOL_PERM;
689 tlsp->channelbinding = b64encode_taint(CUS channel.data, (int)channel.size,
690 !tlsp->channelbind_exporter && state->host ? GET_TAINTED : GET_UNTAINTED);
691 store_pool = old_pool;
692 DEBUG(D_tls) debug_printf("Have channel bindings cached for possible auth usage\n");
697 /* peercert is set in peer_status() */
698 tlsp->peerdn = state->peerdn;
700 /* do not corrupt sni sent by client; record sni rxd by server */
702 tlsp->sni = state->received_sni;
704 /* record our certificate */
706 const gnutls_datum_t * cert = gnutls_certificate_get_ours(state->session);
707 gnutls_x509_crt_t crt;
709 tlsp->ourcert = cert && import_cert(cert, &crt)==0 ? crt : NULL;
716 /*************************************************
717 * Setup up DH parameters *
718 *************************************************/
720 /* Generating the D-H parameters may take a long time. They only need to
721 be re-generated every so often, depending on security policy. What we do is to
722 keep these parameters in a file in the spool directory. If the file does not
723 exist, we generate them. This means that it is easy to cause a regeneration.
725 The new file is written as a temporary file and renamed, so that an incomplete
726 file is never present. If two processes both compute some new parameters, you
727 waste a bit of effort, but it doesn't seem worth messing around with locking to
730 Returns: OK/DEFER (expansion issue)/FAIL (requested none)
734 init_server_dh(uschar ** errstr)
737 unsigned int dh_bits;
739 uschar filename_buf[PATH_MAX];
740 uschar *filename = NULL;
742 uschar *exp_tls_dhparam;
743 BOOL use_file_in_spool = FALSE;
744 host_item *host = NULL; /* dummy for macros */
746 DEBUG(D_tls) debug_printf("Initialising GnuTLS server params\n");
748 if ((rc = gnutls_dh_params_init(&dh_server_params)))
749 return tls_error_gnu(NULL, US"gnutls_dh_params_init", rc, errstr);
754 if (!expand_check(tls_dhparam, US"tls_dhparam", &exp_tls_dhparam, errstr))
757 if (!exp_tls_dhparam)
759 DEBUG(D_tls) debug_printf("Loading default hard-coded DH params\n");
760 m.data = US std_dh_prime_default();
761 m.size = Ustrlen(m.data);
763 else if (Ustrcmp(exp_tls_dhparam, "historic") == 0)
764 use_file_in_spool = TRUE;
765 else if (Ustrcmp(exp_tls_dhparam, "none") == 0)
767 DEBUG(D_tls) debug_printf("Requested no DH parameters\n");
770 else if (exp_tls_dhparam[0] != '/')
772 if (!(m.data = US std_dh_prime_named(exp_tls_dhparam)))
773 return tls_error(US"No standard prime named", exp_tls_dhparam, NULL, errstr);
774 m.size = Ustrlen(m.data);
777 filename = exp_tls_dhparam;
781 if ((rc = gnutls_dh_params_import_pkcs3(dh_server_params, &m, GNUTLS_X509_FMT_PEM)))
782 return tls_error_gnu(NULL, US"gnutls_dh_params_import_pkcs3", rc, errstr);
783 DEBUG(D_tls) debug_printf("Loaded fixed standard D-H parameters\n");
787 #ifdef HAVE_GNUTLS_SEC_PARAM_CONSTANTS
788 /* If you change this constant, also change dh_param_fn_ext so that we can use a
789 different filename and ensure we have sufficient bits. */
791 if (!(dh_bits = gnutls_sec_param_to_pk_bits(GNUTLS_PK_DH, GNUTLS_SEC_PARAM_NORMAL)))
792 return tls_error(US"gnutls_sec_param_to_pk_bits() failed", NULL, NULL, errstr);
794 debug_printf("GnuTLS tells us that for D-H PK, NORMAL is %d bits\n",
797 dh_bits = EXIM_SERVER_DH_BITS_PRE2_12;
799 debug_printf("GnuTLS lacks gnutls_sec_param_to_pk_bits(), using %d bits\n",
803 /* Some clients have hard-coded limits. */
804 if (dh_bits > tls_dh_max_bits)
807 debug_printf("tls_dh_max_bits clamping override, using %d bits instead\n",
809 dh_bits = tls_dh_max_bits;
812 if (use_file_in_spool)
814 if (!string_format(filename_buf, sizeof(filename_buf),
815 "%s/gnutls-params-%d", spool_directory, dh_bits))
816 return tls_error(US"overlong filename", NULL, NULL, errstr);
817 filename = filename_buf;
820 /* Open the cache file for reading and if successful, read it and set up the
823 if ((fd = Uopen(filename, O_RDONLY, 0)) >= 0)
829 if (fstat(fd, &statbuf) < 0) /* EIO */
833 return tls_error_sys(US"TLS cache stat failed", saved_errno, NULL, errstr);
835 if (!S_ISREG(statbuf.st_mode))
838 return tls_error(US"TLS cache not a file", NULL, NULL, errstr);
840 if (!(fp = fdopen(fd, "rb")))
844 return tls_error_sys(US"fdopen(TLS cache stat fd) failed",
845 saved_errno, NULL, errstr);
848 m.size = statbuf.st_size;
849 if (!(m.data = store_malloc(m.size)))
852 return tls_error_sys(US"malloc failed", errno, NULL, errstr);
854 if (!(sz = fread(m.data, m.size, 1, fp)))
859 return tls_error_sys(US"fread failed", saved_errno, NULL, errstr);
863 rc = gnutls_dh_params_import_pkcs3(dh_server_params, &m, GNUTLS_X509_FMT_PEM);
866 return tls_error_gnu(NULL, US"gnutls_dh_params_import_pkcs3", rc, errstr);
867 DEBUG(D_tls) debug_printf("read D-H parameters from file \"%s\"\n", filename);
870 /* If the file does not exist, fall through to compute new data and cache it.
871 If there was any other opening error, it is serious. */
873 else if (errno == ENOENT)
877 debug_printf("D-H parameter cache file \"%s\" does not exist\n", filename);
880 return tls_error(string_open_failed("\"%s\" for reading", filename),
883 /* If ret < 0, either the cache file does not exist, or the data it contains
884 is not useful. One particular case of this is when upgrading from an older
885 release of Exim in which the data was stored in a different format. We don't
886 try to be clever and support both formats; we just regenerate new data in this
892 unsigned int dh_bits_gen = dh_bits;
894 if ((PATH_MAX - Ustrlen(filename)) < 10)
895 return tls_error(US"Filename too long to generate replacement",
896 filename, NULL, errstr);
898 temp_fn = string_copy(US"exim-dh.XXXXXXX");
899 if ((fd = mkstemp(CS temp_fn)) < 0) /* modifies temp_fn */
900 return tls_error_sys(US"Unable to open temp file", errno, NULL, errstr);
901 (void)exim_chown(temp_fn, exim_uid, exim_gid); /* Probably not necessary */
903 /* GnuTLS overshoots!
904 * If we ask for 2236, we might get 2237 or more.
905 * But there's no way to ask GnuTLS how many bits there really are.
906 * We can ask how many bits were used in a TLS session, but that's it!
907 * The prime itself is hidden behind too much abstraction.
908 * So we ask for less, and proceed on a wing and a prayer.
909 * First attempt, subtracted 3 for 2233 and got 2240.
911 if (dh_bits >= EXIM_CLIENT_DH_MIN_BITS + 10)
913 dh_bits_gen = dh_bits - 10;
915 debug_printf("being paranoid about DH generation, make it '%d' bits'\n",
920 debug_printf("requesting generation of %d bit Diffie-Hellman prime ...\n",
922 if ((rc = gnutls_dh_params_generate2(dh_server_params, dh_bits_gen)))
923 return tls_error_gnu(NULL, US"gnutls_dh_params_generate2", rc, errstr);
925 /* gnutls_dh_params_export_pkcs3() will tell us the exact size, every time,
926 and I confirmed that a NULL call to get the size first is how the GnuTLS
927 sample apps handle this. */
931 if ( (rc = gnutls_dh_params_export_pkcs3(dh_server_params,
932 GNUTLS_X509_FMT_PEM, m.data, &sz))
933 && rc != GNUTLS_E_SHORT_MEMORY_BUFFER)
934 return tls_error_gnu(NULL, US"gnutls_dh_params_export_pkcs3(NULL) sizing",
937 if (!(m.data = store_malloc(m.size)))
938 return tls_error_sys(US"memory allocation failed", errno, NULL, errstr);
940 /* this will return a size 1 less than the allocation size above */
941 if ((rc = gnutls_dh_params_export_pkcs3(dh_server_params, GNUTLS_X509_FMT_PEM,
945 return tls_error_gnu(NULL, US"gnutls_dh_params_export_pkcs3() real", rc, errstr);
947 m.size = sz; /* shrink by 1, probably */
949 if ((sz = write_to_fd_buf(fd, m.data, (size_t) m.size)) != m.size)
952 return tls_error_sys(US"TLS cache write D-H params failed",
953 errno, NULL, errstr);
956 if ((sz = write_to_fd_buf(fd, US"\n", 1)) != 1)
957 return tls_error_sys(US"TLS cache write D-H params final newline failed",
958 errno, NULL, errstr);
960 if ((rc = close(fd)))
961 return tls_error_sys(US"TLS cache write close() failed", errno, NULL, errstr);
963 if (Urename(temp_fn, filename) < 0)
964 return tls_error_sys(string_sprintf("failed to rename \"%s\" as \"%s\"",
965 temp_fn, filename), errno, NULL, errstr);
967 DEBUG(D_tls) debug_printf("wrote D-H parameters to file \"%s\"\n", filename);
970 DEBUG(D_tls) debug_printf("initialized server D-H parameters\n");
977 /* Create and install a selfsigned certificate, for use in server mode. */
980 tls_install_selfsign(exim_gnutls_state_st * state, uschar ** errstr)
982 gnutls_x509_crt_t cert = NULL;
984 gnutls_x509_privkey_t pkey = NULL;
985 const uschar * where;
988 #ifndef SUPPORT_SELFSIGN
989 where = US"library too old";
990 rc = GNUTLS_E_NO_CERTIFICATE_FOUND;
994 DEBUG(D_tls) debug_printf("TLS: generating selfsigned server cert\n");
995 where = US"initialising pkey";
996 if ((rc = gnutls_x509_privkey_init(&pkey))) goto err;
998 where = US"initialising cert";
999 if ((rc = gnutls_x509_crt_init(&cert))) goto err;
1001 where = US"generating pkey"; /* Hangs on 2.12.23 */
1002 if ((rc = gnutls_x509_privkey_generate(pkey, GNUTLS_PK_RSA,
1003 #ifdef SUPPORT_PARAM_TO_PK_BITS
1004 # ifndef GNUTLS_SEC_PARAM_MEDIUM
1005 # define GNUTLS_SEC_PARAM_MEDIUM GNUTLS_SEC_PARAM_HIGH
1007 gnutls_sec_param_to_pk_bits(GNUTLS_PK_RSA, GNUTLS_SEC_PARAM_MEDIUM),
1014 where = US"configuring cert";
1016 if ( (rc = gnutls_x509_crt_set_version(cert, 3))
1017 || (rc = gnutls_x509_crt_set_serial(cert, &now, sizeof(now)))
1018 || (rc = gnutls_x509_crt_set_activation_time(cert, now = time(NULL)))
1019 || (rc = gnutls_x509_crt_set_expiration_time(cert, now + (long)2 * 60 * 60)) /* 2 hour */
1020 || (rc = gnutls_x509_crt_set_key(cert, pkey))
1022 || (rc = gnutls_x509_crt_set_dn_by_oid(cert,
1023 GNUTLS_OID_X520_COUNTRY_NAME, 0, "UK", 2))
1024 || (rc = gnutls_x509_crt_set_dn_by_oid(cert,
1025 GNUTLS_OID_X520_ORGANIZATION_NAME, 0, "Exim Developers", 15))
1026 || (rc = gnutls_x509_crt_set_dn_by_oid(cert,
1027 GNUTLS_OID_X520_COMMON_NAME, 0,
1028 smtp_active_hostname, Ustrlen(smtp_active_hostname)))
1032 where = US"signing cert";
1033 if ((rc = gnutls_x509_crt_sign(cert, cert, pkey))) goto err;
1035 where = US"installing selfsign cert";
1037 if ((rc = gnutls_certificate_set_x509_key(state->lib_state.x509_cred,
1044 if (cert) gnutls_x509_crt_deinit(cert);
1045 if (pkey) gnutls_x509_privkey_deinit(pkey);
1049 rc = tls_error_gnu(state, where, rc, errstr);
1056 /* Add certificate and key, from files.
1059 Zero or negative: good. Negate value for certificate index if < 0.
1060 Greater than zero: FAIL or DEFER code.
1064 tls_add_certfile(exim_gnutls_state_st * state, const host_item * host,
1065 const uschar * certfile, const uschar * keyfile, uschar ** errstr)
1067 int rc = gnutls_certificate_set_x509_key_file(state->lib_state.x509_cred,
1068 CCS certfile, CCS keyfile, GNUTLS_X509_FMT_PEM);
1070 return tls_error_gnu(state,
1071 string_sprintf("cert/key setup: cert=%s key=%s", certfile, keyfile),
1077 #if !defined(DISABLE_OCSP) && !defined(SUPPORT_GNUTLS_EXT_RAW_PARSE)
1078 /* Load an OCSP proof from file for sending by the server. Called
1079 on getting a status-request handshake message, for earlier versions
1083 server_ocsp_stapling_cb(gnutls_session_t session, void * ptr,
1084 gnutls_datum_t * ocsp_response)
1087 DEBUG(D_tls) debug_printf("OCSP stapling callback: %s\n", US ptr);
1089 if ((ret = gnutls_load_file(ptr, ocsp_response)) < 0)
1091 DEBUG(D_tls) debug_printf("Failed to load ocsp stapling file %s\n",
1093 tls_in.ocsp = OCSP_NOT_RESP;
1094 return GNUTLS_E_NO_CERTIFICATE_STATUS;
1097 tls_in.ocsp = OCSP_VFY_NOT_TRIED;
1103 #ifdef SUPPORT_GNUTLS_EXT_RAW_PARSE
1104 /* Make a note that we saw a status-request */
1106 tls_server_clienthello_ext(void * ctx, unsigned tls_id,
1107 const uschar * data, unsigned size)
1109 /* The values for tls_id are documented here:
1110 https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml */
1113 case 5: /* Status Request */
1114 DEBUG(D_tls) debug_printf("Seen status_request extension from client\n");
1115 tls_in.ocsp = OCSP_NOT_RESP;
1117 #ifdef EXIM_HAVE_ALPN
1118 case 16: /* Application Layer Protocol Notification */
1119 /* The format of "data" here doesn't seem to be documented, but appears
1120 to be a 2-byte field with a (redundant, given the "size" arg) total length
1121 then a sequence of one-byte size then string (not nul-term) names. The
1122 latter is as described in OpenSSL documentation.
1123 Note that we do not get called for a match_fail, making it hard to log
1124 a single bad ALPN being offered (the common case). */
1128 DEBUG(D_tls) debug_printf("Seen ALPN extension from client (s=%u):", size);
1129 for (const uschar * s = data+2; s-data < size-1; s += *s + 1)
1132 g = string_append_listele_n(g, ':', s+1, *s);
1133 DEBUG(D_tls) debug_printf(" '%.*s'", (int)*s, s+1);
1135 DEBUG(D_tls) debug_printf("\n");
1136 if (server_seen_alpn > 1)
1138 log_write(0, LOG_MAIN, "TLS ALPN (%Y) rejected", g);
1139 DEBUG(D_tls) debug_printf("TLS: too many ALPNs presented in handshake\n");
1140 return GNUTLS_E_NO_APPLICATION_PROTOCOL;
1149 /* Callback for client-hello, on server, if we think we might serve stapled-OCSP */
1151 tls_server_clienthello_cb(gnutls_session_t session, unsigned int htype,
1152 unsigned when, unsigned int incoming, const gnutls_datum_t * msg)
1154 /* Call fn for each extension seen. 3.6.3 onwards */
1155 int rc = gnutls_ext_raw_parse(NULL, tls_server_clienthello_ext, msg,
1156 GNUTLS_EXT_RAW_FLAG_TLS_CLIENT_HELLO);
1157 return rc == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE ? 0 : rc;
1161 # ifdef notdef_crashes
1162 /* Make a note that we saw a status-response */
1164 tls_server_servercerts_ext(void * ctx, unsigned tls_id,
1165 const unsigned char *data, unsigned size)
1167 /* debug_printf("%s %u\n", __FUNCTION__, tls_id); */
1168 /* https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml */
1169 if (FALSE && tls_id == 5) /* status_request */
1171 DEBUG(D_tls) debug_printf("Seen status_request extension\n");
1172 tls_in.ocsp = exim_testharness_disable_ocsp_validity_check
1173 ? OCSP_VFY_NOT_TRIED : OCSP_VFIED; /* We know that GnuTLS verifies responses */
1179 /* Callback for certificates packet, on server, if we think we might serve stapled-OCSP */
1181 tls_server_servercerts_cb(gnutls_session_t session, unsigned int htype,
1182 unsigned when, unsigned int incoming, const gnutls_datum_t * msg)
1184 /* Call fn for each extension seen. 3.6.3 onwards */
1185 # ifdef notdef_crashes
1187 return gnutls_ext_raw_parse(NULL, tls_server_servercerts_ext, msg, 0);
1190 #endif /*SUPPORT_GNUTLS_EXT_RAW_PARSE*/
1192 /*XXX in tls1.3 the cert-status travel as an extension next to the cert, in the
1193 "Handshake Protocol: Certificate" record.
1194 So we need to spot the Certificate handshake message, parse it and spot any status_request extension(s)
1196 This is different to tls1.2 - where it is a separate record (wireshark term) / handshake message (gnutls term).
1199 #if defined(EXIM_HAVE_TLS_RESUME) || defined(SUPPORT_GNUTLS_EXT_RAW_PARSE)
1200 /* Callback for certificate-status, on server. We sent stapled OCSP. */
1202 tls_server_certstatus_cb(gnutls_session_t session, unsigned int htype,
1203 unsigned when, unsigned int incoming, const gnutls_datum_t * msg)
1205 DEBUG(D_tls) debug_printf("Sending certificate-status\n"); /*XXX we get this for tls1.2 but not for 1.3 */
1206 # ifdef SUPPORT_SRV_OCSP_STACK
1207 tls_in.ocsp = exim_testharness_disable_ocsp_validity_check
1208 ? OCSP_VFY_NOT_TRIED : OCSP_VFIED; /* We know that GnuTLS verifies responses */
1210 tls_in.ocsp = OCSP_VFY_NOT_TRIED;
1215 /* Callback for handshake messages, on server */
1217 tls_server_hook_cb(gnutls_session_t sess, u_int htype, unsigned when,
1218 unsigned incoming, const gnutls_datum_t * msg)
1220 /* debug_printf("%s: htype %u\n", __FUNCTION__, htype); */
1223 # ifdef SUPPORT_GNUTLS_EXT_RAW_PARSE
1224 case GNUTLS_HANDSHAKE_CLIENT_HELLO:
1225 return tls_server_clienthello_cb(sess, htype, when, incoming, msg);
1226 case GNUTLS_HANDSHAKE_CERTIFICATE_PKT:
1227 return tls_server_servercerts_cb(sess, htype, when, incoming, msg);
1229 case GNUTLS_HANDSHAKE_CERTIFICATE_STATUS:
1230 return tls_server_certstatus_cb(sess, htype, when, incoming, msg);
1231 # ifdef EXIM_HAVE_TLS_RESUME
1232 case GNUTLS_HANDSHAKE_NEW_SESSION_TICKET:
1233 return tls_server_ticket_cb(sess, htype, when, incoming, msg);
1242 #if !defined(DISABLE_OCSP) && defined(SUPPORT_GNUTLS_EXT_RAW_PARSE)
1244 tls_server_testharness_ocsp_fiddle(void)
1246 extern char ** environ;
1247 if (environ) for (uschar ** p = USS environ; *p; p++)
1248 if (Ustrncmp(*p, "EXIM_TESTHARNESS_DISABLE_OCSPVALIDITYCHECK", 42) == 0)
1250 DEBUG(D_tls) debug_printf("Permitting known bad OCSP response\n");
1251 exim_testharness_disable_ocsp_validity_check = TRUE;
1256 /**************************************************
1257 * One-time init credentials for server and client *
1258 **************************************************/
1261 creds_basic_init(gnutls_certificate_credentials_t x509_cred, BOOL server)
1263 #ifdef SUPPORT_SRV_OCSP_STACK
1264 gnutls_certificate_set_flags(x509_cred, GNUTLS_CERTIFICATE_API_V2);
1266 # if !defined(DISABLE_OCSP) && defined(SUPPORT_GNUTLS_EXT_RAW_PARSE)
1267 if (server && tls_ocsp_file)
1269 if (f.running_in_test_harness)
1270 tls_server_testharness_ocsp_fiddle();
1272 if (exim_testharness_disable_ocsp_validity_check)
1273 gnutls_certificate_set_flags(x509_cred,
1274 GNUTLS_CERTIFICATE_API_V2 | GNUTLS_CERTIFICATE_SKIP_OCSP_RESPONSE_CHECK);
1279 debug_printf("TLS: basic cred init, %s\n", server ? "server" : "client");
1282 /* Returns OK/DEFER/FAIL */
1284 creds_load_server_certs(exim_gnutls_state_st * state, const uschar * cert,
1285 const uschar * pkey, const uschar * ocsp, uschar ** errstr)
1287 const uschar * clist = cert;
1288 const uschar * klist = pkey;
1289 const uschar * olist;
1290 int csep = 0, ksep = 0, osep = 0, cnt = 0, rc;
1291 uschar * cfile, * kfile, * ofile;
1292 #ifndef DISABLE_OCSP
1293 # ifdef SUPPORT_GNUTLS_EXT_RAW_PARSE
1294 gnutls_x509_crt_fmt_t ocsp_fmt = GNUTLS_X509_FMT_DER;
1297 if (!expand_check(ocsp, US"tls_ocsp_file", &ofile, errstr))
1302 while (cfile = string_nextinlist(&clist, &csep, NULL, 0))
1304 if (!(kfile = string_nextinlist(&klist, &ksep, NULL, 0)))
1305 return tls_error(US"cert/key setup: out of keys", NULL, NULL, errstr);
1306 else if ((rc = tls_add_certfile(state, NULL, cfile, kfile, errstr)) > OK)
1310 int gnutls_cert_index = -rc;
1311 DEBUG(D_tls) debug_printf("TLS: cert/key %d %s registered\n",
1312 gnutls_cert_index, cfile);
1314 #ifndef DISABLE_OCSP
1317 /* Set the OCSP stapling server info */
1318 if (gnutls_buggy_ocsp)
1321 debug_printf("GnuTLS library is buggy for OCSP; avoiding\n");
1323 else if ((ofile = string_nextinlist(&olist, &osep, NULL, 0)))
1325 DEBUG(D_tls) debug_printf("OCSP response file %d = %s\n",
1326 gnutls_cert_index, ofile);
1327 # ifdef SUPPORT_GNUTLS_EXT_RAW_PARSE
1328 if (Ustrncmp(ofile, US"PEM ", 4) == 0)
1330 ocsp_fmt = GNUTLS_X509_FMT_PEM;
1333 else if (Ustrncmp(ofile, US"DER ", 4) == 0)
1335 ocsp_fmt = GNUTLS_X509_FMT_DER;
1339 if ((rc = gnutls_certificate_set_ocsp_status_request_file2(
1340 state->lib_state.x509_cred, CCS ofile, gnutls_cert_index,
1342 return tls_error_gnu(state,
1343 US"gnutls_certificate_set_ocsp_status_request_file2",
1346 debug_printf(" %d response%s loaded\n", rc, rc>1 ? "s":"");
1348 /* Arrange callbacks for OCSP request observability */
1351 gnutls_handshake_set_hook_function(state->session,
1352 GNUTLS_HANDSHAKE_ANY, GNUTLS_HOOK_POST, tls_server_hook_cb);
1354 state->lib_state.ocsp_hook = TRUE;
1358 # if defined(SUPPORT_SRV_OCSP_STACK)
1359 if ((rc = gnutls_certificate_set_ocsp_status_request_function2(
1360 state->lib_state.x509_cred, gnutls_cert_index,
1361 server_ocsp_stapling_cb, ofile)))
1362 return tls_error_gnu(state,
1363 US"gnutls_certificate_set_ocsp_status_request_function2",
1371 debug_printf("oops; multiple OCSP files not supported\n");
1374 gnutls_certificate_set_ocsp_status_request_function(
1375 state->lib_state.x509_cred, server_ocsp_stapling_cb, ofile);
1377 # endif /* SUPPORT_GNUTLS_EXT_RAW_PARSE */
1380 DEBUG(D_tls) debug_printf("ran out of OCSP response files in list\n");
1382 #endif /* DISABLE_OCSP */
1388 creds_load_client_certs(exim_gnutls_state_st * state, const host_item * host,
1389 const uschar * cert, const uschar * pkey, uschar ** errstr)
1391 int rc = tls_add_certfile(state, host, cert, pkey, errstr);
1392 if (rc > 0) return rc;
1393 DEBUG(D_tls) debug_printf("TLS: cert/key registered\n");
1398 creds_load_cabundle(exim_gnutls_state_st * state, const uschar * bundle,
1399 const host_item * host, uschar ** errstr)
1402 struct stat statbuf;
1404 #ifdef SUPPORT_SYSDEFAULT_CABUNDLE
1405 if (Ustrcmp(bundle, "system") == 0 || Ustrncmp(bundle, "system,", 7) == 0)
1406 cert_count = gnutls_certificate_set_x509_system_trust(state->lib_state.x509_cred);
1410 if (Ustat(bundle, &statbuf) < 0)
1412 log_write(0, LOG_MAIN|LOG_PANIC, "could not stat '%s' "
1413 "(tls_verify_certificates): %s", bundle, strerror(errno));
1417 #ifndef SUPPORT_CA_DIR
1418 /* The test suite passes in /dev/null; we could check for that path explicitly,
1419 but who knows if someone has some weird FIFO which always dumps some certs, or
1420 other weirdness. The thing we really want to check is that it's not a
1421 directory, since while OpenSSL supports that, GnuTLS does not.
1422 So s/!S_ISREG/S_ISDIR/ and change some messaging ... */
1423 if (S_ISDIR(statbuf.st_mode))
1425 log_write(0, LOG_MAIN|LOG_PANIC,
1426 "tls_verify_certificates \"%s\" is a directory", bundle);
1431 DEBUG(D_tls) debug_printf("verify certificates = %s size=" OFF_T_FMT "\n",
1432 bundle, statbuf.st_size);
1434 if (statbuf.st_size == 0)
1437 debug_printf("cert file empty, no certs, no verification, ignoring any CRL\n");
1443 #ifdef SUPPORT_CA_DIR
1444 (statbuf.st_mode & S_IFMT) == S_IFDIR
1446 gnutls_certificate_set_x509_trust_dir(state->lib_state.x509_cred,
1447 CS bundle, GNUTLS_X509_FMT_PEM)
1450 gnutls_certificate_set_x509_trust_file(state->lib_state.x509_cred,
1451 CS bundle, GNUTLS_X509_FMT_PEM);
1453 #ifdef SUPPORT_CA_DIR
1454 /* Mimic the behaviour with OpenSSL of not advertising a usable-cert list
1455 when using the directory-of-certs config model. */
1457 if ((statbuf.st_mode & S_IFMT) == S_IFDIR)
1459 gnutls_certificate_send_x509_rdn_sequence(state->session, 1);
1461 state->lib_state.ca_rdn_emulate = TRUE;
1466 return tls_error_gnu(state, US"setting certificate trust", cert_count, errstr);
1468 debug_printf("Added %d certificate authorities\n", cert_count);
1475 creds_load_crl(exim_gnutls_state_st * state, const uschar * crl, uschar ** errstr)
1478 DEBUG(D_tls) debug_printf("loading CRL file = %s\n", crl);
1479 if ((cert_count = gnutls_certificate_set_x509_crl_file(state->lib_state.x509_cred,
1480 CS crl, GNUTLS_X509_FMT_PEM)) < 0)
1481 return tls_error_gnu(state, US"gnutls_certificate_set_x509_crl_file",
1482 cert_count, errstr);
1484 DEBUG(D_tls) debug_printf("Processed %d CRLs\n", cert_count);
1490 creds_load_pristring(exim_gnutls_state_st * state, const uschar * p,
1491 const char ** errpos)
1495 p = exim_default_gnutls_priority;
1497 debug_printf("GnuTLS using default session cipher/priority \"%s\"\n", p);
1499 return gnutls_priority_init( (gnutls_priority_t *) &state->lib_state.pri_cache,
1504 tls_server_creds_init(void)
1506 uschar * dummy_errstr;
1507 unsigned lifetime = 0;
1509 state_server.lib_state = null_tls_preload;
1510 if (gnutls_certificate_allocate_credentials(
1511 (gnutls_certificate_credentials_t *) &state_server.lib_state.x509_cred))
1513 state_server.lib_state.x509_cred = NULL;
1516 creds_basic_init(state_server.lib_state.x509_cred, TRUE);
1518 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
1519 /* If tls_certificate has any $ indicating expansions, it is not good.
1520 If tls_privatekey is set but has $, not good. Likewise for tls_ocsp_file.
1521 If all good (and tls_certificate set), load the cert(s). */
1523 if ( opt_set_and_noexpand(tls_certificate)
1524 # ifndef DISABLE_OCSP
1525 && opt_unset_or_noexpand(tls_ocsp_file)
1527 && opt_unset_or_noexpand(tls_privatekey))
1529 /* Set watches on the filenames. The implementation does de-duplication
1530 so we can just blindly do them all.
1533 if ( tls_set_watch(tls_certificate, TRUE)
1534 # ifndef DISABLE_OCSP
1535 && tls_set_watch(tls_ocsp_file, TRUE)
1537 && tls_set_watch(tls_privatekey, TRUE))
1539 DEBUG(D_tls) debug_printf("TLS: preloading server certs\n");
1540 if (creds_load_server_certs(&state_server, tls_certificate,
1541 tls_privatekey && *tls_privatekey ? tls_privatekey : tls_certificate,
1542 # ifdef DISABLE_OCSP
1547 &dummy_errstr) == 0)
1548 state_server.lib_state.conn_certs = TRUE;
1551 else if ( !tls_certificate && !tls_privatekey
1552 # ifndef DISABLE_OCSP
1556 { /* Generate & preload a selfsigned cert. No files to watch. */
1557 if ((tls_install_selfsign(&state_server, &dummy_errstr)) == OK)
1559 state_server.lib_state.conn_certs = TRUE;
1560 lifetime = f.running_in_test_harness ? 2 : 60 * 60; /* 1 hour */
1564 DEBUG(D_tls) debug_printf("TLS: not preloading server certs\n");
1566 /* If tls_verify_certificates is non-empty and has no $, load CAs.
1567 If none was configured and we can't handle "system", treat as empty. */
1569 if ( opt_set_and_noexpand(tls_verify_certificates)
1570 #ifndef SUPPORT_SYSDEFAULT_CABUNDLE
1571 && Ustrcmp(tls_verify_certificates, "system") != 0
1575 if (tls_set_watch(tls_verify_certificates, FALSE))
1577 DEBUG(D_tls) debug_printf("TLS: preloading CA bundle for server\n");
1578 if (creds_load_cabundle(&state_server, tls_verify_certificates,
1579 NULL, &dummy_errstr) != OK)
1581 state_server.lib_state.cabundle = TRUE;
1583 /* If CAs loaded and tls_crl is non-empty and has no $, load it */
1585 if (opt_set_and_noexpand(tls_crl))
1587 if (tls_set_watch(tls_crl, FALSE))
1589 DEBUG(D_tls) debug_printf("TLS: preloading CRL for server\n");
1590 if (creds_load_crl(&state_server, tls_crl, &dummy_errstr) != OK)
1592 state_server.lib_state.crl = TRUE;
1596 DEBUG(D_tls) debug_printf("TLS: not preloading CRL for server\n");
1600 DEBUG(D_tls) debug_printf("TLS: not preloading CA bundle for server\n");
1601 #endif /* EXIM_HAVE_INOTIFY */
1603 /* If tls_require_ciphers is non-empty and has no $, load the
1604 ciphers priority cache. If unset, load with the default.
1605 (server-only as the client one depends on non/DANE) */
1607 if (!tls_require_ciphers || opt_set_and_noexpand(tls_require_ciphers))
1609 const char * dummy_errpos;
1610 DEBUG(D_tls) debug_printf("TLS: preloading cipher list for server: %s\n",
1611 tls_require_ciphers);
1612 if ( creds_load_pristring(&state_server, tls_require_ciphers, &dummy_errpos)
1614 state_server.lib_state.pri_string = TRUE;
1617 DEBUG(D_tls) debug_printf("TLS: not preloading cipher list for server\n");
1622 /* Preload whatever creds are static, onto a transport. The client can then
1623 just copy the pointer as it starts up. */
1625 /*XXX this is not called for a cmdline send. But one needing to use >1 conn would benefit,
1626 and there seems little downside. */
1629 tls_client_creds_init(transport_instance * t, BOOL watch)
1631 smtp_transport_options_block * ob = t->options_block;
1632 exim_gnutls_state_st tpt_dummy_state;
1633 host_item * dummy_host = (host_item *)1;
1634 uschar * dummy_errstr;
1636 if ( !exim_gnutls_base_init_done
1637 && tls_g_init(&dummy_errstr) != OK)
1640 ob->tls_preload = null_tls_preload;
1641 if (gnutls_certificate_allocate_credentials(
1642 (struct gnutls_certificate_credentials_st **)&ob->tls_preload.x509_cred))
1644 ob->tls_preload.x509_cred = NULL;
1647 creds_basic_init(ob->tls_preload.x509_cred, FALSE);
1649 tpt_dummy_state.session = NULL;
1650 tpt_dummy_state.lib_state = ob->tls_preload;
1652 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
1653 if ( opt_set_and_noexpand(ob->tls_certificate)
1654 && opt_unset_or_noexpand(ob->tls_privatekey))
1657 || ( tls_set_watch(ob->tls_certificate, FALSE)
1658 && tls_set_watch(ob->tls_privatekey, FALSE)
1661 const uschar * pkey = ob->tls_privatekey;
1664 debug_printf("TLS: preloading client certs for transport '%s'\n", t->name);
1666 /* The state->lib_state.x509_cred is used for the certs load, and is the sole
1667 structure element used. So we can set up a dummy. The hoat arg only
1668 selects a retcode in case of fail, so any value */
1670 if (creds_load_client_certs(&tpt_dummy_state, dummy_host,
1671 ob->tls_certificate, pkey ? pkey : ob->tls_certificate,
1672 &dummy_errstr) == OK)
1673 ob->tls_preload.conn_certs = TRUE;
1678 debug_printf("TLS: not preloading client certs, for transport '%s'\n", t->name);
1680 /* If tls_verify_certificates is non-empty and has no $, load CAs.
1681 If none was configured and we can't handle "system", treat as empty. */
1683 if ( opt_set_and_noexpand(ob->tls_verify_certificates)
1684 #ifndef SUPPORT_SYSDEFAULT_CABUNDLE
1685 && Ustrcmp(ob->tls_verify_certificates, "system") != 0
1689 if (!watch || tls_set_watch(ob->tls_verify_certificates, FALSE))
1692 debug_printf("TLS: preloading CA bundle for transport '%s'\n", t->name);
1693 if (creds_load_cabundle(&tpt_dummy_state, ob->tls_verify_certificates,
1694 dummy_host, &dummy_errstr) != OK)
1696 ob->tls_preload.cabundle = TRUE;
1698 if (opt_set_and_noexpand(ob->tls_crl))
1700 if (!watch || tls_set_watch(ob->tls_crl, FALSE))
1702 DEBUG(D_tls) debug_printf("TLS: preloading CRL for transport '%s'\n", t->name);
1703 if (creds_load_crl(&tpt_dummy_state, ob->tls_crl, &dummy_errstr) != OK)
1705 ob->tls_preload.crl = TRUE;
1709 DEBUG(D_tls) debug_printf("TLS: not preloading CRL, for transport '%s'\n", t->name);
1714 debug_printf("TLS: not preloading CA bundle, for transport '%s'\n", t->name);
1716 /* We do not preload tls_require_ciphers to to the transport as it implicitly
1717 depends on DANE or plain usage. */
1723 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
1724 /* Invalidate the creds cached, by dropping the current ones.
1725 Call when we notice one of the source files has changed. */
1728 tls_server_creds_invalidate(void)
1730 if (state_server.lib_state.pri_cache)
1731 gnutls_priority_deinit(state_server.lib_state.pri_cache);
1732 state_server.lib_state.pri_cache = NULL;
1734 if (state_server.lib_state.x509_cred)
1735 gnutls_certificate_free_credentials(state_server.lib_state.x509_cred);
1736 state_server.lib_state = null_tls_preload;
1741 tls_client_creds_invalidate(transport_instance * t)
1743 smtp_transport_options_block * ob = t->options_block;
1744 if (ob->tls_preload.x509_cred)
1745 gnutls_certificate_free_credentials(ob->tls_preload.x509_cred);
1746 ob->tls_preload = null_tls_preload;
1751 /*************************************************
1752 * Variables re-expanded post-SNI *
1753 *************************************************/
1755 /* Called from both server and client code, via tls_init(), and also from
1756 the SNI callback after receiving an SNI, if tls_certificate includes "tls_sni".
1758 We can tell the two apart by state->received_sni being non-NULL in callback.
1760 The callback should not call us unless state->trigger_sni_changes is true,
1761 which we are responsible for setting on the first pass through.
1764 state exim_gnutls_state_st *
1765 errstr error string pointer
1767 Returns: OK/DEFER/FAIL
1771 tls_expand_session_files(exim_gnutls_state_st * state, uschar ** errstr)
1774 const host_item *host = state->host; /* macro should be reconsidered? */
1775 const uschar *saved_tls_certificate = NULL;
1776 const uschar *saved_tls_privatekey = NULL;
1777 const uschar *saved_tls_verify_certificates = NULL;
1778 const uschar *saved_tls_crl = NULL;
1781 /* We check for tls_sni *before* expansion. */
1782 if (!host) /* server */
1783 if (!state->received_sni)
1785 if ( state->tls_certificate
1786 && ( Ustrstr(state->tls_certificate, US"tls_sni")
1787 || Ustrstr(state->tls_certificate, US"tls_in_sni")
1788 || Ustrstr(state->tls_certificate, US"tls_out_sni")
1791 DEBUG(D_tls) debug_printf("We will re-expand TLS session files if we receive SNI\n");
1792 state->trigger_sni_changes = TRUE;
1795 else /* SNI callback case */
1797 /* useful for debugging */
1798 saved_tls_certificate = state->exp_tls_certificate;
1799 saved_tls_privatekey = state->exp_tls_privatekey;
1800 saved_tls_verify_certificates = state->exp_tls_verify_certificates;
1801 saved_tls_crl = state->exp_tls_crl;
1804 if (!state->lib_state.x509_cred)
1806 if ((rc = gnutls_certificate_allocate_credentials(
1807 (gnutls_certificate_credentials_t *) &state->lib_state.x509_cred)))
1808 return tls_error_gnu(state, US"gnutls_certificate_allocate_credentials",
1810 creds_basic_init(state->lib_state.x509_cred, !host);
1814 /* remember: Expand_check_tlsvar() is expand_check() but fiddling with
1815 state members, assuming consistent naming; and expand_check() returns
1816 false if expansion failed, unless expansion was forced to fail. */
1818 /* check if we at least have a certificate, before doing expensive
1821 if (!state->lib_state.conn_certs)
1823 if ( !Expand_check_tlsvar(tls_certificate, errstr)
1824 || f.expand_string_forcedfail)
1826 if (f.expand_string_forcedfail)
1827 *errstr = US"expansion of tls_certificate failed";
1831 /* certificate is mandatory in server, optional in client */
1833 if ( !state->exp_tls_certificate
1834 || !*state->exp_tls_certificate
1837 return tls_install_selfsign(state, errstr);
1839 DEBUG(D_tls) debug_printf("TLS: no client certificate specified; okay\n");
1841 if ( state->tls_privatekey && !Expand_check_tlsvar(tls_privatekey, errstr)
1842 || f.expand_string_forcedfail
1845 if (f.expand_string_forcedfail)
1846 *errstr = US"expansion of tls_privatekey failed";
1850 /* tls_privatekey is optional, defaulting to same file as certificate */
1852 if (!state->tls_privatekey || !*state->tls_privatekey)
1854 state->tls_privatekey = state->tls_certificate;
1855 state->exp_tls_privatekey = state->exp_tls_certificate;
1858 if (state->exp_tls_certificate && *state->exp_tls_certificate)
1861 DEBUG(D_tls) debug_printf("certificate file = %s\nkey file = %s\n",
1862 state->exp_tls_certificate, state->exp_tls_privatekey);
1864 if (state->received_sni)
1865 if ( Ustrcmp(state->exp_tls_certificate, saved_tls_certificate) == 0
1866 && Ustrcmp(state->exp_tls_privatekey, saved_tls_privatekey) == 0
1869 DEBUG(D_tls) debug_printf("TLS SNI: cert and key unchanged\n");
1870 load = FALSE; /* avoid re-loading the same certs */
1872 else /* unload the pre-SNI certs before loading new ones */
1874 DEBUG(D_tls) debug_printf("TLS SNI: have a changed cert/key pair\n");
1875 gnutls_certificate_free_keys(state->lib_state.x509_cred);
1880 ? creds_load_client_certs(state, host, state->exp_tls_certificate,
1881 state->exp_tls_privatekey, errstr)
1882 : creds_load_server_certs(state, state->exp_tls_certificate,
1883 state->exp_tls_privatekey,
1892 DEBUG(D_tls) debug_printf("load-cert: '%s'\n", *errstr);
1900 debug_printf("%s certs were preloaded\n", host ? "client" : "server");
1902 if (!state->tls_privatekey) state->tls_privatekey = state->tls_certificate;
1903 state->exp_tls_certificate = US state->tls_certificate;
1904 state->exp_tls_privatekey = US state->tls_privatekey;
1906 #ifdef SUPPORT_GNUTLS_EXT_RAW_PARSE
1907 if (state->lib_state.ocsp_hook)
1908 gnutls_handshake_set_hook_function(state->session,
1909 GNUTLS_HANDSHAKE_ANY, GNUTLS_HOOK_POST, tls_server_hook_cb);
1914 /* Set the trusted CAs file if one is provided, and then add the CRL if one is
1915 provided. Experiment shows that, if the certificate file is empty, an unhelpful
1916 error message is provided. However, if we just refrain from setting anything up
1917 in that case, certificate verification fails, which seems to be the correct
1919 If none was configured and we can't handle "system", treat as empty. */
1921 if (!state->lib_state.cabundle)
1923 if (state->tls_verify_certificates && *state->tls_verify_certificates)
1925 if (!Expand_check_tlsvar(tls_verify_certificates, errstr))
1927 #ifndef SUPPORT_SYSDEFAULT_CABUNDLE
1928 if (Ustrcmp(state->exp_tls_verify_certificates, "system") == 0)
1929 state->exp_tls_verify_certificates = NULL;
1931 if (state->tls_crl && *state->tls_crl)
1932 if (!Expand_check_tlsvar(tls_crl, errstr))
1935 if (!(state->exp_tls_verify_certificates &&
1936 *state->exp_tls_verify_certificates))
1939 debug_printf("TLS: tls_verify_certificates expanded empty, ignoring\n");
1940 /* With no tls_verify_certificates, we ignore tls_crl too */
1947 debug_printf("TLS: tls_verify_certificates not set or empty, ignoring\n");
1950 rc = creds_load_cabundle(state, state->exp_tls_verify_certificates, host, errstr);
1951 if (rc != OK) return rc;
1956 debug_printf("%s CA bundle was preloaded\n", host ? "client" : "server");
1957 state->exp_tls_verify_certificates = US state->tls_verify_certificates;
1959 #ifdef SUPPORT_CA_DIR
1960 /* Mimic the behaviour with OpenSSL of not advertising a usable-cert list
1961 when using the directory-of-certs config model. */
1962 if (state->lib_state.ca_rdn_emulate)
1963 gnutls_certificate_send_x509_rdn_sequence(state->session, 1);
1968 if (!state->lib_state.crl)
1970 if ( state->tls_crl && *state->tls_crl
1971 && state->exp_tls_crl && *state->exp_tls_crl)
1972 return creds_load_crl(state, state->exp_tls_crl, errstr);
1977 debug_printf("%s CRL was preloaded\n", host ? "client" : "server");
1978 state->exp_tls_crl = US state->tls_crl;
1987 /*************************************************
1988 * Set X.509 state variables *
1989 *************************************************/
1991 /* In GnuTLS, the registered cert/key are not replaced by a later
1992 set of a cert/key, so for SNI support we need a whole new x509_cred
1993 structure. Which means various other non-re-expanded pieces of state
1994 need to be re-set in the new struct, so the setting logic is pulled
1998 state exim_gnutls_state_st *
1999 errstr error string pointer
2001 Returns: OK/DEFER/FAIL
2005 tls_set_remaining_x509(exim_gnutls_state_st * state, uschar ** errstr)
2008 const host_item * host = state->host; /* macro should be reconsidered? */
2010 /* Create D-H parameters, or read them from the cache file. This function does
2011 its own SMTP error messaging. This only happens for the server, TLS D-H ignores
2012 client-side params. */
2016 if (!dh_server_params)
2017 if ((rc = init_server_dh(errstr)) == DEFER) return rc;
2019 /* Unnecessary & discouraged with 3.6.0 or later, according to docs. But without it,
2020 no DHE- ciphers are advertised. */
2023 gnutls_certificate_set_dh_params(state->lib_state.x509_cred, dh_server_params);
2026 /* Link the credentials to the session. */
2028 if ((rc = gnutls_credentials_set(state->session,
2029 GNUTLS_CRD_CERTIFICATE, state->lib_state.x509_cred)))
2030 return tls_error_gnu(state, US"gnutls_credentials_set", rc, errstr);
2035 /*************************************************
2036 * Initialize for GnuTLS *
2037 *************************************************/
2040 /* Called from both server and client code. In the case of a server, errors
2041 before actual TLS negotiation return DEFER.
2044 host connected host, if client; NULL if server
2045 ob tranport options block, if client; NULL if server
2046 require_ciphers tls_require_ciphers setting
2047 caller_state returned state-info structure
2048 errstr error string pointer
2050 Returns: OK/DEFER/FAIL
2055 const host_item *host,
2056 smtp_transport_options_block * ob,
2057 const uschar * require_ciphers,
2058 exim_gnutls_state_st **caller_state,
2062 exim_gnutls_state_st * state;
2066 if ( !exim_gnutls_base_init_done
2067 && (rc = tls_g_init(errstr)) != OK)
2072 /* For client-side sessions we allocate a context. This lets us run
2073 several in parallel. */
2075 int old_pool = store_pool;
2076 store_pool = POOL_PERM;
2077 state = store_get(sizeof(exim_gnutls_state_st), GET_UNTAINTED);
2078 store_pool = old_pool;
2080 memcpy(state, &exim_gnutls_state_init, sizeof(exim_gnutls_state_init));
2081 state->lib_state = ob->tls_preload;
2083 DEBUG(D_tls) debug_printf("initialising GnuTLS client session\n");
2084 rc = gnutls_init(&state->session, GNUTLS_CLIENT);
2086 state->tls_certificate = ob->tls_certificate;
2087 state->tls_privatekey = ob->tls_privatekey;
2088 state->tls_sni = ob->tls_sni;
2089 state->tls_verify_certificates = ob->tls_verify_certificates;
2090 state->tls_crl = ob->tls_crl;
2094 /* Server operations always use the one state_server context. It is not
2095 shared because we have forked a fresh process for every receive. However it
2096 can get re-used for successive TLS sessions on a single TCP connection. */
2098 state = &state_server;
2100 DEBUG(D_tls) debug_printf("initialising GnuTLS server session\n");
2101 rc = gnutls_init(&state->session, GNUTLS_SERVER);
2103 state->tls_certificate = tls_certificate;
2104 state->tls_privatekey = tls_privatekey;
2105 state->tls_sni = NULL;
2106 state->tls_verify_certificates = tls_verify_certificates;
2107 state->tls_crl = tls_crl;
2110 return tls_error_gnu(state, US"gnutls_init", rc, errstr);
2112 state->tls_require_ciphers = require_ciphers;
2115 /* This handles the variables that might get re-expanded after TLS SNI;
2116 tls_certificate, tls_privatekey, tls_verify_certificates, tls_crl */
2119 debug_printf("Expanding various TLS configuration options for session credentials\n");
2120 if ((rc = tls_expand_session_files(state, errstr)) != OK) return rc;
2122 /* These are all other parts of the x509_cred handling, since SNI in GnuTLS
2123 requires a new structure afterwards. */
2125 if ((rc = tls_set_remaining_x509(state, errstr)) != OK) return rc;
2127 /* set SNI in client, only */
2130 if (!expand_check(state->tls_sni, US"tls_out_sni", &state->tlsp->sni, errstr))
2132 if (state->tlsp->sni && *state->tlsp->sni)
2135 debug_printf("Setting TLS client SNI to \"%s\"\n", state->tlsp->sni);
2136 sz = Ustrlen(state->tlsp->sni);
2137 if ((rc = gnutls_server_name_set(state->session,
2138 GNUTLS_NAME_DNS, state->tlsp->sni, sz)))
2139 return tls_error_gnu(state, US"gnutls_server_name_set", rc, errstr);
2142 else if (state->tls_sni)
2143 DEBUG(D_tls) debug_printf("*** PROBABLY A BUG *** " \
2144 "have an SNI set for a server [%s]\n", state->tls_sni);
2146 if (!state->lib_state.pri_string)
2148 const uschar * p = NULL;
2149 const char * errpos;
2151 /* This is the priority string support,
2152 http://www.gnutls.org/manual/html_node/Priority-Strings.html
2153 and replaces gnutls_require_kx, gnutls_require_mac & gnutls_require_protocols.
2154 This was backwards incompatible, but means Exim no longer needs to track
2155 all algorithms and provide string forms for them. */
2157 if (state->tls_require_ciphers && *state->tls_require_ciphers)
2159 if (!Expand_check_tlsvar(tls_require_ciphers, errstr))
2161 if (state->exp_tls_require_ciphers && *state->exp_tls_require_ciphers)
2163 p = state->exp_tls_require_ciphers;
2164 DEBUG(D_tls) debug_printf("GnuTLS session cipher/priority \"%s\"\n", p);
2168 if ((rc = creds_load_pristring(state, p, &errpos)))
2169 return tls_error_gnu(state, string_sprintf(
2170 "gnutls_priority_init(%s) failed at offset %ld, \"%.6s..\"",
2171 p, (long)(errpos - CS p), errpos),
2176 DEBUG(D_tls) debug_printf("cipher list preloaded\n");
2177 state->exp_tls_require_ciphers = US state->tls_require_ciphers;
2181 if ((rc = gnutls_priority_set(state->session, state->lib_state.pri_cache)))
2182 return tls_error_gnu(state, US"gnutls_priority_set", rc, errstr);
2184 /* This also sets the server ticket expiration time to the same, and
2185 the STEK rotation time to 3x. */
2187 gnutls_db_set_cache_expiration(state->session, ssl_session_timeout);
2189 /* Reduce security in favour of increased compatibility, if the admin
2190 decides to make that trade-off. */
2191 if (gnutls_compat_mode)
2193 #if LIBGNUTLS_VERSION_NUMBER >= 0x020104
2194 DEBUG(D_tls) debug_printf("lowering GnuTLS security, compatibility mode\n");
2195 gnutls_session_enable_compatibility_mode(state->session);
2197 DEBUG(D_tls) debug_printf("Unable to set gnutls_compat_mode - GnuTLS version too old\n");
2201 *caller_state = state;
2207 /*************************************************
2208 * Extract peer information *
2209 *************************************************/
2211 static const uschar *
2212 cipher_stdname_kcm(gnutls_kx_algorithm_t kx, gnutls_cipher_algorithm_t cipher,
2213 gnutls_mac_algorithm_t mac)
2216 gnutls_kx_algorithm_t kx_i;
2217 gnutls_cipher_algorithm_t cipher_i;
2218 gnutls_mac_algorithm_t mac_i;
2221 gnutls_cipher_suite_info(i, cs_id, &kx_i, &cipher_i, &mac_i, NULL);
2223 if (kx_i == kx && cipher_i == cipher && mac_i == mac)
2224 return cipher_stdname(cs_id[0], cs_id[1]);
2230 /* Called from both server and client code.
2231 Only this is allowed to set state->peerdn and state->have_set_peerdn
2232 and we use that to detect double-calls.
2234 NOTE: the state blocks last while the TLS connection is up, which is fine
2235 for logging in the server side, but for the client side, we log after teardown
2236 in src/deliver.c. While the session is up, we can twist about states and
2237 repoint tls_* globals, but those variables used for logging or other variable
2238 expansion that happens _after_ delivery need to have a longer life-time.
2240 So for those, we get the data from POOL_PERM; the re-invoke guard keeps us from
2241 doing this more than once per generation of a state context. We set them in
2242 the state context, and repoint tls_* to them. After the state goes away, the
2243 tls_* copies of the pointers remain valid and client delivery logging is happy.
2245 tls_certificate_verified is a BOOL, so the tls_peerdn and tls_cipher issues
2249 state exim_gnutls_state_st *
2250 errstr pointer to error string
2252 Returns: OK/DEFER/FAIL
2256 peer_status(exim_gnutls_state_st * state, uschar ** errstr)
2258 gnutls_session_t session = state->session;
2259 const gnutls_datum_t * cert_list;
2261 unsigned int cert_list_size = 0;
2262 gnutls_protocol_t protocol;
2263 gnutls_cipher_algorithm_t cipher;
2264 gnutls_kx_algorithm_t kx;
2265 gnutls_mac_algorithm_t mac;
2266 gnutls_certificate_type_t ct;
2267 gnutls_x509_crt_t crt;
2271 if (state->have_set_peerdn)
2273 state->have_set_peerdn = TRUE;
2275 state->peerdn = NULL;
2278 cipher = gnutls_cipher_get(session);
2279 protocol = gnutls_protocol_get_version(session);
2280 mac = gnutls_mac_get(session);
2282 #ifdef GNUTLS_TLS1_3
2283 protocol >= GNUTLS_TLS1_3 ? 0 :
2285 gnutls_kx_get(session);
2287 old_pool = store_pool;
2289 tls_support * tlsp = state->tlsp;
2290 store_pool = POOL_PERM;
2292 #ifdef SUPPORT_GNUTLS_SESS_DESC
2295 uschar * s = US gnutls_session_get_desc(session), c;
2297 /* Nikos M suggests we use this by preference. It returns like:
2298 (TLS1.3)-(ECDHE-SECP256R1)-(RSA-PSS-RSAE-SHA256)-(AES-256-GCM)
2300 For partial back-compat, put a colon after the TLS version, replace the
2301 )-( grouping with __, replace in-group - with _ and append the :keysize. */
2303 /* debug_printf("peer_status: gnutls_session_get_desc %s\n", s); */
2305 for (s++; (c = *s) && c != ')'; s++) g = string_catn(g, s, 1);
2307 tlsp->ver = string_copy_from_gstring(g);
2308 for (uschar * p = US tlsp->ver; *p; p++)
2309 if (*p == '-') { *p = '\0'; break; } /* TLS1.0-PKIX -> TLS1.0 */
2311 g = string_catn(g, US":", 1);
2312 if (*s) s++; /* now on _ between groups */
2315 for (*++s && ++s; (c = *s) && c != ')'; s++)
2316 g = string_catn(g, c == '-' ? US"_" : s, 1);
2317 /* now on ) closing group */
2318 if ((c = *s) && *++s == '-') g = string_catn(g, US"__", 2);
2319 /* now on _ between groups */
2321 g = string_catn(g, US":", 1);
2322 g = string_cat(g, string_sprintf("%d", (int) gnutls_cipher_get_key_size(cipher) * 8));
2323 state->ciphersuite = string_from_gstring(g);
2326 state->ciphersuite = string_sprintf("%s:%s:%d",
2327 gnutls_protocol_get_name(protocol),
2328 gnutls_cipher_suite_get_name(kx, cipher, mac),
2329 (int) gnutls_cipher_get_key_size(cipher) * 8);
2331 /* I don't see a way that spaces could occur, in the current GnuTLS
2332 code base, but it was a concern in the old code and perhaps older GnuTLS
2333 releases did return "TLS 1.0"; play it safe, just in case. */
2335 for (uschar * p = state->ciphersuite; *p; p++) if (isspace(*p)) *p = '-';
2336 tlsp->ver = string_copyn(state->ciphersuite,
2337 Ustrchr(state->ciphersuite, ':') - state->ciphersuite);
2340 /* debug_printf("peer_status: ciphersuite %s\n", state->ciphersuite); */
2342 tlsp->cipher = state->ciphersuite;
2343 tlsp->bits = gnutls_cipher_get_key_size(cipher) * 8;
2345 tlsp->cipher_stdname = cipher_stdname_kcm(kx, cipher, mac);
2347 store_pool = old_pool;
2350 cert_list = gnutls_certificate_get_peers(session, &cert_list_size);
2352 if (!cert_list || cert_list_size == 0)
2354 DEBUG(D_tls) debug_printf("TLS: no certificate from peer (%p & %d)\n",
2355 cert_list, cert_list_size);
2356 if (state->verify_requirement >= VERIFY_REQUIRED)
2357 return tls_error(US"certificate verification failed",
2358 US"no certificate received from peer", state->host, errstr);
2362 if ((ct = gnutls_certificate_type_get(session)) != GNUTLS_CRT_X509)
2364 const uschar * ctn = US gnutls_certificate_type_get_name(ct);
2366 debug_printf("TLS: peer cert not X.509 but instead \"%s\"\n", ctn);
2367 if (state->verify_requirement >= VERIFY_REQUIRED)
2368 return tls_error(US"certificate verification not possible, unhandled type",
2369 ctn, state->host, errstr);
2373 #define exim_gnutls_peer_err(Label) \
2375 if (rc != GNUTLS_E_SUCCESS) \
2377 DEBUG(D_tls) debug_printf("TLS: peer cert problem: %s: %s\n", \
2378 (Label), gnutls_strerror(rc)); \
2379 if (state->verify_requirement >= VERIFY_REQUIRED) \
2380 return tls_error_gnu(state, (Label), rc, errstr); \
2385 rc = import_cert(&cert_list[0], &crt);
2386 exim_gnutls_peer_err(US"cert 0");
2388 state->tlsp->peercert = state->peercert = crt;
2391 rc = gnutls_x509_crt_get_dn(crt, NULL, &sz);
2392 if (rc != GNUTLS_E_SHORT_MEMORY_BUFFER)
2394 exim_gnutls_peer_err(US"getting size for cert DN failed");
2395 return FAIL; /* should not happen */
2397 dn_buf = store_get_perm(sz, GET_TAINTED);
2398 rc = gnutls_x509_crt_get_dn(crt, CS dn_buf, &sz);
2399 exim_gnutls_peer_err(US"failed to extract certificate DN [gnutls_x509_crt_get_dn(cert 0)]");
2401 state->peerdn = dn_buf;
2404 #undef exim_gnutls_peer_err
2410 /*************************************************
2411 * Verify peer certificate *
2412 *************************************************/
2414 /* Called from both server and client code.
2415 *Should* be using a callback registered with
2416 gnutls_certificate_set_verify_function() to fail the handshake if we dislike
2417 the peer information, but that's too new for some OSes.
2420 state exim_gnutls_state_st *
2421 errstr where to put an error message
2424 FALSE if the session should be rejected
2425 TRUE if the cert is okay or we just don't care
2429 verify_certificate(exim_gnutls_state_st * state, uschar ** errstr)
2434 DEBUG(D_tls) debug_printf("TLS: checking peer certificate\n");
2436 rc = peer_status(state, errstr);
2438 if (state->verify_requirement == VERIFY_NONE)
2441 if (rc != OK || !state->peerdn)
2443 verify = GNUTLS_CERT_INVALID;
2444 *errstr = US"certificate not supplied";
2450 if (state->verify_requirement == VERIFY_DANE && state->host)
2452 /* Using dane_verify_session_crt() would be easy, as it does it all for us
2453 including talking to a DNS resolver. But we want to do that bit ourselves
2454 as the testsuite intercepts and fakes its own DNS environment. */
2459 const gnutls_datum_t * certlist =
2460 gnutls_certificate_get_peers(state->session, &lsize);
2461 int usage = tls_out.tlsa_usage;
2463 # ifdef GNUTLS_BROKEN_DANE_VALIDATION
2464 /* Split the TLSA records into two sets, TA and EE selectors. Run the
2465 dane-verification separately so that we know which selector verified;
2466 then we know whether to do name-verification (needed for TA but not EE). */
2468 if (usage == ((1<<DANESSL_USAGE_DANE_TA) | (1<<DANESSL_USAGE_DANE_EE)))
2469 { /* a mixed-usage bundle */
2474 for (nrec = 0; state->dane_data_len[nrec]; ) nrec++;
2477 dd = store_get(nrec * sizeof(uschar *), GET_UNTAINTED);
2478 ddl = store_get(nrec * sizeof(int), GET_UNTAINTED);
2481 if ((rc = dane_state_init(&s, 0)))
2484 for (usage = DANESSL_USAGE_DANE_EE;
2485 usage >= DANESSL_USAGE_DANE_TA; usage--)
2486 { /* take records with this usage */
2487 for (j = i = 0; i < nrec; i++)
2488 if (state->dane_data[i][0] == usage)
2490 dd[j] = state->dane_data[i];
2491 ddl[j++] = state->dane_data_len[i];
2498 if ((rc = dane_raw_tlsa(s, &r, (char * const *)dd, ddl, 1, 0)))
2501 if ((rc = dane_verify_crt_raw(s, certlist, lsize,
2502 gnutls_certificate_type_get(state->session),
2504 usage == DANESSL_USAGE_DANE_EE
2505 ? DANE_VFLAG_ONLY_CHECK_EE_USAGE : 0,
2509 debug_printf("TLSA record problem: %s\n", dane_strerror(rc));
2511 else if (verify == 0) /* verification passed */
2519 if (rc) goto tlsa_prob;
2524 if ( (rc = dane_state_init(&s, 0))
2525 || (rc = dane_raw_tlsa(s, &r, state->dane_data, state->dane_data_len,
2527 || (rc = dane_verify_crt_raw(s, certlist, lsize,
2528 gnutls_certificate_type_get(state->session),
2530 # ifdef GNUTLS_BROKEN_DANE_VALIDATION
2531 usage == (1 << DANESSL_USAGE_DANE_EE)
2532 ? DANE_VFLAG_ONLY_CHECK_EE_USAGE : 0,
2541 if (verify != 0) /* verification failed */
2544 (void) dane_verification_status_print(verify, &str, 0);
2545 *errstr = US str.data; /* don't bother to free */
2549 # ifdef GNUTLS_BROKEN_DANE_VALIDATION
2550 /* If a TA-mode TLSA record was used for verification we must additionally
2551 verify the cert name (but not the CA chain). For EE-mode, skip it. */
2553 if (usage & (1 << DANESSL_USAGE_DANE_EE))
2556 state->peer_dane_verified = state->peer_cert_verified = TRUE;
2559 # ifdef GNUTLS_BROKEN_DANE_VALIDATION
2560 /* Assume that the name on the A-record is the one that should be matching
2561 the cert. An alternate view is that the domain part of the email address
2562 is also permissible. */
2564 if (gnutls_x509_crt_check_hostname(state->tlsp->peercert,
2565 CS state->host->name))
2567 state->peer_dane_verified = state->peer_cert_verified = TRUE;
2572 #endif /*SUPPORT_DANE*/
2574 rc = gnutls_certificate_verify_peers2(state->session, &verify);
2577 /* Handle the result of verification. INVALID is set if any others are. */
2579 if (rc < 0 || verify & (GNUTLS_CERT_INVALID|GNUTLS_CERT_REVOKED))
2581 state->peer_cert_verified = FALSE;
2584 #ifdef GNUTLS_CERT_VFY_STATUS_PRINT
2589 if (gnutls_certificate_verification_status_print(verify,
2590 gnutls_certificate_type_get(state->session), &txt, 0)
2591 == GNUTLS_E_SUCCESS)
2593 debug_printf("%s\n", txt.data);
2594 gnutls_free(txt.data);
2598 *errstr = verify & GNUTLS_CERT_REVOKED
2599 ? US"certificate revoked" : US"certificate invalid";
2603 debug_printf("TLS certificate verification failed (%s): peerdn=\"%s\"\n",
2604 *errstr, state->peerdn ? state->peerdn : US"<unset>");
2606 if (state->verify_requirement >= VERIFY_REQUIRED)
2609 debug_printf("TLS verify failure overridden (host in tls_try_verify_hosts)\n");
2614 /* Client side, check the server's certificate name versus the name on the
2615 A-record for the connection we made. What to do for server side - what name
2616 to use for client? We document that there is no such checking for server
2619 if ( state->exp_tls_verify_cert_hostnames
2620 && !gnutls_x509_crt_check_hostname(state->tlsp->peercert,
2621 CS state->exp_tls_verify_cert_hostnames)
2625 debug_printf("TLS certificate verification failed: cert name mismatch (per GnuTLS)\n");
2626 if (state->verify_requirement >= VERIFY_REQUIRED)
2631 state->peer_cert_verified = TRUE;
2632 DEBUG(D_tls) debug_printf("TLS certificate verified: peerdn=\"%s\"\n",
2633 state->peerdn ? state->peerdn : US"<unset>");
2637 state->tlsp->peerdn = state->peerdn;
2642 *errstr = string_sprintf("TLSA record problem: %s",
2643 rc == DANE_E_REQUESTED_DATA_NOT_AVAILABLE ? "none usable" : dane_strerror(rc));
2647 gnutls_alert_send(state->session, GNUTLS_AL_FATAL, GNUTLS_A_BAD_CERTIFICATE);
2654 /* ------------------------------------------------------------------------ */
2657 /* Logging function which can be registered with
2658 * gnutls_global_set_log_function()
2659 * gnutls_global_set_log_level() 0..9
2661 #if EXIM_GNUTLS_LIBRARY_LOG_LEVEL >= 0
2663 exim_gnutls_logger_cb(int level, const char *message)
2665 size_t len = strlen(message);
2668 DEBUG(D_tls) debug_printf("GnuTLS<%d> empty debug message\n", level);
2671 DEBUG(D_tls) debug_printf("GnuTLS<%d>: %s%s", level, message,
2672 message[len-1] == '\n' ? "" : "\n");
2677 /* Called after client hello, should handle SNI work.
2678 This will always set tls_sni (state->received_sni) if available,
2679 and may trigger presenting different certificates,
2680 if state->trigger_sni_changes is TRUE.
2682 Should be registered with
2683 gnutls_handshake_set_post_client_hello_function()
2685 "This callback must return 0 on success or a gnutls error code to terminate the
2688 For inability to get SNI information, we return 0.
2689 We only return non-zero if re-setup failed.
2690 Only used for server-side TLS.
2694 exim_sni_handling_cb(gnutls_session_t session)
2696 char sni_name[MAX_HOST_LEN];
2697 size_t data_len = MAX_HOST_LEN;
2698 exim_gnutls_state_st *state = &state_server;
2699 unsigned int sni_type;
2701 uschar * dummy_errstr;
2703 rc = gnutls_server_name_get(session, sni_name, &data_len, &sni_type, 0);
2704 if (rc != GNUTLS_E_SUCCESS)
2707 if (rc == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
2708 debug_printf("TLS: no SNI presented in handshake\n");
2710 debug_printf("TLS failure: gnutls_server_name_get(): %s [%d]\n",
2711 gnutls_strerror(rc), rc);
2715 if (sni_type != GNUTLS_NAME_DNS)
2717 DEBUG(D_tls) debug_printf("TLS: ignoring SNI of unhandled type %u\n", sni_type);
2721 /* We now have a UTF-8 string in sni_name */
2722 old_pool = store_pool;
2723 store_pool = POOL_PERM;
2724 state->received_sni = string_copy_taint(US sni_name, GET_TAINTED);
2725 store_pool = old_pool;
2727 /* We set this one now so that variable expansions below will work */
2728 state->tlsp->sni = state->received_sni;
2730 DEBUG(D_tls) debug_printf("Received TLS SNI \"%s\"%s\n", sni_name,
2731 state->trigger_sni_changes ? "" : " (unused for certificate selection)");
2733 if (!state->trigger_sni_changes)
2736 if ((rc = tls_expand_session_files(state, &dummy_errstr)) != OK)
2738 /* If the setup of certs/etc failed before handshake, TLS would not have
2739 been offered. The best we can do now is abort. */
2740 DEBUG(D_tls) debug_printf("expansion for SNI-dependent session files failed\n");
2741 return GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE;
2744 rc = tls_set_remaining_x509(state, &dummy_errstr);
2745 if (rc != OK) return GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE;
2752 #ifndef DISABLE_EVENT
2754 We use this callback to get observability and detail-level control
2755 for an exim TLS connection (either direction), raising a tls:cert event
2756 for each cert in the chain presented by the peer. Any event
2757 can deny verification.
2759 Return 0 for the handshake to continue or non-zero to terminate.
2763 verify_cb(gnutls_session_t session)
2765 const gnutls_datum_t * cert_list;
2766 unsigned int cert_list_size = 0;
2767 gnutls_x509_crt_t crt;
2770 exim_gnutls_state_st * state = gnutls_session_get_ptr(session);
2772 if ((cert_list = gnutls_certificate_get_peers(session, &cert_list_size)))
2773 while (cert_list_size--)
2775 if ((rc = import_cert(&cert_list[cert_list_size], &crt)) != GNUTLS_E_SUCCESS)
2777 DEBUG(D_tls) debug_printf("TLS: peer cert problem: depth %d: %s\n",
2778 cert_list_size, gnutls_strerror(rc));
2782 state->tlsp->peercert = crt;
2783 if ((yield = event_raise(state->event_action,
2784 US"tls:cert", string_sprintf("%d", cert_list_size), &errno)))
2786 log_write(0, LOG_MAIN,
2787 "SSL verify denied by event-action: depth=%d: %s",
2788 cert_list_size, yield);
2789 return 1; /* reject */
2791 state->tlsp->peercert = NULL;
2801 ddump(gnutls_datum_t * d)
2803 gstring * g = string_get((d->size+1) * 2);
2804 uschar * s = d->data;
2805 for (unsigned i = d->size; i > 0; i--, s++)
2807 g = string_catn(g, US "0123456789abcdef" + (*s >> 4), 1);
2808 g = string_catn(g, US "0123456789abcdef" + (*s & 0xf), 1);
2814 post_handshake_debug(exim_gnutls_state_st * state)
2816 #ifdef SUPPORT_GNUTLS_SESS_DESC
2817 debug_printf("%s\n", gnutls_session_get_desc(state->session));
2820 #ifdef SUPPORT_GNUTLS_KEYLOG
2821 # ifdef EXIM_HAVE_TLS1_3
2822 if (gnutls_protocol_get_version(state->session) < GNUTLS_TLS1_3)
2827 gnutls_datum_t c, s;
2829 /* For TLS1.2 we only want the client random and the master secret */
2830 gnutls_session_get_random(state->session, &c, &s);
2831 gnutls_session_get_master_secret(state->session, &s);
2834 debug_printf("CLIENT_RANDOM %.*s %.*s\n", (int)gc->ptr, gc->s, (int)gs->ptr, gs->s);
2837 debug_printf("To get keying info for TLS1.3 is hard:\n"
2838 " Set environment variable SSLKEYLOGFILE to a filename relative to the spool directory,\n"
2839 " and make sure it is writable by the Exim runtime user.\n"
2840 " Add SSLKEYLOGFILE to keep_environment in the exim config.\n"
2841 " Start Exim as root.\n"
2842 " If using sudo, add SSLKEYLOGFILE to env_keep in /etc/sudoers\n"
2843 " (works for TLS1.2 also, and saves cut-paste into file).\n"
2844 " Trying to use add_environment for this will not work\n");
2849 #ifdef EXIM_HAVE_TLS_RESUME
2851 tls_server_ticket_cb(gnutls_session_t sess, u_int htype, unsigned when,
2852 unsigned incoming, const gnutls_datum_t * msg)
2854 DEBUG(D_tls) debug_printf("newticket cb\n");
2855 tls_in.resumption |= RESUME_CLIENT_REQUESTED;
2860 tls_server_resume_prehandshake(exim_gnutls_state_st * state)
2862 /* Should the server offer session resumption? */
2863 tls_in.resumption = RESUME_SUPPORTED;
2864 if (verify_check_host(&tls_resumption_hosts) == OK)
2867 /* GnuTLS appears to not do ticket overlap, but does emit a fresh ticket when
2868 an offered resumption is unacceptable. We lose one resumption per ticket
2869 lifetime, and sessions cannot be indefinitely re-used. There seems to be no
2870 way (3.6.7) of changing the default number of 2 TLS1.3 tickets issued, but at
2871 least they go out in a single packet. */
2873 if (!(rc = gnutls_session_ticket_enable_server(state->session,
2874 &server_sessticket_key)))
2875 tls_in.resumption |= RESUME_SERVER_TICKET;
2878 debug_printf("enabling session tickets: %s\n", US gnutls_strerror(rc));
2880 /* Try to tell if we see a ticket request */
2881 gnutls_handshake_set_hook_function(state->session,
2882 GNUTLS_HANDSHAKE_ANY, GNUTLS_HOOK_POST, tls_server_hook_cb);
2887 tls_server_resume_posthandshake(exim_gnutls_state_st * state)
2889 if (gnutls_session_resumption_requested(state->session))
2891 /* This tells us the client sent a full ticket. We use a
2892 callback on session-ticket request, elsewhere, to tell
2893 if a client asked for a ticket. */
2895 tls_in.resumption |= RESUME_CLIENT_SUGGESTED;
2896 DEBUG(D_tls) debug_printf("client requested resumption\n");
2898 if (gnutls_session_is_resumed(state->session))
2900 tls_in.resumption |= RESUME_USED;
2901 DEBUG(D_tls) debug_printf("Session resumed\n");
2904 #endif /* EXIM_HAVE_TLS_RESUME */
2907 #ifdef EXIM_HAVE_ALPN
2908 /* Expand and convert an Exim list to a gnutls_datum list. False return for fail.
2909 NULL plist return for silent no-ALPN.
2913 tls_alpn_plist(uschar ** tls_alpn, const gnutls_datum_t ** plist, unsigned * plen,
2918 if (!expand_check(*tls_alpn, US"tls_alpn", &exp_alpn, errstr))
2923 DEBUG(D_tls) debug_printf("Setting TLS ALPN forced to fail, not sending\n");
2928 const uschar * list = exp_alpn;
2934 while (string_nextinlist(&list, &sep, NULL, 0)) cnt++;
2936 p = store_get(sizeof(gnutls_datum_t) * cnt, exp_alpn);
2938 for (int i = 0; s = string_nextinlist(&list, &sep, NULL, 0); i++)
2939 { p[i].data = s; p[i].size = Ustrlen(s); }
2940 *plist = (*plen = cnt) ? p : NULL;
2946 tls_server_set_acceptable_alpns(exim_gnutls_state_st * state, uschar ** errstr)
2948 uschar * local_alpn = string_copy(tls_alpn);
2950 const gnutls_datum_t * plist;
2953 if (tls_alpn_plist(&local_alpn, &plist, &plen, errstr) && plist)
2955 /* This seems to be only mandatory if the client sends an ALPN extension;
2956 not trying ALPN is ok. Need to decide how to support server-side must-alpn. */
2958 server_seen_alpn = 0;
2959 if (!(rc = gnutls_alpn_set_protocols(state->session, plist, plen,
2960 GNUTLS_ALPN_MANDATORY)))
2961 gnutls_handshake_set_hook_function(state->session,
2962 GNUTLS_HANDSHAKE_ANY, GNUTLS_HOOK_POST, tls_server_hook_cb);
2965 debug_printf("setting alpn protocols: %s\n", US gnutls_strerror(rc));
2968 #endif /* EXIM_HAVE_ALPN */
2970 /* ------------------------------------------------------------------------ */
2971 /* Exported functions */
2976 /*************************************************
2977 * Start a TLS session in a server *
2978 *************************************************/
2980 /* This is called when Exim is running as a server, after having received
2981 the STARTTLS command. It must respond to that command, and then negotiate
2985 errstr pointer to error string
2987 Returns: OK on success
2988 DEFER for errors before the start of the negotiation
2989 FAIL for errors during the negotiation; the server can't
2994 tls_server_start(uschar ** errstr)
2997 exim_gnutls_state_st * state = NULL;
2999 /* Check for previous activation */
3000 if (tls_in.active.sock >= 0)
3002 tls_error(US"STARTTLS received after TLS started", US "", NULL, errstr);
3003 smtp_printf("554 Already in TLS\r\n", SP_NO_MORE);
3007 /* Initialize the library. If it fails, it will already have logged the error
3008 and sent an SMTP response. */
3010 DEBUG(D_tls) debug_printf("initialising GnuTLS as a server\n");
3013 #ifdef MEASURE_TIMING
3015 gettimeofday(&t0, NULL);
3018 if ((rc = tls_init(NULL, NULL,
3019 tls_require_ciphers, &state, &tls_in, errstr)) != OK) return rc;
3021 #ifdef MEASURE_TIMING
3022 report_time_since(&t0, US"server tls_init (delta)");
3026 #ifdef EXIM_HAVE_ALPN
3027 tls_server_set_acceptable_alpns(state, errstr);
3030 #ifdef EXIM_HAVE_TLS_RESUME
3031 tls_server_resume_prehandshake(state);
3034 /* If this is a host for which certificate verification is mandatory or
3035 optional, set up appropriately. */
3037 if (verify_check_host(&tls_verify_hosts) == OK)
3040 debug_printf("TLS: a client certificate will be required\n");
3041 state->verify_requirement = VERIFY_REQUIRED;
3042 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_REQUIRE);
3044 else if (verify_check_host(&tls_try_verify_hosts) == OK)
3047 debug_printf("TLS: a client certificate will be requested but not required\n");
3048 state->verify_requirement = VERIFY_OPTIONAL;
3049 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_REQUEST);
3054 debug_printf("TLS: a client certificate will not be requested\n");
3055 state->verify_requirement = VERIFY_NONE;
3056 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_IGNORE);
3059 #ifndef DISABLE_EVENT
3062 state->event_action = event_action;
3063 gnutls_session_set_ptr(state->session, state);
3064 gnutls_certificate_set_verify_function(state->lib_state.x509_cred, verify_cb);
3068 /* Register SNI handling; always, even if not in tls_certificate, so that the
3069 expansion variable $tls_sni is always available. */
3071 gnutls_handshake_set_post_client_hello_function(state->session,
3072 exim_sni_handling_cb);
3074 /* Set context and tell client to go ahead, except in the case of TLS startup
3075 on connection, where outputting anything now upsets the clients and tends to
3076 make them disconnect. We need to have an explicit fflush() here, to force out
3077 the response. Other smtp_printf() calls do not need it, because in non-TLS
3078 mode, the fflush() happens when smtp_getc() is called. */
3080 if (!state->tlsp->on_connect)
3082 smtp_printf("220 TLS go ahead\r\n", SP_NO_MORE);
3086 /* Now negotiate the TLS session. We put our own timer on it, since it seems
3087 that the GnuTLS library doesn't.
3088 From 3.1.0 there is gnutls_handshake_set_timeout() - but it requires you
3089 to set (and clear down afterwards) up a pull-timeout callback function that does
3090 a select, so we're no better off unless avoiding signals becomes an issue. */
3092 gnutls_transport_set_ptr2(state->session,
3093 (gnutls_transport_ptr_t)(long) fileno(smtp_in),
3094 (gnutls_transport_ptr_t)(long) fileno(smtp_out));
3095 state->fd_in = fileno(smtp_in);
3096 state->fd_out = fileno(smtp_out);
3098 sigalrm_seen = FALSE;
3099 if (smtp_receive_timeout > 0) ALARM(smtp_receive_timeout);
3101 rc = gnutls_handshake(state->session);
3102 while (rc == GNUTLS_E_AGAIN || rc == GNUTLS_E_INTERRUPTED && !sigalrm_seen);
3105 if (rc != GNUTLS_E_SUCCESS)
3107 DEBUG(D_tls) debug_printf(" error %d from gnutls_handshake: %s\n",
3108 rc, gnutls_strerror(rc));
3110 /* It seems that, except in the case of a timeout, we have to close the
3111 connection right here; otherwise if the other end is running OpenSSL it hangs
3112 until the server times out. */
3116 tls_error(US"gnutls_handshake", US"timed out", NULL, errstr);
3117 #ifndef DISABLE_EVENT
3118 (void) event_raise(event_action, US"tls:fail:connect", *errstr, NULL);
3120 gnutls_db_remove_session(state->session);
3124 tls_error_gnu(state, US"gnutls_handshake", rc, errstr);
3125 #ifndef DISABLE_EVENT
3126 (void) event_raise(event_action, US"tls:fail:connect", *errstr, NULL);
3128 (void) gnutls_alert_send_appropriate(state->session, rc);
3129 gnutls_deinit(state->session);
3131 shutdown(state->fd_out, SHUT_WR);
3132 for (int i = 1024; fgetc(smtp_in) != EOF && i > 0; ) i--; /* drain skt */
3133 (void)fclose(smtp_out);
3134 (void)fclose(smtp_in);
3135 smtp_out = smtp_in = NULL;
3141 #ifdef GNUTLS_SFLAGS_EXT_MASTER_SECRET
3142 if (gnutls_session_get_flags(state->session) & GNUTLS_SFLAGS_EXT_MASTER_SECRET)
3143 tls_in.ext_master_secret = TRUE;
3146 #ifdef EXIM_HAVE_TLS_RESUME
3147 tls_server_resume_posthandshake(state);
3150 DEBUG(D_tls) post_handshake_debug(state);
3152 #ifdef EXIM_HAVE_ALPN
3153 if (server_seen_alpn > 0)
3156 { /* The client offered ALPN. See what was negotiated. */
3157 gnutls_datum_t p = {.size = 0};
3158 int rc = gnutls_alpn_get_selected_protocol(state->session, &p);
3160 debug_printf("ALPN negotiated: %.*s\n", (int)p.size, p.data);
3162 debug_printf("getting alpn protocol: %s\n", US gnutls_strerror(rc));
3166 else if (server_seen_alpn == 0)
3167 if (verify_check_host(&hosts_require_alpn) == OK)
3169 gnutls_alert_send(state->session, GNUTLS_AL_FATAL, GNUTLS_A_NO_APPLICATION_PROTOCOL);
3170 tls_error(US"handshake", US"ALPN required but not negotiated", NULL, errstr);
3174 DEBUG(D_tls) debug_printf("TLS: no ALPN presented in handshake\n");
3176 DEBUG(D_tls) debug_printf("TLS: was not watching for ALPN\n");
3179 /* Verify after the fact */
3181 if (!verify_certificate(state, errstr))
3183 if (state->verify_requirement != VERIFY_OPTIONAL)
3185 (void) tls_error(US"certificate verification failed", *errstr, NULL, errstr);
3189 debug_printf("TLS: continuing on only because verification was optional, after: %s\n",
3193 /* Sets various Exim expansion variables; always safe within server */
3195 extract_exim_vars_from_tls_state(state);
3197 /* TLS has been set up. Adjust the input functions to read via TLS,
3198 and initialize appropriately. */
3200 state->xfer_buffer = store_malloc(ssl_xfer_buffer_size);
3202 receive_getc = tls_getc;
3203 receive_getbuf = tls_getbuf;
3204 receive_get_cache = tls_get_cache;
3205 receive_hasc = tls_hasc;
3206 receive_ungetc = tls_ungetc;
3207 receive_feof = tls_feof;
3208 receive_ferror = tls_ferror;
3217 tls_client_setup_hostname_checks(host_item * host, exim_gnutls_state_st * state,
3218 smtp_transport_options_block * ob)
3220 if (verify_check_given_host(CUSS &ob->tls_verify_cert_hostnames, host) == OK)
3222 state->exp_tls_verify_cert_hostnames =
3224 string_domain_utf8_to_alabel(host->certname, NULL);
3229 debug_printf("TLS: server cert verification includes hostname: \"%s\"\n",
3230 state->exp_tls_verify_cert_hostnames);
3238 /* Given our list of RRs from the TLSA lookup, build a lookup block in
3239 GnuTLS-DANE's preferred format. Hang it on the state str for later
3240 use in DANE verification.
3242 We point at the dnsa data not copy it, so it must remain valid until
3243 after verification is done.*/
3246 dane_tlsa_load(exim_gnutls_state_st * state, dns_answer * dnsa)
3250 const char ** dane_data;
3251 int * dane_data_len;
3254 for (dns_record * rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS); rr;
3255 rr = dns_next_rr(dnsa, &dnss, RESET_NEXT)
3256 ) if (rr->type == T_TLSA) i++;
3258 dane_data = store_get(i * sizeof(uschar *), GET_UNTAINTED);
3259 dane_data_len = store_get(i * sizeof(int), GET_UNTAINTED);
3262 for (dns_record * rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS); rr;
3263 rr = dns_next_rr(dnsa, &dnss, RESET_NEXT)
3264 ) if (rr->type == T_TLSA && rr->size > 3)
3266 const uschar * p = rr->data;
3267 /*XXX need somehow to mark rr and its data as tainted. Doues this mean copying it? */
3268 uint8_t usage = p[0], sel = p[1], type = p[2];
3271 debug_printf("TLSA: %d %d %d size %d\n", usage, sel, type, rr->size);
3273 if ( (usage != DANESSL_USAGE_DANE_TA && usage != DANESSL_USAGE_DANE_EE)
3274 || (sel != 0 && sel != 1)
3279 case 0: /* Full: cannot check at present */
3281 case 1: if (rr->size != 3 + 256/8) continue; /* sha2-256 */
3283 case 2: if (rr->size != 3 + 512/8) continue; /* sha2-512 */
3288 tls_out.tlsa_usage |= 1<<usage;
3289 dane_data[i] = CS p;
3290 dane_data_len[i++] = rr->size;
3293 if (!i) return FALSE;
3295 dane_data[i] = NULL;
3296 dane_data_len[i] = 0;
3298 state->dane_data = (char * const *)dane_data;
3299 state->dane_data_len = dane_data_len;
3306 #ifdef EXIM_HAVE_TLS_RESUME
3307 /* On the client, get any stashed session for the given IP from hints db
3308 and apply it to the ssl-connection for attempted resumption. Although
3309 there is a gnutls_session_ticket_enable_client() interface it is
3310 documented as unnecessary (as of 3.6.7) as "session tickets are emabled
3311 by deafult". There seems to be no way to disable them, so even hosts not
3312 enabled by the transport option will be sent a ticket request. We will
3313 however avoid storing and retrieving session information. */
3316 tls_retrieve_session(tls_support * tlsp, gnutls_session_t session,
3317 smtp_connect_args * conn_args, smtp_transport_options_block * ob)
3319 tlsp->resumption = RESUME_SUPPORTED;
3321 if (!conn_args->have_lbserver)
3322 { DEBUG(D_tls) debug_printf("resumption not supported on continued-connection\n"); }
3323 else if (verify_check_given_host(CUSS &ob->tls_resumption_hosts, conn_args->host) == OK)
3325 dbdata_tls_session * dt;
3327 open_db dbblock, * dbm_file;
3329 tlsp->host_resumable = TRUE;
3330 tls_client_resmption_key(tlsp, conn_args, ob);
3332 tlsp->resumption |= RESUME_CLIENT_REQUESTED;
3333 if ((dbm_file = dbfn_open(US"tls", O_RDONLY, &dbblock, FALSE, FALSE)))
3335 /* We'd like to filter the retrieved session for ticket advisory expiry,
3336 but 3.6.1 seems to give no access to that */
3338 if ((dt = dbfn_read_with_length(dbm_file, tlsp->resume_index, &len)))
3339 if (!(rc = gnutls_session_set_data(session,
3340 CUS dt->session, (size_t)len - sizeof(dbdata_tls_session))))
3342 DEBUG(D_tls) debug_printf("good session\n");
3343 tlsp->resumption |= RESUME_CLIENT_SUGGESTED;
3345 else DEBUG(D_tls) debug_printf("setting session resumption data: %s\n",
3346 US gnutls_strerror(rc));
3347 dbfn_close(dbm_file);
3354 tls_save_session(tls_support * tlsp, gnutls_session_t session, const host_item * host)
3356 /* TLS 1.2 - we get both the callback and the direct posthandshake call,
3357 but this flag is not set until the second. TLS 1.3 it's the other way about.
3358 Keep both calls as the session data cannot be extracted before handshake
3361 if (gnutls_session_get_flags(session) & GNUTLS_SFLAGS_SESSION_TICKET)
3366 DEBUG(D_tls) debug_printf("server offered session ticket\n");
3367 tlsp->ticket_received = TRUE;
3368 tlsp->resumption |= RESUME_SERVER_TICKET;
3370 if (tlsp->host_resumable)
3371 if (!(rc = gnutls_session_get_data2(session, &tkt)))
3373 open_db dbblock, * dbm_file;
3374 int dlen = sizeof(dbdata_tls_session) + tkt.size;
3375 dbdata_tls_session * dt = store_get(dlen, GET_TAINTED);
3377 DEBUG(D_tls) debug_printf("session data size %u\n", (unsigned)tkt.size);
3378 memcpy(dt->session, tkt.data, tkt.size);
3379 gnutls_free(tkt.data);
3381 if ((dbm_file = dbfn_open(US"tls", O_RDWR, &dbblock, FALSE, FALSE)))
3383 /* key for the db is the IP */
3384 dbfn_write(dbm_file, tlsp->resume_index, dt, dlen);
3385 dbfn_close(dbm_file);
3388 debug_printf("wrote session db (len %u)\n", (unsigned)dlen);
3392 debug_printf("extract session data: %s\n", US gnutls_strerror(rc));
3397 /* With a TLS1.3 session, the ticket(s) are not seen until
3398 the first data read is attempted. And there's often two of them.
3399 Pick them up with this callback. We are also called for 1.2
3403 tls_client_ticket_cb(gnutls_session_t sess, u_int htype, unsigned when,
3404 unsigned incoming, const gnutls_datum_t * msg)
3406 exim_gnutls_state_st * state = gnutls_session_get_ptr(sess);
3407 tls_support * tlsp = state->tlsp;
3409 DEBUG(D_tls) debug_printf("newticket cb\n");
3411 if (!tlsp->ticket_received)
3412 tls_save_session(tlsp, sess, state->host);
3418 tls_client_resume_prehandshake(exim_gnutls_state_st * state,
3419 tls_support * tlsp, smtp_connect_args * conn_args,
3420 smtp_transport_options_block * ob)
3422 gnutls_session_set_ptr(state->session, state);
3423 gnutls_handshake_set_hook_function(state->session,
3424 GNUTLS_HANDSHAKE_NEW_SESSION_TICKET, GNUTLS_HOOK_POST, tls_client_ticket_cb);
3426 tls_retrieve_session(tlsp, state->session, conn_args, ob);
3430 tls_client_resume_posthandshake(exim_gnutls_state_st * state,
3431 tls_support * tlsp, host_item * host)
3433 if (gnutls_session_is_resumed(state->session))
3435 DEBUG(D_tls) debug_printf("Session resumed\n");
3436 tlsp->resumption |= RESUME_USED;
3439 tls_save_session(tlsp, state->session, host);
3441 #endif /* !DISABLE_TLS_RESUME */
3444 /*************************************************
3445 * Start a TLS session in a client *
3446 *************************************************/
3448 /* Called from the smtp transport after STARTTLS has been accepted.
3451 cctx connection context
3452 conn_args connection details
3453 cookie datum for randomness (not used)
3454 tlsp record details of channel configuration here; must be non-NULL
3455 errstr error string pointer
3457 Returns: TRUE for success with TLS session context set in smtp context,
3462 tls_client_start(client_conn_ctx * cctx, smtp_connect_args * conn_args,
3463 void * cookie ARG_UNUSED,
3464 tls_support * tlsp, uschar ** errstr)
3466 host_item * host = conn_args->host; /* for msgs and option-tests */
3467 transport_instance * tb = conn_args->tblock; /* always smtp or NULL */
3468 smtp_transport_options_block * ob = tb
3469 ? (smtp_transport_options_block *)tb->options_block
3470 : &smtp_transport_option_defaults;
3472 exim_gnutls_state_st * state = NULL;
3473 uschar * cipher_list = NULL;
3475 #ifndef DISABLE_OCSP
3477 verify_check_given_host(CUSS &ob->hosts_require_ocsp, host) == OK;
3478 BOOL request_ocsp = require_ocsp ? TRUE
3479 : verify_check_given_host(CUSS &ob->hosts_request_ocsp, host) == OK;
3482 DEBUG(D_tls) debug_printf("initialising GnuTLS as a client on fd %d\n", cctx->sock);
3485 /* If dane is flagged, have either request or require dane for this host, and
3486 a TLSA record found. Therefore, dane verify required. Which implies cert must
3487 be requested and supplied, dane verify must pass, and cert verify irrelevant
3488 (incl. hostnames), and (caller handled) require_tls and sni=$domain */
3490 if (conn_args->dane && ob->dane_require_tls_ciphers)
3492 /* not using Expand_check_tlsvar because not yet in state */
3493 if (!expand_check(ob->dane_require_tls_ciphers, US"dane_require_tls_ciphers",
3494 &cipher_list, errstr))
3496 cipher_list = cipher_list && *cipher_list
3497 ? ob->dane_require_tls_ciphers : ob->tls_require_ciphers;
3502 cipher_list = ob->tls_require_ciphers;
3505 #ifdef MEASURE_TIMING
3507 gettimeofday(&t0, NULL);
3510 if (tls_init(host, ob, cipher_list, &state, tlsp, errstr) != OK)
3513 #ifdef MEASURE_TIMING
3514 report_time_since(&t0, US"client tls_init (delta)");
3519 #ifdef EXIM_HAVE_ALPN
3521 const gnutls_datum_t * plist;
3524 if (!tls_alpn_plist(&ob->tls_alpn, &plist, &plen, errstr))
3527 if (gnutls_alpn_set_protocols(state->session, plist, plen, 0) != 0)
3529 tls_error(US"alpn init", NULL, state->host, errstr);
3533 DEBUG(D_tls) debug_printf("Setting TLS ALPN '%s'\n", ob->tls_alpn);
3536 log_write(0, LOG_MAIN, "ALPN unusable with this GnuTLS library version; ignoring \"%s\"\n",
3541 int dh_min_bits = ob->tls_dh_min_bits;
3542 if (dh_min_bits < EXIM_CLIENT_DH_MIN_MIN_BITS)
3545 debug_printf("WARNING: tls_dh_min_bits far too low,"
3546 " clamping %d up to %d\n",
3547 dh_min_bits, EXIM_CLIENT_DH_MIN_MIN_BITS);
3548 dh_min_bits = EXIM_CLIENT_DH_MIN_MIN_BITS;
3551 DEBUG(D_tls) debug_printf("Setting D-H prime minimum"
3552 " acceptable bits to %d\n",
3554 gnutls_dh_set_prime_bits(state->session, dh_min_bits);
3557 /* Stick to the old behaviour for compatibility if tls_verify_certificates is
3558 set but both tls_verify_hosts and tls_try_verify_hosts are unset. Check only
3559 the specified host patterns if one of them is defined */
3562 if (conn_args->dane && dane_tlsa_load(state, &conn_args->tlsa_dnsa))
3565 debug_printf("TLS: server certificate DANE required\n");
3566 state->verify_requirement = VERIFY_DANE;
3567 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_REQUIRE);
3571 if ( ( state->exp_tls_verify_certificates
3572 && !ob->tls_verify_hosts
3573 && (!ob->tls_try_verify_hosts || !*ob->tls_try_verify_hosts)
3575 || verify_check_given_host(CUSS &ob->tls_verify_hosts, host) == OK
3578 tls_client_setup_hostname_checks(host, state, ob);
3580 debug_printf("TLS: server certificate verification required\n");
3581 state->verify_requirement = VERIFY_REQUIRED;
3582 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_REQUIRE);
3584 else if (verify_check_given_host(CUSS &ob->tls_try_verify_hosts, host) == OK)
3586 tls_client_setup_hostname_checks(host, state, ob);
3588 debug_printf("TLS: server certificate verification optional\n");
3589 state->verify_requirement = VERIFY_OPTIONAL;
3590 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_REQUEST);
3595 debug_printf("TLS: server certificate verification not required\n");
3596 state->verify_requirement = VERIFY_NONE;
3597 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_IGNORE);
3600 #ifndef DISABLE_OCSP
3601 /* supported since GnuTLS 3.1.3 */
3604 DEBUG(D_tls) debug_printf("TLS: will request OCSP stapling\n");
3605 if ((rc = gnutls_ocsp_status_request_enable_client(state->session,
3606 NULL, 0, NULL)) != OK)
3608 tls_error_gnu(state, US"cert-status-req", rc, errstr);
3611 tlsp->ocsp = OCSP_NOT_RESP;
3615 #ifdef EXIM_HAVE_TLS_RESUME
3616 tls_client_resume_prehandshake(state, tlsp, conn_args, ob);
3619 #ifndef DISABLE_EVENT
3620 if (tb && tb->event_action)
3622 state->event_action = tb->event_action;
3623 gnutls_session_set_ptr(state->session, state);
3624 gnutls_certificate_set_verify_function(state->lib_state.x509_cred, verify_cb);
3628 gnutls_transport_set_ptr(state->session, (gnutls_transport_ptr_t)(long) cctx->sock);
3629 state->fd_in = cctx->sock;
3630 state->fd_out = cctx->sock;
3632 DEBUG(D_tls) debug_printf("about to gnutls_handshake\n");
3633 /* There doesn't seem to be a built-in timeout on connection. */
3635 sigalrm_seen = FALSE;
3636 ALARM(ob->command_timeout);
3638 rc = gnutls_handshake(state->session);
3639 while (rc == GNUTLS_E_AGAIN || rc == GNUTLS_E_INTERRUPTED && !sigalrm_seen);
3642 if (rc != GNUTLS_E_SUCCESS)
3646 gnutls_alert_send(state->session, GNUTLS_AL_FATAL, GNUTLS_A_USER_CANCELED);
3647 tls_error(US"gnutls_handshake", US"timed out", state->host, errstr);
3650 tls_error_gnu(state, US"gnutls_handshake", rc, errstr);
3654 DEBUG(D_tls) post_handshake_debug(state);
3658 if (!verify_certificate(state, errstr))
3660 tls_error(US"certificate verification failed", *errstr, state->host, errstr);
3664 #ifdef GNUTLS_SFLAGS_EXT_MASTER_SECRET
3665 if (gnutls_session_get_flags(state->session) & GNUTLS_SFLAGS_EXT_MASTER_SECRET)
3666 tlsp->ext_master_secret = TRUE;
3669 #ifndef DISABLE_OCSP
3674 gnutls_datum_t stapling;
3675 gnutls_ocsp_resp_t resp;
3676 gnutls_datum_t printed;
3680 # ifdef GNUTLS_OCSP_STATUS_REQUEST_GET2
3681 (rc = gnutls_ocsp_status_request_get2(state->session, idx, &stapling)) == 0;
3683 (rc = gnutls_ocsp_status_request_get(state->session, &stapling)) == 0;
3686 if ( (rc= gnutls_ocsp_resp_init(&resp)) == 0
3687 && (rc= gnutls_ocsp_resp_import(resp, &stapling)) == 0
3688 && (rc= gnutls_ocsp_resp_print(resp, GNUTLS_OCSP_PRINT_COMPACT, &printed)) == 0
3691 debug_printf("%.4096s", printed.data);
3692 gnutls_free(printed.data);
3695 (void) tls_error_gnu(state, US"ocsp decode", rc, errstr);
3697 (void) tls_error_gnu(state, US"ocsp decode", rc, errstr);
3700 if (gnutls_ocsp_status_request_is_checked(state->session, 0) == 0)
3702 tlsp->ocsp = OCSP_FAILED;
3703 tls_error(US"certificate status check failed", NULL, state->host, errstr);
3709 DEBUG(D_tls) debug_printf("Passed OCSP checking\n");
3710 tlsp->ocsp = OCSP_VFIED;
3715 #ifdef EXIM_HAVE_TLS_RESUME
3716 tls_client_resume_posthandshake(state, tlsp, host);
3719 #ifdef EXIM_HAVE_ALPN
3720 if (ob->tls_alpn) /* We requested. See what was negotiated. */
3722 gnutls_datum_t p = {.size = 0};
3724 if (gnutls_alpn_get_selected_protocol(state->session, &p) == 0)
3725 { DEBUG(D_tls) debug_printf("ALPN negotiated: '%.*s'\n", (int)p.size, p.data); }
3726 else if (verify_check_given_host(CUSS &ob->hosts_require_alpn, host) == OK)
3728 gnutls_alert_send(state->session, GNUTLS_AL_FATAL, GNUTLS_A_NO_APPLICATION_PROTOCOL);
3729 tls_error(US"handshake", US"ALPN required but not negotiated", state->host, errstr);
3733 DEBUG(D_tls) debug_printf("No ALPN negotiated");
3737 /* Sets various Exim expansion variables; may need to adjust for ACL callouts */
3739 extract_exim_vars_from_tls_state(state);
3741 cctx->tls_ctx = state;
3750 ct_ctx client TLS context pointer, or NULL for the one global server context
3754 tls_shutdown_wr(void * ct_ctx)
3756 exim_gnutls_state_st * state = ct_ctx ? ct_ctx : &state_server;
3757 tls_support * tlsp = state->tlsp;
3759 if (!tlsp || tlsp->active.sock < 0) return; /* TLS was not active */
3761 tls_write(ct_ctx, NULL, 0, FALSE); /* flush write buffer */
3763 HDEBUG(D_transport|D_tls|D_acl|D_v) debug_printf_indent(" SMTP(TLS shutdown)>>\n");
3764 gnutls_bye(state->session, GNUTLS_SHUT_WR);
3767 /*************************************************
3768 * Close down a TLS session *
3769 *************************************************/
3771 /* This is also called from within a delivery subprocess forked from the
3772 daemon, to shut down the TLS library, without actually doing a shutdown (which
3773 would tamper with the TLS session in the parent process).
3776 ct_ctx client context pointer, or NULL for the one global server context
3777 do_shutdown 0 no data-flush or TLS close-alert
3778 1 if TLS close-alert is to be sent,
3779 2 if also response to be waited for (2s timeout)
3785 tls_close(void * ct_ctx, int do_shutdown)
3787 exim_gnutls_state_st * state = ct_ctx ? ct_ctx : &state_server;
3788 tls_support * tlsp = state->tlsp;
3790 if (!tlsp || tlsp->active.sock < 0) return; /* TLS was not active */
3794 DEBUG(D_tls) debug_printf("tls_close(): shutting down TLS%s\n",
3795 do_shutdown > TLS_SHUTDOWN_NOWAIT ? " (with response-wait)" : "");
3797 tls_write(ct_ctx, NULL, 0, FALSE); /* flush write buffer */
3799 #ifdef EXIM_TCP_CORK
3800 if (do_shutdown == TLS_SHUTDOWN_WAIT)
3801 (void) setsockopt(tlsp->active.sock, IPPROTO_TCP, EXIM_TCP_CORK, US &off, sizeof(off));
3804 /* The library seems to have no way to only wait for a peer's
3805 shutdown, so handle the same as TLS_SHUTDOWN_WAIT */
3808 gnutls_bye(state->session,
3809 do_shutdown > TLS_SHUTDOWN_NOWAIT ? GNUTLS_SHUT_RDWR : GNUTLS_SHUT_WR);
3813 if (!ct_ctx) /* server */
3815 receive_getc = smtp_getc;
3816 receive_getbuf = smtp_getbuf;
3817 receive_get_cache = smtp_get_cache;
3818 receive_hasc = smtp_hasc;
3819 receive_ungetc = smtp_ungetc;
3820 receive_feof = smtp_feof;
3821 receive_ferror = smtp_ferror;
3824 gnutls_deinit(state->session);
3825 tlsp->active.sock = -1;
3826 tlsp->active.tls_ctx = NULL;
3827 /* Leave bits, peercert, cipher, peerdn, certificate_verified set, for logging */
3828 tlsp->channelbinding = NULL;
3831 if (state->xfer_buffer) store_free(state->xfer_buffer);
3838 tls_refill(unsigned lim)
3840 exim_gnutls_state_st * state = &state_server;
3843 DEBUG(D_tls) debug_printf("Calling gnutls_record_recv(session=%p, buffer=%p, buffersize=%u)\n",
3844 state->session, state->xfer_buffer, ssl_xfer_buffer_size);
3846 sigalrm_seen = FALSE;
3847 if (smtp_receive_timeout > 0) ALARM(smtp_receive_timeout);
3851 inbytes = gnutls_record_recv(state->session, state->xfer_buffer,
3852 MIN(ssl_xfer_buffer_size, lim));
3853 while (inbytes == GNUTLS_E_AGAIN);
3855 if (smtp_receive_timeout > 0) ALARM_CLR(0);
3857 if (had_command_timeout) /* set by signal handler */
3858 smtp_command_timeout_exit(); /* does not return */
3859 if (had_command_sigterm)
3860 smtp_command_sigterm_exit();
3861 if (had_data_timeout)
3862 smtp_data_timeout_exit();
3863 if (had_data_sigint)
3864 smtp_data_sigint_exit();
3866 /* Timeouts do not get this far. A zero-byte return appears to mean that the
3867 TLS session has been closed down, not that the socket itself has been closed
3868 down. Revert to non-TLS handling. */
3872 DEBUG(D_tls) debug_printf("Got tls read timeout\n");
3873 state->xfer_error = TRUE;
3877 else if (inbytes == 0)
3879 DEBUG(D_tls) debug_printf("Got TLS_EOF\n");
3880 tls_close(NULL, TLS_NO_SHUTDOWN);
3884 /* Handle genuine errors */
3886 else if (inbytes < 0)
3888 DEBUG(D_tls) debug_printf("%s: err from gnutls_record_recv\n", __FUNCTION__);
3889 record_io_error(state, (int) inbytes, US"recv", NULL);
3890 state->xfer_error = TRUE;
3893 #ifndef DISABLE_DKIM
3894 dkim_exim_verify_feed(state->xfer_buffer, inbytes);
3896 state->xfer_buffer_hwm = (int) inbytes;
3897 state->xfer_buffer_lwm = 0;
3901 /*************************************************
3902 * TLS version of getc *
3903 *************************************************/
3905 /* This gets the next byte from the TLS input buffer. If the buffer is empty,
3906 it refills the buffer via the GnuTLS reading function.
3907 Only used by the server-side TLS.
3909 This feeds DKIM and should be used for all message-body reads.
3911 Arguments: lim Maximum amount to read/buffer
3912 Returns: the next character or EOF
3916 tls_getc(unsigned lim)
3918 exim_gnutls_state_st * state = &state_server;
3920 if (state->xfer_buffer_lwm >= state->xfer_buffer_hwm)
3921 if (!tls_refill(lim))
3922 return state->xfer_error ? EOF : smtp_getc(lim);
3924 /* Something in the buffer; return next uschar */
3926 return state->xfer_buffer[state->xfer_buffer_lwm++];
3932 exim_gnutls_state_st * state = &state_server;
3933 return state->xfer_buffer_lwm < state->xfer_buffer_hwm;
3937 tls_getbuf(unsigned * len)
3939 exim_gnutls_state_st * state = &state_server;
3943 if (state->xfer_buffer_lwm >= state->xfer_buffer_hwm)
3944 if (!tls_refill(*len))
3946 if (!state->xfer_error) return smtp_getbuf(len);
3951 if ((size = state->xfer_buffer_hwm - state->xfer_buffer_lwm) > *len)
3953 buf = &state->xfer_buffer[state->xfer_buffer_lwm];
3954 state->xfer_buffer_lwm += size;
3960 /* Get up to the given number of bytes from any cached data, and feed to dkim. */
3962 tls_get_cache(unsigned lim)
3964 #ifndef DISABLE_DKIM
3965 exim_gnutls_state_st * state = &state_server;
3966 int n = state->xfer_buffer_hwm - state->xfer_buffer_lwm;
3970 dkim_exim_verify_feed(state->xfer_buffer+state->xfer_buffer_lwm, n);
3976 tls_could_getc(void)
3978 return state_server.xfer_buffer_lwm < state_server.xfer_buffer_hwm
3979 || gnutls_record_check_pending(state_server.session) > 0;
3983 /*************************************************
3984 * Read bytes from TLS channel *
3985 *************************************************/
3987 /* This does not feed DKIM, so if the caller uses this for reading message body,
3988 then the caller must feed DKIM.
3991 ct_ctx client context pointer, or NULL for the one global server context
3995 Returns: the number of bytes read
3996 -1 after a failed read, including EOF
4000 tls_read(void * ct_ctx, uschar *buff, size_t len)
4002 exim_gnutls_state_st * state = ct_ctx ? ct_ctx : &state_server;
4008 if (state->xfer_buffer_lwm < state->xfer_buffer_hwm)
4010 debug_printf("*** PROBABLY A BUG *** " \
4011 "tls_read() called with data in the tls_getc() buffer, %d ignored\n",
4012 state->xfer_buffer_hwm - state->xfer_buffer_lwm);
4015 debug_printf("Calling gnutls_record_recv(session=%p, buffer=%p, len=" SIZE_T_FMT ")\n",
4016 state->session, buff, len);
4020 inbytes = gnutls_record_recv(state->session, buff, len);
4021 while (inbytes == GNUTLS_E_AGAIN);
4023 if (inbytes > 0) return inbytes;
4026 DEBUG(D_tls) debug_printf("Got TLS_EOF\n");
4030 DEBUG(D_tls) debug_printf("%s: err from gnutls_record_recv\n", __FUNCTION__);
4031 record_io_error(state, (int)inbytes, US"recv", NULL);
4040 /*************************************************
4041 * Write bytes down TLS channel *
4042 *************************************************/
4046 ct_ctx client context pointer, or NULL for the one global server context
4049 more more data expected soon
4051 Calling with len zero and more unset will flush buffered writes. The buff
4052 argument can be null for that case.
4054 Returns: the number of bytes after a successful write,
4055 -1 after a failed write
4059 tls_write(void * ct_ctx, const uschar * buff, size_t len, BOOL more)
4063 exim_gnutls_state_st * state = ct_ctx ? ct_ctx : &state_server;
4066 if (more && !state->corked)
4068 DEBUG(D_tls) debug_printf("gnutls_record_cork(session=%p)\n", state->session);
4069 gnutls_record_cork(state->session);
4070 state->corked = TRUE;
4074 DEBUG(D_tls) debug_printf("%s(%p, " SIZE_T_FMT "%s)\n", __FUNCTION__,
4075 buff, left, more ? ", more" : "");
4079 DEBUG(D_tls) debug_printf("gnutls_record_send(session=%p, buffer=%p, left=" SIZE_T_FMT ")\n",
4080 state->session, buff, left);
4084 outbytes = gnutls_record_send(state->session, buff, left);
4085 while (outbytes == GNUTLS_E_AGAIN);
4087 DEBUG(D_tls) debug_printf("outbytes=" SSIZE_T_FMT "\n", outbytes);
4091 #ifdef GNUTLS_E_PREMATURE_TERMINATION
4092 if ( outbytes == GNUTLS_E_PREMATURE_TERMINATION && errno == ECONNRESET
4093 && !ct_ctx && f.smtp_in_quit
4095 { /* Outlook, dammit */
4096 if (LOGGING(protocol_detail))
4097 log_write(0, LOG_MAIN, "[%s] after QUIT, client reset TCP before"
4098 " SMTP response and TLS close\n", sender_host_address);
4100 DEBUG(D_tls) debug_printf("[%s] SSL_write: after QUIT,"
4101 " client reset TCP before TLS close\n", sender_host_address);
4106 DEBUG(D_tls) debug_printf("%s: gnutls_record_send err\n", __FUNCTION__);
4107 record_io_error(state, outbytes, US"send", NULL);
4113 record_io_error(state, 0, US"send", US"TLS channel closed on write");
4124 debug_printf("Whoops! Wrote more bytes (" SIZE_T_FMT ") than INT_MAX\n",
4130 if (!more && state->corked)
4132 DEBUG(D_tls) debug_printf("gnutls_record_uncork(session=%p)\n", state->session);
4134 /* We can't use GNUTLS_RECORD_WAIT here, as it retries on
4135 GNUTLS_E_AGAIN || GNUTLS_E_INTR, which would break our timeout set by alarm().
4136 The GNUTLS_E_AGAIN should not happen ever, as our sockets are blocking anyway.
4137 But who knows. (That all relies on the fact that GNUTLS_E_INTR and GNUTLS_E_AGAIN
4138 match the EINTR and EAGAIN errno values.) */
4139 outbytes = gnutls_record_uncork(state->session, 0);
4140 while (outbytes == GNUTLS_E_AGAIN);
4144 record_io_error(state, len, US"uncork", NULL);
4148 state->corked = FALSE;
4158 /*************************************************
4159 * Random number generation *
4160 *************************************************/
4162 /* Pseudo-random number generation. The result is not expected to be
4163 cryptographically strong but not so weak that someone will shoot themselves
4164 in the foot using it as a nonce in input in some email header scheme or
4165 whatever weirdness they'll twist this into. The result should handle fork()
4166 and avoid repeating sequences. OpenSSL handles that for us.
4170 Returns a random number in range [0, max-1]
4173 #ifdef HAVE_GNUTLS_RND
4175 vaguely_random_number(int max)
4179 uschar smallbuf[sizeof(r)];
4184 needed_len = sizeof(r);
4185 /* Don't take 8 times more entropy than needed if int is 8 octets and we were
4186 asked for a number less than 10. */
4188 for (r = max, i = 0; r; ++i)
4194 i = gnutls_rnd(GNUTLS_RND_NONCE, smallbuf, needed_len);
4197 DEBUG(D_all) debug_printf("gnutls_rnd() failed, using fallback\n");
4198 return vaguely_random_number_fallback(max);
4201 for (uschar * p = smallbuf; needed_len; --needed_len, ++p)
4204 /* We don't particularly care about weighted results; if someone wants
4205 * smooth distribution and cares enough then they should submit a patch then. */
4208 #else /* HAVE_GNUTLS_RND */
4210 vaguely_random_number(int max)
4212 return vaguely_random_number_fallback(max);
4214 #endif /* HAVE_GNUTLS_RND */
4219 /*************************************************
4220 * Let tls_require_ciphers be checked at startup *
4221 *************************************************/
4223 /* The tls_require_ciphers option, if set, must be something which the
4226 Returns: NULL on success, or error message
4230 tls_validate_require_cipher(void)
4233 uschar *expciphers = NULL;
4234 gnutls_priority_t priority_cache;
4236 uschar * dummy_errstr;
4238 #ifdef GNUTLS_AUTO_GLOBAL_INIT
4239 # define validate_check_rc(Label) do { \
4240 if (rc != GNUTLS_E_SUCCESS) { if (exim_gnutls_base_init_done) \
4241 return string_sprintf("%s failed: %s", (Label), gnutls_strerror(rc)); } } while (0)
4242 # define return_deinit(Label) do { return (Label); } while (0)
4244 # define validate_check_rc(Label) do { \
4245 if (rc != GNUTLS_E_SUCCESS) { if (exim_gnutls_base_init_done) gnutls_global_deinit(); \
4246 return string_sprintf("%s failed: %s", (Label), gnutls_strerror(rc)); } } while (0)
4247 # define return_deinit(Label) do { gnutls_global_deinit(); return (Label); } while (0)
4250 if (exim_gnutls_base_init_done)
4251 log_write(0, LOG_MAIN|LOG_PANIC,
4252 "already initialised GnuTLS, Exim developer bug");
4254 #if defined(HAVE_GNUTLS_PKCS11) && !defined(GNUTLS_AUTO_PKCS11_MANUAL)
4255 if (!gnutls_allow_auto_pkcs11)
4257 rc = gnutls_pkcs11_init(GNUTLS_PKCS11_FLAG_MANUAL, NULL);
4258 validate_check_rc(US"gnutls_pkcs11_init");
4261 #ifndef GNUTLS_AUTO_GLOBAL_INIT
4262 rc = gnutls_global_init();
4263 validate_check_rc(US"gnutls_global_init()");
4265 exim_gnutls_base_init_done = TRUE;
4267 if (!(tls_require_ciphers && *tls_require_ciphers))
4268 return_deinit(NULL);
4270 if (!expand_check(tls_require_ciphers, US"tls_require_ciphers", &expciphers,
4272 return_deinit(US"failed to expand tls_require_ciphers");
4274 if (!(expciphers && *expciphers))
4275 return_deinit(NULL);
4278 debug_printf("tls_require_ciphers expands to \"%s\"\n", expciphers);
4280 rc = gnutls_priority_init(&priority_cache, CS expciphers, &errpos);
4281 validate_check_rc(string_sprintf(
4282 "gnutls_priority_init(%s) failed at offset %ld, \"%.8s..\"",
4283 expciphers, (long)(errpos - CS expciphers), errpos));
4285 #undef return_deinit
4286 #undef validate_check_rc
4287 #ifndef GNUTLS_AUTO_GLOBAL_INIT
4288 gnutls_global_deinit();
4297 /*************************************************
4298 * Report the library versions. *
4299 *************************************************/
4301 /* See a description in tls-openssl.c for an explanation of why this exists.
4303 Arguments: string to append to
4308 tls_version_report(gstring * g)
4310 return string_fmt_append(g,
4311 "Library version: GnuTLS: Compile: %s\n"
4314 gnutls_check_version(NULL));
4317 #endif /*!MACRO_PREDEF*/
4320 /* End of tls-gnu.c */