1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Portions Copyright (c) The OpenSSL Project 1999 */
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.
15 No cryptographic code is included in Exim. All this module does is to call
16 functions from the OpenSSL library. */
21 #include <openssl/lhash.h>
22 #include <openssl/ssl.h>
23 #include <openssl/err.h>
24 #include <openssl/rand.h>
26 # include <openssl/ocsp.h>
28 #ifdef EXPERIMENTAL_DANE
34 # define EXIM_OCSP_SKEW_SECONDS (300L)
35 # define EXIM_OCSP_MAX_AGE (-1L)
38 #if OPENSSL_VERSION_NUMBER >= 0x0090806fL && !defined(OPENSSL_NO_TLSEXT)
39 # define EXIM_HAVE_OPENSSL_TLSEXT
42 #if !defined(EXIM_HAVE_OPENSSL_TLSEXT) && !defined(DISABLE_OCSP)
43 # warning "OpenSSL library version too old; define DISABLE_OCSP in Makefile"
47 /* Structure for collecting random data for seeding. */
49 typedef struct randstuff {
54 /* Local static variables */
56 static BOOL client_verify_callback_called = FALSE;
57 static BOOL server_verify_callback_called = FALSE;
58 static const uschar *sid_ctx = US"exim";
60 /* We have three different contexts to care about.
62 Simple case: client, `client_ctx`
63 As a client, we can be doing a callout or cut-through delivery while receiving
64 a message. So we have a client context, which should have options initialised
65 from the SMTP Transport.
68 There are two cases: with and without ServerNameIndication from the client.
69 Given TLS SNI, we can be using different keys, certs and various other
70 configuration settings, because they're re-expanded with $tls_sni set. This
71 allows vhosting with TLS. This SNI is sent in the handshake.
72 A client might not send SNI, so we need a fallback, and an initial setup too.
73 So as a server, we start out using `server_ctx`.
74 If SNI is sent by the client, then we as server, mid-negotiation, try to clone
75 `server_sni` from `server_ctx` and then initialise settings by re-expanding
79 static SSL_CTX *client_ctx = NULL;
80 static SSL_CTX *server_ctx = NULL;
81 static SSL *client_ssl = NULL;
82 static SSL *server_ssl = NULL;
84 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
85 static SSL_CTX *server_sni = NULL;
88 static char ssl_errstring[256];
90 static int ssl_session_timeout = 200;
91 static BOOL client_verify_optional = FALSE;
92 static BOOL server_verify_optional = FALSE;
94 static BOOL reexpand_tls_files_for_sni = FALSE;
97 typedef struct tls_ext_ctx_cb {
105 uschar *file_expanded;
106 OCSP_RESPONSE *response;
109 X509_STORE *verify_store; /* non-null if status requested */
110 BOOL verify_required;
115 /* these are cached from first expand */
116 uschar *server_cipher_list;
117 /* only passed down to tls_error: */
120 #ifdef EXPERIMENTAL_CERTNAMES
121 uschar * verify_cert_hostnames;
125 /* should figure out a cleanup of API to handle state preserved per
126 implementation, for various reasons, which can be void * in the APIs.
127 For now, we hack around it. */
128 tls_ext_ctx_cb *client_static_cbinfo = NULL;
129 tls_ext_ctx_cb *server_static_cbinfo = NULL;
132 setup_certs(SSL_CTX *sctx, uschar *certs, uschar *crl, host_item *host, BOOL optional,
133 int (*cert_vfy_cb)(int, X509_STORE_CTX *) );
136 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
137 static int tls_servername_cb(SSL *s, int *ad ARG_UNUSED, void *arg);
140 static int tls_server_stapling_cb(SSL *s, void *arg);
144 /*************************************************
146 *************************************************/
148 /* Called from lots of places when errors occur before actually starting to do
149 the TLS handshake, that is, while the session is still in clear. Always returns
150 DEFER for a server and FAIL for a client so that most calls can use "return
151 tls_error(...)" to do this processing and then give an appropriate return. A
152 single function is used for both server and client, because it is called from
153 some shared functions.
156 prefix text to include in the logged error
157 host NULL if setting up a server;
158 the connected host if setting up a client
159 msg error message or NULL if we should ask OpenSSL
161 Returns: OK/DEFER/FAIL
165 tls_error(uschar *prefix, host_item *host, uschar *msg)
169 ERR_error_string(ERR_get_error(), ssl_errstring);
170 msg = (uschar *)ssl_errstring;
175 uschar *conn_info = smtp_get_connection_info();
176 if (Ustrncmp(conn_info, US"SMTP ", 5) == 0)
178 log_write(0, LOG_MAIN, "TLS error on %s (%s): %s",
179 conn_info, prefix, msg);
184 log_write(0, LOG_MAIN, "TLS error on connection to %s [%s] (%s): %s",
185 host->name, host->address, prefix, msg);
192 /*************************************************
193 * Callback to generate RSA key *
194 *************************************************/
202 Returns: pointer to generated key
206 rsa_callback(SSL *s, int export, int keylength)
209 export = export; /* Shut picky compilers up */
210 DEBUG(D_tls) debug_printf("Generating %d bit RSA key...\n", keylength);
211 rsa_key = RSA_generate_key(keylength, RSA_F4, NULL, NULL);
214 ERR_error_string(ERR_get_error(), ssl_errstring);
215 log_write(0, LOG_MAIN|LOG_PANIC, "TLS error (RSA_generate_key): %s",
227 x509_store_dump_cert_s_names(X509_STORE * store)
229 STACK_OF(X509_OBJECT) * roots= store->objs;
231 static uschar name[256];
233 for(i= 0; i<sk_X509_OBJECT_num(roots); i++)
235 X509_OBJECT * tmp_obj= sk_X509_OBJECT_value(roots, i);
236 if(tmp_obj->type == X509_LU_X509)
238 X509 * current_cert= tmp_obj->data.x509;
239 X509_NAME_oneline(X509_get_subject_name(current_cert), CS name, sizeof(name));
240 debug_printf(" %s\n", name);
248 /*************************************************
249 * Callback for verification *
250 *************************************************/
252 /* The SSL library does certificate verification if set up to do so. This
253 callback has the current yes/no state is in "state". If verification succeeded,
254 we set up the tls_peerdn string. If verification failed, what happens depends
255 on whether the client is required to present a verifiable certificate or not.
257 If verification is optional, we change the state to yes, but still log the
258 verification error. For some reason (it really would help to have proper
259 documentation of OpenSSL), this callback function then gets called again, this
260 time with state = 1. In fact, that's useful, because we can set up the peerdn
261 value, but we must take care not to set the private verified flag on the second
264 Note: this function is not called if the client fails to present a certificate
265 when asked. We get here only if a certificate has been received. Handling of
266 optional verification for this case is done when requesting SSL to verify, by
267 setting SSL_VERIFY_FAIL_IF_NO_PEER_CERT in the non-optional case.
270 state current yes/no state as 1/0
271 x509ctx certificate information.
272 client TRUE for client startup, FALSE for server startup
274 Returns: 1 if verified, 0 if not
278 verify_callback(int state, X509_STORE_CTX *x509ctx,
279 tls_support *tlsp, BOOL *calledp, BOOL *optionalp)
281 X509 * cert = X509_STORE_CTX_get_current_cert(x509ctx);
282 static uschar txt[256];
284 X509_NAME_oneline(X509_get_subject_name(cert), CS txt, sizeof(txt));
288 log_write(0, LOG_MAIN, "SSL verify error: depth=%d error=%s cert=%s",
289 X509_STORE_CTX_get_error_depth(x509ctx),
290 X509_verify_cert_error_string(X509_STORE_CTX_get_error(x509ctx)),
292 tlsp->certificate_verified = FALSE;
296 tlsp->peercert = X509_dup(cert);
297 return 0; /* reject */
299 DEBUG(D_tls) debug_printf("SSL verify failure overridden (host in "
300 "tls_try_verify_hosts)\n");
303 else if (X509_STORE_CTX_get_error_depth(x509ctx) != 0)
305 DEBUG(D_tls) debug_printf("SSL verify ok: depth=%d SN=%s\n",
306 X509_STORE_CTX_get_error_depth(x509ctx), txt);
308 if (tlsp == &tls_out && client_static_cbinfo->u_ocsp.client.verify_store)
309 { /* client, wanting stapling */
310 /* Add the server cert's signing chain as the one
311 for the verification of the OCSP stapled information. */
313 if (!X509_STORE_add_cert(client_static_cbinfo->u_ocsp.client.verify_store,
321 #ifdef EXPERIMENTAL_CERTNAMES
322 uschar * verify_cert_hostnames;
326 tlsp->peercert = X509_dup(cert);
328 #ifdef EXPERIMENTAL_CERTNAMES
329 if ( tlsp == &tls_out
330 && ((verify_cert_hostnames = client_static_cbinfo->verify_cert_hostnames)))
331 /* client, wanting hostname check */
333 # if OPENSSL_VERSION_NUMBER >= 0x010100000L || OPENSSL_VERSION_NUMBER >= 0x010002000L
334 # ifndef X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS
335 # define X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS 0
339 uschar * list = verify_cert_hostnames;
342 while ((name = string_nextinlist(&list, &sep, NULL, 0)))
343 if ((rc = X509_check_host(cert, name, 0,
344 X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS)))
348 log_write(0, LOG_MAIN, "SSL verify error: internal error\n");
355 log_write(0, LOG_MAIN,
356 "SSL verify error: certificate name mismatch: \"%s\"\n", txt);
357 return 0; /* reject */
361 if (!tls_is_name_for_cert(verify_cert_hostnames, cert))
363 log_write(0, LOG_MAIN,
364 "SSL verify error: certificate name mismatch: \"%s\"\n", txt);
365 return 0; /* reject */
368 #endif /*EXPERIMENTAL_CERTNAMES*/
370 DEBUG(D_tls) debug_printf("SSL%s verify ok: depth=0 SN=%s\n",
371 *calledp ? "" : " authenticated", txt);
372 if (!*calledp) tlsp->certificate_verified = TRUE;
376 return 1; /* accept */
380 verify_callback_client(int state, X509_STORE_CTX *x509ctx)
382 return verify_callback(state, x509ctx, &tls_out, &client_verify_callback_called, &client_verify_optional);
386 verify_callback_server(int state, X509_STORE_CTX *x509ctx)
388 return verify_callback(state, x509ctx, &tls_in, &server_verify_callback_called, &server_verify_optional);
392 #ifdef EXPERIMENTAL_DANE
394 /* This gets called *by* the dane library verify callback, which interposes
398 verify_callback_client_dane(int state, X509_STORE_CTX * x509ctx)
400 X509 * cert = X509_STORE_CTX_get_current_cert(x509ctx);
401 static uschar txt[256];
403 X509_NAME_oneline(X509_get_subject_name(cert), CS txt, sizeof(txt));
405 DEBUG(D_tls) debug_printf("verify_callback_client_dane: %s\n", txt);
406 tls_out.peerdn = txt;
407 tls_out.peercert = X509_dup(cert);
410 tls_out.dane_verified =
411 tls_out.certificate_verified = TRUE;
415 #endif /*EXPERIMENTAL_DANE*/
418 /*************************************************
419 * Information callback *
420 *************************************************/
422 /* The SSL library functions call this from time to time to indicate what they
423 are doing. We copy the string to the debugging output when TLS debugging has
435 info_callback(SSL *s, int where, int ret)
439 DEBUG(D_tls) debug_printf("SSL info: %s\n", SSL_state_string_long(s));
444 /*************************************************
445 * Initialize for DH *
446 *************************************************/
448 /* If dhparam is set, expand it, and load up the parameters for DH encryption.
451 dhparam DH parameter file or fixed parameter identity string
452 host connected host, if client; NULL if server
454 Returns: TRUE if OK (nothing to set up, or setup worked)
458 init_dh(SSL_CTX *sctx, uschar *dhparam, host_item *host)
465 if (!expand_check(dhparam, US"tls_dhparam", &dhexpanded))
468 if (!dhexpanded || !*dhexpanded)
469 bio = BIO_new_mem_buf(CS std_dh_prime_default(), -1);
470 else if (dhexpanded[0] == '/')
472 if (!(bio = BIO_new_file(CS dhexpanded, "r")))
474 tls_error(string_sprintf("could not read dhparams file %s", dhexpanded),
475 host, US strerror(errno));
481 if (Ustrcmp(dhexpanded, "none") == 0)
483 DEBUG(D_tls) debug_printf("Requested no DH parameters.\n");
487 if (!(pem = std_dh_prime_named(dhexpanded)))
489 tls_error(string_sprintf("Unknown standard DH prime \"%s\"", dhexpanded),
490 host, US strerror(errno));
493 bio = BIO_new_mem_buf(CS pem, -1);
496 if (!(dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL)))
499 tls_error(string_sprintf("Could not read tls_dhparams \"%s\"", dhexpanded),
504 /* Even if it is larger, we silently return success rather than cause things
505 * to fail out, so that a too-large DH will not knock out all TLS; it's a
506 * debatable choice. */
507 if ((8*DH_size(dh)) > tls_dh_max_bits)
510 debug_printf("dhparams file %d bits, is > tls_dh_max_bits limit of %d",
511 8*DH_size(dh), tls_dh_max_bits);
515 SSL_CTX_set_tmp_dh(sctx, dh);
517 debug_printf("Diffie-Hellman initialized from %s with %d-bit prime\n",
518 dhexpanded ? dhexpanded : US"default", 8*DH_size(dh));
531 /*************************************************
532 * Load OCSP information into state *
533 *************************************************/
535 /* Called to load the server OCSP response from the given file into memory, once
536 caller has determined this is needed. Checks validity. Debugs a message
539 ASSUMES: single response, for single cert.
542 sctx the SSL_CTX* to update
543 cbinfo various parts of session state
544 expanded the filename putatively holding an OCSP response
549 ocsp_load_response(SSL_CTX *sctx, tls_ext_ctx_cb *cbinfo, const uschar *expanded)
553 OCSP_BASICRESP *basic_response;
554 OCSP_SINGLERESP *single_response;
555 ASN1_GENERALIZEDTIME *rev, *thisupd, *nextupd;
557 unsigned long verify_flags;
558 int status, reason, i;
560 cbinfo->u_ocsp.server.file_expanded = string_copy(expanded);
561 if (cbinfo->u_ocsp.server.response)
563 OCSP_RESPONSE_free(cbinfo->u_ocsp.server.response);
564 cbinfo->u_ocsp.server.response = NULL;
567 bio = BIO_new_file(CS cbinfo->u_ocsp.server.file_expanded, "rb");
570 DEBUG(D_tls) debug_printf("Failed to open OCSP response file \"%s\"\n",
571 cbinfo->u_ocsp.server.file_expanded);
575 resp = d2i_OCSP_RESPONSE_bio(bio, NULL);
579 DEBUG(D_tls) debug_printf("Error reading OCSP response.\n");
583 status = OCSP_response_status(resp);
584 if (status != OCSP_RESPONSE_STATUS_SUCCESSFUL)
586 DEBUG(D_tls) debug_printf("OCSP response not valid: %s (%d)\n",
587 OCSP_response_status_str(status), status);
591 basic_response = OCSP_response_get1_basic(resp);
595 debug_printf("OCSP response parse error: unable to extract basic response.\n");
599 store = SSL_CTX_get_cert_store(sctx);
600 verify_flags = OCSP_NOVERIFY; /* check sigs, but not purpose */
602 /* May need to expose ability to adjust those flags?
603 OCSP_NOSIGS OCSP_NOVERIFY OCSP_NOCHAIN OCSP_NOCHECKS OCSP_NOEXPLICIT
604 OCSP_TRUSTOTHER OCSP_NOINTERN */
606 i = OCSP_basic_verify(basic_response, NULL, store, verify_flags);
610 ERR_error_string(ERR_get_error(), ssl_errstring);
611 debug_printf("OCSP response verify failure: %s\n", US ssl_errstring);
616 /* Here's the simplifying assumption: there's only one response, for the
617 one certificate we use, and nothing for anything else in a chain. If this
618 proves false, we need to extract a cert id from our issued cert
619 (tls_certificate) and use that for OCSP_resp_find_status() (which finds the
620 right cert in the stack and then calls OCSP_single_get0_status()).
622 I'm hoping to avoid reworking a bunch more of how we handle state here. */
623 single_response = OCSP_resp_get0(basic_response, 0);
624 if (!single_response)
627 debug_printf("Unable to get first response from OCSP basic response.\n");
631 status = OCSP_single_get0_status(single_response, &reason, &rev, &thisupd, &nextupd);
632 if (status != V_OCSP_CERTSTATUS_GOOD)
634 DEBUG(D_tls) debug_printf("OCSP response bad cert status: %s (%d) %s (%d)\n",
635 OCSP_cert_status_str(status), status,
636 OCSP_crl_reason_str(reason), reason);
640 if (!OCSP_check_validity(thisupd, nextupd, EXIM_OCSP_SKEW_SECONDS, EXIM_OCSP_MAX_AGE))
642 DEBUG(D_tls) debug_printf("OCSP status invalid times.\n");
647 cbinfo->u_ocsp.server.response = resp;
651 if (running_in_test_harness)
653 extern char ** environ;
655 for (p = USS environ; *p != NULL; p++)
656 if (Ustrncmp(*p, "EXIM_TESTHARNESS_DISABLE_OCSPVALIDITYCHECK", 42) == 0)
658 DEBUG(D_tls) debug_printf("Supplying known bad OCSP response\n");
659 goto supply_response;
664 #endif /*!DISABLE_OCSP*/
669 /*************************************************
670 * Expand key and cert file specs *
671 *************************************************/
673 /* Called once during tls_init and possibly again during TLS setup, for a
674 new context, if Server Name Indication was used and tls_sni was seen in
675 the certificate string.
678 sctx the SSL_CTX* to update
679 cbinfo various parts of session state
681 Returns: OK/DEFER/FAIL
685 tls_expand_session_files(SSL_CTX *sctx, tls_ext_ctx_cb *cbinfo)
689 if (cbinfo->certificate == NULL)
692 if (Ustrstr(cbinfo->certificate, US"tls_sni") ||
693 Ustrstr(cbinfo->certificate, US"tls_in_sni") ||
694 Ustrstr(cbinfo->certificate, US"tls_out_sni")
696 reexpand_tls_files_for_sni = TRUE;
698 if (!expand_check(cbinfo->certificate, US"tls_certificate", &expanded))
701 if (expanded != NULL)
703 DEBUG(D_tls) debug_printf("tls_certificate file %s\n", expanded);
704 if (!SSL_CTX_use_certificate_chain_file(sctx, CS expanded))
705 return tls_error(string_sprintf(
706 "SSL_CTX_use_certificate_chain_file file=%s", expanded),
710 if (cbinfo->privatekey != NULL &&
711 !expand_check(cbinfo->privatekey, US"tls_privatekey", &expanded))
714 /* If expansion was forced to fail, key_expanded will be NULL. If the result
715 of the expansion is an empty string, ignore it also, and assume the private
716 key is in the same file as the certificate. */
718 if (expanded != NULL && *expanded != 0)
720 DEBUG(D_tls) debug_printf("tls_privatekey file %s\n", expanded);
721 if (!SSL_CTX_use_PrivateKey_file(sctx, CS expanded, SSL_FILETYPE_PEM))
722 return tls_error(string_sprintf(
723 "SSL_CTX_use_PrivateKey_file file=%s", expanded), cbinfo->host, NULL);
727 if (cbinfo->is_server && cbinfo->u_ocsp.server.file != NULL)
729 if (!expand_check(cbinfo->u_ocsp.server.file, US"tls_ocsp_file", &expanded))
732 if (expanded != NULL && *expanded != 0)
734 DEBUG(D_tls) debug_printf("tls_ocsp_file %s\n", expanded);
735 if (cbinfo->u_ocsp.server.file_expanded &&
736 (Ustrcmp(expanded, cbinfo->u_ocsp.server.file_expanded) == 0))
739 debug_printf("tls_ocsp_file value unchanged, using existing values.\n");
741 ocsp_load_response(sctx, cbinfo, expanded);
753 /*************************************************
754 * Callback to handle SNI *
755 *************************************************/
757 /* Called when acting as server during the TLS session setup if a Server Name
758 Indication extension was sent by the client.
760 API documentation is OpenSSL s_server.c implementation.
763 s SSL* of the current session
764 ad unknown (part of OpenSSL API) (unused)
765 arg Callback of "our" registered data
767 Returns: SSL_TLSEXT_ERR_{OK,ALERT_WARNING,ALERT_FATAL,NOACK}
770 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
772 tls_servername_cb(SSL *s, int *ad ARG_UNUSED, void *arg)
774 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
775 tls_ext_ctx_cb *cbinfo = (tls_ext_ctx_cb *) arg;
777 int old_pool = store_pool;
780 return SSL_TLSEXT_ERR_OK;
782 DEBUG(D_tls) debug_printf("Received TLS SNI \"%s\"%s\n", servername,
783 reexpand_tls_files_for_sni ? "" : " (unused for certificate selection)");
785 /* Make the extension value available for expansion */
786 store_pool = POOL_PERM;
787 tls_in.sni = string_copy(US servername);
788 store_pool = old_pool;
790 if (!reexpand_tls_files_for_sni)
791 return SSL_TLSEXT_ERR_OK;
793 /* Can't find an SSL_CTX_clone() or equivalent, so we do it manually;
794 not confident that memcpy wouldn't break some internal reference counting.
795 Especially since there's a references struct member, which would be off. */
797 if (!(server_sni = SSL_CTX_new(SSLv23_server_method())))
799 ERR_error_string(ERR_get_error(), ssl_errstring);
800 DEBUG(D_tls) debug_printf("SSL_CTX_new() failed: %s\n", ssl_errstring);
801 return SSL_TLSEXT_ERR_NOACK;
804 /* Not sure how many of these are actually needed, since SSL object
805 already exists. Might even need this selfsame callback, for reneg? */
807 SSL_CTX_set_info_callback(server_sni, SSL_CTX_get_info_callback(server_ctx));
808 SSL_CTX_set_mode(server_sni, SSL_CTX_get_mode(server_ctx));
809 SSL_CTX_set_options(server_sni, SSL_CTX_get_options(server_ctx));
810 SSL_CTX_set_timeout(server_sni, SSL_CTX_get_timeout(server_ctx));
811 SSL_CTX_set_tlsext_servername_callback(server_sni, tls_servername_cb);
812 SSL_CTX_set_tlsext_servername_arg(server_sni, cbinfo);
813 if (cbinfo->server_cipher_list)
814 SSL_CTX_set_cipher_list(server_sni, CS cbinfo->server_cipher_list);
816 if (cbinfo->u_ocsp.server.file)
818 SSL_CTX_set_tlsext_status_cb(server_sni, tls_server_stapling_cb);
819 SSL_CTX_set_tlsext_status_arg(server_sni, cbinfo);
823 rc = setup_certs(server_sni, tls_verify_certificates, tls_crl, NULL, FALSE, verify_callback_server);
824 if (rc != OK) return SSL_TLSEXT_ERR_NOACK;
826 /* do this after setup_certs, because this can require the certs for verifying
828 rc = tls_expand_session_files(server_sni, cbinfo);
829 if (rc != OK) return SSL_TLSEXT_ERR_NOACK;
831 if (!init_dh(server_sni, cbinfo->dhparam, NULL))
832 return SSL_TLSEXT_ERR_NOACK;
834 DEBUG(D_tls) debug_printf("Switching SSL context.\n");
835 SSL_set_SSL_CTX(s, server_sni);
837 return SSL_TLSEXT_ERR_OK;
839 #endif /* EXIM_HAVE_OPENSSL_TLSEXT */
846 /*************************************************
847 * Callback to handle OCSP Stapling *
848 *************************************************/
850 /* Called when acting as server during the TLS session setup if the client
851 requests OCSP information with a Certificate Status Request.
853 Documentation via openssl s_server.c and the Apache patch from the OpenSSL
859 tls_server_stapling_cb(SSL *s, void *arg)
861 const tls_ext_ctx_cb *cbinfo = (tls_ext_ctx_cb *) arg;
862 uschar *response_der;
863 int response_der_len;
866 debug_printf("Received TLS status request (OCSP stapling); %s response.",
867 cbinfo->u_ocsp.server.response ? "have" : "lack");
869 tls_in.ocsp = OCSP_NOT_RESP;
870 if (!cbinfo->u_ocsp.server.response)
871 return SSL_TLSEXT_ERR_NOACK;
874 response_der_len = i2d_OCSP_RESPONSE(cbinfo->u_ocsp.server.response,
876 if (response_der_len <= 0)
877 return SSL_TLSEXT_ERR_NOACK;
879 SSL_set_tlsext_status_ocsp_resp(server_ssl, response_der, response_der_len);
880 tls_in.ocsp = OCSP_VFIED;
881 return SSL_TLSEXT_ERR_OK;
886 time_print(BIO * bp, const char * str, ASN1_GENERALIZEDTIME * time)
888 BIO_printf(bp, "\t%s: ", str);
889 ASN1_GENERALIZEDTIME_print(bp, time);
894 tls_client_stapling_cb(SSL *s, void *arg)
896 tls_ext_ctx_cb * cbinfo = arg;
897 const unsigned char * p;
903 DEBUG(D_tls) debug_printf("Received TLS status response (OCSP stapling):");
904 len = SSL_get_tlsext_status_ocsp_resp(s, &p);
907 /* Expect this when we requested ocsp but got none */
908 if ( cbinfo->u_ocsp.client.verify_required
909 && log_extra_selector & LX_tls_cipher)
910 log_write(0, LOG_MAIN, "Received TLS status callback, null content");
912 DEBUG(D_tls) debug_printf(" null\n");
913 return cbinfo->u_ocsp.client.verify_required ? 0 : 1;
916 if(!(rsp = d2i_OCSP_RESPONSE(NULL, &p, len)))
918 tls_out.ocsp = OCSP_FAILED;
919 if (log_extra_selector & LX_tls_cipher)
920 log_write(0, LOG_MAIN, "Received TLS status response, parse error");
922 DEBUG(D_tls) debug_printf(" parse error\n");
926 if(!(bs = OCSP_response_get1_basic(rsp)))
928 tls_out.ocsp = OCSP_FAILED;
929 if (log_extra_selector & LX_tls_cipher)
930 log_write(0, LOG_MAIN, "Received TLS status response, error parsing response");
932 DEBUG(D_tls) debug_printf(" error parsing response\n");
933 OCSP_RESPONSE_free(rsp);
937 /* We'd check the nonce here if we'd put one in the request. */
938 /* However that would defeat cacheability on the server so we don't. */
940 /* This section of code reworked from OpenSSL apps source;
941 The OpenSSL Project retains copyright:
942 Copyright (c) 1999 The OpenSSL Project. All rights reserved.
947 ASN1_GENERALIZEDTIME *rev, *thisupd, *nextupd;
949 DEBUG(D_tls) bp = BIO_new_fp(stderr, BIO_NOCLOSE);
951 /*OCSP_RESPONSE_print(bp, rsp, 0); extreme debug: stapling content */
953 /* Use the chain that verified the server cert to verify the stapled info */
954 /* DEBUG(D_tls) x509_store_dump_cert_s_names(cbinfo->u_ocsp.client.verify_store); */
956 if ((i = OCSP_basic_verify(bs, NULL,
957 cbinfo->u_ocsp.client.verify_store, 0)) <= 0)
959 tls_out.ocsp = OCSP_FAILED;
960 BIO_printf(bp, "OCSP response verify failure\n");
961 ERR_print_errors(bp);
962 i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
966 BIO_printf(bp, "OCSP response well-formed and signed OK\n");
969 STACK_OF(OCSP_SINGLERESP) * sresp = bs->tbsResponseData->responses;
970 OCSP_SINGLERESP * single;
972 if (sk_OCSP_SINGLERESP_num(sresp) != 1)
974 tls_out.ocsp = OCSP_FAILED;
975 log_write(0, LOG_MAIN, "OCSP stapling "
976 "with multiple responses not handled");
977 i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
980 single = OCSP_resp_get0(bs, 0);
981 status = OCSP_single_get0_status(single, &reason, &rev,
985 DEBUG(D_tls) time_print(bp, "This OCSP Update", thisupd);
986 DEBUG(D_tls) if(nextupd) time_print(bp, "Next OCSP Update", nextupd);
987 if (!OCSP_check_validity(thisupd, nextupd,
988 EXIM_OCSP_SKEW_SECONDS, EXIM_OCSP_MAX_AGE))
990 tls_out.ocsp = OCSP_FAILED;
991 DEBUG(D_tls) ERR_print_errors(bp);
992 log_write(0, LOG_MAIN, "Server OSCP dates invalid");
993 i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
997 DEBUG(D_tls) BIO_printf(bp, "Certificate status: %s\n",
998 OCSP_cert_status_str(status));
1001 case V_OCSP_CERTSTATUS_GOOD:
1002 tls_out.ocsp = OCSP_VFIED;
1005 case V_OCSP_CERTSTATUS_REVOKED:
1006 tls_out.ocsp = OCSP_FAILED;
1007 log_write(0, LOG_MAIN, "Server certificate revoked%s%s",
1008 reason != -1 ? "; reason: " : "",
1009 reason != -1 ? OCSP_crl_reason_str(reason) : "");
1010 DEBUG(D_tls) time_print(bp, "Revocation Time", rev);
1011 i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
1014 tls_out.ocsp = OCSP_FAILED;
1015 log_write(0, LOG_MAIN,
1016 "Server certificate status unknown, in OCSP stapling");
1017 i = cbinfo->u_ocsp.client.verify_required ? 0 : 1;
1025 OCSP_RESPONSE_free(rsp);
1028 #endif /*!DISABLE_OCSP*/
1031 /*************************************************
1032 * Initialize for TLS *
1033 *************************************************/
1035 /* Called from both server and client code, to do preliminary initialization
1036 of the library. We allocate and return a context structure.
1039 ctxp returned SSL context
1040 host connected host, if client; NULL if server
1041 dhparam DH parameter file
1042 certificate certificate file
1043 privatekey private key
1044 ocsp_file file of stapling info (server); flag for require ocsp (client)
1045 addr address if client; NULL if server (for some randomness)
1046 cbp place to put allocated callback context
1048 Returns: OK/DEFER/FAIL
1052 tls_init(SSL_CTX **ctxp, host_item *host, uschar *dhparam, uschar *certificate,
1054 #ifndef DISABLE_OCSP
1057 address_item *addr, tls_ext_ctx_cb ** cbp)
1062 tls_ext_ctx_cb *cbinfo;
1064 cbinfo = store_malloc(sizeof(tls_ext_ctx_cb));
1065 cbinfo->certificate = certificate;
1066 cbinfo->privatekey = privatekey;
1067 #ifndef DISABLE_OCSP
1068 if ((cbinfo->is_server = host==NULL))
1070 cbinfo->u_ocsp.server.file = ocsp_file;
1071 cbinfo->u_ocsp.server.file_expanded = NULL;
1072 cbinfo->u_ocsp.server.response = NULL;
1075 cbinfo->u_ocsp.client.verify_store = NULL;
1077 cbinfo->dhparam = dhparam;
1078 cbinfo->server_cipher_list = NULL;
1079 cbinfo->host = host;
1081 SSL_load_error_strings(); /* basic set up */
1082 OpenSSL_add_ssl_algorithms();
1084 #if (OPENSSL_VERSION_NUMBER >= 0x0090800fL) && !defined(OPENSSL_NO_SHA256)
1085 /* SHA256 is becoming ever more popular. This makes sure it gets added to the
1086 list of available digests. */
1087 EVP_add_digest(EVP_sha256());
1090 /* Create a context.
1091 The OpenSSL docs in 1.0.1b have not been updated to clarify TLS variant
1092 negotiation in the different methods; as far as I can tell, the only
1093 *_{server,client}_method which allows negotiation is SSLv23, which exists even
1094 when OpenSSL is built without SSLv2 support.
1095 By disabling with openssl_options, we can let admins re-enable with the
1098 *ctxp = SSL_CTX_new((host == NULL)?
1099 SSLv23_server_method() : SSLv23_client_method());
1101 if (*ctxp == NULL) return tls_error(US"SSL_CTX_new", host, NULL);
1103 /* It turns out that we need to seed the random number generator this early in
1104 order to get the full complement of ciphers to work. It took me roughly a day
1105 of work to discover this by experiment.
1107 On systems that have /dev/urandom, SSL may automatically seed itself from
1108 there. Otherwise, we have to make something up as best we can. Double check
1114 gettimeofday(&r.tv, NULL);
1117 RAND_seed((uschar *)(&r), sizeof(r));
1118 RAND_seed((uschar *)big_buffer, big_buffer_size);
1119 if (addr != NULL) RAND_seed((uschar *)addr, sizeof(addr));
1122 return tls_error(US"RAND_status", host,
1123 US"unable to seed random number generator");
1126 /* Set up the information callback, which outputs if debugging is at a suitable
1129 SSL_CTX_set_info_callback(*ctxp, (void (*)())info_callback);
1131 /* Automatically re-try reads/writes after renegotiation. */
1132 (void) SSL_CTX_set_mode(*ctxp, SSL_MODE_AUTO_RETRY);
1134 /* Apply administrator-supplied work-arounds.
1135 Historically we applied just one requested option,
1136 SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS, but when bug 994 requested a second, we
1137 moved to an administrator-controlled list of options to specify and
1138 grandfathered in the first one as the default value for "openssl_options".
1140 No OpenSSL version number checks: the options we accept depend upon the
1141 availability of the option value macros from OpenSSL. */
1143 okay = tls_openssl_options_parse(openssl_options, &init_options);
1145 return tls_error(US"openssl_options parsing failed", host, NULL);
1149 DEBUG(D_tls) debug_printf("setting SSL CTX options: %#lx\n", init_options);
1150 if (!(SSL_CTX_set_options(*ctxp, init_options)))
1151 return tls_error(string_sprintf(
1152 "SSL_CTX_set_option(%#lx)", init_options), host, NULL);
1155 DEBUG(D_tls) debug_printf("no SSL CTX options to set\n");
1157 /* Initialize with DH parameters if supplied */
1159 if (!init_dh(*ctxp, dhparam, host)) return DEFER;
1161 /* Set up certificate and key (and perhaps OCSP info) */
1163 rc = tls_expand_session_files(*ctxp, cbinfo);
1164 if (rc != OK) return rc;
1166 /* If we need to handle SNI, do so */
1167 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
1168 if (host == NULL) /* server */
1170 # ifndef DISABLE_OCSP
1171 /* We check u_ocsp.server.file, not server.response, because we care about if
1172 the option exists, not what the current expansion might be, as SNI might
1173 change the certificate and OCSP file in use between now and the time the
1174 callback is invoked. */
1175 if (cbinfo->u_ocsp.server.file)
1177 SSL_CTX_set_tlsext_status_cb(server_ctx, tls_server_stapling_cb);
1178 SSL_CTX_set_tlsext_status_arg(server_ctx, cbinfo);
1181 /* We always do this, so that $tls_sni is available even if not used in
1183 SSL_CTX_set_tlsext_servername_callback(*ctxp, tls_servername_cb);
1184 SSL_CTX_set_tlsext_servername_arg(*ctxp, cbinfo);
1186 # ifndef DISABLE_OCSP
1188 if(ocsp_file) /* wanting stapling */
1190 if (!(cbinfo->u_ocsp.client.verify_store = X509_STORE_new()))
1192 DEBUG(D_tls) debug_printf("failed to create store for stapling verify\n");
1195 SSL_CTX_set_tlsext_status_cb(*ctxp, tls_client_stapling_cb);
1196 SSL_CTX_set_tlsext_status_arg(*ctxp, cbinfo);
1201 #ifdef EXPERIMENTAL_CERTNAMES
1202 cbinfo->verify_cert_hostnames = NULL;
1205 /* Set up the RSA callback */
1207 SSL_CTX_set_tmp_rsa_callback(*ctxp, rsa_callback);
1209 /* Finally, set the timeout, and we are done */
1211 SSL_CTX_set_timeout(*ctxp, ssl_session_timeout);
1212 DEBUG(D_tls) debug_printf("Initialized TLS\n");
1222 /*************************************************
1223 * Get name of cipher in use *
1224 *************************************************/
1227 Argument: pointer to an SSL structure for the connection
1228 buffer to use for answer
1230 pointer to number of bits for cipher
1235 construct_cipher_name(SSL *ssl, uschar *cipherbuf, int bsize, int *bits)
1237 /* With OpenSSL 1.0.0a, this needs to be const but the documentation doesn't
1238 yet reflect that. It should be a safe change anyway, even 0.9.8 versions have
1239 the accessor functions use const in the prototype. */
1240 const SSL_CIPHER *c;
1243 ver = (const uschar *)SSL_get_version(ssl);
1245 c = (const SSL_CIPHER *) SSL_get_current_cipher(ssl);
1246 SSL_CIPHER_get_bits(c, bits);
1248 string_format(cipherbuf, bsize, "%s:%s:%u", ver,
1249 SSL_CIPHER_get_name(c), *bits);
1251 DEBUG(D_tls) debug_printf("Cipher: %s\n", cipherbuf);
1258 /*************************************************
1259 * Set up for verifying certificates *
1260 *************************************************/
1262 /* Called by both client and server startup
1265 sctx SSL_CTX* to initialise
1266 certs certs file or NULL
1267 crl CRL file or NULL
1268 host NULL in a server; the remote host in a client
1269 optional TRUE if called from a server for a host in tls_try_verify_hosts;
1270 otherwise passed as FALSE
1271 cert_vfy_cb Callback function for certificate verification
1273 Returns: OK/DEFER/FAIL
1277 setup_certs(SSL_CTX *sctx, uschar *certs, uschar *crl, host_item *host, BOOL optional,
1278 int (*cert_vfy_cb)(int, X509_STORE_CTX *) )
1280 uschar *expcerts, *expcrl;
1282 if (!expand_check(certs, US"tls_verify_certificates", &expcerts))
1285 if (expcerts != NULL && *expcerts != '\0')
1287 struct stat statbuf;
1288 if (!SSL_CTX_set_default_verify_paths(sctx))
1289 return tls_error(US"SSL_CTX_set_default_verify_paths", host, NULL);
1291 if (Ustat(expcerts, &statbuf) < 0)
1293 log_write(0, LOG_MAIN|LOG_PANIC,
1294 "failed to stat %s for certificates", expcerts);
1300 if ((statbuf.st_mode & S_IFMT) == S_IFDIR)
1301 { file = NULL; dir = expcerts; }
1303 { file = expcerts; dir = NULL; }
1305 /* If a certificate file is empty, the next function fails with an
1306 unhelpful error message. If we skip it, we get the correct behaviour (no
1307 certificates are recognized, but the error message is still misleading (it
1308 says no certificate was supplied.) But this is better. */
1310 if ((file == NULL || statbuf.st_size > 0) &&
1311 !SSL_CTX_load_verify_locations(sctx, CS file, CS dir))
1312 return tls_error(US"SSL_CTX_load_verify_locations", host, NULL);
1316 SSL_CTX_set_client_CA_list(sctx, SSL_load_client_CA_file(CS file));
1320 /* Handle a certificate revocation list. */
1322 #if OPENSSL_VERSION_NUMBER > 0x00907000L
1324 /* This bit of code is now the version supplied by Lars Mainka. (I have
1325 * merely reformatted it into the Exim code style.)
1327 * "From here I changed the code to add support for multiple crl's
1328 * in pem format in one file or to support hashed directory entries in
1329 * pem format instead of a file. This method now uses the library function
1330 * X509_STORE_load_locations to add the CRL location to the SSL context.
1331 * OpenSSL will then handle the verify against CA certs and CRLs by
1332 * itself in the verify callback." */
1334 if (!expand_check(crl, US"tls_crl", &expcrl)) return DEFER;
1335 if (expcrl != NULL && *expcrl != 0)
1337 struct stat statbufcrl;
1338 if (Ustat(expcrl, &statbufcrl) < 0)
1340 log_write(0, LOG_MAIN|LOG_PANIC,
1341 "failed to stat %s for certificates revocation lists", expcrl);
1346 /* is it a file or directory? */
1348 X509_STORE *cvstore = SSL_CTX_get_cert_store(sctx);
1349 if ((statbufcrl.st_mode & S_IFMT) == S_IFDIR)
1353 DEBUG(D_tls) debug_printf("SSL CRL value is a directory %s\n", dir);
1359 DEBUG(D_tls) debug_printf("SSL CRL value is a file %s\n", file);
1361 if (X509_STORE_load_locations(cvstore, CS file, CS dir) == 0)
1362 return tls_error(US"X509_STORE_load_locations", host, NULL);
1364 /* setting the flags to check against the complete crl chain */
1366 X509_STORE_set_flags(cvstore,
1367 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
1371 #endif /* OPENSSL_VERSION_NUMBER > 0x00907000L */
1373 /* If verification is optional, don't fail if no certificate */
1375 SSL_CTX_set_verify(sctx,
1376 SSL_VERIFY_PEER | (optional? 0 : SSL_VERIFY_FAIL_IF_NO_PEER_CERT),
1385 /*************************************************
1386 * Start a TLS session in a server *
1387 *************************************************/
1389 /* This is called when Exim is running as a server, after having received
1390 the STARTTLS command. It must respond to that command, and then negotiate
1394 require_ciphers allowed ciphers
1396 Returns: OK on success
1397 DEFER for errors before the start of the negotiation
1398 FAIL for errors during the negotation; the server can't
1403 tls_server_start(const uschar *require_ciphers)
1407 tls_ext_ctx_cb *cbinfo;
1408 static uschar cipherbuf[256];
1410 /* Check for previous activation */
1412 if (tls_in.active >= 0)
1414 tls_error(US"STARTTLS received after TLS started", NULL, US"");
1415 smtp_printf("554 Already in TLS\r\n");
1419 /* Initialize the SSL library. If it fails, it will already have logged
1422 rc = tls_init(&server_ctx, NULL, tls_dhparam, tls_certificate, tls_privatekey,
1423 #ifndef DISABLE_OCSP
1426 NULL, &server_static_cbinfo);
1427 if (rc != OK) return rc;
1428 cbinfo = server_static_cbinfo;
1430 if (!expand_check(require_ciphers, US"tls_require_ciphers", &expciphers))
1433 /* In OpenSSL, cipher components are separated by hyphens. In GnuTLS, they
1434 were historically separated by underscores. So that I can use either form in my
1435 tests, and also for general convenience, we turn underscores into hyphens here.
1438 if (expciphers != NULL)
1440 uschar *s = expciphers;
1441 while (*s != 0) { if (*s == '_') *s = '-'; s++; }
1442 DEBUG(D_tls) debug_printf("required ciphers: %s\n", expciphers);
1443 if (!SSL_CTX_set_cipher_list(server_ctx, CS expciphers))
1444 return tls_error(US"SSL_CTX_set_cipher_list", NULL, NULL);
1445 cbinfo->server_cipher_list = expciphers;
1448 /* If this is a host for which certificate verification is mandatory or
1449 optional, set up appropriately. */
1451 tls_in.certificate_verified = FALSE;
1452 #ifdef EXPERIMENTAL_DANE
1453 tls_in.dane_verified = FALSE;
1455 server_verify_callback_called = FALSE;
1457 if (verify_check_host(&tls_verify_hosts) == OK)
1459 rc = setup_certs(server_ctx, tls_verify_certificates, tls_crl, NULL,
1460 FALSE, verify_callback_server);
1461 if (rc != OK) return rc;
1462 server_verify_optional = FALSE;
1464 else if (verify_check_host(&tls_try_verify_hosts) == OK)
1466 rc = setup_certs(server_ctx, tls_verify_certificates, tls_crl, NULL,
1467 TRUE, verify_callback_server);
1468 if (rc != OK) return rc;
1469 server_verify_optional = TRUE;
1472 /* Prepare for new connection */
1474 if ((server_ssl = SSL_new(server_ctx)) == NULL) return tls_error(US"SSL_new", NULL, NULL);
1476 /* Warning: we used to SSL_clear(ssl) here, it was removed.
1478 * With the SSL_clear(), we get strange interoperability bugs with
1479 * OpenSSL 1.0.1b and TLS1.1/1.2. It looks as though this may be a bug in
1480 * OpenSSL itself, as a clear should not lead to inability to follow protocols.
1482 * The SSL_clear() call is to let an existing SSL* be reused, typically after
1483 * session shutdown. In this case, we have a brand new object and there's no
1484 * obvious reason to immediately clear it. I'm guessing that this was
1485 * originally added because of incomplete initialisation which the clear fixed,
1486 * in some historic release.
1489 /* Set context and tell client to go ahead, except in the case of TLS startup
1490 on connection, where outputting anything now upsets the clients and tends to
1491 make them disconnect. We need to have an explicit fflush() here, to force out
1492 the response. Other smtp_printf() calls do not need it, because in non-TLS
1493 mode, the fflush() happens when smtp_getc() is called. */
1495 SSL_set_session_id_context(server_ssl, sid_ctx, Ustrlen(sid_ctx));
1496 if (!tls_in.on_connect)
1498 smtp_printf("220 TLS go ahead\r\n");
1502 /* Now negotiate the TLS session. We put our own timer on it, since it seems
1503 that the OpenSSL library doesn't. */
1505 SSL_set_wfd(server_ssl, fileno(smtp_out));
1506 SSL_set_rfd(server_ssl, fileno(smtp_in));
1507 SSL_set_accept_state(server_ssl);
1509 DEBUG(D_tls) debug_printf("Calling SSL_accept\n");
1511 sigalrm_seen = FALSE;
1512 if (smtp_receive_timeout > 0) alarm(smtp_receive_timeout);
1513 rc = SSL_accept(server_ssl);
1518 tls_error(US"SSL_accept", NULL, sigalrm_seen ? US"timed out" : NULL);
1519 if (ERR_get_error() == 0)
1520 log_write(0, LOG_MAIN,
1521 "TLS client disconnected cleanly (rejected our certificate?)");
1525 DEBUG(D_tls) debug_printf("SSL_accept was successful\n");
1527 /* TLS has been set up. Adjust the input functions to read via TLS,
1528 and initialize things. */
1530 construct_cipher_name(server_ssl, cipherbuf, sizeof(cipherbuf), &tls_in.bits);
1531 tls_in.cipher = cipherbuf;
1536 if (SSL_get_shared_ciphers(server_ssl, CS buf, sizeof(buf)) != NULL)
1537 debug_printf("Shared ciphers: %s\n", buf);
1540 /* Record the certificate we presented */
1542 X509 * crt = SSL_get_certificate(server_ssl);
1543 tls_in.ourcert = crt ? X509_dup(crt) : NULL;
1546 /* Only used by the server-side tls (tls_in), including tls_getc.
1547 Client-side (tls_out) reads (seem to?) go via
1548 smtp_read_response()/ip_recv().
1549 Hence no need to duplicate for _in and _out.
1551 ssl_xfer_buffer = store_malloc(ssl_xfer_buffer_size);
1552 ssl_xfer_buffer_lwm = ssl_xfer_buffer_hwm = 0;
1553 ssl_xfer_eof = ssl_xfer_error = 0;
1555 receive_getc = tls_getc;
1556 receive_ungetc = tls_ungetc;
1557 receive_feof = tls_feof;
1558 receive_ferror = tls_ferror;
1559 receive_smtp_buffered = tls_smtp_buffered;
1561 tls_in.active = fileno(smtp_out);
1569 tls_client_basic_ctx_init(SSL_CTX * ctx,
1570 host_item * host, smtp_transport_options_block * ob
1571 #ifdef EXPERIMENTAL_CERTNAMES
1572 , tls_ext_ctx_cb * cbinfo
1577 /* stick to the old behaviour for compatibility if tls_verify_certificates is
1578 set but both tls_verify_hosts and tls_try_verify_hosts is not set. Check only
1579 the specified host patterns if one of them is defined */
1581 if ((!ob->tls_verify_hosts && !ob->tls_try_verify_hosts) ||
1582 (verify_check_host(&ob->tls_verify_hosts) == OK))
1584 if ((rc = setup_certs(ctx, ob->tls_verify_certificates,
1585 ob->tls_crl, host, FALSE, verify_callback_client)) != OK)
1587 client_verify_optional = FALSE;
1589 #ifdef EXPERIMENTAL_CERTNAMES
1590 if (ob->tls_verify_cert_hostnames)
1592 if (!expand_check(ob->tls_verify_cert_hostnames,
1593 US"tls_verify_cert_hostnames",
1594 &cbinfo->verify_cert_hostnames))
1596 if (cbinfo->verify_cert_hostnames)
1597 DEBUG(D_tls) debug_printf("Cert hostname to check: \"%s\"\n",
1598 cbinfo->verify_cert_hostnames);
1602 else if (verify_check_host(&ob->tls_try_verify_hosts) == OK)
1604 if ((rc = setup_certs(ctx, ob->tls_verify_certificates,
1605 ob->tls_crl, host, TRUE, verify_callback_client)) != OK)
1607 client_verify_optional = TRUE;
1614 #ifdef EXPERIMENTAL_DANE
1616 tlsa_lookup(host_item * host, dns_answer * dnsa,
1617 BOOL dane_required, BOOL * dane)
1619 /* move this out to host.c given the similarity to dns_lookup() ? */
1621 uschar * fullname = buffer;
1623 /* TLSA lookup string */
1624 (void)sprintf(CS buffer, "_%d._tcp.%.256s", host->port, host->name);
1626 switch (dns_lookup(dnsa, buffer, T_TLSA, &fullname))
1629 return DEFER; /* just defer this TLS'd conn */
1635 log_write(0, LOG_MAIN, "DANE error: TLSA lookup failed");
1641 if (!dns_is_secure(dnsa))
1643 log_write(0, LOG_MAIN, "DANE error: TLSA lookup not DNSSEC");
1654 dane_tlsa_load(SSL * ssl, host_item * host, dns_answer * dnsa)
1658 const char * hostnames[2] = { CS host->name, NULL };
1661 if (DANESSL_init(ssl, NULL, hostnames) != 1)
1662 return tls_error(US"hostnames load", host, NULL);
1664 for (rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS);
1666 rr = dns_next_rr(dnsa, &dnss, RESET_NEXT)
1667 ) if (rr->type == T_TLSA)
1669 uschar * p = rr->data;
1670 uint8_t usage, selector, mtype;
1671 const char * mdname;
1681 log_write(0, LOG_MAIN,
1682 "DANE error: TLSA record w/bad mtype 0x%x", mtype);
1684 case 0: mdname = NULL; break;
1685 case 1: mdname = "sha256"; break;
1686 case 2: mdname = "sha512"; break;
1689 switch (DANESSL_add_tlsa(ssl, usage, selector, mdname, p, rr->size - 3))
1692 case 0: /* action not taken */
1693 return tls_error(US"tlsa load", host, NULL);
1697 tls_out.tlsa_usage |= 1<<usage;
1703 log_write(0, LOG_MAIN, "DANE error: No TLSA records");
1706 #endif /*EXPERIMENTAL_DANE*/
1710 /*************************************************
1711 * Start a TLS session in a client *
1712 *************************************************/
1714 /* Called from the smtp transport after STARTTLS has been accepted.
1717 fd the fd of the connection
1718 host connected host (for messages)
1719 addr the first address
1720 ob smtp transport options
1722 Returns: OK on success
1723 FAIL otherwise - note that tls_error() will not give DEFER
1724 because this is not a server
1728 tls_client_start(int fd, host_item *host, address_item *addr,
1731 smtp_transport_options_block * ob = v_ob;
1732 static uschar txt[256];
1733 uschar * expciphers;
1736 static uschar cipherbuf[256];
1738 #ifndef DISABLE_OCSP
1739 BOOL request_ocsp = FALSE;
1740 BOOL require_ocsp = FALSE;
1742 #ifdef EXPERIMENTAL_DANE
1743 dns_answer tlsa_dnsa;
1748 #ifdef EXPERIMENTAL_DANE
1749 tls_out.dane_verified = FALSE;
1750 tls_out.tlsa_usage = 0;
1751 dane_required = verify_check_this_host(&ob->hosts_require_dane, NULL,
1752 host->name, host->address, NULL) == OK;
1754 if (host->dnssec == DS_YES)
1757 || verify_check_this_host(&ob->hosts_try_dane, NULL,
1758 host->name, host->address, NULL) == OK
1760 if ((rc = tlsa_lookup(host, &tlsa_dnsa, dane_required, &dane)) != OK)
1763 else if (dane_required)
1765 /*XXX a shame we only find this after making tcp & smtp connection */
1766 /* move the test earlier? */
1767 log_write(0, LOG_MAIN, "DANE error: previous lookup not DNSSEC");
1772 #ifndef DISABLE_OCSP
1774 require_ocsp = verify_check_this_host(&ob->hosts_require_ocsp,
1775 NULL, host->name, host->address, NULL) == OK;
1776 request_ocsp = require_ocsp ? TRUE
1777 : verify_check_this_host(&ob->hosts_request_ocsp,
1778 NULL, host->name, host->address, NULL) == OK;
1782 rc = tls_init(&client_ctx, host, NULL,
1783 ob->tls_certificate, ob->tls_privatekey,
1784 #ifndef DISABLE_OCSP
1785 (void *)(long)request_ocsp,
1787 addr, &client_static_cbinfo);
1788 if (rc != OK) return rc;
1790 tls_out.certificate_verified = FALSE;
1791 client_verify_callback_called = FALSE;
1793 if (!expand_check(ob->tls_require_ciphers, US"tls_require_ciphers",
1797 /* In OpenSSL, cipher components are separated by hyphens. In GnuTLS, they
1798 are separated by underscores. So that I can use either form in my tests, and
1799 also for general convenience, we turn underscores into hyphens here. */
1801 if (expciphers != NULL)
1803 uschar *s = expciphers;
1804 while (*s != 0) { if (*s == '_') *s = '-'; s++; }
1805 DEBUG(D_tls) debug_printf("required ciphers: %s\n", expciphers);
1806 if (!SSL_CTX_set_cipher_list(client_ctx, CS expciphers))
1807 return tls_error(US"SSL_CTX_set_cipher_list", host, NULL);
1810 #ifdef EXPERIMENTAL_DANE
1813 SSL_CTX_set_verify(client_ctx, SSL_VERIFY_PEER, verify_callback_client_dane);
1815 if (!DANESSL_library_init())
1816 return tls_error(US"library init", host, NULL);
1817 if (DANESSL_CTX_init(client_ctx) <= 0)
1818 return tls_error(US"context init", host, NULL);
1824 if ((rc = tls_client_basic_ctx_init(client_ctx, host, ob
1825 #ifdef EXPERIMENTAL_CERTNAMES
1826 , client_static_cbinfo
1831 if ((client_ssl = SSL_new(client_ctx)) == NULL)
1832 return tls_error(US"SSL_new", host, NULL);
1833 SSL_set_session_id_context(client_ssl, sid_ctx, Ustrlen(sid_ctx));
1834 SSL_set_fd(client_ssl, fd);
1835 SSL_set_connect_state(client_ssl);
1839 if (!expand_check(ob->tls_sni, US"tls_sni", &tls_out.sni))
1841 if (tls_out.sni == NULL)
1843 DEBUG(D_tls) debug_printf("Setting TLS SNI forced to fail, not sending\n");
1845 else if (!Ustrlen(tls_out.sni))
1849 #ifdef EXIM_HAVE_OPENSSL_TLSEXT
1850 DEBUG(D_tls) debug_printf("Setting TLS SNI \"%s\"\n", tls_out.sni);
1851 SSL_set_tlsext_host_name(client_ssl, tls_out.sni);
1854 debug_printf("OpenSSL at build-time lacked SNI support, ignoring \"%s\"\n",
1860 #ifdef EXPERIMENTAL_DANE
1862 if ((rc = dane_tlsa_load(client_ssl, host, &tlsa_dnsa)) != OK)
1866 #ifndef DISABLE_OCSP
1867 /* Request certificate status at connection-time. If the server
1868 does OCSP stapling we will get the callback (set in tls_init()) */
1869 # ifdef EXPERIMENTAL_DANE
1873 if ( (s = ob->hosts_require_ocsp) && Ustrstr(s, US"tls_out_tlsa_usage")
1874 || (s = ob->hosts_request_ocsp) && Ustrstr(s, US"tls_out_tlsa_usage")
1876 { /* Re-eval now $tls_out_tlsa_usage is populated. If
1877 this means we avoid the OCSP request, we wasted the setup
1878 cost in tls_init(). */
1879 require_ocsp = verify_check_this_host(&ob->hosts_require_ocsp,
1880 NULL, host->name, host->address, NULL) == OK;
1881 request_ocsp = require_ocsp ? TRUE
1882 : verify_check_this_host(&ob->hosts_request_ocsp,
1883 NULL, host->name, host->address, NULL) == OK;
1890 SSL_set_tlsext_status_type(client_ssl, TLSEXT_STATUSTYPE_ocsp);
1891 client_static_cbinfo->u_ocsp.client.verify_required = require_ocsp;
1892 tls_out.ocsp = OCSP_NOT_RESP;
1897 /* There doesn't seem to be a built-in timeout on connection. */
1899 DEBUG(D_tls) debug_printf("Calling SSL_connect\n");
1900 sigalrm_seen = FALSE;
1901 alarm(ob->command_timeout);
1902 rc = SSL_connect(client_ssl);
1905 #ifdef EXPERIMENTAL_DANE
1907 DANESSL_cleanup(client_ssl);
1911 return tls_error(US"SSL_connect", host, sigalrm_seen ? US"timed out" : NULL);
1913 DEBUG(D_tls) debug_printf("SSL_connect succeeded\n");
1915 /* Beware anonymous ciphers which lead to server_cert being NULL */
1916 /*XXX server_cert is never freed... use X509_free() */
1917 server_cert = SSL_get_peer_certificate (client_ssl);
1920 tls_out.peerdn = US X509_NAME_oneline(X509_get_subject_name(server_cert),
1921 CS txt, sizeof(txt));
1922 tls_out.peerdn = txt; /*XXX a static buffer... */
1925 tls_out.peerdn = NULL;
1927 construct_cipher_name(client_ssl, cipherbuf, sizeof(cipherbuf), &tls_out.bits);
1928 tls_out.cipher = cipherbuf;
1930 /* Record the certificate we presented */
1932 X509 * crt = SSL_get_certificate(client_ssl);
1933 tls_out.ourcert = crt ? X509_dup(crt) : NULL;
1936 tls_out.active = fd;
1944 /*************************************************
1945 * TLS version of getc *
1946 *************************************************/
1948 /* This gets the next byte from the TLS input buffer. If the buffer is empty,
1949 it refills the buffer via the SSL reading function.
1952 Returns: the next character or EOF
1954 Only used by the server-side TLS.
1960 if (ssl_xfer_buffer_lwm >= ssl_xfer_buffer_hwm)
1965 DEBUG(D_tls) debug_printf("Calling SSL_read(%p, %p, %u)\n", server_ssl,
1966 ssl_xfer_buffer, ssl_xfer_buffer_size);
1968 if (smtp_receive_timeout > 0) alarm(smtp_receive_timeout);
1969 inbytes = SSL_read(server_ssl, CS ssl_xfer_buffer, ssl_xfer_buffer_size);
1970 error = SSL_get_error(server_ssl, inbytes);
1973 /* SSL_ERROR_ZERO_RETURN appears to mean that the SSL session has been
1974 closed down, not that the socket itself has been closed down. Revert to
1975 non-SSL handling. */
1977 if (error == SSL_ERROR_ZERO_RETURN)
1979 DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
1981 receive_getc = smtp_getc;
1982 receive_ungetc = smtp_ungetc;
1983 receive_feof = smtp_feof;
1984 receive_ferror = smtp_ferror;
1985 receive_smtp_buffered = smtp_buffered;
1987 SSL_free(server_ssl);
1991 tls_in.cipher = NULL;
1992 tls_in.peerdn = NULL;
1998 /* Handle genuine errors */
2000 else if (error == SSL_ERROR_SSL)
2002 ERR_error_string(ERR_get_error(), ssl_errstring);
2003 log_write(0, LOG_MAIN, "TLS error (SSL_read): %s", ssl_errstring);
2008 else if (error != SSL_ERROR_NONE)
2010 DEBUG(D_tls) debug_printf("Got SSL error %d\n", error);
2015 #ifndef DISABLE_DKIM
2016 dkim_exim_verify_feed(ssl_xfer_buffer, inbytes);
2018 ssl_xfer_buffer_hwm = inbytes;
2019 ssl_xfer_buffer_lwm = 0;
2022 /* Something in the buffer; return next uschar */
2024 return ssl_xfer_buffer[ssl_xfer_buffer_lwm++];
2029 /*************************************************
2030 * Read bytes from TLS channel *
2031 *************************************************/
2038 Returns: the number of bytes read
2039 -1 after a failed read
2041 Only used by the client-side TLS.
2045 tls_read(BOOL is_server, uschar *buff, size_t len)
2047 SSL *ssl = is_server ? server_ssl : client_ssl;
2051 DEBUG(D_tls) debug_printf("Calling SSL_read(%p, %p, %u)\n", ssl,
2052 buff, (unsigned int)len);
2054 inbytes = SSL_read(ssl, CS buff, len);
2055 error = SSL_get_error(ssl, inbytes);
2057 if (error == SSL_ERROR_ZERO_RETURN)
2059 DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
2062 else if (error != SSL_ERROR_NONE)
2074 /*************************************************
2075 * Write bytes down TLS channel *
2076 *************************************************/
2080 is_server channel specifier
2084 Returns: the number of bytes after a successful write,
2085 -1 after a failed write
2087 Used by both server-side and client-side TLS.
2091 tls_write(BOOL is_server, const uschar *buff, size_t len)
2096 SSL *ssl = is_server ? server_ssl : client_ssl;
2098 DEBUG(D_tls) debug_printf("tls_do_write(%p, %d)\n", buff, left);
2101 DEBUG(D_tls) debug_printf("SSL_write(SSL, %p, %d)\n", buff, left);
2102 outbytes = SSL_write(ssl, CS buff, left);
2103 error = SSL_get_error(ssl, outbytes);
2104 DEBUG(D_tls) debug_printf("outbytes=%d error=%d\n", outbytes, error);
2108 ERR_error_string(ERR_get_error(), ssl_errstring);
2109 log_write(0, LOG_MAIN, "TLS error (SSL_write): %s", ssl_errstring);
2112 case SSL_ERROR_NONE:
2117 case SSL_ERROR_ZERO_RETURN:
2118 log_write(0, LOG_MAIN, "SSL channel closed on write");
2121 case SSL_ERROR_SYSCALL:
2122 log_write(0, LOG_MAIN, "SSL_write: (from %s) syscall: %s",
2123 sender_fullhost ? sender_fullhost : US"<unknown>",
2127 log_write(0, LOG_MAIN, "SSL_write error %d", error);
2136 /*************************************************
2137 * Close down a TLS session *
2138 *************************************************/
2140 /* This is also called from within a delivery subprocess forked from the
2141 daemon, to shut down the TLS library, without actually doing a shutdown (which
2142 would tamper with the SSL session in the parent process).
2144 Arguments: TRUE if SSL_shutdown is to be called
2147 Used by both server-side and client-side TLS.
2151 tls_close(BOOL is_server, BOOL shutdown)
2153 SSL **sslp = is_server ? &server_ssl : &client_ssl;
2154 int *fdp = is_server ? &tls_in.active : &tls_out.active;
2156 if (*fdp < 0) return; /* TLS was not active */
2160 DEBUG(D_tls) debug_printf("tls_close(): shutting down SSL\n");
2161 SSL_shutdown(*sslp);
2173 /*************************************************
2174 * Let tls_require_ciphers be checked at startup *
2175 *************************************************/
2177 /* The tls_require_ciphers option, if set, must be something which the
2180 Returns: NULL on success, or error message
2184 tls_validate_require_cipher(void)
2187 uschar *s, *expciphers, *err;
2189 /* this duplicates from tls_init(), we need a better "init just global
2190 state, for no specific purpose" singleton function of our own */
2192 SSL_load_error_strings();
2193 OpenSSL_add_ssl_algorithms();
2194 #if (OPENSSL_VERSION_NUMBER >= 0x0090800fL) && !defined(OPENSSL_NO_SHA256)
2195 /* SHA256 is becoming ever more popular. This makes sure it gets added to the
2196 list of available digests. */
2197 EVP_add_digest(EVP_sha256());
2200 if (!(tls_require_ciphers && *tls_require_ciphers))
2203 if (!expand_check(tls_require_ciphers, US"tls_require_ciphers", &expciphers))
2204 return US"failed to expand tls_require_ciphers";
2206 if (!(expciphers && *expciphers))
2209 /* normalisation ripped from above */
2211 while (*s != 0) { if (*s == '_') *s = '-'; s++; }
2215 ctx = SSL_CTX_new(SSLv23_server_method());
2218 ERR_error_string(ERR_get_error(), ssl_errstring);
2219 return string_sprintf("SSL_CTX_new() failed: %s", ssl_errstring);
2223 debug_printf("tls_require_ciphers expands to \"%s\"\n", expciphers);
2225 if (!SSL_CTX_set_cipher_list(ctx, CS expciphers))
2227 ERR_error_string(ERR_get_error(), ssl_errstring);
2228 err = string_sprintf("SSL_CTX_set_cipher_list(%s) failed", expciphers);
2239 /*************************************************
2240 * Report the library versions. *
2241 *************************************************/
2243 /* There have historically been some issues with binary compatibility in
2244 OpenSSL libraries; if Exim (like many other applications) is built against
2245 one version of OpenSSL but the run-time linker picks up another version,
2246 it can result in serious failures, including crashing with a SIGSEGV. So
2247 report the version found by the compiler and the run-time version.
2249 Note: some OS vendors backport security fixes without changing the version
2250 number/string, and the version date remains unchanged. The _build_ date
2251 will change, so we can more usefully assist with version diagnosis by also
2252 reporting the build date.
2254 Arguments: a FILE* to print the results to
2259 tls_version_report(FILE *f)
2261 fprintf(f, "Library version: OpenSSL: Compile: %s\n"
2264 OPENSSL_VERSION_TEXT,
2265 SSLeay_version(SSLEAY_VERSION),
2266 SSLeay_version(SSLEAY_BUILT_ON));
2267 /* third line is 38 characters for the %s and the line is 73 chars long;
2268 the OpenSSL output includes a "built on: " prefix already. */
2274 /*************************************************
2275 * Random number generation *
2276 *************************************************/
2278 /* Pseudo-random number generation. The result is not expected to be
2279 cryptographically strong but not so weak that someone will shoot themselves
2280 in the foot using it as a nonce in input in some email header scheme or
2281 whatever weirdness they'll twist this into. The result should handle fork()
2282 and avoid repeating sequences. OpenSSL handles that for us.
2286 Returns a random number in range [0, max-1]
2290 vaguely_random_number(int max)
2294 static pid_t pidlast = 0;
2297 uschar smallbuf[sizeof(r)];
2303 if (pidnow != pidlast)
2305 /* Although OpenSSL documents that "OpenSSL makes sure that the PRNG state
2306 is unique for each thread", this doesn't apparently apply across processes,
2307 so our own warning from vaguely_random_number_fallback() applies here too.
2308 Fix per PostgreSQL. */
2314 /* OpenSSL auto-seeds from /dev/random, etc, but this a double-check. */
2318 gettimeofday(&r.tv, NULL);
2321 RAND_seed((uschar *)(&r), sizeof(r));
2323 /* We're after pseudo-random, not random; if we still don't have enough data
2324 in the internal PRNG then our options are limited. We could sleep and hope
2325 for entropy to come along (prayer technique) but if the system is so depleted
2326 in the first place then something is likely to just keep taking it. Instead,
2327 we'll just take whatever little bit of pseudo-random we can still manage to
2330 needed_len = sizeof(r);
2331 /* Don't take 8 times more entropy than needed if int is 8 octets and we were
2332 asked for a number less than 10. */
2333 for (r = max, i = 0; r; ++i)
2339 /* We do not care if crypto-strong */
2340 i = RAND_pseudo_bytes(smallbuf, needed_len);
2344 debug_printf("OpenSSL RAND_pseudo_bytes() not supported by RAND method, using fallback.\n");
2345 return vaguely_random_number_fallback(max);
2349 for (p = smallbuf; needed_len; --needed_len, ++p)
2355 /* We don't particularly care about weighted results; if someone wants
2356 smooth distribution and cares enough then they should submit a patch then. */
2363 /*************************************************
2364 * OpenSSL option parse *
2365 *************************************************/
2367 /* Parse one option for tls_openssl_options_parse below
2370 name one option name
2371 value place to store a value for it
2372 Returns success or failure in parsing
2375 struct exim_openssl_option {
2379 /* We could use a macro to expand, but we need the ifdef and not all the
2380 options document which version they were introduced in. Policylet: include
2381 all options unless explicitly for DTLS, let the administrator choose which
2384 This list is current as of:
2386 Plus SSL_OP_SAFARI_ECDHE_ECDSA_BUG from 2013-June patch/discussion on openssl-dev
2388 static struct exim_openssl_option exim_openssl_options[] = {
2389 /* KEEP SORTED ALPHABETICALLY! */
2391 { US"all", SSL_OP_ALL },
2393 #ifdef SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION
2394 { US"allow_unsafe_legacy_renegotiation", SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION },
2396 #ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
2397 { US"cipher_server_preference", SSL_OP_CIPHER_SERVER_PREFERENCE },
2399 #ifdef SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS
2400 { US"dont_insert_empty_fragments", SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS },
2402 #ifdef SSL_OP_EPHEMERAL_RSA
2403 { US"ephemeral_rsa", SSL_OP_EPHEMERAL_RSA },
2405 #ifdef SSL_OP_LEGACY_SERVER_CONNECT
2406 { US"legacy_server_connect", SSL_OP_LEGACY_SERVER_CONNECT },
2408 #ifdef SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
2409 { US"microsoft_big_sslv3_buffer", SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER },
2411 #ifdef SSL_OP_MICROSOFT_SESS_ID_BUG
2412 { US"microsoft_sess_id_bug", SSL_OP_MICROSOFT_SESS_ID_BUG },
2414 #ifdef SSL_OP_MSIE_SSLV2_RSA_PADDING
2415 { US"msie_sslv2_rsa_padding", SSL_OP_MSIE_SSLV2_RSA_PADDING },
2417 #ifdef SSL_OP_NETSCAPE_CHALLENGE_BUG
2418 { US"netscape_challenge_bug", SSL_OP_NETSCAPE_CHALLENGE_BUG },
2420 #ifdef SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
2421 { US"netscape_reuse_cipher_change_bug", SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG },
2423 #ifdef SSL_OP_NO_COMPRESSION
2424 { US"no_compression", SSL_OP_NO_COMPRESSION },
2426 #ifdef SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
2427 { US"no_session_resumption_on_renegotiation", SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION },
2429 #ifdef SSL_OP_NO_SSLv2
2430 { US"no_sslv2", SSL_OP_NO_SSLv2 },
2432 #ifdef SSL_OP_NO_SSLv3
2433 { US"no_sslv3", SSL_OP_NO_SSLv3 },
2435 #ifdef SSL_OP_NO_TICKET
2436 { US"no_ticket", SSL_OP_NO_TICKET },
2438 #ifdef SSL_OP_NO_TLSv1
2439 { US"no_tlsv1", SSL_OP_NO_TLSv1 },
2441 #ifdef SSL_OP_NO_TLSv1_1
2442 #if SSL_OP_NO_TLSv1_1 == 0x00000400L
2443 /* Error in chosen value in 1.0.1a; see first item in CHANGES for 1.0.1b */
2444 #warning OpenSSL 1.0.1a uses a bad value for SSL_OP_NO_TLSv1_1, ignoring
2446 { US"no_tlsv1_1", SSL_OP_NO_TLSv1_1 },
2449 #ifdef SSL_OP_NO_TLSv1_2
2450 { US"no_tlsv1_2", SSL_OP_NO_TLSv1_2 },
2452 #ifdef SSL_OP_SAFARI_ECDHE_ECDSA_BUG
2453 { US"safari_ecdhe_ecdsa_bug", SSL_OP_SAFARI_ECDHE_ECDSA_BUG },
2455 #ifdef SSL_OP_SINGLE_DH_USE
2456 { US"single_dh_use", SSL_OP_SINGLE_DH_USE },
2458 #ifdef SSL_OP_SINGLE_ECDH_USE
2459 { US"single_ecdh_use", SSL_OP_SINGLE_ECDH_USE },
2461 #ifdef SSL_OP_SSLEAY_080_CLIENT_DH_BUG
2462 { US"ssleay_080_client_dh_bug", SSL_OP_SSLEAY_080_CLIENT_DH_BUG },
2464 #ifdef SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
2465 { US"sslref2_reuse_cert_type_bug", SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG },
2467 #ifdef SSL_OP_TLS_BLOCK_PADDING_BUG
2468 { US"tls_block_padding_bug", SSL_OP_TLS_BLOCK_PADDING_BUG },
2470 #ifdef SSL_OP_TLS_D5_BUG
2471 { US"tls_d5_bug", SSL_OP_TLS_D5_BUG },
2473 #ifdef SSL_OP_TLS_ROLLBACK_BUG
2474 { US"tls_rollback_bug", SSL_OP_TLS_ROLLBACK_BUG },
2477 static int exim_openssl_options_size =
2478 sizeof(exim_openssl_options)/sizeof(struct exim_openssl_option);
2482 tls_openssl_one_option_parse(uschar *name, long *value)
2485 int last = exim_openssl_options_size;
2486 while (last > first)
2488 int middle = (first + last)/2;
2489 int c = Ustrcmp(name, exim_openssl_options[middle].name);
2492 *value = exim_openssl_options[middle].value;
2506 /*************************************************
2507 * OpenSSL option parsing logic *
2508 *************************************************/
2510 /* OpenSSL has a number of compatibility options which an administrator might
2511 reasonably wish to set. Interpret a list similarly to decode_bits(), so that
2512 we look like log_selector.
2515 option_spec the administrator-supplied string of options
2516 results ptr to long storage for the options bitmap
2517 Returns success or failure
2521 tls_openssl_options_parse(uschar *option_spec, long *results)
2526 BOOL adding, item_parsed;
2529 /* Prior to 4.80 we or'd in SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS; removed
2530 * from default because it increases BEAST susceptibility. */
2531 #ifdef SSL_OP_NO_SSLv2
2532 result |= SSL_OP_NO_SSLv2;
2535 if (option_spec == NULL)
2541 for (s=option_spec; *s != '\0'; /**/)
2543 while (isspace(*s)) ++s;
2546 if (*s != '+' && *s != '-')
2548 DEBUG(D_tls) debug_printf("malformed openssl option setting: "
2549 "+ or - expected but found \"%s\"\n", s);
2552 adding = *s++ == '+';
2553 for (end = s; (*end != '\0') && !isspace(*end); ++end) /**/ ;
2556 item_parsed = tls_openssl_one_option_parse(s, &item);
2559 DEBUG(D_tls) debug_printf("openssl option setting unrecognised: \"%s\"\n", s);
2562 DEBUG(D_tls) debug_printf("openssl option, %s from %lx: %lx (%s)\n",
2563 adding ? "adding" : "removing", result, item, s);
2578 /* End of tls-openssl.c */