Testsuite outputs: ipv6
[exim.git] / src / src / tls-gnu.c
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
5a66c31b 5/* Copyright (c) University of Cambridge 1995 - 2014 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
17c76198 8/* Copyright (c) Phil Pennock 2012 */
059ec3d9 9
17c76198
PP
10/* This file provides TLS/SSL support for Exim using the GnuTLS library,
11one of the available supported implementations. This file is #included into
12tls.c when USE_GNUTLS has been set.
059ec3d9 13
17c76198
PP
14The code herein is a revamp of GnuTLS integration using the current APIs; the
15original tls-gnu.c was based on a patch which was contributed by Nikos
16Mavroyanopoulos. The revamp is partially a rewrite, partially cut&paste as
17appropriate.
059ec3d9 18
17c76198
PP
19APIs current as of GnuTLS 2.12.18; note that the GnuTLS manual is for GnuTLS 3,
20which is not widely deployed by OS vendors. Will note issues below, which may
21assist in updating the code in the future. Another sources of hints is
22mod_gnutls for Apache (SNI callback registration and handling).
059ec3d9 23
17c76198
PP
24Keeping client and server variables more split than before and is currently
25the norm, in anticipation of TLS in ACL callouts.
059ec3d9 26
17c76198
PP
27I wanted to switch to gnutls_certificate_set_verify_function() so that
28certificate rejection could happen during handshake where it belongs, rather
29than being dropped afterwards, but that was introduced in 2.10.0 and Debian
30(6.0.5) is still on 2.8.6. So for now we have to stick with sub-par behaviour.
059ec3d9 31
17c76198
PP
32(I wasn't looking for libraries quite that old, when updating to get rid of
33compiler warnings of deprecated APIs. If it turns out that a lot of the rest
34require current GnuTLS, then we'll drop support for the ancient libraries).
35*/
b5aea5e1 36
17c76198
PP
37#include <gnutls/gnutls.h>
38/* needed for cert checks in verification and DN extraction: */
39#include <gnutls/x509.h>
40/* man-page is incorrect, gnutls_rnd() is not in gnutls.h: */
41#include <gnutls/crypto.h>
a5f239e4
PP
42/* needed to disable PKCS11 autoload unless requested */
43#if GNUTLS_VERSION_NUMBER >= 0x020c00
44# include <gnutls/pkcs11.h>
45#endif
7e07527a
JH
46#if GNUTLS_VERSION_NUMBER < 0x030103 && !defined(DISABLE_OCSP)
47# warning "GnuTLS library version too old; define DISABLE_OCSP in Makefile"
48# define DISABLE_OCSP
49#endif
a7538db1
JH
50#if GNUTLS_VERSION_NUMBER < 0x020a00 && defined(EXPERIMENTAL_TPDA)
51# warning "GnuTLS library version too old; TPDA tls:cert event unsupported"
52# undef EXPERIMENTAL_TPDA
53#endif
a7fec7a7
JH
54#if GNUTLS_VERSION_NUMBER >= 0x030306
55# define SUPPORT_CA_DIR
56#else
57# undef SUPPORT_CA_DIR
58#endif
7e07527a 59
f2de3a33 60#ifndef DISABLE_OCSP
2b4a568d
JH
61# include <gnutls/ocsp.h>
62#endif
059ec3d9 63
17c76198 64/* GnuTLS 2 vs 3
059ec3d9 65
17c76198
PP
66GnuTLS 3 only:
67 gnutls_global_set_audit_log_function()
059ec3d9 68
17c76198
PP
69Changes:
70 gnutls_certificate_verify_peers2(): is new, drop the 2 for old version
71*/
059ec3d9 72
17c76198 73/* Local static variables for GnuTLS */
059ec3d9 74
17c76198 75/* Values for verify_requirement */
059ec3d9 76
e51c7be2
JH
77enum peer_verify_requirement
78 { VERIFY_NONE, VERIFY_OPTIONAL, VERIFY_REQUIRED
79#ifdef EXPERIMENTAL_CERTNAMES
80 ,VERIFY_WITHHOST
81#endif
82 };
059ec3d9 83
17c76198
PP
84/* This holds most state for server or client; with this, we can set up an
85outbound TLS-enabled connection in an ACL callout, while not stomping all
86over the TLS variables available for expansion.
059ec3d9 87
17c76198
PP
88Some of these correspond to variables in globals.c; those variables will
89be set to point to content in one of these instances, as appropriate for
90the stage of the process lifetime.
059ec3d9 91
389ca47a 92Not handled here: global tls_channelbinding_b64.
17c76198 93*/
059ec3d9 94
17c76198 95typedef struct exim_gnutls_state {
9d1c15ef 96 gnutls_session_t session;
17c76198 97 gnutls_certificate_credentials_t x509_cred;
9d1c15ef 98 gnutls_priority_t priority_cache;
17c76198 99 enum peer_verify_requirement verify_requirement;
9d1c15ef
JH
100 int fd_in;
101 int fd_out;
102 BOOL peer_cert_verified;
103 BOOL trigger_sni_changes;
104 BOOL have_set_peerdn;
17c76198 105 const struct host_item *host;
9d1c15ef
JH
106 gnutls_x509_crt_t peercert;
107 uschar *peerdn;
108 uschar *ciphersuite;
109 uschar *received_sni;
17c76198
PP
110
111 const uschar *tls_certificate;
112 const uschar *tls_privatekey;
113 const uschar *tls_sni; /* client send only, not received */
114 const uschar *tls_verify_certificates;
115 const uschar *tls_crl;
116 const uschar *tls_require_ciphers;
e51c7be2 117
17c76198
PP
118 uschar *exp_tls_certificate;
119 uschar *exp_tls_privatekey;
17c76198
PP
120 uschar *exp_tls_verify_certificates;
121 uschar *exp_tls_crl;
122 uschar *exp_tls_require_ciphers;
44662487 123 uschar *exp_tls_ocsp_file;
e51c7be2
JH
124#ifdef EXPERIMENTAL_CERTNAMES
125 uschar *exp_tls_verify_cert_hostnames;
126#endif
a7538db1
JH
127#ifdef EXPERIMENTAL_TPDA
128 uschar *event_action;
129#endif
17c76198 130
389ca47a 131 tls_support *tlsp; /* set in tls_init() */
817d9f57 132
17c76198
PP
133 uschar *xfer_buffer;
134 int xfer_buffer_lwm;
135 int xfer_buffer_hwm;
136 int xfer_eof;
137 int xfer_error;
17c76198
PP
138} exim_gnutls_state_st;
139
140static const exim_gnutls_state_st exim_gnutls_state_init = {
4fe99a6c 141 NULL, NULL, NULL, VERIFY_NONE, -1, -1, FALSE, FALSE, FALSE,
75fe387d 142 NULL, NULL, NULL, NULL,
17c76198 143 NULL, NULL, NULL, NULL, NULL, NULL,
44662487 144 NULL, NULL, NULL, NULL, NULL, NULL, NULL,
e51c7be2
JH
145#ifdef EXPERIMENTAL_CERTNAMES
146 NULL,
a7538db1
JH
147#endif
148#ifdef EXPERIMENTAL_TPDA
149 NULL,
e51c7be2 150#endif
817d9f57 151 NULL,
17c76198 152 NULL, 0, 0, 0, 0,
17c76198 153};
83da1223 154
17c76198
PP
155/* Not only do we have our own APIs which don't pass around state, assuming
156it's held in globals, GnuTLS doesn't appear to let us register callback data
157for callbacks, or as part of the session, so we have to keep a "this is the
158context we're currently dealing with" pointer and rely upon being
159single-threaded to keep from processing data on an inbound TLS connection while
160talking to another TLS connection for an outbound check. This does mean that
161there's no way for heart-beats to be responded to, for the duration of the
a7538db1
JH
162second connection.
163XXX But see gnutls_session_get_ptr()
164*/
059ec3d9 165
17c76198 166static exim_gnutls_state_st state_server, state_client;
059ec3d9 167
17c76198
PP
168/* dh_params are initialised once within the lifetime of a process using TLS;
169if we used TLS in a long-lived daemon, we'd have to reconsider this. But we
170don't want to repeat this. */
83da1223 171
17c76198 172static gnutls_dh_params_t dh_server_params = NULL;
059ec3d9 173
17c76198 174/* No idea how this value was chosen; preserving it. Default is 3600. */
059ec3d9 175
17c76198 176static const int ssl_session_timeout = 200;
059ec3d9 177
17c76198 178static const char * const exim_default_gnutls_priority = "NORMAL";
83da1223 179
17c76198 180/* Guard library core initialisation */
83da1223 181
17c76198 182static BOOL exim_gnutls_base_init_done = FALSE;
059ec3d9 183
059ec3d9 184
17c76198
PP
185/* ------------------------------------------------------------------------ */
186/* macros */
83da1223 187
17c76198 188#define MAX_HOST_LEN 255
83da1223 189
17c76198
PP
190/* Set this to control gnutls_global_set_log_level(); values 0 to 9 will setup
191the library logging; a value less than 0 disables the calls to set up logging
192callbacks. */
2c17bb02 193#ifndef EXIM_GNUTLS_LIBRARY_LOG_LEVEL
a7538db1 194# define EXIM_GNUTLS_LIBRARY_LOG_LEVEL -1
2c17bb02 195#endif
83da1223 196
2c17bb02 197#ifndef EXIM_CLIENT_DH_MIN_BITS
a7538db1 198# define EXIM_CLIENT_DH_MIN_BITS 1024
2c17bb02 199#endif
83da1223 200
af3498d6
PP
201/* With GnuTLS 2.12.x+ we have gnutls_sec_param_to_pk_bits() with which we
202can ask for a bit-strength. Without that, we stick to the constant we had
203before, for now. */
2c17bb02 204#ifndef EXIM_SERVER_DH_BITS_PRE2_12
a7538db1 205# define EXIM_SERVER_DH_BITS_PRE2_12 1024
2c17bb02 206#endif
af3498d6 207
17c76198
PP
208#define exim_gnutls_err_check(Label) do { \
209 if (rc != GNUTLS_E_SUCCESS) { return tls_error((Label), gnutls_strerror(rc), host); } } while (0)
059ec3d9 210
17c76198 211#define expand_check_tlsvar(Varname) expand_check(state->Varname, US #Varname, &state->exp_##Varname)
83da1223 212
17c76198 213#if GNUTLS_VERSION_NUMBER >= 0x020c00
e51c7be2
JH
214# define HAVE_GNUTLS_SESSION_CHANNEL_BINDING
215# define HAVE_GNUTLS_SEC_PARAM_CONSTANTS
216# define HAVE_GNUTLS_RND
2519e60d
TL
217/* The security fix we provide with the gnutls_allow_auto_pkcs11 option
218 * (4.82 PP/09) introduces a compatibility regression. The symbol simply
219 * isn't available sometimes, so this needs to become a conditional
220 * compilation; the sanest way to deal with this being a problem on
221 * older OSes is to block it in the Local/Makefile with this compiler
222 * definition */
e51c7be2
JH
223# ifndef AVOID_GNUTLS_PKCS11
224# define HAVE_GNUTLS_PKCS11
225# endif /* AVOID_GNUTLS_PKCS11 */
17c76198 226#endif
83da1223 227
af3498d6
PP
228
229
230
231/* ------------------------------------------------------------------------ */
232/* Callback declarations */
233
234#if EXIM_GNUTLS_LIBRARY_LOG_LEVEL >= 0
235static void exim_gnutls_logger_cb(int level, const char *message);
236#endif
237
238static int exim_sni_handling_cb(gnutls_session_t session);
239
f2de3a33 240#ifndef DISABLE_OCSP
44662487
JH
241static int server_ocsp_stapling_cb(gnutls_session_t session, void * ptr,
242 gnutls_datum_t * ocsp_response);
243#endif
af3498d6
PP
244
245
246
17c76198
PP
247/* ------------------------------------------------------------------------ */
248/* Static functions */
059ec3d9
PH
249
250/*************************************************
251* Handle TLS error *
252*************************************************/
253
254/* Called from lots of places when errors occur before actually starting to do
255the TLS handshake, that is, while the session is still in clear. Always returns
256DEFER for a server and FAIL for a client so that most calls can use "return
257tls_error(...)" to do this processing and then give an appropriate return. A
258single function is used for both server and client, because it is called from
259some shared functions.
260
261Argument:
262 prefix text to include in the logged error
7199e1ee
TF
263 msg additional error string (may be NULL)
264 usually obtained from gnutls_strerror()
17c76198
PP
265 host NULL if setting up a server;
266 the connected host if setting up a client
059ec3d9
PH
267
268Returns: OK/DEFER/FAIL
269*/
270
271static int
17c76198 272tls_error(const uschar *prefix, const char *msg, const host_item *host)
059ec3d9 273{
17c76198
PP
274if (host)
275 {
276 log_write(0, LOG_MAIN, "TLS error on connection to %s [%s] (%s)%s%s",
277 host->name, host->address, prefix, msg ? ": " : "", msg ? msg : "");
278 return FAIL;
279 }
280else
059ec3d9 281 {
7199e1ee 282 uschar *conn_info = smtp_get_connection_info();
17c76198 283 if (Ustrncmp(conn_info, US"SMTP ", 5) == 0)
7199e1ee
TF
284 conn_info += 5;
285 log_write(0, LOG_MAIN, "TLS error on %s (%s)%s%s",
17c76198 286 conn_info, prefix, msg ? ": " : "", msg ? msg : "");
059ec3d9
PH
287 return DEFER;
288 }
059ec3d9
PH
289}
290
291
292
17c76198 293
059ec3d9 294/*************************************************
17c76198 295* Deal with logging errors during I/O *
059ec3d9
PH
296*************************************************/
297
17c76198 298/* We have to get the identity of the peer from saved data.
059ec3d9 299
17c76198
PP
300Argument:
301 state the current GnuTLS exim state container
302 rc the GnuTLS error code, or 0 if it's a local error
303 when text identifying read or write
304 text local error text when ec is 0
059ec3d9 305
17c76198 306Returns: nothing
059ec3d9
PH
307*/
308
17c76198
PP
309static void
310record_io_error(exim_gnutls_state_st *state, int rc, uschar *when, uschar *text)
059ec3d9 311{
17c76198 312const char *msg;
059ec3d9 313
17c76198
PP
314if (rc == GNUTLS_E_FATAL_ALERT_RECEIVED)
315 msg = CS string_sprintf("%s: %s", US gnutls_strerror(rc),
316 US gnutls_alert_get_name(gnutls_alert_get(state->session)));
317else
318 msg = gnutls_strerror(rc);
059ec3d9 319
17c76198
PP
320tls_error(when, msg, state->host);
321}
059ec3d9 322
059ec3d9 323
059ec3d9 324
059ec3d9 325
17c76198
PP
326/*************************************************
327* Set various Exim expansion vars *
328*************************************************/
059ec3d9 329
e51c7be2
JH
330#define exim_gnutls_cert_err(Label) \
331 do \
332 { \
333 if (rc != GNUTLS_E_SUCCESS) \
334 { \
335 DEBUG(D_tls) debug_printf("TLS: cert problem: %s: %s\n", \
336 (Label), gnutls_strerror(rc)); \
337 return rc; \
338 } \
339 } while (0)
9d1c15ef
JH
340
341static int
342import_cert(const gnutls_datum * cert, gnutls_x509_crt_t * crtp)
343{
344int rc;
345
346rc = gnutls_x509_crt_init(crtp);
347exim_gnutls_cert_err(US"gnutls_x509_crt_init (crt)");
348
349rc = gnutls_x509_crt_import(*crtp, cert, GNUTLS_X509_FMT_DER);
350exim_gnutls_cert_err(US"failed to import certificate [gnutls_x509_crt_import(cert)]");
351
352return rc;
353}
354
355#undef exim_gnutls_cert_err
356
357
17c76198
PP
358/* We set various Exim global variables from the state, once a session has
359been established. With TLS callouts, may need to change this to stack
360variables, or just re-call it with the server state after client callout
361has finished.
059ec3d9 362
9d1c15ef 363Make sure anything set here is unset in tls_getc().
17c76198
PP
364
365Sets:
366 tls_active fd
367 tls_bits strength indicator
368 tls_certificate_verified bool indicator
369 tls_channelbinding_b64 for some SASL mechanisms
370 tls_cipher a string
9d1c15ef 371 tls_peercert pointer to library internal
17c76198
PP
372 tls_peerdn a string
373 tls_sni a (UTF-8) string
9d1c15ef 374 tls_ourcert pointer to library internal
17c76198
PP
375
376Argument:
377 state the relevant exim_gnutls_state_st *
378*/
379
380static void
9d1c15ef 381extract_exim_vars_from_tls_state(exim_gnutls_state_st * state)
17c76198 382{
17c76198 383gnutls_cipher_algorithm_t cipher;
17c76198
PP
384#ifdef HAVE_GNUTLS_SESSION_CHANNEL_BINDING
385int old_pool;
386int rc;
387gnutls_datum_t channel;
388#endif
9d1c15ef 389tls_support * tlsp = state->tlsp;
17c76198 390
9d1c15ef 391tlsp->active = state->fd_out;
17c76198
PP
392
393cipher = gnutls_cipher_get(state->session);
394/* returns size in "bytes" */
9d1c15ef 395tlsp->bits = gnutls_cipher_get_key_size(cipher) * 8;
17c76198 396
9d1c15ef 397tlsp->cipher = state->ciphersuite;
17c76198 398
817d9f57 399DEBUG(D_tls) debug_printf("cipher: %s\n", state->ciphersuite);
17c76198 400
9d1c15ef 401tlsp->certificate_verified = state->peer_cert_verified;
059ec3d9 402
17c76198
PP
403/* note that tls_channelbinding_b64 is not saved to the spool file, since it's
404only available for use for authenticators while this TLS session is running. */
405
406tls_channelbinding_b64 = NULL;
407#ifdef HAVE_GNUTLS_SESSION_CHANNEL_BINDING
408channel.data = NULL;
409channel.size = 0;
410rc = gnutls_session_channel_binding(state->session, GNUTLS_CB_TLS_UNIQUE, &channel);
411if (rc) {
412 DEBUG(D_tls) debug_printf("Channel binding error: %s\n", gnutls_strerror(rc));
413} else {
414 old_pool = store_pool;
415 store_pool = POOL_PERM;
416 tls_channelbinding_b64 = auth_b64encode(channel.data, (int)channel.size);
417 store_pool = old_pool;
418 DEBUG(D_tls) debug_printf("Have channel bindings cached for possible auth usage.\n");
419}
420#endif
421
9d1c15ef
JH
422/* peercert is set in peer_status() */
423tlsp->peerdn = state->peerdn;
424tlsp->sni = state->received_sni;
425
426/* record our certificate */
427 {
428 const gnutls_datum * cert = gnutls_certificate_get_ours(state->session);
429 gnutls_x509_crt_t crt;
430
431 tlsp->ourcert = cert && import_cert(cert, &crt)==0 ? crt : NULL;
432 }
059ec3d9
PH
433}
434
435
436
17c76198 437
059ec3d9 438/*************************************************
575643cd 439* Setup up DH parameters *
059ec3d9
PH
440*************************************************/
441
575643cd 442/* Generating the D-H parameters may take a long time. They only need to
059ec3d9
PH
443be re-generated every so often, depending on security policy. What we do is to
444keep these parameters in a file in the spool directory. If the file does not
445exist, we generate them. This means that it is easy to cause a regeneration.
446
447The new file is written as a temporary file and renamed, so that an incomplete
448file is never present. If two processes both compute some new parameters, you
449waste a bit of effort, but it doesn't seem worth messing around with locking to
450prevent this.
451
059ec3d9
PH
452Returns: OK/DEFER/FAIL
453*/
454
455static int
17c76198 456init_server_dh(void)
059ec3d9 457{
17c76198
PP
458int fd, rc;
459unsigned int dh_bits;
b5aea5e1 460gnutls_datum m;
a799883d
PP
461uschar filename_buf[PATH_MAX];
462uschar *filename = NULL;
17c76198 463size_t sz;
a799883d
PP
464uschar *exp_tls_dhparam;
465BOOL use_file_in_spool = FALSE;
466BOOL use_fixed_file = FALSE;
17c76198 467host_item *host = NULL; /* dummy for macros */
059ec3d9 468
17c76198 469DEBUG(D_tls) debug_printf("Initialising GnuTLS server params.\n");
059ec3d9 470
17c76198
PP
471rc = gnutls_dh_params_init(&dh_server_params);
472exim_gnutls_err_check(US"gnutls_dh_params_init");
059ec3d9 473
a799883d
PP
474m.data = NULL;
475m.size = 0;
476
477if (!expand_check(tls_dhparam, US"tls_dhparam", &exp_tls_dhparam))
478 return DEFER;
479
480if (!exp_tls_dhparam)
481 {
482 DEBUG(D_tls) debug_printf("Loading default hard-coded DH params\n");
483 m.data = US std_dh_prime_default();
484 m.size = Ustrlen(m.data);
485 }
486else if (Ustrcmp(exp_tls_dhparam, "historic") == 0)
487 use_file_in_spool = TRUE;
488else if (Ustrcmp(exp_tls_dhparam, "none") == 0)
489 {
490 DEBUG(D_tls) debug_printf("Requested no DH parameters.\n");
491 return OK;
492 }
493else if (exp_tls_dhparam[0] != '/')
494 {
495 m.data = US std_dh_prime_named(exp_tls_dhparam);
496 if (m.data == NULL)
497 return tls_error(US"No standard prime named", CS exp_tls_dhparam, NULL);
498 m.size = Ustrlen(m.data);
499 }
500else
501 {
502 use_fixed_file = TRUE;
503 filename = exp_tls_dhparam;
504 }
505
506if (m.data)
507 {
508 rc = gnutls_dh_params_import_pkcs3(dh_server_params, &m, GNUTLS_X509_FMT_PEM);
509 exim_gnutls_err_check(US"gnutls_dh_params_import_pkcs3");
510 DEBUG(D_tls) debug_printf("Loaded fixed standard D-H parameters\n");
511 return OK;
512 }
513
af3498d6
PP
514#ifdef HAVE_GNUTLS_SEC_PARAM_CONSTANTS
515/* If you change this constant, also change dh_param_fn_ext so that we can use a
17c76198
PP
516different filename and ensure we have sufficient bits. */
517dh_bits = gnutls_sec_param_to_pk_bits(GNUTLS_PK_DH, GNUTLS_SEC_PARAM_NORMAL);
518if (!dh_bits)
519 return tls_error(US"gnutls_sec_param_to_pk_bits() failed", NULL, NULL);
af3498d6 520DEBUG(D_tls)
b34fc30c 521 debug_printf("GnuTLS tells us that for D-H PK, NORMAL is %d bits.\n",
af3498d6
PP
522 dh_bits);
523#else
524dh_bits = EXIM_SERVER_DH_BITS_PRE2_12;
525DEBUG(D_tls)
526 debug_printf("GnuTLS lacks gnutls_sec_param_to_pk_bits(), using %d bits.\n",
527 dh_bits);
528#endif
059ec3d9 529
3375e053
PP
530/* Some clients have hard-coded limits. */
531if (dh_bits > tls_dh_max_bits)
532 {
533 DEBUG(D_tls)
534 debug_printf("tls_dh_max_bits clamping override, using %d bits instead.\n",
535 tls_dh_max_bits);
536 dh_bits = tls_dh_max_bits;
537 }
538
a799883d
PP
539if (use_file_in_spool)
540 {
541 if (!string_format(filename_buf, sizeof(filename_buf),
542 "%s/gnutls-params-%d", spool_directory, dh_bits))
543 return tls_error(US"overlong filename", NULL, NULL);
544 filename = filename_buf;
545 }
059ec3d9 546
b5aea5e1 547/* Open the cache file for reading and if successful, read it and set up the
575643cd 548parameters. */
059ec3d9
PH
549
550fd = Uopen(filename, O_RDONLY, 0);
b5aea5e1 551if (fd >= 0)
059ec3d9 552 {
b5aea5e1 553 struct stat statbuf;
17c76198
PP
554 FILE *fp;
555 int saved_errno;
556
557 if (fstat(fd, &statbuf) < 0) /* EIO */
558 {
559 saved_errno = errno;
560 (void)close(fd);
561 return tls_error(US"TLS cache stat failed", strerror(saved_errno), NULL);
562 }
563 if (!S_ISREG(statbuf.st_mode))
b5aea5e1
PH
564 {
565 (void)close(fd);
17c76198
PP
566 return tls_error(US"TLS cache not a file", NULL, NULL);
567 }
568 fp = fdopen(fd, "rb");
569 if (!fp)
570 {
571 saved_errno = errno;
572 (void)close(fd);
573 return tls_error(US"fdopen(TLS cache stat fd) failed",
574 strerror(saved_errno), NULL);
b5aea5e1 575 }
059ec3d9 576
b5aea5e1
PH
577 m.size = statbuf.st_size;
578 m.data = malloc(m.size);
579 if (m.data == NULL)
17c76198
PP
580 {
581 fclose(fp);
582 return tls_error(US"malloc failed", strerror(errno), NULL);
583 }
584 sz = fread(m.data, m.size, 1, fp);
585 if (!sz)
586 {
587 saved_errno = errno;
588 fclose(fp);
589 free(m.data);
590 return tls_error(US"fread failed", strerror(saved_errno), NULL);
591 }
592 fclose(fp);
b5aea5e1 593
17c76198 594 rc = gnutls_dh_params_import_pkcs3(dh_server_params, &m, GNUTLS_X509_FMT_PEM);
b5aea5e1 595 free(m.data);
17c76198
PP
596 exim_gnutls_err_check(US"gnutls_dh_params_import_pkcs3");
597 DEBUG(D_tls) debug_printf("read D-H parameters from file \"%s\"\n", filename);
b5aea5e1
PH
598 }
599
600/* If the file does not exist, fall through to compute new data and cache it.
601If there was any other opening error, it is serious. */
602
182ad5cf
PH
603else if (errno == ENOENT)
604 {
17c76198 605 rc = -1;
182ad5cf 606 DEBUG(D_tls)
17c76198 607 debug_printf("D-H parameter cache file \"%s\" does not exist\n", filename);
182ad5cf
PH
608 }
609else
17c76198
PP
610 return tls_error(string_open_failed(errno, "\"%s\" for reading", filename),
611 NULL, NULL);
b5aea5e1
PH
612
613/* If ret < 0, either the cache file does not exist, or the data it contains
614is not useful. One particular case of this is when upgrading from an older
615release of Exim in which the data was stored in a different format. We don't
616try to be clever and support both formats; we just regenerate new data in this
617case. */
618
17c76198 619if (rc < 0)
b5aea5e1 620 {
17c76198 621 uschar *temp_fn;
201f5254 622 unsigned int dh_bits_gen = dh_bits;
059ec3d9 623
17c76198
PP
624 if ((PATH_MAX - Ustrlen(filename)) < 10)
625 return tls_error(US"Filename too long to generate replacement",
626 CS filename, NULL);
059ec3d9 627
17c76198
PP
628 temp_fn = string_copy(US "%s.XXXXXXX");
629 fd = mkstemp(CS temp_fn); /* modifies temp_fn */
059ec3d9 630 if (fd < 0)
17c76198 631 return tls_error(US"Unable to open temp file", strerror(errno), NULL);
059ec3d9
PH
632 (void)fchown(fd, exim_uid, exim_gid); /* Probably not necessary */
633
201f5254
PP
634 /* GnuTLS overshoots!
635 * If we ask for 2236, we might get 2237 or more.
636 * But there's no way to ask GnuTLS how many bits there really are.
637 * We can ask how many bits were used in a TLS session, but that's it!
638 * The prime itself is hidden behind too much abstraction.
639 * So we ask for less, and proceed on a wing and a prayer.
640 * First attempt, subtracted 3 for 2233 and got 2240.
641 */
cae6e576 642 if (dh_bits >= EXIM_CLIENT_DH_MIN_BITS + 10)
201f5254
PP
643 {
644 dh_bits_gen = dh_bits - 10;
645 DEBUG(D_tls)
646 debug_printf("being paranoid about DH generation, make it '%d' bits'\n",
647 dh_bits_gen);
648 }
649
650 DEBUG(D_tls)
651 debug_printf("requesting generation of %d bit Diffie-Hellman prime ...\n",
652 dh_bits_gen);
653 rc = gnutls_dh_params_generate2(dh_server_params, dh_bits_gen);
17c76198
PP
654 exim_gnutls_err_check(US"gnutls_dh_params_generate2");
655
656 /* gnutls_dh_params_export_pkcs3() will tell us the exact size, every time,
657 and I confirmed that a NULL call to get the size first is how the GnuTLS
658 sample apps handle this. */
659
660 sz = 0;
661 m.data = NULL;
662 rc = gnutls_dh_params_export_pkcs3(dh_server_params, GNUTLS_X509_FMT_PEM,
663 m.data, &sz);
664 if (rc != GNUTLS_E_SHORT_MEMORY_BUFFER)
665 exim_gnutls_err_check(US"gnutls_dh_params_export_pkcs3(NULL) sizing");
666 m.size = sz;
b5aea5e1
PH
667 m.data = malloc(m.size);
668 if (m.data == NULL)
17c76198 669 return tls_error(US"memory allocation failed", strerror(errno), NULL);
1f00591e 670 /* this will return a size 1 less than the allocation size above */
17c76198 671 rc = gnutls_dh_params_export_pkcs3(dh_server_params, GNUTLS_X509_FMT_PEM,
1f00591e 672 m.data, &sz);
17c76198
PP
673 if (rc != GNUTLS_E_SUCCESS)
674 {
675 free(m.data);
676 exim_gnutls_err_check(US"gnutls_dh_params_export_pkcs3() real");
677 }
1f00591e 678 m.size = sz; /* shrink by 1, probably */
059ec3d9 679
17c76198
PP
680 sz = write_to_fd_buf(fd, m.data, (size_t) m.size);
681 if (sz != m.size)
682 {
683 free(m.data);
684 return tls_error(US"TLS cache write D-H params failed",
685 strerror(errno), NULL);
686 }
b5aea5e1 687 free(m.data);
17c76198
PP
688 sz = write_to_fd_buf(fd, US"\n", 1);
689 if (sz != 1)
690 return tls_error(US"TLS cache write D-H params final newline failed",
691 strerror(errno), NULL);
692
693 rc = close(fd);
694 if (rc)
695 return tls_error(US"TLS cache write close() failed",
696 strerror(errno), NULL);
059ec3d9 697
17c76198
PP
698 if (Urename(temp_fn, filename) < 0)
699 return tls_error(string_sprintf("failed to rename \"%s\" as \"%s\"",
700 temp_fn, filename), strerror(errno), NULL);
059ec3d9 701
17c76198 702 DEBUG(D_tls) debug_printf("wrote D-H parameters to file \"%s\"\n", filename);
059ec3d9
PH
703 }
704
17c76198 705DEBUG(D_tls) debug_printf("initialized server D-H parameters\n");
059ec3d9
PH
706return OK;
707}
708
709
710
711
712/*************************************************
17c76198 713* Variables re-expanded post-SNI *
059ec3d9
PH
714*************************************************/
715
17c76198
PP
716/* Called from both server and client code, via tls_init(), and also from
717the SNI callback after receiving an SNI, if tls_certificate includes "tls_sni".
718
719We can tell the two apart by state->received_sni being non-NULL in callback.
720
721The callback should not call us unless state->trigger_sni_changes is true,
722which we are responsible for setting on the first pass through.
059ec3d9
PH
723
724Arguments:
17c76198 725 state exim_gnutls_state_st *
059ec3d9
PH
726
727Returns: OK/DEFER/FAIL
728*/
729
730static int
17c76198 731tls_expand_session_files(exim_gnutls_state_st *state)
059ec3d9 732{
1365611d 733struct stat statbuf;
059ec3d9 734int rc;
17c76198
PP
735const host_item *host = state->host; /* macro should be reconsidered? */
736uschar *saved_tls_certificate = NULL;
737uschar *saved_tls_privatekey = NULL;
738uschar *saved_tls_verify_certificates = NULL;
739uschar *saved_tls_crl = NULL;
740int cert_count;
741
742/* We check for tls_sni *before* expansion. */
2b4a568d 743if (!host) /* server */
17c76198
PP
744 {
745 if (!state->received_sni)
746 {
d9b2312b
JH
747 if (state->tls_certificate &&
748 (Ustrstr(state->tls_certificate, US"tls_sni") ||
749 Ustrstr(state->tls_certificate, US"tls_in_sni") ||
750 Ustrstr(state->tls_certificate, US"tls_out_sni")
751 ))
17c76198
PP
752 {
753 DEBUG(D_tls) debug_printf("We will re-expand TLS session files if we receive SNI.\n");
754 state->trigger_sni_changes = TRUE;
755 }
756 }
757 else
758 {
1365611d 759 /* useful for debugging */
17c76198
PP
760 saved_tls_certificate = state->exp_tls_certificate;
761 saved_tls_privatekey = state->exp_tls_privatekey;
762 saved_tls_verify_certificates = state->exp_tls_verify_certificates;
763 saved_tls_crl = state->exp_tls_crl;
764 }
765 }
059ec3d9 766
1365611d
PP
767rc = gnutls_certificate_allocate_credentials(&state->x509_cred);
768exim_gnutls_err_check(US"gnutls_certificate_allocate_credentials");
769
17c76198
PP
770/* remember: expand_check_tlsvar() is expand_check() but fiddling with
771state members, assuming consistent naming; and expand_check() returns
772false if expansion failed, unless expansion was forced to fail. */
059ec3d9 773
17c76198
PP
774/* check if we at least have a certificate, before doing expensive
775D-H generation. */
059ec3d9 776
17c76198
PP
777if (!expand_check_tlsvar(tls_certificate))
778 return DEFER;
059ec3d9 779
17c76198 780/* certificate is mandatory in server, optional in client */
059ec3d9 781
17c76198
PP
782if ((state->exp_tls_certificate == NULL) ||
783 (*state->exp_tls_certificate == '\0'))
784 {
2b4a568d 785 if (!host)
17c76198
PP
786 return tls_error(US"no TLS server certificate is specified", NULL, NULL);
787 else
788 DEBUG(D_tls) debug_printf("TLS: no client certificate specified; okay\n");
789 }
059ec3d9 790
17c76198 791if (state->tls_privatekey && !expand_check_tlsvar(tls_privatekey))
059ec3d9
PH
792 return DEFER;
793
17c76198
PP
794/* tls_privatekey is optional, defaulting to same file as certificate */
795
796if (state->tls_privatekey == NULL || *state->tls_privatekey == '\0')
059ec3d9 797 {
17c76198
PP
798 state->tls_privatekey = state->tls_certificate;
799 state->exp_tls_privatekey = state->exp_tls_certificate;
059ec3d9 800 }
c91535f3 801
059ec3d9 802
17c76198 803if (state->exp_tls_certificate && *state->exp_tls_certificate)
059ec3d9
PH
804 {
805 DEBUG(D_tls) debug_printf("certificate file = %s\nkey file = %s\n",
17c76198
PP
806 state->exp_tls_certificate, state->exp_tls_privatekey);
807
808 if (state->received_sni)
de365ded 809 {
17c76198
PP
810 if ((Ustrcmp(state->exp_tls_certificate, saved_tls_certificate) == 0) &&
811 (Ustrcmp(state->exp_tls_privatekey, saved_tls_privatekey) == 0))
812 {
b34fc30c 813 DEBUG(D_tls) debug_printf("TLS SNI: cert and key unchanged\n");
17c76198
PP
814 }
815 else
816 {
b34fc30c 817 DEBUG(D_tls) debug_printf("TLS SNI: have a changed cert/key pair.\n");
17c76198 818 }
8e669ac1 819 }
059ec3d9 820
1365611d
PP
821 rc = gnutls_certificate_set_x509_key_file(state->x509_cred,
822 CS state->exp_tls_certificate, CS state->exp_tls_privatekey,
823 GNUTLS_X509_FMT_PEM);
824 exim_gnutls_err_check(
825 string_sprintf("cert/key setup: cert=%s key=%s",
826 state->exp_tls_certificate, state->exp_tls_privatekey));
827 DEBUG(D_tls) debug_printf("TLS: cert/key registered\n");
b34fc30c 828 } /* tls_certificate */
059ec3d9 829
2b4a568d
JH
830
831/* Set the OCSP stapling server info */
832
f2de3a33 833#ifndef DISABLE_OCSP
2b4a568d
JH
834if ( !host /* server */
835 && tls_ocsp_file
836 )
837 {
44662487
JH
838 if (!expand_check(tls_ocsp_file, US"tls_ocsp_file",
839 &state->exp_tls_ocsp_file))
2b4a568d
JH
840 return DEFER;
841
44662487
JH
842 /* Use the full callback method for stapling just to get observability.
843 More efficient would be to read the file once only, if it never changed
844 (due to SNI). Would need restart on file update, or watch datestamp. */
845
846 gnutls_certificate_set_ocsp_status_request_function(state->x509_cred,
847 server_ocsp_stapling_cb, state->exp_tls_ocsp_file);
2b4a568d 848
44662487 849 DEBUG(D_tls) debug_printf("Set OCSP response file %s\n", &state->exp_tls_ocsp_file);
2b4a568d
JH
850 }
851#endif
852
853
059ec3d9
PH
854/* Set the trusted CAs file if one is provided, and then add the CRL if one is
855provided. Experiment shows that, if the certificate file is empty, an unhelpful
856error message is provided. However, if we just refrain from setting anything up
857in that case, certificate verification fails, which seems to be the correct
858behaviour. */
859
17c76198 860if (state->tls_verify_certificates && *state->tls_verify_certificates)
059ec3d9 861 {
17c76198 862 if (!expand_check_tlsvar(tls_verify_certificates))
059ec3d9 863 return DEFER;
17c76198
PP
864 if (state->tls_crl && *state->tls_crl)
865 if (!expand_check_tlsvar(tls_crl))
866 return DEFER;
059ec3d9 867
1365611d
PP
868 if (!(state->exp_tls_verify_certificates &&
869 *state->exp_tls_verify_certificates))
b34fc30c
PP
870 {
871 DEBUG(D_tls)
1365611d
PP
872 debug_printf("TLS: tls_verify_certificates expanded empty, ignoring\n");
873 /* With no tls_verify_certificates, we ignore tls_crl too */
17c76198 874 return OK;
b34fc30c 875 }
1365611d 876 }
83e2f8a2
PP
877else
878 {
879 DEBUG(D_tls)
880 debug_printf("TLS: tls_verify_certificates not set or empty, ignoring\n");
881 return OK;
882 }
17c76198 883
1365611d
PP
884if (Ustat(state->exp_tls_verify_certificates, &statbuf) < 0)
885 {
886 log_write(0, LOG_MAIN|LOG_PANIC, "could not stat %s "
887 "(tls_verify_certificates): %s", state->exp_tls_verify_certificates,
888 strerror(errno));
889 return DEFER;
890 }
17c76198 891
a7fec7a7 892#ifndef SUPPORT_CA_DIR
619b2b25
PP
893/* The test suite passes in /dev/null; we could check for that path explicitly,
894but who knows if someone has some weird FIFO which always dumps some certs, or
895other weirdness. The thing we really want to check is that it's not a
896directory, since while OpenSSL supports that, GnuTLS does not.
897So s/!S_ISREG/S_ISDIR/ and change some messsaging ... */
898if (S_ISDIR(statbuf.st_mode))
1365611d
PP
899 {
900 DEBUG(D_tls)
619b2b25
PP
901 debug_printf("verify certificates path is a dir: \"%s\"\n",
902 state->exp_tls_verify_certificates);
1365611d 903 log_write(0, LOG_MAIN|LOG_PANIC,
619b2b25 904 "tls_verify_certificates \"%s\" is a directory",
1365611d
PP
905 state->exp_tls_verify_certificates);
906 return DEFER;
907 }
a7fec7a7 908#endif
059ec3d9 909
1365611d
PP
910DEBUG(D_tls) debug_printf("verify certificates = %s size=" OFF_T_FMT "\n",
911 state->exp_tls_verify_certificates, statbuf.st_size);
059ec3d9 912
1365611d
PP
913if (statbuf.st_size == 0)
914 {
915 DEBUG(D_tls)
916 debug_printf("cert file empty, no certs, no verification, ignoring any CRL\n");
917 return OK;
918 }
059ec3d9 919
a7fec7a7
JH
920cert_count =
921
922#ifdef SUPPORT_CA_DIR
923 (statbuf.st_mode & S_IFMT) == S_IFDIR
924 ?
925 gnutls_certificate_set_x509_trust_dir(state->x509_cred,
926 CS state->exp_tls_verify_certificates, GNUTLS_X509_FMT_PEM)
927 :
928#endif
929 gnutls_certificate_set_x509_trust_file(state->x509_cred,
1365611d 930 CS state->exp_tls_verify_certificates, GNUTLS_X509_FMT_PEM);
a7fec7a7 931
1365611d
PP
932if (cert_count < 0)
933 {
934 rc = cert_count;
935 exim_gnutls_err_check(US"gnutls_certificate_set_x509_trust_file");
936 }
937DEBUG(D_tls) debug_printf("Added %d certificate authorities.\n", cert_count);
059ec3d9 938
5c8cda3a
PP
939if (state->tls_crl && *state->tls_crl &&
940 state->exp_tls_crl && *state->exp_tls_crl)
1365611d 941 {
5c8cda3a
PP
942 DEBUG(D_tls) debug_printf("loading CRL file = %s\n", state->exp_tls_crl);
943 cert_count = gnutls_certificate_set_x509_crl_file(state->x509_cred,
944 CS state->exp_tls_crl, GNUTLS_X509_FMT_PEM);
945 if (cert_count < 0)
1365611d 946 {
5c8cda3a 947 rc = cert_count;
1365611d
PP
948 exim_gnutls_err_check(US"gnutls_certificate_set_x509_crl_file");
949 }
5c8cda3a 950 DEBUG(D_tls) debug_printf("Processed %d CRLs.\n", cert_count);
1365611d 951 }
059ec3d9 952
059ec3d9
PH
953return OK;
954}
955
956
957
958
1365611d
PP
959/*************************************************
960* Set X.509 state variables *
961*************************************************/
962
963/* In GnuTLS, the registered cert/key are not replaced by a later
964set of a cert/key, so for SNI support we need a whole new x509_cred
965structure. Which means various other non-re-expanded pieces of state
966need to be re-set in the new struct, so the setting logic is pulled
967out to this.
968
969Arguments:
970 state exim_gnutls_state_st *
971
972Returns: OK/DEFER/FAIL
973*/
974
975static int
976tls_set_remaining_x509(exim_gnutls_state_st *state)
977{
978int rc;
979const host_item *host = state->host; /* macro should be reconsidered? */
980
981/* Create D-H parameters, or read them from the cache file. This function does
982its own SMTP error messaging. This only happens for the server, TLS D-H ignores
983client-side params. */
984
985if (!state->host)
986 {
987 if (!dh_server_params)
988 {
989 rc = init_server_dh();
990 if (rc != OK) return rc;
991 }
992 gnutls_certificate_set_dh_params(state->x509_cred, dh_server_params);
993 }
994
995/* Link the credentials to the session. */
996
997rc = gnutls_credentials_set(state->session, GNUTLS_CRD_CERTIFICATE, state->x509_cred);
998exim_gnutls_err_check(US"gnutls_credentials_set");
999
1000return OK;
1001}
1002
059ec3d9 1003/*************************************************
17c76198 1004* Initialize for GnuTLS *
059ec3d9
PH
1005*************************************************/
1006
17c76198
PP
1007/* Called from both server and client code. In the case of a server, errors
1008before actual TLS negotiation return DEFER.
059ec3d9
PH
1009
1010Arguments:
17c76198
PP
1011 host connected host, if client; NULL if server
1012 certificate certificate file
1013 privatekey private key file
1014 sni TLS SNI to send, sometimes when client; else NULL
1015 cas CA certs file
1016 crl CRL file
1017 require_ciphers tls_require_ciphers setting
817d9f57 1018 caller_state returned state-info structure
059ec3d9 1019
17c76198 1020Returns: OK/DEFER/FAIL
059ec3d9
PH
1021*/
1022
17c76198
PP
1023static int
1024tls_init(
1025 const host_item *host,
1026 const uschar *certificate,
1027 const uschar *privatekey,
1028 const uschar *sni,
1029 const uschar *cas,
1030 const uschar *crl,
1031 const uschar *require_ciphers,
1032 exim_gnutls_state_st **caller_state)
059ec3d9 1033{
17c76198
PP
1034exim_gnutls_state_st *state;
1035int rc;
1036size_t sz;
1037const char *errpos;
1038uschar *p;
1039BOOL want_default_priorities;
1040
1041if (!exim_gnutls_base_init_done)
059ec3d9 1042 {
17c76198
PP
1043 DEBUG(D_tls) debug_printf("GnuTLS global init required.\n");
1044
a5f239e4
PP
1045#ifdef HAVE_GNUTLS_PKCS11
1046 /* By default, gnutls_global_init will init PKCS11 support in auto mode,
1047 which loads modules from a config file, which sounds good and may be wanted
1048 by some sysadmin, but also means in common configurations that GNOME keyring
1049 environment variables are used and so breaks for users calling mailq.
1050 To prevent this, we init PKCS11 first, which is the documented approach. */
2519e60d 1051 if (!gnutls_allow_auto_pkcs11)
a5f239e4
PP
1052 {
1053 rc = gnutls_pkcs11_init(GNUTLS_PKCS11_FLAG_MANUAL, NULL);
1054 exim_gnutls_err_check(US"gnutls_pkcs11_init");
1055 }
1056#endif
1057
17c76198
PP
1058 rc = gnutls_global_init();
1059 exim_gnutls_err_check(US"gnutls_global_init");
1060
1061#if EXIM_GNUTLS_LIBRARY_LOG_LEVEL >= 0
1062 DEBUG(D_tls)
059ec3d9 1063 {
17c76198
PP
1064 gnutls_global_set_log_function(exim_gnutls_logger_cb);
1065 /* arbitrarily chosen level; bump upto 9 for more */
1066 gnutls_global_set_log_level(EXIM_GNUTLS_LIBRARY_LOG_LEVEL);
059ec3d9 1067 }
17c76198
PP
1068#endif
1069
1070 exim_gnutls_base_init_done = TRUE;
059ec3d9 1071 }
059ec3d9 1072
17c76198
PP
1073if (host)
1074 {
1075 state = &state_client;
1076 memcpy(state, &exim_gnutls_state_init, sizeof(exim_gnutls_state_init));
817d9f57 1077 state->tlsp = &tls_out;
17c76198
PP
1078 DEBUG(D_tls) debug_printf("initialising GnuTLS client session\n");
1079 rc = gnutls_init(&state->session, GNUTLS_CLIENT);
1080 }
1081else
1082 {
1083 state = &state_server;
1084 memcpy(state, &exim_gnutls_state_init, sizeof(exim_gnutls_state_init));
817d9f57 1085 state->tlsp = &tls_in;
17c76198
PP
1086 DEBUG(D_tls) debug_printf("initialising GnuTLS server session\n");
1087 rc = gnutls_init(&state->session, GNUTLS_SERVER);
1088 }
1089exim_gnutls_err_check(US"gnutls_init");
059ec3d9 1090
17c76198 1091state->host = host;
059ec3d9 1092
17c76198
PP
1093state->tls_certificate = certificate;
1094state->tls_privatekey = privatekey;
5779e6aa 1095state->tls_require_ciphers = require_ciphers;
17c76198
PP
1096state->tls_sni = sni;
1097state->tls_verify_certificates = cas;
1098state->tls_crl = crl;
059ec3d9 1099
17c76198
PP
1100/* This handles the variables that might get re-expanded after TLS SNI;
1101that's tls_certificate, tls_privatekey, tls_verify_certificates, tls_crl */
059ec3d9 1102
17c76198
PP
1103DEBUG(D_tls)
1104 debug_printf("Expanding various TLS configuration options for session credentials.\n");
1105rc = tls_expand_session_files(state);
1106if (rc != OK) return rc;
059ec3d9 1107
1365611d
PP
1108/* These are all other parts of the x509_cred handling, since SNI in GnuTLS
1109requires a new structure afterwards. */
83da1223 1110
1365611d
PP
1111rc = tls_set_remaining_x509(state);
1112if (rc != OK) return rc;
83da1223 1113
17c76198
PP
1114/* set SNI in client, only */
1115if (host)
1116 {
0df4ab80 1117 if (!expand_check(sni, US"tls_out_sni", &state->tlsp->sni))
17c76198 1118 return DEFER;
0df4ab80 1119 if (state->tlsp->sni && *state->tlsp->sni)
17c76198
PP
1120 {
1121 DEBUG(D_tls)
0df4ab80
JH
1122 debug_printf("Setting TLS client SNI to \"%s\"\n", state->tlsp->sni);
1123 sz = Ustrlen(state->tlsp->sni);
17c76198 1124 rc = gnutls_server_name_set(state->session,
0df4ab80 1125 GNUTLS_NAME_DNS, state->tlsp->sni, sz);
17c76198
PP
1126 exim_gnutls_err_check(US"gnutls_server_name_set");
1127 }
1128 }
1129else if (state->tls_sni)
1130 DEBUG(D_tls) debug_printf("*** PROBABLY A BUG *** " \
1131 "have an SNI set for a client [%s]\n", state->tls_sni);
83da1223 1132
17c76198 1133/* This is the priority string support,
42bfef1e 1134http://www.gnutls.org/manual/html_node/Priority-Strings.html
17c76198
PP
1135and replaces gnutls_require_kx, gnutls_require_mac & gnutls_require_protocols.
1136This was backwards incompatible, but means Exim no longer needs to track
1137all algorithms and provide string forms for them. */
83da1223 1138
17c76198 1139want_default_priorities = TRUE;
83da1223 1140
17c76198 1141if (state->tls_require_ciphers && *state->tls_require_ciphers)
83da1223 1142 {
17c76198
PP
1143 if (!expand_check_tlsvar(tls_require_ciphers))
1144 return DEFER;
1145 if (state->exp_tls_require_ciphers && *state->exp_tls_require_ciphers)
83da1223 1146 {
17c76198
PP
1147 DEBUG(D_tls) debug_printf("GnuTLS session cipher/priority \"%s\"\n",
1148 state->exp_tls_require_ciphers);
1149
1150 rc = gnutls_priority_init(&state->priority_cache,
1151 CS state->exp_tls_require_ciphers, &errpos);
1152 want_default_priorities = FALSE;
1153 p = state->exp_tls_require_ciphers;
83da1223
PH
1154 }
1155 }
17c76198
PP
1156if (want_default_priorities)
1157 {
83e2f8a2
PP
1158 DEBUG(D_tls)
1159 debug_printf("GnuTLS using default session cipher/priority \"%s\"\n",
1160 exim_default_gnutls_priority);
17c76198
PP
1161 rc = gnutls_priority_init(&state->priority_cache,
1162 exim_default_gnutls_priority, &errpos);
1163 p = US exim_default_gnutls_priority;
1164 }
83da1223 1165
17c76198
PP
1166exim_gnutls_err_check(string_sprintf(
1167 "gnutls_priority_init(%s) failed at offset %ld, \"%.6s..\"",
1168 p, errpos - CS p, errpos));
1169
1170rc = gnutls_priority_set(state->session, state->priority_cache);
1171exim_gnutls_err_check(US"gnutls_priority_set");
1172
1173gnutls_db_set_cache_expiration(state->session, ssl_session_timeout);
1174
1175/* Reduce security in favour of increased compatibility, if the admin
1176decides to make that trade-off. */
1177if (gnutls_compat_mode)
83da1223 1178 {
17c76198
PP
1179#if LIBGNUTLS_VERSION_NUMBER >= 0x020104
1180 DEBUG(D_tls) debug_printf("lowering GnuTLS security, compatibility mode\n");
1181 gnutls_session_enable_compatibility_mode(state->session);
1182#else
1183 DEBUG(D_tls) debug_printf("Unable to set gnutls_compat_mode - GnuTLS version too old\n");
1184#endif
83da1223
PH
1185 }
1186
17c76198 1187*caller_state = state;
17c76198 1188return OK;
83da1223
PH
1189}
1190
1191
1192
059ec3d9 1193/*************************************************
17c76198 1194* Extract peer information *
059ec3d9
PH
1195*************************************************/
1196
17c76198 1197/* Called from both server and client code.
4fe99a6c
PP
1198Only this is allowed to set state->peerdn and state->have_set_peerdn
1199and we use that to detect double-calls.
059ec3d9 1200
75fe387d
PP
1201NOTE: the state blocks last while the TLS connection is up, which is fine
1202for logging in the server side, but for the client side, we log after teardown
1203in src/deliver.c. While the session is up, we can twist about states and
1204repoint tls_* globals, but those variables used for logging or other variable
1205expansion that happens _after_ delivery need to have a longer life-time.
1206
1207So for those, we get the data from POOL_PERM; the re-invoke guard keeps us from
1208doing this more than once per generation of a state context. We set them in
1209the state context, and repoint tls_* to them. After the state goes away, the
1210tls_* copies of the pointers remain valid and client delivery logging is happy.
1211
1212tls_certificate_verified is a BOOL, so the tls_peerdn and tls_cipher issues
1213don't apply.
1214
059ec3d9 1215Arguments:
17c76198 1216 state exim_gnutls_state_st *
059ec3d9 1217
17c76198 1218Returns: OK/DEFER/FAIL
059ec3d9
PH
1219*/
1220
17c76198
PP
1221static int
1222peer_status(exim_gnutls_state_st *state)
059ec3d9 1223{
75fe387d 1224uschar cipherbuf[256];
17c76198 1225const gnutls_datum *cert_list;
75fe387d 1226int old_pool, rc;
17c76198 1227unsigned int cert_list_size = 0;
4fe99a6c
PP
1228gnutls_protocol_t protocol;
1229gnutls_cipher_algorithm_t cipher;
1230gnutls_kx_algorithm_t kx;
1231gnutls_mac_algorithm_t mac;
17c76198
PP
1232gnutls_certificate_type_t ct;
1233gnutls_x509_crt_t crt;
4fe99a6c 1234uschar *p, *dn_buf;
17c76198 1235size_t sz;
059ec3d9 1236
4fe99a6c 1237if (state->have_set_peerdn)
17c76198 1238 return OK;
4fe99a6c 1239state->have_set_peerdn = TRUE;
059ec3d9 1240
4fe99a6c 1241state->peerdn = NULL;
059ec3d9 1242
4fe99a6c
PP
1243/* tls_cipher */
1244cipher = gnutls_cipher_get(state->session);
1245protocol = gnutls_protocol_get_version(state->session);
1246mac = gnutls_mac_get(state->session);
1247kx = gnutls_kx_get(state->session);
1248
75fe387d 1249string_format(cipherbuf, sizeof(cipherbuf),
4fe99a6c
PP
1250 "%s:%s:%d",
1251 gnutls_protocol_get_name(protocol),
1252 gnutls_cipher_suite_get_name(kx, cipher, mac),
1253 (int) gnutls_cipher_get_key_size(cipher) * 8);
1254
1255/* I don't see a way that spaces could occur, in the current GnuTLS
1256code base, but it was a concern in the old code and perhaps older GnuTLS
1257releases did return "TLS 1.0"; play it safe, just in case. */
75fe387d 1258for (p = cipherbuf; *p != '\0'; ++p)
4fe99a6c
PP
1259 if (isspace(*p))
1260 *p = '-';
75fe387d
PP
1261old_pool = store_pool;
1262store_pool = POOL_PERM;
1263state->ciphersuite = string_copy(cipherbuf);
1264store_pool = old_pool;
817d9f57 1265state->tlsp->cipher = state->ciphersuite;
4fe99a6c
PP
1266
1267/* tls_peerdn */
17c76198 1268cert_list = gnutls_certificate_get_peers(state->session, &cert_list_size);
83da1223 1269
17c76198
PP
1270if (cert_list == NULL || cert_list_size == 0)
1271 {
17c76198
PP
1272 DEBUG(D_tls) debug_printf("TLS: no certificate from peer (%p & %d)\n",
1273 cert_list, cert_list_size);
e51c7be2 1274 if (state->verify_requirement >= VERIFY_REQUIRED)
17c76198
PP
1275 return tls_error(US"certificate verification failed",
1276 "no certificate received from peer", state->host);
1277 return OK;
1278 }
059ec3d9 1279
17c76198
PP
1280ct = gnutls_certificate_type_get(state->session);
1281if (ct != GNUTLS_CRT_X509)
059ec3d9 1282 {
17c76198 1283 const char *ctn = gnutls_certificate_type_get_name(ct);
17c76198
PP
1284 DEBUG(D_tls)
1285 debug_printf("TLS: peer cert not X.509 but instead \"%s\"\n", ctn);
e51c7be2 1286 if (state->verify_requirement >= VERIFY_REQUIRED)
17c76198
PP
1287 return tls_error(US"certificate verification not possible, unhandled type",
1288 ctn, state->host);
1289 return OK;
83da1223 1290 }
059ec3d9 1291
e51c7be2
JH
1292#define exim_gnutls_peer_err(Label) \
1293 do { \
1294 if (rc != GNUTLS_E_SUCCESS) \
1295 { \
1296 DEBUG(D_tls) debug_printf("TLS: peer cert problem: %s: %s\n", \
1297 (Label), gnutls_strerror(rc)); \
1298 if (state->verify_requirement >= VERIFY_REQUIRED) \
1299 return tls_error((Label), gnutls_strerror(rc), state->host); \
1300 return OK; \
1301 } \
1302 } while (0)
17c76198 1303
9d1c15ef
JH
1304rc = import_cert(&cert_list[0], &crt);
1305exim_gnutls_peer_err(US"cert 0");
1306
1307state->tlsp->peercert = state->peercert = crt;
17c76198 1308
17c76198
PP
1309sz = 0;
1310rc = gnutls_x509_crt_get_dn(crt, NULL, &sz);
1311if (rc != GNUTLS_E_SHORT_MEMORY_BUFFER)
83da1223 1312 {
17c76198
PP
1313 exim_gnutls_peer_err(US"getting size for cert DN failed");
1314 return FAIL; /* should not happen */
059ec3d9 1315 }
17c76198
PP
1316dn_buf = store_get_perm(sz);
1317rc = gnutls_x509_crt_get_dn(crt, CS dn_buf, &sz);
1318exim_gnutls_peer_err(US"failed to extract certificate DN [gnutls_x509_crt_get_dn(cert 0)]");
9d1c15ef 1319
17c76198
PP
1320state->peerdn = dn_buf;
1321
1322return OK;
1323#undef exim_gnutls_peer_err
1324}
059ec3d9 1325
059ec3d9 1326
059ec3d9 1327
059ec3d9 1328
17c76198
PP
1329/*************************************************
1330* Verify peer certificate *
1331*************************************************/
059ec3d9 1332
17c76198
PP
1333/* Called from both server and client code.
1334*Should* be using a callback registered with
1335gnutls_certificate_set_verify_function() to fail the handshake if we dislike
1336the peer information, but that's too new for some OSes.
059ec3d9 1337
17c76198
PP
1338Arguments:
1339 state exim_gnutls_state_st *
1340 error where to put an error message
059ec3d9 1341
17c76198
PP
1342Returns:
1343 FALSE if the session should be rejected
1344 TRUE if the cert is okay or we just don't care
1345*/
059ec3d9 1346
17c76198
PP
1347static BOOL
1348verify_certificate(exim_gnutls_state_st *state, const char **error)
1349{
1350int rc;
1351unsigned int verify;
1352
1353*error = NULL;
1354
0a92f87f 1355if ((rc = peer_status(state)) != OK)
e6060e2c 1356 {
17c76198 1357 verify = GNUTLS_CERT_INVALID;
0a92f87f 1358 *error = "certificate not supplied";
17c76198
PP
1359 }
1360else
17c76198 1361 rc = gnutls_certificate_verify_peers2(state->session, &verify);
e6060e2c 1362
17c76198
PP
1363/* Handle the result of verification. INVALID seems to be set as well
1364as REVOKED, but leave the test for both. */
059ec3d9 1365
e51c7be2
JH
1366if (rc < 0 ||
1367 verify & (GNUTLS_CERT_INVALID|GNUTLS_CERT_REVOKED)
1368 )
17c76198
PP
1369 {
1370 state->peer_cert_verified = FALSE;
0a92f87f
JH
1371 if (!*error)
1372 *error = verify & GNUTLS_CERT_REVOKED
1373 ? "certificate revoked" : "certificate invalid";
059ec3d9 1374
17c76198 1375 DEBUG(D_tls)
e51c7be2 1376 debug_printf("TLS certificate verification failed (%s): peerdn=\"%s\"\n",
4fe99a6c 1377 *error, state->peerdn ? state->peerdn : US"<unset>");
059ec3d9 1378
e51c7be2 1379 if (state->verify_requirement >= VERIFY_REQUIRED)
17c76198 1380 {
e51c7be2
JH
1381 gnutls_alert_send(state->session,
1382 GNUTLS_AL_FATAL, GNUTLS_A_BAD_CERTIFICATE);
17c76198
PP
1383 return FALSE;
1384 }
1385 DEBUG(D_tls)
4789da3a 1386 debug_printf("TLS verify failure overridden (host in tls_try_verify_hosts)\n");
17c76198 1387 }
e51c7be2 1388
17c76198
PP
1389else
1390 {
e51c7be2
JH
1391#ifdef EXPERIMENTAL_CERTNAMES
1392 if (state->verify_requirement == VERIFY_WITHHOST)
1393 {
1394 int sep = 0;
1395 uschar * list = state->exp_tls_verify_cert_hostnames;
1396 uschar * name;
1397 while (name = string_nextinlist(&list, &sep, NULL, 0))
1398 if (gnutls_x509_crt_check_hostname(state->tlsp->peercert, CS name))
1399 break;
1400 if (!name)
1401 {
1402 DEBUG(D_tls)
1403 debug_printf("TLS certificate verification failed: cert name mismatch\n");
1404 gnutls_alert_send(state->session,
1405 GNUTLS_AL_FATAL, GNUTLS_A_BAD_CERTIFICATE);
1406 return FALSE;
1407 }
1408 }
1409#endif
17c76198 1410 state->peer_cert_verified = TRUE;
e51c7be2 1411 DEBUG(D_tls) debug_printf("TLS certificate verified: peerdn=\"%s\"\n",
4fe99a6c 1412 state->peerdn ? state->peerdn : US"<unset>");
17c76198 1413 }
059ec3d9 1414
817d9f57 1415state->tlsp->peerdn = state->peerdn;
059ec3d9 1416
17c76198
PP
1417return TRUE;
1418}
059ec3d9 1419
17c76198
PP
1420
1421
1422
1423/* ------------------------------------------------------------------------ */
1424/* Callbacks */
1425
1426/* Logging function which can be registered with
1427 * gnutls_global_set_log_function()
1428 * gnutls_global_set_log_level() 0..9
1429 */
af3498d6 1430#if EXIM_GNUTLS_LIBRARY_LOG_LEVEL >= 0
059ec3d9 1431static void
17c76198 1432exim_gnutls_logger_cb(int level, const char *message)
059ec3d9 1433{
8c79eebf
PP
1434 size_t len = strlen(message);
1435 if (len < 1)
1436 {
1437 DEBUG(D_tls) debug_printf("GnuTLS<%d> empty debug message\n", level);
1438 return;
1439 }
1440 DEBUG(D_tls) debug_printf("GnuTLS<%d>: %s%s", level, message,
1441 message[len-1] == '\n' ? "" : "\n");
17c76198 1442}
af3498d6 1443#endif
059ec3d9 1444
059ec3d9 1445
17c76198
PP
1446/* Called after client hello, should handle SNI work.
1447This will always set tls_sni (state->received_sni) if available,
1448and may trigger presenting different certificates,
1449if state->trigger_sni_changes is TRUE.
059ec3d9 1450
17c76198
PP
1451Should be registered with
1452 gnutls_handshake_set_post_client_hello_function()
059ec3d9 1453
17c76198
PP
1454"This callback must return 0 on success or a gnutls error code to terminate the
1455handshake.".
059ec3d9 1456
17c76198
PP
1457For inability to get SNI information, we return 0.
1458We only return non-zero if re-setup failed.
817d9f57 1459Only used for server-side TLS.
17c76198 1460*/
44bbabb5 1461
17c76198
PP
1462static int
1463exim_sni_handling_cb(gnutls_session_t session)
1464{
1465char sni_name[MAX_HOST_LEN];
1466size_t data_len = MAX_HOST_LEN;
817d9f57 1467exim_gnutls_state_st *state = &state_server;
17c76198
PP
1468unsigned int sni_type;
1469int rc, old_pool;
1470
1471rc = gnutls_server_name_get(session, sni_name, &data_len, &sni_type, 0);
b34fc30c
PP
1472if (rc != GNUTLS_E_SUCCESS)
1473 {
1474 DEBUG(D_tls) {
1475 if (rc == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
1476 debug_printf("TLS: no SNI presented in handshake.\n");
1477 else
1478 debug_printf("TLS failure: gnutls_server_name_get(): %s [%d]\n",
1479 gnutls_strerror(rc), rc);
1480 };
1481 return 0;
1482 }
1483
17c76198
PP
1484if (sni_type != GNUTLS_NAME_DNS)
1485 {
1486 DEBUG(D_tls) debug_printf("TLS: ignoring SNI of unhandled type %u\n", sni_type);
1487 return 0;
1488 }
44bbabb5 1489
17c76198
PP
1490/* We now have a UTF-8 string in sni_name */
1491old_pool = store_pool;
1492store_pool = POOL_PERM;
1493state->received_sni = string_copyn(US sni_name, data_len);
1494store_pool = old_pool;
1495
1496/* We set this one now so that variable expansions below will work */
817d9f57 1497state->tlsp->sni = state->received_sni;
17c76198
PP
1498
1499DEBUG(D_tls) debug_printf("Received TLS SNI \"%s\"%s\n", sni_name,
1500 state->trigger_sni_changes ? "" : " (unused for certificate selection)");
1501
1502if (!state->trigger_sni_changes)
1503 return 0;
1504
1505rc = tls_expand_session_files(state);
1506if (rc != OK)
1507 {
1508 /* If the setup of certs/etc failed before handshake, TLS would not have
1509 been offered. The best we can do now is abort. */
1510 return GNUTLS_E_APPLICATION_ERROR_MIN;
1511 }
1512
1365611d
PP
1513rc = tls_set_remaining_x509(state);
1514if (rc != OK) return GNUTLS_E_APPLICATION_ERROR_MIN;
1515
1516return 0;
059ec3d9
PH
1517}
1518
1519
1520
f2de3a33 1521#ifndef DISABLE_OCSP
44662487
JH
1522
1523static int
1524server_ocsp_stapling_cb(gnutls_session_t session, void * ptr,
1525 gnutls_datum_t * ocsp_response)
1526{
1527int ret;
1528
44662487
JH
1529if ((ret = gnutls_load_file(ptr, ocsp_response)) < 0)
1530 {
1531 DEBUG(D_tls) debug_printf("Failed to load ocsp stapling file %s\n",
1532 (char *)ptr);
018058b2 1533 tls_in.ocsp = OCSP_NOT_RESP;
44662487
JH
1534 return GNUTLS_E_NO_CERTIFICATE_STATUS;
1535 }
1536
018058b2 1537tls_in.ocsp = OCSP_VFY_NOT_TRIED;
44662487
JH
1538return 0;
1539}
1540
1541#endif
1542
1543
a7538db1
JH
1544#ifdef EXPERIMENTAL_TPDA
1545/*
1546We use this callback to get observability and detail-level control
1547for an exim client TLS connection, raising a TPDA tls:cert event
1548for each cert in the chain presented by the server. Any event
1549can deny verification.
1550
1551Return 0 for the handshake to continue or non-zero to terminate.
1552*/
1553
1554static int
1555client_verify_cb(gnutls_session_t session)
1556{
1557const gnutls_datum * cert_list;
1558unsigned int cert_list_size = 0;
1559gnutls_x509_crt_t crt;
1560int rc;
1561exim_gnutls_state_st * state = gnutls_session_get_ptr(session);
1562
1563cert_list = gnutls_certificate_get_peers(session, &cert_list_size);
1564if (cert_list)
1565 while (cert_list_size--)
1566 {
1567 rc = import_cert(&cert_list[cert_list_size], &crt);
1568 if (rc != GNUTLS_E_SUCCESS)
1569 {
1570 DEBUG(D_tls) debug_printf("TLS: peer cert problem: depth %d: %s\n",
1571 cert_list_size, gnutls_strerror(rc));
1572 break;
1573 }
1574
1575 state->tlsp->peercert = crt;
1576 if (tpda_raise_event(state->event_action,
1577 US"tls:cert", string_sprintf("%d", cert_list_size)) == DEFER)
1578 {
1579 log_write(0, LOG_MAIN,
1580 "SSL verify denied by event-action: depth=%d", cert_list_size);
1581 return 1; /* reject */
1582 }
1583 state->tlsp->peercert = NULL;
1584 }
1585
1586return 0;
1587}
1588
1589#endif
44662487
JH
1590
1591
17c76198
PP
1592
1593/* ------------------------------------------------------------------------ */
1594/* Exported functions */
1595
1596
1597
1598
059ec3d9
PH
1599/*************************************************
1600* Start a TLS session in a server *
1601*************************************************/
1602
1603/* This is called when Exim is running as a server, after having received
1604the STARTTLS command. It must respond to that command, and then negotiate
1605a TLS session.
1606
1607Arguments:
83da1223 1608 require_ciphers list of allowed ciphers or NULL
059ec3d9
PH
1609
1610Returns: OK on success
1611 DEFER for errors before the start of the negotiation
1612 FAIL for errors during the negotation; the server can't
1613 continue running.
1614*/
1615
1616int
17c76198 1617tls_server_start(const uschar *require_ciphers)
059ec3d9
PH
1618{
1619int rc;
7199e1ee 1620const char *error;
17c76198 1621exim_gnutls_state_st *state = NULL;
059ec3d9
PH
1622
1623/* Check for previous activation */
817d9f57 1624if (tls_in.active >= 0)
059ec3d9 1625 {
17c76198 1626 tls_error(US"STARTTLS received after TLS started", "", NULL);
059ec3d9
PH
1627 smtp_printf("554 Already in TLS\r\n");
1628 return FAIL;
1629 }
1630
1631/* Initialize the library. If it fails, it will already have logged the error
1632and sent an SMTP response. */
1633
17c76198 1634DEBUG(D_tls) debug_printf("initialising GnuTLS as a server\n");
059ec3d9 1635
17c76198
PP
1636rc = tls_init(NULL, tls_certificate, tls_privatekey,
1637 NULL, tls_verify_certificates, tls_crl,
1638 require_ciphers, &state);
059ec3d9
PH
1639if (rc != OK) return rc;
1640
059ec3d9
PH
1641/* If this is a host for which certificate verification is mandatory or
1642optional, set up appropriately. */
1643
059ec3d9 1644if (verify_check_host(&tls_verify_hosts) == OK)
17c76198 1645 {
e51c7be2
JH
1646 DEBUG(D_tls)
1647 debug_printf("TLS: a client certificate will be required.\n");
17c76198
PP
1648 state->verify_requirement = VERIFY_REQUIRED;
1649 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_REQUIRE);
1650 }
059ec3d9 1651else if (verify_check_host(&tls_try_verify_hosts) == OK)
17c76198 1652 {
e51c7be2
JH
1653 DEBUG(D_tls)
1654 debug_printf("TLS: a client certificate will be requested but not required.\n");
17c76198
PP
1655 state->verify_requirement = VERIFY_OPTIONAL;
1656 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_REQUEST);
1657 }
1658else
1659 {
e51c7be2
JH
1660 DEBUG(D_tls)
1661 debug_printf("TLS: a client certificate will not be requested.\n");
17c76198
PP
1662 state->verify_requirement = VERIFY_NONE;
1663 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_IGNORE);
1664 }
059ec3d9 1665
17c76198
PP
1666/* Register SNI handling; always, even if not in tls_certificate, so that the
1667expansion variable $tls_sni is always available. */
059ec3d9 1668
17c76198
PP
1669gnutls_handshake_set_post_client_hello_function(state->session,
1670 exim_sni_handling_cb);
059ec3d9
PH
1671
1672/* Set context and tell client to go ahead, except in the case of TLS startup
1673on connection, where outputting anything now upsets the clients and tends to
1674make them disconnect. We need to have an explicit fflush() here, to force out
1675the response. Other smtp_printf() calls do not need it, because in non-TLS
1676mode, the fflush() happens when smtp_getc() is called. */
1677
817d9f57 1678if (!state->tlsp->on_connect)
059ec3d9
PH
1679 {
1680 smtp_printf("220 TLS go ahead\r\n");
9d1c15ef 1681 fflush(smtp_out);
059ec3d9
PH
1682 }
1683
1684/* Now negotiate the TLS session. We put our own timer on it, since it seems
1685that the GnuTLS library doesn't. */
1686
17c76198 1687gnutls_transport_set_ptr2(state->session,
44662487
JH
1688 (gnutls_transport_ptr)(long) fileno(smtp_in),
1689 (gnutls_transport_ptr)(long) fileno(smtp_out));
17c76198
PP
1690state->fd_in = fileno(smtp_in);
1691state->fd_out = fileno(smtp_out);
059ec3d9
PH
1692
1693sigalrm_seen = FALSE;
1694if (smtp_receive_timeout > 0) alarm(smtp_receive_timeout);
17c76198
PP
1695do
1696 {
1697 rc = gnutls_handshake(state->session);
619b2b25
PP
1698 } while ((rc == GNUTLS_E_AGAIN) ||
1699 (rc == GNUTLS_E_INTERRUPTED && !sigalrm_seen));
059ec3d9
PH
1700alarm(0);
1701
17c76198 1702if (rc != GNUTLS_E_SUCCESS)
059ec3d9 1703 {
17c76198
PP
1704 tls_error(US"gnutls_handshake",
1705 sigalrm_seen ? "timed out" : gnutls_strerror(rc), NULL);
059ec3d9
PH
1706 /* It seems that, except in the case of a timeout, we have to close the
1707 connection right here; otherwise if the other end is running OpenSSL it hangs
1708 until the server times out. */
1709
1710 if (!sigalrm_seen)
1711 {
f1e894f3
PH
1712 (void)fclose(smtp_out);
1713 (void)fclose(smtp_in);
059ec3d9
PH
1714 }
1715
1716 return FAIL;
1717 }
1718
1719DEBUG(D_tls) debug_printf("gnutls_handshake was successful\n");
1720
17c76198
PP
1721/* Verify after the fact */
1722
9d1c15ef
JH
1723if ( state->verify_requirement != VERIFY_NONE
1724 && !verify_certificate(state, &error))
059ec3d9 1725 {
9d1c15ef 1726 if (state->verify_requirement != VERIFY_OPTIONAL)
17c76198 1727 {
9d1c15ef
JH
1728 tls_error(US"certificate verification failed", error, NULL);
1729 return FAIL;
17c76198 1730 }
9d1c15ef
JH
1731 DEBUG(D_tls)
1732 debug_printf("TLS: continuing on only because verification was optional, after: %s\n",
1733 error);
059ec3d9
PH
1734 }
1735
17c76198
PP
1736/* Figure out peer DN, and if authenticated, etc. */
1737
1738rc = peer_status(state);
1739if (rc != OK) return rc;
1740
1741/* Sets various Exim expansion variables; always safe within server */
1742
9d1c15ef 1743extract_exim_vars_from_tls_state(state);
059ec3d9
PH
1744
1745/* TLS has been set up. Adjust the input functions to read via TLS,
1746and initialize appropriately. */
1747
17c76198 1748state->xfer_buffer = store_malloc(ssl_xfer_buffer_size);
059ec3d9
PH
1749
1750receive_getc = tls_getc;
1751receive_ungetc = tls_ungetc;
1752receive_feof = tls_feof;
1753receive_ferror = tls_ferror;
58eb016e 1754receive_smtp_buffered = tls_smtp_buffered;
059ec3d9 1755
059ec3d9
PH
1756return OK;
1757}
1758
1759
1760
1761
1762/*************************************************
1763* Start a TLS session in a client *
1764*************************************************/
1765
1766/* Called from the smtp transport after STARTTLS has been accepted.
1767
1768Arguments:
1769 fd the fd of the connection
1770 host connected host (for messages)
83da1223 1771 addr the first address (not used)
a7538db1 1772 tb transport (always smtp)
059ec3d9
PH
1773
1774Returns: OK/DEFER/FAIL (because using common functions),
1775 but for a client, DEFER and FAIL have the same meaning
1776*/
1777
1778int
17c76198 1779tls_client_start(int fd, host_item *host,
f5d78688 1780 address_item *addr ARG_UNUSED,
0e66b3b6
JH
1781 transport_instance *tb
1782#ifdef EXPERIMENTAL_DANE
1783 , dne_answer * unused_tlsa_dnsa
1784#endif
1785 )
059ec3d9 1786{
a7538db1
JH
1787smtp_transport_options_block *ob =
1788 (smtp_transport_options_block *)tb->options_block;
059ec3d9 1789int rc;
17c76198
PP
1790const char *error;
1791exim_gnutls_state_st *state = NULL;
f2de3a33 1792#ifndef DISABLE_OCSP
65867078 1793BOOL require_ocsp = verify_check_this_host(&ob->hosts_require_ocsp,
2b4a568d 1794 NULL, host->name, host->address, NULL) == OK;
44662487
JH
1795BOOL request_ocsp = require_ocsp ? TRUE
1796 : verify_check_this_host(&ob->hosts_request_ocsp,
1797 NULL, host->name, host->address, NULL) == OK;
2b4a568d 1798#endif
059ec3d9 1799
17c76198 1800DEBUG(D_tls) debug_printf("initialising GnuTLS as a client on fd %d\n", fd);
059ec3d9 1801
65867078
JH
1802if ((rc = tls_init(host, ob->tls_certificate, ob->tls_privatekey,
1803 ob->tls_sni, ob->tls_verify_certificates, ob->tls_crl,
1804 ob->tls_require_ciphers, &state)) != OK)
2b4a568d 1805 return rc;
059ec3d9 1806
54c90be1 1807 {
65867078
JH
1808 int dh_min_bits = ob->tls_dh_min_bits;
1809 if (dh_min_bits < EXIM_CLIENT_DH_MIN_MIN_BITS)
1810 {
1811 DEBUG(D_tls)
1812 debug_printf("WARNING: tls_dh_min_bits far too low,"
1813 " clamping %d up to %d\n",
1814 dh_min_bits, EXIM_CLIENT_DH_MIN_MIN_BITS);
1815 dh_min_bits = EXIM_CLIENT_DH_MIN_MIN_BITS;
1816 }
54c90be1 1817
65867078
JH
1818 DEBUG(D_tls) debug_printf("Setting D-H prime minimum"
1819 " acceptable bits to %d\n",
1820 dh_min_bits);
1821 gnutls_dh_set_prime_bits(state->session, dh_min_bits);
1822 }
83da1223 1823
2b4a568d
JH
1824/* Stick to the old behaviour for compatibility if tls_verify_certificates is
1825set but both tls_verify_hosts and tls_try_verify_hosts are unset. Check only
1826the specified host patterns if one of them is defined */
1827
1828if (( state->exp_tls_verify_certificates
65867078
JH
1829 && !ob->tls_verify_hosts
1830 && !ob->tls_try_verify_hosts
2b4a568d
JH
1831 )
1832 ||
65867078 1833 verify_check_host(&ob->tls_verify_hosts) == OK
2b4a568d 1834 )
17c76198 1835 {
e51c7be2
JH
1836#ifdef EXPERIMENTAL_CERTNAMES
1837 if (ob->tls_verify_cert_hostnames)
1838 {
1839 DEBUG(D_tls)
1840 debug_printf("TLS: server cert incl. hostname verification required.\n");
1841 state->verify_requirement = VERIFY_WITHHOST;
1842 if (!expand_check(ob->tls_verify_cert_hostnames,
1843 US"tls_verify_cert_hostnames",
1844 &state->exp_tls_verify_cert_hostnames))
1845 return FAIL;
1846 if (state->exp_tls_verify_cert_hostnames)
1847 DEBUG(D_tls) debug_printf("Cert hostname to check: \"%s\"\n",
1848 state->exp_tls_verify_cert_hostnames);
1849 }
1850 else
1851#endif
1852 {
1853 DEBUG(D_tls)
1854 debug_printf("TLS: server certificate verification required.\n");
1855 state->verify_requirement = VERIFY_REQUIRED;
1856 }
52f93eed
WB
1857 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_REQUIRE);
1858 }
65867078 1859else if (verify_check_host(&ob->tls_try_verify_hosts) == OK)
52f93eed 1860 {
e51c7be2
JH
1861 DEBUG(D_tls)
1862 debug_printf("TLS: server certificate verification optional.\n");
52f93eed 1863 state->verify_requirement = VERIFY_OPTIONAL;
17c76198
PP
1864 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_REQUEST);
1865 }
1866else
1867 {
e51c7be2
JH
1868 DEBUG(D_tls)
1869 debug_printf("TLS: server certificate verification not required.\n");
52f93eed
WB
1870 state->verify_requirement = VERIFY_NONE;
1871 gnutls_certificate_server_set_request(state->session, GNUTLS_CERT_IGNORE);
17c76198 1872 }
059ec3d9 1873
f2de3a33
JH
1874#ifndef DISABLE_OCSP
1875 /* supported since GnuTLS 3.1.3 */
44662487 1876if (request_ocsp)
9d1c15ef
JH
1877 {
1878 DEBUG(D_tls) debug_printf("TLS: will request OCSP stapling\n");
65867078
JH
1879 if ((rc = gnutls_ocsp_status_request_enable_client(state->session,
1880 NULL, 0, NULL)) != OK)
9d1c15ef
JH
1881 return tls_error(US"cert-status-req",
1882 gnutls_strerror(rc), state->host);
44662487 1883 tls_out.ocsp = OCSP_NOT_RESP;
9d1c15ef 1884 }
2b4a568d
JH
1885#endif
1886
a7538db1
JH
1887#ifdef EXPERIMENTAL_TPDA
1888if (tb->tpda_event_action)
1889 {
1890 state->event_action = tb->tpda_event_action;
1891 gnutls_session_set_ptr(state->session, state);
1892 gnutls_certificate_set_verify_function(state->x509_cred, client_verify_cb);
1893 }
1894#endif
1895
44662487 1896gnutls_transport_set_ptr(state->session, (gnutls_transport_ptr)(long) fd);
17c76198
PP
1897state->fd_in = fd;
1898state->fd_out = fd;
059ec3d9 1899
9d1c15ef 1900DEBUG(D_tls) debug_printf("about to gnutls_handshake\n");
059ec3d9
PH
1901/* There doesn't seem to be a built-in timeout on connection. */
1902
1903sigalrm_seen = FALSE;
65867078 1904alarm(ob->command_timeout);
17c76198
PP
1905do
1906 {
1907 rc = gnutls_handshake(state->session);
619b2b25
PP
1908 } while ((rc == GNUTLS_E_AGAIN) ||
1909 (rc == GNUTLS_E_INTERRUPTED && !sigalrm_seen));
059ec3d9
PH
1910alarm(0);
1911
4fe99a6c
PP
1912if (rc != GNUTLS_E_SUCCESS)
1913 return tls_error(US"gnutls_handshake",
1914 sigalrm_seen ? "timed out" : gnutls_strerror(rc), state->host);
1915
17c76198 1916DEBUG(D_tls) debug_printf("gnutls_handshake was successful\n");
059ec3d9 1917
17c76198 1918/* Verify late */
059ec3d9 1919
17c76198
PP
1920if (state->verify_requirement != VERIFY_NONE &&
1921 !verify_certificate(state, &error))
1922 return tls_error(US"certificate verification failed", error, state->host);
059ec3d9 1923
f2de3a33 1924#ifndef DISABLE_OCSP
2b4a568d
JH
1925if (require_ocsp)
1926 {
1927 DEBUG(D_tls)
1928 {
1929 gnutls_datum_t stapling;
1930 gnutls_ocsp_resp_t resp;
1931 gnutls_datum_t printed;
1932 if ( (rc= gnutls_ocsp_status_request_get(state->session, &stapling)) == 0
1933 && (rc= gnutls_ocsp_resp_init(&resp)) == 0
1934 && (rc= gnutls_ocsp_resp_import(resp, &stapling)) == 0
1935 && (rc= gnutls_ocsp_resp_print(resp, GNUTLS_OCSP_PRINT_FULL, &printed)) == 0
1936 )
1937 {
65867078 1938 debug_printf("%.4096s", printed.data);
2b4a568d
JH
1939 gnutls_free(printed.data);
1940 }
1941 else
1942 (void) tls_error(US"ocsp decode", gnutls_strerror(rc), state->host);
1943 }
1944
2b4a568d 1945 if (gnutls_ocsp_status_request_is_checked(state->session, 0) == 0)
018058b2
JH
1946 {
1947 tls_out.ocsp = OCSP_FAILED;
2b4a568d 1948 return tls_error(US"certificate status check failed", NULL, state->host);
018058b2 1949 }
2b4a568d 1950 DEBUG(D_tls) debug_printf("Passed OCSP checking\n");
44662487 1951 tls_out.ocsp = OCSP_VFIED;
2b4a568d
JH
1952 }
1953#endif
1954
17c76198 1955/* Figure out peer DN, and if authenticated, etc. */
059ec3d9 1956
2b4a568d
JH
1957if ((rc = peer_status(state)) != OK)
1958 return rc;
059ec3d9 1959
4fe99a6c 1960/* Sets various Exim expansion variables; may need to adjust for ACL callouts */
059ec3d9 1961
9d1c15ef 1962extract_exim_vars_from_tls_state(state);
059ec3d9 1963
059ec3d9
PH
1964return OK;
1965}
1966
1967
1968
17c76198 1969
059ec3d9 1970/*************************************************
17c76198 1971* Close down a TLS session *
059ec3d9
PH
1972*************************************************/
1973
17c76198
PP
1974/* This is also called from within a delivery subprocess forked from the
1975daemon, to shut down the TLS library, without actually doing a shutdown (which
1976would tamper with the TLS session in the parent process).
059ec3d9 1977
17c76198
PP
1978Arguments: TRUE if gnutls_bye is to be called
1979Returns: nothing
059ec3d9
PH
1980*/
1981
17c76198 1982void
817d9f57 1983tls_close(BOOL is_server, BOOL shutdown)
059ec3d9 1984{
817d9f57 1985exim_gnutls_state_st *state = is_server ? &state_server : &state_client;
059ec3d9 1986
389ca47a 1987if (!state->tlsp || state->tlsp->active < 0) return; /* TLS was not active */
17c76198
PP
1988
1989if (shutdown)
1990 {
1991 DEBUG(D_tls) debug_printf("tls_close(): shutting down TLS\n");
1992 gnutls_bye(state->session, GNUTLS_SHUT_WR);
1993 }
1994
1995gnutls_deinit(state->session);
1996
389ca47a 1997state->tlsp->active = -1;
17c76198
PP
1998memcpy(state, &exim_gnutls_state_init, sizeof(exim_gnutls_state_init));
1999
2000if ((state_server.session == NULL) && (state_client.session == NULL))
2001 {
2002 gnutls_global_deinit();
2003 exim_gnutls_base_init_done = FALSE;
2004 }
7199e1ee 2005
059ec3d9
PH
2006}
2007
2008
2009
17c76198 2010
059ec3d9
PH
2011/*************************************************
2012* TLS version of getc *
2013*************************************************/
2014
2015/* This gets the next byte from the TLS input buffer. If the buffer is empty,
2016it refills the buffer via the GnuTLS reading function.
817d9f57 2017Only used by the server-side TLS.
059ec3d9 2018
17c76198
PP
2019This feeds DKIM and should be used for all message-body reads.
2020
059ec3d9
PH
2021Arguments: none
2022Returns: the next character or EOF
2023*/
2024
2025int
2026tls_getc(void)
2027{
817d9f57 2028exim_gnutls_state_st *state = &state_server;
17c76198 2029if (state->xfer_buffer_lwm >= state->xfer_buffer_hwm)
059ec3d9 2030 {
17c76198 2031 ssize_t inbytes;
059ec3d9 2032
17c76198
PP
2033 DEBUG(D_tls) debug_printf("Calling gnutls_record_recv(%p, %p, %u)\n",
2034 state->session, state->xfer_buffer, ssl_xfer_buffer_size);
059ec3d9
PH
2035
2036 if (smtp_receive_timeout > 0) alarm(smtp_receive_timeout);
17c76198 2037 inbytes = gnutls_record_recv(state->session, state->xfer_buffer,
059ec3d9
PH
2038 ssl_xfer_buffer_size);
2039 alarm(0);
2040
2041 /* A zero-byte return appears to mean that the TLS session has been
2042 closed down, not that the socket itself has been closed down. Revert to
2043 non-TLS handling. */
2044
2045 if (inbytes == 0)
2046 {
2047 DEBUG(D_tls) debug_printf("Got TLS_EOF\n");
2048
2049 receive_getc = smtp_getc;
2050 receive_ungetc = smtp_ungetc;
2051 receive_feof = smtp_feof;
2052 receive_ferror = smtp_ferror;
58eb016e 2053 receive_smtp_buffered = smtp_buffered;
059ec3d9 2054
17c76198
PP
2055 gnutls_deinit(state->session);
2056 state->session = NULL;
817d9f57
JH
2057 state->tlsp->active = -1;
2058 state->tlsp->bits = 0;
2059 state->tlsp->certificate_verified = FALSE;
9d1c15ef 2060 tls_channelbinding_b64 = NULL;
817d9f57 2061 state->tlsp->cipher = NULL;
9d1c15ef 2062 state->tlsp->peercert = NULL;
817d9f57 2063 state->tlsp->peerdn = NULL;
059ec3d9
PH
2064
2065 return smtp_getc();
2066 }
2067
2068 /* Handle genuine errors */
2069
2070 else if (inbytes < 0)
2071 {
17c76198
PP
2072 record_io_error(state, (int) inbytes, US"recv", NULL);
2073 state->xfer_error = 1;
059ec3d9
PH
2074 return EOF;
2075 }
80a47a2c 2076#ifndef DISABLE_DKIM
17c76198 2077 dkim_exim_verify_feed(state->xfer_buffer, inbytes);
80a47a2c 2078#endif
17c76198
PP
2079 state->xfer_buffer_hwm = (int) inbytes;
2080 state->xfer_buffer_lwm = 0;
059ec3d9
PH
2081 }
2082
059ec3d9
PH
2083/* Something in the buffer; return next uschar */
2084
17c76198 2085return state->xfer_buffer[state->xfer_buffer_lwm++];
059ec3d9
PH
2086}
2087
2088
2089
17c76198 2090
059ec3d9
PH
2091/*************************************************
2092* Read bytes from TLS channel *
2093*************************************************/
2094
17c76198
PP
2095/* This does not feed DKIM, so if the caller uses this for reading message body,
2096then the caller must feed DKIM.
817d9f57 2097
059ec3d9
PH
2098Arguments:
2099 buff buffer of data
2100 len size of buffer
2101
2102Returns: the number of bytes read
2103 -1 after a failed read
2104*/
2105
2106int
817d9f57 2107tls_read(BOOL is_server, uschar *buff, size_t len)
059ec3d9 2108{
817d9f57 2109exim_gnutls_state_st *state = is_server ? &state_server : &state_client;
17c76198 2110ssize_t inbytes;
059ec3d9 2111
17c76198
PP
2112if (len > INT_MAX)
2113 len = INT_MAX;
059ec3d9 2114
17c76198
PP
2115if (state->xfer_buffer_lwm < state->xfer_buffer_hwm)
2116 DEBUG(D_tls)
2117 debug_printf("*** PROBABLY A BUG *** " \
2118 "tls_read() called with data in the tls_getc() buffer, %d ignored\n",
2119 state->xfer_buffer_hwm - state->xfer_buffer_lwm);
2120
2121DEBUG(D_tls)
2122 debug_printf("Calling gnutls_record_recv(%p, %p, " SIZE_T_FMT ")\n",
2123 state->session, buff, len);
2124
2125inbytes = gnutls_record_recv(state->session, buff, len);
059ec3d9
PH
2126if (inbytes > 0) return inbytes;
2127if (inbytes == 0)
2128 {
2129 DEBUG(D_tls) debug_printf("Got TLS_EOF\n");
2130 }
17c76198 2131else record_io_error(state, (int)inbytes, US"recv", NULL);
059ec3d9
PH
2132
2133return -1;
2134}
2135
2136
2137
17c76198 2138
059ec3d9
PH
2139/*************************************************
2140* Write bytes down TLS channel *
2141*************************************************/
2142
2143/*
2144Arguments:
817d9f57 2145 is_server channel specifier
059ec3d9
PH
2146 buff buffer of data
2147 len number of bytes
2148
2149Returns: the number of bytes after a successful write,
2150 -1 after a failed write
2151*/
2152
2153int
817d9f57 2154tls_write(BOOL is_server, const uschar *buff, size_t len)
059ec3d9 2155{
17c76198
PP
2156ssize_t outbytes;
2157size_t left = len;
817d9f57 2158exim_gnutls_state_st *state = is_server ? &state_server : &state_client;
059ec3d9 2159
17c76198 2160DEBUG(D_tls) debug_printf("tls_do_write(%p, " SIZE_T_FMT ")\n", buff, left);
059ec3d9
PH
2161while (left > 0)
2162 {
17c76198
PP
2163 DEBUG(D_tls) debug_printf("gnutls_record_send(SSL, %p, " SIZE_T_FMT ")\n",
2164 buff, left);
2165 outbytes = gnutls_record_send(state->session, buff, left);
059ec3d9 2166
17c76198 2167 DEBUG(D_tls) debug_printf("outbytes=" SSIZE_T_FMT "\n", outbytes);
059ec3d9
PH
2168 if (outbytes < 0)
2169 {
17c76198 2170 record_io_error(state, outbytes, US"send", NULL);
059ec3d9
PH
2171 return -1;
2172 }
2173 if (outbytes == 0)
2174 {
17c76198 2175 record_io_error(state, 0, US"send", US"TLS channel closed on write");
059ec3d9
PH
2176 return -1;
2177 }
2178
2179 left -= outbytes;
2180 buff += outbytes;
2181 }
2182
17c76198
PP
2183if (len > INT_MAX)
2184 {
2185 DEBUG(D_tls)
2186 debug_printf("Whoops! Wrote more bytes (" SIZE_T_FMT ") than INT_MAX\n",
2187 len);
2188 len = INT_MAX;
2189 }
2190
2191return (int) len;
059ec3d9
PH
2192}
2193
2194
2195
17c76198 2196
059ec3d9 2197/*************************************************
17c76198 2198* Random number generation *
059ec3d9
PH
2199*************************************************/
2200
17c76198
PP
2201/* Pseudo-random number generation. The result is not expected to be
2202cryptographically strong but not so weak that someone will shoot themselves
2203in the foot using it as a nonce in input in some email header scheme or
2204whatever weirdness they'll twist this into. The result should handle fork()
2205and avoid repeating sequences. OpenSSL handles that for us.
059ec3d9 2206
17c76198
PP
2207Arguments:
2208 max range maximum
2209Returns a random number in range [0, max-1]
059ec3d9
PH
2210*/
2211
af3498d6 2212#ifdef HAVE_GNUTLS_RND
17c76198
PP
2213int
2214vaguely_random_number(int max)
059ec3d9 2215{
17c76198
PP
2216unsigned int r;
2217int i, needed_len;
2218uschar *p;
2219uschar smallbuf[sizeof(r)];
2220
2221if (max <= 1)
2222 return 0;
2223
2224needed_len = sizeof(r);
2225/* Don't take 8 times more entropy than needed if int is 8 octets and we were
2226 * asked for a number less than 10. */
2227for (r = max, i = 0; r; ++i)
2228 r >>= 1;
2229i = (i + 7) / 8;
2230if (i < needed_len)
2231 needed_len = i;
2232
2233i = gnutls_rnd(GNUTLS_RND_NONCE, smallbuf, needed_len);
2234if (i < 0)
059ec3d9 2235 {
17c76198
PP
2236 DEBUG(D_all) debug_printf("gnutls_rnd() failed, using fallback.\n");
2237 return vaguely_random_number_fallback(max);
2238 }
2239r = 0;
2240for (p = smallbuf; needed_len; --needed_len, ++p)
2241 {
2242 r *= 256;
2243 r += *p;
059ec3d9
PH
2244 }
2245
17c76198
PP
2246/* We don't particularly care about weighted results; if someone wants
2247 * smooth distribution and cares enough then they should submit a patch then. */
2248return r % max;
059ec3d9 2249}
af3498d6
PP
2250#else /* HAVE_GNUTLS_RND */
2251int
2252vaguely_random_number(int max)
2253{
2254 return vaguely_random_number_fallback(max);
2255}
2256#endif /* HAVE_GNUTLS_RND */
059ec3d9 2257
36f12725
NM
2258
2259
2260
3375e053
PP
2261/*************************************************
2262* Let tls_require_ciphers be checked at startup *
2263*************************************************/
2264
2265/* The tls_require_ciphers option, if set, must be something which the
2266library can parse.
2267
2268Returns: NULL on success, or error message
2269*/
2270
2271uschar *
2272tls_validate_require_cipher(void)
2273{
2274int rc;
2275uschar *expciphers = NULL;
2276gnutls_priority_t priority_cache;
2277const char *errpos;
2278
2279#define validate_check_rc(Label) do { \
2280 if (rc != GNUTLS_E_SUCCESS) { if (exim_gnutls_base_init_done) gnutls_global_deinit(); \
2281 return string_sprintf("%s failed: %s", (Label), gnutls_strerror(rc)); } } while (0)
2282#define return_deinit(Label) do { gnutls_global_deinit(); return (Label); } while (0)
2283
2284if (exim_gnutls_base_init_done)
2285 log_write(0, LOG_MAIN|LOG_PANIC,
2286 "already initialised GnuTLS, Exim developer bug");
2287
a5f239e4 2288#ifdef HAVE_GNUTLS_PKCS11
2519e60d 2289if (!gnutls_allow_auto_pkcs11)
a5f239e4
PP
2290 {
2291 rc = gnutls_pkcs11_init(GNUTLS_PKCS11_FLAG_MANUAL, NULL);
2292 validate_check_rc(US"gnutls_pkcs11_init");
2293 }
2294#endif
3375e053
PP
2295rc = gnutls_global_init();
2296validate_check_rc(US"gnutls_global_init()");
2297exim_gnutls_base_init_done = TRUE;
2298
2299if (!(tls_require_ciphers && *tls_require_ciphers))
2300 return_deinit(NULL);
2301
2302if (!expand_check(tls_require_ciphers, US"tls_require_ciphers", &expciphers))
2303 return_deinit(US"failed to expand tls_require_ciphers");
2304
2305if (!(expciphers && *expciphers))
2306 return_deinit(NULL);
2307
2308DEBUG(D_tls)
2309 debug_printf("tls_require_ciphers expands to \"%s\"\n", expciphers);
2310
2311rc = gnutls_priority_init(&priority_cache, CS expciphers, &errpos);
2312validate_check_rc(string_sprintf(
2313 "gnutls_priority_init(%s) failed at offset %ld, \"%.8s..\"",
2314 expciphers, errpos - CS expciphers, errpos));
2315
2316#undef return_deinit
2317#undef validate_check_rc
2318gnutls_global_deinit();
2319
2320return NULL;
2321}
2322
2323
2324
2325
36f12725
NM
2326/*************************************************
2327* Report the library versions. *
2328*************************************************/
2329
2330/* See a description in tls-openssl.c for an explanation of why this exists.
2331
2332Arguments: a FILE* to print the results to
2333Returns: nothing
2334*/
2335
2336void
2337tls_version_report(FILE *f)
2338{
754a0503
PP
2339fprintf(f, "Library version: GnuTLS: Compile: %s\n"
2340 " Runtime: %s\n",
2341 LIBGNUTLS_VERSION,
2342 gnutls_check_version(NULL));
36f12725
NM
2343}
2344
2b4a568d
JH
2345/* vi: aw ai sw=2
2346*/
059ec3d9 2347/* End of tls-gnu.c */