src/src/tls-openssl.c

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