src/src/tls-openssl.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2019 */
   6 /* Copyright (c) The Exim Maintainers 2020 - 2021 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8
   9 /* Portions Copyright (c) The OpenSSL Project 1999 */
  10
  11 /* This module provides the TLS (aka SSL) support for Exim using the OpenSSL
  12 library. It is #included into the tls.c file when that library is used. The
  13 code herein is based on a patch that was originally contributed by Steve
  14 Haslam. It was adapted from stunnel, a GPL program by Michal Trojnara.
  15
  16 No cryptographic code is included in Exim. All this module does is to call
  17 functions from the OpenSSL library. */
  18
  19
  20 /* Heading stuff */
  21
  22 #include <openssl/lhash.h>
  23 #include <openssl/ssl.h>
  24 #include <openssl/err.h>
  25 #include <openssl/rand.h>
  26 #ifndef OPENSSL_NO_ECDH
  27 # include <openssl/ec.h>
  28 #endif
  29 #ifndef DISABLE_OCSP
  30 # include <openssl/ocsp.h>
  31 #endif
  32 #ifdef SUPPORT_DANE
  33 # include "danessl.h"
  34 #endif
  35
  36
  37 #ifndef DISABLE_OCSP
  38 # define EXIM_OCSP_SKEW_SECONDS (300L)
  39 # define EXIM_OCSP_MAX_AGE (-1L)
  40 #endif
  41
  42 #if OPENSSL_VERSION_NUMBER >= 0x0090806fL && !defined(OPENSSL_NO_TLSEXT)
  43 # define EXIM_HAVE_OPENSSL_TLSEXT
  44 #endif
  45 #if OPENSSL_VERSION_NUMBER >= 0x00908000L
  46 # define EXIM_HAVE_RSA_GENKEY_EX
  47 #endif
  48 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
  49 # define EXIM_HAVE_OCSP_RESP_COUNT
  50 # define OPENSSL_AUTO_SHA256
  51 #else
  52 # define EXIM_HAVE_EPHEM_RSA_KEX
  53 # define EXIM_HAVE_RAND_PSEUDO
  54 #endif
  55 #if (OPENSSL_VERSION_NUMBER >= 0x0090800fL) && !defined(OPENSSL_NO_SHA256)
  56 # define EXIM_HAVE_SHA256
  57 #endif
  58
  59 /* X509_check_host provides sane certificate hostname checking, but was added
  60 to OpenSSL late, after other projects forked off the code-base.  So in
  61 addition to guarding against the base version number, beware that LibreSSL
  62 does not (at this time) support this function.
  63
  64 If LibreSSL gains a different API, perhaps via libtls, then we'll probably
  65 opt to disentangle and ask a LibreSSL user to provide glue for a third
  66 crypto provider for libtls instead of continuing to tie the OpenSSL glue
  67 into even twistier knots.  If LibreSSL gains the same API, we can just
  68 change this guard and punt the issue for a while longer. */
  69
  70 #ifndef LIBRESSL_VERSION_NUMBER
  71 # if OPENSSL_VERSION_NUMBER >= 0x010100000L
  72 #  define EXIM_HAVE_OPENSSL_CHECKHOST
  73 #  define EXIM_HAVE_OPENSSL_DH_BITS
  74 #  define EXIM_HAVE_OPENSSL_TLS_METHOD
  75 #  define EXIM_HAVE_OPENSSL_KEYLOG
  76 #  define EXIM_HAVE_OPENSSL_CIPHER_GET_ID
  77 #  define EXIM_HAVE_SESSION_TICKET
  78 #  define EXIM_HAVE_OPESSL_TRACE
  79 #  define EXIM_HAVE_OPESSL_GET0_SERIAL
  80 #  ifndef DISABLE_OCSP
  81 #   define EXIM_HAVE_OCSP
  82 #  endif
  83 #  define EXIM_HAVE_ALPN /* fail ret from hshake-cb is ignored by LibreSSL */
  84 # else
  85 #  define EXIM_NEED_OPENSSL_INIT
  86 # endif
  87 # if OPENSSL_VERSION_NUMBER >= 0x010000000L \
  88     && (OPENSSL_VERSION_NUMBER & 0x0000ff000L) >= 0x000002000L
  89 #  define EXIM_HAVE_OPENSSL_CHECKHOST
  90 # endif
  91 #endif
  92
  93 #if LIBRESSL_VERSION_NUMBER >= 0x3040000fL
  94 # define EXIM_HAVE_OPENSSL_CIPHER_GET_ID
  95 #endif
  96
  97 #if !defined(LIBRESSL_VERSION_NUMBER) \
  98     || LIBRESSL_VERSION_NUMBER >= 0x20010000L
  99 # if !defined(OPENSSL_NO_ECDH)
 100 #  if OPENSSL_VERSION_NUMBER >= 0x0090800fL
 101 #   define EXIM_HAVE_ECDH
 102 #  endif
 103 #  if OPENSSL_VERSION_NUMBER >= 0x10002000L
 104 #   define EXIM_HAVE_OPENSSL_EC_NIST2NID
 105 #  endif
 106 # endif
 107 #endif
 108
 109 #ifndef LIBRESSL_VERSION_NUMBER
 110 # if OPENSSL_VERSION_NUMBER >= 0x010101000L
 111 #  define OPENSSL_HAVE_KEYLOG_CB
 112 #  define OPENSSL_HAVE_NUM_TICKETS
 113 #  define EXIM_HAVE_OPENSSL_CIPHER_STD_NAME
 114 # else
 115 #  define OPENSSL_BAD_SRVR_OURCERT
 116 # endif
 117 #endif
 118
 119 #if !defined(EXIM_HAVE_OPENSSL_TLSEXT) && !defined(DISABLE_OCSP)
 120 # warning "OpenSSL library version too old; define DISABLE_OCSP in Makefile"
 121 # define DISABLE_OCSP
 122 #endif
 123
 124 #ifndef DISABLE_TLS_RESUME
 125 # if OPENSSL_VERSION_NUMBER < 0x0101010L
 126 #  error OpenSSL version too old for session-resumption
 127 # endif
 128 #endif
 129
 130 #ifdef EXIM_HAVE_OPENSSL_CHECKHOST
 131 # include <openssl/x509v3.h>
 132 #endif
 133
 134 #ifndef EXIM_HAVE_OPENSSL_CIPHER_STD_NAME
 135 # ifndef EXIM_HAVE_OPENSSL_CIPHER_GET_ID
 136 #  define SSL_CIPHER_get_id(c) (c->id)
 137 # endif
 138 # ifndef MACRO_PREDEF
 139 #  include "tls-cipher-stdname.c"
 140 # endif
 141 #endif
 142
 143 /*************************************************
 144 *        OpenSSL option parse                    *
 145 *************************************************/
 146
 147 typedef struct exim_openssl_option {
 148   uschar *name;
 149   long    value;
 150 } exim_openssl_option;
 151 /* We could use a macro to expand, but we need the ifdef and not all the
 152 options document which version they were introduced in.  Policylet: include
 153 all options unless explicitly for DTLS, let the administrator choose which
 154 to apply.
 155
 156 This list is current as of:
 157   ==>  1.1.1c  <==
 158
 159 XXX could we autobuild this list, as with predefined-macros?
 160 Seems just parsing ssl.h for SSL_OP_.* would be enough (except to exclude DTLS).
 161 Also allow a numeric literal?
 162 */
 163 static exim_openssl_option exim_openssl_options[] = {
 164 /* KEEP SORTED ALPHABETICALLY! */
 165 #ifdef SSL_OP_ALL
 166   { US"all", (long) SSL_OP_ALL },
 167 #endif
 168 #ifdef SSL_OP_ALLOW_NO_DHE_KEX
 169   { US"allow_no_dhe_kex", SSL_OP_ALLOW_NO_DHE_KEX },
 170 #endif
 171 #ifdef SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION
 172   { US"allow_unsafe_legacy_renegotiation", SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION },
 173 #endif
 174 #ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
 175   { US"cipher_server_preference", SSL_OP_CIPHER_SERVER_PREFERENCE },
 176 #endif
 177 #ifdef SSL_OP_CRYPTOPRO_TLSEXT_BUG
 178   { US"cryptopro_tlsext_bug", SSL_OP_CRYPTOPRO_TLSEXT_BUG },
 179 #endif
 180 #ifdef SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS
 181   { US"dont_insert_empty_fragments", SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS },
 182 #endif
 183 #ifdef SSL_OP_ENABLE_MIDDLEBOX_COMPAT
 184   { US"enable_middlebox_compat", SSL_OP_ENABLE_MIDDLEBOX_COMPAT },
 185 #endif
 186 #ifdef SSL_OP_EPHEMERAL_RSA
 187   { US"ephemeral_rsa", SSL_OP_EPHEMERAL_RSA },
 188 #endif
 189 #ifdef SSL_OP_LEGACY_SERVER_CONNECT
 190   { US"legacy_server_connect", SSL_OP_LEGACY_SERVER_CONNECT },
 191 #endif
 192 #ifdef SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
 193   { US"microsoft_big_sslv3_buffer", SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER },
 194 #endif
 195 #ifdef SSL_OP_MICROSOFT_SESS_ID_BUG
 196   { US"microsoft_sess_id_bug", SSL_OP_MICROSOFT_SESS_ID_BUG },
 197 #endif
 198 #ifdef SSL_OP_MSIE_SSLV2_RSA_PADDING
 199   { US"msie_sslv2_rsa_padding", SSL_OP_MSIE_SSLV2_RSA_PADDING },
 200 #endif
 201 #ifdef SSL_OP_NETSCAPE_CHALLENGE_BUG
 202   { US"netscape_challenge_bug", SSL_OP_NETSCAPE_CHALLENGE_BUG },
 203 #endif
 204 #ifdef SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
 205   { US"netscape_reuse_cipher_change_bug", SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG },
 206 #endif
 207 #ifdef SSL_OP_NO_ANTI_REPLAY
 208   { US"no_anti_replay", SSL_OP_NO_ANTI_REPLAY },
 209 #endif
 210 #ifdef SSL_OP_NO_COMPRESSION
 211   { US"no_compression", SSL_OP_NO_COMPRESSION },
 212 #endif
 213 #ifdef SSL_OP_NO_ENCRYPT_THEN_MAC
 214   { US"no_encrypt_then_mac", SSL_OP_NO_ENCRYPT_THEN_MAC },
 215 #endif
 216 #ifdef SSL_OP_NO_RENEGOTIATION
 217   { US"no_renegotiation", SSL_OP_NO_RENEGOTIATION },
 218 #endif
 219 #ifdef SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
 220   { US"no_session_resumption_on_renegotiation", SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION },
 221 #endif
 222 #ifdef SSL_OP_NO_SSLv2
 223   { US"no_sslv2", SSL_OP_NO_SSLv2 },
 224 #endif
 225 #ifdef SSL_OP_NO_SSLv3
 226   { US"no_sslv3", SSL_OP_NO_SSLv3 },
 227 #endif
 228 #ifdef SSL_OP_NO_TICKET
 229   { US"no_ticket", SSL_OP_NO_TICKET },
 230 #endif
 231 #ifdef SSL_OP_NO_TLSv1
 232   { US"no_tlsv1", SSL_OP_NO_TLSv1 },
 233 #endif
 234 #ifdef SSL_OP_NO_TLSv1_1
 235 # if OPENSSL_VERSION_NUMBER < 0x30000000L
 236 #  if SSL_OP_NO_TLSv1_1 == 0x00000400L
 237   /* Error in chosen value in 1.0.1a; see first item in CHANGES for 1.0.1b */
 238 #   warning OpenSSL 1.0.1a uses a bad value for SSL_OP_NO_TLSv1_1, ignoring
 239 #   define NO_SSL_OP_NO_TLSv1_1
 240 #  endif
 241 # endif
 242 # ifndef NO_SSL_OP_NO_TLSv1_1
 243   { US"no_tlsv1_1", SSL_OP_NO_TLSv1_1 },
 244 # endif
 245 #endif
 246 #ifdef SSL_OP_NO_TLSv1_2
 247   { US"no_tlsv1_2", SSL_OP_NO_TLSv1_2 },
 248 #endif
 249 #ifdef SSL_OP_NO_TLSv1_3
 250   { US"no_tlsv1_3", SSL_OP_NO_TLSv1_3 },
 251 #endif
 252 #ifdef SSL_OP_PRIORITIZE_CHACHA
 253   { US"prioritize_chacha", SSL_OP_PRIORITIZE_CHACHA },
 254 #endif
 255 #ifdef SSL_OP_SAFARI_ECDHE_ECDSA_BUG
 256   { US"safari_ecdhe_ecdsa_bug", SSL_OP_SAFARI_ECDHE_ECDSA_BUG },
 257 #endif
 258 #ifdef SSL_OP_SINGLE_DH_USE
 259   { US"single_dh_use", SSL_OP_SINGLE_DH_USE },
 260 #endif
 261 #ifdef SSL_OP_SINGLE_ECDH_USE
 262   { US"single_ecdh_use", SSL_OP_SINGLE_ECDH_USE },
 263 #endif
 264 #ifdef SSL_OP_SSLEAY_080_CLIENT_DH_BUG
 265   { US"ssleay_080_client_dh_bug", SSL_OP_SSLEAY_080_CLIENT_DH_BUG },
 266 #endif
 267 #ifdef SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
 268   { US"sslref2_reuse_cert_type_bug", SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG },
 269 #endif
 270 #ifdef SSL_OP_TLS_BLOCK_PADDING_BUG
 271   { US"tls_block_padding_bug", SSL_OP_TLS_BLOCK_PADDING_BUG },
 272 #endif
 273 #ifdef SSL_OP_TLS_D5_BUG
 274   { US"tls_d5_bug", SSL_OP_TLS_D5_BUG },
 275 #endif
 276 #ifdef SSL_OP_TLS_ROLLBACK_BUG
 277   { US"tls_rollback_bug", SSL_OP_TLS_ROLLBACK_BUG },
 278 #endif
 279 #ifdef SSL_OP_TLSEXT_PADDING
 280   { US"tlsext_padding", SSL_OP_TLSEXT_PADDING },
 281 #endif
 282 };
 283
 284 #ifndef MACRO_PREDEF
 285 static int exim_openssl_options_size = nelem(exim_openssl_options);
 286 static long init_options = 0;
 287 #endif
 288
 289 #ifdef MACRO_PREDEF
 290 void
 291 options_tls(void)
 292 {
 293 uschar buf[64];
 294
 295 for (struct exim_openssl_option * o = exim_openssl_options;
 296      o < exim_openssl_options + nelem(exim_openssl_options); o++)
 297   {
 298   /* Trailing X is workaround for problem with _OPT_OPENSSL_NO_TLSV1
 299   being a ".ifdef _OPT_OPENSSL_NO_TLSV1_3" match */
 300
 301   spf(buf, sizeof(buf), US"_OPT_OPENSSL_%T_X", o->name);
 302   builtin_macro_create(buf);
 303   }
 304
 305 # ifndef DISABLE_TLS_RESUME
 306 builtin_macro_create_var(US"_RESUME_DECODE", RESUME_DECODE_STRING );
 307 # endif
 308 # ifdef SSL_OP_NO_TLSv1_3
 309 builtin_macro_create(US"_HAVE_TLS1_3");
 310 # endif
 311 # ifdef OPENSSL_BAD_SRVR_OURCERT
 312 builtin_macro_create(US"_TLS_BAD_MULTICERT_IN_OURCERT");
 313 # endif
 314 # ifdef EXIM_HAVE_OCSP
 315 builtin_macro_create(US"_HAVE_TLS_OCSP");
 316 builtin_macro_create(US"_HAVE_TLS_OCSP_LIST");
 317 # endif
 318 # ifdef EXIM_HAVE_ALPN
 319 builtin_macro_create(US"_HAVE_TLS_ALPN");
 320 # endif
 321 }
 322 #else
 323
 324 /******************************************************************************/
 325
 326 /* Structure for collecting random data for seeding. */
 327
 328 typedef struct randstuff {
 329   struct timeval tv;
 330   pid_t          p;
 331 } randstuff;
 332
 333 /* Local static variables */
 334
 335 static BOOL client_verify_callback_called = FALSE;
 336 static BOOL server_verify_callback_called = FALSE;
 337 static const uschar *sid_ctx = US"exim";
 338
 339 /* We have three different contexts to care about.
 340
 341 Simple case: client, `client_ctx`
 342  As a client, we can be doing a callout or cut-through delivery while receiving
 343  a message.  So we have a client context, which should have options initialised
 344  from the SMTP Transport.  We may also concurrently want to make TLS connections
 345  to utility daemons, so client-contexts are allocated and passed around in call
 346  args rather than using a gobal.
 347
 348 Server:
 349  There are two cases: with and without ServerNameIndication from the client.
 350  Given TLS SNI, we can be using different keys, certs and various other
 351  configuration settings, because they're re-expanded with $tls_sni set.  This
 352  allows vhosting with TLS.  This SNI is sent in the handshake.
 353  A client might not send SNI, so we need a fallback, and an initial setup too.
 354  So as a server, we start out using `server_ctx`.
 355  If SNI is sent by the client, then we as server, mid-negotiation, try to clone
 356  `server_sni` from `server_ctx` and then initialise settings by re-expanding
 357  configuration.
 358 */
 359
 360 typedef struct {
 361   SSL_CTX *     ctx;
 362   SSL *         ssl;
 363   gstring *     corked;
 364 } exim_openssl_client_tls_ctx;
 365
 366
 367 /* static SSL_CTX *server_ctx = NULL; */
 368 /* static SSL     *server_ssl = NULL; */
 369
 370 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
 371 static SSL_CTX *server_sni = NULL;
 372 #endif
 373 #ifdef EXIM_HAVE_ALPN
 374 static BOOL server_seen_alpn = FALSE;
 375 #endif
 376
 377 static char ssl_errstring[256];
 378
 379 static int  ssl_session_timeout = 7200;         /* Two hours */
 380 static BOOL client_verify_optional = FALSE;
 381 static BOOL server_verify_optional = FALSE;
 382
 383 static BOOL reexpand_tls_files_for_sni = FALSE;
 384
 385
 386 typedef struct ocsp_resp {
 387   struct ocsp_resp *    next;
 388   OCSP_RESPONSE *       resp;
 389 } ocsp_resplist;
 390
 391 typedef struct exim_openssl_state {
 392   exim_tlslib_state     lib_state;
 393 #define lib_ctx                 libdata0
 394 #define lib_ssl                 libdata1
 395
 396   tls_support * tlsp;
 397   uschar *      certificate;
 398   uschar *      privatekey;
 399   BOOL          is_server;
 400 #ifndef DISABLE_OCSP
 401   STACK_OF(X509) *verify_stack;         /* chain for verifying the proof */
 402   union {
 403     struct {
 404       uschar        *file;
 405       const uschar  *file_expanded;
 406       ocsp_resplist *olist;
 407     } server;
 408     struct {
 409       X509_STORE    *verify_store;      /* non-null if status requested */
 410       BOOL          verify_required;
 411     } client;
 412   } u_ocsp;
 413 #endif
 414   uschar *      dhparam;
 415   /* these are cached from first expand */
 416   uschar *      server_cipher_list;
 417   /* only passed down to tls_error: */
 418   host_item *   host;
 419   const uschar * verify_cert_hostnames;
 420 #ifndef DISABLE_EVENT
 421   uschar *      event_action;
 422 #endif
 423 } exim_openssl_state_st;
 424
 425 /* should figure out a cleanup of API to handle state preserved per
 426 implementation, for various reasons, which can be void * in the APIs.
 427 For now, we hack around it. */
 428 exim_openssl_state_st *client_static_state = NULL;      /*XXX should not use static; multiple concurrent clients! */
 429 exim_openssl_state_st state_server = {.is_server = TRUE};
 430
 431 static int
 432 setup_certs(SSL_CTX *sctx, uschar *certs, uschar *crl, host_item *host,
 433     uschar ** errstr );
 434
 435 /* Callbacks */
 436 #ifndef DISABLE_OCSP
 437 static int tls_server_stapling_cb(SSL *s, void *arg);
 438 #endif
 439
 440
 441
 442 /* Daemon-called, before every connection, key create/rotate */
 443 #ifndef DISABLE_TLS_RESUME
 444 static void tk_init(void);
 445 static int tls_exdata_idx = -1;
 446 #endif
 447
 448 static void
 449 tls_per_lib_daemon_tick(void)
 450 {
 451 #ifndef DISABLE_TLS_RESUME
 452 tk_init();
 453 #endif
 454 }
 455
 456 /* Called once at daemon startup */
 457
 458 static void
 459 tls_per_lib_daemon_init(void)
 460 {
 461 tls_daemon_creds_reload();
 462 }
 463
 464
 465 /*************************************************
 466 *               Handle TLS error                 *
 467 *************************************************/
 468
 469 /* Called from lots of places when errors occur before actually starting to do
 470 the TLS handshake, that is, while the session is still in clear. Always returns
 471 DEFER for a server and FAIL for a client so that most calls can use "return
 472 tls_error(...)" to do this processing and then give an appropriate return. A
 473 single function is used for both server and client, because it is called from
 474 some shared functions.
 475
 476 Argument:
 477   prefix    text to include in the logged error
 478   host      NULL if setting up a server;
 479             the connected host if setting up a client
 480   msg       error message or NULL if we should ask OpenSSL
 481   errstr    pointer to output error message
 482
 483 Returns:    OK/DEFER/FAIL
 484 */
 485
 486 static int
 487 tls_error(uschar * prefix, const host_item * host, uschar * msg, uschar ** errstr)
 488 {
 489 if (!msg)
 490   {
 491   ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
 492   msg = US ssl_errstring;
 493   }
 494
 495 msg = string_sprintf("(%s): %s", prefix, msg);
 496 DEBUG(D_tls) debug_printf("TLS error '%s'\n", msg);
 497 if (errstr) *errstr = msg;
 498 return host ? FAIL : DEFER;
 499 }
 500
 501
 502
 503 /**************************************************
 504 * General library initalisation                   *
 505 **************************************************/
 506
 507 static BOOL
 508 lib_rand_init(void * addr)
 509 {
 510 randstuff r;
 511 if (!RAND_status()) return TRUE;
 512
 513 gettimeofday(&r.tv, NULL);
 514 r.p = getpid();
 515 RAND_seed(US (&r), sizeof(r));
 516 RAND_seed(US big_buffer, big_buffer_size);
 517 if (addr) RAND_seed(US addr, sizeof(addr));
 518
 519 return RAND_status();
 520 }
 521
 522
 523 static void
 524 tls_openssl_init(void)
 525 {
 526 static BOOL once = FALSE;
 527 if (once) return;
 528 once = TRUE;
 529
 530 #ifdef EXIM_NEED_OPENSSL_INIT
 531 SSL_load_error_strings();          /* basic set up */
 532 OpenSSL_add_ssl_algorithms();
 533 #endif
 534
 535 #if defined(EXIM_HAVE_SHA256) && !defined(OPENSSL_AUTO_SHA256)
 536 /* SHA256 is becoming ever more popular. This makes sure it gets added to the
 537 list of available digests. */
 538 EVP_add_digest(EVP_sha256());
 539 #endif
 540
 541 (void) lib_rand_init(NULL);
 542 (void) tls_openssl_options_parse(openssl_options, &init_options);
 543 }
 544
 545
 546
 547 /*************************************************
 548 *                Initialize for DH               *
 549 *************************************************/
 550
 551 /* If dhparam is set, expand it, and load up the parameters for DH encryption.
 552 Server only.
 553
 554 Arguments:
 555   sctx      The current SSL CTX (inbound or outbound)
 556   dhparam   DH parameter file or fixed parameter identity string
 557   errstr    error string pointer
 558
 559 Returns:    TRUE if OK (nothing to set up, or setup worked)
 560 */
 561
 562 static BOOL
 563 init_dh(SSL_CTX * sctx, uschar * dhparam, uschar ** errstr)
 564 {
 565 BIO * bio;
 566 #if OPENSSL_VERSION_NUMBER < 0x30000000L
 567 DH * dh;
 568 #else
 569 EVP_PKEY * pkey;
 570 #endif
 571 uschar * dhexpanded;
 572 const char * pem;
 573 int dh_bitsize;
 574
 575 if (!expand_check(dhparam, US"tls_dhparam", &dhexpanded, errstr))
 576   return FALSE;
 577
 578 if (!dhexpanded || !*dhexpanded)
 579   bio = BIO_new_mem_buf(CS std_dh_prime_default(), -1);
 580 else if (dhexpanded[0] == '/')
 581   {
 582   if (!(bio = BIO_new_file(CS dhexpanded, "r")))
 583     {
 584     tls_error(string_sprintf("could not read dhparams file %s", dhexpanded),
 585           NULL, US strerror(errno), errstr);
 586     return FALSE;
 587     }
 588   }
 589 else
 590   {
 591   if (Ustrcmp(dhexpanded, "none") == 0)
 592     {
 593     DEBUG(D_tls) debug_printf("Requested no DH parameters.\n");
 594     return TRUE;
 595     }
 596
 597   if (!(pem = std_dh_prime_named(dhexpanded)))
 598     {
 599     tls_error(string_sprintf("Unknown standard DH prime \"%s\"", dhexpanded),
 600         NULL, US strerror(errno), errstr);
 601     return FALSE;
 602     }
 603   bio = BIO_new_mem_buf(CS pem, -1);
 604   }
 605
 606 if (!(
 607 #if OPENSSL_VERSION_NUMBER < 0x30000000L
 608       dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL)
 609 #else
 610       pkey = PEM_read_bio_Parameters_ex(bio, NULL, NULL, NULL)
 611 #endif
 612    ) )
 613   {
 614   BIO_free(bio);
 615   tls_error(string_sprintf("Could not read tls_dhparams \"%s\"", dhexpanded),
 616       NULL, NULL, errstr);
 617   return FALSE;
 618   }
 619
 620 /* note: our default limit of 2236 is not a multiple of 8; the limit comes from
 621 an NSS limit, and the GnuTLS APIs handle bit-sizes fine, so we went with 2236.
 622 But older OpenSSL can only report in bytes (octets), not bits.  If someone wants
 623 to dance at the edge, then they can raise the limit or use current libraries. */
 624
 625 #if OPENSSL_VERSION_NUMBER < 0x30000000L
 626 # ifdef EXIM_HAVE_OPENSSL_DH_BITS
 627 /* Added in commit 26c79d5641d; `git describe --contains` says OpenSSL_1_1_0-pre1~1022
 628 This predates OpenSSL_1_1_0 (before a, b, ...) so is in all 1.1.0 */
 629 dh_bitsize = DH_bits(dh);
 630 # else
 631 dh_bitsize = 8 * DH_size(dh);
 632 # endif
 633 #else   /* 3.0.0 + */
 634 dh_bitsize = EVP_PKEY_get_bits(pkey);
 635 #endif
 636
 637 /* Even if it is larger, we silently return success rather than cause things to
 638 fail out, so that a too-large DH will not knock out all TLS; it's a debatable
 639 choice.  Likewise for a failing attempt to set one. */
 640
 641 if (dh_bitsize <= tls_dh_max_bits)
 642   {
 643   if (
 644 #if OPENSSL_VERSION_NUMBER < 0x30000000L
 645       SSL_CTX_set_tmp_dh(sctx, dh)
 646 #else
 647       SSL_CTX_set0_tmp_dh_pkey(sctx, pkey)
 648 #endif
 649       == 0)
 650     {
 651     ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
 652     log_write(0, LOG_MAIN|LOG_PANIC, "TLS error (D-H param setting '%s'): %s",
 653         dhexpanded ? dhexpanded : US"default", ssl_errstring);
 654 #if OPENSSL_VERSION_NUMBER >= 0x30000000L
 655     /* EVP_PKEY_free(pkey);  crashes */
 656 #endif
 657     }
 658   else
 659     DEBUG(D_tls)
 660       debug_printf("Diffie-Hellman initialized from %s with %d-bit prime\n",
 661         dhexpanded ? dhexpanded : US"default", dh_bitsize);
 662   }
 663 else
 664   DEBUG(D_tls)
 665     debug_printf("dhparams '%s' %d bits, is > tls_dh_max_bits limit of %d\n",
 666         dhexpanded ? dhexpanded : US"default", dh_bitsize, tls_dh_max_bits);
 667
 668 #if OPENSSL_VERSION_NUMBER < 0x30000000L
 669 DH_free(dh);
 670 #endif
 671 /* The EVP_PKEY ownership stays with the ctx; do not free it */
 672
 673 BIO_free(bio);
 674 return TRUE;
 675 }
 676
 677
 678
 679
 680 /*************************************************
 681 *               Initialize for ECDH              *
 682 *************************************************/
 683
 684 /* Load parameters for ECDH encryption.  Server only.
 685
 686 For now, we stick to NIST P-256 because: it's simple and easy to configure;
 687 it avoids any patent issues that might bite redistributors; despite events in
 688 the news and concerns over curve choices, we're not cryptographers, we're not
 689 pretending to be, and this is "good enough" to be better than no support,
 690 protecting against most adversaries.  Given another year or two, there might
 691 be sufficient clarity about a "right" way forward to let us make an informed
 692 decision, instead of a knee-jerk reaction.
 693
 694 Longer-term, we should look at supporting both various named curves and
 695 external files generated with "openssl ecparam", much as we do for init_dh().
 696 We should also support "none" as a value, to explicitly avoid initialisation.
 697
 698 Patches welcome.
 699
 700 Arguments:
 701   sctx      The current SSL CTX (inbound or outbound)
 702   errstr    error string pointer
 703
 704 Returns:    TRUE if OK (nothing to set up, or setup worked)
 705 */
 706
 707 static BOOL
 708 init_ecdh(SSL_CTX * sctx, uschar ** errstr)
 709 {
 710 #ifdef OPENSSL_NO_ECDH
 711 return TRUE;
 712 #else
 713
 714 uschar * exp_curve;
 715 int nid;
 716 BOOL rv;
 717
 718 # ifndef EXIM_HAVE_ECDH
 719 DEBUG(D_tls)
 720   debug_printf("No OpenSSL API to define ECDH parameters, skipping\n");
 721 return TRUE;
 722 # else
 723
 724 if (!expand_check(tls_eccurve, US"tls_eccurve", &exp_curve, errstr))
 725   return FALSE;
 726 if (!exp_curve || !*exp_curve)
 727   return TRUE;
 728
 729 /* "auto" needs to be handled carefully.
 730  * OpenSSL <  1.0.2: we do not select anything, but fallback to prime256v1
 731  * OpenSSL <  1.1.0: we have to call SSL_CTX_set_ecdh_auto
 732  *                   (openssl/ssl.h defines SSL_CTRL_SET_ECDH_AUTO)
 733  * OpenSSL >= 1.1.0: we do not set anything, the libray does autoselection
 734  *                   https://github.com/openssl/openssl/commit/fe6ef2472db933f01b59cad82aa925736935984b
 735  */
 736 if (Ustrcmp(exp_curve, "auto") == 0)
 737   {
 738 #if OPENSSL_VERSION_NUMBER < 0x10002000L
 739   DEBUG(D_tls) debug_printf(
 740     "ECDH OpenSSL < 1.0.2: temp key parameter settings: overriding \"auto\" with \"prime256v1\"\n");
 741   exp_curve = US"prime256v1";
 742 #else
 743 # if defined SSL_CTRL_SET_ECDH_AUTO
 744   DEBUG(D_tls) debug_printf(
 745     "ECDH OpenSSL 1.0.2+: temp key parameter settings: autoselection\n");
 746   SSL_CTX_set_ecdh_auto(sctx, 1);
 747   return TRUE;
 748 # else
 749   DEBUG(D_tls) debug_printf(
 750     "ECDH OpenSSL 1.1.0+: temp key parameter settings: default selection\n");
 751   return TRUE;
 752 # endif
 753 #endif
 754   }
 755
 756 DEBUG(D_tls) debug_printf("ECDH: curve '%s'\n", exp_curve);
 757 if (  (nid = OBJ_sn2nid       (CCS exp_curve)) == NID_undef
 758 #   ifdef EXIM_HAVE_OPENSSL_EC_NIST2NID
 759    && (nid = EC_curve_nist2nid(CCS exp_curve)) == NID_undef
 760 #   endif
 761    )
 762   {
 763   tls_error(string_sprintf("Unknown curve name tls_eccurve '%s'", exp_curve),
 764     NULL, NULL, errstr);
 765   return FALSE;
 766   }
 767
 768 # if OPENSSL_VERSION_NUMBER < 0x30000000L
 769  {
 770   EC_KEY * ecdh;
 771   if (!(ecdh = EC_KEY_new_by_curve_name(nid)))
 772     {
 773     tls_error(US"Unable to create ec curve", NULL, NULL, errstr);
 774     return FALSE;
 775     }
 776
 777   /* The "tmp" in the name here refers to setting a temporary key
 778   not to the stability of the interface. */
 779
 780   if ((rv = SSL_CTX_set_tmp_ecdh(sctx, ecdh) == 0))
 781     tls_error(string_sprintf("Error enabling '%s' curve", exp_curve), NULL, NULL, errstr);
 782   else
 783     DEBUG(D_tls) debug_printf("ECDH: enabled '%s' curve\n", exp_curve);
 784   EC_KEY_free(ecdh);
 785  }
 786
 787 #else   /* v 3.0.0 + */
 788
 789 if ((rv = SSL_CTX_set1_groups(sctx, &nid, 1)) == 0)
 790   tls_error(string_sprintf("Error enabling '%s' group", exp_curve), NULL, NULL, errstr);
 791 else
 792   DEBUG(D_tls) debug_printf("ECDH: enabled '%s' group\n", exp_curve);
 793
 794 #endif
 795
 796 return !rv;
 797
 798 # endif /*EXIM_HAVE_ECDH*/
 799 #endif /*OPENSSL_NO_ECDH*/
 800 }
 801
 802
 803
 804 /*************************************************
 805 *        Expand key and cert file specs          *
 806 *************************************************/
 807
 808 #if OPENSSL_VERSION_NUMBER < 0x30000000L
 809 /*
 810 Arguments:
 811   s          SSL connection (not used)
 812   export     not used
 813   keylength  keylength
 814
 815 Returns:     pointer to generated key
 816 */
 817
 818 static RSA *
 819 rsa_callback(SSL *s, int export, int keylength)
 820 {
 821 RSA *rsa_key;
 822 #ifdef EXIM_HAVE_RSA_GENKEY_EX
 823 BIGNUM *bn = BN_new();
 824 #endif
 825
 826 DEBUG(D_tls) debug_printf("Generating %d bit RSA key...\n", keylength);
 827
 828 # ifdef EXIM_HAVE_RSA_GENKEY_EX
 829 if (  !BN_set_word(bn, (unsigned long)RSA_F4)
 830    || !(rsa_key = RSA_new())
 831    || !RSA_generate_key_ex(rsa_key, keylength, bn, NULL)
 832    )
 833 # else
 834 if (!(rsa_key = RSA_generate_key(keylength, RSA_F4, NULL, NULL)))
 835 # endif
 836
 837   {
 838   ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
 839   log_write(0, LOG_MAIN|LOG_PANIC, "TLS error (RSA_generate_key): %s",
 840     ssl_errstring);
 841   return NULL;
 842   }
 843 return rsa_key;
 844 }
 845 #endif  /* pre-3.0.0 */
 846
 847
 848
 849 /* Create and install a selfsigned certificate, for use in server mode */
 850 /*XXX we could arrange to call this during prelo for a null tls_certificate option.
 851 The normal cache inval + relo will suffice.
 852 Just need a timer for inval. */
 853
 854 static int
 855 tls_install_selfsign(SSL_CTX * sctx, uschar ** errstr)
 856 {
 857 X509 * x509 = NULL;
 858 EVP_PKEY * pkey;
 859 X509_NAME * name;
 860 uschar * where;
 861
 862 DEBUG(D_tls) debug_printf("TLS: generating selfsigned server cert\n");
 863 where = US"allocating pkey";
 864 if (!(pkey = EVP_PKEY_new()))
 865   goto err;
 866
 867 where = US"allocating cert";
 868 if (!(x509 = X509_new()))
 869   goto err;
 870
 871 where = US"generating pkey";
 872 #if OPENSSL_VERSION_NUMBER < 0x30000000L
 873  {
 874   RSA * rsa;
 875   if (!(rsa = rsa_callback(NULL, 0, 2048)))
 876     goto err;
 877
 878   where = US"assigning pkey";
 879   if (!EVP_PKEY_assign_RSA(pkey, rsa))
 880     goto err;
 881  }
 882 #else
 883 pkey = EVP_RSA_gen(2048);
 884 #endif
 885
 886 X509_set_version(x509, 2);                              /* N+1 - version 3 */
 887 ASN1_INTEGER_set(X509_get_serialNumber(x509), 1);
 888 X509_gmtime_adj(X509_get_notBefore(x509), 0);
 889 X509_gmtime_adj(X509_get_notAfter(x509), (long)2 * 60 * 60);    /* 2 hour */
 890 X509_set_pubkey(x509, pkey);
 891
 892 name = X509_get_subject_name(x509);
 893 X509_NAME_add_entry_by_txt(name, "C",
 894                           MBSTRING_ASC, CUS "UK", -1, -1, 0);
 895 X509_NAME_add_entry_by_txt(name, "O",
 896                           MBSTRING_ASC, CUS "Exim Developers", -1, -1, 0);
 897 X509_NAME_add_entry_by_txt(name, "CN",
 898                           MBSTRING_ASC, CUS smtp_active_hostname, -1, -1, 0);
 899 X509_set_issuer_name(x509, name);
 900
 901 where = US"signing cert";
 902 if (!X509_sign(x509, pkey, EVP_md5()))
 903   goto err;
 904
 905 where = US"installing selfsign cert";
 906 if (!SSL_CTX_use_certificate(sctx, x509))
 907   goto err;
 908
 909 where = US"installing selfsign key";
 910 if (!SSL_CTX_use_PrivateKey(sctx, pkey))
 911   goto err;
 912
 913 return OK;
 914
 915 err:
 916   (void) tls_error(where, NULL, NULL, errstr);
 917   if (x509) X509_free(x509);
 918   if (pkey) EVP_PKEY_free(pkey);
 919   return DEFER;
 920 }
 921
 922
 923
 924
 925
 926
 927
 928 /*************************************************
 929 *           Information callback                 *
 930 *************************************************/
 931
 932 /* The SSL library functions call this from time to time to indicate what they
 933 are doing. We copy the string to the debugging output when TLS debugging has
 934 been requested.
 935
 936 Arguments:
 937   s         the SSL connection
 938   where
 939   ret
 940
 941 Returns:    nothing
 942 */
 943
 944 static void
 945 info_callback(SSL *s, int where, int ret)
 946 {
 947 DEBUG(D_tls)
 948   {
 949   const uschar * str;
 950
 951   if (where & SSL_ST_CONNECT)
 952      str = US"SSL_connect";
 953   else if (where & SSL_ST_ACCEPT)
 954      str = US"SSL_accept";
 955   else
 956      str = US"SSL info (undefined)";
 957
 958   if (where & SSL_CB_LOOP)
 959      debug_printf("%s: %s\n", str, SSL_state_string_long(s));
 960   else if (where & SSL_CB_ALERT)
 961     debug_printf("SSL3 alert %s:%s:%s\n",
 962           str = where & SSL_CB_READ ? US"read" : US"write",
 963           SSL_alert_type_string_long(ret), SSL_alert_desc_string_long(ret));
 964   else if (where & SSL_CB_EXIT)
 965     {
 966     if (ret == 0)
 967       debug_printf("%s: failed in %s\n", str, SSL_state_string_long(s));
 968     else if (ret < 0)
 969       debug_printf("%s: error in %s\n", str, SSL_state_string_long(s));
 970     }
 971   else if (where & SSL_CB_HANDSHAKE_START)
 972      debug_printf("%s: hshake start: %s\n", str, SSL_state_string_long(s));
 973   else if (where & SSL_CB_HANDSHAKE_DONE)
 974      debug_printf("%s: hshake done: %s\n", str, SSL_state_string_long(s));
 975   }
 976 }
 977
 978 #ifdef OPENSSL_HAVE_KEYLOG_CB
 979 static void
 980 keylog_callback(const SSL *ssl, const char *line)
 981 {
 982 char * filename;
 983 FILE * fp;
 984 DEBUG(D_tls) debug_printf("%.200s\n", line);
 985 if (!(filename = getenv("SSLKEYLOGFILE"))) return;
 986 if (!(fp = fopen(filename, "a"))) return;
 987 fprintf(fp, "%s\n", line);
 988 fclose(fp);
 989 }
 990 #endif
 991
 992
 993
 994
 995
 996 #ifndef DISABLE_EVENT
 997 static int
 998 verify_event(tls_support * tlsp, X509 * cert, int depth, const uschar * dn,
 999   BOOL *calledp, const BOOL *optionalp, const uschar * what)
1000 {
1001 uschar * ev;
1002 uschar * yield;
1003 X509 * old_cert;
1004
1005 ev = tlsp == &tls_out ? client_static_state->event_action : event_action;
1006 if (ev)
1007   {
1008   DEBUG(D_tls) debug_printf("verify_event: %s %d\n", what, depth);
1009   old_cert = tlsp->peercert;
1010   tlsp->peercert = X509_dup(cert);
1011   /* NB we do not bother setting peerdn */
1012   if ((yield = event_raise(ev, US"tls:cert", string_sprintf("%d", depth), &errno)))
1013     {
1014     log_write(0, LOG_MAIN, "[%s] %s verify denied by event-action: "
1015                 "depth=%d cert=%s: %s",
1016               tlsp == &tls_out ? deliver_host_address : sender_host_address,
1017               what, depth, dn, yield);
1018     *calledp = TRUE;
1019     if (!*optionalp)
1020       {
1021       if (old_cert) tlsp->peercert = old_cert;  /* restore 1st failing cert */
1022       return 1;                     /* reject (leaving peercert set) */
1023       }
1024     DEBUG(D_tls) debug_printf("Event-action verify failure overridden "
1025       "(host in tls_try_verify_hosts)\n");
1026     tlsp->verify_override = TRUE;
1027     }
1028   X509_free(tlsp->peercert);
1029   tlsp->peercert = old_cert;
1030   }
1031 return 0;
1032 }
1033 #endif
1034
1035 /*************************************************
1036 *        Callback for verification               *
1037 *************************************************/
1038
1039 /* The SSL library does certificate verification if set up to do so. This
1040 callback has the current yes/no state is in "state". If verification succeeded,
1041 we set the certificate-verified flag. If verification failed, what happens
1042 depends on whether the client is required to present a verifiable certificate
1043 or not.
1044
1045 If verification is optional, we change the state to yes, but still log the
1046 verification error. For some reason (it really would help to have proper
1047 documentation of OpenSSL), this callback function then gets called again, this
1048 time with state = 1.  We must take care not to set the private verified flag on
1049 the second time through.
1050
1051 Note: this function is not called if the client fails to present a certificate
1052 when asked. We get here only if a certificate has been received. Handling of
1053 optional verification for this case is done when requesting SSL to verify, by
1054 setting SSL_VERIFY_FAIL_IF_NO_PEER_CERT in the non-optional case.
1055
1056 May be called multiple times for different issues with a certificate, even
1057 for a given "depth" in the certificate chain.
1058
1059 Arguments:
1060   preverify_ok current yes/no state as 1/0
1061   x509ctx      certificate information.
1062   tlsp         per-direction (client vs. server) support data
1063   calledp      has-been-called flag
1064   optionalp    verification-is-optional flag
1065
1066 Returns:     0 if verification should fail, otherwise 1
1067 */
1068
1069 static int
1070 verify_callback(int preverify_ok, X509_STORE_CTX * x509ctx,
1071   tls_support * tlsp, BOOL * calledp, BOOL * optionalp)
1072 {
1073 X509 * cert = X509_STORE_CTX_get_current_cert(x509ctx);
1074 int depth = X509_STORE_CTX_get_error_depth(x509ctx);
1075 uschar dn[256];
1076
1077 if (!X509_NAME_oneline(X509_get_subject_name(cert), CS dn, sizeof(dn)))
1078   {
1079   DEBUG(D_tls) debug_printf("X509_NAME_oneline() error\n");
1080   log_write(0, LOG_MAIN, "[%s] SSL verify error: internal error",
1081     tlsp == &tls_out ? deliver_host_address : sender_host_address);
1082   return 0;
1083   }
1084 dn[sizeof(dn)-1] = '\0';
1085
1086 tlsp->verify_override = FALSE;
1087 if (preverify_ok == 0)
1088   {
1089   uschar * extra = verify_mode ? string_sprintf(" (during %c-verify for [%s])",
1090       *verify_mode, sender_host_address)
1091     : US"";
1092   log_write(0, LOG_MAIN, "[%s] SSL verify error%s: depth=%d error=%s cert=%s",
1093     tlsp == &tls_out ? deliver_host_address : sender_host_address,
1094     extra, depth,
1095     X509_verify_cert_error_string(X509_STORE_CTX_get_error(x509ctx)), dn);
1096   *calledp = TRUE;
1097   if (!*optionalp)
1098     {
1099     if (!tlsp->peercert)
1100       tlsp->peercert = X509_dup(cert);  /* record failing cert */
1101     return 0;                           /* reject */
1102     }
1103   DEBUG(D_tls) debug_printf("SSL verify failure overridden (host in "
1104     "tls_try_verify_hosts)\n");
1105   tlsp->verify_override = TRUE;
1106   }
1107
1108 else if (depth != 0)
1109   {
1110   DEBUG(D_tls) debug_printf("SSL verify ok: depth=%d SN=%s\n", depth, dn);
1111 #ifndef DISABLE_OCSP
1112   if (tlsp == &tls_out && client_static_state->u_ocsp.client.verify_store)
1113     {   /* client, wanting stapling  */
1114     /* Add the server cert's signing chain as the one
1115     for the verification of the OCSP stapled information. */
1116
1117     if (!X509_STORE_add_cert(client_static_state->u_ocsp.client.verify_store,
1118                              cert))
1119       ERR_clear_error();
1120     sk_X509_push(client_static_state->verify_stack, cert);
1121     }
1122 #endif
1123 #ifndef DISABLE_EVENT
1124     if (verify_event(tlsp, cert, depth, dn, calledp, optionalp, US"SSL"))
1125       return 0;                         /* reject, with peercert set */
1126 #endif
1127   }
1128 else
1129   {
1130   const uschar * verify_cert_hostnames;
1131
1132   if (  tlsp == &tls_out
1133      && ((verify_cert_hostnames = client_static_state->verify_cert_hostnames)))
1134         /* client, wanting hostname check */
1135     {
1136
1137 #ifdef EXIM_HAVE_OPENSSL_CHECKHOST
1138 # ifndef X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS
1139 #  define X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS 0
1140 # endif
1141 # ifndef X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS
1142 #  define X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS 0
1143 # endif
1144     int sep = 0;
1145     const uschar * list = verify_cert_hostnames;
1146     uschar * name;
1147     int rc;
1148     while ((name = string_nextinlist(&list, &sep, NULL, 0)))
1149       if ((rc = X509_check_host(cert, CCS name, 0,
1150                   X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS
1151                   | X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS,
1152                   NULL)))
1153         {
1154         if (rc < 0)
1155           {
1156           log_write(0, LOG_MAIN, "[%s] SSL verify error: internal error",
1157             tlsp == &tls_out ? deliver_host_address : sender_host_address);
1158           name = NULL;
1159           }
1160         break;
1161         }
1162     if (!name)
1163 #else
1164     if (!tls_is_name_for_cert(verify_cert_hostnames, cert))
1165 #endif
1166       {
1167       uschar * extra = verify_mode
1168         ? string_sprintf(" (during %c-verify for [%s])",
1169           *verify_mode, sender_host_address)
1170         : US"";
1171       log_write(0, LOG_MAIN,
1172         "[%s] SSL verify error%s: certificate name mismatch: DN=\"%s\" H=\"%s\"",
1173         tlsp == &tls_out ? deliver_host_address : sender_host_address,
1174         extra, dn, verify_cert_hostnames);
1175       *calledp = TRUE;
1176       if (!*optionalp)
1177         {
1178         if (!tlsp->peercert)
1179           tlsp->peercert = X509_dup(cert);      /* record failing cert */
1180         return 0;                               /* reject */
1181         }
1182       DEBUG(D_tls) debug_printf("SSL verify name failure overridden (host in "
1183         "tls_try_verify_hosts)\n");
1184       tlsp->verify_override = TRUE;
1185       }
1186     }
1187
1188 #ifndef DISABLE_EVENT
1189   if (verify_event(tlsp, cert, depth, dn, calledp, optionalp, US"SSL"))
1190     return 0;                           /* reject, with peercert set */
1191 #endif
1192
1193   DEBUG(D_tls) debug_printf("SSL%s verify ok: depth=0 SN=%s\n",
1194     *calledp ? "" : " authenticated", dn);
1195   *calledp = TRUE;
1196   }
1197
1198 return 1;   /* accept, at least for this level */
1199 }
1200
1201 static int
1202 verify_callback_client(int preverify_ok, X509_STORE_CTX *x509ctx)
1203 {
1204 return verify_callback(preverify_ok, x509ctx, &tls_out,
1205   &client_verify_callback_called, &client_verify_optional);
1206 }
1207
1208 static int
1209 verify_callback_server(int preverify_ok, X509_STORE_CTX *x509ctx)
1210 {
1211 return verify_callback(preverify_ok, x509ctx, &tls_in,
1212   &server_verify_callback_called, &server_verify_optional);
1213 }
1214
1215
1216 #ifdef SUPPORT_DANE
1217
1218 /* This gets called *by* the dane library verify callback, which interposes
1219 itself.
1220 */
1221 static int
1222 verify_callback_client_dane(int preverify_ok, X509_STORE_CTX * x509ctx)
1223 {
1224 X509 * cert = X509_STORE_CTX_get_current_cert(x509ctx);
1225 uschar dn[256];
1226 int depth = X509_STORE_CTX_get_error_depth(x509ctx);
1227 #ifndef DISABLE_EVENT
1228 BOOL dummy_called, optional = FALSE;
1229 #endif
1230
1231 if (!X509_NAME_oneline(X509_get_subject_name(cert), CS dn, sizeof(dn)))
1232   {
1233   DEBUG(D_tls) debug_printf("X509_NAME_oneline() error\n");
1234   log_write(0, LOG_MAIN, "[%s] SSL verify error: internal error",
1235     deliver_host_address);
1236   return 0;
1237   }
1238 dn[sizeof(dn)-1] = '\0';
1239
1240 DEBUG(D_tls) debug_printf("verify_callback_client_dane: %s depth %d %s\n",
1241   preverify_ok ? "ok":"BAD", depth, dn);
1242
1243 #ifndef DISABLE_EVENT
1244   if (verify_event(&tls_out, cert, depth, dn,
1245           &dummy_called, &optional, US"DANE"))
1246     return 0;                           /* reject, with peercert set */
1247 #endif
1248
1249 if (preverify_ok == 1)
1250   {
1251   tls_out.dane_verified = TRUE;
1252 #ifndef DISABLE_OCSP
1253   if (client_static_state->u_ocsp.client.verify_store)
1254     {   /* client, wanting stapling  */
1255     /* Add the server cert's signing chain as the one
1256     for the verification of the OCSP stapled information. */
1257
1258     if (!X509_STORE_add_cert(client_static_state->u_ocsp.client.verify_store,
1259                              cert))
1260       ERR_clear_error();
1261     sk_X509_push(client_static_state->verify_stack, cert);
1262     }
1263 #endif
1264   }
1265 else
1266   {
1267   int err = X509_STORE_CTX_get_error(x509ctx);
1268   DEBUG(D_tls)
1269     debug_printf(" - err %d '%s'\n", err, X509_verify_cert_error_string(err));
1270   if (err == X509_V_ERR_APPLICATION_VERIFICATION)
1271     preverify_ok = 1;
1272   }
1273 return preverify_ok;
1274 }
1275
1276 #endif  /*SUPPORT_DANE*/
1277
1278
1279 #ifndef DISABLE_OCSP
1280 /*************************************************
1281 *       Load OCSP information into state         *
1282 *************************************************/
1283 /* Called to load the server OCSP response from the given file into memory, once
1284 caller has determined this is needed.  Checks validity.  Debugs a message
1285 if invalid.
1286
1287 ASSUMES: single response, for single cert.
1288
1289 Arguments:
1290   state           various parts of session state
1291   filename        the filename putatively holding an OCSP response
1292   is_pem          file is PEM format; otherwise is DER
1293 */
1294
1295 static void
1296 ocsp_load_response(exim_openssl_state_st * state, const uschar * filename,
1297   BOOL is_pem)
1298 {
1299 BIO * bio;
1300 OCSP_RESPONSE * resp;
1301 OCSP_BASICRESP * basic_response;
1302 OCSP_SINGLERESP * single_response;
1303 ASN1_GENERALIZEDTIME * rev, * thisupd, * nextupd;
1304 STACK_OF(X509) * sk;
1305 unsigned long verify_flags;
1306 int status, reason, i;
1307
1308 DEBUG(D_tls)
1309   debug_printf("tls_ocsp_file (%s)  '%s'\n", is_pem ? "PEM" : "DER", filename);
1310
1311 if (!filename || !*filename) return;
1312
1313 ERR_clear_error();
1314 if (!(bio = BIO_new_file(CS filename, "rb")))
1315   {
1316   log_write(0, LOG_MAIN|LOG_PANIC,
1317     "Failed to open OCSP response file \"%s\": %.100s",
1318     filename, ERR_reason_error_string(ERR_get_error()));
1319   return;
1320   }
1321
1322 if (is_pem)
1323   {
1324   uschar * data, * freep;
1325   char * dummy;
1326   long len;
1327   if (!PEM_read_bio(bio, &dummy, &dummy, &data, &len))
1328     {
1329     log_write(0, LOG_MAIN|LOG_PANIC, "Failed to read PEM file \"%s\": %.100s",
1330       filename, ERR_reason_error_string(ERR_get_error()));
1331     return;
1332     }
1333   freep = data;
1334   resp = d2i_OCSP_RESPONSE(NULL, CUSS &data, len);
1335   OPENSSL_free(freep);
1336   }
1337 else
1338   resp = d2i_OCSP_RESPONSE_bio(bio, NULL);
1339 BIO_free(bio);
1340
1341 if (!resp)
1342   {
1343   log_write(0, LOG_MAIN|LOG_PANIC, "Error reading OCSP response from \"%s\": %s",
1344       filename, ERR_reason_error_string(ERR_get_error()));
1345   return;
1346   }
1347
1348 if ((status = OCSP_response_status(resp)) != OCSP_RESPONSE_STATUS_SUCCESSFUL)
1349   {
1350   DEBUG(D_tls) debug_printf("OCSP response not valid: %s (%d)\n",
1351       OCSP_response_status_str(status), status);
1352   goto bad;
1353   }
1354
1355 #ifdef notdef
1356   {
1357   BIO * bp = BIO_new_fp(debug_file, BIO_NOCLOSE);
1358   OCSP_RESPONSE_print(bp, resp, 0);  /* extreme debug: stapling content */
1359   BIO_free(bp);
1360   }
1361 #endif
1362
1363 if (!(basic_response = OCSP_response_get1_basic(resp)))
1364   {
1365   DEBUG(D_tls)
1366     debug_printf("OCSP response parse error: unable to extract basic response.\n");
1367   goto bad;
1368   }
1369
1370 sk = state->verify_stack;
1371 verify_flags = OCSP_NOVERIFY; /* check sigs, but not purpose */
1372
1373 /* May need to expose ability to adjust those flags?
1374 OCSP_NOSIGS OCSP_NOVERIFY OCSP_NOCHAIN OCSP_NOCHECKS OCSP_NOEXPLICIT
1375 OCSP_TRUSTOTHER OCSP_NOINTERN */
1376
1377 /* This does a full verify on the OCSP proof before we load it for serving
1378 up; possibly overkill - just date-checks might be nice enough.
1379
1380 OCSP_basic_verify takes a "store" arg, but does not
1381 use it for the chain verification, which is all we do
1382 when OCSP_NOVERIFY is set.  The content from the wire
1383 "basic_response" and a cert-stack "sk" are all that is used.
1384
1385 We have a stack, loaded in setup_certs() if tls_verify_certificates
1386 was a file (not a directory, or "system").  It is unfortunate we
1387 cannot used the connection context store, as that would neatly
1388 handle the "system" case too, but there seems to be no library
1389 function for getting a stack from a store.
1390 [ In OpenSSL 1.1 - ?  X509_STORE_CTX_get0_chain(ctx) ? ]
1391 We do not free the stack since it could be needed a second time for
1392 SNI handling.
1393
1394 Separately we might try to replace using OCSP_basic_verify() - which seems to not
1395 be a public interface into the OpenSSL library (there's no manual entry) -
1396 But what with?  We also use OCSP_basic_verify in the client stapling callback.
1397 And there we NEED it; we must verify that status... unless the
1398 library does it for us anyway?  */
1399
1400 if ((i = OCSP_basic_verify(basic_response, sk, NULL, verify_flags)) < 0)
1401   {
1402   DEBUG(D_tls)
1403     {
1404     ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
1405     debug_printf("OCSP response verify failure: %s\n", US ssl_errstring);
1406     }
1407   goto bad;
1408   }
1409
1410 /* Here's the simplifying assumption: there's only one response, for the
1411 one certificate we use, and nothing for anything else in a chain.  If this
1412 proves false, we need to extract a cert id from our issued cert
1413 (tls_certificate) and use that for OCSP_resp_find_status() (which finds the
1414 right cert in the stack and then calls OCSP_single_get0_status()).
1415
1416 I'm hoping to avoid reworking a bunch more of how we handle state here.
1417
1418 XXX that will change when we add support for (TLS1.3) whole-chain stapling
1419 */
1420
1421 if (!(single_response = OCSP_resp_get0(basic_response, 0)))
1422   {
1423   DEBUG(D_tls)
1424     debug_printf("Unable to get first response from OCSP basic response.\n");
1425   goto bad;
1426   }
1427
1428 status = OCSP_single_get0_status(single_response, &reason, &rev, &thisupd, &nextupd);
1429 if (status != V_OCSP_CERTSTATUS_GOOD)
1430   {
1431   DEBUG(D_tls) debug_printf("OCSP response bad cert status: %s (%d) %s (%d)\n",
1432       OCSP_cert_status_str(status), status,
1433       OCSP_crl_reason_str(reason), reason);
1434   goto bad;
1435   }
1436
1437 if (!OCSP_check_validity(thisupd, nextupd, EXIM_OCSP_SKEW_SECONDS, EXIM_OCSP_MAX_AGE))
1438   {
1439   DEBUG(D_tls) debug_printf("OCSP status invalid times.\n");
1440   goto bad;
1441   }
1442
1443 supply_response:
1444   /* Add the resp to the list used by tls_server_stapling_cb() */
1445   {
1446   ocsp_resplist ** op = &state->u_ocsp.server.olist, * oentry;
1447   while (oentry = *op)
1448     op = &oentry->next;
1449   *op = oentry = store_get(sizeof(ocsp_resplist), FALSE);
1450   oentry->next = NULL;
1451   oentry->resp = resp;
1452   }
1453 return;
1454
1455 bad:
1456   if (f.running_in_test_harness)
1457     {
1458     extern char ** environ;
1459     if (environ) for (uschar ** p = USS environ; *p; p++)
1460       if (Ustrncmp(*p, "EXIM_TESTHARNESS_DISABLE_OCSPVALIDITYCHECK", 42) == 0)
1461         {
1462         DEBUG(D_tls) debug_printf("Supplying known bad OCSP response\n");
1463         goto supply_response;
1464         }
1465     }
1466 return;
1467 }
1468
1469
1470 static void
1471 ocsp_free_response_list(exim_openssl_state_st * cbinfo)
1472 {
1473 for (ocsp_resplist * olist = cbinfo->u_ocsp.server.olist; olist;
1474      olist = olist->next)
1475   OCSP_RESPONSE_free(olist->resp);
1476 cbinfo->u_ocsp.server.olist = NULL;
1477 }
1478 #endif  /*!DISABLE_OCSP*/
1479
1480
1481
1482
1483
1484 static int
1485 tls_add_certfile(SSL_CTX * sctx, exim_openssl_state_st * cbinfo, uschar * file,
1486   uschar ** errstr)
1487 {
1488 DEBUG(D_tls) debug_printf("tls_certificate file '%s'\n", file);
1489 if (!SSL_CTX_use_certificate_chain_file(sctx, CS file))
1490   return tls_error(string_sprintf(
1491     "SSL_CTX_use_certificate_chain_file file=%s", file),
1492       cbinfo->host, NULL, errstr);
1493 return 0;
1494 }
1495
1496 static int
1497 tls_add_pkeyfile(SSL_CTX * sctx, exim_openssl_state_st * cbinfo, uschar * file,
1498   uschar ** errstr)
1499 {
1500 DEBUG(D_tls) debug_printf("tls_privatekey file  '%s'\n", file);
1501 if (!SSL_CTX_use_PrivateKey_file(sctx, CS file, SSL_FILETYPE_PEM))
1502   return tls_error(string_sprintf(
1503     "SSL_CTX_use_PrivateKey_file file=%s", file), cbinfo->host, NULL, errstr);
1504 return 0;
1505 }
1506
1507
1508
1509
1510 /* Called once during tls_init and possibly again during TLS setup, for a
1511 new context, if Server Name Indication was used and tls_sni was seen in
1512 the certificate string.
1513
1514 Arguments:
1515   sctx            the SSL_CTX* to update
1516   state           various parts of session state
1517   errstr          error string pointer
1518
1519 Returns:          OK/DEFER/FAIL
1520 */
1521
1522 static int
1523 tls_expand_session_files(SSL_CTX * sctx, exim_openssl_state_st * state,
1524   uschar ** errstr)
1525 {
1526 uschar * expanded;
1527
1528 if (!state->certificate)
1529   {
1530   if (!state->is_server)                /* client */
1531     return OK;
1532                                         /* server */
1533   if (tls_install_selfsign(sctx, errstr) != OK)
1534     return DEFER;
1535   }
1536 else
1537   {
1538   int err;
1539
1540   if ( !reexpand_tls_files_for_sni
1541      && (  Ustrstr(state->certificate, US"tls_sni")
1542         || Ustrstr(state->certificate, US"tls_in_sni")
1543         || Ustrstr(state->certificate, US"tls_out_sni")
1544      )  )
1545     reexpand_tls_files_for_sni = TRUE;
1546
1547   if (!expand_check(state->certificate, US"tls_certificate", &expanded, errstr))
1548     return DEFER;
1549
1550   if (expanded)
1551     if (state->is_server)
1552       {
1553       const uschar * file_list = expanded;
1554       int sep = 0;
1555       uschar * file;
1556 #ifndef DISABLE_OCSP
1557       const uschar * olist = state->u_ocsp.server.file;
1558       int osep = 0;
1559       uschar * ofile;
1560       BOOL fmt_pem = FALSE;
1561
1562       if (olist)
1563         if (!expand_check(olist, US"tls_ocsp_file", USS &olist, errstr))
1564           return DEFER;
1565       if (olist && !*olist)
1566         olist = NULL;
1567
1568       if (  state->u_ocsp.server.file_expanded && olist
1569          && (Ustrcmp(olist, state->u_ocsp.server.file_expanded) == 0))
1570         {
1571         DEBUG(D_tls) debug_printf(" - value unchanged, using existing values\n");
1572         olist = NULL;
1573         }
1574       else
1575         {
1576         ocsp_free_response_list(state);
1577         state->u_ocsp.server.file_expanded = olist;
1578         }
1579 #endif
1580
1581       while (file = string_nextinlist(&file_list, &sep, NULL, 0))
1582         {
1583         if ((err = tls_add_certfile(sctx, state, file, errstr)))
1584           return err;
1585
1586 #ifndef DISABLE_OCSP
1587         if (olist)
1588           if ((ofile = string_nextinlist(&olist, &osep, NULL, 0)))
1589             {
1590             if (Ustrncmp(ofile, US"PEM ", 4) == 0)
1591               {
1592               fmt_pem = TRUE;
1593               ofile += 4;
1594               }
1595             else if (Ustrncmp(ofile, US"DER ", 4) == 0)
1596               {
1597               fmt_pem = FALSE;
1598               ofile += 4;
1599               }
1600             ocsp_load_response(state, ofile, fmt_pem);
1601             }
1602           else
1603             DEBUG(D_tls) debug_printf("ran out of ocsp file list\n");
1604 #endif
1605         }
1606       }
1607     else        /* would there ever be a need for multiple client certs? */
1608       if ((err = tls_add_certfile(sctx, state, expanded, errstr)))
1609         return err;
1610
1611   if (  state->privatekey
1612      && !expand_check(state->privatekey, US"tls_privatekey", &expanded, errstr))
1613     return DEFER;
1614
1615   /* If expansion was forced to fail, key_expanded will be NULL. If the result
1616   of the expansion is an empty string, ignore it also, and assume the private
1617   key is in the same file as the certificate. */
1618
1619   if (expanded && *expanded)
1620     if (state->is_server)
1621       {
1622       const uschar * file_list = expanded;
1623       int sep = 0;
1624       uschar * file;
1625
1626       while (file = string_nextinlist(&file_list, &sep, NULL, 0))
1627         if ((err = tls_add_pkeyfile(sctx, state, file, errstr)))
1628           return err;
1629       }
1630     else        /* would there ever be a need for multiple client certs? */
1631       if ((err = tls_add_pkeyfile(sctx, state, expanded, errstr)))
1632         return err;
1633   }
1634
1635 return OK;
1636 }
1637
1638
1639
1640
1641 /**************************************************
1642 * One-time init credentials for server and client *
1643 **************************************************/
1644
1645 static void
1646 normalise_ciphers(uschar ** ciphers, const uschar * pre_expansion_ciphers)
1647 {
1648 uschar * s = *ciphers;
1649
1650 if (!s || !Ustrchr(s, '_')) return;     /* no change needed */
1651
1652 if (s == pre_expansion_ciphers)
1653   s = string_copy(s);                   /* get writable copy */
1654
1655 for (uschar * t = s; *t; t++) if (*t == '_') *t = '-';
1656 *ciphers = s;
1657 }
1658
1659 static int
1660 server_load_ciphers(SSL_CTX * ctx, exim_openssl_state_st * state,
1661   uschar * ciphers, uschar ** errstr)
1662 {
1663 DEBUG(D_tls) debug_printf("required ciphers: %s\n", ciphers);
1664 if (!SSL_CTX_set_cipher_list(ctx, CS ciphers))
1665   return tls_error(US"SSL_CTX_set_cipher_list", NULL, NULL, errstr);
1666 state->server_cipher_list = ciphers;
1667 return OK;
1668 }
1669
1670
1671
1672 static int
1673 lib_ctx_new(SSL_CTX ** ctxp, host_item * host, uschar ** errstr)
1674 {
1675 SSL_CTX * ctx;
1676 #ifdef EXIM_HAVE_OPENSSL_TLS_METHOD
1677 if (!(ctx = SSL_CTX_new(host ? TLS_client_method() : TLS_server_method())))
1678 #else
1679 if (!(ctx = SSL_CTX_new(host ? SSLv23_client_method() : SSLv23_server_method())))
1680 #endif
1681   return tls_error(US"SSL_CTX_new", host, NULL, errstr);
1682
1683 /* Set up the information callback, which outputs if debugging is at a suitable
1684 level. */
1685
1686 DEBUG(D_tls)
1687   {
1688   SSL_CTX_set_info_callback(ctx, (void (*)())info_callback);
1689 #if defined(EXIM_HAVE_OPESSL_TRACE) && !defined(OPENSSL_NO_SSL_TRACE)
1690   /* this needs a debug build of OpenSSL */
1691   SSL_CTX_set_msg_callback(ctx, (void (*)())SSL_trace);
1692 #endif
1693 #ifdef OPENSSL_HAVE_KEYLOG_CB
1694   SSL_CTX_set_keylog_callback(ctx, (void (*)())keylog_callback);
1695 #endif
1696   }
1697
1698 /* Automatically re-try reads/writes after renegotiation. */
1699 (void) SSL_CTX_set_mode(ctx, SSL_MODE_AUTO_RETRY);
1700 *ctxp = ctx;
1701 return OK;
1702 }
1703
1704
1705 static unsigned
1706 tls_server_creds_init(void)
1707 {
1708 SSL_CTX * ctx;
1709 uschar * dummy_errstr;
1710 unsigned lifetime = 0;
1711
1712 tls_openssl_init();
1713
1714 state_server.lib_state = null_tls_preload;
1715
1716 if (lib_ctx_new(&ctx, NULL, &dummy_errstr) != OK)
1717   return 0;
1718 state_server.lib_state.lib_ctx = ctx;
1719
1720 /* Preload DH params and EC curve */
1721
1722 if (opt_unset_or_noexpand(tls_dhparam))
1723   {
1724   DEBUG(D_tls) debug_printf("TLS: preloading DH params for server\n");
1725   if (init_dh(ctx, tls_dhparam, &dummy_errstr))
1726     state_server.lib_state.dh = TRUE;
1727   }
1728 else
1729   DEBUG(D_tls) debug_printf("TLS: not preloading DH params for server\n");
1730 if (opt_unset_or_noexpand(tls_eccurve))
1731   {
1732   DEBUG(D_tls) debug_printf("TLS: preloading ECDH curve for server\n");
1733   if (init_ecdh(ctx, &dummy_errstr))
1734     state_server.lib_state.ecdh = TRUE;
1735   }
1736 else
1737   DEBUG(D_tls) debug_printf("TLS: not preloading ECDH curve for server\n");
1738
1739 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
1740 /* If we can, preload the server-side cert, key and ocsp */
1741
1742 if (  opt_set_and_noexpand(tls_certificate)
1743 # ifndef DISABLE_OCSP
1744    && opt_unset_or_noexpand(tls_ocsp_file)
1745 #endif
1746    && opt_unset_or_noexpand(tls_privatekey))
1747   {
1748   /* Set watches on the filenames.  The implementation does de-duplication
1749   so we can just blindly do them all.  */
1750
1751   if (  tls_set_watch(tls_certificate, TRUE)
1752 # ifndef DISABLE_OCSP
1753      && tls_set_watch(tls_ocsp_file, TRUE)
1754 #endif
1755      && tls_set_watch(tls_privatekey, TRUE))
1756     {
1757     state_server.certificate = tls_certificate;
1758     state_server.privatekey = tls_privatekey;
1759 #ifndef DISABLE_OCSP
1760     state_server.u_ocsp.server.file = tls_ocsp_file;
1761 #endif
1762
1763     DEBUG(D_tls) debug_printf("TLS: preloading server certs\n");
1764     if (tls_expand_session_files(ctx, &state_server, &dummy_errstr) == OK)
1765       state_server.lib_state.conn_certs = TRUE;
1766     }
1767   }
1768 else if (  !tls_certificate && !tls_privatekey
1769 # ifndef DISABLE_OCSP
1770         && !tls_ocsp_file
1771 #endif
1772    )
1773   {             /* Generate & preload a selfsigned cert. No files to watch. */
1774   if (tls_expand_session_files(ctx, &state_server, &dummy_errstr) == OK)
1775     {
1776     state_server.lib_state.conn_certs = TRUE;
1777     lifetime = f.running_in_test_harness ? 2 : 60 * 60;         /* 1 hour */
1778     }
1779   }
1780 else
1781   DEBUG(D_tls) debug_printf("TLS: not preloading server certs\n");
1782
1783
1784 /* If we can, preload the Authorities for checking client certs against.
1785 Actual choice to do verify is made (tls_{,try_}verify_hosts)
1786 at TLS conn startup */
1787
1788 if (  opt_set_and_noexpand(tls_verify_certificates)
1789    && opt_unset_or_noexpand(tls_crl))
1790   {
1791   /* Watch the default dir also as they are always included */
1792
1793   if (  tls_set_watch(CUS X509_get_default_cert_file(), FALSE)
1794      && tls_set_watch(tls_verify_certificates, FALSE)
1795      && tls_set_watch(tls_crl, FALSE))
1796     {
1797     DEBUG(D_tls) debug_printf("TLS: preloading CA bundle for server\n");
1798
1799     if (setup_certs(ctx, tls_verify_certificates, tls_crl, NULL, &dummy_errstr)
1800         == OK)
1801       state_server.lib_state.cabundle = TRUE;
1802     }
1803   }
1804 else
1805   DEBUG(D_tls) debug_printf("TLS: not preloading CA bundle for server\n");
1806 #endif  /* EXIM_HAVE_INOTIFY */
1807
1808
1809 /* If we can, preload the ciphers control string */
1810
1811 if (opt_set_and_noexpand(tls_require_ciphers))
1812   {
1813   DEBUG(D_tls) debug_printf("TLS: preloading cipher list for server\n");
1814   normalise_ciphers(&tls_require_ciphers, tls_require_ciphers);
1815   if (server_load_ciphers(ctx, &state_server, tls_require_ciphers,
1816                           &dummy_errstr) == OK)
1817     state_server.lib_state.pri_string = TRUE;
1818   }
1819 else
1820   DEBUG(D_tls) debug_printf("TLS: not preloading cipher list for server\n");
1821 return lifetime;
1822 }
1823
1824
1825
1826
1827 /* Preload whatever creds are static, onto a transport.  The client can then
1828 just copy the pointer as it starts up.
1829 Called from the daemon after a cache-invalidate with watch set; called from
1830 a queue-run startup with watch clear. */
1831
1832 static void
1833 tls_client_creds_init(transport_instance * t, BOOL watch)
1834 {
1835 smtp_transport_options_block * ob = t->options_block;
1836 exim_openssl_state_st tpt_dummy_state;
1837 host_item * dummy_host = (host_item *)1;
1838 uschar * dummy_errstr;
1839 SSL_CTX * ctx;
1840
1841 tls_openssl_init();
1842
1843 ob->tls_preload = null_tls_preload;
1844 if (lib_ctx_new(&ctx, dummy_host, &dummy_errstr) != OK)
1845   return;
1846 ob->tls_preload.lib_ctx = ctx;
1847
1848 tpt_dummy_state.lib_state = ob->tls_preload;
1849
1850 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
1851 if (  opt_set_and_noexpand(ob->tls_certificate)
1852    && opt_unset_or_noexpand(ob->tls_privatekey))
1853   {
1854   if (  !watch
1855      || (  tls_set_watch(ob->tls_certificate, FALSE)
1856         && tls_set_watch(ob->tls_privatekey, FALSE)
1857      )  )
1858     {
1859     uschar * pkey = ob->tls_privatekey;
1860
1861     DEBUG(D_tls)
1862       debug_printf("TLS: preloading client certs for transport '%s'\n",t->name);
1863
1864     if (  tls_add_certfile(ctx, &tpt_dummy_state, ob->tls_certificate,
1865                                     &dummy_errstr) == 0
1866        && tls_add_pkeyfile(ctx, &tpt_dummy_state,
1867                                     pkey ? pkey : ob->tls_certificate,
1868                                     &dummy_errstr) == 0
1869        )
1870       ob->tls_preload.conn_certs = TRUE;
1871     }
1872   }
1873 else
1874   DEBUG(D_tls)
1875     debug_printf("TLS: not preloading client certs, for transport '%s'\n", t->name);
1876
1877
1878 if (  opt_set_and_noexpand(ob->tls_verify_certificates)
1879    && opt_unset_or_noexpand(ob->tls_crl))
1880   {
1881   if (  !watch
1882      ||    tls_set_watch(CUS X509_get_default_cert_file(), FALSE)
1883         && tls_set_watch(ob->tls_verify_certificates, FALSE)
1884         && tls_set_watch(ob->tls_crl, FALSE)
1885      )
1886     {
1887     DEBUG(D_tls)
1888       debug_printf("TLS: preloading CA bundle for transport '%s'\n", t->name);
1889
1890     if (setup_certs(ctx, ob->tls_verify_certificates,
1891           ob->tls_crl, dummy_host, &dummy_errstr) == OK)
1892       ob->tls_preload.cabundle = TRUE;
1893     }
1894   }
1895 else
1896   DEBUG(D_tls)
1897       debug_printf("TLS: not preloading CA bundle, for transport '%s'\n", t->name);
1898
1899 #endif /*EXIM_HAVE_INOTIFY*/
1900 }
1901
1902
1903 #if defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT)
1904 /* Invalidate the creds cached, by dropping the current ones.
1905 Call when we notice one of the source files has changed. */
1906
1907 static void
1908 tls_server_creds_invalidate(void)
1909 {
1910 SSL_CTX_free(state_server.lib_state.lib_ctx);
1911 state_server.lib_state = null_tls_preload;
1912 }
1913
1914
1915 static void
1916 tls_client_creds_invalidate(transport_instance * t)
1917 {
1918 smtp_transport_options_block * ob = t->options_block;
1919 SSL_CTX_free(ob->tls_preload.lib_ctx);
1920 ob->tls_preload = null_tls_preload;
1921 }
1922
1923 #else
1924
1925 static void
1926 tls_server_creds_invalidate(void)
1927 { return; }
1928
1929 static void
1930 tls_client_creds_invalidate(transport_instance * t)
1931 { return; }
1932
1933 #endif  /*EXIM_HAVE_INOTIFY*/
1934
1935
1936 /* Extreme debug
1937 #ifndef DISABLE_OCSP
1938 void
1939 x509_store_dump_cert_s_names(X509_STORE * store)
1940 {
1941 STACK_OF(X509_OBJECT) * roots= store->objs;
1942 static uschar name[256];
1943
1944 for (int i= 0; i < sk_X509_OBJECT_num(roots); i++)
1945   {
1946   X509_OBJECT * tmp_obj= sk_X509_OBJECT_value(roots, i);
1947   if(tmp_obj->type == X509_LU_X509)
1948     {
1949     X509_NAME * sn = X509_get_subject_name(tmp_obj->data.x509);
1950     if (X509_NAME_oneline(sn, CS name, sizeof(name)))
1951       {
1952       name[sizeof(name)-1] = '\0';
1953       debug_printf(" %s\n", name);
1954       }
1955     }
1956   }
1957 }
1958 #endif
1959 */
1960
1961
1962 #ifndef DISABLE_TLS_RESUME
1963 /* Manage the keysets used for encrypting the session tickets, on the server. */
1964
1965 typedef struct {                        /* Session ticket encryption key */
1966   uschar        name[16];
1967
1968   const EVP_CIPHER *    aes_cipher;
1969   uschar                aes_key[32];    /* size needed depends on cipher. aes_128 implies 128/8 = 16? */
1970 # if OPENSSL_VERSION_NUMBER < 0x30000000L
1971   const EVP_MD *        hmac_hash;
1972 # else
1973   const uschar *        hmac_hashname;
1974 # endif
1975   uschar                hmac_key[16];
1976   time_t                renew;
1977   time_t                expire;
1978 } exim_stek;
1979
1980 static exim_stek exim_tk;       /* current key */
1981 static exim_stek exim_tk_old;   /* previous key */
1982
1983 static void
1984 tk_init(void)
1985 {
1986 time_t t = time(NULL);
1987
1988 if (exim_tk.name[0])
1989   {
1990   if (exim_tk.renew >= t) return;
1991   exim_tk_old = exim_tk;
1992   }
1993
1994 if (f.running_in_test_harness) ssl_session_timeout = 6;
1995
1996 DEBUG(D_tls) debug_printf("OpenSSL: %s STEK\n", exim_tk.name[0] ? "rotating" : "creating");
1997 if (RAND_bytes(exim_tk.aes_key, sizeof(exim_tk.aes_key)) <= 0) return;
1998 if (RAND_bytes(exim_tk.hmac_key, sizeof(exim_tk.hmac_key)) <= 0) return;
1999 if (RAND_bytes(exim_tk.name+1, sizeof(exim_tk.name)-1) <= 0) return;
2000
2001 exim_tk.name[0] = 'E';
2002 exim_tk.aes_cipher = EVP_aes_256_cbc();
2003 # if OPENSSL_VERSION_NUMBER < 0x30000000L
2004 exim_tk.hmac_hash = EVP_sha256();
2005 # else
2006 exim_tk.hmac_hashname = US "sha256";
2007 # endif
2008 exim_tk.expire = t + ssl_session_timeout;
2009 exim_tk.renew = t + ssl_session_timeout/2;
2010 }
2011
2012 static exim_stek *
2013 tk_current(void)
2014 {
2015 if (!exim_tk.name[0]) return NULL;
2016 return &exim_tk;
2017 }
2018
2019 static exim_stek *
2020 tk_find(const uschar * name)
2021 {
2022 return memcmp(name, exim_tk.name, sizeof(exim_tk.name)) == 0 ? &exim_tk
2023   : memcmp(name, exim_tk_old.name, sizeof(exim_tk_old.name)) == 0 ? &exim_tk_old
2024   : NULL;
2025 }
2026
2027
2028 static int
2029 tk_hmac_init(
2030 # if OPENSSL_VERSION_NUMBER < 0x30000000L
2031   HMAC_CTX * hctx,
2032 #else
2033   EVP_MAC_CTX * hctx,
2034 #endif
2035   exim_stek * key
2036   )
2037 {
2038 /*XXX will want these dependent on the ssl session strength */
2039 # if OPENSSL_VERSION_NUMBER < 0x30000000L
2040   HMAC_Init_ex(hctx, key->hmac_key, sizeof(key->hmac_key),
2041                 key->hmac_hash, NULL);
2042 #else
2043  {
2044   OSSL_PARAM params[3];
2045   uschar * hk = string_copy(key->hmac_hashname);        /* need nonconst */
2046   params[0] = OSSL_PARAM_construct_octet_string("key", key->hmac_key, sizeof(key->hmac_key));
2047   params[1] = OSSL_PARAM_construct_utf8_string("digest", CS hk, 0);
2048   params[2] = OSSL_PARAM_construct_end();
2049   if (EVP_MAC_CTX_set_params(hctx, params) == 0)
2050     {
2051     DEBUG(D_tls) debug_printf("EVP_MAC_CTX_set_params: %s\n",
2052       ERR_reason_error_string(ERR_get_error()));
2053     return 0; /* error in mac initialisation */
2054     }
2055 }
2056 #endif
2057 return 1;
2058 }
2059
2060 /* Callback for session tickets, on server */
2061 static int
2062 ticket_key_callback(SSL * ssl, uschar key_name[16],
2063   uschar * iv, EVP_CIPHER_CTX * c_ctx,
2064 # if OPENSSL_VERSION_NUMBER < 0x30000000L
2065   HMAC_CTX * hctx,
2066 #else
2067   EVP_MAC_CTX * hctx,
2068 #endif
2069   int enc)
2070 {
2071 tls_support * tlsp = state_server.tlsp;
2072 exim_stek * key;
2073
2074 if (enc)
2075   {
2076   DEBUG(D_tls) debug_printf("ticket_key_callback: create new session\n");
2077   tlsp->resumption |= RESUME_CLIENT_REQUESTED;
2078
2079   if (RAND_bytes(iv, EVP_MAX_IV_LENGTH) <= 0)
2080     return -1; /* insufficient random */
2081
2082   if (!(key = tk_current()))    /* current key doesn't exist or isn't valid */
2083      return 0;                  /* key couldn't be created */
2084   memcpy(key_name, key->name, 16);
2085   DEBUG(D_tls) debug_printf("STEK expire " TIME_T_FMT "\n", key->expire - time(NULL));
2086
2087   if (tk_hmac_init(hctx, key) == 0) return 0;
2088   EVP_EncryptInit_ex(c_ctx, key->aes_cipher, NULL, key->aes_key, iv);
2089
2090   DEBUG(D_tls) debug_printf("ticket created\n");
2091   return 1;
2092   }
2093 else
2094   {
2095   time_t now = time(NULL);
2096
2097   DEBUG(D_tls) debug_printf("ticket_key_callback: retrieve session\n");
2098   tlsp->resumption |= RESUME_CLIENT_SUGGESTED;
2099
2100   if (!(key = tk_find(key_name)) || key->expire < now)
2101     {
2102     DEBUG(D_tls)
2103       {
2104       debug_printf("ticket not usable (%s)\n", key ? "expired" : "not found");
2105       if (key) debug_printf("STEK expire " TIME_T_FMT "\n", key->expire - now);
2106       }
2107     return 0;
2108     }
2109
2110   if (tk_hmac_init(hctx, key) == 0) return 0;
2111   EVP_DecryptInit_ex(c_ctx, key->aes_cipher, NULL, key->aes_key, iv);
2112
2113   DEBUG(D_tls) debug_printf("ticket usable, STEK expire " TIME_T_FMT "\n", key->expire - now);
2114
2115   /* The ticket lifetime and renewal are the same as the STEK lifetime and
2116   renewal, which is overenthusiastic.  A factor of, say, 3x longer STEK would
2117   be better.  To do that we'd have to encode ticket lifetime in the name as
2118   we don't yet see the restored session.  Could check posthandshake for TLS1.3
2119   and trigger a new ticket then, but cannot do that for TLS1.2 */
2120   return key->renew < now ? 2 : 1;
2121   }
2122 }
2123 #endif  /* !DISABLE_TLS_RESUME */
2124
2125
2126
2127 static void
2128 setup_cert_verify(SSL_CTX * ctx, BOOL optional,
2129     int (*cert_vfy_cb)(int, X509_STORE_CTX *))
2130 {
2131 /* If verification is optional, don't fail if no certificate */
2132
2133 SSL_CTX_set_verify(ctx,
2134     SSL_VERIFY_PEER | (optional ? 0 : SSL_VERIFY_FAIL_IF_NO_PEER_CERT),
2135     cert_vfy_cb);
2136 }
2137
2138
2139 /*************************************************
2140 *            Callback to handle SNI              *
2141 *************************************************/
2142
2143 /* Called when acting as server during the TLS session setup if a Server Name
2144 Indication extension was sent by the client.
2145
2146 API documentation is OpenSSL s_server.c implementation.
2147
2148 Arguments:
2149   s               SSL* of the current session
2150   ad              unknown (part of OpenSSL API) (unused)
2151   arg             Callback of "our" registered data
2152
2153 Returns:          SSL_TLSEXT_ERR_{OK,ALERT_WARNING,ALERT_FATAL,NOACK}
2154
2155 XXX might need to change to using ClientHello callback,
2156 per https://www.openssl.org/docs/manmaster/man3/SSL_client_hello_cb_fn.html
2157 */
2158
2159 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
2160 static int
2161 tls_servername_cb(SSL *s, int *ad ARG_UNUSED, void *arg)
2162 {
2163 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
2164 exim_openssl_state_st *state = (exim_openssl_state_st *) arg;
2165 int rc;
2166 int old_pool = store_pool;
2167 uschar * dummy_errstr;
2168
2169 if (!servername)
2170   return SSL_TLSEXT_ERR_OK;
2171
2172 DEBUG(D_tls) debug_printf("Received TLS SNI \"%s\"%s\n", servername,
2173     reexpand_tls_files_for_sni ? "" : " (unused for certificate selection)");
2174
2175 /* Make the extension value available for expansion */
2176 store_pool = POOL_PERM;
2177 tls_in.sni = string_copy_taint(US servername, TRUE);
2178 store_pool = old_pool;
2179
2180 if (!reexpand_tls_files_for_sni)
2181   return SSL_TLSEXT_ERR_OK;
2182
2183 /* Can't find an SSL_CTX_clone() or equivalent, so we do it manually;
2184 not confident that memcpy wouldn't break some internal reference counting.
2185 Especially since there's a references struct member, which would be off. */
2186
2187 if (lib_ctx_new(&server_sni, NULL, &dummy_errstr) != OK)
2188   goto bad;
2189
2190 /* Not sure how many of these are actually needed, since SSL object
2191 already exists.  Might even need this selfsame callback, for reneg? */
2192
2193   {
2194   SSL_CTX * ctx = state_server.lib_state.lib_ctx;
2195   SSL_CTX_set_info_callback(server_sni, SSL_CTX_get_info_callback(ctx));
2196   SSL_CTX_set_mode(server_sni, SSL_CTX_get_mode(ctx));
2197   SSL_CTX_set_options(server_sni, SSL_CTX_get_options(ctx));
2198   SSL_CTX_set_timeout(server_sni, SSL_CTX_get_timeout(ctx));
2199   SSL_CTX_set_tlsext_servername_callback(server_sni, tls_servername_cb);
2200   SSL_CTX_set_tlsext_servername_arg(server_sni, state);
2201   }
2202
2203 if (  !init_dh(server_sni, state->dhparam, &dummy_errstr)
2204    || !init_ecdh(server_sni, &dummy_errstr)
2205    )
2206   goto bad;
2207
2208 if (  state->server_cipher_list
2209    && !SSL_CTX_set_cipher_list(server_sni, CS state->server_cipher_list))
2210   goto bad;
2211
2212 #ifndef DISABLE_OCSP
2213 if (state->u_ocsp.server.file)
2214   {
2215   SSL_CTX_set_tlsext_status_cb(server_sni, tls_server_stapling_cb);
2216   SSL_CTX_set_tlsext_status_arg(server_sni, state);
2217   }
2218 #endif
2219
2220   {
2221   uschar * expcerts;
2222   if (  !expand_check(tls_verify_certificates, US"tls_verify_certificates",
2223                   &expcerts, &dummy_errstr)
2224      || (rc = setup_certs(server_sni, expcerts, tls_crl, NULL,
2225                         &dummy_errstr)) != OK)
2226     goto bad;
2227
2228   if (expcerts && *expcerts)
2229     setup_cert_verify(server_sni, FALSE, verify_callback_server);
2230   }
2231
2232 /* do this after setup_certs, because this can require the certs for verifying
2233 OCSP information. */
2234 if ((rc = tls_expand_session_files(server_sni, state, &dummy_errstr)) != OK)
2235   goto bad;
2236
2237 DEBUG(D_tls) debug_printf("Switching SSL context.\n");
2238 SSL_set_SSL_CTX(s, server_sni);
2239 return SSL_TLSEXT_ERR_OK;
2240
2241 bad: return SSL_TLSEXT_ERR_ALERT_FATAL;
2242 }
2243 #endif /* EXIM_HAVE_OPENSSL_TLSEXT */
2244
2245
2246
2247
2248 #ifdef EXIM_HAVE_ALPN
2249 /*************************************************
2250 *        Callback to handle ALPN                 *
2251 *************************************************/
2252
2253 /* Called on server if tls_alpn nonblank after expansion,
2254 when client offers ALPN, after the SNI callback.
2255 If set and not matching the list then we dump the connection */
2256
2257 static int
2258 tls_server_alpn_cb(SSL *ssl, const uschar ** out, uschar * outlen,
2259   const uschar * in, unsigned int inlen, void * arg)
2260 {
2261 server_seen_alpn = TRUE;
2262 DEBUG(D_tls)
2263   {
2264   debug_printf("Received TLS ALPN offer:");
2265   for (int pos = 0, siz; pos < inlen; pos += siz+1)
2266     {
2267     siz = in[pos];
2268     if (pos + 1 + siz > inlen) siz = inlen - pos - 1;
2269     debug_printf(" '%.*s'", siz, in + pos + 1);
2270     }
2271   debug_printf(".  Our list: '%s'\n", tls_alpn);
2272   }
2273
2274 /* Look for an acceptable ALPN */
2275
2276 if (  inlen > 1         /* at least one name */
2277    && in[0]+1 == inlen  /* filling the vector, so exactly one name */
2278    )
2279   {
2280   const uschar * list = tls_alpn;
2281   int sep = 0;
2282   for (uschar * name; name = string_nextinlist(&list, &sep, NULL, 0); )
2283     if (Ustrncmp(in+1, name, in[0]) == 0)
2284       {
2285       *out = in+1;                      /* we checked for exactly one, so can just point to it */
2286       *outlen = inlen;
2287       return SSL_TLSEXT_ERR_OK;         /* use ALPN */
2288       }
2289   }
2290
2291 /* More than one name from clilent, or name did not match our list. */
2292
2293 /* This will be fatal to the TLS conn; would be nice to kill TCP also.
2294 Maybe as an option in future; for now leave control to the config (must-tls). */
2295
2296 DEBUG(D_tls) debug_printf("TLS ALPN rejected\n");
2297 return SSL_TLSEXT_ERR_ALERT_FATAL;
2298 }
2299 #endif  /* EXIM_HAVE_ALPN */
2300
2301
2302
2303 #ifndef DISABLE_OCSP
2304
2305 /*************************************************
2306 *        Callback to handle OCSP Stapling        *
2307 *************************************************/
2308
2309 /* Called when acting as server during the TLS session setup if the client
2310 requests OCSP information with a Certificate Status Request.
2311
2312 Documentation via openssl s_server.c and the Apache patch from the OpenSSL
2313 project.
2314
2315 */
2316
2317 static int
2318 tls_server_stapling_cb(SSL *s, void *arg)
2319 {
2320 const exim_openssl_state_st * state = arg;
2321 ocsp_resplist * olist = state->u_ocsp.server.olist;
2322 uschar * response_der;  /*XXX blob */
2323 int response_der_len;
2324
2325 DEBUG(D_tls)
2326   debug_printf("Received TLS status request (OCSP stapling); %s response list\n",
2327     olist ? "have" : "lack");
2328
2329 tls_in.ocsp = OCSP_NOT_RESP;
2330 if (!olist)
2331   return SSL_TLSEXT_ERR_NOACK;
2332
2333 #ifdef EXIM_HAVE_OPESSL_GET0_SERIAL
2334  {
2335   const X509 * cert_sent = SSL_get_certificate(s);
2336   const ASN1_INTEGER * cert_serial = X509_get0_serialNumber(cert_sent);
2337   const BIGNUM * cert_bn = ASN1_INTEGER_to_BN(cert_serial, NULL);
2338
2339   for (; olist; olist = olist->next)
2340     {
2341     OCSP_BASICRESP * bs = OCSP_response_get1_basic(olist->resp);
2342     const OCSP_SINGLERESP * single = OCSP_resp_get0(bs, 0);
2343     const OCSP_CERTID * cid = OCSP_SINGLERESP_get0_id(single);
2344     ASN1_INTEGER * res_cert_serial;
2345     const BIGNUM * resp_bn;
2346     ASN1_OCTET_STRING * res_cert_iNameHash;
2347
2348
2349     (void) OCSP_id_get0_info(&res_cert_iNameHash, NULL, NULL, &res_cert_serial,
2350       (OCSP_CERTID *) cid);
2351     resp_bn = ASN1_INTEGER_to_BN(res_cert_serial, NULL);
2352
2353     DEBUG(D_tls)
2354       {
2355       debug_printf("cert serial: %s\n", BN_bn2hex(cert_bn));
2356       debug_printf("resp serial: %s\n", BN_bn2hex(resp_bn));
2357       }
2358
2359     if (BN_cmp(cert_bn, resp_bn) == 0)
2360       {
2361       DEBUG(D_tls) debug_printf("matched serial for ocsp\n");
2362
2363       /*XXX TODO: check the rest of the list for duplicate matches.
2364       If any, need to also check the Issuer Name hash.
2365       Without this, we will provide the wrong status in the case of
2366       duplicate id. */
2367
2368       break;
2369       }
2370     DEBUG(D_tls) debug_printf("not match serial for ocsp\n");
2371     }
2372   if (!olist)
2373     {
2374     DEBUG(D_tls) debug_printf("failed to find match for ocsp\n");
2375     return SSL_TLSEXT_ERR_NOACK;
2376     }
2377  }
2378 #else
2379 if (olist->next)
2380   {
2381   DEBUG(D_tls) debug_printf("OpenSSL version too early to support multi-leaf OCSP\n");
2382   return SSL_TLSEXT_ERR_NOACK;
2383   }
2384 #endif
2385
2386 /*XXX could we do the i2d earlier, rather than during the callback? */
2387 response_der = NULL;
2388 response_der_len = i2d_OCSP_RESPONSE(olist->resp, &response_der);
2389 if (response_der_len <= 0)
2390   return SSL_TLSEXT_ERR_NOACK;
2391
2392 SSL_set_tlsext_status_ocsp_resp(state_server.lib_state.lib_ssl,
2393                                 response_der, response_der_len);
2394 tls_in.ocsp = OCSP_VFIED;
2395 return SSL_TLSEXT_ERR_OK;
2396 }
2397
2398
2399 static void
2400 time_print(BIO * bp, const char * str, ASN1_GENERALIZEDTIME * time)
2401 {
2402 BIO_printf(bp, "\t%s: ", str);
2403 ASN1_GENERALIZEDTIME_print(bp, time);
2404 BIO_puts(bp, "\n");
2405 }
2406
2407 static int
2408 tls_client_stapling_cb(SSL *s, void *arg)
2409 {
2410 exim_openssl_state_st * cbinfo = arg;
2411 const unsigned char * p;
2412 int len;
2413 OCSP_RESPONSE * rsp;
2414 OCSP_BASICRESP * bs;
2415 int i;
2416
2417 DEBUG(D_tls) debug_printf("Received TLS status callback (OCSP stapling):\n");
2418 len = SSL_get_tlsext_status_ocsp_resp(s, &p);
2419 if(!p)
2420  {
2421   /* Expect this when we requested ocsp but got none */
2422   if (cbinfo->u_ocsp.client.verify_required && LOGGING(tls_cipher))
2423     log_write(0, LOG_MAIN, "Required TLS certificate status not received");
2424   else
2425     DEBUG(D_tls) debug_printf(" null\n");
2426   return cbinfo->u_ocsp.client.verify_required ? 0 : 1;
2427  }
2428
2429 if (!(rsp = d2i_OCSP_RESPONSE(NULL, &p, len)))
2430   {
2431   tls_out.ocsp = OCSP_FAILED;   /*XXX should use tlsp-> to permit concurrent outbound */
2432   if (LOGGING(tls_cipher))
2433     log_write(0, LOG_MAIN, "Received TLS cert status response, parse error");
2434   else
2435     DEBUG(D_tls) debug_printf(" parse error\n");
2436   return 0;
2437   }
2438
2439 if (!(bs = OCSP_response_get1_basic(rsp)))
2440   {
2441   tls_out.ocsp = OCSP_FAILED;
2442   if (LOGGING(tls_cipher))
2443     log_write(0, LOG_MAIN, "Received TLS cert status response, error parsing response");
2444   else
2445     DEBUG(D_tls) debug_printf(" error parsing response\n");
2446   OCSP_RESPONSE_free(rsp);
2447   return 0;
2448   }
2449
2450 /* We'd check the nonce here if we'd put one in the request. */
2451 /* However that would defeat cacheability on the server so we don't. */
2452
2453 /* This section of code reworked from OpenSSL apps source;
2454    The OpenSSL Project retains copyright:
2455    Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
2456 */
2457   {
2458     BIO * bp = NULL;
2459 #ifndef EXIM_HAVE_OCSP_RESP_COUNT
2460     STACK_OF(OCSP_SINGLERESP) * sresp = bs->tbsResponseData->responses;
2461 #endif
2462
2463     DEBUG(D_tls) bp = BIO_new_fp(debug_file, BIO_NOCLOSE);
2464
2465     /*OCSP_RESPONSE_print(bp, rsp, 0);   extreme debug: stapling content */
2466
2467     /* Use the chain that verified the server cert to verify the stapled info */
2468     /* DEBUG(D_tls) x509_store_dump_cert_s_names(cbinfo->u_ocsp.client.verify_store); */
2469
2470     if ((i = OCSP_basic_verify(bs, cbinfo->verify_stack,
2471               cbinfo->u_ocsp.client.verify_store, OCSP_NOEXPLICIT)) <= 0)
2472       if (ERR_peek_error())
2473         {
2474         tls_out.ocsp = OCSP_FAILED;
2475         if (LOGGING(tls_cipher)) log_write(0, LOG_MAIN,
2476                 "Received TLS cert status response, itself unverifiable: %s",
2477                 ERR_reason_error_string(ERR_peek_error()));
2478         BIO_printf(bp, "OCSP response verify failure\n");
2479         ERR_print_errors(bp);
2480         OCSP_RESPONSE_print(bp, rsp, 0);
2481         goto failed;
2482         }
2483       else
2484         DEBUG(D_tls) debug_printf("no explicit trust for OCSP signing"
2485           " in the root CA certificate; ignoring\n");
2486
2487     DEBUG(D_tls) debug_printf("OCSP response well-formed and signed OK\n");
2488
2489     /*XXX So we have a good stapled OCSP status.  How do we know
2490     it is for the cert of interest?  OpenSSL 1.1.0 has a routine
2491     OCSP_resp_find_status() which matches on a cert id, which presumably
2492     we should use. Making an id needs OCSP_cert_id_new(), which takes
2493     issuerName, issuerKey, serialNumber.  Are they all in the cert?
2494
2495     For now, carry on blindly accepting the resp. */
2496
2497     for (int idx =
2498 #ifdef EXIM_HAVE_OCSP_RESP_COUNT
2499             OCSP_resp_count(bs) - 1;
2500 #else
2501             sk_OCSP_SINGLERESP_num(sresp) - 1;
2502 #endif
2503          idx >= 0; idx--)
2504       {
2505       OCSP_SINGLERESP * single = OCSP_resp_get0(bs, idx);
2506       int status, reason;
2507       ASN1_GENERALIZEDTIME * rev, * thisupd, * nextupd;
2508
2509   /*XXX so I can see putting a loop in here to handle a rsp with >1 singleresp
2510   - but what happens with a GnuTLS-style input?
2511
2512   we could do with a debug label for each singleresp
2513   - it has a certID with a serialNumber, but I see no API to get that
2514   */
2515       status = OCSP_single_get0_status(single, &reason, &rev,
2516                   &thisupd, &nextupd);
2517
2518       DEBUG(D_tls) time_print(bp, "This OCSP Update", thisupd);
2519       DEBUG(D_tls) if(nextupd) time_print(bp, "Next OCSP Update", nextupd);
2520       if (!OCSP_check_validity(thisupd, nextupd,
2521             EXIM_OCSP_SKEW_SECONDS, EXIM_OCSP_MAX_AGE))
2522         {
2523         tls_out.ocsp = OCSP_FAILED;
2524         DEBUG(D_tls) ERR_print_errors(bp);
2525         log_write(0, LOG_MAIN, "OCSP dates invalid");
2526         goto failed;
2527         }
2528
2529       DEBUG(D_tls) BIO_printf(bp, "Certificate status: %s\n",
2530                     OCSP_cert_status_str(status));
2531       switch(status)
2532         {
2533         case V_OCSP_CERTSTATUS_GOOD:
2534           continue;     /* the idx loop */
2535         case V_OCSP_CERTSTATUS_REVOKED:
2536           log_write(0, LOG_MAIN, "Server certificate revoked%s%s",
2537               reason != -1 ? "; reason: " : "",
2538               reason != -1 ? OCSP_crl_reason_str(reason) : "");
2539           DEBUG(D_tls) time_print(bp, "Revocation Time", rev);
2540           break;
2541         default:
2542           log_write(0, LOG_MAIN,
2543               "Server certificate status unknown, in OCSP stapling");
2544           break;
2545         }
2546
2547       goto failed;
2548       }
2549
2550     i = 1;
2551     tls_out.ocsp = OCSP_VFIED;
2552     goto good;
2553
2554   failed:
2555     tls_out.ocsp = OCSP_FAILED;
2556     i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
2557   good:
2558     BIO_free(bp);
2559   }
2560
2561 OCSP_RESPONSE_free(rsp);
2562 return i;
2563 }
2564 #endif  /*!DISABLE_OCSP*/
2565
2566
2567 /*************************************************
2568 *            Initialize for TLS                  *
2569 *************************************************/
2570 /* Called from both server and client code, to do preliminary initialization
2571 of the library.  We allocate and return a context structure.
2572
2573 Arguments:
2574   host            connected host, if client; NULL if server
2575   ob              transport options block, if client; NULL if server
2576   ocsp_file       file of stapling info (server); flag for require ocsp (client)
2577   addr            address if client; NULL if server (for some randomness)
2578   caller_state    place to put pointer to allocated state-struct
2579   errstr          error string pointer
2580
2581 Returns:          OK/DEFER/FAIL
2582 */
2583
2584 static int
2585 tls_init(host_item * host, smtp_transport_options_block * ob,
2586 #ifndef DISABLE_OCSP
2587   uschar *ocsp_file,
2588 #endif
2589   address_item *addr, exim_openssl_state_st ** caller_state,
2590   tls_support * tlsp,
2591   uschar ** errstr)
2592 {
2593 SSL_CTX * ctx;
2594 exim_openssl_state_st * state;
2595 int rc;
2596
2597 if (host)                       /* client */
2598   {
2599   state = store_malloc(sizeof(exim_openssl_state_st));
2600   memset(state, 0, sizeof(*state));
2601   state->certificate = ob->tls_certificate;
2602   state->privatekey =  ob->tls_privatekey;
2603   state->is_server = FALSE;
2604   state->dhparam = NULL;
2605   state->lib_state = ob->tls_preload;
2606   }
2607 else                            /* server */
2608   {
2609   state = &state_server;
2610   state->certificate = tls_certificate;
2611   state->privatekey =  tls_privatekey;
2612   state->is_server = TRUE;
2613   state->dhparam = tls_dhparam;
2614   state->lib_state = state_server.lib_state;
2615   }
2616
2617 state->tlsp = tlsp;
2618 state->host = host;
2619
2620 if (!state->lib_state.pri_string)
2621   state->server_cipher_list = NULL;
2622
2623 #ifndef DISABLE_EVENT
2624 state->event_action = NULL;
2625 #endif
2626
2627 tls_openssl_init();
2628
2629 /* It turns out that we need to seed the random number generator this early in
2630 order to get the full complement of ciphers to work. It took me roughly a day
2631 of work to discover this by experiment.
2632
2633 On systems that have /dev/urandom, SSL may automatically seed itself from
2634 there. Otherwise, we have to make something up as best we can. Double check
2635 afterwards.
2636
2637 Although we likely called this before, at daemon startup, this is a chance
2638 to mix in further variable info (time, pid) if needed. */
2639
2640 if (!lib_rand_init(addr))
2641   return tls_error(US"RAND_status", host,
2642     US"unable to seed random number generator", errstr);
2643
2644 /* Apply administrator-supplied work-arounds.
2645 Historically we applied just one requested option,
2646 SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS, but when bug 994 requested a second, we
2647 moved to an administrator-controlled list of options to specify and
2648 grandfathered in the first one as the default value for "openssl_options".
2649
2650 No OpenSSL version number checks: the options we accept depend upon the
2651 availability of the option value macros from OpenSSL.  */
2652
2653 if (!init_options)
2654   if (!tls_openssl_options_parse(openssl_options, &init_options))
2655     return tls_error(US"openssl_options parsing failed", host, NULL, errstr);
2656
2657 /* Create a context.
2658 The OpenSSL docs in 1.0.1b have not been updated to clarify TLS variant
2659 negotiation in the different methods; as far as I can tell, the only
2660 *_{server,client}_method which allows negotiation is SSLv23, which exists even
2661 when OpenSSL is built without SSLv2 support.
2662 By disabling with openssl_options, we can let admins re-enable with the
2663 existing knob. */
2664
2665 if (!(ctx = state->lib_state.lib_ctx))
2666   {
2667   if ((rc = lib_ctx_new(&ctx, host, errstr)) != OK)
2668     return rc;
2669   state->lib_state.lib_ctx = ctx;
2670   }
2671
2672 #ifndef DISABLE_TLS_RESUME
2673 tlsp->resumption = RESUME_SUPPORTED;
2674 #endif
2675 if (init_options)
2676   {
2677 #ifndef DISABLE_TLS_RESUME
2678   /* Should the server offer session resumption? */
2679   if (!host && verify_check_host(&tls_resumption_hosts) == OK)
2680     {
2681     DEBUG(D_tls) debug_printf("tls_resumption_hosts overrides openssl_options\n");
2682     init_options &= ~SSL_OP_NO_TICKET;
2683     tlsp->resumption |= RESUME_SERVER_TICKET; /* server will give ticket on request */
2684     tlsp->host_resumable = TRUE;
2685     }
2686 #endif
2687
2688   DEBUG(D_tls) debug_printf("setting SSL CTX options: %#lx\n", init_options);
2689   if (!(SSL_CTX_set_options(ctx, init_options)))
2690     return tls_error(string_sprintf(
2691           "SSL_CTX_set_option(%#lx)", init_options), host, NULL, errstr);
2692   }
2693 else
2694   DEBUG(D_tls) debug_printf("no SSL CTX options to set\n");
2695
2696 /* We'd like to disable session cache unconditionally, but foolish Outlook
2697 Express clients then give up the first TLS connection and make a second one
2698 (which works).  Only when there is an IMAP service on the same machine.
2699 Presumably OE is trying to use the cache for A on B.  Leave it enabled for
2700 now, until we work out a decent way of presenting control to the config.  It
2701 will never be used because we use a new context every time. */
2702 #ifdef notdef
2703 (void) SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
2704 #endif
2705
2706 /* Initialize with DH parameters if supplied */
2707 /* Initialize ECDH temp key parameter selection */
2708
2709 if (!host)
2710   {
2711   if (state->lib_state.dh)
2712     { DEBUG(D_tls) debug_printf("TLS: DH params were preloaded\n"); }
2713   else
2714     if (!init_dh(ctx, state->dhparam, errstr)) return DEFER;
2715
2716   if (state->lib_state.ecdh)
2717     { DEBUG(D_tls) debug_printf("TLS: ECDH curve was preloaded\n"); }
2718   else
2719     if (!init_ecdh(ctx, errstr)) return DEFER;
2720   }
2721
2722 /* Set up certificate and key (and perhaps OCSP info) */
2723
2724 if (state->lib_state.conn_certs)
2725   {
2726   DEBUG(D_tls)
2727     debug_printf("TLS: %s certs were preloaded\n", host ? "client":"server");
2728   }
2729 else
2730   {
2731 #ifndef DISABLE_OCSP
2732   if (!host)
2733     {
2734     state->u_ocsp.server.file = ocsp_file;
2735     state->u_ocsp.server.file_expanded = NULL;
2736     state->u_ocsp.server.olist = NULL;
2737     }
2738 #endif
2739   if ((rc = tls_expand_session_files(ctx, state, errstr)) != OK) return rc;
2740   }
2741
2742 /* If we need to handle SNI or OCSP, do so */
2743
2744 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
2745 # ifndef DISABLE_OCSP
2746   if (!(state->verify_stack = sk_X509_new_null()))
2747     {
2748     DEBUG(D_tls) debug_printf("failed to create stack for stapling verify\n");
2749     return FAIL;
2750     }
2751 # endif
2752
2753 if (!host)              /* server */
2754   {
2755 # ifndef DISABLE_OCSP
2756   /* We check u_ocsp.server.file, not server.olist, because we care about if
2757   the option exists, not what the current expansion might be, as SNI might
2758   change the certificate and OCSP file in use between now and the time the
2759   callback is invoked. */
2760   if (state->u_ocsp.server.file)
2761     {
2762     SSL_CTX_set_tlsext_status_cb(ctx, tls_server_stapling_cb);
2763     SSL_CTX_set_tlsext_status_arg(ctx, state);
2764     }
2765 # endif
2766   /* We always do this, so that $tls_sni is available even if not used in
2767   tls_certificate */
2768   SSL_CTX_set_tlsext_servername_callback(ctx, tls_servername_cb);
2769   SSL_CTX_set_tlsext_servername_arg(ctx, state);
2770
2771 # ifdef EXIM_HAVE_ALPN
2772   if (tls_alpn && *tls_alpn)
2773     {
2774     uschar * exp_alpn;
2775     if (  expand_check(tls_alpn, US"tls_alpn", &exp_alpn, errstr)
2776        && *exp_alpn && !isblank(*exp_alpn))
2777       {
2778       tls_alpn = exp_alpn;      /* subprocess so ok to overwrite */
2779       SSL_CTX_set_alpn_select_cb(ctx, tls_server_alpn_cb, state);
2780       }
2781     else
2782       tls_alpn = NULL;
2783     }
2784 # endif
2785   }
2786 # ifndef DISABLE_OCSP
2787 else                    /* client */
2788   if(ocsp_file)         /* wanting stapling */
2789     {
2790     if (!(state->u_ocsp.client.verify_store = X509_STORE_new()))
2791       {
2792       DEBUG(D_tls) debug_printf("failed to create store for stapling verify\n");
2793       return FAIL;
2794       }
2795     SSL_CTX_set_tlsext_status_cb(ctx, tls_client_stapling_cb);
2796     SSL_CTX_set_tlsext_status_arg(ctx, state);
2797     }
2798 # endif
2799 #endif
2800
2801 state->verify_cert_hostnames = NULL;
2802
2803 #ifdef EXIM_HAVE_EPHEM_RSA_KEX
2804 /* Set up the RSA callback */
2805 SSL_CTX_set_tmp_rsa_callback(ctx, rsa_callback);
2806 #endif
2807
2808 /* Finally, set the session cache timeout, and we are done.
2809 The period appears to be also used for (server-generated) session tickets */
2810
2811 SSL_CTX_set_timeout(ctx, ssl_session_timeout);
2812 DEBUG(D_tls) debug_printf("Initialized TLS\n");
2813
2814 *caller_state = state;
2815
2816 return OK;
2817 }
2818
2819
2820
2821
2822 /*************************************************
2823 *           Get name of cipher in use            *
2824 *************************************************/
2825
2826 /*
2827 Argument:   pointer to an SSL structure for the connection
2828             pointer to number of bits for cipher
2829 Returns:    pointer to allocated string in perm-pool
2830 */
2831
2832 static uschar *
2833 construct_cipher_name(SSL * ssl, const uschar * ver, int * bits)
2834 {
2835 int pool = store_pool;
2836 /* With OpenSSL 1.0.0a, 'c' needs to be const but the documentation doesn't
2837 yet reflect that.  It should be a safe change anyway, even 0.9.8 versions have
2838 the accessor functions use const in the prototype. */
2839
2840 const SSL_CIPHER * c = (const SSL_CIPHER *) SSL_get_current_cipher(ssl);
2841 uschar * s;
2842
2843 SSL_CIPHER_get_bits(c, bits);
2844
2845 store_pool = POOL_PERM;
2846 s = string_sprintf("%s:%s:%u", ver, SSL_CIPHER_get_name(c), *bits);
2847 store_pool = pool;
2848 DEBUG(D_tls) debug_printf("Cipher: %s\n", s);
2849 return s;
2850 }
2851
2852
2853 /* Get IETF-standard name for ciphersuite.
2854 Argument:   pointer to an SSL structure for the connection
2855 Returns:    pointer to string
2856 */
2857
2858 static const uschar *
2859 cipher_stdname_ssl(SSL * ssl)
2860 {
2861 #ifdef EXIM_HAVE_OPENSSL_CIPHER_STD_NAME
2862 return CUS SSL_CIPHER_standard_name(SSL_get_current_cipher(ssl));
2863 #else
2864 ushort id = 0xffff & SSL_CIPHER_get_id(SSL_get_current_cipher(ssl));
2865 return cipher_stdname(id >> 8, id & 0xff);
2866 #endif
2867 }
2868
2869
2870 static const uschar *
2871 tlsver_name(SSL * ssl)
2872 {
2873 uschar * s, * p;
2874 int pool = store_pool;
2875
2876 store_pool = POOL_PERM;
2877 s = string_copy(US SSL_get_version(ssl));
2878 store_pool = pool;
2879 if ((p = Ustrchr(s, 'v')))      /* TLSv1.2 -> TLS1.2 */
2880   for (;; p++) if (!(*p = p[1])) break;
2881 return CUS s;
2882 }
2883
2884
2885 static void
2886 peer_cert(SSL * ssl, tls_support * tlsp, uschar * peerdn, unsigned siz)
2887 {
2888 /*XXX we might consider a list-of-certs variable for the cert chain.
2889 SSL_get_peer_cert_chain(SSL*).  We'd need a new variable type and support
2890 in list-handling functions, also consider the difference between the entire
2891 chain and the elements sent by the peer. */
2892
2893 tlsp->peerdn = NULL;
2894
2895 /* Will have already noted peercert on a verify fail; possibly not the leaf */
2896 if (!tlsp->peercert)
2897   tlsp->peercert = SSL_get_peer_certificate(ssl);
2898 /* Beware anonymous ciphers which lead to server_cert being NULL */
2899 if (tlsp->peercert)
2900   if (!X509_NAME_oneline(X509_get_subject_name(tlsp->peercert), CS peerdn, siz))
2901     { DEBUG(D_tls) debug_printf("X509_NAME_oneline() error\n"); }
2902   else
2903     {
2904     int oldpool = store_pool;
2905
2906     peerdn[siz-1] = '\0';               /* paranoia */
2907     store_pool = POOL_PERM;
2908     tlsp->peerdn = string_copy(peerdn);
2909     store_pool = oldpool;
2910
2911     /* We used to set CV in the cert-verify callbacks (either plain or dane)
2912     but they don't get called on session-resumption.  So use the official
2913     interface, which uses the resumed value.  Unfortunately this claims verified
2914     when it actually failed but we're in try-verify mode, due to us wanting the
2915     knowlege that it failed so needing to have the callback and forcing a
2916     permissive return.  If we don't force it, the TLS startup is failed.
2917     The extra bit of information is set in verify_override in the cb, stashed
2918     for resumption next to the TLS session, and used here. */
2919
2920     if (!tlsp->verify_override)
2921       tlsp->certificate_verified =
2922 #ifdef SUPPORT_DANE
2923         tlsp->dane_verified ||
2924 #endif
2925         SSL_get_verify_result(ssl) == X509_V_OK;
2926     }
2927 }
2928
2929
2930
2931
2932
2933 /*************************************************
2934 *        Set up for verifying certificates       *
2935 *************************************************/
2936
2937 #ifndef DISABLE_OCSP
2938 /* Load certs from file, return TRUE on success */
2939
2940 static BOOL
2941 chain_from_pem_file(const uschar * file, STACK_OF(X509) ** vp)
2942 {
2943 BIO * bp;
2944 STACK_OF(X509) * verify_stack = *vp;
2945
2946 if (verify_stack)
2947   while (sk_X509_num(verify_stack) > 0)
2948     X509_free(sk_X509_pop(verify_stack));
2949 else
2950   verify_stack = sk_X509_new_null();
2951
2952 if (!(bp = BIO_new_file(CS file, "r"))) return FALSE;
2953 for (X509 * x; x = PEM_read_bio_X509(bp, NULL, 0, NULL); )
2954   sk_X509_push(verify_stack, x);
2955 BIO_free(bp);
2956 *vp = verify_stack;
2957 return TRUE;
2958 }
2959 #endif
2960
2961
2962
2963 /* Called by both client and server startup; on the server possibly
2964 repeated after a Server Name Indication.
2965
2966 Arguments:
2967   sctx          SSL_CTX* to initialise
2968   certs         certs file, expanded
2969   crl           CRL file or NULL
2970   host          NULL in a server; the remote host in a client
2971   errstr        error string pointer
2972
2973 Returns:        OK/DEFER/FAIL
2974 */
2975
2976 static int
2977 setup_certs(SSL_CTX *sctx, uschar *certs, uschar *crl, host_item *host,
2978     uschar ** errstr)
2979 {
2980 uschar *expcerts, *expcrl;
2981
2982 if (!expand_check(certs, US"tls_verify_certificates", &expcerts, errstr))
2983   return DEFER;
2984 DEBUG(D_tls) debug_printf("tls_verify_certificates: %s\n", expcerts);
2985
2986 if (expcerts && *expcerts)
2987   {
2988   /* Tell the library to use its compiled-in location for the system default
2989   CA bundle. Then add the ones specified in the config, if any. */
2990
2991   if (!SSL_CTX_set_default_verify_paths(sctx))
2992     return tls_error(US"SSL_CTX_set_default_verify_paths", host, NULL, errstr);
2993
2994   if (Ustrcmp(expcerts, "system") != 0 && Ustrncmp(expcerts, "system,", 7) != 0)
2995     {
2996     struct stat statbuf;
2997
2998     if (Ustat(expcerts, &statbuf) < 0)
2999       {
3000       log_write(0, LOG_MAIN|LOG_PANIC,
3001         "failed to stat %s for certificates", expcerts);
3002       return DEFER;
3003       }
3004     else
3005       {
3006       uschar *file, *dir;
3007       if ((statbuf.st_mode & S_IFMT) == S_IFDIR)
3008         { file = NULL; dir = expcerts; }
3009       else
3010         {
3011         STACK_OF(X509) * verify_stack =
3012 #ifndef DISABLE_OCSP
3013           !host ? state_server.verify_stack :
3014 #endif
3015           NULL;
3016         STACK_OF(X509) ** vp = &verify_stack;
3017
3018         file = expcerts; dir = NULL;
3019 #ifndef DISABLE_OCSP
3020         /* In the server if we will be offering an OCSP proof, load chain from
3021         file for verifying the OCSP proof at load time. */
3022
3023 /*XXX Glitch!   The file here is tls_verify_certs: the chain for verifying the client cert.
3024 This is inconsistent with the need to verify the OCSP proof of the server cert.
3025 */
3026         if (  !host
3027            && statbuf.st_size > 0
3028            && state_server.u_ocsp.server.file
3029            && !chain_from_pem_file(file, vp)
3030            )
3031           {
3032           log_write(0, LOG_MAIN|LOG_PANIC,
3033             "failed to load cert chain from %s", file);
3034           return DEFER;
3035           }
3036 #endif
3037         }
3038
3039       /* If a certificate file is empty, the load function fails with an
3040       unhelpful error message. If we skip it, we get the correct behaviour (no
3041       certificates are recognized, but the error message is still misleading (it
3042       says no certificate was supplied).  But this is better. */
3043
3044       if (  (!file || statbuf.st_size > 0)
3045          && !SSL_CTX_load_verify_locations(sctx, CS file, CS dir))
3046           return tls_error(US"SSL_CTX_load_verify_locations",
3047                             host, NULL, errstr);
3048
3049       /* On the server load the list of CAs for which we will accept certs, for
3050       sending to the client.  This is only for the one-file
3051       tls_verify_certificates variant.
3052       If a list isn't loaded into the server, but some verify locations are set,
3053       the server end appears to make a wildcard request for client certs.
3054       Meanwhile, the client library as default behaviour *ignores* the list
3055       we send over the wire - see man SSL_CTX_set_client_cert_cb.
3056       Because of this, and that the dir variant is likely only used for
3057       the public-CA bundle (not for a private CA), not worth fixing.  */
3058
3059       if (file)
3060         {
3061         STACK_OF(X509_NAME) * names = SSL_load_client_CA_file(CS file);
3062         int i = sk_X509_NAME_num(names);
3063
3064         if (!host) SSL_CTX_set_client_CA_list(sctx, names);
3065         DEBUG(D_tls) debug_printf("Added %d additional certificate authorit%s\n",
3066                                     i, i>1 ? "ies":"y");
3067         }
3068       else
3069         DEBUG(D_tls)
3070           debug_printf("Added dir for additional certificate authorities\n");
3071       }
3072     }
3073
3074   /* Handle a certificate revocation list. */
3075
3076 #if OPENSSL_VERSION_NUMBER > 0x00907000L
3077
3078   /* This bit of code is now the version supplied by Lars Mainka. (I have
3079   merely reformatted it into the Exim code style.)
3080
3081   "From here I changed the code to add support for multiple crl's
3082   in pem format in one file or to support hashed directory entries in
3083   pem format instead of a file. This method now uses the library function
3084   X509_STORE_load_locations to add the CRL location to the SSL context.
3085   OpenSSL will then handle the verify against CA certs and CRLs by
3086   itself in the verify callback." */
3087
3088   if (!expand_check(crl, US"tls_crl", &expcrl, errstr)) return DEFER;
3089   if (expcrl && *expcrl)
3090     {
3091     struct stat statbufcrl;
3092     if (Ustat(expcrl, &statbufcrl) < 0)
3093       {
3094       log_write(0, LOG_MAIN|LOG_PANIC,
3095         "failed to stat %s for certificates revocation lists", expcrl);
3096       return DEFER;
3097       }
3098     else
3099       {
3100       /* is it a file or directory? */
3101       uschar *file, *dir;
3102       X509_STORE *cvstore = SSL_CTX_get_cert_store(sctx);
3103       if ((statbufcrl.st_mode & S_IFMT) == S_IFDIR)
3104         {
3105         file = NULL;
3106         dir = expcrl;
3107         DEBUG(D_tls) debug_printf("SSL CRL value is a directory %s\n", dir);
3108         }
3109       else
3110         {
3111         file = expcrl;
3112         dir = NULL;
3113         DEBUG(D_tls) debug_printf("SSL CRL value is a file %s\n", file);
3114         }
3115       if (X509_STORE_load_locations(cvstore, CS file, CS dir) == 0)
3116         return tls_error(US"X509_STORE_load_locations", host, NULL, errstr);
3117
3118       /* setting the flags to check against the complete crl chain */
3119
3120       X509_STORE_set_flags(cvstore,
3121         X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
3122       }
3123     }
3124
3125 #endif  /* OPENSSL_VERSION_NUMBER > 0x00907000L */
3126   }
3127
3128 return OK;
3129 }
3130
3131
3132
3133 /*************************************************
3134 *       Start a TLS session in a server          *
3135 *************************************************/
3136 /* This is called when Exim is running as a server, after having received
3137 the STARTTLS command. It must respond to that command, and then negotiate
3138 a TLS session.
3139
3140 Arguments:
3141   errstr            pointer to error message
3142
3143 Returns:            OK on success
3144                     DEFER for errors before the start of the negotiation
3145                     FAIL for errors during the negotiation; the server can't
3146                       continue running.
3147 */
3148
3149 int
3150 tls_server_start(uschar ** errstr)
3151 {
3152 int rc;
3153 uschar * expciphers;
3154 exim_openssl_state_st * dummy_statep;
3155 SSL_CTX * ctx;
3156 SSL * ssl;
3157 static uschar peerdn[256];
3158
3159 /* Check for previous activation */
3160
3161 if (tls_in.active.sock >= 0)
3162   {
3163   tls_error(US"STARTTLS received after TLS started", NULL, US"", errstr);
3164   smtp_printf("554 Already in TLS\r\n", FALSE);
3165   return FAIL;
3166   }
3167
3168 /* Initialize the SSL library. If it fails, it will already have logged
3169 the error. */
3170
3171 rc = tls_init(NULL, NULL,
3172 #ifndef DISABLE_OCSP
3173     tls_ocsp_file,
3174 #endif
3175     NULL, &dummy_statep, &tls_in, errstr);
3176 if (rc != OK) return rc;
3177 ctx = state_server.lib_state.lib_ctx;
3178
3179 /* In OpenSSL, cipher components are separated by hyphens. In GnuTLS, they
3180 were historically separated by underscores. So that I can use either form in my
3181 tests, and also for general convenience, we turn underscores into hyphens here.
3182
3183 XXX SSL_CTX_set_cipher_list() is replaced by SSL_CTX_set_ciphersuites()
3184 for TLS 1.3 .  Since we do not call it at present we get the default list:
3185 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
3186 */
3187
3188 if (state_server.lib_state.pri_string)
3189   { DEBUG(D_tls) debug_printf("TLS: cipher list was preloaded\n"); }
3190 else
3191   {
3192   if (!expand_check(tls_require_ciphers, US"tls_require_ciphers", &expciphers, errstr))
3193     return FAIL;
3194
3195   if (expciphers)
3196     {
3197     normalise_ciphers(&expciphers, tls_require_ciphers);
3198     if ((rc = server_load_ciphers(ctx, &state_server, expciphers, errstr)) != OK)
3199       return rc;
3200     }
3201   }
3202
3203 /* If this is a host for which certificate verification is mandatory or
3204 optional, set up appropriately. */
3205
3206 tls_in.certificate_verified = FALSE;
3207 #ifdef SUPPORT_DANE
3208 tls_in.dane_verified = FALSE;
3209 #endif
3210 server_verify_callback_called = FALSE;
3211
3212 if (verify_check_host(&tls_verify_hosts) == OK)
3213   server_verify_optional = FALSE;
3214 else if (verify_check_host(&tls_try_verify_hosts) == OK)
3215   server_verify_optional = TRUE;
3216 else
3217   goto skip_certs;
3218
3219  {
3220   uschar * expcerts;
3221   if (!expand_check(tls_verify_certificates, US"tls_verify_certificates",
3222                     &expcerts, errstr))
3223     return DEFER;
3224   DEBUG(D_tls) debug_printf("tls_verify_certificates: %s\n", expcerts);
3225
3226   if (state_server.lib_state.cabundle)
3227     { DEBUG(D_tls) debug_printf("TLS: CA bundle for server was preloaded\n"); }
3228   else
3229     if ((rc = setup_certs(ctx, expcerts, tls_crl, NULL, errstr)) != OK)
3230       return rc;
3231
3232   if (expcerts && *expcerts)
3233     setup_cert_verify(ctx, server_verify_optional, verify_callback_server);
3234  }
3235 skip_certs: ;
3236
3237 #ifndef DISABLE_TLS_RESUME
3238 # if OPENSSL_VERSION_NUMBER < 0x30000000L
3239 SSL_CTX_set_tlsext_ticket_key_cb(ctx, ticket_key_callback);
3240 /* despite working, appears to always return failure, so ignoring */
3241 # else
3242 SSL_CTX_set_tlsext_ticket_key_evp_cb(ctx, ticket_key_callback);
3243 /* despite working, appears to always return failure, so ignoring */
3244 # endif
3245 #endif
3246
3247 #ifdef OPENSSL_HAVE_NUM_TICKETS
3248 # ifndef DISABLE_TLS_RESUME
3249 SSL_CTX_set_num_tickets(ctx, tls_in.host_resumable ? 1 : 0);
3250 # else
3251 SSL_CTX_set_num_tickets(ctx, 0);        /* send no TLS1.3 stateful-tickets */
3252 # endif
3253 #endif
3254
3255
3256 /* Prepare for new connection */
3257
3258 if (!(ssl = SSL_new(ctx)))
3259   return tls_error(US"SSL_new", NULL, NULL, errstr);
3260 state_server.lib_state.lib_ssl = ssl;
3261
3262 /* Warning: we used to SSL_clear(ssl) here, it was removed.
3263  *
3264  * With the SSL_clear(), we get strange interoperability bugs with
3265  * OpenSSL 1.0.1b and TLS1.1/1.2.  It looks as though this may be a bug in
3266  * OpenSSL itself, as a clear should not lead to inability to follow protocols.
3267  *
3268  * The SSL_clear() call is to let an existing SSL* be reused, typically after
3269  * session shutdown.  In this case, we have a brand new object and there's no
3270  * obvious reason to immediately clear it.  I'm guessing that this was
3271  * originally added because of incomplete initialisation which the clear fixed,
3272  * in some historic release.
3273  */
3274
3275 /* Set context and tell client to go ahead, except in the case of TLS startup
3276 on connection, where outputting anything now upsets the clients and tends to
3277 make them disconnect. We need to have an explicit fflush() here, to force out
3278 the response. Other smtp_printf() calls do not need it, because in non-TLS
3279 mode, the fflush() happens when smtp_getc() is called. */
3280
3281 SSL_set_session_id_context(ssl, sid_ctx, Ustrlen(sid_ctx));
3282 if (!tls_in.on_connect)
3283   {
3284   smtp_printf("220 TLS go ahead\r\n", FALSE);
3285   fflush(smtp_out);
3286   }
3287
3288 /* Now negotiate the TLS session. We put our own timer on it, since it seems
3289 that the OpenSSL library doesn't. */
3290
3291 SSL_set_wfd(ssl, fileno(smtp_out));
3292 SSL_set_rfd(ssl, fileno(smtp_in));
3293 SSL_set_accept_state(ssl);
3294
3295 DEBUG(D_tls) debug_printf("Calling SSL_accept\n");
3296
3297 ERR_clear_error();
3298 sigalrm_seen = FALSE;
3299 if (smtp_receive_timeout > 0) ALARM(smtp_receive_timeout);
3300 rc = SSL_accept(ssl);
3301 ALARM_CLR(0);
3302
3303 if (rc <= 0)
3304   {
3305   int error = SSL_get_error(ssl, rc);
3306   switch(error)
3307     {
3308     case SSL_ERROR_NONE:
3309       break;
3310
3311     case SSL_ERROR_ZERO_RETURN:
3312       DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
3313       (void) tls_error(US"SSL_accept", NULL, sigalrm_seen ? US"timed out" : NULL, errstr);
3314       (void) event_raise(event_action, US"tls:fail:connect", *errstr, NULL);
3315
3316       if (SSL_get_shutdown(ssl) == SSL_RECEIVED_SHUTDOWN)
3317             SSL_shutdown(ssl);
3318
3319       tls_close(NULL, TLS_NO_SHUTDOWN);
3320       return FAIL;
3321
3322     /* Handle genuine errors */
3323     case SSL_ERROR_SSL:
3324       {
3325       uschar * s = NULL;
3326       int r = ERR_GET_REASON(ERR_peek_error());
3327       if (  r == SSL_R_WRONG_VERSION_NUMBER
3328 #ifdef SSL_R_VERSION_TOO_LOW
3329          || r == SSL_R_VERSION_TOO_LOW
3330 #endif
3331          || r == SSL_R_UNKNOWN_PROTOCOL || r == SSL_R_UNSUPPORTED_PROTOCOL)
3332         s = string_sprintf("(%s)", SSL_get_version(ssl));
3333       (void) tls_error(US"SSL_accept", NULL, sigalrm_seen ? US"timed out" : s, errstr);
3334       (void) event_raise(event_action, US"tls:fail:connect", *errstr, NULL);
3335       return FAIL;
3336       }
3337
3338     default:
3339       DEBUG(D_tls) debug_printf("Got SSL error %d\n", error);
3340       if (error == SSL_ERROR_SYSCALL)
3341         {
3342         if (!errno)
3343           {
3344           *errstr = US"SSL_accept: TCP connection closed by peer";
3345           (void) event_raise(event_action, US"tls:fail:connect", *errstr, NULL);
3346           return FAIL;
3347           }
3348         DEBUG(D_tls) debug_printf(" - syscall %s\n", strerror(errno));
3349         }
3350       (void) tls_error(US"SSL_accept", NULL,
3351                       sigalrm_seen ? US"timed out"
3352                       : ERR_peek_error() ? NULL : string_sprintf("ret %d", error),
3353                       errstr);
3354       (void) event_raise(event_action, US"tls:fail:connect", *errstr, NULL);
3355       return FAIL;
3356     }
3357   }
3358
3359 DEBUG(D_tls) debug_printf("SSL_accept was successful\n");
3360 ERR_clear_error();      /* Even success can leave errors in the stack. Seen with
3361                         anon-authentication ciphersuite negotiated. */
3362
3363 #ifndef DISABLE_TLS_RESUME
3364 if (SSL_session_reused(ssl))
3365   {
3366   tls_in.resumption |= RESUME_USED;
3367   DEBUG(D_tls) debug_printf("Session reused\n");
3368   }
3369 #endif
3370
3371 #ifdef EXIM_HAVE_ALPN
3372 /* If require-alpn, check server_seen_alpn here.  Else abort TLS */
3373 if (!tls_alpn || !*tls_alpn)
3374   { DEBUG(D_tls) debug_printf("TLS: was not watching for ALPN\n"); }
3375 else if (!server_seen_alpn)
3376   if (verify_check_host(&hosts_require_alpn) == OK)
3377     {
3378     /* We'd like to send a definitive Alert but OpenSSL provides no facility */
3379     SSL_shutdown(ssl);
3380     tls_error(US"handshake", NULL, US"ALPN required but not negotiated", errstr);
3381     return FAIL;
3382     }
3383   else
3384     { DEBUG(D_tls) debug_printf("TLS: no ALPN presented in handshake\n"); }
3385 else DEBUG(D_tls)
3386   {
3387   const uschar * name;
3388   unsigned len;
3389   SSL_get0_alpn_selected(ssl, &name, &len);
3390   if (len && name)
3391     debug_printf("ALPN negotiated: '%.*s'\n", (int)*name, name+1);
3392   else
3393     debug_printf("ALPN: no protocol negotiated\n");
3394   }
3395 #endif
3396
3397
3398 /* TLS has been set up. Record data for the connection,
3399 adjust the input functions to read via TLS, and initialize things. */
3400
3401 #ifdef SSL_get_extms_support
3402 tls_in.ext_master_secret = SSL_get_extms_support(ssl) == 1;
3403 #endif
3404 peer_cert(ssl, &tls_in, peerdn, sizeof(peerdn));
3405
3406 tls_in.ver = tlsver_name(ssl);
3407 tls_in.cipher = construct_cipher_name(ssl, tls_in.ver, &tls_in.bits);
3408 tls_in.cipher_stdname = cipher_stdname_ssl(ssl);
3409
3410 DEBUG(D_tls)
3411   {
3412   uschar buf[2048];
3413   if (SSL_get_shared_ciphers(ssl, CS buf, sizeof(buf)))
3414     debug_printf("Shared ciphers: %s\n", buf);
3415
3416 #ifdef EXIM_HAVE_OPENSSL_KEYLOG
3417   {
3418   BIO * bp = BIO_new_fp(debug_file, BIO_NOCLOSE);
3419   SSL_SESSION_print_keylog(bp, SSL_get_session(ssl));
3420   BIO_free(bp);
3421   }
3422 #endif
3423
3424 #ifdef EXIM_HAVE_SESSION_TICKET
3425   {
3426   SSL_SESSION * ss = SSL_get_session(ssl);
3427   if (SSL_SESSION_has_ticket(ss))       /* 1.1.0 */
3428     debug_printf("The session has a ticket, life %lu seconds\n",
3429       SSL_SESSION_get_ticket_lifetime_hint(ss));
3430   }
3431 #endif
3432   }
3433
3434 /* Record the certificate we presented */
3435   {
3436   X509 * crt = SSL_get_certificate(ssl);
3437   tls_in.ourcert = crt ? X509_dup(crt) : NULL;
3438   }
3439
3440 /* Channel-binding info for authenticators
3441 See description in https://paquier.xyz/postgresql-2/channel-binding-openssl/ */
3442   {
3443   uschar c, * s;
3444   size_t len = SSL_get_peer_finished(ssl, &c, 0);
3445   int old_pool = store_pool;
3446
3447   SSL_get_peer_finished(ssl, s = store_get((int)len, FALSE), len);
3448   store_pool = POOL_PERM;
3449     tls_in.channelbinding = b64encode_taint(CUS s, (int)len, FALSE);
3450   store_pool = old_pool;
3451   DEBUG(D_tls) debug_printf("Have channel bindings cached for possible auth usage %p\n", tls_in.channelbinding);
3452   }
3453
3454 /* Only used by the server-side tls (tls_in), including tls_getc.
3455    Client-side (tls_out) reads (seem to?) go via
3456    smtp_read_response()/ip_recv().
3457    Hence no need to duplicate for _in and _out.
3458  */
3459 if (!ssl_xfer_buffer) ssl_xfer_buffer = store_malloc(ssl_xfer_buffer_size);
3460 ssl_xfer_buffer_lwm = ssl_xfer_buffer_hwm = 0;
3461 ssl_xfer_eof = ssl_xfer_error = FALSE;
3462
3463 receive_getc = tls_getc;
3464 receive_getbuf = tls_getbuf;
3465 receive_get_cache = tls_get_cache;
3466 receive_hasc = tls_hasc;
3467 receive_ungetc = tls_ungetc;
3468 receive_feof = tls_feof;
3469 receive_ferror = tls_ferror;
3470
3471 tls_in.active.sock = fileno(smtp_out);
3472 tls_in.active.tls_ctx = NULL;   /* not using explicit ctx for server-side */
3473 return OK;
3474 }
3475
3476
3477
3478
3479 static int
3480 tls_client_basic_ctx_init(SSL_CTX * ctx,
3481     host_item * host, smtp_transport_options_block * ob, exim_openssl_state_st * state,
3482     uschar ** errstr)
3483 {
3484 int rc;
3485
3486 /* Back-compatible old behaviour if tls_verify_certificates is set but both
3487 tls_verify_hosts and tls_try_verify_hosts are not set. Check only the specified
3488 host patterns if one of them is set with content. */
3489
3490 if (  (  (  !ob->tls_verify_hosts || !ob->tls_verify_hosts
3491          || Ustrcmp(ob->tls_try_verify_hosts, ":") == 0
3492          )
3493       && (  !ob->tls_try_verify_hosts || !*ob->tls_try_verify_hosts
3494          || Ustrcmp(ob->tls_try_verify_hosts, ":") == 0
3495          )
3496       )
3497    || verify_check_given_host(CUSS &ob->tls_verify_hosts, host) == OK
3498    )
3499   client_verify_optional = FALSE;
3500 else if (verify_check_given_host(CUSS &ob->tls_try_verify_hosts, host) == OK)
3501   client_verify_optional = TRUE;
3502 else
3503   return OK;
3504
3505  {
3506   uschar * expcerts;
3507   if (!expand_check(ob->tls_verify_certificates, US"tls_verify_certificates",
3508                     &expcerts, errstr))
3509     return DEFER;
3510   DEBUG(D_tls) debug_printf("tls_verify_certificates: %s\n", expcerts);
3511
3512   if (state->lib_state.cabundle)
3513     { DEBUG(D_tls) debug_printf("TLS: CA bundle was preloaded\n"); }
3514   else
3515     if ((rc = setup_certs(ctx, expcerts, ob->tls_crl, host, errstr)) != OK)
3516       return rc;
3517
3518   if (expcerts && *expcerts)
3519     setup_cert_verify(ctx, client_verify_optional, verify_callback_client);
3520  }
3521
3522 if (verify_check_given_host(CUSS &ob->tls_verify_cert_hostnames, host) == OK)
3523   {
3524   state->verify_cert_hostnames =
3525 #ifdef SUPPORT_I18N
3526     string_domain_utf8_to_alabel(host->certname, NULL);
3527 #else
3528     host->certname;
3529 #endif
3530   DEBUG(D_tls) debug_printf("Cert hostname to check: \"%s\"\n",
3531                     state->verify_cert_hostnames);
3532   }
3533 return OK;
3534 }
3535
3536
3537 #ifdef SUPPORT_DANE
3538 static int
3539 dane_tlsa_load(SSL * ssl, host_item * host, dns_answer * dnsa, uschar ** errstr)
3540 {
3541 dns_scan dnss;
3542 const char * hostnames[2] = { CS host->name, NULL };
3543 int found = 0;
3544
3545 if (DANESSL_init(ssl, NULL, hostnames) != 1)
3546   return tls_error(US"hostnames load", host, NULL, errstr);
3547
3548 for (dns_record * rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS); rr;
3549      rr = dns_next_rr(dnsa, &dnss, RESET_NEXT)
3550     ) if (rr->type == T_TLSA && rr->size > 3)
3551   {
3552   const uschar * p = rr->data;
3553   uint8_t usage, selector, mtype;
3554   const char * mdname;
3555
3556   usage = *p++;
3557
3558   /* Only DANE-TA(2) and DANE-EE(3) are supported */
3559   if (usage != 2 && usage != 3) continue;
3560
3561   selector = *p++;
3562   mtype = *p++;
3563
3564   switch (mtype)
3565     {
3566     default: continue;  /* Only match-types 0, 1, 2 are supported */
3567     case 0:  mdname = NULL; break;
3568     case 1:  mdname = "sha256"; break;
3569     case 2:  mdname = "sha512"; break;
3570     }
3571
3572   found++;
3573   switch (DANESSL_add_tlsa(ssl, usage, selector, mdname, p, rr->size - 3))
3574     {
3575     default:
3576       return tls_error(US"tlsa load", host, NULL, errstr);
3577     case 0:     /* action not taken */
3578     case 1:     break;
3579     }
3580
3581   tls_out.tlsa_usage |= 1<<usage;
3582   }
3583
3584 if (found)
3585   return OK;
3586
3587 log_write(0, LOG_MAIN, "DANE error: No usable TLSA records");
3588 return DEFER;
3589 }
3590 #endif  /*SUPPORT_DANE*/
3591
3592
3593
3594 #ifndef DISABLE_TLS_RESUME
3595 /* On the client, get any stashed session for the given IP from hints db
3596 and apply it to the ssl-connection for attempted resumption. */
3597
3598 static void
3599 tls_retrieve_session(tls_support * tlsp, SSL * ssl, const uschar * key)
3600 {
3601 tlsp->resumption |= RESUME_SUPPORTED;
3602 if (tlsp->host_resumable)
3603   {
3604   dbdata_tls_session * dt;
3605   int len;
3606   open_db dbblock, * dbm_file;
3607
3608   tlsp->resumption |= RESUME_CLIENT_REQUESTED;
3609   DEBUG(D_tls) debug_printf("checking for resumable session for %s\n", key);
3610   if ((dbm_file = dbfn_open(US"tls", O_RDWR, &dbblock, FALSE, FALSE)))
3611     {
3612     /* key for the db is the IP */
3613     if ((dt = dbfn_read_with_length(dbm_file, key, &len)))
3614       {
3615       SSL_SESSION * ss = NULL;
3616       const uschar * sess_asn1 = dt->session;
3617
3618       len -= sizeof(dbdata_tls_session);
3619       if (!(d2i_SSL_SESSION(&ss, &sess_asn1, (long)len)))
3620         {
3621         DEBUG(D_tls)
3622           {
3623           ERR_error_string_n(ERR_get_error(),
3624             ssl_errstring, sizeof(ssl_errstring));
3625           debug_printf("decoding session: %s\n", ssl_errstring);
3626           }
3627         }
3628       else
3629         {
3630         unsigned long lifetime =
3631 #ifdef EXIM_HAVE_SESSION_TICKET
3632           SSL_SESSION_get_ticket_lifetime_hint(ss);
3633 #else                   /* Use, fairly arbitrilarily, what we as server would */
3634           f.running_in_test_harness ? 6 : ssl_session_timeout;
3635 #endif
3636         if (lifetime + dt->time_stamp < time(NULL))
3637           {
3638           DEBUG(D_tls) debug_printf("session expired\n");
3639           dbfn_delete(dbm_file, key);
3640           }
3641         else if (!SSL_set_session(ssl, ss))
3642           {
3643           DEBUG(D_tls)
3644             {
3645             ERR_error_string_n(ERR_get_error(),
3646               ssl_errstring, sizeof(ssl_errstring));
3647             debug_printf("applying session to ssl: %s\n", ssl_errstring);
3648             }
3649           }
3650         else
3651           {
3652           DEBUG(D_tls) debug_printf("good session\n");
3653           tlsp->resumption |= RESUME_CLIENT_SUGGESTED;
3654           tlsp->verify_override = dt->verify_override;
3655           tlsp->ocsp = dt->ocsp;
3656           }
3657         }
3658       }
3659     else
3660       DEBUG(D_tls) debug_printf("no session record\n");
3661     dbfn_close(dbm_file);
3662     }
3663   }
3664 }
3665
3666
3667 /* On the client, save the session for later resumption */
3668
3669 static int
3670 tls_save_session_cb(SSL * ssl, SSL_SESSION * ss)
3671 {
3672 exim_openssl_state_st * cbinfo = SSL_get_ex_data(ssl, tls_exdata_idx);
3673 tls_support * tlsp;
3674
3675 DEBUG(D_tls) debug_printf("tls_save_session_cb\n");
3676
3677 if (!cbinfo || !(tlsp = cbinfo->tlsp)->host_resumable) return 0;
3678
3679 # ifdef OPENSSL_HAVE_NUM_TICKETS
3680 if (SSL_SESSION_is_resumable(ss))       /* 1.1.1 */
3681 # endif
3682   {
3683   int len = i2d_SSL_SESSION(ss, NULL);
3684   int dlen = sizeof(dbdata_tls_session) + len;
3685   dbdata_tls_session * dt = store_get(dlen, TRUE);
3686   uschar * s = dt->session;
3687   open_db dbblock, * dbm_file;
3688
3689   DEBUG(D_tls) debug_printf("session is resumable\n");
3690   tlsp->resumption |= RESUME_SERVER_TICKET;     /* server gave us a ticket */
3691
3692   dt->verify_override = tlsp->verify_override;
3693   dt->ocsp = tlsp->ocsp;
3694   (void) i2d_SSL_SESSION(ss, &s);               /* s gets bumped to end */
3695
3696   if ((dbm_file = dbfn_open(US"tls", O_RDWR, &dbblock, FALSE, FALSE)))
3697     {
3698     const uschar * key = cbinfo->host->address;
3699     dbfn_delete(dbm_file, key);
3700     dbfn_write(dbm_file, key, dt, dlen);
3701     dbfn_close(dbm_file);
3702     DEBUG(D_tls) debug_printf("wrote session (len %u) to db\n",
3703                   (unsigned)dlen);
3704     }
3705   }
3706 return 1;
3707 }
3708
3709
3710 static void
3711 tls_client_ctx_resume_prehandshake(
3712   exim_openssl_client_tls_ctx * exim_client_ctx, tls_support * tlsp,
3713   smtp_transport_options_block * ob, host_item * host)
3714 {
3715 /* Should the client request a session resumption ticket? */
3716 if (verify_check_given_host(CUSS &ob->tls_resumption_hosts, host) == OK)
3717   {
3718   tlsp->host_resumable = TRUE;
3719
3720   SSL_CTX_set_session_cache_mode(exim_client_ctx->ctx,
3721         SSL_SESS_CACHE_CLIENT
3722         | SSL_SESS_CACHE_NO_INTERNAL | SSL_SESS_CACHE_NO_AUTO_CLEAR);
3723   SSL_CTX_sess_set_new_cb(exim_client_ctx->ctx, tls_save_session_cb);
3724   }
3725 }
3726
3727 static BOOL
3728 tls_client_ssl_resume_prehandshake(SSL * ssl, tls_support * tlsp,
3729   host_item * host, uschar ** errstr)
3730 {
3731 if (tlsp->host_resumable)
3732   {
3733   DEBUG(D_tls)
3734     debug_printf("tls_resumption_hosts overrides openssl_options, enabling tickets\n");
3735   SSL_clear_options(ssl, SSL_OP_NO_TICKET);
3736
3737   tls_exdata_idx = SSL_get_ex_new_index(0, 0, 0, 0, 0);
3738   if (!SSL_set_ex_data(ssl, tls_exdata_idx, client_static_state))
3739     {
3740     tls_error(US"set ex_data", host, NULL, errstr);
3741     return FALSE;
3742     }
3743   debug_printf("tls_exdata_idx %d cbinfo %p\n", tls_exdata_idx, client_static_state);
3744   }
3745
3746 tlsp->resumption = RESUME_SUPPORTED;
3747 /* Pick up a previous session, saved on an old ticket */
3748 tls_retrieve_session(tlsp, ssl, host->address);
3749 return TRUE;
3750 }
3751
3752 static void
3753 tls_client_resume_posthandshake(exim_openssl_client_tls_ctx * exim_client_ctx,
3754   tls_support * tlsp)
3755 {
3756 if (SSL_session_reused(exim_client_ctx->ssl))
3757   {
3758   DEBUG(D_tls) debug_printf("The session was reused\n");
3759   tlsp->resumption |= RESUME_USED;
3760   }
3761 }
3762 #endif  /* !DISABLE_TLS_RESUME */
3763
3764
3765 #ifdef EXIM_HAVE_ALPN
3766 /* Expand and convert an Exim list to an ALPN list.  False return for fail.
3767 NULL plist return for silent no-ALPN.
3768 */
3769
3770 static BOOL
3771 tls_alpn_plist(const uschar * tls_alpn, const uschar ** plist, unsigned * plen,
3772   uschar ** errstr)
3773 {
3774 uschar * exp_alpn;
3775
3776 if (!expand_check(tls_alpn, US"tls_alpn", &exp_alpn, errstr))
3777   return FALSE;
3778
3779 if (!exp_alpn)
3780   {
3781   DEBUG(D_tls) debug_printf("Setting TLS ALPN forced to fail, not sending\n");
3782   *plist = NULL;
3783   }
3784 else
3785   {
3786   /* The server implementation only accepts exactly one protocol name
3787   but it's little extra code complexity in the client. */
3788
3789   const uschar * list = exp_alpn;
3790   uschar * p = store_get(Ustrlen(exp_alpn), is_tainted(exp_alpn)), * s, * t;
3791   int sep = 0;
3792   uschar len;
3793
3794   for (t = p; s = string_nextinlist(&list, &sep, NULL, 0); t += len)
3795     {
3796     *t++ = len = (uschar) Ustrlen(s);
3797     memcpy(t, s, len);
3798     }
3799   *plist = (*plen = t - p) ? p : NULL;
3800   }
3801 return TRUE;
3802 }
3803 #endif  /* EXIM_HAVE_ALPN */
3804
3805
3806 /*************************************************
3807 *    Start a TLS session in a client             *
3808 *************************************************/
3809
3810 /* Called from the smtp transport after STARTTLS has been accepted.
3811
3812 Arguments:
3813   cctx          connection context
3814   conn_args     connection details
3815   cookie        datum for randomness; can be NULL
3816   tlsp          record details of TLS channel configuration here; must be non-NULL
3817   errstr        error string pointer
3818
3819 Returns:        TRUE for success with TLS session context set in connection context,
3820                 FALSE on error
3821 */
3822
3823 BOOL
3824 tls_client_start(client_conn_ctx * cctx, smtp_connect_args * conn_args,
3825   void * cookie, tls_support * tlsp, uschar ** errstr)
3826 {
3827 host_item * host = conn_args->host;             /* for msgs and option-tests */
3828 transport_instance * tb = conn_args->tblock;    /* always smtp or NULL */
3829 smtp_transport_options_block * ob = tb
3830   ? (smtp_transport_options_block *)tb->options_block
3831   : &smtp_transport_option_defaults;
3832 exim_openssl_client_tls_ctx * exim_client_ctx;
3833 uschar * expciphers;
3834 int rc;
3835 static uschar peerdn[256];
3836
3837 #ifndef DISABLE_OCSP
3838 BOOL request_ocsp = FALSE;
3839 BOOL require_ocsp = FALSE;
3840 #endif
3841
3842 rc = store_pool;
3843 store_pool = POOL_PERM;
3844 exim_client_ctx = store_get(sizeof(exim_openssl_client_tls_ctx), FALSE);
3845 exim_client_ctx->corked = NULL;
3846 store_pool = rc;
3847
3848 #ifdef SUPPORT_DANE
3849 tlsp->tlsa_usage = 0;
3850 #endif
3851
3852 #ifndef DISABLE_OCSP
3853   {
3854 # ifdef SUPPORT_DANE
3855   /*XXX this should be moved to caller, to be common across gnutls/openssl */
3856   if (  conn_args->dane
3857      && ob->hosts_request_ocsp[0] == '*'
3858      && ob->hosts_request_ocsp[1] == '\0'
3859      )
3860     {
3861     /* Unchanged from default.  Use a safer one under DANE */
3862     request_ocsp = TRUE;
3863     ob->hosts_request_ocsp = US"${if or { {= {0}{$tls_out_tlsa_usage}} "
3864                                       "   {= {4}{$tls_out_tlsa_usage}} } "
3865                                  " {*}{}}";
3866     }
3867 # endif
3868
3869   if ((require_ocsp =
3870         verify_check_given_host(CUSS &ob->hosts_require_ocsp, host) == OK))
3871     request_ocsp = TRUE;
3872   else
3873 # ifdef SUPPORT_DANE
3874     if (!request_ocsp)
3875 # endif
3876       request_ocsp =
3877         verify_check_given_host(CUSS &ob->hosts_request_ocsp, host) == OK;
3878   }
3879 #endif
3880
3881 rc = tls_init(host, ob,
3882 #ifndef DISABLE_OCSP
3883     (void *)(long)request_ocsp,
3884 #endif
3885     cookie, &client_static_state, tlsp, errstr);
3886 if (rc != OK) return FALSE;
3887
3888 exim_client_ctx->ctx = client_static_state->lib_state.lib_ctx;
3889
3890 tlsp->certificate_verified = FALSE;
3891 client_verify_callback_called = FALSE;
3892
3893 expciphers = NULL;
3894 #ifdef SUPPORT_DANE
3895 if (conn_args->dane)
3896   {
3897   /* We fall back to tls_require_ciphers if unset, empty or forced failure, but
3898   other failures should be treated as problems. */
3899   if (ob->dane_require_tls_ciphers &&
3900       !expand_check(ob->dane_require_tls_ciphers, US"dane_require_tls_ciphers",
3901         &expciphers, errstr))
3902     return FALSE;
3903   if (expciphers && *expciphers == '\0')
3904     expciphers = NULL;
3905
3906   normalise_ciphers(&expciphers, ob->dane_require_tls_ciphers);
3907   }
3908 #endif
3909 if (!expciphers)
3910   {
3911   if (!expand_check(ob->tls_require_ciphers, US"tls_require_ciphers",
3912       &expciphers, errstr))
3913     return FALSE;
3914
3915   /* In OpenSSL, cipher components are separated by hyphens. In GnuTLS, they
3916   are separated by underscores. So that I can use either form in my tests, and
3917   also for general convenience, we turn underscores into hyphens here. */
3918
3919   normalise_ciphers(&expciphers, ob->tls_require_ciphers);
3920   }
3921
3922 if (expciphers)
3923   {
3924   DEBUG(D_tls) debug_printf("required ciphers: %s\n", expciphers);
3925   if (!SSL_CTX_set_cipher_list(exim_client_ctx->ctx, CS expciphers))
3926     {
3927     tls_error(US"SSL_CTX_set_cipher_list", host, NULL, errstr);
3928     return FALSE;
3929     }
3930   }
3931
3932 #ifdef SUPPORT_DANE
3933 if (conn_args->dane)
3934   {
3935   SSL_CTX_set_verify(exim_client_ctx->ctx,
3936     SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
3937     verify_callback_client_dane);
3938
3939   if (!DANESSL_library_init())
3940     {
3941     tls_error(US"library init", host, NULL, errstr);
3942     return FALSE;
3943     }
3944   if (DANESSL_CTX_init(exim_client_ctx->ctx) <= 0)
3945     {
3946     tls_error(US"context init", host, NULL, errstr);
3947     return FALSE;
3948     }
3949   }
3950 else
3951
3952 #endif
3953
3954 if (tls_client_basic_ctx_init(exim_client_ctx->ctx, host, ob,
3955       client_static_state, errstr) != OK)
3956   return FALSE;
3957
3958 #ifndef DISABLE_TLS_RESUME
3959 tls_client_ctx_resume_prehandshake(exim_client_ctx, tlsp, ob, host);
3960 #endif
3961
3962
3963 if (!(exim_client_ctx->ssl = SSL_new(exim_client_ctx->ctx)))
3964   {
3965   tls_error(US"SSL_new", host, NULL, errstr);
3966   return FALSE;
3967   }
3968 SSL_set_session_id_context(exim_client_ctx->ssl, sid_ctx, Ustrlen(sid_ctx));
3969
3970 SSL_set_fd(exim_client_ctx->ssl, cctx->sock);
3971 SSL_set_connect_state(exim_client_ctx->ssl);
3972
3973 if (ob->tls_sni)
3974   {
3975   if (!expand_check(ob->tls_sni, US"tls_sni", &tlsp->sni, errstr))
3976     return FALSE;
3977   if (!tlsp->sni)
3978     {
3979     DEBUG(D_tls) debug_printf("Setting TLS SNI forced to fail, not sending\n");
3980     }
3981   else if (!Ustrlen(tlsp->sni))
3982     tlsp->sni = NULL;
3983   else
3984     {
3985 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
3986     DEBUG(D_tls) debug_printf("Setting TLS SNI \"%s\"\n", tlsp->sni);
3987     SSL_set_tlsext_host_name(exim_client_ctx->ssl, tlsp->sni);
3988 #else
3989     log_write(0, LOG_MAIN, "SNI unusable with this OpenSSL library version; ignoring \"%s\"\n",
3990           tlsp->sni);
3991 #endif
3992     }
3993   }
3994
3995 if (ob->tls_alpn)
3996 #ifdef EXIM_HAVE_ALPN
3997   {
3998   const uschar * plist;
3999   unsigned plen;
4000
4001   if (!tls_alpn_plist(ob->tls_alpn, &plist, &plen, errstr))
4002     return FALSE;
4003   if (plist)
4004     if (SSL_set_alpn_protos(exim_client_ctx->ssl, plist, plen) != 0)
4005       {
4006       tls_error(US"alpn init", host, NULL, errstr);
4007       return FALSE;
4008       }
4009     else
4010       DEBUG(D_tls) debug_printf("Setting TLS ALPN '%s'\n", ob->tls_alpn);
4011   }
4012 #else
4013   log_write(0, LOG_MAIN, "ALPN unusable with this OpenSSL library version; ignoring \"%s\"\n",
4014           ob->tls_alpn);
4015 #endif
4016
4017 #ifdef SUPPORT_DANE
4018 if (conn_args->dane)
4019   if (dane_tlsa_load(exim_client_ctx->ssl, host, &conn_args->tlsa_dnsa, errstr) != OK)
4020     return FALSE;
4021 #endif
4022
4023 #ifndef DISABLE_OCSP
4024 /* Request certificate status at connection-time.  If the server
4025 does OCSP stapling we will get the callback (set in tls_init()) */
4026 # ifdef SUPPORT_DANE
4027 if (request_ocsp)
4028   {
4029   const uschar * s;
4030   if (  ((s = ob->hosts_require_ocsp) && Ustrstr(s, US"tls_out_tlsa_usage"))
4031      || ((s = ob->hosts_request_ocsp) && Ustrstr(s, US"tls_out_tlsa_usage"))
4032      )
4033     {   /* Re-eval now $tls_out_tlsa_usage is populated.  If
4034         this means we avoid the OCSP request, we wasted the setup
4035         cost in tls_init(). */
4036     require_ocsp = verify_check_given_host(CUSS &ob->hosts_require_ocsp, host) == OK;
4037     request_ocsp = require_ocsp
4038       || verify_check_given_host(CUSS &ob->hosts_request_ocsp, host) == OK;
4039     }
4040   }
4041 # endif
4042
4043 if (request_ocsp)
4044   {
4045   SSL_set_tlsext_status_type(exim_client_ctx->ssl, TLSEXT_STATUSTYPE_ocsp);
4046   client_static_state->u_ocsp.client.verify_required = require_ocsp;
4047   tlsp->ocsp = OCSP_NOT_RESP;
4048   }
4049 #endif
4050
4051 #ifndef DISABLE_TLS_RESUME
4052 if (!tls_client_ssl_resume_prehandshake(exim_client_ctx->ssl, tlsp, host,
4053       errstr))
4054   return FALSE;
4055 #endif
4056
4057 #ifndef DISABLE_EVENT
4058 client_static_state->event_action = tb ? tb->event_action : NULL;
4059 #endif
4060
4061 /* There doesn't seem to be a built-in timeout on connection. */
4062
4063 DEBUG(D_tls) debug_printf("Calling SSL_connect\n");
4064 sigalrm_seen = FALSE;
4065 ALARM(ob->command_timeout);
4066 rc = SSL_connect(exim_client_ctx->ssl);
4067 ALARM_CLR(0);
4068
4069 #ifdef SUPPORT_DANE
4070 if (conn_args->dane)
4071   DANESSL_cleanup(exim_client_ctx->ssl);
4072 #endif
4073
4074 if (rc <= 0)
4075   {
4076   tls_error(US"SSL_connect", host, sigalrm_seen ? US"timed out" : NULL, errstr);
4077   return FALSE;
4078   }
4079
4080 DEBUG(D_tls)
4081   {
4082   debug_printf("SSL_connect succeeded\n");
4083 #ifdef EXIM_HAVE_OPENSSL_KEYLOG
4084   {
4085   BIO * bp = BIO_new_fp(debug_file, BIO_NOCLOSE);
4086   SSL_SESSION_print_keylog(bp, SSL_get_session(exim_client_ctx->ssl));
4087   BIO_free(bp);
4088   }
4089 #endif
4090   }
4091
4092 #ifndef DISABLE_TLS_RESUME
4093 tls_client_resume_posthandshake(exim_client_ctx, tlsp);
4094 #endif
4095
4096 #ifdef EXIM_HAVE_ALPN
4097 if (ob->tls_alpn)       /* We requested. See what was negotiated. */
4098   {
4099   const uschar * name;
4100   unsigned len;
4101
4102   SSL_get0_alpn_selected(exim_client_ctx->ssl, &name, &len);
4103   if (len > 0)
4104     { DEBUG(D_tls) debug_printf("ALPN negotiated %u: '%.*s'\n", len, (int)*name, name+1); }
4105   else if (verify_check_given_host(CUSS &ob->hosts_require_alpn, host) == OK)
4106     {
4107     /* Would like to send a relevant fatal Alert, but OpenSSL has no API */
4108     tls_error(US"handshake", host, US"ALPN required but not negotiated", errstr);
4109     return FALSE;
4110     }
4111   }
4112 #endif
4113
4114 #ifdef SSL_get_extms_support
4115 tlsp->ext_master_secret = SSL_get_extms_support(exim_client_ctx->ssl) == 1;
4116 #endif
4117 peer_cert(exim_client_ctx->ssl, tlsp, peerdn, sizeof(peerdn));
4118
4119 tlsp->ver = tlsver_name(exim_client_ctx->ssl);
4120 tlsp->cipher = construct_cipher_name(exim_client_ctx->ssl, tlsp->ver, &tlsp->bits);
4121 tlsp->cipher_stdname = cipher_stdname_ssl(exim_client_ctx->ssl);
4122
4123 /* Record the certificate we presented */
4124   {
4125   X509 * crt = SSL_get_certificate(exim_client_ctx->ssl);
4126   tlsp->ourcert = crt ? X509_dup(crt) : NULL;
4127   }
4128
4129 /*XXX will this work with continued-TLS? */
4130 /* Channel-binding info for authenticators */
4131   {
4132   uschar c, * s;
4133   size_t len = SSL_get_finished(exim_client_ctx->ssl, &c, 0);
4134   int old_pool = store_pool;
4135
4136   SSL_get_finished(exim_client_ctx->ssl, s = store_get((int)len, TRUE), len);
4137   store_pool = POOL_PERM;
4138     tlsp->channelbinding = b64encode_taint(CUS s, (int)len, TRUE);
4139   store_pool = old_pool;
4140   DEBUG(D_tls) debug_printf("Have channel bindings cached for possible auth usage %p %p\n", tlsp->channelbinding, tlsp);
4141   }
4142
4143 tlsp->active.sock = cctx->sock;
4144 tlsp->active.tls_ctx = exim_client_ctx;
4145 cctx->tls_ctx = exim_client_ctx;
4146 return TRUE;
4147 }
4148
4149
4150
4151
4152
4153 static BOOL
4154 tls_refill(unsigned lim)
4155 {
4156 SSL * ssl = state_server.lib_state.lib_ssl;
4157 int error;
4158 int inbytes;
4159
4160 DEBUG(D_tls) debug_printf("Calling SSL_read(%p, %p, %u)\n", ssl,
4161   ssl_xfer_buffer, ssl_xfer_buffer_size);
4162
4163 ERR_clear_error();
4164 if (smtp_receive_timeout > 0) ALARM(smtp_receive_timeout);
4165 inbytes = SSL_read(ssl, CS ssl_xfer_buffer,
4166                   MIN(ssl_xfer_buffer_size, lim));
4167 error = SSL_get_error(ssl, inbytes);
4168 if (smtp_receive_timeout > 0) ALARM_CLR(0);
4169
4170 if (had_command_timeout)                /* set by signal handler */
4171   smtp_command_timeout_exit();          /* does not return */
4172 if (had_command_sigterm)
4173   smtp_command_sigterm_exit();
4174 if (had_data_timeout)
4175   smtp_data_timeout_exit();
4176 if (had_data_sigint)
4177   smtp_data_sigint_exit();
4178
4179 /* SSL_ERROR_ZERO_RETURN appears to mean that the SSL session has been
4180 closed down, not that the socket itself has been closed down. Revert to
4181 non-SSL handling. */
4182
4183 switch(error)
4184   {
4185   case SSL_ERROR_NONE:
4186     break;
4187
4188   case SSL_ERROR_ZERO_RETURN:
4189     DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
4190
4191     if (SSL_get_shutdown(ssl) == SSL_RECEIVED_SHUTDOWN)
4192           SSL_shutdown(ssl);
4193
4194     tls_close(NULL, TLS_NO_SHUTDOWN);
4195     return FALSE;
4196
4197   /* Handle genuine errors */
4198   case SSL_ERROR_SSL:
4199     ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
4200     log_write(0, LOG_MAIN, "TLS error (SSL_read): %s", ssl_errstring);
4201     ssl_xfer_error = TRUE;
4202     return FALSE;
4203
4204   default:
4205     DEBUG(D_tls) debug_printf("Got SSL error %d\n", error);
4206     DEBUG(D_tls) if (error == SSL_ERROR_SYSCALL)
4207       debug_printf(" - syscall %s\n", strerror(errno));
4208     ssl_xfer_error = TRUE;
4209     return FALSE;
4210   }
4211
4212 #ifndef DISABLE_DKIM
4213 dkim_exim_verify_feed(ssl_xfer_buffer, inbytes);
4214 #endif
4215 ssl_xfer_buffer_hwm = inbytes;
4216 ssl_xfer_buffer_lwm = 0;
4217 return TRUE;
4218 }
4219
4220
4221 /*************************************************
4222 *            TLS version of getc                 *
4223 *************************************************/
4224
4225 /* This gets the next byte from the TLS input buffer. If the buffer is empty,
4226 it refills the buffer via the SSL reading function.
4227
4228 Arguments:  lim         Maximum amount to read/buffer
4229 Returns:    the next character or EOF
4230
4231 Only used by the server-side TLS.
4232 */
4233
4234 int
4235 tls_getc(unsigned lim)
4236 {
4237 if (ssl_xfer_buffer_lwm >= ssl_xfer_buffer_hwm)
4238   if (!tls_refill(lim))
4239     return ssl_xfer_error ? EOF : smtp_getc(lim);
4240
4241 /* Something in the buffer; return next uschar */
4242
4243 return ssl_xfer_buffer[ssl_xfer_buffer_lwm++];
4244 }
4245
4246 BOOL
4247 tls_hasc(void)
4248 {
4249 return ssl_xfer_buffer_lwm < ssl_xfer_buffer_hwm;
4250 }
4251
4252 uschar *
4253 tls_getbuf(unsigned * len)
4254 {
4255 unsigned size;
4256 uschar * buf;
4257
4258 if (ssl_xfer_buffer_lwm >= ssl_xfer_buffer_hwm)
4259   if (!tls_refill(*len))
4260     {
4261     if (!ssl_xfer_error) return smtp_getbuf(len);
4262     *len = 0;
4263     return NULL;
4264     }
4265
4266 if ((size = ssl_xfer_buffer_hwm - ssl_xfer_buffer_lwm) > *len)
4267   size = *len;
4268 buf = &ssl_xfer_buffer[ssl_xfer_buffer_lwm];
4269 ssl_xfer_buffer_lwm += size;
4270 *len = size;
4271 return buf;
4272 }
4273
4274
4275 void
4276 tls_get_cache(unsigned lim)
4277 {
4278 #ifndef DISABLE_DKIM
4279 int n = ssl_xfer_buffer_hwm - ssl_xfer_buffer_lwm;
4280 debug_printf("tls_get_cache\n");
4281 if (n > lim)
4282   n = lim;
4283 if (n > 0)
4284   dkim_exim_verify_feed(ssl_xfer_buffer+ssl_xfer_buffer_lwm, n);
4285 #endif
4286 }
4287
4288
4289 BOOL
4290 tls_could_getc(void)
4291 {
4292 return ssl_xfer_buffer_lwm < ssl_xfer_buffer_hwm
4293     || SSL_pending(state_server.lib_state.lib_ssl) > 0;
4294 }
4295
4296
4297 /*************************************************
4298 *          Read bytes from TLS channel           *
4299 *************************************************/
4300
4301 /*
4302 Arguments:
4303   ct_ctx    client context pointer, or NULL for the one global server context
4304   buff      buffer of data
4305   len       size of buffer
4306
4307 Returns:    the number of bytes read
4308             -1 after a failed read, including EOF
4309
4310 Only used by the client-side TLS.
4311 */
4312
4313 int
4314 tls_read(void * ct_ctx, uschar *buff, size_t len)
4315 {
4316 SSL * ssl = ct_ctx ? ((exim_openssl_client_tls_ctx *)ct_ctx)->ssl
4317                   : state_server.lib_state.lib_ssl;
4318 int inbytes;
4319 int error;
4320
4321 DEBUG(D_tls) debug_printf("Calling SSL_read(%p, %p, %u)\n", ssl,
4322   buff, (unsigned int)len);
4323
4324 ERR_clear_error();
4325 inbytes = SSL_read(ssl, CS buff, len);
4326 error = SSL_get_error(ssl, inbytes);
4327
4328 if (error == SSL_ERROR_ZERO_RETURN)
4329   {
4330   DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
4331   return -1;
4332   }
4333 else if (error != SSL_ERROR_NONE)
4334   return -1;
4335
4336 return inbytes;
4337 }
4338
4339
4340
4341
4342
4343 /*************************************************
4344 *         Write bytes down TLS channel           *
4345 *************************************************/
4346
4347 /*
4348 Arguments:
4349   ct_ctx    client context pointer, or NULL for the one global server context
4350   buff      buffer of data
4351   len       number of bytes
4352   more      further data expected soon
4353
4354 Returns:    the number of bytes after a successful write,
4355             -1 after a failed write
4356
4357 Used by both server-side and client-side TLS.  Calling with len zero and more unset
4358 will flush buffered writes; buff can be null for this case.
4359 */
4360
4361 int
4362 tls_write(void * ct_ctx, const uschar * buff, size_t len, BOOL more)
4363 {
4364 size_t olen = len;
4365 int outbytes, error;
4366 SSL * ssl = ct_ctx
4367   ? ((exim_openssl_client_tls_ctx *)ct_ctx)->ssl
4368   : state_server.lib_state.lib_ssl;
4369 static gstring * server_corked = NULL;
4370 gstring ** corkedp = ct_ctx
4371   ? &((exim_openssl_client_tls_ctx *)ct_ctx)->corked : &server_corked;
4372 gstring * corked = *corkedp;
4373
4374 DEBUG(D_tls) debug_printf("%s(%p, %lu%s)\n", __FUNCTION__,
4375   buff, (unsigned long)len, more ? ", more" : "");
4376
4377 /* Lacking a CORK or MSG_MORE facility (such as GnuTLS has) we copy data when
4378 "more" is notified.  This hack is only ok if small amounts are involved AND only
4379 one stream does it, in one context (i.e. no store reset).  Currently it is used
4380 for the responses to the received SMTP MAIL , RCPT, DATA sequence, only.
4381 We support callouts done by the server process by using a separate client
4382 context for the stashed information. */
4383 /* + if PIPE_COMMAND, banner & ehlo-resp for smmtp-on-connect. Suspect there's
4384 a store reset there, so use POOL_PERM. */
4385 /* + if CHUNKING, cmds EHLO,MAIL,RCPT(s),BDAT */
4386
4387 if (more || corked)
4388   {
4389   if (!len) buff = US &error;   /* dummy just so that string_catn is ok */
4390
4391   int save_pool = store_pool;
4392   store_pool = POOL_PERM;
4393
4394   corked = string_catn(corked, buff, len);
4395
4396   store_pool = save_pool;
4397
4398   if (more)
4399     {
4400     *corkedp = corked;
4401     return len;
4402     }
4403   buff = CUS corked->s;
4404   len = corked->ptr;
4405   *corkedp = NULL;
4406   }
4407
4408 for (int left = len; left > 0;)
4409   {
4410   DEBUG(D_tls) debug_printf("SSL_write(%p, %p, %d)\n", ssl, buff, left);
4411   ERR_clear_error();
4412   outbytes = SSL_write(ssl, CS buff, left);
4413   error = SSL_get_error(ssl, outbytes);
4414   DEBUG(D_tls) debug_printf("outbytes=%d error=%d\n", outbytes, error);
4415   switch (error)
4416     {
4417     case SSL_ERROR_NONE:        /* the usual case */
4418       left -= outbytes;
4419       buff += outbytes;
4420       break;
4421
4422     case SSL_ERROR_SSL:
4423       ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
4424       log_write(0, LOG_MAIN, "TLS error (SSL_write): %s", ssl_errstring);
4425       return -1;
4426
4427     case SSL_ERROR_ZERO_RETURN:
4428       log_write(0, LOG_MAIN, "SSL channel closed on write");
4429       return -1;
4430
4431     case SSL_ERROR_SYSCALL:
4432       if (ct_ctx || errno != ECONNRESET || !f.smtp_in_quit)
4433         log_write(0, LOG_MAIN, "SSL_write: (from %s) syscall: %s",
4434           sender_fullhost ? sender_fullhost : US"<unknown>",
4435           strerror(errno));
4436       else if (LOGGING(protocol_detail))
4437         log_write(0, LOG_MAIN, "[%s] after QUIT, client reset TCP before"
4438           " SMTP response and TLS close\n", sender_host_address);
4439       else
4440         DEBUG(D_tls) debug_printf("[%s] SSL_write: after QUIT,"
4441           " client reset TCP before TLS close\n", sender_host_address);
4442       return -1;
4443
4444     default:
4445       log_write(0, LOG_MAIN, "SSL_write error %d", error);
4446       return -1;
4447     }
4448   }
4449 return olen;
4450 }
4451
4452
4453
4454 /*
4455 Arguments:
4456   ct_ctx        client TLS context pointer, or NULL for the one global server context
4457 */
4458
4459 void
4460 tls_shutdown_wr(void * ct_ctx)
4461 {
4462 exim_openssl_client_tls_ctx * o_ctx = ct_ctx;
4463 SSL ** sslp = o_ctx ? &o_ctx->ssl : (SSL **) &state_server.lib_state.lib_ssl;
4464 int * fdp = o_ctx ? &tls_out.active.sock : &tls_in.active.sock;
4465 int rc;
4466
4467 if (*fdp < 0) return;  /* TLS was not active */
4468
4469 tls_write(ct_ctx, NULL, 0, FALSE);      /* flush write buffer */
4470
4471 HDEBUG(D_transport|D_tls|D_acl|D_v) debug_printf_indent("  SMTP(TLS shutdown)>>\n");
4472 rc = SSL_shutdown(*sslp);
4473 if (rc < 0) DEBUG(D_tls)
4474   {
4475   ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
4476   debug_printf("SSL_shutdown: %s\n", ssl_errstring);
4477   }
4478 }
4479
4480 /*************************************************
4481 *         Close down a TLS session               *
4482 *************************************************/
4483
4484 /* This is also called from within a delivery subprocess forked from the
4485 daemon, to shut down the TLS library, without actually doing a shutdown (which
4486 would tamper with the SSL session in the parent process).
4487
4488 Arguments:
4489   ct_ctx        client TLS context pointer, or NULL for the one global server context
4490   do_shutdown   0 no data-flush or TLS close-alert
4491                 1 if TLS close-alert is to be sent,
4492                 2 if also response to be waited for
4493
4494 Returns:     nothing
4495
4496 Used by both server-side and client-side TLS.
4497 */
4498
4499 void
4500 tls_close(void * ct_ctx, int do_shutdown)
4501 {
4502 exim_openssl_client_tls_ctx * o_ctx = ct_ctx;
4503 SSL ** sslp = o_ctx ? &o_ctx->ssl : (SSL **) &state_server.lib_state.lib_ssl;
4504 int * fdp = o_ctx ? &tls_out.active.sock : &tls_in.active.sock;
4505
4506 if (*fdp < 0) return;  /* TLS was not active */
4507
4508 if (do_shutdown)
4509   {
4510   int rc;
4511   DEBUG(D_tls) debug_printf("tls_close(): shutting down TLS%s\n",
4512     do_shutdown > 1 ? " (with response-wait)" : "");
4513
4514   tls_write(ct_ctx, NULL, 0, FALSE);    /* flush write buffer */
4515
4516   if (  (rc = SSL_shutdown(*sslp)) == 0 /* send "close notify" alert */
4517      && do_shutdown > 1)
4518     {
4519 #ifdef EXIM_TCP_CORK
4520     (void) setsockopt(*fdp, IPPROTO_TCP, EXIM_TCP_CORK, US &off, sizeof(off));
4521 #endif
4522     ALARM(2);
4523     rc = SSL_shutdown(*sslp);           /* wait for response */
4524     ALARM_CLR(0);
4525     }
4526
4527   if (rc < 0) DEBUG(D_tls)
4528     {
4529     ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
4530     debug_printf("SSL_shutdown: %s\n", ssl_errstring);
4531     }
4532   }
4533
4534 if (!o_ctx)             /* server side */
4535   {
4536 #ifndef DISABLE_OCSP
4537   sk_X509_pop_free(state_server.verify_stack, X509_free);
4538   state_server.verify_stack = NULL;
4539 #endif
4540
4541   receive_getc =        smtp_getc;
4542   receive_getbuf =      smtp_getbuf;
4543   receive_get_cache =   smtp_get_cache;
4544   receive_hasc =        smtp_hasc;
4545   receive_ungetc =      smtp_ungetc;
4546   receive_feof =        smtp_feof;
4547   receive_ferror =      smtp_ferror;
4548   tls_in.active.tls_ctx = NULL;
4549   tls_in.sni = NULL;
4550   /* Leave bits, peercert, cipher, peerdn, certificate_verified set, for logging */
4551   }
4552
4553 SSL_free(*sslp);
4554 *sslp = NULL;
4555 *fdp = -1;
4556 }
4557
4558
4559
4560
4561 /*************************************************
4562 *  Let tls_require_ciphers be checked at startup *
4563 *************************************************/
4564
4565 /* The tls_require_ciphers option, if set, must be something which the
4566 library can parse.
4567
4568 Returns:     NULL on success, or error message
4569 */
4570
4571 uschar *
4572 tls_validate_require_cipher(void)
4573 {
4574 SSL_CTX *ctx;
4575 uschar *s, *expciphers, *err;
4576
4577 tls_openssl_init();
4578
4579 if (!(tls_require_ciphers && *tls_require_ciphers))
4580   return NULL;
4581
4582 if (!expand_check(tls_require_ciphers, US"tls_require_ciphers", &expciphers,
4583                   &err))
4584   return US"failed to expand tls_require_ciphers";
4585
4586 if (!(expciphers && *expciphers))
4587   return NULL;
4588
4589 normalise_ciphers(&expciphers, tls_require_ciphers);
4590
4591 err = NULL;
4592 if (lib_ctx_new(&ctx, NULL, &err) == OK)
4593   {
4594   DEBUG(D_tls)
4595     debug_printf("tls_require_ciphers expands to \"%s\"\n", expciphers);
4596
4597   if (!SSL_CTX_set_cipher_list(ctx, CS expciphers))
4598     {
4599     ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
4600     err = string_sprintf("SSL_CTX_set_cipher_list(%s) failed: %s",
4601                         expciphers, ssl_errstring);
4602     }
4603
4604   SSL_CTX_free(ctx);
4605   }
4606 return err;
4607 }
4608
4609
4610
4611
4612 /*************************************************
4613 *         Report the library versions.           *
4614 *************************************************/
4615
4616 /* There have historically been some issues with binary compatibility in
4617 OpenSSL libraries; if Exim (like many other applications) is built against
4618 one version of OpenSSL but the run-time linker picks up another version,
4619 it can result in serious failures, including crashing with a SIGSEGV.  So
4620 report the version found by the compiler and the run-time version.
4621
4622 Note: some OS vendors backport security fixes without changing the version
4623 number/string, and the version date remains unchanged.  The _build_ date
4624 will change, so we can more usefully assist with version diagnosis by also
4625 reporting the build date.
4626
4627 Arguments:   a FILE* to print the results to
4628 Returns:     nothing
4629 */
4630
4631 void
4632 tls_version_report(FILE *f)
4633 {
4634 fprintf(f, "Library version: OpenSSL: Compile: %s\n"
4635            "                          Runtime: %s\n"
4636            "                                 : %s\n",
4637            OPENSSL_VERSION_TEXT,
4638            SSLeay_version(SSLEAY_VERSION),
4639            SSLeay_version(SSLEAY_BUILT_ON));
4640 /* third line is 38 characters for the %s and the line is 73 chars long;
4641 the OpenSSL output includes a "built on: " prefix already. */
4642 }
4643
4644
4645
4646
4647 /*************************************************
4648 *            Random number generation            *
4649 *************************************************/
4650
4651 /* Pseudo-random number generation.  The result is not expected to be
4652 cryptographically strong but not so weak that someone will shoot themselves
4653 in the foot using it as a nonce in input in some email header scheme or
4654 whatever weirdness they'll twist this into.  The result should handle fork()
4655 and avoid repeating sequences.  OpenSSL handles that for us.
4656
4657 Arguments:
4658   max       range maximum
4659 Returns     a random number in range [0, max-1]
4660 */
4661
4662 int
4663 vaguely_random_number(int max)
4664 {
4665 unsigned int r;
4666 int i, needed_len;
4667 static pid_t pidlast = 0;
4668 pid_t pidnow;
4669 uschar smallbuf[sizeof(r)];
4670
4671 if (max <= 1)
4672   return 0;
4673
4674 pidnow = getpid();
4675 if (pidnow != pidlast)
4676   {
4677   /* Although OpenSSL documents that "OpenSSL makes sure that the PRNG state
4678   is unique for each thread", this doesn't apparently apply across processes,
4679   so our own warning from vaguely_random_number_fallback() applies here too.
4680   Fix per PostgreSQL. */
4681   if (pidlast != 0)
4682     RAND_cleanup();
4683   pidlast = pidnow;
4684   }
4685
4686 /* OpenSSL auto-seeds from /dev/random, etc, but this a double-check. */
4687 if (!RAND_status())
4688   {
4689   randstuff r;
4690   gettimeofday(&r.tv, NULL);
4691   r.p = getpid();
4692
4693   RAND_seed(US (&r), sizeof(r));
4694   }
4695 /* We're after pseudo-random, not random; if we still don't have enough data
4696 in the internal PRNG then our options are limited.  We could sleep and hope
4697 for entropy to come along (prayer technique) but if the system is so depleted
4698 in the first place then something is likely to just keep taking it.  Instead,
4699 we'll just take whatever little bit of pseudo-random we can still manage to
4700 get. */
4701
4702 needed_len = sizeof(r);
4703 /* Don't take 8 times more entropy than needed if int is 8 octets and we were
4704 asked for a number less than 10. */
4705 for (r = max, i = 0; r; ++i)
4706   r >>= 1;
4707 i = (i + 7) / 8;
4708 if (i < needed_len)
4709   needed_len = i;
4710
4711 #ifdef EXIM_HAVE_RAND_PSEUDO
4712 /* We do not care if crypto-strong */
4713 i = RAND_pseudo_bytes(smallbuf, needed_len);
4714 #else
4715 i = RAND_bytes(smallbuf, needed_len);
4716 #endif
4717
4718 if (i < 0)
4719   {
4720   DEBUG(D_all)
4721     debug_printf("OpenSSL RAND_pseudo_bytes() not supported by RAND method, using fallback.\n");
4722   return vaguely_random_number_fallback(max);
4723   }
4724
4725 r = 0;
4726 for (uschar * p = smallbuf; needed_len; --needed_len, ++p)
4727   r = 256 * r + *p;
4728
4729 /* We don't particularly care about weighted results; if someone wants
4730 smooth distribution and cares enough then they should submit a patch then. */
4731 return r % max;
4732 }
4733
4734
4735
4736
4737 /*************************************************
4738 *        OpenSSL option parse                    *
4739 *************************************************/
4740
4741 /* Parse one option for tls_openssl_options_parse below
4742
4743 Arguments:
4744   name    one option name
4745   value   place to store a value for it
4746 Returns   success or failure in parsing
4747 */
4748
4749
4750
4751 static BOOL
4752 tls_openssl_one_option_parse(uschar *name, long *value)
4753 {
4754 int first = 0;
4755 int last = exim_openssl_options_size;
4756 while (last > first)
4757   {
4758   int middle = (first + last)/2;
4759   int c = Ustrcmp(name, exim_openssl_options[middle].name);
4760   if (c == 0)
4761     {
4762     *value = exim_openssl_options[middle].value;
4763     return TRUE;
4764     }
4765   else if (c > 0)
4766     first = middle + 1;
4767   else
4768     last = middle;
4769   }
4770 return FALSE;
4771 }
4772
4773
4774
4775
4776 /*************************************************
4777 *        OpenSSL option parsing logic            *
4778 *************************************************/
4779
4780 /* OpenSSL has a number of compatibility options which an administrator might
4781 reasonably wish to set.  Interpret a list similarly to decode_bits(), so that
4782 we look like log_selector.
4783
4784 Arguments:
4785   option_spec  the administrator-supplied string of options
4786   results      ptr to long storage for the options bitmap
4787 Returns        success or failure
4788 */
4789
4790 BOOL
4791 tls_openssl_options_parse(uschar *option_spec, long *results)
4792 {
4793 long result, item;
4794 uschar * exp, * end;
4795 BOOL adding, item_parsed;
4796
4797 /* Server: send no (<= TLS1.2) session tickets */
4798 result = SSL_OP_NO_TICKET;
4799
4800 /* Prior to 4.80 we or'd in SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS; removed
4801 from default because it increases BEAST susceptibility. */
4802 #ifdef SSL_OP_NO_SSLv2
4803 result |= SSL_OP_NO_SSLv2;
4804 #endif
4805 #ifdef SSL_OP_NO_SSLv3
4806 result |= SSL_OP_NO_SSLv3;
4807 #endif
4808 #ifdef SSL_OP_SINGLE_DH_USE
4809 result |= SSL_OP_SINGLE_DH_USE;
4810 #endif
4811 #ifdef SSL_OP_NO_RENEGOTIATION
4812 result |= SSL_OP_NO_RENEGOTIATION;
4813 #endif
4814
4815 if (!option_spec)
4816   {
4817   *results = result;
4818   return TRUE;
4819   }
4820
4821 if (!expand_check(option_spec, US"openssl_options", &exp, &end))
4822   return FALSE;
4823
4824 for (uschar * s = exp; *s; /**/)
4825   {
4826   while (isspace(*s)) ++s;
4827   if (*s == '\0')
4828     break;
4829   if (*s != '+' && *s != '-')
4830     {
4831     DEBUG(D_tls) debug_printf("malformed openssl option setting: "
4832         "+ or - expected but found \"%s\"\n", s);
4833     return FALSE;
4834     }
4835   adding = *s++ == '+';
4836   for (end = s; *end && !isspace(*end); ) end++;
4837   item_parsed = tls_openssl_one_option_parse(string_copyn(s, end-s), &item);
4838   if (!item_parsed)
4839     {
4840     DEBUG(D_tls) debug_printf("openssl option setting unrecognised: \"%s\"\n", s);
4841     return FALSE;
4842     }
4843   DEBUG(D_tls) debug_printf("openssl option, %s %08lx: %08lx (%s)\n",
4844       adding ? "adding to    " : "removing from", result, item, s);
4845   if (adding)
4846     result |= item;
4847   else
4848     result &= ~item;
4849   s = end;
4850   }
4851
4852 *results = result;
4853 return TRUE;
4854 }
4855
4856 #endif  /*!MACRO_PREDEF*/
4857 /* vi: aw ai sw=2
4858 */
4859 /* End of tls-openssl.c */