src/src/tls-openssl.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2015 */
   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 EXPERIMENTAL_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
  45 /*
  46  * X509_check_host provides sane certificate hostname checking, but was added
  47  * to OpenSSL late, after other projects forked off the code-base.  So in
  48  * addition to guarding against the base version number, beware that LibreSSL
  49  * does not (at this time) support this function.
  50  *
  51  * If LibreSSL gains a different API, perhaps via libtls, then we'll probably
  52  * opt to disentangle and ask a LibreSSL user to provide glue for a third
  53  * crypto provider for libtls instead of continuing to tie the OpenSSL glue
  54  * into even twistier knots.  If LibreSSL gains the same API, we can just
  55  * change this guard and punt the issue for a while longer.
  56  */
  57 #ifndef LIBRESSL_VERSION_NUMBER
  58 # if OPENSSL_VERSION_NUMBER >= 0x010100000L
  59 #  define EXIM_HAVE_OPENSSL_CHECKHOST
  60 # endif
  61 # if OPENSSL_VERSION_NUMBER >= 0x010000000L \
  62     && (OPENSSL_VERSION_NUMBER & 0x0000ff000L) >= 0x000002000L
  63 #  define EXIM_HAVE_OPENSSL_CHECKHOST
  64 # endif
  65
  66 # if !defined(OPENSSL_NO_ECDH)
  67 #  if OPENSSL_VERSION_NUMBER >= 0x0090800fL
  68 #   define EXIM_HAVE_ECDH
  69 #  endif
  70 #  if OPENSSL_VERSION_NUMBER >= 0x10002000L
  71 #   define EXIM_HAVE_OPENSSL_ECDH_AUTO
  72 #   define EXIM_HAVE_OPENSSL_EC_NIST2NID
  73 #  endif
  74 # endif
  75 #endif
  76
  77 #if !defined(EXIM_HAVE_OPENSSL_TLSEXT) && !defined(DISABLE_OCSP)
  78 # warning "OpenSSL library version too old; define DISABLE_OCSP in Makefile"
  79 # define DISABLE_OCSP
  80 #endif
  81
  82 /* Structure for collecting random data for seeding. */
  83
  84 typedef struct randstuff {
  85   struct timeval tv;
  86   pid_t          p;
  87 } randstuff;
  88
  89 /* Local static variables */
  90
  91 static BOOL client_verify_callback_called = FALSE;
  92 static BOOL server_verify_callback_called = FALSE;
  93 static const uschar *sid_ctx = US"exim";
  94
  95 /* We have three different contexts to care about.
  96
  97 Simple case: client, `client_ctx`
  98  As a client, we can be doing a callout or cut-through delivery while receiving
  99  a message.  So we have a client context, which should have options initialised
 100  from the SMTP Transport.
 101
 102 Server:
 103  There are two cases: with and without ServerNameIndication from the client.
 104  Given TLS SNI, we can be using different keys, certs and various other
 105  configuration settings, because they're re-expanded with $tls_sni set.  This
 106  allows vhosting with TLS.  This SNI is sent in the handshake.
 107  A client might not send SNI, so we need a fallback, and an initial setup too.
 108  So as a server, we start out using `server_ctx`.
 109  If SNI is sent by the client, then we as server, mid-negotiation, try to clone
 110  `server_sni` from `server_ctx` and then initialise settings by re-expanding
 111  configuration.
 112 */
 113
 114 static SSL_CTX *client_ctx = NULL;
 115 static SSL_CTX *server_ctx = NULL;
 116 static SSL     *client_ssl = NULL;
 117 static SSL     *server_ssl = NULL;
 118
 119 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
 120 static SSL_CTX *server_sni = NULL;
 121 #endif
 122
 123 static char ssl_errstring[256];
 124
 125 static int  ssl_session_timeout = 200;
 126 static BOOL client_verify_optional = FALSE;
 127 static BOOL server_verify_optional = FALSE;
 128
 129 static BOOL reexpand_tls_files_for_sni = FALSE;
 130
 131
 132 typedef struct tls_ext_ctx_cb {
 133   uschar *certificate;
 134   uschar *privatekey;
 135 #ifndef DISABLE_OCSP
 136   BOOL is_server;
 137   union {
 138     struct {
 139       uschar        *file;
 140       uschar        *file_expanded;
 141       OCSP_RESPONSE *response;
 142     } server;
 143     struct {
 144       X509_STORE    *verify_store;      /* non-null if status requested */
 145       BOOL          verify_required;
 146     } client;
 147   } u_ocsp;
 148 #endif
 149   uschar *dhparam;
 150   /* these are cached from first expand */
 151   uschar *server_cipher_list;
 152   /* only passed down to tls_error: */
 153   host_item *host;
 154   const uschar * verify_cert_hostnames;
 155 #ifndef DISABLE_EVENT
 156   uschar * event_action;
 157 #endif
 158 } tls_ext_ctx_cb;
 159
 160 /* should figure out a cleanup of API to handle state preserved per
 161 implementation, for various reasons, which can be void * in the APIs.
 162 For now, we hack around it. */
 163 tls_ext_ctx_cb *client_static_cbinfo = NULL;
 164 tls_ext_ctx_cb *server_static_cbinfo = NULL;
 165
 166 static int
 167 setup_certs(SSL_CTX *sctx, uschar *certs, uschar *crl, host_item *host, BOOL optional,
 168     int (*cert_vfy_cb)(int, X509_STORE_CTX *) );
 169
 170 /* Callbacks */
 171 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
 172 static int tls_servername_cb(SSL *s, int *ad ARG_UNUSED, void *arg);
 173 #endif
 174 #ifndef DISABLE_OCSP
 175 static int tls_server_stapling_cb(SSL *s, void *arg);
 176 #endif
 177
 178
 179 /*************************************************
 180 *               Handle TLS error                 *
 181 *************************************************/
 182
 183 /* Called from lots of places when errors occur before actually starting to do
 184 the TLS handshake, that is, while the session is still in clear. Always returns
 185 DEFER for a server and FAIL for a client so that most calls can use "return
 186 tls_error(...)" to do this processing and then give an appropriate return. A
 187 single function is used for both server and client, because it is called from
 188 some shared functions.
 189
 190 Argument:
 191   prefix    text to include in the logged error
 192   host      NULL if setting up a server;
 193             the connected host if setting up a client
 194   msg       error message or NULL if we should ask OpenSSL
 195
 196 Returns:    OK/DEFER/FAIL
 197 */
 198
 199 static int
 200 tls_error(uschar * prefix, const host_item * host, uschar *  msg)
 201 {
 202 if (!msg)
 203   {
 204   ERR_error_string(ERR_get_error(), ssl_errstring);
 205   msg = (uschar *)ssl_errstring;
 206   }
 207
 208 if (host)
 209   {
 210   log_write(0, LOG_MAIN, "H=%s [%s] TLS error on connection (%s): %s",
 211     host->name, host->address, prefix, msg);
 212   return FAIL;
 213   }
 214 else
 215   {
 216   uschar *conn_info = smtp_get_connection_info();
 217   if (Ustrncmp(conn_info, US"SMTP ", 5) == 0)
 218     conn_info += 5;
 219   /* I'd like to get separated H= here, but too hard for now */
 220   log_write(0, LOG_MAIN, "TLS error on %s (%s): %s",
 221     conn_info, prefix, msg);
 222   return DEFER;
 223   }
 224 }
 225
 226
 227
 228 /*************************************************
 229 *        Callback to generate RSA key            *
 230 *************************************************/
 231
 232 /*
 233 Arguments:
 234   s          SSL connection
 235   export     not used
 236   keylength  keylength
 237
 238 Returns:     pointer to generated key
 239 */
 240
 241 static RSA *
 242 rsa_callback(SSL *s, int export, int keylength)
 243 {
 244 RSA *rsa_key;
 245 export = export;     /* Shut picky compilers up */
 246 DEBUG(D_tls) debug_printf("Generating %d bit RSA key...\n", keylength);
 247 rsa_key = RSA_generate_key(keylength, RSA_F4, NULL, NULL);
 248 if (rsa_key == NULL)
 249   {
 250   ERR_error_string(ERR_get_error(), ssl_errstring);
 251   log_write(0, LOG_MAIN|LOG_PANIC, "TLS error (RSA_generate_key): %s",
 252     ssl_errstring);
 253   return NULL;
 254   }
 255 return rsa_key;
 256 }
 257
 258
 259
 260 /* Extreme debug
 261 #ifndef DISABLE_OCSP
 262 void
 263 x509_store_dump_cert_s_names(X509_STORE * store)
 264 {
 265 STACK_OF(X509_OBJECT) * roots= store->objs;
 266 int i;
 267 static uschar name[256];
 268
 269 for(i= 0; i<sk_X509_OBJECT_num(roots); i++)
 270   {
 271   X509_OBJECT * tmp_obj= sk_X509_OBJECT_value(roots, i);
 272   if(tmp_obj->type == X509_LU_X509)
 273     {
 274     X509 * current_cert= tmp_obj->data.x509;
 275     X509_NAME_oneline(X509_get_subject_name(current_cert), CS name, sizeof(name));
 276         name[sizeof(name)-1] = '\0';
 277     debug_printf(" %s\n", name);
 278     }
 279   }
 280 }
 281 #endif
 282 */
 283
 284
 285 #ifndef DISABLE_EVENT
 286 static int
 287 verify_event(tls_support * tlsp, X509 * cert, int depth, const uschar * dn,
 288   BOOL *calledp, const BOOL *optionalp, const uschar * what)
 289 {
 290 uschar * ev;
 291 uschar * yield;
 292 X509 * old_cert;
 293
 294 ev = tlsp == &tls_out ? client_static_cbinfo->event_action : event_action;
 295 if (ev)
 296   {
 297   DEBUG(D_tls) debug_printf("verify_event: %s %d\n", what, depth);
 298   old_cert = tlsp->peercert;
 299   tlsp->peercert = X509_dup(cert);
 300   /* NB we do not bother setting peerdn */
 301   if ((yield = event_raise(ev, US"tls:cert", string_sprintf("%d", depth))))
 302     {
 303     log_write(0, LOG_MAIN, "[%s] %s verify denied by event-action: "
 304                 "depth=%d cert=%s: %s",
 305               tlsp == &tls_out ? deliver_host_address : sender_host_address,
 306               what, depth, dn, yield);
 307     *calledp = TRUE;
 308     if (!*optionalp)
 309       {
 310       if (old_cert) tlsp->peercert = old_cert;  /* restore 1st failing cert */
 311       return 1;                     /* reject (leaving peercert set) */
 312       }
 313     DEBUG(D_tls) debug_printf("Event-action verify failure overridden "
 314       "(host in tls_try_verify_hosts)\n");
 315     }
 316   X509_free(tlsp->peercert);
 317   tlsp->peercert = old_cert;
 318   }
 319 return 0;
 320 }
 321 #endif
 322
 323 /*************************************************
 324 *        Callback for verification               *
 325 *************************************************/
 326
 327 /* The SSL library does certificate verification if set up to do so. This
 328 callback has the current yes/no state is in "state". If verification succeeded,
 329 we set the certificate-verified flag. If verification failed, what happens
 330 depends on whether the client is required to present a verifiable certificate
 331 or not.
 332
 333 If verification is optional, we change the state to yes, but still log the
 334 verification error. For some reason (it really would help to have proper
 335 documentation of OpenSSL), this callback function then gets called again, this
 336 time with state = 1.  We must take care not to set the private verified flag on
 337 the second time through.
 338
 339 Note: this function is not called if the client fails to present a certificate
 340 when asked. We get here only if a certificate has been received. Handling of
 341 optional verification for this case is done when requesting SSL to verify, by
 342 setting SSL_VERIFY_FAIL_IF_NO_PEER_CERT in the non-optional case.
 343
 344 May be called multiple times for different issues with a certificate, even
 345 for a given "depth" in the certificate chain.
 346
 347 Arguments:
 348   preverify_ok current yes/no state as 1/0
 349   x509ctx      certificate information.
 350   tlsp         per-direction (client vs. server) support data
 351   calledp      has-been-called flag
 352   optionalp    verification-is-optional flag
 353
 354 Returns:     0 if verification should fail, otherwise 1
 355 */
 356
 357 static int
 358 verify_callback(int preverify_ok, X509_STORE_CTX *x509ctx,
 359   tls_support *tlsp, BOOL *calledp, BOOL *optionalp)
 360 {
 361 X509 * cert = X509_STORE_CTX_get_current_cert(x509ctx);
 362 int depth = X509_STORE_CTX_get_error_depth(x509ctx);
 363 uschar dn[256];
 364
 365 X509_NAME_oneline(X509_get_subject_name(cert), CS dn, sizeof(dn));
 366 dn[sizeof(dn)-1] = '\0';
 367
 368 if (preverify_ok == 0)
 369   {
 370   log_write(0, LOG_MAIN, "[%s] SSL verify error: depth=%d error=%s cert=%s",
 371         tlsp == &tls_out ? deliver_host_address : sender_host_address,
 372     depth,
 373     X509_verify_cert_error_string(X509_STORE_CTX_get_error(x509ctx)),
 374     dn);
 375   *calledp = TRUE;
 376   if (!*optionalp)
 377     {
 378     if (!tlsp->peercert)
 379       tlsp->peercert = X509_dup(cert);  /* record failing cert */
 380     return 0;                           /* reject */
 381     }
 382   DEBUG(D_tls) debug_printf("SSL verify failure overridden (host in "
 383     "tls_try_verify_hosts)\n");
 384   }
 385
 386 else if (depth != 0)
 387   {
 388   DEBUG(D_tls) debug_printf("SSL verify ok: depth=%d SN=%s\n", depth, dn);
 389 #ifndef DISABLE_OCSP
 390   if (tlsp == &tls_out && client_static_cbinfo->u_ocsp.client.verify_store)
 391     {   /* client, wanting stapling  */
 392     /* Add the server cert's signing chain as the one
 393     for the verification of the OCSP stapled information. */
 394
 395     if (!X509_STORE_add_cert(client_static_cbinfo->u_ocsp.client.verify_store,
 396                              cert))
 397       ERR_clear_error();
 398     }
 399 #endif
 400 #ifndef DISABLE_EVENT
 401     if (verify_event(tlsp, cert, depth, dn, calledp, optionalp, US"SSL"))
 402       return 0;                         /* reject, with peercert set */
 403 #endif
 404   }
 405 else
 406   {
 407   const uschar * verify_cert_hostnames;
 408
 409   if (  tlsp == &tls_out
 410      && ((verify_cert_hostnames = client_static_cbinfo->verify_cert_hostnames)))
 411         /* client, wanting hostname check */
 412     {
 413
 414 #ifdef EXIM_HAVE_OPENSSL_CHECKHOST
 415 # ifndef X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS
 416 #  define X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS 0
 417 # endif
 418 # ifndef X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS
 419 #  define X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS 0
 420 # endif
 421     int sep = 0;
 422     const uschar * list = verify_cert_hostnames;
 423     uschar * name;
 424     int rc;
 425     while ((name = string_nextinlist(&list, &sep, NULL, 0)))
 426       if ((rc = X509_check_host(cert, name, 0,
 427                   X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS
 428                   | X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS,
 429                   NULL)))
 430         {
 431         if (rc < 0)
 432           {
 433           log_write(0, LOG_MAIN, "[%s] SSL verify error: internal error",
 434                 tlsp == &tls_out ? deliver_host_address : sender_host_address);
 435           name = NULL;
 436           }
 437         break;
 438         }
 439     if (!name)
 440 #else
 441     if (!tls_is_name_for_cert(verify_cert_hostnames, cert))
 442 #endif
 443       {
 444       log_write(0, LOG_MAIN,
 445                 "[%s] SSL verify error: certificate name mismatch: \"%s\"",
 446                 tlsp == &tls_out ? deliver_host_address : sender_host_address,
 447                 dn);
 448       *calledp = TRUE;
 449       if (!*optionalp)
 450         {
 451         if (!tlsp->peercert)
 452           tlsp->peercert = X509_dup(cert);      /* record failing cert */
 453         return 0;                               /* reject */
 454         }
 455       DEBUG(D_tls) debug_printf("SSL verify failure overridden (host in "
 456         "tls_try_verify_hosts)\n");
 457       }
 458     }
 459
 460 #ifndef DISABLE_EVENT
 461   if (verify_event(tlsp, cert, depth, dn, calledp, optionalp, US"SSL"))
 462     return 0;                           /* reject, with peercert set */
 463 #endif
 464
 465   DEBUG(D_tls) debug_printf("SSL%s verify ok: depth=0 SN=%s\n",
 466     *calledp ? "" : " authenticated", dn);
 467   if (!*calledp) tlsp->certificate_verified = TRUE;
 468   *calledp = TRUE;
 469   }
 470
 471 return 1;   /* accept, at least for this level */
 472 }
 473
 474 static int
 475 verify_callback_client(int preverify_ok, X509_STORE_CTX *x509ctx)
 476 {
 477 return verify_callback(preverify_ok, x509ctx, &tls_out,
 478   &client_verify_callback_called, &client_verify_optional);
 479 }
 480
 481 static int
 482 verify_callback_server(int preverify_ok, X509_STORE_CTX *x509ctx)
 483 {
 484 return verify_callback(preverify_ok, x509ctx, &tls_in,
 485   &server_verify_callback_called, &server_verify_optional);
 486 }
 487
 488
 489 #ifdef EXPERIMENTAL_DANE
 490
 491 /* This gets called *by* the dane library verify callback, which interposes
 492 itself.
 493 */
 494 static int
 495 verify_callback_client_dane(int preverify_ok, X509_STORE_CTX * x509ctx)
 496 {
 497 X509 * cert = X509_STORE_CTX_get_current_cert(x509ctx);
 498 uschar dn[256];
 499 #ifndef DISABLE_EVENT
 500 int depth = X509_STORE_CTX_get_error_depth(x509ctx);
 501 BOOL dummy_called, optional = FALSE;
 502 #endif
 503
 504 X509_NAME_oneline(X509_get_subject_name(cert), CS dn, sizeof(dn));
 505 dn[sizeof(dn)-1] = '\0';
 506
 507 DEBUG(D_tls) debug_printf("verify_callback_client_dane: %s depth %d %s\n",
 508   preverify_ok ? "ok":"BAD", depth, dn);
 509
 510 #ifndef DISABLE_EVENT
 511   if (verify_event(&tls_out, cert, depth, dn,
 512           &dummy_called, &optional, US"DANE"))
 513     return 0;                           /* reject, with peercert set */
 514 #endif
 515
 516 if (preverify_ok == 1)
 517   tls_out.dane_verified =
 518   tls_out.certificate_verified = TRUE;
 519 else
 520   {
 521   int err = X509_STORE_CTX_get_error(x509ctx);
 522   DEBUG(D_tls)
 523     debug_printf(" - err %d '%s'\n", err, X509_verify_cert_error_string(err));
 524   if (err = X509_V_ERR_APPLICATION_VERIFICATION)
 525     preverify_ok = 1;
 526   }
 527 return preverify_ok;
 528 }
 529
 530 #endif  /*EXPERIMENTAL_DANE*/
 531
 532
 533 /*************************************************
 534 *           Information callback                 *
 535 *************************************************/
 536
 537 /* The SSL library functions call this from time to time to indicate what they
 538 are doing. We copy the string to the debugging output when TLS debugging has
 539 been requested.
 540
 541 Arguments:
 542   s         the SSL connection
 543   where
 544   ret
 545
 546 Returns:    nothing
 547 */
 548
 549 static void
 550 info_callback(SSL *s, int where, int ret)
 551 {
 552 where = where;
 553 ret = ret;
 554 DEBUG(D_tls) debug_printf("SSL info: %s\n", SSL_state_string_long(s));
 555 }
 556
 557
 558
 559 /*************************************************
 560 *                Initialize for DH               *
 561 *************************************************/
 562
 563 /* If dhparam is set, expand it, and load up the parameters for DH encryption.
 564
 565 Arguments:
 566   sctx      The current SSL CTX (inbound or outbound)
 567   dhparam   DH parameter file or fixed parameter identity string
 568   host      connected host, if client; NULL if server
 569
 570 Returns:    TRUE if OK (nothing to set up, or setup worked)
 571 */
 572
 573 static BOOL
 574 init_dh(SSL_CTX *sctx, uschar *dhparam, const host_item *host)
 575 {
 576 BIO *bio;
 577 DH *dh;
 578 uschar *dhexpanded;
 579 const char *pem;
 580
 581 if (!expand_check(dhparam, US"tls_dhparam", &dhexpanded))
 582   return FALSE;
 583
 584 if (!dhexpanded || !*dhexpanded)
 585   bio = BIO_new_mem_buf(CS std_dh_prime_default(), -1);
 586 else if (dhexpanded[0] == '/')
 587   {
 588   if (!(bio = BIO_new_file(CS dhexpanded, "r")))
 589     {
 590     tls_error(string_sprintf("could not read dhparams file %s", dhexpanded),
 591           host, US strerror(errno));
 592     return FALSE;
 593     }
 594   }
 595 else
 596   {
 597   if (Ustrcmp(dhexpanded, "none") == 0)
 598     {
 599     DEBUG(D_tls) debug_printf("Requested no DH parameters.\n");
 600     return TRUE;
 601     }
 602
 603   if (!(pem = std_dh_prime_named(dhexpanded)))
 604     {
 605     tls_error(string_sprintf("Unknown standard DH prime \"%s\"", dhexpanded),
 606         host, US strerror(errno));
 607     return FALSE;
 608     }
 609   bio = BIO_new_mem_buf(CS pem, -1);
 610   }
 611
 612 if (!(dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL)))
 613   {
 614   BIO_free(bio);
 615   tls_error(string_sprintf("Could not read tls_dhparams \"%s\"", dhexpanded),
 616       host, NULL);
 617   return FALSE;
 618   }
 619
 620 /* Even if it is larger, we silently return success rather than cause things
 621  * to fail out, so that a too-large DH will not knock out all TLS; it's a
 622  * debatable choice. */
 623 if ((8*DH_size(dh)) > tls_dh_max_bits)
 624   {
 625   DEBUG(D_tls)
 626     debug_printf("dhparams file %d bits, is > tls_dh_max_bits limit of %d",
 627         8*DH_size(dh), tls_dh_max_bits);
 628   }
 629 else
 630   {
 631   SSL_CTX_set_tmp_dh(sctx, dh);
 632   DEBUG(D_tls)
 633     debug_printf("Diffie-Hellman initialized from %s with %d-bit prime\n",
 634       dhexpanded ? dhexpanded : US"default", 8*DH_size(dh));
 635   }
 636
 637 DH_free(dh);
 638 BIO_free(bio);
 639
 640 return TRUE;
 641 }
 642
 643
 644
 645
 646 /*************************************************
 647 *               Initialize for ECDH              *
 648 *************************************************/
 649
 650 /* Load parameters for ECDH encryption.
 651
 652 For now, we stick to NIST P-256 because: it's simple and easy to configure;
 653 it avoids any patent issues that might bite redistributors; despite events in
 654 the news and concerns over curve choices, we're not cryptographers, we're not
 655 pretending to be, and this is "good enough" to be better than no support,
 656 protecting against most adversaries.  Given another year or two, there might
 657 be sufficient clarity about a "right" way forward to let us make an informed
 658 decision, instead of a knee-jerk reaction.
 659
 660 Longer-term, we should look at supporting both various named curves and
 661 external files generated with "openssl ecparam", much as we do for init_dh().
 662 We should also support "none" as a value, to explicitly avoid initialisation.
 663
 664 Patches welcome.
 665
 666 Arguments:
 667   sctx      The current SSL CTX (inbound or outbound)
 668   host      connected host, if client; NULL if server
 669
 670 Returns:    TRUE if OK (nothing to set up, or setup worked)
 671 */
 672
 673 static BOOL
 674 init_ecdh(SSL_CTX * sctx, host_item * host)
 675 {
 676 #ifdef OPENSSL_NO_ECDH
 677 return TRUE;
 678 #else
 679
 680 EC_KEY * ecdh;
 681 uschar * exp_curve;
 682 int nid;
 683 BOOL rv;
 684
 685 if (host)       /* No ECDH setup for clients, only for servers */
 686   return TRUE;
 687
 688 # ifndef EXIM_HAVE_ECDH
 689 DEBUG(D_tls)
 690   debug_printf("No OpenSSL API to define ECDH parameters, skipping\n");
 691 return TRUE;
 692 # else
 693
 694 if (!expand_check(tls_eccurve, US"tls_eccurve", &exp_curve))
 695   return FALSE;
 696 if (!exp_curve || !*exp_curve)
 697   return TRUE;
 698
 699 #  ifdef EXIM_HAVE_OPENSSL_ECDH_AUTO
 700 /* check if new enough library to support auto ECDH temp key parameter selection */
 701 if (Ustrcmp(exp_curve, "auto") == 0)
 702   {
 703   DEBUG(D_tls) debug_printf(
 704     "ECDH temp key parameter settings: OpenSSL 1.2+ autoselection\n");
 705   SSL_CTX_set_ecdh_auto(sctx, 1);
 706   return TRUE;
 707   }
 708 #  endif
 709
 710 DEBUG(D_tls) debug_printf("ECDH: curve '%s'\n", exp_curve);
 711 if (  (nid = OBJ_sn2nid       (CCS exp_curve)) == NID_undef
 712 #   ifdef EXIM_HAVE_OPENSSL_EC_NIST2NID
 713    && (nid = EC_curve_nist2nid(CCS exp_curve)) == NID_undef
 714 #   endif
 715    )
 716   {
 717   tls_error(string_sprintf("Unknown curve name tls_eccurve '%s'",
 718       exp_curve),
 719     host, NULL);
 720   return FALSE;
 721   }
 722
 723 if (!(ecdh = EC_KEY_new_by_curve_name(nid)))
 724   {
 725   tls_error(US"Unable to create ec curve", host, NULL);
 726   return FALSE;
 727   }
 728
 729 /* The "tmp" in the name here refers to setting a temporary key
 730 not to the stability of the interface. */
 731
 732 if ((rv = SSL_CTX_set_tmp_ecdh(sctx, ecdh) == 0))
 733   tls_error(string_sprintf("Error enabling '%s' curve", exp_curve), host, NULL);
 734 else
 735   DEBUG(D_tls) debug_printf("ECDH: enabled '%s' curve\n", exp_curve);
 736
 737 EC_KEY_free(ecdh);
 738 return !rv;
 739
 740 # endif /*EXIM_HAVE_ECDH*/
 741 #endif /*OPENSSL_NO_ECDH*/
 742 }
 743
 744
 745
 746
 747 #ifndef DISABLE_OCSP
 748 /*************************************************
 749 *       Load OCSP information into state         *
 750 *************************************************/
 751
 752 /* Called to load the server OCSP response from the given file into memory, once
 753 caller has determined this is needed.  Checks validity.  Debugs a message
 754 if invalid.
 755
 756 ASSUMES: single response, for single cert.
 757
 758 Arguments:
 759   sctx            the SSL_CTX* to update
 760   cbinfo          various parts of session state
 761   expanded        the filename putatively holding an OCSP response
 762
 763 */
 764
 765 static void
 766 ocsp_load_response(SSL_CTX *sctx, tls_ext_ctx_cb *cbinfo, const uschar *expanded)
 767 {
 768 BIO *bio;
 769 OCSP_RESPONSE *resp;
 770 OCSP_BASICRESP *basic_response;
 771 OCSP_SINGLERESP *single_response;
 772 ASN1_GENERALIZEDTIME *rev, *thisupd, *nextupd;
 773 X509_STORE *store;
 774 unsigned long verify_flags;
 775 int status, reason, i;
 776
 777 cbinfo->u_ocsp.server.file_expanded = string_copy(expanded);
 778 if (cbinfo->u_ocsp.server.response)
 779   {
 780   OCSP_RESPONSE_free(cbinfo->u_ocsp.server.response);
 781   cbinfo->u_ocsp.server.response = NULL;
 782   }
 783
 784 bio = BIO_new_file(CS cbinfo->u_ocsp.server.file_expanded, "rb");
 785 if (!bio)
 786   {
 787   DEBUG(D_tls) debug_printf("Failed to open OCSP response file \"%s\"\n",
 788       cbinfo->u_ocsp.server.file_expanded);
 789   return;
 790   }
 791
 792 resp = d2i_OCSP_RESPONSE_bio(bio, NULL);
 793 BIO_free(bio);
 794 if (!resp)
 795   {
 796   DEBUG(D_tls) debug_printf("Error reading OCSP response.\n");
 797   return;
 798   }
 799
 800 status = OCSP_response_status(resp);
 801 if (status != OCSP_RESPONSE_STATUS_SUCCESSFUL)
 802   {
 803   DEBUG(D_tls) debug_printf("OCSP response not valid: %s (%d)\n",
 804       OCSP_response_status_str(status), status);
 805   goto bad;
 806   }
 807
 808 basic_response = OCSP_response_get1_basic(resp);
 809 if (!basic_response)
 810   {
 811   DEBUG(D_tls)
 812     debug_printf("OCSP response parse error: unable to extract basic response.\n");
 813   goto bad;
 814   }
 815
 816 store = SSL_CTX_get_cert_store(sctx);
 817 verify_flags = OCSP_NOVERIFY; /* check sigs, but not purpose */
 818
 819 /* May need to expose ability to adjust those flags?
 820 OCSP_NOSIGS OCSP_NOVERIFY OCSP_NOCHAIN OCSP_NOCHECKS OCSP_NOEXPLICIT
 821 OCSP_TRUSTOTHER OCSP_NOINTERN */
 822
 823 i = OCSP_basic_verify(basic_response, NULL, store, verify_flags);
 824 if (i <= 0)
 825   {
 826   DEBUG(D_tls) {
 827     ERR_error_string(ERR_get_error(), ssl_errstring);
 828     debug_printf("OCSP response verify failure: %s\n", US ssl_errstring);
 829     }
 830   goto bad;
 831   }
 832
 833 /* Here's the simplifying assumption: there's only one response, for the
 834 one certificate we use, and nothing for anything else in a chain.  If this
 835 proves false, we need to extract a cert id from our issued cert
 836 (tls_certificate) and use that for OCSP_resp_find_status() (which finds the
 837 right cert in the stack and then calls OCSP_single_get0_status()).
 838
 839 I'm hoping to avoid reworking a bunch more of how we handle state here. */
 840 single_response = OCSP_resp_get0(basic_response, 0);
 841 if (!single_response)
 842   {
 843   DEBUG(D_tls)
 844     debug_printf("Unable to get first response from OCSP basic response.\n");
 845   goto bad;
 846   }
 847
 848 status = OCSP_single_get0_status(single_response, &reason, &rev, &thisupd, &nextupd);
 849 if (status != V_OCSP_CERTSTATUS_GOOD)
 850   {
 851   DEBUG(D_tls) debug_printf("OCSP response bad cert status: %s (%d) %s (%d)\n",
 852       OCSP_cert_status_str(status), status,
 853       OCSP_crl_reason_str(reason), reason);
 854   goto bad;
 855   }
 856
 857 if (!OCSP_check_validity(thisupd, nextupd, EXIM_OCSP_SKEW_SECONDS, EXIM_OCSP_MAX_AGE))
 858   {
 859   DEBUG(D_tls) debug_printf("OCSP status invalid times.\n");
 860   goto bad;
 861   }
 862
 863 supply_response:
 864   cbinfo->u_ocsp.server.response = resp;
 865 return;
 866
 867 bad:
 868   if (running_in_test_harness)
 869     {
 870     extern char ** environ;
 871     uschar ** p;
 872     for (p = USS environ; *p != NULL; p++)
 873       if (Ustrncmp(*p, "EXIM_TESTHARNESS_DISABLE_OCSPVALIDITYCHECK", 42) == 0)
 874         {
 875         DEBUG(D_tls) debug_printf("Supplying known bad OCSP response\n");
 876         goto supply_response;
 877         }
 878     }
 879 return;
 880 }
 881 #endif  /*!DISABLE_OCSP*/
 882
 883
 884
 885
 886 /*************************************************
 887 *        Expand key and cert file specs          *
 888 *************************************************/
 889
 890 /* Called once during tls_init and possibly again during TLS setup, for a
 891 new context, if Server Name Indication was used and tls_sni was seen in
 892 the certificate string.
 893
 894 Arguments:
 895   sctx            the SSL_CTX* to update
 896   cbinfo          various parts of session state
 897
 898 Returns:          OK/DEFER/FAIL
 899 */
 900
 901 static int
 902 tls_expand_session_files(SSL_CTX *sctx, tls_ext_ctx_cb *cbinfo)
 903 {
 904 uschar *expanded;
 905
 906 if (cbinfo->certificate == NULL)
 907   return OK;
 908
 909 if (Ustrstr(cbinfo->certificate, US"tls_sni") ||
 910     Ustrstr(cbinfo->certificate, US"tls_in_sni") ||
 911     Ustrstr(cbinfo->certificate, US"tls_out_sni")
 912    )
 913   reexpand_tls_files_for_sni = TRUE;
 914
 915 if (!expand_check(cbinfo->certificate, US"tls_certificate", &expanded))
 916   return DEFER;
 917
 918 if (expanded != NULL)
 919   {
 920   DEBUG(D_tls) debug_printf("tls_certificate file %s\n", expanded);
 921   if (!SSL_CTX_use_certificate_chain_file(sctx, CS expanded))
 922     return tls_error(string_sprintf(
 923       "SSL_CTX_use_certificate_chain_file file=%s", expanded),
 924         cbinfo->host, NULL);
 925   }
 926
 927 if (cbinfo->privatekey != NULL &&
 928     !expand_check(cbinfo->privatekey, US"tls_privatekey", &expanded))
 929   return DEFER;
 930
 931 /* If expansion was forced to fail, key_expanded will be NULL. If the result
 932 of the expansion is an empty string, ignore it also, and assume the private
 933 key is in the same file as the certificate. */
 934
 935 if (expanded != NULL && *expanded != 0)
 936   {
 937   DEBUG(D_tls) debug_printf("tls_privatekey file %s\n", expanded);
 938   if (!SSL_CTX_use_PrivateKey_file(sctx, CS expanded, SSL_FILETYPE_PEM))
 939     return tls_error(string_sprintf(
 940       "SSL_CTX_use_PrivateKey_file file=%s", expanded), cbinfo->host, NULL);
 941   }
 942
 943 #ifndef DISABLE_OCSP
 944 if (cbinfo->is_server &&  cbinfo->u_ocsp.server.file != NULL)
 945   {
 946   if (!expand_check(cbinfo->u_ocsp.server.file, US"tls_ocsp_file", &expanded))
 947     return DEFER;
 948
 949   if (expanded != NULL && *expanded != 0)
 950     {
 951     DEBUG(D_tls) debug_printf("tls_ocsp_file %s\n", expanded);
 952     if (cbinfo->u_ocsp.server.file_expanded &&
 953         (Ustrcmp(expanded, cbinfo->u_ocsp.server.file_expanded) == 0))
 954       {
 955       DEBUG(D_tls)
 956         debug_printf("tls_ocsp_file value unchanged, using existing values.\n");
 957       } else {
 958         ocsp_load_response(sctx, cbinfo, expanded);
 959       }
 960     }
 961   }
 962 #endif
 963
 964 return OK;
 965 }
 966
 967
 968
 969
 970 /*************************************************
 971 *            Callback to handle SNI              *
 972 *************************************************/
 973
 974 /* Called when acting as server during the TLS session setup if a Server Name
 975 Indication extension was sent by the client.
 976
 977 API documentation is OpenSSL s_server.c implementation.
 978
 979 Arguments:
 980   s               SSL* of the current session
 981   ad              unknown (part of OpenSSL API) (unused)
 982   arg             Callback of "our" registered data
 983
 984 Returns:          SSL_TLSEXT_ERR_{OK,ALERT_WARNING,ALERT_FATAL,NOACK}
 985 */
 986
 987 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
 988 static int
 989 tls_servername_cb(SSL *s, int *ad ARG_UNUSED, void *arg)
 990 {
 991 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
 992 tls_ext_ctx_cb *cbinfo = (tls_ext_ctx_cb *) arg;
 993 int rc;
 994 int old_pool = store_pool;
 995
 996 if (!servername)
 997   return SSL_TLSEXT_ERR_OK;
 998
 999 DEBUG(D_tls) debug_printf("Received TLS SNI \"%s\"%s\n", servername,
1000     reexpand_tls_files_for_sni ? "" : " (unused for certificate selection)");
1001
1002 /* Make the extension value available for expansion */
1003 store_pool = POOL_PERM;
1004 tls_in.sni = string_copy(US servername);
1005 store_pool = old_pool;
1006
1007 if (!reexpand_tls_files_for_sni)
1008   return SSL_TLSEXT_ERR_OK;
1009
1010 /* Can't find an SSL_CTX_clone() or equivalent, so we do it manually;
1011 not confident that memcpy wouldn't break some internal reference counting.
1012 Especially since there's a references struct member, which would be off. */
1013
1014 if (!(server_sni = SSL_CTX_new(SSLv23_server_method())))
1015   {
1016   ERR_error_string(ERR_get_error(), ssl_errstring);
1017   DEBUG(D_tls) debug_printf("SSL_CTX_new() failed: %s\n", ssl_errstring);
1018   return SSL_TLSEXT_ERR_NOACK;
1019   }
1020
1021 /* Not sure how many of these are actually needed, since SSL object
1022 already exists.  Might even need this selfsame callback, for reneg? */
1023
1024 SSL_CTX_set_info_callback(server_sni, SSL_CTX_get_info_callback(server_ctx));
1025 SSL_CTX_set_mode(server_sni, SSL_CTX_get_mode(server_ctx));
1026 SSL_CTX_set_options(server_sni, SSL_CTX_get_options(server_ctx));
1027 SSL_CTX_set_timeout(server_sni, SSL_CTX_get_timeout(server_ctx));
1028 SSL_CTX_set_tlsext_servername_callback(server_sni, tls_servername_cb);
1029 SSL_CTX_set_tlsext_servername_arg(server_sni, cbinfo);
1030
1031 if (  !init_dh(server_sni, cbinfo->dhparam, NULL)
1032    || !init_ecdh(server_sni, NULL)
1033    )
1034   return SSL_TLSEXT_ERR_NOACK;
1035
1036 if (cbinfo->server_cipher_list)
1037   SSL_CTX_set_cipher_list(server_sni, CS cbinfo->server_cipher_list);
1038 #ifndef DISABLE_OCSP
1039 if (cbinfo->u_ocsp.server.file)
1040   {
1041   SSL_CTX_set_tlsext_status_cb(server_sni, tls_server_stapling_cb);
1042   SSL_CTX_set_tlsext_status_arg(server_sni, cbinfo);
1043   }
1044 #endif
1045
1046 rc = setup_certs(server_sni, tls_verify_certificates, tls_crl, NULL, FALSE, verify_callback_server);
1047 if (rc != OK) return SSL_TLSEXT_ERR_NOACK;
1048
1049 /* do this after setup_certs, because this can require the certs for verifying
1050 OCSP information. */
1051 if ((rc = tls_expand_session_files(server_sni, cbinfo)) != OK)
1052   return SSL_TLSEXT_ERR_NOACK;
1053
1054 DEBUG(D_tls) debug_printf("Switching SSL context.\n");
1055 SSL_set_SSL_CTX(s, server_sni);
1056
1057 return SSL_TLSEXT_ERR_OK;
1058 }
1059 #endif /* EXIM_HAVE_OPENSSL_TLSEXT */
1060
1061
1062
1063
1064 #ifndef DISABLE_OCSP
1065
1066 /*************************************************
1067 *        Callback to handle OCSP Stapling        *
1068 *************************************************/
1069
1070 /* Called when acting as server during the TLS session setup if the client
1071 requests OCSP information with a Certificate Status Request.
1072
1073 Documentation via openssl s_server.c and the Apache patch from the OpenSSL
1074 project.
1075
1076 */
1077
1078 static int
1079 tls_server_stapling_cb(SSL *s, void *arg)
1080 {
1081 const tls_ext_ctx_cb *cbinfo = (tls_ext_ctx_cb *) arg;
1082 uschar *response_der;
1083 int response_der_len;
1084
1085 DEBUG(D_tls)
1086   debug_printf("Received TLS status request (OCSP stapling); %s response\n",
1087     cbinfo->u_ocsp.server.response ? "have" : "lack");
1088
1089 tls_in.ocsp = OCSP_NOT_RESP;
1090 if (!cbinfo->u_ocsp.server.response)
1091   return SSL_TLSEXT_ERR_NOACK;
1092
1093 response_der = NULL;
1094 response_der_len = i2d_OCSP_RESPONSE(cbinfo->u_ocsp.server.response,
1095                       &response_der);
1096 if (response_der_len <= 0)
1097   return SSL_TLSEXT_ERR_NOACK;
1098
1099 SSL_set_tlsext_status_ocsp_resp(server_ssl, response_der, response_der_len);
1100 tls_in.ocsp = OCSP_VFIED;
1101 return SSL_TLSEXT_ERR_OK;
1102 }
1103
1104
1105 static void
1106 time_print(BIO * bp, const char * str, ASN1_GENERALIZEDTIME * time)
1107 {
1108 BIO_printf(bp, "\t%s: ", str);
1109 ASN1_GENERALIZEDTIME_print(bp, time);
1110 BIO_puts(bp, "\n");
1111 }
1112
1113 static int
1114 tls_client_stapling_cb(SSL *s, void *arg)
1115 {
1116 tls_ext_ctx_cb * cbinfo = arg;
1117 const unsigned char * p;
1118 int len;
1119 OCSP_RESPONSE * rsp;
1120 OCSP_BASICRESP * bs;
1121 int i;
1122
1123 DEBUG(D_tls) debug_printf("Received TLS status response (OCSP stapling):");
1124 len = SSL_get_tlsext_status_ocsp_resp(s, &p);
1125 if(!p)
1126  {
1127   /* Expect this when we requested ocsp but got none */
1128   if (cbinfo->u_ocsp.client.verify_required && LOGGING(tls_cipher))
1129     log_write(0, LOG_MAIN, "Received TLS status callback, null content");
1130   else
1131     DEBUG(D_tls) debug_printf(" null\n");
1132   return cbinfo->u_ocsp.client.verify_required ? 0 : 1;
1133  }
1134
1135 if(!(rsp = d2i_OCSP_RESPONSE(NULL, &p, len)))
1136  {
1137   tls_out.ocsp = OCSP_FAILED;
1138   if (LOGGING(tls_cipher))
1139     log_write(0, LOG_MAIN, "Received TLS cert status response, parse error");
1140   else
1141     DEBUG(D_tls) debug_printf(" parse error\n");
1142   return 0;
1143  }
1144
1145 if(!(bs = OCSP_response_get1_basic(rsp)))
1146   {
1147   tls_out.ocsp = OCSP_FAILED;
1148   if (LOGGING(tls_cipher))
1149     log_write(0, LOG_MAIN, "Received TLS cert status response, error parsing response");
1150   else
1151     DEBUG(D_tls) debug_printf(" error parsing response\n");
1152   OCSP_RESPONSE_free(rsp);
1153   return 0;
1154   }
1155
1156 /* We'd check the nonce here if we'd put one in the request. */
1157 /* However that would defeat cacheability on the server so we don't. */
1158
1159 /* This section of code reworked from OpenSSL apps source;
1160    The OpenSSL Project retains copyright:
1161    Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
1162 */
1163   {
1164     BIO * bp = NULL;
1165     int status, reason;
1166     ASN1_GENERALIZEDTIME *rev, *thisupd, *nextupd;
1167
1168     DEBUG(D_tls) bp = BIO_new_fp(stderr, BIO_NOCLOSE);
1169
1170     /*OCSP_RESPONSE_print(bp, rsp, 0);   extreme debug: stapling content */
1171
1172     /* Use the chain that verified the server cert to verify the stapled info */
1173     /* DEBUG(D_tls) x509_store_dump_cert_s_names(cbinfo->u_ocsp.client.verify_store); */
1174
1175     if ((i = OCSP_basic_verify(bs, NULL,
1176               cbinfo->u_ocsp.client.verify_store, 0)) <= 0)
1177       {
1178       tls_out.ocsp = OCSP_FAILED;
1179       if (LOGGING(tls_cipher))
1180         log_write(0, LOG_MAIN, "Received TLS cert status response, itself unverifiable");
1181       BIO_printf(bp, "OCSP response verify failure\n");
1182       ERR_print_errors(bp);
1183       i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
1184       goto out;
1185       }
1186
1187     BIO_printf(bp, "OCSP response well-formed and signed OK\n");
1188
1189       {
1190       STACK_OF(OCSP_SINGLERESP) * sresp = bs->tbsResponseData->responses;
1191       OCSP_SINGLERESP * single;
1192
1193       if (sk_OCSP_SINGLERESP_num(sresp) != 1)
1194         {
1195         tls_out.ocsp = OCSP_FAILED;
1196         log_write(0, LOG_MAIN, "OCSP stapling "
1197             "with multiple responses not handled");
1198         i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
1199         goto out;
1200         }
1201       single = OCSP_resp_get0(bs, 0);
1202       status = OCSP_single_get0_status(single, &reason, &rev,
1203                   &thisupd, &nextupd);
1204       }
1205
1206     DEBUG(D_tls) time_print(bp, "This OCSP Update", thisupd);
1207     DEBUG(D_tls) if(nextupd) time_print(bp, "Next OCSP Update", nextupd);
1208     if (!OCSP_check_validity(thisupd, nextupd,
1209           EXIM_OCSP_SKEW_SECONDS, EXIM_OCSP_MAX_AGE))
1210       {
1211       tls_out.ocsp = OCSP_FAILED;
1212       DEBUG(D_tls) ERR_print_errors(bp);
1213       log_write(0, LOG_MAIN, "Server OSCP dates invalid");
1214       i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
1215       }
1216     else
1217       {
1218       DEBUG(D_tls) BIO_printf(bp, "Certificate status: %s\n",
1219                     OCSP_cert_status_str(status));
1220       switch(status)
1221         {
1222         case V_OCSP_CERTSTATUS_GOOD:
1223           tls_out.ocsp = OCSP_VFIED;
1224           i = 1;
1225           break;
1226         case V_OCSP_CERTSTATUS_REVOKED:
1227           tls_out.ocsp = OCSP_FAILED;
1228           log_write(0, LOG_MAIN, "Server certificate revoked%s%s",
1229               reason != -1 ? "; reason: " : "",
1230               reason != -1 ? OCSP_crl_reason_str(reason) : "");
1231           DEBUG(D_tls) time_print(bp, "Revocation Time", rev);
1232           i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
1233           break;
1234         default:
1235           tls_out.ocsp = OCSP_FAILED;
1236           log_write(0, LOG_MAIN,
1237               "Server certificate status unknown, in OCSP stapling");
1238           i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
1239           break;
1240         }
1241       }
1242   out:
1243     BIO_free(bp);
1244   }
1245
1246 OCSP_RESPONSE_free(rsp);
1247 return i;
1248 }
1249 #endif  /*!DISABLE_OCSP*/
1250
1251
1252 /*************************************************
1253 *            Initialize for TLS                  *
1254 *************************************************/
1255
1256 /* Called from both server and client code, to do preliminary initialization
1257 of the library.  We allocate and return a context structure.
1258
1259 Arguments:
1260   ctxp            returned SSL context
1261   host            connected host, if client; NULL if server
1262   dhparam         DH parameter file
1263   certificate     certificate file
1264   privatekey      private key
1265   ocsp_file       file of stapling info (server); flag for require ocsp (client)
1266   addr            address if client; NULL if server (for some randomness)
1267   cbp             place to put allocated callback context
1268
1269 Returns:          OK/DEFER/FAIL
1270 */
1271
1272 static int
1273 tls_init(SSL_CTX **ctxp, host_item *host, uschar *dhparam, uschar *certificate,
1274   uschar *privatekey,
1275 #ifndef DISABLE_OCSP
1276   uschar *ocsp_file,
1277 #endif
1278   address_item *addr, tls_ext_ctx_cb ** cbp)
1279 {
1280 long init_options;
1281 int rc;
1282 BOOL okay;
1283 tls_ext_ctx_cb * cbinfo;
1284
1285 cbinfo = store_malloc(sizeof(tls_ext_ctx_cb));
1286 cbinfo->certificate = certificate;
1287 cbinfo->privatekey = privatekey;
1288 #ifndef DISABLE_OCSP
1289 if ((cbinfo->is_server = host==NULL))
1290   {
1291   cbinfo->u_ocsp.server.file = ocsp_file;
1292   cbinfo->u_ocsp.server.file_expanded = NULL;
1293   cbinfo->u_ocsp.server.response = NULL;
1294   }
1295 else
1296   cbinfo->u_ocsp.client.verify_store = NULL;
1297 #endif
1298 cbinfo->dhparam = dhparam;
1299 cbinfo->server_cipher_list = NULL;
1300 cbinfo->host = host;
1301 #ifndef DISABLE_EVENT
1302 cbinfo->event_action = NULL;
1303 #endif
1304
1305 SSL_load_error_strings();          /* basic set up */
1306 OpenSSL_add_ssl_algorithms();
1307
1308 #if (OPENSSL_VERSION_NUMBER >= 0x0090800fL) && !defined(OPENSSL_NO_SHA256)
1309 /* SHA256 is becoming ever more popular. This makes sure it gets added to the
1310 list of available digests. */
1311 EVP_add_digest(EVP_sha256());
1312 #endif
1313
1314 /* Create a context.
1315 The OpenSSL docs in 1.0.1b have not been updated to clarify TLS variant
1316 negotiation in the different methods; as far as I can tell, the only
1317 *_{server,client}_method which allows negotiation is SSLv23, which exists even
1318 when OpenSSL is built without SSLv2 support.
1319 By disabling with openssl_options, we can let admins re-enable with the
1320 existing knob. */
1321
1322 *ctxp = SSL_CTX_new((host == NULL)?
1323   SSLv23_server_method() : SSLv23_client_method());
1324
1325 if (*ctxp == NULL) return tls_error(US"SSL_CTX_new", host, NULL);
1326
1327 /* It turns out that we need to seed the random number generator this early in
1328 order to get the full complement of ciphers to work. It took me roughly a day
1329 of work to discover this by experiment.
1330
1331 On systems that have /dev/urandom, SSL may automatically seed itself from
1332 there. Otherwise, we have to make something up as best we can. Double check
1333 afterwards. */
1334
1335 if (!RAND_status())
1336   {
1337   randstuff r;
1338   gettimeofday(&r.tv, NULL);
1339   r.p = getpid();
1340
1341   RAND_seed((uschar *)(&r), sizeof(r));
1342   RAND_seed((uschar *)big_buffer, big_buffer_size);
1343   if (addr != NULL) RAND_seed((uschar *)addr, sizeof(addr));
1344
1345   if (!RAND_status())
1346     return tls_error(US"RAND_status", host,
1347       US"unable to seed random number generator");
1348   }
1349
1350 /* Set up the information callback, which outputs if debugging is at a suitable
1351 level. */
1352
1353 DEBUG(D_tls) SSL_CTX_set_info_callback(*ctxp, (void (*)())info_callback);
1354
1355 /* Automatically re-try reads/writes after renegotiation. */
1356 (void) SSL_CTX_set_mode(*ctxp, SSL_MODE_AUTO_RETRY);
1357
1358 /* Apply administrator-supplied work-arounds.
1359 Historically we applied just one requested option,
1360 SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS, but when bug 994 requested a second, we
1361 moved to an administrator-controlled list of options to specify and
1362 grandfathered in the first one as the default value for "openssl_options".
1363
1364 No OpenSSL version number checks: the options we accept depend upon the
1365 availability of the option value macros from OpenSSL.  */
1366
1367 okay = tls_openssl_options_parse(openssl_options, &init_options);
1368 if (!okay)
1369   return tls_error(US"openssl_options parsing failed", host, NULL);
1370
1371 if (init_options)
1372   {
1373   DEBUG(D_tls) debug_printf("setting SSL CTX options: %#lx\n", init_options);
1374   if (!(SSL_CTX_set_options(*ctxp, init_options)))
1375     return tls_error(string_sprintf(
1376           "SSL_CTX_set_option(%#lx)", init_options), host, NULL);
1377   }
1378 else
1379   DEBUG(D_tls) debug_printf("no SSL CTX options to set\n");
1380
1381 /* Initialize with DH parameters if supplied */
1382 /* Initialize ECDH temp key parameter selection */
1383
1384 if (  !init_dh(*ctxp, dhparam, host)
1385    || !init_ecdh(*ctxp, host)
1386    )
1387   return DEFER;
1388
1389 /* Set up certificate and key (and perhaps OCSP info) */
1390
1391 rc = tls_expand_session_files(*ctxp, cbinfo);
1392 if (rc != OK) return rc;
1393
1394 /* If we need to handle SNI, do so */
1395 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
1396 if (host == NULL)               /* server */
1397   {
1398 # ifndef DISABLE_OCSP
1399   /* We check u_ocsp.server.file, not server.response, because we care about if
1400   the option exists, not what the current expansion might be, as SNI might
1401   change the certificate and OCSP file in use between now and the time the
1402   callback is invoked. */
1403   if (cbinfo->u_ocsp.server.file)
1404     {
1405     SSL_CTX_set_tlsext_status_cb(server_ctx, tls_server_stapling_cb);
1406     SSL_CTX_set_tlsext_status_arg(server_ctx, cbinfo);
1407     }
1408 # endif
1409   /* We always do this, so that $tls_sni is available even if not used in
1410   tls_certificate */
1411   SSL_CTX_set_tlsext_servername_callback(*ctxp, tls_servername_cb);
1412   SSL_CTX_set_tlsext_servername_arg(*ctxp, cbinfo);
1413   }
1414 # ifndef DISABLE_OCSP
1415 else                    /* client */
1416   if(ocsp_file)         /* wanting stapling */
1417     {
1418     if (!(cbinfo->u_ocsp.client.verify_store = X509_STORE_new()))
1419       {
1420       DEBUG(D_tls) debug_printf("failed to create store for stapling verify\n");
1421       return FAIL;
1422       }
1423     SSL_CTX_set_tlsext_status_cb(*ctxp, tls_client_stapling_cb);
1424     SSL_CTX_set_tlsext_status_arg(*ctxp, cbinfo);
1425     }
1426 # endif
1427 #endif
1428
1429 cbinfo->verify_cert_hostnames = NULL;
1430
1431 /* Set up the RSA callback */
1432
1433 SSL_CTX_set_tmp_rsa_callback(*ctxp, rsa_callback);
1434
1435 /* Finally, set the timeout, and we are done */
1436
1437 SSL_CTX_set_timeout(*ctxp, ssl_session_timeout);
1438 DEBUG(D_tls) debug_printf("Initialized TLS\n");
1439
1440 *cbp = cbinfo;
1441
1442 return OK;
1443 }
1444
1445
1446
1447
1448 /*************************************************
1449 *           Get name of cipher in use            *
1450 *************************************************/
1451
1452 /*
1453 Argument:   pointer to an SSL structure for the connection
1454             buffer to use for answer
1455             size of buffer
1456             pointer to number of bits for cipher
1457 Returns:    nothing
1458 */
1459
1460 static void
1461 construct_cipher_name(SSL *ssl, uschar *cipherbuf, int bsize, int *bits)
1462 {
1463 /* With OpenSSL 1.0.0a, this needs to be const but the documentation doesn't
1464 yet reflect that.  It should be a safe change anyway, even 0.9.8 versions have
1465 the accessor functions use const in the prototype. */
1466 const SSL_CIPHER *c;
1467 const uschar *ver;
1468
1469 ver = (const uschar *)SSL_get_version(ssl);
1470
1471 c = (const SSL_CIPHER *) SSL_get_current_cipher(ssl);
1472 SSL_CIPHER_get_bits(c, bits);
1473
1474 string_format(cipherbuf, bsize, "%s:%s:%u", ver,
1475   SSL_CIPHER_get_name(c), *bits);
1476
1477 DEBUG(D_tls) debug_printf("Cipher: %s\n", cipherbuf);
1478 }
1479
1480
1481 static void
1482 peer_cert(SSL * ssl, tls_support * tlsp, uschar * peerdn, unsigned bsize)
1483 {
1484 /*XXX we might consider a list-of-certs variable for the cert chain.
1485 SSL_get_peer_cert_chain(SSL*).  We'd need a new variable type and support
1486 in list-handling functions, also consider the difference between the entire
1487 chain and the elements sent by the peer. */
1488
1489 /* Will have already noted peercert on a verify fail; possibly not the leaf */
1490 if (!tlsp->peercert)
1491   tlsp->peercert = SSL_get_peer_certificate(ssl);
1492 /* Beware anonymous ciphers which lead to server_cert being NULL */
1493 if (tlsp->peercert)
1494   {
1495   X509_NAME_oneline(X509_get_subject_name(tlsp->peercert), CS peerdn, bsize);
1496   peerdn[bsize-1] = '\0';
1497   tlsp->peerdn = peerdn;                /*XXX a static buffer... */
1498   }
1499 else
1500   tlsp->peerdn = NULL;
1501 }
1502
1503
1504
1505
1506
1507 /*************************************************
1508 *        Set up for verifying certificates       *
1509 *************************************************/
1510
1511 /* Called by both client and server startup
1512
1513 Arguments:
1514   sctx          SSL_CTX* to initialise
1515   certs         certs file or NULL
1516   crl           CRL file or NULL
1517   host          NULL in a server; the remote host in a client
1518   optional      TRUE if called from a server for a host in tls_try_verify_hosts;
1519                 otherwise passed as FALSE
1520   cert_vfy_cb   Callback function for certificate verification
1521
1522 Returns:        OK/DEFER/FAIL
1523 */
1524
1525 static int
1526 setup_certs(SSL_CTX *sctx, uschar *certs, uschar *crl, host_item *host, BOOL optional,
1527     int (*cert_vfy_cb)(int, X509_STORE_CTX *) )
1528 {
1529 uschar *expcerts, *expcrl;
1530
1531 if (!expand_check(certs, US"tls_verify_certificates", &expcerts))
1532   return DEFER;
1533
1534 if (expcerts != NULL && *expcerts != '\0')
1535   {
1536   if (Ustrcmp(expcerts, "system") == 0)
1537     {
1538     /* Tell the library to use its compiled-in location for the system default
1539     CA bundle, only */
1540
1541     if (!SSL_CTX_set_default_verify_paths(sctx))
1542       return tls_error(US"SSL_CTX_set_default_verify_paths", host, NULL);
1543     }
1544   else
1545     {
1546     struct stat statbuf;
1547
1548     /* Tell the library to use its compiled-in location for the system default
1549     CA bundle. Those given by the exim config are additional to these */
1550
1551     if (!SSL_CTX_set_default_verify_paths(sctx))
1552       return tls_error(US"SSL_CTX_set_default_verify_paths", host, NULL);
1553
1554     if (Ustat(expcerts, &statbuf) < 0)
1555       {
1556       log_write(0, LOG_MAIN|LOG_PANIC,
1557         "failed to stat %s for certificates", expcerts);
1558       return DEFER;
1559       }
1560     else
1561       {
1562       uschar *file, *dir;
1563       if ((statbuf.st_mode & S_IFMT) == S_IFDIR)
1564         { file = NULL; dir = expcerts; }
1565       else
1566         { file = expcerts; dir = NULL; }
1567
1568       /* If a certificate file is empty, the next function fails with an
1569       unhelpful error message. If we skip it, we get the correct behaviour (no
1570       certificates are recognized, but the error message is still misleading (it
1571       says no certificate was supplied.) But this is better. */
1572
1573       if (  (!file || statbuf.st_size > 0)
1574          && !SSL_CTX_load_verify_locations(sctx, CS file, CS dir))
1575         return tls_error(US"SSL_CTX_load_verify_locations", host, NULL);
1576
1577       /* Load the list of CAs for which we will accept certs, for sending
1578       to the client.  This is only for the one-file tls_verify_certificates
1579       variant.
1580       If a list isn't loaded into the server, but
1581       some verify locations are set, the server end appears to make
1582       a wildcard reqest for client certs.
1583       Meanwhile, the client library as deafult behaviour *ignores* the list
1584       we send over the wire - see man SSL_CTX_set_client_cert_cb.
1585       Because of this, and that the dir variant is likely only used for
1586       the public-CA bundle (not for a private CA), not worth fixing.
1587       */
1588       if (file)
1589         {
1590         STACK_OF(X509_NAME) * names = SSL_load_client_CA_file(CS file);
1591
1592         DEBUG(D_tls) debug_printf("Added %d certificate authorities.\n",
1593                                     sk_X509_NAME_num(names));
1594         SSL_CTX_set_client_CA_list(sctx, names);
1595         }
1596       }
1597     }
1598
1599   /* Handle a certificate revocation list. */
1600
1601   #if OPENSSL_VERSION_NUMBER > 0x00907000L
1602
1603   /* This bit of code is now the version supplied by Lars Mainka. (I have
1604    * merely reformatted it into the Exim code style.)
1605
1606    * "From here I changed the code to add support for multiple crl's
1607    * in pem format in one file or to support hashed directory entries in
1608    * pem format instead of a file. This method now uses the library function
1609    * X509_STORE_load_locations to add the CRL location to the SSL context.
1610    * OpenSSL will then handle the verify against CA certs and CRLs by
1611    * itself in the verify callback." */
1612
1613   if (!expand_check(crl, US"tls_crl", &expcrl)) return DEFER;
1614   if (expcrl != NULL && *expcrl != 0)
1615     {
1616     struct stat statbufcrl;
1617     if (Ustat(expcrl, &statbufcrl) < 0)
1618       {
1619       log_write(0, LOG_MAIN|LOG_PANIC,
1620         "failed to stat %s for certificates revocation lists", expcrl);
1621       return DEFER;
1622       }
1623     else
1624       {
1625       /* is it a file or directory? */
1626       uschar *file, *dir;
1627       X509_STORE *cvstore = SSL_CTX_get_cert_store(sctx);
1628       if ((statbufcrl.st_mode & S_IFMT) == S_IFDIR)
1629         {
1630         file = NULL;
1631         dir = expcrl;
1632         DEBUG(D_tls) debug_printf("SSL CRL value is a directory %s\n", dir);
1633         }
1634       else
1635         {
1636         file = expcrl;
1637         dir = NULL;
1638         DEBUG(D_tls) debug_printf("SSL CRL value is a file %s\n", file);
1639         }
1640       if (X509_STORE_load_locations(cvstore, CS file, CS dir) == 0)
1641         return tls_error(US"X509_STORE_load_locations", host, NULL);
1642
1643       /* setting the flags to check against the complete crl chain */
1644
1645       X509_STORE_set_flags(cvstore,
1646         X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
1647       }
1648     }
1649
1650   #endif  /* OPENSSL_VERSION_NUMBER > 0x00907000L */
1651
1652   /* If verification is optional, don't fail if no certificate */
1653
1654   SSL_CTX_set_verify(sctx,
1655     SSL_VERIFY_PEER | (optional? 0 : SSL_VERIFY_FAIL_IF_NO_PEER_CERT),
1656     cert_vfy_cb);
1657   }
1658
1659 return OK;
1660 }
1661
1662
1663
1664 /*************************************************
1665 *       Start a TLS session in a server          *
1666 *************************************************/
1667
1668 /* This is called when Exim is running as a server, after having received
1669 the STARTTLS command. It must respond to that command, and then negotiate
1670 a TLS session.
1671
1672 Arguments:
1673   require_ciphers   allowed ciphers
1674
1675 Returns:            OK on success
1676                     DEFER for errors before the start of the negotiation
1677                     FAIL for errors during the negotation; the server can't
1678                       continue running.
1679 */
1680
1681 int
1682 tls_server_start(const uschar *require_ciphers)
1683 {
1684 int rc;
1685 uschar *expciphers;
1686 tls_ext_ctx_cb *cbinfo;
1687 static uschar peerdn[256];
1688 static uschar cipherbuf[256];
1689
1690 /* Check for previous activation */
1691
1692 if (tls_in.active >= 0)
1693   {
1694   tls_error(US"STARTTLS received after TLS started", NULL, US"");
1695   smtp_printf("554 Already in TLS\r\n");
1696   return FAIL;
1697   }
1698
1699 /* Initialize the SSL library. If it fails, it will already have logged
1700 the error. */
1701
1702 rc = tls_init(&server_ctx, NULL, tls_dhparam, tls_certificate, tls_privatekey,
1703 #ifndef DISABLE_OCSP
1704     tls_ocsp_file,
1705 #endif
1706     NULL, &server_static_cbinfo);
1707 if (rc != OK) return rc;
1708 cbinfo = server_static_cbinfo;
1709
1710 if (!expand_check(require_ciphers, US"tls_require_ciphers", &expciphers))
1711   return FAIL;
1712
1713 /* In OpenSSL, cipher components are separated by hyphens. In GnuTLS, they
1714 were historically separated by underscores. So that I can use either form in my
1715 tests, and also for general convenience, we turn underscores into hyphens here.
1716 */
1717
1718 if (expciphers != NULL)
1719   {
1720   uschar *s = expciphers;
1721   while (*s != 0) { if (*s == '_') *s = '-'; s++; }
1722   DEBUG(D_tls) debug_printf("required ciphers: %s\n", expciphers);
1723   if (!SSL_CTX_set_cipher_list(server_ctx, CS expciphers))
1724     return tls_error(US"SSL_CTX_set_cipher_list", NULL, NULL);
1725   cbinfo->server_cipher_list = expciphers;
1726   }
1727
1728 /* If this is a host for which certificate verification is mandatory or
1729 optional, set up appropriately. */
1730
1731 tls_in.certificate_verified = FALSE;
1732 #ifdef EXPERIMENTAL_DANE
1733 tls_in.dane_verified = FALSE;
1734 #endif
1735 server_verify_callback_called = FALSE;
1736
1737 if (verify_check_host(&tls_verify_hosts) == OK)
1738   {
1739   rc = setup_certs(server_ctx, tls_verify_certificates, tls_crl, NULL,
1740                         FALSE, verify_callback_server);
1741   if (rc != OK) return rc;
1742   server_verify_optional = FALSE;
1743   }
1744 else if (verify_check_host(&tls_try_verify_hosts) == OK)
1745   {
1746   rc = setup_certs(server_ctx, tls_verify_certificates, tls_crl, NULL,
1747                         TRUE, verify_callback_server);
1748   if (rc != OK) return rc;
1749   server_verify_optional = TRUE;
1750   }
1751
1752 /* Prepare for new connection */
1753
1754 if ((server_ssl = SSL_new(server_ctx)) == NULL) return tls_error(US"SSL_new", NULL, NULL);
1755
1756 /* Warning: we used to SSL_clear(ssl) here, it was removed.
1757  *
1758  * With the SSL_clear(), we get strange interoperability bugs with
1759  * OpenSSL 1.0.1b and TLS1.1/1.2.  It looks as though this may be a bug in
1760  * OpenSSL itself, as a clear should not lead to inability to follow protocols.
1761  *
1762  * The SSL_clear() call is to let an existing SSL* be reused, typically after
1763  * session shutdown.  In this case, we have a brand new object and there's no
1764  * obvious reason to immediately clear it.  I'm guessing that this was
1765  * originally added because of incomplete initialisation which the clear fixed,
1766  * in some historic release.
1767  */
1768
1769 /* Set context and tell client to go ahead, except in the case of TLS startup
1770 on connection, where outputting anything now upsets the clients and tends to
1771 make them disconnect. We need to have an explicit fflush() here, to force out
1772 the response. Other smtp_printf() calls do not need it, because in non-TLS
1773 mode, the fflush() happens when smtp_getc() is called. */
1774
1775 SSL_set_session_id_context(server_ssl, sid_ctx, Ustrlen(sid_ctx));
1776 if (!tls_in.on_connect)
1777   {
1778   smtp_printf("220 TLS go ahead\r\n");
1779   fflush(smtp_out);
1780   }
1781
1782 /* Now negotiate the TLS session. We put our own timer on it, since it seems
1783 that the OpenSSL library doesn't. */
1784
1785 SSL_set_wfd(server_ssl, fileno(smtp_out));
1786 SSL_set_rfd(server_ssl, fileno(smtp_in));
1787 SSL_set_accept_state(server_ssl);
1788
1789 DEBUG(D_tls) debug_printf("Calling SSL_accept\n");
1790
1791 sigalrm_seen = FALSE;
1792 if (smtp_receive_timeout > 0) alarm(smtp_receive_timeout);
1793 rc = SSL_accept(server_ssl);
1794 alarm(0);
1795
1796 if (rc <= 0)
1797   {
1798   tls_error(US"SSL_accept", NULL, sigalrm_seen ? US"timed out" : NULL);
1799   if (ERR_get_error() == 0)
1800     log_write(0, LOG_MAIN,
1801         "TLS client disconnected cleanly (rejected our certificate?)");
1802   return FAIL;
1803   }
1804
1805 DEBUG(D_tls) debug_printf("SSL_accept was successful\n");
1806
1807 /* TLS has been set up. Adjust the input functions to read via TLS,
1808 and initialize things. */
1809
1810 peer_cert(server_ssl, &tls_in, peerdn, sizeof(peerdn));
1811
1812 construct_cipher_name(server_ssl, cipherbuf, sizeof(cipherbuf), &tls_in.bits);
1813 tls_in.cipher = cipherbuf;
1814
1815 DEBUG(D_tls)
1816   {
1817   uschar buf[2048];
1818   if (SSL_get_shared_ciphers(server_ssl, CS buf, sizeof(buf)) != NULL)
1819     debug_printf("Shared ciphers: %s\n", buf);
1820   }
1821
1822 /* Record the certificate we presented */
1823   {
1824   X509 * crt = SSL_get_certificate(server_ssl);
1825   tls_in.ourcert = crt ? X509_dup(crt) : NULL;
1826   }
1827
1828 /* Only used by the server-side tls (tls_in), including tls_getc.
1829    Client-side (tls_out) reads (seem to?) go via
1830    smtp_read_response()/ip_recv().
1831    Hence no need to duplicate for _in and _out.
1832  */
1833 ssl_xfer_buffer = store_malloc(ssl_xfer_buffer_size);
1834 ssl_xfer_buffer_lwm = ssl_xfer_buffer_hwm = 0;
1835 ssl_xfer_eof = ssl_xfer_error = 0;
1836
1837 receive_getc = tls_getc;
1838 receive_ungetc = tls_ungetc;
1839 receive_feof = tls_feof;
1840 receive_ferror = tls_ferror;
1841 receive_smtp_buffered = tls_smtp_buffered;
1842
1843 tls_in.active = fileno(smtp_out);
1844 return OK;
1845 }
1846
1847
1848
1849
1850 static int
1851 tls_client_basic_ctx_init(SSL_CTX * ctx,
1852     host_item * host, smtp_transport_options_block * ob, tls_ext_ctx_cb * cbinfo
1853                           )
1854 {
1855 int rc;
1856 /* stick to the old behaviour for compatibility if tls_verify_certificates is
1857    set but both tls_verify_hosts and tls_try_verify_hosts is not set. Check only
1858    the specified host patterns if one of them is defined */
1859
1860 if (  (  !ob->tls_verify_hosts
1861       && (!ob->tls_try_verify_hosts || !*ob->tls_try_verify_hosts)
1862       )
1863    || (verify_check_given_host(&ob->tls_verify_hosts, host) == OK)
1864    )
1865   client_verify_optional = FALSE;
1866 else if (verify_check_given_host(&ob->tls_try_verify_hosts, host) == OK)
1867   client_verify_optional = TRUE;
1868 else
1869   return OK;
1870
1871 if ((rc = setup_certs(ctx, ob->tls_verify_certificates,
1872       ob->tls_crl, host, client_verify_optional, verify_callback_client)) != OK)
1873   return rc;
1874
1875 if (verify_check_given_host(&ob->tls_verify_cert_hostnames, host) == OK)
1876   {
1877   cbinfo->verify_cert_hostnames =
1878 #ifdef SUPPORT_I18N
1879     string_domain_utf8_to_alabel(host->name, NULL);
1880 #else
1881     host->name;
1882 #endif
1883   DEBUG(D_tls) debug_printf("Cert hostname to check: \"%s\"\n",
1884                     cbinfo->verify_cert_hostnames);
1885   }
1886 return OK;
1887 }
1888
1889
1890 #ifdef EXPERIMENTAL_DANE
1891 static int
1892 dane_tlsa_load(SSL * ssl, host_item * host, dns_answer * dnsa)
1893 {
1894 dns_record * rr;
1895 dns_scan dnss;
1896 const char * hostnames[2] = { CS host->name, NULL };
1897 int found = 0;
1898
1899 if (DANESSL_init(ssl, NULL, hostnames) != 1)
1900   return tls_error(US"hostnames load", host, NULL);
1901
1902 for (rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS);
1903      rr;
1904      rr = dns_next_rr(dnsa, &dnss, RESET_NEXT)
1905     ) if (rr->type == T_TLSA)
1906   {
1907   uschar * p = rr->data;
1908   uint8_t usage, selector, mtype;
1909   const char * mdname;
1910
1911   usage = *p++;
1912
1913   /* Only DANE-TA(2) and DANE-EE(3) are supported */
1914   if (usage != 2 && usage != 3) continue;
1915
1916   selector = *p++;
1917   mtype = *p++;
1918
1919   switch (mtype)
1920     {
1921     default: continue;  /* Only match-types 0, 1, 2 are supported */
1922     case 0:  mdname = NULL; break;
1923     case 1:  mdname = "sha256"; break;
1924     case 2:  mdname = "sha512"; break;
1925     }
1926
1927   found++;
1928   switch (DANESSL_add_tlsa(ssl, usage, selector, mdname, p, rr->size - 3))
1929     {
1930     default:
1931     case 0:     /* action not taken */
1932       return tls_error(US"tlsa load", host, NULL);
1933     case 1:     break;
1934     }
1935
1936   tls_out.tlsa_usage |= 1<<usage;
1937   }
1938
1939 if (found)
1940   return OK;
1941
1942 log_write(0, LOG_MAIN, "DANE error: No usable TLSA records");
1943 return DEFER;
1944 }
1945 #endif  /*EXPERIMENTAL_DANE*/
1946
1947
1948
1949 /*************************************************
1950 *    Start a TLS session in a client             *
1951 *************************************************/
1952
1953 /* Called from the smtp transport after STARTTLS has been accepted.
1954
1955 Argument:
1956   fd               the fd of the connection
1957   host             connected host (for messages)
1958   addr             the first address
1959   tb               transport (always smtp)
1960   tlsa_dnsa        tlsa lookup, if DANE, else null
1961
1962 Returns:           OK on success
1963                    FAIL otherwise - note that tls_error() will not give DEFER
1964                      because this is not a server
1965 */
1966
1967 int
1968 tls_client_start(int fd, host_item *host, address_item *addr,
1969   transport_instance *tb
1970 #ifdef EXPERIMENTAL_DANE
1971   , dns_answer * tlsa_dnsa
1972 #endif
1973   )
1974 {
1975 smtp_transport_options_block * ob =
1976   (smtp_transport_options_block *)tb->options_block;
1977 static uschar peerdn[256];
1978 uschar * expciphers;
1979 int rc;
1980 static uschar cipherbuf[256];
1981
1982 #ifndef DISABLE_OCSP
1983 BOOL request_ocsp = FALSE;
1984 BOOL require_ocsp = FALSE;
1985 #endif
1986
1987 #ifdef EXPERIMENTAL_DANE
1988 tls_out.tlsa_usage = 0;
1989 #endif
1990
1991 #ifndef DISABLE_OCSP
1992   {
1993 # ifdef EXPERIMENTAL_DANE
1994   if (  tlsa_dnsa
1995      && ob->hosts_request_ocsp[0] == '*'
1996      && ob->hosts_request_ocsp[1] == '\0'
1997      )
1998     {
1999     /* Unchanged from default.  Use a safer one under DANE */
2000     request_ocsp = TRUE;
2001     ob->hosts_request_ocsp = US"${if or { {= {0}{$tls_out_tlsa_usage}} "
2002                                       "   {= {4}{$tls_out_tlsa_usage}} } "
2003                                  " {*}{}}";
2004     }
2005 # endif
2006
2007   if ((require_ocsp =
2008         verify_check_given_host(&ob->hosts_require_ocsp, host) == OK))
2009     request_ocsp = TRUE;
2010   else
2011 # ifdef EXPERIMENTAL_DANE
2012     if (!request_ocsp)
2013 # endif
2014       request_ocsp =
2015         verify_check_given_host(&ob->hosts_request_ocsp, host) == OK;
2016   }
2017 #endif
2018
2019 rc = tls_init(&client_ctx, host, NULL,
2020     ob->tls_certificate, ob->tls_privatekey,
2021 #ifndef DISABLE_OCSP
2022     (void *)(long)request_ocsp,
2023 #endif
2024     addr, &client_static_cbinfo);
2025 if (rc != OK) return rc;
2026
2027 tls_out.certificate_verified = FALSE;
2028 client_verify_callback_called = FALSE;
2029
2030 if (!expand_check(ob->tls_require_ciphers, US"tls_require_ciphers",
2031     &expciphers))
2032   return FAIL;
2033
2034 /* In OpenSSL, cipher components are separated by hyphens. In GnuTLS, they
2035 are separated by underscores. So that I can use either form in my tests, and
2036 also for general convenience, we turn underscores into hyphens here. */
2037
2038 if (expciphers != NULL)
2039   {
2040   uschar *s = expciphers;
2041   while (*s != 0) { if (*s == '_') *s = '-'; s++; }
2042   DEBUG(D_tls) debug_printf("required ciphers: %s\n", expciphers);
2043   if (!SSL_CTX_set_cipher_list(client_ctx, CS expciphers))
2044     return tls_error(US"SSL_CTX_set_cipher_list", host, NULL);
2045   }
2046
2047 #ifdef EXPERIMENTAL_DANE
2048 if (tlsa_dnsa)
2049   {
2050   SSL_CTX_set_verify(client_ctx,
2051     SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
2052     verify_callback_client_dane);
2053
2054   if (!DANESSL_library_init())
2055     return tls_error(US"library init", host, NULL);
2056   if (DANESSL_CTX_init(client_ctx) <= 0)
2057     return tls_error(US"context init", host, NULL);
2058   }
2059 else
2060
2061 #endif
2062
2063   if ((rc = tls_client_basic_ctx_init(client_ctx, host, ob, client_static_cbinfo))
2064       != OK)
2065     return rc;
2066
2067 if ((client_ssl = SSL_new(client_ctx)) == NULL)
2068   return tls_error(US"SSL_new", host, NULL);
2069 SSL_set_session_id_context(client_ssl, sid_ctx, Ustrlen(sid_ctx));
2070 SSL_set_fd(client_ssl, fd);
2071 SSL_set_connect_state(client_ssl);
2072
2073 if (ob->tls_sni)
2074   {
2075   if (!expand_check(ob->tls_sni, US"tls_sni", &tls_out.sni))
2076     return FAIL;
2077   if (tls_out.sni == NULL)
2078     {
2079     DEBUG(D_tls) debug_printf("Setting TLS SNI forced to fail, not sending\n");
2080     }
2081   else if (!Ustrlen(tls_out.sni))
2082     tls_out.sni = NULL;
2083   else
2084     {
2085 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
2086     DEBUG(D_tls) debug_printf("Setting TLS SNI \"%s\"\n", tls_out.sni);
2087     SSL_set_tlsext_host_name(client_ssl, tls_out.sni);
2088 #else
2089     DEBUG(D_tls)
2090       debug_printf("OpenSSL at build-time lacked SNI support, ignoring \"%s\"\n",
2091           tls_out.sni);
2092 #endif
2093     }
2094   }
2095
2096 #ifdef EXPERIMENTAL_DANE
2097 if (tlsa_dnsa)
2098   if ((rc = dane_tlsa_load(client_ssl, host, tlsa_dnsa)) != OK)
2099     return rc;
2100 #endif
2101
2102 #ifndef DISABLE_OCSP
2103 /* Request certificate status at connection-time.  If the server
2104 does OCSP stapling we will get the callback (set in tls_init()) */
2105 # ifdef EXPERIMENTAL_DANE
2106 if (request_ocsp)
2107   {
2108   const uschar * s;
2109   if (  ((s = ob->hosts_require_ocsp) && Ustrstr(s, US"tls_out_tlsa_usage"))
2110      || ((s = ob->hosts_request_ocsp) && Ustrstr(s, US"tls_out_tlsa_usage"))
2111      )
2112     {   /* Re-eval now $tls_out_tlsa_usage is populated.  If
2113         this means we avoid the OCSP request, we wasted the setup
2114         cost in tls_init(). */
2115     require_ocsp = verify_check_given_host(&ob->hosts_require_ocsp, host) == OK;
2116     request_ocsp = require_ocsp
2117       || verify_check_given_host(&ob->hosts_request_ocsp, host) == OK;
2118     }
2119   }
2120 # endif
2121
2122 if (request_ocsp)
2123   {
2124   SSL_set_tlsext_status_type(client_ssl, TLSEXT_STATUSTYPE_ocsp);
2125   client_static_cbinfo->u_ocsp.client.verify_required = require_ocsp;
2126   tls_out.ocsp = OCSP_NOT_RESP;
2127   }
2128 #endif
2129
2130 #ifndef DISABLE_EVENT
2131 client_static_cbinfo->event_action = tb->event_action;
2132 #endif
2133
2134 /* There doesn't seem to be a built-in timeout on connection. */
2135
2136 DEBUG(D_tls) debug_printf("Calling SSL_connect\n");
2137 sigalrm_seen = FALSE;
2138 alarm(ob->command_timeout);
2139 rc = SSL_connect(client_ssl);
2140 alarm(0);
2141
2142 #ifdef EXPERIMENTAL_DANE
2143 if (tlsa_dnsa)
2144   DANESSL_cleanup(client_ssl);
2145 #endif
2146
2147 if (rc <= 0)
2148   return tls_error(US"SSL_connect", host, sigalrm_seen ? US"timed out" : NULL);
2149
2150 DEBUG(D_tls) debug_printf("SSL_connect succeeded\n");
2151
2152 peer_cert(client_ssl, &tls_out, peerdn, sizeof(peerdn));
2153
2154 construct_cipher_name(client_ssl, cipherbuf, sizeof(cipherbuf), &tls_out.bits);
2155 tls_out.cipher = cipherbuf;
2156
2157 /* Record the certificate we presented */
2158   {
2159   X509 * crt = SSL_get_certificate(client_ssl);
2160   tls_out.ourcert = crt ? X509_dup(crt) : NULL;
2161   }
2162
2163 tls_out.active = fd;
2164 return OK;
2165 }
2166
2167
2168
2169
2170
2171 /*************************************************
2172 *            TLS version of getc                 *
2173 *************************************************/
2174
2175 /* This gets the next byte from the TLS input buffer. If the buffer is empty,
2176 it refills the buffer via the SSL reading function.
2177
2178 Arguments:  none
2179 Returns:    the next character or EOF
2180
2181 Only used by the server-side TLS.
2182 */
2183
2184 int
2185 tls_getc(void)
2186 {
2187 if (ssl_xfer_buffer_lwm >= ssl_xfer_buffer_hwm)
2188   {
2189   int error;
2190   int inbytes;
2191
2192   DEBUG(D_tls) debug_printf("Calling SSL_read(%p, %p, %u)\n", server_ssl,
2193     ssl_xfer_buffer, ssl_xfer_buffer_size);
2194
2195   if (smtp_receive_timeout > 0) alarm(smtp_receive_timeout);
2196   inbytes = SSL_read(server_ssl, CS ssl_xfer_buffer, ssl_xfer_buffer_size);
2197   error = SSL_get_error(server_ssl, inbytes);
2198   alarm(0);
2199
2200   /* SSL_ERROR_ZERO_RETURN appears to mean that the SSL session has been
2201   closed down, not that the socket itself has been closed down. Revert to
2202   non-SSL handling. */
2203
2204   if (error == SSL_ERROR_ZERO_RETURN)
2205     {
2206     DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
2207
2208     receive_getc = smtp_getc;
2209     receive_ungetc = smtp_ungetc;
2210     receive_feof = smtp_feof;
2211     receive_ferror = smtp_ferror;
2212     receive_smtp_buffered = smtp_buffered;
2213
2214     SSL_free(server_ssl);
2215     server_ssl = NULL;
2216     tls_in.active = -1;
2217     tls_in.bits = 0;
2218     tls_in.cipher = NULL;
2219     tls_in.peerdn = NULL;
2220     tls_in.sni = NULL;
2221
2222     return smtp_getc();
2223     }
2224
2225   /* Handle genuine errors */
2226
2227   else if (error == SSL_ERROR_SSL)
2228     {
2229     ERR_error_string(ERR_get_error(), ssl_errstring);
2230     log_write(0, LOG_MAIN, "TLS error (SSL_read): %s", ssl_errstring);
2231     ssl_xfer_error = 1;
2232     return EOF;
2233     }
2234
2235   else if (error != SSL_ERROR_NONE)
2236     {
2237     DEBUG(D_tls) debug_printf("Got SSL error %d\n", error);
2238     ssl_xfer_error = 1;
2239     return EOF;
2240     }
2241
2242 #ifndef DISABLE_DKIM
2243   dkim_exim_verify_feed(ssl_xfer_buffer, inbytes);
2244 #endif
2245   ssl_xfer_buffer_hwm = inbytes;
2246   ssl_xfer_buffer_lwm = 0;
2247   }
2248
2249 /* Something in the buffer; return next uschar */
2250
2251 return ssl_xfer_buffer[ssl_xfer_buffer_lwm++];
2252 }
2253
2254
2255
2256 /*************************************************
2257 *          Read bytes from TLS channel           *
2258 *************************************************/
2259
2260 /*
2261 Arguments:
2262   buff      buffer of data
2263   len       size of buffer
2264
2265 Returns:    the number of bytes read
2266             -1 after a failed read
2267
2268 Only used by the client-side TLS.
2269 */
2270
2271 int
2272 tls_read(BOOL is_server, uschar *buff, size_t len)
2273 {
2274 SSL *ssl = is_server ? server_ssl : client_ssl;
2275 int inbytes;
2276 int error;
2277
2278 DEBUG(D_tls) debug_printf("Calling SSL_read(%p, %p, %u)\n", ssl,
2279   buff, (unsigned int)len);
2280
2281 inbytes = SSL_read(ssl, CS buff, len);
2282 error = SSL_get_error(ssl, inbytes);
2283
2284 if (error == SSL_ERROR_ZERO_RETURN)
2285   {
2286   DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
2287   return -1;
2288   }
2289 else if (error != SSL_ERROR_NONE)
2290   {
2291   return -1;
2292   }
2293
2294 return inbytes;
2295 }
2296
2297
2298
2299
2300
2301 /*************************************************
2302 *         Write bytes down TLS channel           *
2303 *************************************************/
2304
2305 /*
2306 Arguments:
2307   is_server channel specifier
2308   buff      buffer of data
2309   len       number of bytes
2310
2311 Returns:    the number of bytes after a successful write,
2312             -1 after a failed write
2313
2314 Used by both server-side and client-side TLS.
2315 */
2316
2317 int
2318 tls_write(BOOL is_server, const uschar *buff, size_t len)
2319 {
2320 int outbytes;
2321 int error;
2322 int left = len;
2323 SSL *ssl = is_server ? server_ssl : client_ssl;
2324
2325 DEBUG(D_tls) debug_printf("tls_do_write(%p, %d)\n", buff, left);
2326 while (left > 0)
2327   {
2328   DEBUG(D_tls) debug_printf("SSL_write(SSL, %p, %d)\n", buff, left);
2329   outbytes = SSL_write(ssl, CS buff, left);
2330   error = SSL_get_error(ssl, outbytes);
2331   DEBUG(D_tls) debug_printf("outbytes=%d error=%d\n", outbytes, error);
2332   switch (error)
2333     {
2334     case SSL_ERROR_SSL:
2335     ERR_error_string(ERR_get_error(), ssl_errstring);
2336     log_write(0, LOG_MAIN, "TLS error (SSL_write): %s", ssl_errstring);
2337     return -1;
2338
2339     case SSL_ERROR_NONE:
2340     left -= outbytes;
2341     buff += outbytes;
2342     break;
2343
2344     case SSL_ERROR_ZERO_RETURN:
2345     log_write(0, LOG_MAIN, "SSL channel closed on write");
2346     return -1;
2347
2348     case SSL_ERROR_SYSCALL:
2349     log_write(0, LOG_MAIN, "SSL_write: (from %s) syscall: %s",
2350       sender_fullhost ? sender_fullhost : US"<unknown>",
2351       strerror(errno));
2352
2353     default:
2354     log_write(0, LOG_MAIN, "SSL_write error %d", error);
2355     return -1;
2356     }
2357   }
2358 return len;
2359 }
2360
2361
2362
2363 /*************************************************
2364 *         Close down a TLS session               *
2365 *************************************************/
2366
2367 /* This is also called from within a delivery subprocess forked from the
2368 daemon, to shut down the TLS library, without actually doing a shutdown (which
2369 would tamper with the SSL session in the parent process).
2370
2371 Arguments:   TRUE if SSL_shutdown is to be called
2372 Returns:     nothing
2373
2374 Used by both server-side and client-side TLS.
2375 */
2376
2377 void
2378 tls_close(BOOL is_server, BOOL shutdown)
2379 {
2380 SSL **sslp = is_server ? &server_ssl : &client_ssl;
2381 int *fdp = is_server ? &tls_in.active : &tls_out.active;
2382
2383 if (*fdp < 0) return;  /* TLS was not active */
2384
2385 if (shutdown)
2386   {
2387   DEBUG(D_tls) debug_printf("tls_close(): shutting down SSL\n");
2388   SSL_shutdown(*sslp);
2389   }
2390
2391 SSL_free(*sslp);
2392 *sslp = NULL;
2393
2394 *fdp = -1;
2395 }
2396
2397
2398
2399
2400 /*************************************************
2401 *  Let tls_require_ciphers be checked at startup *
2402 *************************************************/
2403
2404 /* The tls_require_ciphers option, if set, must be something which the
2405 library can parse.
2406
2407 Returns:     NULL on success, or error message
2408 */
2409
2410 uschar *
2411 tls_validate_require_cipher(void)
2412 {
2413 SSL_CTX *ctx;
2414 uschar *s, *expciphers, *err;
2415
2416 /* this duplicates from tls_init(), we need a better "init just global
2417 state, for no specific purpose" singleton function of our own */
2418
2419 SSL_load_error_strings();
2420 OpenSSL_add_ssl_algorithms();
2421 #if (OPENSSL_VERSION_NUMBER >= 0x0090800fL) && !defined(OPENSSL_NO_SHA256)
2422 /* SHA256 is becoming ever more popular. This makes sure it gets added to the
2423 list of available digests. */
2424 EVP_add_digest(EVP_sha256());
2425 #endif
2426
2427 if (!(tls_require_ciphers && *tls_require_ciphers))
2428   return NULL;
2429
2430 if (!expand_check(tls_require_ciphers, US"tls_require_ciphers", &expciphers))
2431   return US"failed to expand tls_require_ciphers";
2432
2433 if (!(expciphers && *expciphers))
2434   return NULL;
2435
2436 /* normalisation ripped from above */
2437 s = expciphers;
2438 while (*s != 0) { if (*s == '_') *s = '-'; s++; }
2439
2440 err = NULL;
2441
2442 ctx = SSL_CTX_new(SSLv23_server_method());
2443 if (!ctx)
2444   {
2445   ERR_error_string(ERR_get_error(), ssl_errstring);
2446   return string_sprintf("SSL_CTX_new() failed: %s", ssl_errstring);
2447   }
2448
2449 DEBUG(D_tls)
2450   debug_printf("tls_require_ciphers expands to \"%s\"\n", expciphers);
2451
2452 if (!SSL_CTX_set_cipher_list(ctx, CS expciphers))
2453   {
2454   ERR_error_string(ERR_get_error(), ssl_errstring);
2455   err = string_sprintf("SSL_CTX_set_cipher_list(%s) failed", expciphers);
2456   }
2457
2458 SSL_CTX_free(ctx);
2459
2460 return err;
2461 }
2462
2463
2464
2465
2466 /*************************************************
2467 *         Report the library versions.           *
2468 *************************************************/
2469
2470 /* There have historically been some issues with binary compatibility in
2471 OpenSSL libraries; if Exim (like many other applications) is built against
2472 one version of OpenSSL but the run-time linker picks up another version,
2473 it can result in serious failures, including crashing with a SIGSEGV.  So
2474 report the version found by the compiler and the run-time version.
2475
2476 Note: some OS vendors backport security fixes without changing the version
2477 number/string, and the version date remains unchanged.  The _build_ date
2478 will change, so we can more usefully assist with version diagnosis by also
2479 reporting the build date.
2480
2481 Arguments:   a FILE* to print the results to
2482 Returns:     nothing
2483 */
2484
2485 void
2486 tls_version_report(FILE *f)
2487 {
2488 fprintf(f, "Library version: OpenSSL: Compile: %s\n"
2489            "                          Runtime: %s\n"
2490            "                                 : %s\n",
2491            OPENSSL_VERSION_TEXT,
2492            SSLeay_version(SSLEAY_VERSION),
2493            SSLeay_version(SSLEAY_BUILT_ON));
2494 /* third line is 38 characters for the %s and the line is 73 chars long;
2495 the OpenSSL output includes a "built on: " prefix already. */
2496 }
2497
2498
2499
2500
2501 /*************************************************
2502 *            Random number generation            *
2503 *************************************************/
2504
2505 /* Pseudo-random number generation.  The result is not expected to be
2506 cryptographically strong but not so weak that someone will shoot themselves
2507 in the foot using it as a nonce in input in some email header scheme or
2508 whatever weirdness they'll twist this into.  The result should handle fork()
2509 and avoid repeating sequences.  OpenSSL handles that for us.
2510
2511 Arguments:
2512   max       range maximum
2513 Returns     a random number in range [0, max-1]
2514 */
2515
2516 int
2517 vaguely_random_number(int max)
2518 {
2519 unsigned int r;
2520 int i, needed_len;
2521 static pid_t pidlast = 0;
2522 pid_t pidnow;
2523 uschar *p;
2524 uschar smallbuf[sizeof(r)];
2525
2526 if (max <= 1)
2527   return 0;
2528
2529 pidnow = getpid();
2530 if (pidnow != pidlast)
2531   {
2532   /* Although OpenSSL documents that "OpenSSL makes sure that the PRNG state
2533   is unique for each thread", this doesn't apparently apply across processes,
2534   so our own warning from vaguely_random_number_fallback() applies here too.
2535   Fix per PostgreSQL. */
2536   if (pidlast != 0)
2537     RAND_cleanup();
2538   pidlast = pidnow;
2539   }
2540
2541 /* OpenSSL auto-seeds from /dev/random, etc, but this a double-check. */
2542 if (!RAND_status())
2543   {
2544   randstuff r;
2545   gettimeofday(&r.tv, NULL);
2546   r.p = getpid();
2547
2548   RAND_seed((uschar *)(&r), sizeof(r));
2549   }
2550 /* We're after pseudo-random, not random; if we still don't have enough data
2551 in the internal PRNG then our options are limited.  We could sleep and hope
2552 for entropy to come along (prayer technique) but if the system is so depleted
2553 in the first place then something is likely to just keep taking it.  Instead,
2554 we'll just take whatever little bit of pseudo-random we can still manage to
2555 get. */
2556
2557 needed_len = sizeof(r);
2558 /* Don't take 8 times more entropy than needed if int is 8 octets and we were
2559 asked for a number less than 10. */
2560 for (r = max, i = 0; r; ++i)
2561   r >>= 1;
2562 i = (i + 7) / 8;
2563 if (i < needed_len)
2564   needed_len = i;
2565
2566 /* We do not care if crypto-strong */
2567 i = RAND_pseudo_bytes(smallbuf, needed_len);
2568 if (i < 0)
2569   {
2570   DEBUG(D_all)
2571     debug_printf("OpenSSL RAND_pseudo_bytes() not supported by RAND method, using fallback.\n");
2572   return vaguely_random_number_fallback(max);
2573   }
2574
2575 r = 0;
2576 for (p = smallbuf; needed_len; --needed_len, ++p)
2577   {
2578   r *= 256;
2579   r += *p;
2580   }
2581
2582 /* We don't particularly care about weighted results; if someone wants
2583 smooth distribution and cares enough then they should submit a patch then. */
2584 return r % max;
2585 }
2586
2587
2588
2589
2590 /*************************************************
2591 *        OpenSSL option parse                    *
2592 *************************************************/
2593
2594 /* Parse one option for tls_openssl_options_parse below
2595
2596 Arguments:
2597   name    one option name
2598   value   place to store a value for it
2599 Returns   success or failure in parsing
2600 */
2601
2602 struct exim_openssl_option {
2603   uschar *name;
2604   long    value;
2605 };
2606 /* We could use a macro to expand, but we need the ifdef and not all the
2607 options document which version they were introduced in.  Policylet: include
2608 all options unless explicitly for DTLS, let the administrator choose which
2609 to apply.
2610
2611 This list is current as of:
2612   ==>  1.0.1b  <==
2613 Plus SSL_OP_SAFARI_ECDHE_ECDSA_BUG from 2013-June patch/discussion on openssl-dev
2614 */
2615 static struct exim_openssl_option exim_openssl_options[] = {
2616 /* KEEP SORTED ALPHABETICALLY! */
2617 #ifdef SSL_OP_ALL
2618   { US"all", SSL_OP_ALL },
2619 #endif
2620 #ifdef SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION
2621   { US"allow_unsafe_legacy_renegotiation", SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION },
2622 #endif
2623 #ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
2624   { US"cipher_server_preference", SSL_OP_CIPHER_SERVER_PREFERENCE },
2625 #endif
2626 #ifdef SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS
2627   { US"dont_insert_empty_fragments", SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS },
2628 #endif
2629 #ifdef SSL_OP_EPHEMERAL_RSA
2630   { US"ephemeral_rsa", SSL_OP_EPHEMERAL_RSA },
2631 #endif
2632 #ifdef SSL_OP_LEGACY_SERVER_CONNECT
2633   { US"legacy_server_connect", SSL_OP_LEGACY_SERVER_CONNECT },
2634 #endif
2635 #ifdef SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
2636   { US"microsoft_big_sslv3_buffer", SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER },
2637 #endif
2638 #ifdef SSL_OP_MICROSOFT_SESS_ID_BUG
2639   { US"microsoft_sess_id_bug", SSL_OP_MICROSOFT_SESS_ID_BUG },
2640 #endif
2641 #ifdef SSL_OP_MSIE_SSLV2_RSA_PADDING
2642   { US"msie_sslv2_rsa_padding", SSL_OP_MSIE_SSLV2_RSA_PADDING },
2643 #endif
2644 #ifdef SSL_OP_NETSCAPE_CHALLENGE_BUG
2645   { US"netscape_challenge_bug", SSL_OP_NETSCAPE_CHALLENGE_BUG },
2646 #endif
2647 #ifdef SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
2648   { US"netscape_reuse_cipher_change_bug", SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG },
2649 #endif
2650 #ifdef SSL_OP_NO_COMPRESSION
2651   { US"no_compression", SSL_OP_NO_COMPRESSION },
2652 #endif
2653 #ifdef SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
2654   { US"no_session_resumption_on_renegotiation", SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION },
2655 #endif
2656 #ifdef SSL_OP_NO_SSLv2
2657   { US"no_sslv2", SSL_OP_NO_SSLv2 },
2658 #endif
2659 #ifdef SSL_OP_NO_SSLv3
2660   { US"no_sslv3", SSL_OP_NO_SSLv3 },
2661 #endif
2662 #ifdef SSL_OP_NO_TICKET
2663   { US"no_ticket", SSL_OP_NO_TICKET },
2664 #endif
2665 #ifdef SSL_OP_NO_TLSv1
2666   { US"no_tlsv1", SSL_OP_NO_TLSv1 },
2667 #endif
2668 #ifdef SSL_OP_NO_TLSv1_1
2669 #if SSL_OP_NO_TLSv1_1 == 0x00000400L
2670   /* Error in chosen value in 1.0.1a; see first item in CHANGES for 1.0.1b */
2671 #warning OpenSSL 1.0.1a uses a bad value for SSL_OP_NO_TLSv1_1, ignoring
2672 #else
2673   { US"no_tlsv1_1", SSL_OP_NO_TLSv1_1 },
2674 #endif
2675 #endif
2676 #ifdef SSL_OP_NO_TLSv1_2
2677   { US"no_tlsv1_2", SSL_OP_NO_TLSv1_2 },
2678 #endif
2679 #ifdef SSL_OP_SAFARI_ECDHE_ECDSA_BUG
2680   { US"safari_ecdhe_ecdsa_bug", SSL_OP_SAFARI_ECDHE_ECDSA_BUG },
2681 #endif
2682 #ifdef SSL_OP_SINGLE_DH_USE
2683   { US"single_dh_use", SSL_OP_SINGLE_DH_USE },
2684 #endif
2685 #ifdef SSL_OP_SINGLE_ECDH_USE
2686   { US"single_ecdh_use", SSL_OP_SINGLE_ECDH_USE },
2687 #endif
2688 #ifdef SSL_OP_SSLEAY_080_CLIENT_DH_BUG
2689   { US"ssleay_080_client_dh_bug", SSL_OP_SSLEAY_080_CLIENT_DH_BUG },
2690 #endif
2691 #ifdef SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
2692   { US"sslref2_reuse_cert_type_bug", SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG },
2693 #endif
2694 #ifdef SSL_OP_TLS_BLOCK_PADDING_BUG
2695   { US"tls_block_padding_bug", SSL_OP_TLS_BLOCK_PADDING_BUG },
2696 #endif
2697 #ifdef SSL_OP_TLS_D5_BUG
2698   { US"tls_d5_bug", SSL_OP_TLS_D5_BUG },
2699 #endif
2700 #ifdef SSL_OP_TLS_ROLLBACK_BUG
2701   { US"tls_rollback_bug", SSL_OP_TLS_ROLLBACK_BUG },
2702 #endif
2703 };
2704 static int exim_openssl_options_size =
2705   sizeof(exim_openssl_options)/sizeof(struct exim_openssl_option);
2706
2707
2708 static BOOL
2709 tls_openssl_one_option_parse(uschar *name, long *value)
2710 {
2711 int first = 0;
2712 int last = exim_openssl_options_size;
2713 while (last > first)
2714   {
2715   int middle = (first + last)/2;
2716   int c = Ustrcmp(name, exim_openssl_options[middle].name);
2717   if (c == 0)
2718     {
2719     *value = exim_openssl_options[middle].value;
2720     return TRUE;
2721     }
2722   else if (c > 0)
2723     first = middle + 1;
2724   else
2725     last = middle;
2726   }
2727 return FALSE;
2728 }
2729
2730
2731
2732
2733 /*************************************************
2734 *        OpenSSL option parsing logic            *
2735 *************************************************/
2736
2737 /* OpenSSL has a number of compatibility options which an administrator might
2738 reasonably wish to set.  Interpret a list similarly to decode_bits(), so that
2739 we look like log_selector.
2740
2741 Arguments:
2742   option_spec  the administrator-supplied string of options
2743   results      ptr to long storage for the options bitmap
2744 Returns        success or failure
2745 */
2746
2747 BOOL
2748 tls_openssl_options_parse(uschar *option_spec, long *results)
2749 {
2750 long result, item;
2751 uschar *s, *end;
2752 uschar keep_c;
2753 BOOL adding, item_parsed;
2754
2755 result = 0L;
2756 /* Prior to 4.80 we or'd in SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS; removed
2757  * from default because it increases BEAST susceptibility. */
2758 #ifdef SSL_OP_NO_SSLv2
2759 result |= SSL_OP_NO_SSLv2;
2760 #endif
2761
2762 if (option_spec == NULL)
2763   {
2764   *results = result;
2765   return TRUE;
2766   }
2767
2768 for (s=option_spec; *s != '\0'; /**/)
2769   {
2770   while (isspace(*s)) ++s;
2771   if (*s == '\0')
2772     break;
2773   if (*s != '+' && *s != '-')
2774     {
2775     DEBUG(D_tls) debug_printf("malformed openssl option setting: "
2776         "+ or - expected but found \"%s\"\n", s);
2777     return FALSE;
2778     }
2779   adding = *s++ == '+';
2780   for (end = s; (*end != '\0') && !isspace(*end); ++end) /**/ ;
2781   keep_c = *end;
2782   *end = '\0';
2783   item_parsed = tls_openssl_one_option_parse(s, &item);
2784   if (!item_parsed)
2785     {
2786     DEBUG(D_tls) debug_printf("openssl option setting unrecognised: \"%s\"\n", s);
2787     return FALSE;
2788     }
2789   DEBUG(D_tls) debug_printf("openssl option, %s from %lx: %lx (%s)\n",
2790       adding ? "adding" : "removing", result, item, s);
2791   if (adding)
2792     result |= item;
2793   else
2794     result &= ~item;
2795   *end = keep_c;
2796   s = end;
2797   }
2798
2799 *results = result;
2800 return TRUE;
2801 }
2802
2803 /* vi: aw ai sw=2
2804 */
2805 /* End of tls-openssl.c */