src/src/tls-openssl.c

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