1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* This module provides the TLS (aka SSL) support for Exim using the OpenSSL
9 library. It is #included into the tls.c file when that library is used. The
10 code herein is based on a patch that was originally contributed by Steve
11 Haslam. It was adapted from stunnel, a GPL program by Michal Trojnara.
13 No cryptographic code is included in Exim. All this module does is to call
14 functions from the OpenSSL library. */
19 #include <openssl/lhash.h>
20 #include <openssl/ssl.h>
21 #include <openssl/err.h>
22 #include <openssl/rand.h>
24 /* Structure for collecting random data for seeding. */
26 typedef struct randstuff {
31 /* Local static variables */
33 static BOOL verify_callback_called = FALSE;
34 static const uschar *sid_ctx = US"exim";
36 static SSL_CTX *ctx = NULL;
37 static SSL *ssl = NULL;
39 static char ssl_errstring[256];
41 static int ssl_session_timeout = 200;
42 static BOOL verify_optional = FALSE;
48 /*************************************************
50 *************************************************/
52 /* Called from lots of places when errors occur before actually starting to do
53 the TLS handshake, that is, while the session is still in clear. Always returns
54 DEFER for a server and FAIL for a client so that most calls can use "return
55 tls_error(...)" to do this processing and then give an appropriate return. A
56 single function is used for both server and client, because it is called from
57 some shared functions.
60 prefix text to include in the logged error
61 host NULL if setting up a server;
62 the connected host if setting up a client
63 msg error message or NULL if we should ask OpenSSL
65 Returns: OK/DEFER/FAIL
69 tls_error(uschar *prefix, host_item *host, uschar *msg)
73 ERR_error_string(ERR_get_error(), ssl_errstring);
74 msg = (uschar *)ssl_errstring;
79 uschar *conn_info = smtp_get_connection_info();
80 if (Ustrncmp(conn_info, US"SMTP ", 5) == 0)
82 log_write(0, LOG_MAIN, "TLS error on %s (%s): %s",
83 conn_info, prefix, msg);
88 log_write(0, LOG_MAIN, "TLS error on connection to %s [%s] (%s): %s",
89 host->name, host->address, prefix, msg);
96 /*************************************************
97 * Callback to generate RSA key *
98 *************************************************/
106 Returns: pointer to generated key
110 rsa_callback(SSL *s, int export, int keylength)
113 export = export; /* Shut picky compilers up */
114 DEBUG(D_tls) debug_printf("Generating %d bit RSA key...\n", keylength);
115 rsa_key = RSA_generate_key(keylength, RSA_F4, NULL, NULL);
118 ERR_error_string(ERR_get_error(), ssl_errstring);
119 log_write(0, LOG_MAIN|LOG_PANIC, "TLS error (RSA_generate_key): %s",
129 /*************************************************
130 * Callback for verification *
131 *************************************************/
133 /* The SSL library does certificate verification if set up to do so. This
134 callback has the current yes/no state is in "state". If verification succeeded,
135 we set up the tls_peerdn string. If verification failed, what happens depends
136 on whether the client is required to present a verifiable certificate or not.
138 If verification is optional, we change the state to yes, but still log the
139 verification error. For some reason (it really would help to have proper
140 documentation of OpenSSL), this callback function then gets called again, this
141 time with state = 1. In fact, that's useful, because we can set up the peerdn
142 value, but we must take care not to set the private verified flag on the second
145 Note: this function is not called if the client fails to present a certificate
146 when asked. We get here only if a certificate has been received. Handling of
147 optional verification for this case is done when requesting SSL to verify, by
148 setting SSL_VERIFY_FAIL_IF_NO_PEER_CERT in the non-optional case.
151 state current yes/no state as 1/0
152 x509ctx certificate information.
154 Returns: 1 if verified, 0 if not
158 verify_callback(int state, X509_STORE_CTX *x509ctx)
160 static uschar txt[256];
162 X509_NAME_oneline(X509_get_subject_name(x509ctx->current_cert),
163 CS txt, sizeof(txt));
167 log_write(0, LOG_MAIN, "SSL verify error: depth=%d error=%s cert=%s",
168 x509ctx->error_depth,
169 X509_verify_cert_error_string(x509ctx->error),
171 tls_certificate_verified = FALSE;
172 verify_callback_called = TRUE;
173 if (!verify_optional) return 0; /* reject */
174 DEBUG(D_tls) debug_printf("SSL verify failure overridden (host in "
175 "tls_try_verify_hosts)\n");
176 return 1; /* accept */
179 if (x509ctx->error_depth != 0)
181 DEBUG(D_tls) debug_printf("SSL verify ok: depth=%d cert=%s\n",
182 x509ctx->error_depth, txt);
186 DEBUG(D_tls) debug_printf("SSL%s peer: %s\n",
187 verify_callback_called? "" : " authenticated", txt);
191 if (!verify_callback_called) tls_certificate_verified = TRUE;
192 verify_callback_called = TRUE;
194 return 1; /* accept */
199 /*************************************************
200 * Information callback *
201 *************************************************/
203 /* The SSL library functions call this from time to time to indicate what they
204 are doing. We copy the string to the debugging output when the level is high
216 info_callback(SSL *s, int where, int ret)
220 DEBUG(D_tls) debug_printf("SSL info: %s\n", SSL_state_string_long(s));
225 /*************************************************
226 * Initialize for DH *
227 *************************************************/
229 /* If dhparam is set, expand it, and load up the parameters for DH encryption.
232 dhparam DH parameter file
233 host connected host, if client; NULL if server
235 Returns: TRUE if OK (nothing to set up, or setup worked)
239 init_dh(uschar *dhparam, host_item *host)
246 if (!expand_check(dhparam, US"tls_dhparam", &dhexpanded))
249 if (dhexpanded == NULL) return TRUE;
251 if ((bio = BIO_new_file(CS dhexpanded, "r")) == NULL)
253 tls_error(string_sprintf("could not read dhparams file %s", dhexpanded),
254 host, (uschar *)strerror(errno));
259 if ((dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL)) == NULL)
261 tls_error(string_sprintf("could not read dhparams file %s", dhexpanded),
267 SSL_CTX_set_tmp_dh(ctx, dh);
269 debug_printf("Diffie-Hellman initialized from %s with %d-bit key\n",
270 dhexpanded, 8*DH_size(dh));
282 /*************************************************
283 * Initialize for TLS *
284 *************************************************/
286 /* Called from both server and client code, to do preliminary initialization of
290 host connected host, if client; NULL if server
291 dhparam DH parameter file
292 certificate certificate file
293 privatekey private key
294 addr address if client; NULL if server (for some randomness)
296 Returns: OK/DEFER/FAIL
300 tls_init(host_item *host, uschar *dhparam, uschar *certificate,
301 uschar *privatekey, address_item *addr)
306 SSL_load_error_strings(); /* basic set up */
307 OpenSSL_add_ssl_algorithms();
309 #if (OPENSSL_VERSION_NUMBER >= 0x0090800fL) && !defined(OPENSSL_NO_SHA256)
310 /* SHA256 is becoming ever more popular. This makes sure it gets added to the
311 list of available digests. */
312 EVP_add_digest(EVP_sha256());
315 /* Create a context */
317 ctx = SSL_CTX_new((host == NULL)?
318 SSLv23_server_method() : SSLv23_client_method());
320 if (ctx == NULL) return tls_error(US"SSL_CTX_new", host, NULL);
322 /* It turns out that we need to seed the random number generator this early in
323 order to get the full complement of ciphers to work. It took me roughly a day
324 of work to discover this by experiment.
326 On systems that have /dev/urandom, SSL may automatically seed itself from
327 there. Otherwise, we have to make something up as best we can. Double check
333 gettimeofday(&r.tv, NULL);
336 RAND_seed((uschar *)(&r), sizeof(r));
337 RAND_seed((uschar *)big_buffer, big_buffer_size);
338 if (addr != NULL) RAND_seed((uschar *)addr, sizeof(addr));
341 return tls_error(US"RAND_status", host,
342 US"unable to seed random number generator");
345 /* Set up the information callback, which outputs if debugging is at a suitable
348 SSL_CTX_set_info_callback(ctx, (void (*)())info_callback);
350 /* Automatically re-try reads/writes after renegotiation. */
351 (void) SSL_CTX_set_mode(ctx, SSL_MODE_AUTO_RETRY);
353 /* Apply administrator-supplied work-arounds.
354 Historically we applied just one requested option,
355 SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS, but when bug 994 requested a second, we
356 moved to an administrator-controlled list of options to specify and
357 grandfathered in the first one as the default value for "openssl_options".
359 No OpenSSL version number checks: the options we accept depend upon the
360 availability of the option value macros from OpenSSL. */
362 okay = tls_openssl_options_parse(openssl_options, &init_options);
364 return tls_error(US"openssl_options parsing failed", host, NULL);
368 DEBUG(D_tls) debug_printf("setting SSL CTX options: %#lx\n", init_options);
369 if (!(SSL_CTX_set_options(ctx, init_options)))
370 return tls_error(string_sprintf(
371 "SSL_CTX_set_option(%#lx)", init_options), host, NULL);
374 DEBUG(D_tls) debug_printf("no SSL CTX options to set\n");
376 /* Initialize with DH parameters if supplied */
378 if (!init_dh(dhparam, host)) return DEFER;
380 /* Set up certificate and key */
382 if (certificate != NULL)
385 if (!expand_check(certificate, US"tls_certificate", &expanded))
388 if (expanded != NULL)
390 DEBUG(D_tls) debug_printf("tls_certificate file %s\n", expanded);
391 if (!SSL_CTX_use_certificate_chain_file(ctx, CS expanded))
392 return tls_error(string_sprintf(
393 "SSL_CTX_use_certificate_chain_file file=%s", expanded), host, NULL);
396 if (privatekey != NULL &&
397 !expand_check(privatekey, US"tls_privatekey", &expanded))
400 /* If expansion was forced to fail, key_expanded will be NULL. If the result
401 of the expansion is an empty string, ignore it also, and assume the private
402 key is in the same file as the certificate. */
404 if (expanded != NULL && *expanded != 0)
406 DEBUG(D_tls) debug_printf("tls_privatekey file %s\n", expanded);
407 if (!SSL_CTX_use_PrivateKey_file(ctx, CS expanded, SSL_FILETYPE_PEM))
408 return tls_error(string_sprintf(
409 "SSL_CTX_use_PrivateKey_file file=%s", expanded), host, NULL);
413 /* Set up the RSA callback */
415 SSL_CTX_set_tmp_rsa_callback(ctx, rsa_callback);
417 /* Finally, set the timeout, and we are done */
419 SSL_CTX_set_timeout(ctx, ssl_session_timeout);
420 DEBUG(D_tls) debug_printf("Initialized TLS\n");
427 /*************************************************
428 * Get name of cipher in use *
429 *************************************************/
431 /* The answer is left in a static buffer, and tls_cipher is set to point
434 Argument: pointer to an SSL structure for the connection
439 construct_cipher_name(SSL *ssl)
441 static uschar cipherbuf[256];
442 /* With OpenSSL 1.0.0a, this needs to be const but the documentation doesn't
443 yet reflect that. It should be a safe change anyway, even 0.9.8 versions have
444 the accessor functions use const in the prototype. */
448 switch (ssl->session->ssl_version)
462 #ifdef TLS1_1_VERSION
468 #ifdef TLS1_2_VERSION
478 c = (const SSL_CIPHER *) SSL_get_current_cipher(ssl);
479 SSL_CIPHER_get_bits(c, &tls_bits);
481 string_format(cipherbuf, sizeof(cipherbuf), "%s:%s:%u", ver,
482 SSL_CIPHER_get_name(c), tls_bits);
483 tls_cipher = cipherbuf;
485 DEBUG(D_tls) debug_printf("Cipher: %s\n", cipherbuf);
492 /*************************************************
493 * Set up for verifying certificates *
494 *************************************************/
496 /* Called by both client and server startup
499 certs certs file or NULL
501 host NULL in a server; the remote host in a client
502 optional TRUE if called from a server for a host in tls_try_verify_hosts;
503 otherwise passed as FALSE
505 Returns: OK/DEFER/FAIL
509 setup_certs(uschar *certs, uschar *crl, host_item *host, BOOL optional)
511 uschar *expcerts, *expcrl;
513 if (!expand_check(certs, US"tls_verify_certificates", &expcerts))
516 if (expcerts != NULL)
519 if (!SSL_CTX_set_default_verify_paths(ctx))
520 return tls_error(US"SSL_CTX_set_default_verify_paths", host, NULL);
522 if (Ustat(expcerts, &statbuf) < 0)
524 log_write(0, LOG_MAIN|LOG_PANIC,
525 "failed to stat %s for certificates", expcerts);
531 if ((statbuf.st_mode & S_IFMT) == S_IFDIR)
532 { file = NULL; dir = expcerts; }
534 { file = expcerts; dir = NULL; }
536 /* If a certificate file is empty, the next function fails with an
537 unhelpful error message. If we skip it, we get the correct behaviour (no
538 certificates are recognized, but the error message is still misleading (it
539 says no certificate was supplied.) But this is better. */
541 if ((file == NULL || statbuf.st_size > 0) &&
542 !SSL_CTX_load_verify_locations(ctx, CS file, CS dir))
543 return tls_error(US"SSL_CTX_load_verify_locations", host, NULL);
547 SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(CS file));
551 /* Handle a certificate revocation list. */
553 #if OPENSSL_VERSION_NUMBER > 0x00907000L
555 /* This bit of code is now the version supplied by Lars Mainka. (I have
556 * merely reformatted it into the Exim code style.)
558 * "From here I changed the code to add support for multiple crl's
559 * in pem format in one file or to support hashed directory entries in
560 * pem format instead of a file. This method now uses the library function
561 * X509_STORE_load_locations to add the CRL location to the SSL context.
562 * OpenSSL will then handle the verify against CA certs and CRLs by
563 * itself in the verify callback." */
565 if (!expand_check(crl, US"tls_crl", &expcrl)) return DEFER;
566 if (expcrl != NULL && *expcrl != 0)
568 struct stat statbufcrl;
569 if (Ustat(expcrl, &statbufcrl) < 0)
571 log_write(0, LOG_MAIN|LOG_PANIC,
572 "failed to stat %s for certificates revocation lists", expcrl);
577 /* is it a file or directory? */
579 X509_STORE *cvstore = SSL_CTX_get_cert_store(ctx);
580 if ((statbufcrl.st_mode & S_IFMT) == S_IFDIR)
584 DEBUG(D_tls) debug_printf("SSL CRL value is a directory %s\n", dir);
590 DEBUG(D_tls) debug_printf("SSL CRL value is a file %s\n", file);
592 if (X509_STORE_load_locations(cvstore, CS file, CS dir) == 0)
593 return tls_error(US"X509_STORE_load_locations", host, NULL);
595 /* setting the flags to check against the complete crl chain */
597 X509_STORE_set_flags(cvstore,
598 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
602 #endif /* OPENSSL_VERSION_NUMBER > 0x00907000L */
604 /* If verification is optional, don't fail if no certificate */
606 SSL_CTX_set_verify(ctx,
607 SSL_VERIFY_PEER | (optional? 0 : SSL_VERIFY_FAIL_IF_NO_PEER_CERT),
616 /*************************************************
617 * Start a TLS session in a server *
618 *************************************************/
620 /* This is called when Exim is running as a server, after having received
621 the STARTTLS command. It must respond to that command, and then negotiate
625 require_ciphers allowed ciphers
626 ------------------------------------------------------
627 require_mac list of allowed MACs ) Not used
628 require_kx list of allowed key_exchange methods ) for
629 require_proto list of allowed protocols ) OpenSSL
630 ------------------------------------------------------
632 Returns: OK on success
633 DEFER for errors before the start of the negotiation
634 FAIL for errors during the negotation; the server can't
639 tls_server_start(uschar *require_ciphers, uschar *require_mac,
640 uschar *require_kx, uschar *require_proto)
645 /* Check for previous activation */
649 tls_error(US"STARTTLS received after TLS started", NULL, US"");
650 smtp_printf("554 Already in TLS\r\n");
654 /* Initialize the SSL library. If it fails, it will already have logged
657 rc = tls_init(NULL, tls_dhparam, tls_certificate, tls_privatekey, NULL);
658 if (rc != OK) return rc;
660 if (!expand_check(require_ciphers, US"tls_require_ciphers", &expciphers))
663 /* In OpenSSL, cipher components are separated by hyphens. In GnuTLS, they
664 are separated by underscores. So that I can use either form in my tests, and
665 also for general convenience, we turn underscores into hyphens here. */
667 if (expciphers != NULL)
669 uschar *s = expciphers;
670 while (*s != 0) { if (*s == '_') *s = '-'; s++; }
671 DEBUG(D_tls) debug_printf("required ciphers: %s\n", expciphers);
672 if (!SSL_CTX_set_cipher_list(ctx, CS expciphers))
673 return tls_error(US"SSL_CTX_set_cipher_list", NULL, NULL);
676 /* If this is a host for which certificate verification is mandatory or
677 optional, set up appropriately. */
679 tls_certificate_verified = FALSE;
680 verify_callback_called = FALSE;
682 if (verify_check_host(&tls_verify_hosts) == OK)
684 rc = setup_certs(tls_verify_certificates, tls_crl, NULL, FALSE);
685 if (rc != OK) return rc;
686 verify_optional = FALSE;
688 else if (verify_check_host(&tls_try_verify_hosts) == OK)
690 rc = setup_certs(tls_verify_certificates, tls_crl, NULL, TRUE);
691 if (rc != OK) return rc;
692 verify_optional = TRUE;
695 /* Prepare for new connection */
697 if ((ssl = SSL_new(ctx)) == NULL) return tls_error(US"SSL_new", NULL, NULL);
700 /* Set context and tell client to go ahead, except in the case of TLS startup
701 on connection, where outputting anything now upsets the clients and tends to
702 make them disconnect. We need to have an explicit fflush() here, to force out
703 the response. Other smtp_printf() calls do not need it, because in non-TLS
704 mode, the fflush() happens when smtp_getc() is called. */
706 SSL_set_session_id_context(ssl, sid_ctx, Ustrlen(sid_ctx));
709 smtp_printf("220 TLS go ahead\r\n");
713 /* Now negotiate the TLS session. We put our own timer on it, since it seems
714 that the OpenSSL library doesn't. */
716 SSL_set_wfd(ssl, fileno(smtp_out));
717 SSL_set_rfd(ssl, fileno(smtp_in));
718 SSL_set_accept_state(ssl);
720 DEBUG(D_tls) debug_printf("Calling SSL_accept\n");
722 sigalrm_seen = FALSE;
723 if (smtp_receive_timeout > 0) alarm(smtp_receive_timeout);
724 rc = SSL_accept(ssl);
729 tls_error(US"SSL_accept", NULL, sigalrm_seen ? US"timed out" : NULL);
730 if (ERR_get_error() == 0)
731 log_write(0, LOG_MAIN,
732 "TLS client disconnected cleanly (rejected our certificate?)");
736 DEBUG(D_tls) debug_printf("SSL_accept was successful\n");
738 /* TLS has been set up. Adjust the input functions to read via TLS,
739 and initialize things. */
741 construct_cipher_name(ssl);
746 if (SSL_get_shared_ciphers(ssl, CS buf, sizeof(buf)) != NULL)
747 debug_printf("Shared ciphers: %s\n", buf);
751 ssl_xfer_buffer = store_malloc(ssl_xfer_buffer_size);
752 ssl_xfer_buffer_lwm = ssl_xfer_buffer_hwm = 0;
753 ssl_xfer_eof = ssl_xfer_error = 0;
755 receive_getc = tls_getc;
756 receive_ungetc = tls_ungetc;
757 receive_feof = tls_feof;
758 receive_ferror = tls_ferror;
759 receive_smtp_buffered = tls_smtp_buffered;
761 tls_active = fileno(smtp_out);
769 /*************************************************
770 * Start a TLS session in a client *
771 *************************************************/
773 /* Called from the smtp transport after STARTTLS has been accepted.
776 fd the fd of the connection
777 host connected host (for messages)
778 addr the first address
779 dhparam DH parameter file
780 certificate certificate file
781 privatekey private key file
782 verify_certs file for certificate verify
783 crl file containing CRL
784 require_ciphers list of allowed ciphers
785 ------------------------------------------------------
786 require_mac list of allowed MACs ) Not used
787 require_kx list of allowed key_exchange methods ) for
788 require_proto list of allowed protocols ) OpenSSL
789 ------------------------------------------------------
790 timeout startup timeout
792 Returns: OK on success
793 FAIL otherwise - note that tls_error() will not give DEFER
794 because this is not a server
798 tls_client_start(int fd, host_item *host, address_item *addr, uschar *dhparam,
799 uschar *certificate, uschar *privatekey, uschar *verify_certs, uschar *crl,
800 uschar *require_ciphers, uschar *require_mac, uschar *require_kx,
801 uschar *require_proto, int timeout)
803 static uschar txt[256];
808 rc = tls_init(host, dhparam, certificate, privatekey, addr);
809 if (rc != OK) return rc;
811 tls_certificate_verified = FALSE;
812 verify_callback_called = FALSE;
814 if (!expand_check(require_ciphers, US"tls_require_ciphers", &expciphers))
817 /* In OpenSSL, cipher components are separated by hyphens. In GnuTLS, they
818 are separated by underscores. So that I can use either form in my tests, and
819 also for general convenience, we turn underscores into hyphens here. */
821 if (expciphers != NULL)
823 uschar *s = expciphers;
824 while (*s != 0) { if (*s == '_') *s = '-'; s++; }
825 DEBUG(D_tls) debug_printf("required ciphers: %s\n", expciphers);
826 if (!SSL_CTX_set_cipher_list(ctx, CS expciphers))
827 return tls_error(US"SSL_CTX_set_cipher_list", host, NULL);
830 rc = setup_certs(verify_certs, crl, host, FALSE);
831 if (rc != OK) return rc;
833 if ((ssl = SSL_new(ctx)) == NULL) return tls_error(US"SSL_new", host, NULL);
834 SSL_set_session_id_context(ssl, sid_ctx, Ustrlen(sid_ctx));
836 SSL_set_connect_state(ssl);
838 /* There doesn't seem to be a built-in timeout on connection. */
840 DEBUG(D_tls) debug_printf("Calling SSL_connect\n");
841 sigalrm_seen = FALSE;
843 rc = SSL_connect(ssl);
847 return tls_error(US"SSL_connect", host, sigalrm_seen ? US"timed out" : NULL);
849 DEBUG(D_tls) debug_printf("SSL_connect succeeded\n");
851 /* Beware anonymous ciphers which lead to server_cert being NULL */
852 server_cert = SSL_get_peer_certificate (ssl);
855 tls_peerdn = US X509_NAME_oneline(X509_get_subject_name(server_cert),
856 CS txt, sizeof(txt));
862 construct_cipher_name(ssl); /* Sets tls_cipher */
872 /*************************************************
873 * TLS version of getc *
874 *************************************************/
876 /* This gets the next byte from the TLS input buffer. If the buffer is empty,
877 it refills the buffer via the SSL reading function.
880 Returns: the next character or EOF
886 if (ssl_xfer_buffer_lwm >= ssl_xfer_buffer_hwm)
891 DEBUG(D_tls) debug_printf("Calling SSL_read(%p, %p, %u)\n", ssl,
892 ssl_xfer_buffer, ssl_xfer_buffer_size);
894 if (smtp_receive_timeout > 0) alarm(smtp_receive_timeout);
895 inbytes = SSL_read(ssl, CS ssl_xfer_buffer, ssl_xfer_buffer_size);
896 error = SSL_get_error(ssl, inbytes);
899 /* SSL_ERROR_ZERO_RETURN appears to mean that the SSL session has been
900 closed down, not that the socket itself has been closed down. Revert to
903 if (error == SSL_ERROR_ZERO_RETURN)
905 DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
907 receive_getc = smtp_getc;
908 receive_ungetc = smtp_ungetc;
909 receive_feof = smtp_feof;
910 receive_ferror = smtp_ferror;
911 receive_smtp_buffered = smtp_buffered;
922 /* Handle genuine errors */
924 else if (error == SSL_ERROR_SSL)
926 ERR_error_string(ERR_get_error(), ssl_errstring);
927 log_write(0, LOG_MAIN, "TLS error (SSL_read): %s", ssl_errstring);
932 else if (error != SSL_ERROR_NONE)
934 DEBUG(D_tls) debug_printf("Got SSL error %d\n", error);
940 dkim_exim_verify_feed(ssl_xfer_buffer, inbytes);
942 ssl_xfer_buffer_hwm = inbytes;
943 ssl_xfer_buffer_lwm = 0;
946 /* Something in the buffer; return next uschar */
948 return ssl_xfer_buffer[ssl_xfer_buffer_lwm++];
953 /*************************************************
954 * Read bytes from TLS channel *
955 *************************************************/
962 Returns: the number of bytes read
963 -1 after a failed read
967 tls_read(uschar *buff, size_t len)
972 DEBUG(D_tls) debug_printf("Calling SSL_read(%p, %p, %u)\n", ssl,
973 buff, (unsigned int)len);
975 inbytes = SSL_read(ssl, CS buff, len);
976 error = SSL_get_error(ssl, inbytes);
978 if (error == SSL_ERROR_ZERO_RETURN)
980 DEBUG(D_tls) debug_printf("Got SSL_ERROR_ZERO_RETURN\n");
983 else if (error != SSL_ERROR_NONE)
995 /*************************************************
996 * Write bytes down TLS channel *
997 *************************************************/
1004 Returns: the number of bytes after a successful write,
1005 -1 after a failed write
1009 tls_write(const uschar *buff, size_t len)
1015 DEBUG(D_tls) debug_printf("tls_do_write(%p, %d)\n", buff, left);
1018 DEBUG(D_tls) debug_printf("SSL_write(SSL, %p, %d)\n", buff, left);
1019 outbytes = SSL_write(ssl, CS buff, left);
1020 error = SSL_get_error(ssl, outbytes);
1021 DEBUG(D_tls) debug_printf("outbytes=%d error=%d\n", outbytes, error);
1025 ERR_error_string(ERR_get_error(), ssl_errstring);
1026 log_write(0, LOG_MAIN, "TLS error (SSL_write): %s", ssl_errstring);
1029 case SSL_ERROR_NONE:
1034 case SSL_ERROR_ZERO_RETURN:
1035 log_write(0, LOG_MAIN, "SSL channel closed on write");
1039 log_write(0, LOG_MAIN, "SSL_write error %d", error);
1048 /*************************************************
1049 * Close down a TLS session *
1050 *************************************************/
1052 /* This is also called from within a delivery subprocess forked from the
1053 daemon, to shut down the TLS library, without actually doing a shutdown (which
1054 would tamper with the SSL session in the parent process).
1056 Arguments: TRUE if SSL_shutdown is to be called
1061 tls_close(BOOL shutdown)
1063 if (tls_active < 0) return; /* TLS was not active */
1067 DEBUG(D_tls) debug_printf("tls_close(): shutting down SSL\n");
1080 /*************************************************
1081 * Report the library versions. *
1082 *************************************************/
1084 /* There have historically been some issues with binary compatibility in
1085 OpenSSL libraries; if Exim (like many other applications) is built against
1086 one version of OpenSSL but the run-time linker picks up another version,
1087 it can result in serious failures, including crashing with a SIGSEGV. So
1088 report the version found by the compiler and the run-time version.
1090 Arguments: a FILE* to print the results to
1095 tls_version_report(FILE *f)
1097 fprintf(f, "Library version: OpenSSL: Compile: %s\n"
1099 OPENSSL_VERSION_TEXT,
1100 SSLeay_version(SSLEAY_VERSION));
1106 /*************************************************
1107 * Pseudo-random number generation *
1108 *************************************************/
1110 /* Pseudo-random number generation. The result is not expected to be
1111 cryptographically strong but not so weak that someone will shoot themselves
1112 in the foot using it as a nonce in input in some email header scheme or
1113 whatever weirdness they'll twist this into. The result should handle fork()
1114 and avoid repeating sequences. OpenSSL handles that for us.
1118 Returns a random number in range [0, max-1]
1122 pseudo_random_number(int max)
1127 uschar smallbuf[sizeof(r)];
1132 /* OpenSSL auto-seeds from /dev/random, etc, but this a double-check. */
1136 gettimeofday(&r.tv, NULL);
1139 RAND_seed((uschar *)(&r), sizeof(r));
1141 /* We're after pseudo-random, not random; if we still don't have enough data
1142 in the internal PRNG then our options are limited. We could sleep and hope
1143 for entropy to come along (prayer technique) but if the system is so depleted
1144 in the first place then something is likely to just keep taking it. Instead,
1145 we'll just take whatever little bit of pseudo-random we can still manage to
1148 needed_len = sizeof(r);
1149 /* Don't take 8 times more entropy than needed if int is 8 octets and we were
1150 asked for a number less than 10. */
1151 for (r = max, i = 0; r; ++i)
1157 /* We do not care if crypto-strong */
1158 (void) RAND_pseudo_bytes(smallbuf, needed_len);
1160 for (p = smallbuf; needed_len; --needed_len, ++p)
1166 /* We don't particularly care about weighted results; if someone wants
1167 smooth distribution and cares enough then they should submit a patch then. */
1174 /*************************************************
1175 * OpenSSL option parse *
1176 *************************************************/
1178 /* Parse one option for tls_openssl_options_parse below
1181 name one option name
1182 value place to store a value for it
1183 Returns success or failure in parsing
1186 struct exim_openssl_option {
1190 /* We could use a macro to expand, but we need the ifdef and not all the
1191 options document which version they were introduced in. Policylet: include
1192 all options unless explicitly for DTLS, let the administrator choose which
1195 This list is current as of:
1197 static struct exim_openssl_option exim_openssl_options[] = {
1198 /* KEEP SORTED ALPHABETICALLY! */
1200 { US"all", SSL_OP_ALL },
1202 #ifdef SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION
1203 { US"allow_unsafe_legacy_renegotiation", SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION },
1205 #ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
1206 { US"cipher_server_preference", SSL_OP_CIPHER_SERVER_PREFERENCE },
1208 #ifdef SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS
1209 { US"dont_insert_empty_fragments", SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS },
1211 #ifdef SSL_OP_EPHEMERAL_RSA
1212 { US"ephemeral_rsa", SSL_OP_EPHEMERAL_RSA },
1214 #ifdef SSL_OP_LEGACY_SERVER_CONNECT
1215 { US"legacy_server_connect", SSL_OP_LEGACY_SERVER_CONNECT },
1217 #ifdef SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
1218 { US"microsoft_big_sslv3_buffer", SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER },
1220 #ifdef SSL_OP_MICROSOFT_SESS_ID_BUG
1221 { US"microsoft_sess_id_bug", SSL_OP_MICROSOFT_SESS_ID_BUG },
1223 #ifdef SSL_OP_MSIE_SSLV2_RSA_PADDING
1224 { US"msie_sslv2_rsa_padding", SSL_OP_MSIE_SSLV2_RSA_PADDING },
1226 #ifdef SSL_OP_NETSCAPE_CHALLENGE_BUG
1227 { US"netscape_challenge_bug", SSL_OP_NETSCAPE_CHALLENGE_BUG },
1229 #ifdef SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG
1230 { US"netscape_reuse_cipher_change_bug", SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG },
1232 #ifdef SSL_OP_NO_COMPRESSION
1233 { US"no_compression", SSL_OP_NO_COMPRESSION },
1235 #ifdef SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
1236 { US"no_session_resumption_on_renegotiation", SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION },
1238 #ifdef SSL_OP_NO_SSLv2
1239 { US"no_sslv2", SSL_OP_NO_SSLv2 },
1241 #ifdef SSL_OP_NO_SSLv3
1242 { US"no_sslv3", SSL_OP_NO_SSLv3 },
1244 #ifdef SSL_OP_NO_TICKET
1245 { US"no_ticket", SSL_OP_NO_TICKET },
1247 #ifdef SSL_OP_NO_TLSv1
1248 { US"no_tlsv1", SSL_OP_NO_TLSv1 },
1250 #ifdef SSL_OP_NO_TLSv1_1
1251 #if SSL_OP_NO_TLSv1_1 == 0x00000400L
1252 /* Error in chosen value in 1.0.1a; see first item in CHANGES for 1.0.1b */
1253 #warning OpenSSL 1.0.1a uses a bad value for SSL_OP_NO_TLSv1_1, ignoring
1255 { US"no_tlsv1_1", SSL_OP_NO_TLSv1_1 },
1258 #ifdef SSL_OP_NO_TLSv1_2
1259 { US"no_tlsv1_2", SSL_OP_NO_TLSv1_2 },
1261 #ifdef SSL_OP_SINGLE_DH_USE
1262 { US"single_dh_use", SSL_OP_SINGLE_DH_USE },
1264 #ifdef SSL_OP_SINGLE_ECDH_USE
1265 { US"single_ecdh_use", SSL_OP_SINGLE_ECDH_USE },
1267 #ifdef SSL_OP_SSLEAY_080_CLIENT_DH_BUG
1268 { US"ssleay_080_client_dh_bug", SSL_OP_SSLEAY_080_CLIENT_DH_BUG },
1270 #ifdef SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG
1271 { US"sslref2_reuse_cert_type_bug", SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG },
1273 #ifdef SSL_OP_TLS_BLOCK_PADDING_BUG
1274 { US"tls_block_padding_bug", SSL_OP_TLS_BLOCK_PADDING_BUG },
1276 #ifdef SSL_OP_TLS_D5_BUG
1277 { US"tls_d5_bug", SSL_OP_TLS_D5_BUG },
1279 #ifdef SSL_OP_TLS_ROLLBACK_BUG
1280 { US"tls_rollback_bug", SSL_OP_TLS_ROLLBACK_BUG },
1283 static int exim_openssl_options_size =
1284 sizeof(exim_openssl_options)/sizeof(struct exim_openssl_option);
1288 tls_openssl_one_option_parse(uschar *name, long *value)
1291 int last = exim_openssl_options_size;
1292 while (last > first)
1294 int middle = (first + last)/2;
1295 int c = Ustrcmp(name, exim_openssl_options[middle].name);
1298 *value = exim_openssl_options[middle].value;
1312 /*************************************************
1313 * OpenSSL option parsing logic *
1314 *************************************************/
1316 /* OpenSSL has a number of compatibility options which an administrator might
1317 reasonably wish to set. Interpret a list similarly to decode_bits(), so that
1318 we look like log_selector.
1321 option_spec the administrator-supplied string of options
1322 results ptr to long storage for the options bitmap
1323 Returns success or failure
1327 tls_openssl_options_parse(uschar *option_spec, long *results)
1332 BOOL adding, item_parsed;
1335 /* We grandfather in as default the one option which we used to set always. */
1336 #ifdef SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS
1337 result |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
1340 if (option_spec == NULL)
1346 for (s=option_spec; *s != '\0'; /**/)
1348 while (isspace(*s)) ++s;
1351 if (*s != '+' && *s != '-')
1353 DEBUG(D_tls) debug_printf("malformed openssl option setting: "
1354 "+ or - expected but found \"%s\"\n", s);
1357 adding = *s++ == '+';
1358 for (end = s; (*end != '\0') && !isspace(*end); ++end) /**/ ;
1361 item_parsed = tls_openssl_one_option_parse(s, &item);
1364 DEBUG(D_tls) debug_printf("openssl option setting unrecognised: \"%s\"\n", s);
1367 DEBUG(D_tls) debug_printf("openssl option, %s from %lx: %lx (%s)\n",
1368 adding ? "adding" : "removing", result, item, s);
1381 /* End of tls-openssl.c */