src/src/tls-openssl.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
   6 /* Copyright (c) University of Cambridge 1995 - 2019 */
   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), GET_UNTAINTED);
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, GET_TAINTED);
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  {                              /* Expect this when we requested ocsp but got none */
2421   if (SSL_session_reused(s) && tls_out.ocsp == OCSP_VFIED)
2422     {
2423     DEBUG(D_tls) debug_printf(" null, but resumed; ocsp vfy stored with session is good\n");
2424     return 1;
2425     }
2426   if (cbinfo->u_ocsp.client.verify_required && LOGGING(tls_cipher))
2427     log_write(0, LOG_MAIN, "Required TLS certificate status not received");
2428   else
2429     DEBUG(D_tls) debug_printf(" null\n");
2430   return cbinfo->u_ocsp.client.verify_required ? 0 : 1;
2431  }
2432
2433 if (!(rsp = d2i_OCSP_RESPONSE(NULL, &p, len)))
2434   {
2435   tls_out.ocsp = OCSP_FAILED;   /*XXX should use tlsp-> to permit concurrent outbound */
2436   if (LOGGING(tls_cipher))
2437     log_write(0, LOG_MAIN, "Received TLS cert status response, parse error");
2438   else
2439     DEBUG(D_tls) debug_printf(" parse error\n");
2440   return 0;
2441   }
2442
2443 if (!(bs = OCSP_response_get1_basic(rsp)))
2444   {
2445   tls_out.ocsp = OCSP_FAILED;
2446   if (LOGGING(tls_cipher))
2447     log_write(0, LOG_MAIN, "Received TLS cert status response, error parsing response");
2448   else
2449     DEBUG(D_tls) debug_printf(" error parsing response\n");
2450   OCSP_RESPONSE_free(rsp);
2451   return 0;
2452   }
2453
2454 /* We'd check the nonce here if we'd put one in the request. */
2455 /* However that would defeat cacheability on the server so we don't. */
2456
2457 /* This section of code reworked from OpenSSL apps source;
2458    The OpenSSL Project retains copyright:
2459    Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
2460 */
2461   {
2462     BIO * bp = NULL;
2463 #ifndef EXIM_HAVE_OCSP_RESP_COUNT
2464     STACK_OF(OCSP_SINGLERESP) * sresp = bs->tbsResponseData->responses;
2465 #endif
2466
2467     DEBUG(D_tls) bp = BIO_new(BIO_s_mem());
2468
2469     /*OCSP_RESPONSE_print(bp, rsp, 0);   extreme debug: stapling content */
2470
2471     /* Use the chain that verified the server cert to verify the stapled info */
2472     /* DEBUG(D_tls) x509_store_dump_cert_s_names(cbinfo->u_ocsp.client.verify_store); */
2473
2474     if ((i = OCSP_basic_verify(bs, cbinfo->verify_stack,
2475               cbinfo->u_ocsp.client.verify_store, OCSP_NOEXPLICIT)) <= 0)
2476       if (ERR_peek_error())
2477         {
2478         tls_out.ocsp = OCSP_FAILED;
2479         if (LOGGING(tls_cipher)) log_write(0, LOG_MAIN,
2480                 "Received TLS cert status response, itself unverifiable: %s",
2481                 ERR_reason_error_string(ERR_peek_error()));
2482         DEBUG(D_tls)
2483           {
2484           BIO_printf(bp, "OCSP response verify failure\n");
2485           ERR_print_errors(bp);
2486           OCSP_RESPONSE_print(bp, rsp, 0);
2487           }
2488         goto failed;
2489         }
2490       else
2491         DEBUG(D_tls) debug_printf("no explicit trust for OCSP signing"
2492           " in the root CA certificate; ignoring\n");
2493
2494     DEBUG(D_tls) debug_printf("OCSP response well-formed and signed OK\n");
2495
2496     /*XXX So we have a good stapled OCSP status.  How do we know
2497     it is for the cert of interest?  OpenSSL 1.1.0 has a routine
2498     OCSP_resp_find_status() which matches on a cert id, which presumably
2499     we should use. Making an id needs OCSP_cert_id_new(), which takes
2500     issuerName, issuerKey, serialNumber.  Are they all in the cert?
2501
2502     For now, carry on blindly accepting the resp. */
2503
2504     for (int idx =
2505 #ifdef EXIM_HAVE_OCSP_RESP_COUNT
2506             OCSP_resp_count(bs) - 1;
2507 #else
2508             sk_OCSP_SINGLERESP_num(sresp) - 1;
2509 #endif
2510          idx >= 0; idx--)
2511       {
2512       OCSP_SINGLERESP * single = OCSP_resp_get0(bs, idx);
2513       int status, reason;
2514       ASN1_GENERALIZEDTIME * rev, * thisupd, * nextupd;
2515
2516   /*XXX so I can see putting a loop in here to handle a rsp with >1 singleresp
2517   - but what happens with a GnuTLS-style input?
2518
2519   we could do with a debug label for each singleresp
2520   - it has a certID with a serialNumber, but I see no API to get that
2521   */
2522       status = OCSP_single_get0_status(single, &reason, &rev,
2523                   &thisupd, &nextupd);
2524
2525       DEBUG(D_tls)
2526         {
2527         time_print(bp, "This OCSP Update", thisupd);
2528         if (nextupd) time_print(bp, "Next OCSP Update", nextupd);
2529         }
2530       if (!OCSP_check_validity(thisupd, nextupd,
2531             EXIM_OCSP_SKEW_SECONDS, EXIM_OCSP_MAX_AGE))
2532         {
2533         tls_out.ocsp = OCSP_FAILED;
2534         DEBUG(D_tls) ERR_print_errors(bp);
2535         log_write(0, LOG_MAIN, "OCSP dates invalid");
2536         goto failed;
2537         }
2538
2539       DEBUG(D_tls) BIO_printf(bp, "Certificate status: %s\n",
2540                     OCSP_cert_status_str(status));
2541       switch(status)
2542         {
2543         case V_OCSP_CERTSTATUS_GOOD:
2544           continue;     /* the idx loop */
2545         case V_OCSP_CERTSTATUS_REVOKED:
2546           log_write(0, LOG_MAIN, "Server certificate revoked%s%s",
2547               reason != -1 ? "; reason: " : "",
2548               reason != -1 ? OCSP_crl_reason_str(reason) : "");
2549           DEBUG(D_tls) time_print(bp, "Revocation Time", rev);
2550           break;
2551         default:
2552           log_write(0, LOG_MAIN,
2553               "Server certificate status unknown, in OCSP stapling");
2554           break;
2555         }
2556
2557       goto failed;
2558       }
2559
2560     i = 1;
2561     tls_out.ocsp = OCSP_VFIED;
2562     goto good;
2563
2564   failed:
2565     tls_out.ocsp = OCSP_FAILED;
2566     i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
2567   good:
2568     {
2569     uschar * s = NULL;
2570     int len = (int) BIO_get_mem_data(bp, CSS &s);
2571     if (len > 0) debug_printf("%.*s", len, s);
2572     }
2573     BIO_free(bp);
2574   }
2575
2576 OCSP_RESPONSE_free(rsp);
2577 return i;
2578 }
2579 #endif  /*!DISABLE_OCSP*/
2580
2581
2582 /*************************************************
2583 *            Initialize for TLS                  *
2584 *************************************************/
2585 /* Called from both server and client code, to do preliminary initialization
2586 of the library.  We allocate and return a context structure.
2587
2588 Arguments:
2589   host            connected host, if client; NULL if server
2590   ob              transport options block, if client; NULL if server
2591   ocsp_file       file of stapling info (server); flag for require ocsp (client)
2592   addr            address if client; NULL if server (for some randomness)
2593   caller_state    place to put pointer to allocated state-struct
2594   errstr          error string pointer
2595
2596 Returns:          OK/DEFER/FAIL
2597 */
2598
2599 static int
2600 tls_init(host_item * host, smtp_transport_options_block * ob,
2601 #ifndef DISABLE_OCSP
2602   uschar *ocsp_file,
2603 #endif
2604   address_item *addr, exim_openssl_state_st ** caller_state,
2605   tls_support * tlsp,
2606   uschar ** errstr)
2607 {
2608 SSL_CTX * ctx;
2609 exim_openssl_state_st * state;
2610 int rc;
2611
2612 if (host)                       /* client */
2613   {
2614   state = store_malloc(sizeof(exim_openssl_state_st));
2615   memset(state, 0, sizeof(*state));
2616   state->certificate = ob->tls_certificate;
2617   state->privatekey =  ob->tls_privatekey;
2618   state->is_server = FALSE;
2619   state->dhparam = NULL;
2620   state->lib_state = ob->tls_preload;
2621   }
2622 else                            /* server */
2623   {
2624   state = &state_server;
2625   state->certificate = tls_certificate;
2626   state->privatekey =  tls_privatekey;
2627   state->is_server = TRUE;
2628   state->dhparam = tls_dhparam;
2629   state->lib_state = state_server.lib_state;
2630   }
2631
2632 state->tlsp = tlsp;
2633 state->host = host;
2634
2635 if (!state->lib_state.pri_string)
2636   state->server_cipher_list = NULL;
2637
2638 #ifndef DISABLE_EVENT
2639 state->event_action = NULL;
2640 #endif
2641
2642 tls_openssl_init();
2643
2644 /* It turns out that we need to seed the random number generator this early in
2645 order to get the full complement of ciphers to work. It took me roughly a day
2646 of work to discover this by experiment.
2647
2648 On systems that have /dev/urandom, SSL may automatically seed itself from
2649 there. Otherwise, we have to make something up as best we can. Double check
2650 afterwards.
2651
2652 Although we likely called this before, at daemon startup, this is a chance
2653 to mix in further variable info (time, pid) if needed. */
2654
2655 if (!lib_rand_init(addr))
2656   return tls_error(US"RAND_status", host,
2657     US"unable to seed random number generator", errstr);
2658
2659 /* Apply administrator-supplied work-arounds.
2660 Historically we applied just one requested option,
2661 SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS, but when bug 994 requested a second, we
2662 moved to an administrator-controlled list of options to specify and
2663 grandfathered in the first one as the default value for "openssl_options".
2664
2665 No OpenSSL version number checks: the options we accept depend upon the
2666 availability of the option value macros from OpenSSL.  */
2667
2668 if (!init_options)
2669   if (!tls_openssl_options_parse(openssl_options, &init_options))
2670     return tls_error(US"openssl_options parsing failed", host, NULL, errstr);
2671
2672 /* Create a context.
2673 The OpenSSL docs in 1.0.1b have not been updated to clarify TLS variant
2674 negotiation in the different methods; as far as I can tell, the only
2675 *_{server,client}_method which allows negotiation is SSLv23, which exists even
2676 when OpenSSL is built without SSLv2 support.
2677 By disabling with openssl_options, we can let admins re-enable with the
2678 existing knob. */
2679
2680 if (!(ctx = state->lib_state.lib_ctx))
2681   {
2682   if ((rc = lib_ctx_new(&ctx, host, errstr)) != OK)
2683     return rc;
2684   state->lib_state.lib_ctx = ctx;
2685   }
2686
2687 #ifndef DISABLE_TLS_RESUME
2688 tlsp->resumption = RESUME_SUPPORTED;
2689 #endif
2690 if (init_options)
2691   {
2692 #ifndef DISABLE_TLS_RESUME
2693   /* Should the server offer session resumption? */
2694   if (!host && verify_check_host(&tls_resumption_hosts) == OK)
2695     {
2696     DEBUG(D_tls) debug_printf("tls_resumption_hosts overrides openssl_options\n");
2697     init_options &= ~SSL_OP_NO_TICKET;
2698     tlsp->resumption |= RESUME_SERVER_TICKET; /* server will give ticket on request */
2699     tlsp->host_resumable = TRUE;
2700     }
2701 #endif
2702
2703   DEBUG(D_tls) debug_printf("setting SSL CTX options: %#lx\n", init_options);
2704   if (!(SSL_CTX_set_options(ctx, init_options)))
2705     return tls_error(string_sprintf(
2706           "SSL_CTX_set_option(%#lx)", init_options), host, NULL, errstr);
2707   }
2708 else
2709   DEBUG(D_tls) debug_printf("no SSL CTX options to set\n");
2710
2711 /* We'd like to disable session cache unconditionally, but foolish Outlook
2712 Express clients then give up the first TLS connection and make a second one
2713 (which works).  Only when there is an IMAP service on the same machine.
2714 Presumably OE is trying to use the cache for A on B.  Leave it enabled for
2715 now, until we work out a decent way of presenting control to the config.  It
2716 will never be used because we use a new context every time. */
2717 #ifdef notdef
2718 (void) SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
2719 #endif
2720
2721 /* Initialize with DH parameters if supplied */
2722 /* Initialize ECDH temp key parameter selection */
2723
2724 if (!host)
2725   {
2726   if (state->lib_state.dh)
2727     { DEBUG(D_tls) debug_printf("TLS: DH params were preloaded\n"); }
2728   else
2729     if (!init_dh(ctx, state->dhparam, errstr)) return DEFER;
2730
2731   if (state->lib_state.ecdh)
2732     { DEBUG(D_tls) debug_printf("TLS: ECDH curve was preloaded\n"); }
2733   else
2734     if (!init_ecdh(ctx, errstr)) return DEFER;
2735   }
2736
2737 /* Set up certificate and key (and perhaps OCSP info) */
2738
2739 if (state->lib_state.conn_certs)
2740   {
2741   DEBUG(D_tls)
2742     debug_printf("TLS: %s certs were preloaded\n", host ? "client":"server");
2743   }
2744 else
2745   {
2746 #ifndef DISABLE_OCSP
2747   if (!host)
2748     {
2749     state->u_ocsp.server.file = ocsp_file;
2750     state->u_ocsp.server.file_expanded = NULL;
2751     state->u_ocsp.server.olist = NULL;
2752     }
2753 #endif
2754   if ((rc = tls_expand_session_files(ctx, state, errstr)) != OK) return rc;
2755   }
2756
2757 /* If we need to handle SNI or OCSP, do so */
2758
2759 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
2760 # ifndef DISABLE_OCSP
2761   if (!(state->verify_stack = sk_X509_new_null()))
2762     {
2763     DEBUG(D_tls) debug_printf("failed to create stack for stapling verify\n");
2764     return FAIL;
2765     }
2766 # endif
2767
2768 if (!host)              /* server */
2769   {
2770 # ifndef DISABLE_OCSP
2771   /* We check u_ocsp.server.file, not server.olist, because we care about if
2772   the option exists, not what the current expansion might be, as SNI might
2773   change the certificate and OCSP file in use between now and the time the
2774   callback is invoked. */
2775   if (state->u_ocsp.server.file)
2776     {
2777     SSL_CTX_set_tlsext_status_cb(ctx, tls_server_stapling_cb);
2778     SSL_CTX_set_tlsext_status_arg(ctx, state);
2779     }
2780 # endif
2781   /* We always do this, so that $tls_sni is available even if not used in
2782   tls_certificate */
2783   SSL_CTX_set_tlsext_servername_callback(ctx, tls_servername_cb);
2784   SSL_CTX_set_tlsext_servername_arg(ctx, state);
2785
2786 # ifdef EXIM_HAVE_ALPN
2787   if (tls_alpn && *tls_alpn)
2788     {
2789     uschar * exp_alpn;
2790     if (  expand_check(tls_alpn, US"tls_alpn", &exp_alpn, errstr)
2791        && *exp_alpn && !isblank(*exp_alpn))
2792       {
2793       tls_alpn = exp_alpn;      /* subprocess so ok to overwrite */
2794       SSL_CTX_set_alpn_select_cb(ctx, tls_server_alpn_cb, state);
2795       }
2796     else
2797       tls_alpn = NULL;
2798     }
2799 # endif
2800   }
2801 # ifndef DISABLE_OCSP
2802 else                    /* client */
2803   if(ocsp_file)         /* wanting stapling */
2804     {
2805     if (!(state->u_ocsp.client.verify_store = X509_STORE_new()))
2806       {
2807       DEBUG(D_tls) debug_printf("failed to create store for stapling verify\n");
2808       return FAIL;
2809       }
2810     SSL_CTX_set_tlsext_status_cb(ctx, tls_client_stapling_cb);
2811     SSL_CTX_set_tlsext_status_arg(ctx, state);
2812     }
2813 # endif
2814 #endif
2815
2816 state->verify_cert_hostnames = NULL;
2817
2818 #ifdef EXIM_HAVE_EPHEM_RSA_KEX
2819 /* Set up the RSA callback */
2820 SSL_CTX_set_tmp_rsa_callback(ctx, rsa_callback);
2821 #endif
2822
2823 /* Finally, set the session cache timeout, and we are done.
2824 The period appears to be also used for (server-generated) session tickets */
2825
2826 SSL_CTX_set_timeout(ctx, ssl_session_timeout);
2827 DEBUG(D_tls) debug_printf("Initialized TLS\n");
2828
2829 *caller_state = state;
2830
2831 return OK;
2832 }
2833
2834
2835
2836
2837 /*************************************************
2838 *           Get name of cipher in use            *
2839 *************************************************/
2840
2841 /*
2842 Argument:   pointer to an SSL structure for the connection
2843             pointer to number of bits for cipher
2844 Returns:    pointer to allocated string in perm-pool
2845 */
2846
2847 static uschar *
2848 construct_cipher_name(SSL * ssl, const uschar * ver, int * bits)
2849 {
2850 int pool = store_pool;
2851 /* With OpenSSL 1.0.0a, 'c' needs to be const but the documentation doesn't
2852 yet reflect that.  It should be a safe change anyway, even 0.9.8 versions have
2853 the accessor functions use const in the prototype. */
2854
2855 const SSL_CIPHER * c = (const SSL_CIPHER *) SSL_get_current_cipher(ssl);
2856 uschar * s;
2857
2858 SSL_CIPHER_get_bits(c, bits);
2859
2860 store_pool = POOL_PERM;
2861 s = string_sprintf("%s:%s:%u", ver, SSL_CIPHER_get_name(c), *bits);
2862 store_pool = pool;
2863 DEBUG(D_tls) debug_printf("Cipher: %s\n", s);
2864 return s;
2865 }
2866
2867
2868 /* Get IETF-standard name for ciphersuite.
2869 Argument:   pointer to an SSL structure for the connection
2870 Returns:    pointer to string
2871 */
2872
2873 static const uschar *
2874 cipher_stdname_ssl(SSL * ssl)
2875 {
2876 #ifdef EXIM_HAVE_OPENSSL_CIPHER_STD_NAME
2877 return CUS SSL_CIPHER_standard_name(SSL_get_current_cipher(ssl));
2878 #else
2879 ushort id = 0xffff & SSL_CIPHER_get_id(SSL_get_current_cipher(ssl));
2880 return cipher_stdname(id >> 8, id & 0xff);
2881 #endif
2882 }
2883
2884
2885 static const uschar *
2886 tlsver_name(SSL * ssl)
2887 {
2888 uschar * s, * p;
2889 int pool = store_pool;
2890
2891 store_pool = POOL_PERM;
2892 s = string_copy(US SSL_get_version(ssl));
2893 store_pool = pool;
2894 if ((p = Ustrchr(s, 'v')))      /* TLSv1.2 -> TLS1.2 */
2895   for (;; p++) if (!(*p = p[1])) break;
2896 return CUS s;
2897 }
2898
2899
2900 static void
2901 peer_cert(SSL * ssl, tls_support * tlsp, uschar * peerdn, unsigned siz)
2902 {
2903 /*XXX we might consider a list-of-certs variable for the cert chain.
2904 SSL_get_peer_cert_chain(SSL*).  We'd need a new variable type and support
2905 in list-handling functions, also consider the difference between the entire
2906 chain and the elements sent by the peer. */
2907
2908 tlsp->peerdn = NULL;
2909
2910 /* Will have already noted peercert on a verify fail; possibly not the leaf */
2911 if (!tlsp->peercert)
2912   tlsp->peercert = SSL_get_peer_certificate(ssl);
2913 /* Beware anonymous ciphers which lead to server_cert being NULL */
2914 if (tlsp->peercert)
2915   if (!X509_NAME_oneline(X509_get_subject_name(tlsp->peercert), CS peerdn, siz))
2916     { DEBUG(D_tls) debug_printf("X509_NAME_oneline() error\n"); }
2917   else
2918     {
2919     int oldpool = store_pool;
2920
2921     peerdn[siz-1] = '\0';               /* paranoia */
2922     store_pool = POOL_PERM;
2923     tlsp->peerdn = string_copy(peerdn);
2924     store_pool = oldpool;
2925
2926     /* We used to set CV in the cert-verify callbacks (either plain or dane)
2927     but they don't get called on session-resumption.  So use the official
2928     interface, which uses the resumed value.  Unfortunately this claims verified
2929     when it actually failed but we're in try-verify mode, due to us wanting the
2930     knowlege that it failed so needing to have the callback and forcing a
2931     permissive return.  If we don't force it, the TLS startup is failed.
2932     The extra bit of information is set in verify_override in the cb, stashed
2933     for resumption next to the TLS session, and used here. */
2934
2935     if (!tlsp->verify_override)
2936       tlsp->certificate_verified =
2937 #ifdef SUPPORT_DANE
2938         tlsp->dane_verified ||
2939 #endif
2940         SSL_get_verify_result(ssl) == X509_V_OK;
2941     }
2942 }
2943
2944
2945
2946
2947
2948 /*************************************************
2949 *        Set up for verifying certificates       *
2950 *************************************************/
2951
2952 #ifndef DISABLE_OCSP
2953 /* Load certs from file, return TRUE on success */
2954
2955 static BOOL
2956 chain_from_pem_file(const uschar * file, STACK_OF(X509) ** vp)
2957 {
2958 BIO * bp;
2959 STACK_OF(X509) * verify_stack = *vp;
2960
2961 if (verify_stack)
2962   while (sk_X509_num(verify_stack) > 0)
2963     X509_free(sk_X509_pop(verify_stack));
2964 else
2965   verify_stack = sk_X509_new_null();
2966
2967 if (!(bp = BIO_new_file(CS file, "r"))) return FALSE;
2968 for (X509 * x; x = PEM_read_bio_X509(bp, NULL, 0, NULL); )
2969   sk_X509_push(verify_stack, x);
2970 BIO_free(bp);
2971 *vp = verify_stack;
2972 return TRUE;
2973 }
2974 #endif
2975
2976
2977
2978 /* Called by both client and server startup; on the server possibly
2979 repeated after a Server Name Indication.
2980
2981 Arguments:
2982   sctx          SSL_CTX* to initialise
2983   certs         certs file, expanded
2984   crl           CRL file or NULL
2985   host          NULL in a server; the remote host in a client
2986   errstr        error string pointer
2987
2988 Returns:        OK/DEFER/FAIL
2989 */
2990
2991 static int
2992 setup_certs(SSL_CTX *sctx, uschar *certs, uschar *crl, host_item *host,
2993     uschar ** errstr)
2994 {
2995 uschar *expcerts, *expcrl;
2996
2997 if (!expand_check(certs, US"tls_verify_certificates", &expcerts, errstr))
2998   return DEFER;
2999 DEBUG(D_tls) debug_printf("tls_verify_certificates: %s\n", expcerts);
3000
3001 if (expcerts && *expcerts)
3002   {
3003   /* Tell the library to use its compiled-in location for the system default
3004   CA bundle. Then add the ones specified in the config, if any. */
3005
3006   if (!SSL_CTX_set_default_verify_paths(sctx))
3007     return tls_error(US"SSL_CTX_set_default_verify_paths", host, NULL, errstr);
3008
3009   if (Ustrcmp(expcerts, "system") != 0 && Ustrncmp(expcerts, "system,", 7) != 0)
3010     {
3011     struct stat statbuf;
3012
3013     if (Ustat(expcerts, &statbuf) < 0)
3014       {
3015       log_write(0, LOG_MAIN|LOG_PANIC,
3016         "failed to stat %s for certificates", expcerts);
3017       return DEFER;
3018       }
3019     else
3020       {
3021       uschar *file, *dir;
3022       if ((statbuf.st_mode & S_IFMT) == S_IFDIR)
3023         { file = NULL; dir = expcerts; }
3024       else
3025         {
3026         STACK_OF(X509) * verify_stack =
3027 #ifndef DISABLE_OCSP
3028           !host ? state_server.verify_stack :
3029 #endif
3030           NULL;
3031         STACK_OF(X509) ** vp = &verify_stack;
3032
3033         file = expcerts; dir = NULL;
3034 #ifndef DISABLE_OCSP
3035         /* In the server if we will be offering an OCSP proof, load chain from
3036         file for verifying the OCSP proof at load time. */
3037
3038 /*XXX Glitch!   The file here is tls_verify_certs: the chain for verifying the client cert.
3039 This is inconsistent with the need to verify the OCSP proof of the server cert.
3040 */
3041         if (  !host
3042            && statbuf.st_size > 0
3043            && state_server.u_ocsp.server.file
3044            && !chain_from_pem_file(file, vp)
3045            )
3046           {
3047           log_write(0, LOG_MAIN|LOG_PANIC,
3048             "failed to load cert chain from %s", file);
3049           return DEFER;
3050           }
3051 #endif
3052         }
3053
3054       /* If a certificate file is empty, the load function fails with an
3055       unhelpful error message. If we skip it, we get the correct behaviour (no
3056       certificates are recognized, but the error message is still misleading (it
3057       says no certificate was supplied).  But this is better. */
3058
3059       if (  (!file || statbuf.st_size > 0)
3060          && !SSL_CTX_load_verify_locations(sctx, CS file, CS dir))
3061           return tls_error(US"SSL_CTX_load_verify_locations",
3062                             host, NULL, errstr);
3063
3064       /* On the server load the list of CAs for which we will accept certs, for
3065       sending to the client.  This is only for the one-file
3066       tls_verify_certificates variant.
3067       If a list isn't loaded into the server, but some verify locations are set,
3068       the server end appears to make a wildcard request for client certs.
3069       Meanwhile, the client library as default behaviour *ignores* the list
3070       we send over the wire - see man SSL_CTX_set_client_cert_cb.
3071       Because of this, and that the dir variant is likely only used for
3072       the public-CA bundle (not for a private CA), not worth fixing.  */
3073
3074       if (file)
3075         {
3076         STACK_OF(X509_NAME) * names = SSL_load_client_CA_file(CS file);
3077         int i = sk_X509_NAME_num(names);
3078
3079         if (!host) SSL_CTX_set_client_CA_list(sctx, names);
3080         DEBUG(D_tls) debug_printf("Added %d additional certificate authorit%s\n",
3081                                     i, i>1 ? "ies":"y");
3082         }
3083       else
3084         DEBUG(D_tls)
3085           debug_printf("Added dir for additional certificate authorities\n");
3086       }
3087     }
3088
3089   /* Handle a certificate revocation list. */
3090
3091 #if OPENSSL_VERSION_NUMBER > 0x00907000L
3092
3093   /* This bit of code is now the version supplied by Lars Mainka. (I have
3094   merely reformatted it into the Exim code style.)
3095
3096   "From here I changed the code to add support for multiple crl's
3097   in pem format in one file or to support hashed directory entries in
3098   pem format instead of a file. This method now uses the library function
3099   X509_STORE_load_locations to add the CRL location to the SSL context.
3100   OpenSSL will then handle the verify against CA certs and CRLs by
3101   itself in the verify callback." */
3102
3103   if (!expand_check(crl, US"tls_crl", &expcrl, errstr)) return DEFER;
3104   if (expcrl && *expcrl)
3105     {
3106     struct stat statbufcrl;
3107     if (Ustat(expcrl, &statbufcrl) < 0)
3108       {
3109       log_write(0, LOG_MAIN|LOG_PANIC,
3110         "failed to stat %s for certificates revocation lists", expcrl);
3111       return DEFER;
3112       }
3113     else
3114       {
3115       /* is it a file or directory? */
3116       uschar *file, *dir;
3117       X509_STORE *cvstore = SSL_CTX_get_cert_store(sctx);
3118       if ((statbufcrl.st_mode & S_IFMT) == S_IFDIR)
3119         {
3120         file = NULL;
3121         dir = expcrl;
3122         DEBUG(D_tls) debug_printf("SSL CRL value is a directory %s\n", dir);
3123         }
3124       else
3125         {
3126         file = expcrl;
3127         dir = NULL;
3128         DEBUG(D_tls) debug_printf("SSL CRL value is a file %s\n", file);
3129         }
3130       if (X509_STORE_load_locations(cvstore, CS file, CS dir) == 0)
3131         return tls_error(US"X509_STORE_load_locations", host, NULL, errstr);
3132
3133       /* setting the flags to check against the complete crl chain */
3134
3135       X509_STORE_set_flags(cvstore,
3136         X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
3137       }
3138     }
3139
3140 #endif  /* OPENSSL_VERSION_NUMBER > 0x00907000L */
3141   }
3142
3143 return OK;
3144 }
3145
3146
3147
3148 static void
3149 tls_dump_keylog(SSL * ssl)
3150 {
3151 #ifdef EXIM_HAVE_OPENSSL_KEYLOG
3152   BIO * bp = BIO_new(BIO_s_mem());
3153   uschar * s = NULL;
3154   int len;
3155   SSL_SESSION_print_keylog(bp, SSL_get_session(ssl));
3156   len = (int) BIO_get_mem_data(bp, CSS &s);
3157   if (len > 0) debug_printf("%.*s", len, s);
3158   BIO_free(bp);
3159 #endif
3160 }
3161
3162
3163 /*************************************************
3164 *       Start a TLS session in a server          *
3165 *************************************************/
3166 /* This is called when Exim is running as a server, after having received
3167 the STARTTLS command. It must respond to that command, and then negotiate
3168 a TLS session.
3169
3170 Arguments:
3171   errstr            pointer to error message
3172
3173 Returns:            OK on success
3174                     DEFER for errors before the start of the negotiation
3175                     FAIL for errors during the negotiation; the server can't
3176                       continue running.
3177 */
3178
3179 int
3180 tls_server_start(uschar ** errstr)
3181 {
3182 int rc;
3183 uschar * expciphers;
3184 exim_openssl_state_st * dummy_statep;
3185 SSL_CTX * ctx;
3186 SSL * ssl;
3187 static uschar peerdn[256];
3188
3189 /* Check for previous activation */
3190
3191 if (tls_in.active.sock >= 0)
3192   {
3193   tls_error(US"STARTTLS received after TLS started", NULL, US"", errstr);
3194   smtp_printf("554 Already in TLS\r\n", FALSE);
3195   return FAIL;
3196   }
3197
3198 /* Initialize the SSL library. If it fails, it will already have logged
3199 the error. */
3200
3201 rc = tls_init(NULL, NULL,
3202 #ifndef DISABLE_OCSP
3203     tls_ocsp_file,
3204 #endif
3205     NULL, &dummy_statep, &tls_in, errstr);
3206 if (rc != OK) return rc;
3207 ctx = state_server.lib_state.lib_ctx;
3208
3209 /* In OpenSSL, cipher components are separated by hyphens. In GnuTLS, they
3210 were historically separated by underscores. So that I can use either form in my
3211 tests, and also for general convenience, we turn underscores into hyphens here.
3212
3213 XXX SSL_CTX_set_cipher_list() is replaced by SSL_CTX_set_ciphersuites()
3214 for TLS 1.3 .  Since we do not call it at present we get the default list:
3215 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
3216 */
3217
3218 if (state_server.lib_state.pri_string)
3219   { DEBUG(D_tls) debug_printf("TLS: cipher list was preloaded\n"); }
3220 else
3221   {
3222   if (!expand_check(tls_require_ciphers, US"tls_require_ciphers", &expciphers, errstr))
3223     return FAIL;
3224
3225   if (expciphers)
3226     {
3227     normalise_ciphers(&expciphers, tls_require_ciphers);
3228     if ((rc = server_load_ciphers(ctx, &state_server, expciphers, errstr)) != OK)
3229       return rc;
3230     }
3231   }
3232
3233 /* If this is a host for which certificate verification is mandatory or
3234 optional, set up appropriately. */
3235
3236 tls_in.certificate_verified = FALSE;
3237 #ifdef SUPPORT_DANE
3238 tls_in.dane_verified = FALSE;
3239 #endif
3240 server_verify_callback_called = FALSE;
3241
3242 if (verify_check_host(&tls_verify_hosts) == OK)
3243   server_verify_optional = FALSE;
3244 else if (verify_check_host(&tls_try_verify_hosts) == OK)
3245   server_verify_optional = TRUE;
3246 else
3247   goto skip_certs;
3248
3249  {
3250   uschar * expcerts;
3251   if (!expand_check(tls_verify_certificates, US"tls_verify_certificates",
3252                     &expcerts, errstr))
3253     return DEFER;
3254   DEBUG(D_tls) debug_printf("tls_verify_certificates: %s\n", expcerts);
3255
3256   if (state_server.lib_state.cabundle)
3257     { DEBUG(D_tls) debug_printf("TLS: CA bundle for server was preloaded\n"); }
3258   else
3259     if ((rc = setup_certs(ctx, expcerts, tls_crl, NULL, errstr)) != OK)
3260       return rc;
3261
3262   if (expcerts && *expcerts)
3263     setup_cert_verify(ctx, server_verify_optional, verify_callback_server);
3264  }
3265 skip_certs: ;
3266
3267 #ifndef DISABLE_TLS_RESUME
3268 # if OPENSSL_VERSION_NUMBER < 0x30000000L
3269 SSL_CTX_set_tlsext_ticket_key_cb(ctx, ticket_key_callback);
3270 /* despite working, appears to always return failure, so ignoring */
3271 # else
3272 SSL_CTX_set_tlsext_ticket_key_evp_cb(ctx, ticket_key_callback);
3273 /* despite working, appears to always return failure, so ignoring */
3274 # endif
3275 #endif
3276
3277 #ifdef OPENSSL_HAVE_NUM_TICKETS
3278 # ifndef DISABLE_TLS_RESUME
3279 SSL_CTX_set_num_tickets(ctx, tls_in.host_resumable ? 1 : 0);
3280 # else
3281 SSL_CTX_set_num_tickets(ctx, 0);        /* send no TLS1.3 stateful-tickets */
3282 # endif
3283 #endif
3284
3285
3286 /* Prepare for new connection */
3287
3288 if (!(ssl = SSL_new(ctx)))
3289   return tls_error(US"SSL_new", NULL, NULL, errstr);
3290 state_server.lib_state.lib_ssl = ssl;
3291
3292 /* Warning: we used to SSL_clear(ssl) here, it was removed.
3293  *
3294  * With the SSL_clear(), we get strange interoperability bugs with
3295  * OpenSSL 1.0.1b and TLS1.1/1.2.  It looks as though this may be a bug in
3296  * OpenSSL itself, as a clear should not lead to inability to follow protocols.
3297  *
3298  * The SSL_clear() call is to let an existing SSL* be reused, typically after
3299  * session shutdown.  In this case, we have a brand new object and there's no
3300  * obvious reason to immediately clear it.  I'm guessing that this was
3301  * originally added because of incomplete initialisation which the clear fixed,
3302  * in some historic release.
3303  */
3304
3305 /* Set context and tell client to go ahead, except in the case of TLS startup
3306 on connection, where outputting anything now upsets the clients and tends to
3307 make them disconnect. We need to have an explicit fflush() here, to force out
3308 the response. Other smtp_printf() calls do not need it, because in non-TLS
3309 mode, the fflush() happens when smtp_getc() is called. */
3310
3311 SSL_set_session_id_context(ssl, sid_ctx, Ustrlen(sid_ctx));
3312 if (!tls_in.on_connect)
3313   {
3314   smtp_printf("220 TLS go ahead\r\n", FALSE);
3315   fflush(smtp_out);
3316   }
3317
3318 /* Now negotiate the TLS session. We put our own timer on it, since it seems
3319 that the OpenSSL library doesn't. */
3320
3321 SSL_set_wfd(ssl, fileno(smtp_out));
3322 SSL_set_rfd(ssl, fileno(smtp_in));
3323 SSL_set_accept_state(ssl);
3324
3325 DEBUG(D_tls) debug_printf("Calling SSL_accept\n");
3326
3327 ERR_clear_error();
3328 sigalrm_seen = FALSE;
3329 if (smtp_receive_timeout > 0) ALARM(smtp_receive_timeout);
3330 rc = SSL_accept(ssl);
3331 ALARM_CLR(0);
3332
3333 if (rc <= 0)
3334   {
3335   int error = SSL_get_error(ssl, rc);
3336   switch(error)
3337     {
3338     case SSL_ERROR_NONE:
3339       break;
3340
3341     case SSL_ERROR_ZERO_RETURN:
3342       DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
3343       (void) tls_error(US"SSL_accept", NULL, sigalrm_seen ? US"timed out" : NULL, errstr);
3344 #ifndef DISABLE_EVENT
3345       (void) event_raise(event_action, US"tls:fail:connect", *errstr, NULL);
3346 #endif
3347       if (SSL_get_shutdown(ssl) == SSL_RECEIVED_SHUTDOWN)
3348         SSL_shutdown(ssl);
3349
3350       tls_close(NULL, TLS_NO_SHUTDOWN);
3351       return FAIL;
3352
3353     /* Handle genuine errors */
3354     case SSL_ERROR_SSL:
3355       {
3356       uschar * s = NULL;
3357       int r = ERR_GET_REASON(ERR_peek_error());
3358       if (  r == SSL_R_WRONG_VERSION_NUMBER
3359 #ifdef SSL_R_VERSION_TOO_LOW
3360          || r == SSL_R_VERSION_TOO_LOW
3361 #endif
3362          || r == SSL_R_UNKNOWN_PROTOCOL || r == SSL_R_UNSUPPORTED_PROTOCOL)
3363         s = string_sprintf("(%s)", SSL_get_version(ssl));
3364       (void) tls_error(US"SSL_accept", NULL, sigalrm_seen ? US"timed out" : s, errstr);
3365 #ifndef DISABLE_EVENT
3366       (void) event_raise(event_action, US"tls:fail:connect", *errstr, NULL);
3367 #endif
3368       return FAIL;
3369       }
3370
3371     default:
3372       DEBUG(D_tls) debug_printf("Got SSL error %d\n", error);
3373       if (error == SSL_ERROR_SYSCALL)
3374         {
3375         if (!errno)
3376           {
3377           *errstr = US"SSL_accept: TCP connection closed by peer";
3378 #ifndef DISABLE_EVENT
3379           (void) event_raise(event_action, US"tls:fail:connect", *errstr, NULL);
3380 #endif
3381           return FAIL;
3382           }
3383         DEBUG(D_tls) debug_printf(" - syscall %s\n", strerror(errno));
3384         }
3385       (void) tls_error(US"SSL_accept", NULL,
3386                       sigalrm_seen ? US"timed out"
3387                       : ERR_peek_error() ? NULL : string_sprintf("ret %d", error),
3388                       errstr);
3389 #ifndef DISABLE_EVENT
3390       (void) event_raise(event_action, US"tls:fail:connect", *errstr, NULL);
3391 #endif
3392       return FAIL;
3393     }
3394   }
3395
3396 DEBUG(D_tls) debug_printf("SSL_accept was successful\n");
3397 ERR_clear_error();      /* Even success can leave errors in the stack. Seen with
3398                         anon-authentication ciphersuite negotiated. */
3399
3400 #ifndef DISABLE_TLS_RESUME
3401 if (SSL_session_reused(ssl))
3402   {
3403   tls_in.resumption |= RESUME_USED;
3404   DEBUG(D_tls) debug_printf("Session reused\n");
3405   }
3406 #endif
3407
3408 #ifdef EXIM_HAVE_ALPN
3409 /* If require-alpn, check server_seen_alpn here.  Else abort TLS */
3410 if (!tls_alpn || !*tls_alpn)
3411   { DEBUG(D_tls) debug_printf("TLS: was not watching for ALPN\n"); }
3412 else if (!server_seen_alpn)
3413   if (verify_check_host(&hosts_require_alpn) == OK)
3414     {
3415     /* We'd like to send a definitive Alert but OpenSSL provides no facility */
3416     SSL_shutdown(ssl);
3417     tls_error(US"handshake", NULL, US"ALPN required but not negotiated", errstr);
3418     return FAIL;
3419     }
3420   else
3421     { DEBUG(D_tls) debug_printf("TLS: no ALPN presented in handshake\n"); }
3422 else DEBUG(D_tls)
3423   {
3424   const uschar * name;
3425   unsigned len;
3426   SSL_get0_alpn_selected(ssl, &name, &len);
3427   if (len && name)
3428     debug_printf("ALPN negotiated: '%.*s'\n", (int)*name, name+1);
3429   else
3430     debug_printf("ALPN: no protocol negotiated\n");
3431   }
3432 #endif
3433
3434
3435 /* TLS has been set up. Record data for the connection,
3436 adjust the input functions to read via TLS, and initialize things. */
3437
3438 #ifdef SSL_get_extms_support
3439 tls_in.ext_master_secret = SSL_get_extms_support(ssl) == 1;
3440 #endif
3441 peer_cert(ssl, &tls_in, peerdn, sizeof(peerdn));
3442
3443 tls_in.ver = tlsver_name(ssl);
3444 tls_in.cipher = construct_cipher_name(ssl, tls_in.ver, &tls_in.bits);
3445 tls_in.cipher_stdname = cipher_stdname_ssl(ssl);
3446
3447 DEBUG(D_tls)
3448   {
3449   uschar buf[2048];
3450   if (SSL_get_shared_ciphers(ssl, CS buf, sizeof(buf)))
3451     debug_printf("Shared ciphers: %s\n", buf);
3452
3453   tls_dump_keylog(ssl);
3454
3455 #ifdef EXIM_HAVE_SESSION_TICKET
3456   {
3457   SSL_SESSION * ss = SSL_get_session(ssl);
3458   if (SSL_SESSION_has_ticket(ss))       /* 1.1.0 */
3459     debug_printf("The session has a ticket, life %lu seconds\n",
3460       SSL_SESSION_get_ticket_lifetime_hint(ss));
3461   }
3462 #endif
3463   }
3464
3465 /* Record the certificate we presented */
3466   {
3467   X509 * crt = SSL_get_certificate(ssl);
3468   tls_in.ourcert = crt ? X509_dup(crt) : NULL;
3469   }
3470
3471 /* Channel-binding info for authenticators
3472 See description in https://paquier.xyz/postgresql-2/channel-binding-openssl/ */
3473   {
3474   uschar c, * s;
3475   size_t len = SSL_get_peer_finished(ssl, &c, 0);
3476   int old_pool = store_pool;
3477
3478   SSL_get_peer_finished(ssl, s = store_get((int)len, GET_UNTAINTED), len);
3479   store_pool = POOL_PERM;
3480     tls_in.channelbinding = b64encode_taint(CUS s, (int)len, GET_UNTAINTED);
3481   store_pool = old_pool;
3482   DEBUG(D_tls) debug_printf("Have channel bindings cached for possible auth usage %p\n", tls_in.channelbinding);
3483   }
3484
3485 /* Only used by the server-side tls (tls_in), including tls_getc.
3486    Client-side (tls_out) reads (seem to?) go via
3487    smtp_read_response()/ip_recv().
3488    Hence no need to duplicate for _in and _out.
3489  */
3490 if (!ssl_xfer_buffer) ssl_xfer_buffer = store_malloc(ssl_xfer_buffer_size);
3491 ssl_xfer_buffer_lwm = ssl_xfer_buffer_hwm = 0;
3492 ssl_xfer_eof = ssl_xfer_error = FALSE;
3493
3494 receive_getc = tls_getc;
3495 receive_getbuf = tls_getbuf;
3496 receive_get_cache = tls_get_cache;
3497 receive_hasc = tls_hasc;
3498 receive_ungetc = tls_ungetc;
3499 receive_feof = tls_feof;
3500 receive_ferror = tls_ferror;
3501
3502 tls_in.active.sock = fileno(smtp_out);
3503 tls_in.active.tls_ctx = NULL;   /* not using explicit ctx for server-side */
3504 return OK;
3505 }
3506
3507
3508
3509
3510 static int
3511 tls_client_basic_ctx_init(SSL_CTX * ctx,
3512     host_item * host, smtp_transport_options_block * ob, exim_openssl_state_st * state,
3513     uschar ** errstr)
3514 {
3515 int rc;
3516
3517 /* Back-compatible old behaviour if tls_verify_certificates is set but both
3518 tls_verify_hosts and tls_try_verify_hosts are not set. Check only the specified
3519 host patterns if one of them is set with content. */
3520
3521 if (  (  (  !ob->tls_verify_hosts || !ob->tls_verify_hosts
3522          || Ustrcmp(ob->tls_try_verify_hosts, ":") == 0
3523          )
3524       && (  !ob->tls_try_verify_hosts || !*ob->tls_try_verify_hosts
3525          || Ustrcmp(ob->tls_try_verify_hosts, ":") == 0
3526          )
3527       )
3528    || verify_check_given_host(CUSS &ob->tls_verify_hosts, host) == OK
3529    )
3530   client_verify_optional = FALSE;
3531 else if (verify_check_given_host(CUSS &ob->tls_try_verify_hosts, host) == OK)
3532   client_verify_optional = TRUE;
3533 else
3534   return OK;
3535
3536  {
3537   uschar * expcerts;
3538   if (!expand_check(ob->tls_verify_certificates, US"tls_verify_certificates",
3539                     &expcerts, errstr))
3540     return DEFER;
3541   DEBUG(D_tls) debug_printf("tls_verify_certificates: %s\n", expcerts);
3542
3543   if (state->lib_state.cabundle)
3544     { DEBUG(D_tls) debug_printf("TLS: CA bundle was preloaded\n"); }
3545   else
3546     if ((rc = setup_certs(ctx, expcerts, ob->tls_crl, host, errstr)) != OK)
3547       return rc;
3548
3549   if (expcerts && *expcerts)
3550     setup_cert_verify(ctx, client_verify_optional, verify_callback_client);
3551  }
3552
3553 if (verify_check_given_host(CUSS &ob->tls_verify_cert_hostnames, host) == OK)
3554   {
3555   state->verify_cert_hostnames =
3556 #ifdef SUPPORT_I18N
3557     string_domain_utf8_to_alabel(host->certname, NULL);
3558 #else
3559     host->certname;
3560 #endif
3561   DEBUG(D_tls) debug_printf("Cert hostname to check: \"%s\"\n",
3562                     state->verify_cert_hostnames);
3563   }
3564 return OK;
3565 }
3566
3567
3568 #ifdef SUPPORT_DANE
3569 static int
3570 dane_tlsa_load(SSL * ssl, host_item * host, dns_answer * dnsa, uschar ** errstr)
3571 {
3572 dns_scan dnss;
3573 const char * hostnames[2] = { CS host->name, NULL };
3574 int found = 0;
3575
3576 if (DANESSL_init(ssl, NULL, hostnames) != 1)
3577   return tls_error(US"hostnames load", host, NULL, errstr);
3578
3579 for (dns_record * rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS); rr;
3580      rr = dns_next_rr(dnsa, &dnss, RESET_NEXT)
3581     ) if (rr->type == T_TLSA && rr->size > 3)
3582   {
3583   const uschar * p = rr->data;
3584   uint8_t usage, selector, mtype;
3585   const char * mdname;
3586
3587   usage = *p++;
3588
3589   /* Only DANE-TA(2) and DANE-EE(3) are supported */
3590   if (usage != 2 && usage != 3) continue;
3591
3592   selector = *p++;
3593   mtype = *p++;
3594
3595   switch (mtype)
3596     {
3597     default: continue;  /* Only match-types 0, 1, 2 are supported */
3598     case 0:  mdname = NULL; break;
3599     case 1:  mdname = "sha256"; break;
3600     case 2:  mdname = "sha512"; break;
3601     }
3602
3603   found++;
3604   switch (DANESSL_add_tlsa(ssl, usage, selector, mdname, p, rr->size - 3))
3605     {
3606     default:
3607       return tls_error(US"tlsa load", host, NULL, errstr);
3608     case 0:     /* action not taken */
3609     case 1:     break;
3610     }
3611
3612   tls_out.tlsa_usage |= 1<<usage;
3613   }
3614
3615 if (found)
3616   return OK;
3617
3618 log_write(0, LOG_MAIN, "DANE error: No usable TLSA records");
3619 return DEFER;
3620 }
3621 #endif  /*SUPPORT_DANE*/
3622
3623
3624
3625 #ifndef DISABLE_TLS_RESUME
3626 /* On the client, get any stashed session for the given IP from hints db
3627 and apply it to the ssl-connection for attempted resumption. */
3628
3629 static void
3630 tls_retrieve_session(tls_support * tlsp, SSL * ssl)
3631 {
3632 if (tlsp->host_resumable)
3633   {
3634   const uschar * key = tlsp->resume_index;
3635   dbdata_tls_session * dt;
3636   int len;
3637   open_db dbblock, * dbm_file;
3638
3639   tlsp->resumption |= RESUME_CLIENT_REQUESTED;
3640   DEBUG(D_tls)
3641     debug_printf("checking for resumable session for %s\n", tlsp->resume_index);
3642   if ((dbm_file = dbfn_open(US"tls", O_RDWR, &dbblock, FALSE, FALSE)))
3643     {
3644     if ((dt = dbfn_read_with_length(dbm_file, tlsp->resume_index, &len)))
3645       {
3646       SSL_SESSION * ss = NULL;
3647       const uschar * sess_asn1 = dt->session;
3648
3649       len -= sizeof(dbdata_tls_session);
3650       if (!(d2i_SSL_SESSION(&ss, &sess_asn1, (long)len)))
3651         {
3652         DEBUG(D_tls)
3653           {
3654           ERR_error_string_n(ERR_get_error(),
3655             ssl_errstring, sizeof(ssl_errstring));
3656           debug_printf("decoding session: %s\n", ssl_errstring);
3657           }
3658         }
3659       else
3660         {
3661         unsigned long lifetime =
3662 #ifdef EXIM_HAVE_SESSION_TICKET
3663           SSL_SESSION_get_ticket_lifetime_hint(ss);
3664 #else                   /* Use, fairly arbitrilarily, what we as server would */
3665           f.running_in_test_harness ? 6 : ssl_session_timeout;
3666 #endif
3667         if (lifetime + dt->time_stamp < time(NULL))
3668           {
3669           DEBUG(D_tls) debug_printf("session expired\n");
3670           dbfn_delete(dbm_file, tlsp->resume_index);
3671           }
3672         else if (SSL_set_session(ssl, ss))
3673           {
3674           DEBUG(D_tls) debug_printf("good session\n");
3675           tlsp->resumption |= RESUME_CLIENT_SUGGESTED;
3676           tlsp->verify_override = dt->verify_override;
3677           tlsp->ocsp = dt->ocsp;
3678           }
3679         else DEBUG(D_tls)
3680           {
3681           ERR_error_string_n(ERR_get_error(),
3682             ssl_errstring, sizeof(ssl_errstring));
3683           debug_printf("applying session to ssl: %s\n", ssl_errstring);
3684           }
3685         }
3686       }
3687     else
3688       DEBUG(D_tls) debug_printf("no session record\n");
3689     dbfn_close(dbm_file);
3690     }
3691   }
3692 }
3693
3694
3695 /* On the client, save the session for later resumption */
3696
3697 static int
3698 tls_save_session_cb(SSL * ssl, SSL_SESSION * ss)
3699 {
3700 exim_openssl_state_st * cbinfo = SSL_get_ex_data(ssl, tls_exdata_idx);
3701 tls_support * tlsp;
3702
3703 DEBUG(D_tls) debug_printf("tls_save_session_cb\n");
3704
3705 if (!cbinfo || !(tlsp = cbinfo->tlsp)->host_resumable) return 0;
3706
3707 # ifdef OPENSSL_HAVE_NUM_TICKETS
3708 if (SSL_SESSION_is_resumable(ss))       /* 1.1.1 */
3709 # endif
3710   {
3711   int len = i2d_SSL_SESSION(ss, NULL);
3712   int dlen = sizeof(dbdata_tls_session) + len;
3713   dbdata_tls_session * dt = store_get(dlen, GET_TAINTED);
3714   uschar * s = dt->session;
3715   open_db dbblock, * dbm_file;
3716
3717   DEBUG(D_tls) debug_printf("session is resumable\n");
3718   tlsp->resumption |= RESUME_SERVER_TICKET;     /* server gave us a ticket */
3719
3720   dt->verify_override = tlsp->verify_override;
3721   dt->ocsp = tlsp->ocsp;
3722   (void) i2d_SSL_SESSION(ss, &s);               /* s gets bumped to end */
3723
3724   if ((dbm_file = dbfn_open(US"tls", O_RDWR, &dbblock, FALSE, FALSE)))
3725     {
3726     dbfn_write(dbm_file, tlsp->resume_index, dt, dlen);
3727     dbfn_close(dbm_file);
3728     DEBUG(D_tls) debug_printf("wrote session (len %u) to db\n",
3729                   (unsigned)dlen);
3730     }
3731   }
3732 return 1;
3733 }
3734
3735
3736 /* Construct a key for session DB lookup, and setup the SSL_CTX for resumption */
3737
3738 static void
3739 tls_client_ctx_resume_prehandshake(
3740   exim_openssl_client_tls_ctx * exim_client_ctx, smtp_connect_args * conn_args,
3741   tls_support * tlsp, smtp_transport_options_block * ob)
3742 {
3743 tlsp->host_resumable = TRUE;
3744 tls_client_resmption_key(tlsp, conn_args, ob);
3745
3746 SSL_CTX_set_session_cache_mode(exim_client_ctx->ctx,
3747       SSL_SESS_CACHE_CLIENT
3748       | SSL_SESS_CACHE_NO_INTERNAL | SSL_SESS_CACHE_NO_AUTO_CLEAR);
3749 SSL_CTX_sess_set_new_cb(exim_client_ctx->ctx, tls_save_session_cb);
3750 }
3751
3752 static BOOL
3753 tls_client_ssl_resume_prehandshake(SSL * ssl, tls_support * tlsp,
3754   host_item * host, uschar ** errstr)
3755 {
3756 if (tlsp->host_resumable)
3757   {
3758   DEBUG(D_tls)
3759     debug_printf("tls_resumption_hosts overrides openssl_options, enabling tickets\n");
3760   SSL_clear_options(ssl, SSL_OP_NO_TICKET);
3761
3762   tls_exdata_idx = SSL_get_ex_new_index(0, 0, 0, 0, 0);
3763   if (!SSL_set_ex_data(ssl, tls_exdata_idx, client_static_state))
3764     {
3765     tls_error(US"set ex_data", host, NULL, errstr);
3766     return FALSE;
3767     }
3768   debug_printf("tls_exdata_idx %d cbinfo %p\n", tls_exdata_idx, client_static_state);
3769   }
3770
3771 tlsp->resumption = RESUME_SUPPORTED;
3772 /* Pick up a previous session, saved on an old ticket */
3773 tls_retrieve_session(tlsp, ssl);
3774 return TRUE;
3775 }
3776
3777 static void
3778 tls_client_resume_posthandshake(exim_openssl_client_tls_ctx * exim_client_ctx,
3779   tls_support * tlsp)
3780 {
3781 if (SSL_session_reused(exim_client_ctx->ssl))
3782   {
3783   DEBUG(D_tls) debug_printf("The session was reused\n");
3784   tlsp->resumption |= RESUME_USED;
3785   }
3786 }
3787 #endif  /* !DISABLE_TLS_RESUME */
3788
3789
3790 #ifdef EXIM_HAVE_ALPN
3791 /* Expand and convert an Exim list to an ALPN list.  False return for fail.
3792 NULL plist return for silent no-ALPN.
3793
3794 Overwite the passed-in list with the expanded version.
3795 */
3796
3797 static BOOL
3798 tls_alpn_plist(uschar ** tls_alpn, const uschar ** plist, unsigned * plen,
3799   uschar ** errstr)
3800 {
3801 uschar * exp_alpn;
3802
3803 if (!expand_check(*tls_alpn, US"tls_alpn", &exp_alpn, errstr))
3804   return FALSE;
3805 *tls_alpn = exp_alpn;
3806
3807 if (!exp_alpn)
3808   {
3809   DEBUG(D_tls) debug_printf("Setting TLS ALPN forced to fail, not sending\n");
3810   *plist = NULL;
3811   }
3812 else
3813   {
3814   /* The server implementation only accepts exactly one protocol name
3815   but it's little extra code complexity in the client. */
3816
3817   const uschar * list = exp_alpn;
3818   uschar * p = store_get(Ustrlen(exp_alpn), exp_alpn), * s, * t;
3819   int sep = 0;
3820   uschar len;
3821
3822   for (t = p; s = string_nextinlist(&list, &sep, NULL, 0); t += len)
3823     {
3824     *t++ = len = (uschar) Ustrlen(s);
3825     memcpy(t, s, len);
3826     }
3827   *plist = (*plen = t - p) ? p : NULL;
3828   }
3829 return TRUE;
3830 }
3831 #endif  /* EXIM_HAVE_ALPN */
3832
3833
3834 /*************************************************
3835 *    Start a TLS session in a client             *
3836 *************************************************/
3837
3838 /* Called from the smtp transport after STARTTLS has been accepted.
3839
3840 Arguments:
3841   cctx          connection context
3842   conn_args     connection details
3843   cookie        datum for randomness; can be NULL
3844   tlsp          record details of TLS channel configuration here; must be non-NULL
3845   errstr        error string pointer
3846
3847 Returns:        TRUE for success with TLS session context set in connection context,
3848                 FALSE on error
3849 */
3850
3851 BOOL
3852 tls_client_start(client_conn_ctx * cctx, smtp_connect_args * conn_args,
3853   void * cookie, tls_support * tlsp, uschar ** errstr)
3854 {
3855 host_item * host = conn_args->host;             /* for msgs and option-tests */
3856 transport_instance * tb = conn_args->tblock;    /* always smtp or NULL */
3857 smtp_transport_options_block * ob = tb
3858   ? (smtp_transport_options_block *)tb->options_block
3859   : &smtp_transport_option_defaults;
3860 exim_openssl_client_tls_ctx * exim_client_ctx;
3861 uschar * expciphers;
3862 int rc;
3863 static uschar peerdn[256];
3864
3865 #ifndef DISABLE_OCSP
3866 BOOL request_ocsp = FALSE;
3867 BOOL require_ocsp = FALSE;
3868 #endif
3869
3870 rc = store_pool;
3871 store_pool = POOL_PERM;
3872 exim_client_ctx = store_get(sizeof(exim_openssl_client_tls_ctx), GET_UNTAINTED);
3873 exim_client_ctx->corked = NULL;
3874 store_pool = rc;
3875
3876 #ifdef SUPPORT_DANE
3877 tlsp->tlsa_usage = 0;
3878 #endif
3879
3880 #ifndef DISABLE_OCSP
3881   {
3882 # ifdef SUPPORT_DANE
3883   /*XXX this should be moved to caller, to be common across gnutls/openssl */
3884   if (  conn_args->dane
3885      && ob->hosts_request_ocsp[0] == '*'
3886      && ob->hosts_request_ocsp[1] == '\0'
3887      )
3888     {
3889     /* Unchanged from default.  Use a safer one under DANE */
3890     request_ocsp = TRUE;
3891     ob->hosts_request_ocsp = US"${if or { {= {0}{$tls_out_tlsa_usage}} "
3892                                       "   {= {4}{$tls_out_tlsa_usage}} } "
3893                                  " {*}{}}";
3894     }
3895 # endif
3896
3897   if ((require_ocsp =
3898         verify_check_given_host(CUSS &ob->hosts_require_ocsp, host) == OK))
3899     request_ocsp = TRUE;
3900   else
3901 # ifdef SUPPORT_DANE
3902     if (!request_ocsp)
3903 # endif
3904       request_ocsp =
3905         verify_check_given_host(CUSS &ob->hosts_request_ocsp, host) == OK;
3906   }
3907 #endif
3908
3909 rc = tls_init(host, ob,
3910 #ifndef DISABLE_OCSP
3911     (void *)(long)request_ocsp,
3912 #endif
3913     cookie, &client_static_state, tlsp, errstr);
3914 if (rc != OK) return FALSE;
3915
3916 exim_client_ctx->ctx = client_static_state->lib_state.lib_ctx;
3917
3918 tlsp->certificate_verified = FALSE;
3919 client_verify_callback_called = FALSE;
3920
3921 expciphers = NULL;
3922 #ifdef SUPPORT_DANE
3923 if (conn_args->dane)
3924   {
3925   /* We fall back to tls_require_ciphers if unset, empty or forced failure, but
3926   other failures should be treated as problems. */
3927   if (ob->dane_require_tls_ciphers &&
3928       !expand_check(ob->dane_require_tls_ciphers, US"dane_require_tls_ciphers",
3929         &expciphers, errstr))
3930     return FALSE;
3931   if (expciphers && *expciphers == '\0')
3932     expciphers = NULL;
3933
3934   normalise_ciphers(&expciphers, ob->dane_require_tls_ciphers);
3935   }
3936 #endif
3937 if (!expciphers)
3938   {
3939   if (!expand_check(ob->tls_require_ciphers, US"tls_require_ciphers",
3940       &expciphers, errstr))
3941     return FALSE;
3942
3943   /* In OpenSSL, cipher components are separated by hyphens. In GnuTLS, they
3944   are separated by underscores. So that I can use either form in my tests, and
3945   also for general convenience, we turn underscores into hyphens here. */
3946
3947   normalise_ciphers(&expciphers, ob->tls_require_ciphers);
3948   }
3949
3950 if (expciphers)
3951   {
3952   DEBUG(D_tls) debug_printf("required ciphers: %s\n", expciphers);
3953   if (!SSL_CTX_set_cipher_list(exim_client_ctx->ctx, CS expciphers))
3954     {
3955     tls_error(US"SSL_CTX_set_cipher_list", host, NULL, errstr);
3956     return FALSE;
3957     }
3958   }
3959
3960 #ifdef SUPPORT_DANE
3961 if (conn_args->dane)
3962   {
3963   SSL_CTX_set_verify(exim_client_ctx->ctx,
3964     SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
3965     verify_callback_client_dane);
3966
3967   if (!DANESSL_library_init())
3968     {
3969     tls_error(US"library init", host, NULL, errstr);
3970     return FALSE;
3971     }
3972   if (DANESSL_CTX_init(exim_client_ctx->ctx) <= 0)
3973     {
3974     tls_error(US"context init", host, NULL, errstr);
3975     return FALSE;
3976     }
3977   }
3978 else
3979
3980 #endif
3981
3982 if (tls_client_basic_ctx_init(exim_client_ctx->ctx, host, ob,
3983       client_static_state, errstr) != OK)
3984   return FALSE;
3985
3986 if (ob->tls_sni)
3987   {
3988   if (!expand_check(ob->tls_sni, US"tls_sni", &tlsp->sni, errstr))
3989     return FALSE;
3990   if (!tlsp->sni)
3991     { DEBUG(D_tls) debug_printf("Setting TLS SNI forced to fail, not sending\n"); }
3992   else if (!Ustrlen(tlsp->sni))
3993     tlsp->sni = NULL;
3994   else
3995     {
3996 #ifndef EXIM_HAVE_OPENSSL_TLSEXT
3997     log_write(0, LOG_MAIN, "SNI unusable with this OpenSSL library version; ignoring \"%s\"\n",
3998           tlsp->sni);
3999     tlsp->sni = NULL;
4000 #endif
4001     }
4002   }
4003
4004 if (ob->tls_alpn)
4005 #ifdef EXIM_HAVE_ALPN
4006   {
4007   const uschar * plist;
4008   unsigned plen;
4009
4010   if (!tls_alpn_plist(&ob->tls_alpn, &plist, &plen, errstr))
4011     return FALSE;
4012   if (plist)
4013     if (SSL_CTX_set_alpn_protos(exim_client_ctx->ctx, plist, plen) != 0)
4014       {
4015       tls_error(US"alpn init", host, NULL, errstr);
4016       return FALSE;
4017       }
4018     else
4019       DEBUG(D_tls) debug_printf("Setting TLS ALPN '%s'\n", ob->tls_alpn);
4020   }
4021 #else
4022   log_write(0, LOG_MAIN, "ALPN unusable with this OpenSSL library version; ignoring \"%s\"\n",
4023           ob->tls_alpn);
4024 #endif
4025
4026 #ifndef DISABLE_TLS_RESUME
4027 if (continue_hostname)  /* no host_lbserver available for tls_client_resmption_key() */
4028                         /*XXX another cmdline arg possibly, but use will be very low */
4029   { DEBUG(D_tls) debug_printf("resumption not supported on continued-connection\n"); }
4030 else if (verify_check_given_host(CUSS &ob->tls_resumption_hosts, host) == OK)
4031   tls_client_ctx_resume_prehandshake(exim_client_ctx, conn_args, tlsp, ob);
4032 #endif
4033
4034
4035 if (!(exim_client_ctx->ssl = SSL_new(exim_client_ctx->ctx)))
4036   {
4037   tls_error(US"SSL_new", host, NULL, errstr);
4038   return FALSE;
4039   }
4040 SSL_set_session_id_context(exim_client_ctx->ssl, sid_ctx, Ustrlen(sid_ctx));
4041 SSL_set_fd(exim_client_ctx->ssl, cctx->sock);
4042 SSL_set_connect_state(exim_client_ctx->ssl);
4043
4044 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
4045 if (tlsp->sni)
4046   {
4047   DEBUG(D_tls) debug_printf("Setting TLS SNI \"%s\"\n", tlsp->sni);
4048   SSL_set_tlsext_host_name(exim_client_ctx->ssl, tlsp->sni);
4049   }
4050 #endif
4051
4052 #ifdef SUPPORT_DANE
4053 if (conn_args->dane)
4054   if (dane_tlsa_load(exim_client_ctx->ssl, host, &conn_args->tlsa_dnsa, errstr) != OK)
4055     return FALSE;
4056 #endif
4057
4058 #ifndef DISABLE_OCSP
4059 /* Request certificate status at connection-time.  If the server
4060 does OCSP stapling we will get the callback (set in tls_init()) */
4061 # ifdef SUPPORT_DANE
4062 if (request_ocsp)
4063   {
4064   const uschar * s;
4065   if (  ((s = ob->hosts_require_ocsp) && Ustrstr(s, US"tls_out_tlsa_usage"))
4066      || ((s = ob->hosts_request_ocsp) && Ustrstr(s, US"tls_out_tlsa_usage"))
4067      )
4068     {   /* Re-eval now $tls_out_tlsa_usage is populated.  If
4069         this means we avoid the OCSP request, we wasted the setup
4070         cost in tls_init(). */
4071     require_ocsp = verify_check_given_host(CUSS &ob->hosts_require_ocsp, host) == OK;
4072     request_ocsp = require_ocsp
4073       || verify_check_given_host(CUSS &ob->hosts_request_ocsp, host) == OK;
4074     }
4075   }
4076 # endif
4077
4078 if (request_ocsp)
4079   {
4080   SSL_set_tlsext_status_type(exim_client_ctx->ssl, TLSEXT_STATUSTYPE_ocsp);
4081   client_static_state->u_ocsp.client.verify_required = require_ocsp;
4082   tlsp->ocsp = OCSP_NOT_RESP;
4083   }
4084 #endif
4085
4086 #ifndef DISABLE_TLS_RESUME
4087 if (!tls_client_ssl_resume_prehandshake(exim_client_ctx->ssl, tlsp, host,
4088       errstr))
4089   return FALSE;
4090 #endif
4091
4092 #ifndef DISABLE_EVENT
4093 client_static_state->event_action = tb ? tb->event_action : NULL;
4094 #endif
4095
4096 /* There doesn't seem to be a built-in timeout on connection. */
4097
4098 DEBUG(D_tls) debug_printf("Calling SSL_connect\n");
4099 sigalrm_seen = FALSE;
4100 ALARM(ob->command_timeout);
4101 rc = SSL_connect(exim_client_ctx->ssl);
4102 ALARM_CLR(0);
4103
4104 #ifdef SUPPORT_DANE
4105 if (conn_args->dane)
4106   DANESSL_cleanup(exim_client_ctx->ssl);
4107 #endif
4108
4109 if (rc <= 0)
4110   {
4111   tls_error(US"SSL_connect", host, sigalrm_seen ? US"timed out" : NULL, errstr);
4112   return FALSE;
4113   }
4114
4115 DEBUG(D_tls)
4116   {
4117   debug_printf("SSL_connect succeeded\n");
4118   tls_dump_keylog(exim_client_ctx->ssl);
4119   }
4120
4121 #ifndef DISABLE_TLS_RESUME
4122 tls_client_resume_posthandshake(exim_client_ctx, tlsp);
4123 #endif
4124
4125 #ifdef EXIM_HAVE_ALPN
4126 if (ob->tls_alpn)       /* We requested. See what was negotiated. */
4127   {
4128   const uschar * name;
4129   unsigned len;
4130
4131   SSL_get0_alpn_selected(exim_client_ctx->ssl, &name, &len);
4132   if (len > 0)
4133     { DEBUG(D_tls) debug_printf("ALPN negotiated %u: '%.*s'\n", len, (int)*name, name+1); }
4134   else if (verify_check_given_host(CUSS &ob->hosts_require_alpn, host) == OK)
4135     {
4136     /* Would like to send a relevant fatal Alert, but OpenSSL has no API */
4137     tls_error(US"handshake", host, US"ALPN required but not negotiated", errstr);
4138     return FALSE;
4139     }
4140   }
4141 #endif
4142
4143 #ifdef SSL_get_extms_support
4144 tlsp->ext_master_secret = SSL_get_extms_support(exim_client_ctx->ssl) == 1;
4145 #endif
4146 peer_cert(exim_client_ctx->ssl, tlsp, peerdn, sizeof(peerdn));
4147
4148 tlsp->ver = tlsver_name(exim_client_ctx->ssl);
4149 tlsp->cipher = construct_cipher_name(exim_client_ctx->ssl, tlsp->ver, &tlsp->bits);
4150 tlsp->cipher_stdname = cipher_stdname_ssl(exim_client_ctx->ssl);
4151
4152 /* Record the certificate we presented */
4153   {
4154   X509 * crt = SSL_get_certificate(exim_client_ctx->ssl);
4155   tlsp->ourcert = crt ? X509_dup(crt) : NULL;
4156   }
4157
4158 /*XXX will this work with continued-TLS? */
4159 /* Channel-binding info for authenticators */
4160   {
4161   uschar c, * s;
4162   size_t len = SSL_get_finished(exim_client_ctx->ssl, &c, 0);
4163   int old_pool = store_pool;
4164
4165   SSL_get_finished(exim_client_ctx->ssl, s = store_get((int)len, GET_TAINTED), len);
4166   store_pool = POOL_PERM;
4167     tlsp->channelbinding = b64encode_taint(CUS s, (int)len, GET_TAINTED);
4168   store_pool = old_pool;
4169   DEBUG(D_tls) debug_printf("Have channel bindings cached for possible auth usage %p %p\n", tlsp->channelbinding, tlsp);
4170   }
4171
4172 tlsp->active.sock = cctx->sock;
4173 tlsp->active.tls_ctx = exim_client_ctx;
4174 cctx->tls_ctx = exim_client_ctx;
4175 return TRUE;
4176 }
4177
4178
4179
4180
4181
4182 static BOOL
4183 tls_refill(unsigned lim)
4184 {
4185 SSL * ssl = state_server.lib_state.lib_ssl;
4186 int error;
4187 int inbytes;
4188
4189 DEBUG(D_tls) debug_printf("Calling SSL_read(%p, %p, %u)\n", ssl,
4190   ssl_xfer_buffer, ssl_xfer_buffer_size);
4191
4192 ERR_clear_error();
4193 if (smtp_receive_timeout > 0) ALARM(smtp_receive_timeout);
4194 inbytes = SSL_read(ssl, CS ssl_xfer_buffer,
4195                   MIN(ssl_xfer_buffer_size, lim));
4196 error = SSL_get_error(ssl, inbytes);
4197 if (smtp_receive_timeout > 0) ALARM_CLR(0);
4198
4199 if (had_command_timeout)                /* set by signal handler */
4200   smtp_command_timeout_exit();          /* does not return */
4201 if (had_command_sigterm)
4202   smtp_command_sigterm_exit();
4203 if (had_data_timeout)
4204   smtp_data_timeout_exit();
4205 if (had_data_sigint)
4206   smtp_data_sigint_exit();
4207
4208 /* SSL_ERROR_ZERO_RETURN appears to mean that the SSL session has been
4209 closed down, not that the socket itself has been closed down. Revert to
4210 non-SSL handling. */
4211
4212 switch(error)
4213   {
4214   case SSL_ERROR_NONE:
4215     break;
4216
4217   case SSL_ERROR_ZERO_RETURN:
4218     DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
4219
4220     if (SSL_get_shutdown(ssl) == SSL_RECEIVED_SHUTDOWN)
4221           SSL_shutdown(ssl);
4222
4223     tls_close(NULL, TLS_NO_SHUTDOWN);
4224     return FALSE;
4225
4226   /* Handle genuine errors */
4227   case SSL_ERROR_SSL:
4228     ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
4229     log_write(0, LOG_MAIN, "TLS error (SSL_read): %s", ssl_errstring);
4230     ssl_xfer_error = TRUE;
4231     return FALSE;
4232
4233   default:
4234     DEBUG(D_tls) debug_printf("Got SSL error %d\n", error);
4235     DEBUG(D_tls) if (error == SSL_ERROR_SYSCALL)
4236       debug_printf(" - syscall %s\n", strerror(errno));
4237     ssl_xfer_error = TRUE;
4238     return FALSE;
4239   }
4240
4241 #ifndef DISABLE_DKIM
4242 dkim_exim_verify_feed(ssl_xfer_buffer, inbytes);
4243 #endif
4244 ssl_xfer_buffer_hwm = inbytes;
4245 ssl_xfer_buffer_lwm = 0;
4246 return TRUE;
4247 }
4248
4249
4250 /*************************************************
4251 *            TLS version of getc                 *
4252 *************************************************/
4253
4254 /* This gets the next byte from the TLS input buffer. If the buffer is empty,
4255 it refills the buffer via the SSL reading function.
4256
4257 Arguments:  lim         Maximum amount to read/buffer
4258 Returns:    the next character or EOF
4259
4260 Only used by the server-side TLS.
4261 */
4262
4263 int
4264 tls_getc(unsigned lim)
4265 {
4266 if (ssl_xfer_buffer_lwm >= ssl_xfer_buffer_hwm)
4267   if (!tls_refill(lim))
4268     return ssl_xfer_error ? EOF : smtp_getc(lim);
4269
4270 /* Something in the buffer; return next uschar */
4271
4272 return ssl_xfer_buffer[ssl_xfer_buffer_lwm++];
4273 }
4274
4275 BOOL
4276 tls_hasc(void)
4277 {
4278 return ssl_xfer_buffer_lwm < ssl_xfer_buffer_hwm;
4279 }
4280
4281 uschar *
4282 tls_getbuf(unsigned * len)
4283 {
4284 unsigned size;
4285 uschar * buf;
4286
4287 if (ssl_xfer_buffer_lwm >= ssl_xfer_buffer_hwm)
4288   if (!tls_refill(*len))
4289     {
4290     if (!ssl_xfer_error) return smtp_getbuf(len);
4291     *len = 0;
4292     return NULL;
4293     }
4294
4295 if ((size = ssl_xfer_buffer_hwm - ssl_xfer_buffer_lwm) > *len)
4296   size = *len;
4297 buf = &ssl_xfer_buffer[ssl_xfer_buffer_lwm];
4298 ssl_xfer_buffer_lwm += size;
4299 *len = size;
4300 return buf;
4301 }
4302
4303
4304 void
4305 tls_get_cache(unsigned lim)
4306 {
4307 #ifndef DISABLE_DKIM
4308 int n = ssl_xfer_buffer_hwm - ssl_xfer_buffer_lwm;
4309 debug_printf("tls_get_cache\n");
4310 if (n > lim)
4311   n = lim;
4312 if (n > 0)
4313   dkim_exim_verify_feed(ssl_xfer_buffer+ssl_xfer_buffer_lwm, n);
4314 #endif
4315 }
4316
4317
4318 BOOL
4319 tls_could_getc(void)
4320 {
4321 return ssl_xfer_buffer_lwm < ssl_xfer_buffer_hwm
4322     || SSL_pending(state_server.lib_state.lib_ssl) > 0;
4323 }
4324
4325
4326 /*************************************************
4327 *          Read bytes from TLS channel           *
4328 *************************************************/
4329
4330 /*
4331 Arguments:
4332   ct_ctx    client context pointer, or NULL for the one global server context
4333   buff      buffer of data
4334   len       size of buffer
4335
4336 Returns:    the number of bytes read
4337             -1 after a failed read, including EOF
4338
4339 Only used by the client-side TLS.
4340 */
4341
4342 int
4343 tls_read(void * ct_ctx, uschar *buff, size_t len)
4344 {
4345 SSL * ssl = ct_ctx ? ((exim_openssl_client_tls_ctx *)ct_ctx)->ssl
4346                   : state_server.lib_state.lib_ssl;
4347 int inbytes;
4348 int error;
4349
4350 DEBUG(D_tls) debug_printf("Calling SSL_read(%p, %p, %u)\n", ssl,
4351   buff, (unsigned int)len);
4352
4353 ERR_clear_error();
4354 inbytes = SSL_read(ssl, CS buff, len);
4355 error = SSL_get_error(ssl, inbytes);
4356
4357 if (error == SSL_ERROR_ZERO_RETURN)
4358   {
4359   DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
4360   return -1;
4361   }
4362 else if (error != SSL_ERROR_NONE)
4363   return -1;
4364
4365 return inbytes;
4366 }
4367
4368
4369
4370
4371
4372 /*************************************************
4373 *         Write bytes down TLS channel           *
4374 *************************************************/
4375
4376 /*
4377 Arguments:
4378   ct_ctx    client context pointer, or NULL for the one global server context
4379   buff      buffer of data
4380   len       number of bytes
4381   more      further data expected soon
4382
4383 Returns:    the number of bytes after a successful write,
4384             -1 after a failed write
4385
4386 Used by both server-side and client-side TLS.  Calling with len zero and more unset
4387 will flush buffered writes; buff can be null for this case.
4388 */
4389
4390 int
4391 tls_write(void * ct_ctx, const uschar * buff, size_t len, BOOL more)
4392 {
4393 size_t olen = len;
4394 int outbytes, error;
4395 SSL * ssl = ct_ctx
4396   ? ((exim_openssl_client_tls_ctx *)ct_ctx)->ssl
4397   : state_server.lib_state.lib_ssl;
4398 static gstring * server_corked = NULL;
4399 gstring ** corkedp = ct_ctx
4400   ? &((exim_openssl_client_tls_ctx *)ct_ctx)->corked : &server_corked;
4401 gstring * corked = *corkedp;
4402
4403 DEBUG(D_tls) debug_printf("%s(%p, %lu%s)\n", __FUNCTION__,
4404   buff, (unsigned long)len, more ? ", more" : "");
4405
4406 /* Lacking a CORK or MSG_MORE facility (such as GnuTLS has) we copy data when
4407 "more" is notified.  This hack is only ok if small amounts are involved AND only
4408 one stream does it, in one context (i.e. no store reset).  Currently it is used
4409 for the responses to the received SMTP MAIL , RCPT, DATA sequence, only.
4410 We support callouts done by the server process by using a separate client
4411 context for the stashed information. */
4412 /* + if PIPE_COMMAND, banner & ehlo-resp for smmtp-on-connect. Suspect there's
4413 a store reset there, so use POOL_PERM. */
4414 /* + if CHUNKING, cmds EHLO,MAIL,RCPT(s),BDAT */
4415
4416 if (more || corked)
4417   {
4418   if (!len) buff = US &error;   /* dummy just so that string_catn is ok */
4419
4420   int save_pool = store_pool;
4421   store_pool = POOL_PERM;
4422
4423   corked = string_catn(corked, buff, len);
4424
4425   store_pool = save_pool;
4426
4427   if (more)
4428     {
4429     *corkedp = corked;
4430     return len;
4431     }
4432   buff = CUS corked->s;
4433   len = corked->ptr;
4434   *corkedp = NULL;
4435   }
4436
4437 for (int left = len; left > 0;)
4438   {
4439   DEBUG(D_tls) debug_printf("SSL_write(%p, %p, %d)\n", ssl, buff, left);
4440   ERR_clear_error();
4441   outbytes = SSL_write(ssl, CS buff, left);
4442   error = SSL_get_error(ssl, outbytes);
4443   DEBUG(D_tls) debug_printf("outbytes=%d error=%d\n", outbytes, error);
4444   switch (error)
4445     {
4446     case SSL_ERROR_NONE:        /* the usual case */
4447       left -= outbytes;
4448       buff += outbytes;
4449       break;
4450
4451     case SSL_ERROR_SSL:
4452       ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
4453       log_write(0, LOG_MAIN, "TLS error (SSL_write): %s", ssl_errstring);
4454       return -1;
4455
4456     case SSL_ERROR_ZERO_RETURN:
4457       log_write(0, LOG_MAIN, "SSL channel closed on write");
4458       return -1;
4459
4460     case SSL_ERROR_SYSCALL:
4461       if (ct_ctx || errno != ECONNRESET || !f.smtp_in_quit)
4462         log_write(0, LOG_MAIN, "SSL_write: (from %s) syscall: %s",
4463           sender_fullhost ? sender_fullhost : US"<unknown>",
4464           strerror(errno));
4465       else if (LOGGING(protocol_detail))
4466         log_write(0, LOG_MAIN, "[%s] after QUIT, client reset TCP before"
4467           " SMTP response and TLS close\n", sender_host_address);
4468       else
4469         DEBUG(D_tls) debug_printf("[%s] SSL_write: after QUIT,"
4470           " client reset TCP before TLS close\n", sender_host_address);
4471       return -1;
4472
4473     default:
4474       log_write(0, LOG_MAIN, "SSL_write error %d", error);
4475       return -1;
4476     }
4477   }
4478 return olen;
4479 }
4480
4481
4482
4483 /*
4484 Arguments:
4485   ct_ctx        client TLS context pointer, or NULL for the one global server context
4486 */
4487
4488 void
4489 tls_shutdown_wr(void * ct_ctx)
4490 {
4491 exim_openssl_client_tls_ctx * o_ctx = ct_ctx;
4492 SSL ** sslp = o_ctx ? &o_ctx->ssl : (SSL **) &state_server.lib_state.lib_ssl;
4493 int * fdp = o_ctx ? &tls_out.active.sock : &tls_in.active.sock;
4494 int rc;
4495
4496 if (*fdp < 0) return;  /* TLS was not active */
4497
4498 tls_write(ct_ctx, NULL, 0, FALSE);      /* flush write buffer */
4499
4500 HDEBUG(D_transport|D_tls|D_acl|D_v) debug_printf_indent("  SMTP(TLS shutdown)>>\n");
4501 rc = SSL_shutdown(*sslp);
4502 if (rc < 0) DEBUG(D_tls)
4503   {
4504   ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
4505   debug_printf("SSL_shutdown: %s\n", ssl_errstring);
4506   }
4507 }
4508
4509 /*************************************************
4510 *         Close down a TLS session               *
4511 *************************************************/
4512
4513 /* This is also called from within a delivery subprocess forked from the
4514 daemon, to shut down the TLS library, without actually doing a shutdown (which
4515 would tamper with the SSL session in the parent process).
4516
4517 Arguments:
4518   ct_ctx        client TLS context pointer, or NULL for the one global server context
4519   do_shutdown   0 no data-flush or TLS close-alert
4520                 1 if TLS close-alert is to be sent,
4521                 2 if also response to be waited for
4522
4523 Returns:     nothing
4524
4525 Used by both server-side and client-side TLS.
4526 */
4527
4528 void
4529 tls_close(void * ct_ctx, int do_shutdown)
4530 {
4531 exim_openssl_client_tls_ctx * o_ctx = ct_ctx;
4532 SSL ** sslp = o_ctx ? &o_ctx->ssl : (SSL **) &state_server.lib_state.lib_ssl;
4533 int * fdp = o_ctx ? &tls_out.active.sock : &tls_in.active.sock;
4534
4535 if (*fdp < 0) return;  /* TLS was not active */
4536
4537 if (do_shutdown > TLS_NO_SHUTDOWN)
4538   {
4539   int rc;
4540   DEBUG(D_tls) debug_printf("tls_close(): shutting down TLS%s\n",
4541     do_shutdown > TLS_SHUTDOWN_NOWAIT ? " (with response-wait)" : "");
4542
4543   tls_write(ct_ctx, NULL, 0, FALSE);    /* flush write buffer */
4544
4545   if (  (  do_shutdown >= TLS_SHUTDOWN_WONLY
4546         || (rc = SSL_shutdown(*sslp)) == 0      /* send "close notify" alert */
4547         )
4548      && do_shutdown > TLS_SHUTDOWN_NOWAIT
4549      )
4550     {
4551 #ifdef EXIM_TCP_CORK
4552     (void) setsockopt(*fdp, IPPROTO_TCP, EXIM_TCP_CORK, US &off, sizeof(off));
4553 #endif
4554     ALARM(2);
4555     rc = SSL_shutdown(*sslp);                   /* wait for response */
4556     ALARM_CLR(0);
4557     }
4558
4559   if (rc < 0) DEBUG(D_tls)
4560     {
4561     ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
4562     debug_printf("SSL_shutdown: %s\n", ssl_errstring);
4563     }
4564   }
4565
4566 if (!o_ctx)             /* server side */
4567   {
4568 #ifndef DISABLE_OCSP
4569   sk_X509_pop_free(state_server.verify_stack, X509_free);
4570   state_server.verify_stack = NULL;
4571 #endif
4572
4573   receive_getc =        smtp_getc;
4574   receive_getbuf =      smtp_getbuf;
4575   receive_get_cache =   smtp_get_cache;
4576   receive_hasc =        smtp_hasc;
4577   receive_ungetc =      smtp_ungetc;
4578   receive_feof =        smtp_feof;
4579   receive_ferror =      smtp_ferror;
4580   tls_in.active.tls_ctx = NULL;
4581   tls_in.sni = NULL;
4582   /* Leave bits, peercert, cipher, peerdn, certificate_verified set, for logging */
4583   }
4584
4585 SSL_free(*sslp);
4586 *sslp = NULL;
4587 *fdp = -1;
4588 }
4589
4590
4591
4592
4593 /*************************************************
4594 *  Let tls_require_ciphers be checked at startup *
4595 *************************************************/
4596
4597 /* The tls_require_ciphers option, if set, must be something which the
4598 library can parse.
4599
4600 Returns:     NULL on success, or error message
4601 */
4602
4603 uschar *
4604 tls_validate_require_cipher(void)
4605 {
4606 SSL_CTX * ctx;
4607 uschar * expciphers, * err;
4608
4609 tls_openssl_init();
4610
4611 if (!(tls_require_ciphers && *tls_require_ciphers))
4612   return NULL;
4613
4614 if (!expand_check(tls_require_ciphers, US"tls_require_ciphers", &expciphers,
4615                   &err))
4616   return US"failed to expand tls_require_ciphers";
4617
4618 if (!(expciphers && *expciphers))
4619   return NULL;
4620
4621 normalise_ciphers(&expciphers, tls_require_ciphers);
4622
4623 err = NULL;
4624 if (lib_ctx_new(&ctx, NULL, &err) == OK)
4625   {
4626   DEBUG(D_tls)
4627     debug_printf("tls_require_ciphers expands to \"%s\"\n", expciphers);
4628
4629   if (!SSL_CTX_set_cipher_list(ctx, CS expciphers))
4630     {
4631     ERR_error_string_n(ERR_get_error(), ssl_errstring, sizeof(ssl_errstring));
4632     err = string_sprintf("SSL_CTX_set_cipher_list(%s) failed: %s",
4633                         expciphers, ssl_errstring);
4634     }
4635
4636   SSL_CTX_free(ctx);
4637   }
4638 return err;
4639 }
4640
4641
4642
4643
4644 /*************************************************
4645 *         Report the library versions.           *
4646 *************************************************/
4647
4648 /* There have historically been some issues with binary compatibility in
4649 OpenSSL libraries; if Exim (like many other applications) is built against
4650 one version of OpenSSL but the run-time linker picks up another version,
4651 it can result in serious failures, including crashing with a SIGSEGV.  So
4652 report the version found by the compiler and the run-time version.
4653
4654 Note: some OS vendors backport security fixes without changing the version
4655 number/string, and the version date remains unchanged.  The _build_ date
4656 will change, so we can more usefully assist with version diagnosis by also
4657 reporting the build date.
4658
4659 Arguments:   string to append to
4660 Returns:     string
4661 */
4662
4663 gstring *
4664 tls_version_report(gstring * g)
4665 {
4666 return string_fmt_append(g,
4667     "Library version: OpenSSL: Compile: %s\n"
4668     "                          Runtime: %s\n"
4669     "                                 : %s\n",
4670              OPENSSL_VERSION_TEXT,
4671              SSLeay_version(SSLEAY_VERSION),
4672              SSLeay_version(SSLEAY_BUILT_ON));
4673   /* third line is 38 characters for the %s and the line is 73 chars long;
4674   the OpenSSL output includes a "built on: " prefix already. */
4675 }
4676
4677
4678
4679
4680 /*************************************************
4681 *            Random number generation            *
4682 *************************************************/
4683
4684 /* Pseudo-random number generation.  The result is not expected to be
4685 cryptographically strong but not so weak that someone will shoot themselves
4686 in the foot using it as a nonce in input in some email header scheme or
4687 whatever weirdness they'll twist this into.  The result should handle fork()
4688 and avoid repeating sequences.  OpenSSL handles that for us.
4689
4690 Arguments:
4691   max       range maximum
4692 Returns     a random number in range [0, max-1]
4693 */
4694
4695 int
4696 vaguely_random_number(int max)
4697 {
4698 unsigned int r;
4699 int i, needed_len;
4700 static pid_t pidlast = 0;
4701 pid_t pidnow;
4702 uschar smallbuf[sizeof(r)];
4703
4704 if (max <= 1)
4705   return 0;
4706
4707 pidnow = getpid();
4708 if (pidnow != pidlast)
4709   {
4710   /* Although OpenSSL documents that "OpenSSL makes sure that the PRNG state
4711   is unique for each thread", this doesn't apparently apply across processes,
4712   so our own warning from vaguely_random_number_fallback() applies here too.
4713   Fix per PostgreSQL. */
4714   if (pidlast != 0)
4715     RAND_cleanup();
4716   pidlast = pidnow;
4717   }
4718
4719 /* OpenSSL auto-seeds from /dev/random, etc, but this a double-check. */
4720 if (!RAND_status())
4721   {
4722   randstuff r;
4723   gettimeofday(&r.tv, NULL);
4724   r.p = getpid();
4725
4726   RAND_seed(US (&r), sizeof(r));
4727   }
4728 /* We're after pseudo-random, not random; if we still don't have enough data
4729 in the internal PRNG then our options are limited.  We could sleep and hope
4730 for entropy to come along (prayer technique) but if the system is so depleted
4731 in the first place then something is likely to just keep taking it.  Instead,
4732 we'll just take whatever little bit of pseudo-random we can still manage to
4733 get. */
4734
4735 needed_len = sizeof(r);
4736 /* Don't take 8 times more entropy than needed if int is 8 octets and we were
4737 asked for a number less than 10. */
4738 for (r = max, i = 0; r; ++i)
4739   r >>= 1;
4740 i = (i + 7) / 8;
4741 if (i < needed_len)
4742   needed_len = i;
4743
4744 #ifdef EXIM_HAVE_RAND_PSEUDO
4745 /* We do not care if crypto-strong */
4746 i = RAND_pseudo_bytes(smallbuf, needed_len);
4747 #else
4748 i = RAND_bytes(smallbuf, needed_len);
4749 #endif
4750
4751 if (i < 0)
4752   {
4753   DEBUG(D_all)
4754     debug_printf("OpenSSL RAND_pseudo_bytes() not supported by RAND method, using fallback.\n");
4755   return vaguely_random_number_fallback(max);
4756   }
4757
4758 r = 0;
4759 for (uschar * p = smallbuf; needed_len; --needed_len, ++p)
4760   r = 256 * r + *p;
4761
4762 /* We don't particularly care about weighted results; if someone wants
4763 smooth distribution and cares enough then they should submit a patch then. */
4764 return r % max;
4765 }
4766
4767
4768
4769
4770 /*************************************************
4771 *        OpenSSL option parse                    *
4772 *************************************************/
4773
4774 /* Parse one option for tls_openssl_options_parse below
4775
4776 Arguments:
4777   name    one option name
4778   value   place to store a value for it
4779 Returns   success or failure in parsing
4780 */
4781
4782
4783
4784 static BOOL
4785 tls_openssl_one_option_parse(uschar *name, long *value)
4786 {
4787 int first = 0;
4788 int last = exim_openssl_options_size;
4789 while (last > first)
4790   {
4791   int middle = (first + last)/2;
4792   int c = Ustrcmp(name, exim_openssl_options[middle].name);
4793   if (c == 0)
4794     {
4795     *value = exim_openssl_options[middle].value;
4796     return TRUE;
4797     }
4798   else if (c > 0)
4799     first = middle + 1;
4800   else
4801     last = middle;
4802   }
4803 return FALSE;
4804 }
4805
4806
4807
4808
4809 /*************************************************
4810 *        OpenSSL option parsing logic            *
4811 *************************************************/
4812
4813 /* OpenSSL has a number of compatibility options which an administrator might
4814 reasonably wish to set.  Interpret a list similarly to decode_bits(), so that
4815 we look like log_selector.
4816
4817 Arguments:
4818   option_spec  the administrator-supplied string of options
4819   results      ptr to long storage for the options bitmap
4820 Returns        success or failure
4821 */
4822
4823 BOOL
4824 tls_openssl_options_parse(uschar *option_spec, long *results)
4825 {
4826 long result, item;
4827 uschar * exp, * end;
4828 BOOL adding, item_parsed;
4829
4830 /* Server: send no (<= TLS1.2) session tickets */
4831 result = SSL_OP_NO_TICKET;
4832
4833 /* Prior to 4.80 we or'd in SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS; removed
4834 from default because it increases BEAST susceptibility. */
4835 #ifdef SSL_OP_NO_SSLv2
4836 result |= SSL_OP_NO_SSLv2;
4837 #endif
4838 #ifdef SSL_OP_NO_SSLv3
4839 result |= SSL_OP_NO_SSLv3;
4840 #endif
4841 #ifdef SSL_OP_SINGLE_DH_USE
4842 result |= SSL_OP_SINGLE_DH_USE;
4843 #endif
4844 #ifdef SSL_OP_NO_RENEGOTIATION
4845 result |= SSL_OP_NO_RENEGOTIATION;
4846 #endif
4847
4848 if (!option_spec)
4849   {
4850   *results = result;
4851   return TRUE;
4852   }
4853
4854 if (!expand_check(option_spec, US"openssl_options", &exp, &end))
4855   return FALSE;
4856
4857 for (uschar * s = exp; *s; /**/)
4858   {
4859   while (isspace(*s)) ++s;
4860   if (*s == '\0')
4861     break;
4862   if (*s != '+' && *s != '-')
4863     {
4864     DEBUG(D_tls) debug_printf("malformed openssl option setting: "
4865         "+ or - expected but found \"%s\"\n", s);
4866     return FALSE;
4867     }
4868   adding = *s++ == '+';
4869   for (end = s; *end && !isspace(*end); ) end++;
4870   item_parsed = tls_openssl_one_option_parse(string_copyn(s, end-s), &item);
4871   if (!item_parsed)
4872     {
4873     DEBUG(D_tls) debug_printf("openssl option setting unrecognised: \"%s\"\n", s);
4874     return FALSE;
4875     }
4876   DEBUG(D_tls) debug_printf("openssl option, %s %08lx: %08lx (%s)\n",
4877       adding ? "adding to    " : "removing from", result, item, s);
4878   if (adding)
4879     result |= item;
4880   else
4881     result &= ~item;
4882   s = end;
4883   }
4884
4885 *results = result;
4886 return TRUE;
4887 }
4888
4889 #endif  /*!MACRO_PREDEF*/
4890 /* vi: aw ai sw=2
4891 */
4892 /* End of tls-openssl.c */