6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2001 hereUare Communications, Inc. <raghud@hereuare.com>
21 * Copyright 2003 Alan DeKok <aland@freeradius.org>
22 * Copyright 2006 The FreeRADIUS server project
26 USES_APPLE_DEPRECATED_API /* OpenSSL API has been deprecated by Apple */
28 #include <freeradius-devel/radiusd.h>
29 #include <freeradius-devel/process.h>
30 #include <freeradius-devel/rad_assert.h>
32 #ifdef HAVE_SYS_STAT_H
46 # ifdef HAVE_OPENSSL_RAND_H
47 # include <openssl/rand.h>
50 # ifdef HAVE_OPENSSL_OCSP_H
51 # include <openssl/ocsp.h>
54 # ifdef HAVE_OPENSSL_EVP_H
55 # include <openssl/evp.h>
57 # include <openssl/ssl.h>
59 #define LOG_PREFIX "tls"
61 #ifdef ENABLE_OPENSSL_VERSION_CHECK
62 typedef struct libssl_defect {
71 /* Record critical defects in libssl here, new versions of OpenSSL to older versions of OpenSSL. */
72 static libssl_defect_t libssl_defects[] =
75 .low = 0x01010101f, /* 1.1.0a */
76 .high = 0x01010101f, /* 1.1.0a */
77 .id = "CVE-2016-6309",
78 .name = "OCSP status request extension",
79 .comment = "For more information see https://www.openssl.org/news/secadv/20160926.txt"
82 .low = 0x01010100f, /* 1.1.0 */
83 .high = 0x01010100f, /* 1.1.0 */
84 .id = "CVE-2016-6304",
85 .name = "OCSP status request extension",
86 .comment = "For more information see https://www.openssl.org/news/secadv/20160922.txt"
89 .low = 0x01000209f, /* 1.0.2i */
90 .high = 0x01000209f, /* 1.0.2i */
91 .id = "CVE-2016-7052",
92 .name = "OCSP status request extension",
93 .comment = "For more information see https://www.openssl.org/news/secadv/20160926.txt"
96 .low = 0x01000200f, /* 1.0.2 */
97 .high = 0x01000208f, /* 1.0.2h */
98 .id = "CVE-2016-6304",
99 .name = "OCSP status request extension",
100 .comment = "For more information see https://www.openssl.org/news/secadv/20160922.txt"
103 .low = 0x01000100f, /* 1.0.1 */
104 .high = 0x01000114f, /* 1.0.1t */
105 .id = "CVE-2016-6304",
106 .name = "OCSP status request extension",
107 .comment = "For more information see https://www.openssl.org/news/secadv/20160922.txt"
110 .low = 0x010001000, /* 1.0.1 */
111 .high = 0x01000106f, /* 1.0.1f */
112 .id = "CVE-2014-0160",
113 .name = "Heartbleed",
114 .comment = "For more information see http://heartbleed.com"
117 #endif /* ENABLE_OPENSSL_VERSION_CHECK */
119 FR_NAME_NUMBER const fr_tls_status_table[] = {
120 { "invalid", FR_TLS_INVALID },
121 { "request", FR_TLS_REQUEST },
122 { "response", FR_TLS_RESPONSE },
123 { "success", FR_TLS_SUCCESS },
124 { "fail", FR_TLS_FAIL },
125 { "noop", FR_TLS_NOOP },
127 { "start", FR_TLS_START },
129 { "ack", FR_TLS_ACK },
130 { "first fragment", FR_TLS_FIRST_FRAGMENT },
131 { "more fragments", FR_TLS_MORE_FRAGMENTS },
132 { "length included", FR_TLS_LENGTH_INCLUDED },
133 { "more fragments with length", FR_TLS_MORE_FRAGMENTS_WITH_LENGTH },
134 { "handled", FR_TLS_HANDLED },
138 /* index we use to store cached session VPs
139 * needs to be dynamic so we can supply a "free" function
141 int fr_tls_ex_index_vps = -1;
142 int fr_tls_ex_index_certs = -1;
145 static void session_close(tls_session_t *ssn);
146 static void session_init(tls_session_t *ssn);
149 static void record_init(record_t *buf);
150 static void record_close(record_t *buf);
151 static unsigned int record_plus(record_t *buf, void const *ptr,
153 static unsigned int record_minus(record_t *buf, void *ptr,
156 DIAG_OFF(format-nonliteral)
157 /** Print errors in the TLS thread local error stack
159 * Drains the thread local OpenSSL error queue, and prints out errors.
161 * @param[in] request The current request (may be NULL).
162 * @param[in] msg Error message describing the operation being attempted.
163 * @param[in] ap Arguments for msg.
164 * @return the number of errors drained from the stack.
166 static int tls_verror_log(REQUEST *request, char const *msg, va_list ap)
177 * Pop the first error, so ERR_peek_error()
178 * can be used to determine if there are
181 error = ERR_get_error_line(&file, &line);
184 p = talloc_vasprintf(request, msg, ap);
187 * Single line mode (there's only one error)
189 if (error && !ERR_peek_error()) {
190 ERR_error_string_n(error, buffer, sizeof(buffer));
193 if ((request && RDEBUG_ENABLED3) || DEBUG_ENABLED3) {
194 ROPTIONAL(REDEBUG, ERROR, "%s: %s[%i]:%s", p, file, line, buffer);
196 ROPTIONAL(REDEBUG, ERROR, "%s: %s", p, buffer);
205 * Print the error we were given, irrespective
206 * of whether there were any OpenSSL errors.
208 ROPTIONAL(RERROR, ERROR, "%s", p);
213 * Stack mode (there are multiple errors)
215 if (!error) return 0;
217 ERR_error_string_n(error, buffer, sizeof(buffer));
219 if ((request && RDEBUG_ENABLED3) || DEBUG_ENABLED3) {
220 ROPTIONAL(REDEBUG, ERROR, "%s[%i]:%s", file, line, buffer);
222 ROPTIONAL(REDEBUG, ERROR, "%s", buffer);
225 } while ((error = ERR_get_error_line(&file, &line)));
229 DIAG_ON(format-nonliteral)
231 /** Print errors in the TLS thread local error stack
233 * Drains the thread local OpenSSL error queue, and prints out errors.
235 * @param[in] request The current request (may be NULL).
236 * @param[in] msg Error message describing the operation being attempted.
237 * @param[in] ... Arguments for msg.
238 * @return the number of errors drained from the stack.
240 int tls_error_log(REQUEST *request, char const *msg, ...)
246 ret = tls_verror_log(request, msg, ap);
252 /** Print errors raised by OpenSSL I/O functions
254 * Drains the thread local OpenSSL error queue, and prints out errors
255 * based on the SSL handle and the return code of the I/O function.
257 * OpenSSL lists I/O functions to be:
265 * @param request The current request (may be NULL).
266 * @param session The current tls_session.
267 * @param ret from the I/O operation.
268 * @param msg Error message describing the operation being attempted.
269 * @param ... Arguments for msg.
271 * - 0 TLS session cannot continue.
272 * - 1 TLS session may still be viable.
274 int tls_error_io_log(REQUEST *request, tls_session_t *session, int ret, char const *msg, ...)
279 if (ERR_peek_error()) {
281 tls_verror_log(request, msg, ap);
285 error = SSL_get_error(session->ssl, ret);
288 * These seem to be harmless and already "dealt
289 * with" by our non-blocking environment. NB:
290 * "ZERO_RETURN" is the clean "error"
291 * indicating a successfully closed SSL
292 * tunnel. We let this happen because our IO
293 * loop should not appear to have broken on
294 * this condition - and outside the IO loop, the
295 * "shutdown" state is checked.
297 * Don't print anything if we ignore the error.
300 case SSL_ERROR_WANT_READ:
301 case SSL_ERROR_WANT_WRITE:
302 case SSL_ERROR_WANT_X509_LOOKUP:
303 case SSL_ERROR_ZERO_RETURN:
307 * These seem to be indications of a genuine
308 * error that should result in the SSL tunnel
309 * being regarded as "dead".
311 case SSL_ERROR_SYSCALL:
312 ROPTIONAL(REDEBUG, ERROR, "System call (I/O) error (%i)", ret);
316 ROPTIONAL(REDEBUG, ERROR, "TLS protocol error (%i)", ret);
320 * For any other errors that (a) exist, and (b)
321 * crop up - we need to interpret what to do with
322 * them - so "politely inform" the caller that
323 * the code needs updating here.
326 ROPTIONAL(REDEBUG, ERROR, "TLS session error %i (%i)", error, ret);
333 #ifdef PSK_MAX_IDENTITY_LEN
334 static bool identity_is_safe(const char *identity)
338 if (!identity) return true;
340 while ((c = *(identity++)) != '\0') {
341 if (isalpha((int) c) || isdigit((int) c) || isspace((int) c) ||
342 (c == '@') || (c == '-') || (c == '_') || (c == '.')) {
353 * When a client uses TLS-PSK to talk to a server, this callback
354 * is used by the server to determine the PSK to use.
356 static unsigned int psk_server_callback(SSL *ssl, const char *identity,
358 unsigned int max_psk_len)
360 unsigned int psk_len = 0;
361 fr_tls_server_conf_t *conf;
364 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl,
365 FR_TLS_EX_INDEX_CONF);
368 request = (REQUEST *)SSL_get_ex_data(ssl,
369 FR_TLS_EX_INDEX_REQUEST);
370 if (request && conf->psk_query) {
373 char buffer[2 * PSK_MAX_PSK_LEN + 4]; /* allow for too-long keys */
376 * The passed identity is weird. Deny it.
378 if (!identity_is_safe(identity)) {
379 RWDEBUG("Invalid characters in PSK identity %s", identity);
383 vp = pair_make_request("TLS-PSK-Identity", identity, T_OP_SET);
386 hex_len = radius_xlat(buffer, sizeof(buffer), request, conf->psk_query,
389 RWDEBUG("PSK expansion returned an empty string.");
394 * The returned key is truncated at MORE than
395 * OpenSSL can handle. That way we can detect
396 * the truncation, and complain about it.
398 if (hex_len > (2 * max_psk_len)) {
399 RWDEBUG("Returned PSK is too long (%u > %u)",
400 (unsigned int) hex_len, 2 * max_psk_len);
405 * Leave the TLS-PSK-Identity in the request, and
406 * convert the expansion from printable string
409 return fr_hex2bin(psk, max_psk_len, buffer, hex_len);
412 if (!conf->psk_identity) {
413 DEBUG("No static PSK identity set. Rejecting the user");
418 * No REQUEST, or no dynamic query. Just look for a
421 if (strcmp(identity, conf->psk_identity) != 0) {
422 ERROR("Supplied PSK identity %s does not match configuration. Rejecting.",
427 psk_len = strlen(conf->psk_password);
428 if (psk_len > (2 * max_psk_len)) return 0;
430 return fr_hex2bin(psk, max_psk_len, conf->psk_password, psk_len);
433 static unsigned int psk_client_callback(SSL *ssl, UNUSED char const *hint,
434 char *identity, unsigned int max_identity_len,
435 unsigned char *psk, unsigned int max_psk_len)
437 unsigned int psk_len;
438 fr_tls_server_conf_t *conf;
440 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl,
441 FR_TLS_EX_INDEX_CONF);
444 psk_len = strlen(conf->psk_password);
445 if (psk_len > (2 * max_psk_len)) return 0;
447 strlcpy(identity, conf->psk_identity, max_identity_len);
449 return fr_hex2bin(psk, max_psk_len, conf->psk_password, psk_len);
454 #define MAX_SESSION_SIZE (256)
457 void tls_session_id(SSL_SESSION *ssn, char *buffer, size_t bufsize)
459 #if OPENSSL_VERSION_NUMBER < 0x10001000L
462 size = ssn->session_id_length;
463 if (size > bufsize) size = bufsize;
465 fr_bin2hex(buffer, ssn->session_id, size);
470 p = SSL_SESSION_get_id(ssn, &size);
471 if (size > bufsize) size = bufsize;
473 fr_bin2hex(buffer, p, size);
480 static int _tls_session_free(tls_session_t *ssn)
483 * Free any opaque TTLS or PEAP data.
485 if ((ssn->opaque) && (ssn->free_opaque)) {
486 ssn->free_opaque(ssn->opaque);
495 tls_session_t *tls_new_client_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, int fd)
499 tls_session_t *ssn = NULL;
502 ssn = talloc_zero(ctx, tls_session_t);
503 if (!ssn) return NULL;
505 talloc_set_destructor(ssn, _tls_session_free);
507 ssn->ctx = conf->ctx;
508 ssn->mtu = conf->fragment_size;
510 SSL_CTX_set_mode(ssn->ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_AUTO_RETRY);
512 ssn->ssl = SSL_new(ssn->ctx);
518 request = request_alloc(ssn);
519 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_REQUEST, (void *)request);
522 * Add the message callback to identify what type of
523 * message/handshake is passed
525 SSL_set_msg_callback(ssn->ssl, cbtls_msg);
526 SSL_set_msg_callback_arg(ssn->ssl, ssn);
527 SSL_set_info_callback(ssn->ssl, cbtls_info);
530 * Always verify the peer certificate.
532 DEBUG2("Requiring Server certificate");
533 verify_mode = SSL_VERIFY_PEER;
534 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
535 SSL_set_verify(ssn->ssl, verify_mode, cbtls_verify);
537 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
538 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_SSN, (void *)ssn);
539 SSL_set_fd(ssn->ssl, fd);
540 ret = SSL_connect(ssn->ssl);
543 switch (SSL_get_error(ssn->ssl, ret)) {
549 case SSL_ERROR_WANT_READ:
550 case SSL_ERROR_WANT_WRITE:
551 ssn->connected = false;
557 tls_error_io_log(NULL, ssn, ret, "Failed in " STRINGIFY(__FUNCTION__) " (SSL_connect)");
563 ssn->connected = true;
568 /** Create a new TLS session
570 * Configures a new TLS session, configuring options, setting callbacks etc...
572 * @param ctx to alloc session data in. Should usually be NULL unless the lifetime of the
573 * session is tied to another talloc'd object.
574 * @param conf to use to configure the tls session.
575 * @param request The current #REQUEST.
576 * @param client_cert Whether to require a client_cert.
577 * @return a new session on success, or NULL on error.
579 tls_session_t *tls_new_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, REQUEST *request, bool client_cert)
581 tls_session_t *state = NULL;
586 rad_assert(request != NULL);
588 RDEBUG2("Initiating new EAP-TLS session");
591 * Manually flush the sessions every so often. If HALF
592 * of the session lifetime has passed since we last
593 * flushed, then flush it again.
595 * FIXME: Also do it every N sessions?
597 if (conf->session_cache_enable &&
598 ((conf->session_last_flushed + ((int)conf->session_timeout * 1800)) <= request->timestamp)){
599 RDEBUG2("Flushing SSL sessions (of #%ld)", SSL_CTX_sess_number(conf->ctx));
601 SSL_CTX_flush_sessions(conf->ctx, request->timestamp);
602 conf->session_last_flushed = request->timestamp;
605 new_tls = SSL_new(conf->ctx);
606 if (new_tls == NULL) {
607 tls_error_log(request, "Error creating new TLS session");
611 /* We use the SSL's "app_data" to indicate a call-back */
612 SSL_set_app_data(new_tls, NULL);
614 if ((state = talloc_zero(ctx, tls_session_t)) == NULL) {
615 RERROR("Error allocating memory for SSL state");
619 talloc_set_destructor(state, _tls_session_free);
621 state->ctx = conf->ctx;
622 state->ssl = new_tls;
625 * Initialize callbacks
627 state->record_init = record_init;
628 state->record_close = record_close;
629 state->record_plus = record_plus;
630 state->record_minus = record_minus;
633 * Create & hook the BIOs to handle the dirty side of the
634 * SSL. This is *very important* as we want to handle
635 * the transmission part. Now the only IO interface
636 * that SSL is aware of, is our defined BIO buffers.
638 * This means that all SSL IO is done to/from memory,
639 * and we can update those BIOs from the packets we've
642 state->into_ssl = BIO_new(BIO_s_mem());
643 state->from_ssl = BIO_new(BIO_s_mem());
644 SSL_set_bio(state->ssl, state->into_ssl, state->from_ssl);
647 * Add the message callback to identify what type of
648 * message/handshake is passed
650 SSL_set_msg_callback(new_tls, cbtls_msg);
651 SSL_set_msg_callback_arg(new_tls, state);
652 SSL_set_info_callback(new_tls, cbtls_info);
655 * In Server mode we only accept.
657 SSL_set_accept_state(state->ssl);
660 * Verify the peer certificate, if asked.
663 RDEBUG2("Setting verify mode to require certificate from client");
664 verify_mode = SSL_VERIFY_PEER;
665 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
666 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
668 SSL_set_verify(state->ssl, verify_mode, cbtls_verify);
670 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
671 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_SSN, (void *)state);
672 state->length_flag = conf->include_length;
675 * We use default fragment size, unless the Framed-MTU
676 * tells us it's too big. Note that we do NOT account
677 * for the EAP-TLS headers if conf->fragment_size is
678 * large, because that config item looks to be confusing.
680 * i.e. it should REALLY be called MTU, and the code here
681 * should figure out what that means for TLS fragment size.
682 * asking the administrator to know the internal details
683 * of EAP-TLS in order to calculate fragment sizes is
686 state->mtu = conf->fragment_size;
687 vp = fr_pair_find_by_num(request->packet->vps, PW_FRAMED_MTU, 0, TAG_ANY);
688 if (vp && (vp->vp_integer > 100) && (vp->vp_integer < state->mtu)) {
689 state->mtu = vp->vp_integer;
692 if (conf->session_cache_enable) state->allow_session_resumption = true; /* otherwise it's false */
698 * We are the server, we always get the dirty data
699 * (Handshake data is also considered as dirty data)
700 * During handshake, since SSL API handles itself,
701 * After clean-up, dirty_out will be filled with
702 * the data required for handshaking. So we check
703 * if dirty_out is empty then we simply send it back.
704 * As of now, if handshake is successful, then we keep going,
707 * Fill the Bio with the dirty data to clean it
708 * Get the cleaned data from SSL, if it is not Handshake data
710 int tls_handshake_recv(REQUEST *request, tls_session_t *ssn)
714 if (ssn->invalid_hb_used) return 0;
716 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data, ssn->dirty_in.used);
717 if (err != (int) ssn->dirty_in.used) {
718 REDEBUG("Failed writing %zd bytes to SSL BIO: %d", ssn->dirty_in.used, err);
719 record_init(&ssn->dirty_in);
722 record_init(&ssn->dirty_in);
724 err = SSL_read(ssn->ssl, ssn->clean_out.data + ssn->clean_out.used,
725 sizeof(ssn->clean_out.data) - ssn->clean_out.used);
727 ssn->clean_out.used += err;
731 if (!tls_error_io_log(request, ssn, err, "Failed in " STRINGIFY(__FUNCTION__) " (SSL_read)")) return 0;
733 /* Some Extra STATE information for easy debugging */
734 if (SSL_is_init_finished(ssn->ssl)) RDEBUG2("SSL Connection Established");
735 if (SSL_in_init(ssn->ssl)) RDEBUG2("In SSL Handshake Phase");
736 if (SSL_in_before(ssn->ssl)) RDEBUG2("Before SSL Handshake Phase");
737 if (SSL_in_accept_init(ssn->ssl)) RDEBUG2("In SSL Accept mode");
738 if (SSL_in_connect_init(ssn->ssl)) RDEBUG2("In SSL Connect mode");
740 #if OPENSSL_VERSION_NUMBER >= 0x10001000L
742 * Cache the SSL_SESSION pointer.
744 if (!ssn->ssl_session && SSL_is_init_finished(ssn->ssl)) {
745 ssn->ssl_session = SSL_get_session(ssn->ssl);
746 if (!ssn->ssl_session) {
747 RDEBUG("Failed getting SSL session");
753 err = BIO_ctrl_pending(ssn->from_ssl);
755 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
756 sizeof(ssn->dirty_out.data));
758 ssn->dirty_out.used = err;
760 } else if (BIO_should_retry(ssn->from_ssl)) {
761 record_init(&ssn->dirty_in);
762 RDEBUG2("Asking for more data in tunnel");
766 tls_error_log(NULL, NULL);
767 record_init(&ssn->dirty_in);
771 RDEBUG2("SSL Application Data");
772 /* Its clean application data, do whatever we want */
773 record_init(&ssn->clean_out);
776 /* We are done with dirty_in, reinitialize it */
777 record_init(&ssn->dirty_in);
782 * Take cleartext user data, and encrypt it into the output buffer,
783 * to send to the client at the other end of the SSL connection.
785 int tls_handshake_send(REQUEST *request, tls_session_t *ssn)
790 * If there's un-encrypted data in 'clean_in', then write
791 * that data to the SSL session, and then call the BIO function
792 * to get that encrypted data from the SSL session, into
793 * a buffer which we can then package into an EAP packet.
795 * Based on Server's logic this clean_in is expected to
796 * contain the data to send to the client.
798 if (ssn->clean_in.used > 0) {
801 written = SSL_write(ssn->ssl, ssn->clean_in.data, ssn->clean_in.used);
802 record_minus(&ssn->clean_in, NULL, written);
804 /* Get the dirty data from Bio to send it */
805 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
806 sizeof(ssn->dirty_out.data));
808 ssn->dirty_out.used = err;
810 if (!tls_error_io_log(request, ssn, err,
811 "Failed in " STRINGIFY(__FUNCTION__) " (SSL_write)")) {
820 static void session_init(tls_session_t *ssn)
823 ssn->into_ssl = ssn->from_ssl = NULL;
824 record_init(&ssn->clean_in);
825 record_init(&ssn->clean_out);
826 record_init(&ssn->dirty_in);
827 record_init(&ssn->dirty_out);
829 memset(&ssn->info, 0, sizeof(ssn->info));
832 ssn->fragment = false;
833 ssn->tls_msg_len = 0;
834 ssn->length_flag = false;
836 ssn->free_opaque = NULL;
839 static void session_close(tls_session_t *ssn)
842 SSL_set_quiet_shutdown(ssn->ssl, 1);
843 SSL_shutdown(ssn->ssl);
849 record_close(&ssn->clean_in);
850 record_close(&ssn->clean_out);
851 record_close(&ssn->dirty_in);
852 record_close(&ssn->dirty_out);
856 static void record_init(record_t *rec)
861 static void record_close(record_t *rec)
868 * Copy data to the intermediate buffer, before we send
871 static unsigned int record_plus(record_t *rec, void const *ptr,
874 unsigned int added = MAX_RECORD_SIZE - rec->used;
880 memcpy(rec->data + rec->used, ptr, added);
886 * Take data from the buffer, and give it to the caller.
888 static unsigned int record_minus(record_t *rec, void *ptr,
891 unsigned int taken = rec->used;
898 memcpy(ptr, rec->data, taken);
902 * This is pretty bad...
904 if (rec->used > 0) memmove(rec->data, rec->data + taken, rec->used);
909 void tls_session_information(tls_session_t *tls_session)
911 char const *str_write_p, *str_version, *str_content_type = "";
912 char const *str_details1 = "", *str_details2= "";
917 * Don't print this out in the normal course of
920 if (rad_debug_lvl == 0) return;
922 str_write_p = tls_session->info.origin ? ">>> send" : "<<< recv";
924 switch (tls_session->info.version) {
926 str_version = "SSL 2.0 ";
929 str_version = "SSL 3.0 ";
932 str_version = "TLS 1.0 ";
934 #ifdef TLS1_1_VERSION
936 str_version = "TLS 1.1 ";
939 #ifdef TLS1_2_VERSION
941 str_version = "TLS 1.2 ";
946 str_version = "TLS 1.3 ";
951 sprintf(buffer, "UNKNOWN TLS VERSION ?%04X?", tls_session->info.version);
952 str_version = buffer;
956 if (tls_session->info.version == SSL3_VERSION ||
957 tls_session->info.version == TLS1_VERSION) {
958 switch (tls_session->info.content_type) {
959 case SSL3_RT_CHANGE_CIPHER_SPEC:
960 str_content_type = "ChangeCipherSpec";
964 str_content_type = "Alert";
967 case SSL3_RT_HANDSHAKE:
968 str_content_type = "Handshake";
971 case SSL3_RT_APPLICATION_DATA:
972 str_content_type = "ApplicationData";
976 str_content_type = "UnknownContentType";
980 if (tls_session->info.content_type == SSL3_RT_ALERT) {
981 str_details1 = ", ???";
983 if (tls_session->info.record_len == 2) {
985 switch (tls_session->info.alert_level) {
986 case SSL3_AL_WARNING:
987 str_details1 = ", warning";
990 str_details1 = ", fatal";
994 str_details2 = " ???";
995 switch (tls_session->info.alert_description) {
996 case SSL3_AD_CLOSE_NOTIFY:
997 str_details2 = " close_notify";
1000 case SSL3_AD_UNEXPECTED_MESSAGE:
1001 str_details2 = " unexpected_message";
1004 case SSL3_AD_BAD_RECORD_MAC:
1005 str_details2 = " bad_record_mac";
1008 case TLS1_AD_DECRYPTION_FAILED:
1009 str_details2 = " decryption_failed";
1012 case TLS1_AD_RECORD_OVERFLOW:
1013 str_details2 = " record_overflow";
1016 case SSL3_AD_DECOMPRESSION_FAILURE:
1017 str_details2 = " decompression_failure";
1020 case SSL3_AD_HANDSHAKE_FAILURE:
1021 str_details2 = " handshake_failure";
1024 case SSL3_AD_BAD_CERTIFICATE:
1025 str_details2 = " bad_certificate";
1028 case SSL3_AD_UNSUPPORTED_CERTIFICATE:
1029 str_details2 = " unsupported_certificate";
1032 case SSL3_AD_CERTIFICATE_REVOKED:
1033 str_details2 = " certificate_revoked";
1036 case SSL3_AD_CERTIFICATE_EXPIRED:
1037 str_details2 = " certificate_expired";
1040 case SSL3_AD_CERTIFICATE_UNKNOWN:
1041 str_details2 = " certificate_unknown";
1044 case SSL3_AD_ILLEGAL_PARAMETER:
1045 str_details2 = " illegal_parameter";
1048 case TLS1_AD_UNKNOWN_CA:
1049 str_details2 = " unknown_ca";
1052 case TLS1_AD_ACCESS_DENIED:
1053 str_details2 = " access_denied";
1056 case TLS1_AD_DECODE_ERROR:
1057 str_details2 = " decode_error";
1060 case TLS1_AD_DECRYPT_ERROR:
1061 str_details2 = " decrypt_error";
1064 case TLS1_AD_EXPORT_RESTRICTION:
1065 str_details2 = " export_restriction";
1068 case TLS1_AD_PROTOCOL_VERSION:
1069 str_details2 = " protocol_version";
1072 case TLS1_AD_INSUFFICIENT_SECURITY:
1073 str_details2 = " insufficient_security";
1076 case TLS1_AD_INTERNAL_ERROR:
1077 str_details2 = " internal_error";
1080 case TLS1_AD_USER_CANCELLED:
1081 str_details2 = " user_canceled";
1084 case TLS1_AD_NO_RENEGOTIATION:
1085 str_details2 = " no_renegotiation";
1091 if (tls_session->info.content_type == SSL3_RT_HANDSHAKE) {
1092 str_details1 = "???";
1094 if (tls_session->info.record_len > 0) switch (tls_session->info.handshake_type) {
1095 case SSL3_MT_HELLO_REQUEST:
1096 str_details1 = ", HelloRequest";
1099 case SSL3_MT_CLIENT_HELLO:
1100 str_details1 = ", ClientHello";
1103 case SSL3_MT_SERVER_HELLO:
1104 str_details1 = ", ServerHello";
1107 case SSL3_MT_CERTIFICATE:
1108 str_details1 = ", Certificate";
1111 case SSL3_MT_SERVER_KEY_EXCHANGE:
1112 str_details1 = ", ServerKeyExchange";
1115 case SSL3_MT_CERTIFICATE_REQUEST:
1116 str_details1 = ", CertificateRequest";
1119 case SSL3_MT_SERVER_DONE:
1120 str_details1 = ", ServerHelloDone";
1123 case SSL3_MT_CERTIFICATE_VERIFY:
1124 str_details1 = ", CertificateVerify";
1127 case SSL3_MT_CLIENT_KEY_EXCHANGE:
1128 str_details1 = ", ClientKeyExchange";
1131 case SSL3_MT_FINISHED:
1132 str_details1 = ", Finished";
1138 snprintf(tls_session->info.info_description,
1139 sizeof(tls_session->info.info_description),
1140 "%s %s%s [length %04lx]%s%s\n",
1141 str_write_p, str_version, str_content_type,
1142 (unsigned long)tls_session->info.record_len,
1143 str_details1, str_details2);
1145 request = SSL_get_ex_data(tls_session->ssl, FR_TLS_EX_INDEX_REQUEST);
1146 ROPTIONAL(RDEBUG2, DEBUG2, "%s", tls_session->info.info_description);
1149 static CONF_PARSER cache_config[] = {
1150 { "enable", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, session_cache_enable), "no" },
1152 { "lifetime", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, session_timeout), "24" },
1153 { "name", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, session_id_name), NULL },
1155 { "max_entries", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, session_cache_size), "255" },
1156 { "persist_dir", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, session_cache_path), NULL },
1157 CONF_PARSER_TERMINATOR
1160 static CONF_PARSER verify_config[] = {
1161 { "skip_if_ocsp_ok", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, verify_skip_if_ocsp_ok), "no" },
1162 { "tmpdir", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, verify_tmp_dir), NULL },
1163 { "client", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, verify_client_cert_cmd), NULL },
1164 CONF_PARSER_TERMINATOR
1167 #ifdef HAVE_OPENSSL_OCSP_H
1168 static CONF_PARSER ocsp_config[] = {
1169 { "enable", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_enable), "no" },
1170 { "override_cert_url", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_override_url), "no" },
1171 { "url", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ocsp_url), NULL },
1172 { "use_nonce", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_use_nonce), "yes" },
1173 { "timeout", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, ocsp_timeout), "yes" },
1174 { "softfail", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_softfail), "no" },
1175 CONF_PARSER_TERMINATOR
1179 static CONF_PARSER tls_server_config[] = {
1180 { "verify_depth", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, verify_depth), "0" },
1181 { "CA_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED, fr_tls_server_conf_t, ca_path), NULL },
1182 { "ca_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_path), NULL },
1183 { "pem_file_type", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, file_type), "yes" },
1184 { "private_key_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, private_key_file), NULL },
1185 { "certificate_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, certificate_file), NULL },
1186 { "CA_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED, fr_tls_server_conf_t, ca_file), NULL },
1187 { "ca_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_file), NULL },
1188 { "private_key_password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, private_key_password), NULL },
1189 #ifdef PSK_MAX_IDENTITY_LEN
1190 { "psk_identity", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, psk_identity), NULL },
1191 { "psk_hexphrase", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, psk_password), NULL },
1192 { "psk_query", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, psk_query), NULL },
1194 { "dh_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, dh_file), NULL },
1195 { "random_file", FR_CONF_OFFSET(PW_TYPE_FILE_EXISTS, fr_tls_server_conf_t, random_file), NULL },
1196 { "fragment_size", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, fragment_size), "1024" },
1197 { "include_length", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, include_length), "yes" },
1198 { "auto_chain", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, auto_chain), "yes" },
1199 { "disable_single_dh_use", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_single_dh_use), NULL },
1200 { "check_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, check_crl), "no" },
1201 #ifdef X509_V_FLAG_CRL_CHECK_ALL
1202 { "check_all_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, check_all_crl), "no" },
1204 { "allow_expired_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, allow_expired_crl), NULL },
1205 { "check_cert_cn", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_cn), NULL },
1206 { "cipher_list", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, cipher_list), NULL },
1207 { "cipher_server_preference", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, cipher_server_preference), NULL },
1208 { "check_cert_issuer", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_issuer), NULL },
1209 { "require_client_cert", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, require_client_cert), NULL },
1211 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
1212 #ifndef OPENSSL_NO_ECDH
1213 { "ecdh_curve", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ecdh_curve), "prime256v1" },
1217 #ifdef SSL_OP_NO_TLSv1
1218 { "disable_tlsv1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1), NULL },
1221 #ifdef SSL_OP_NO_TLSv1_1
1222 { "disable_tlsv1_1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_1), NULL },
1225 #ifdef SSL_OP_NO_TLSv1_2
1226 { "disable_tlsv1_2", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_2), NULL },
1229 { "cache", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) cache_config },
1231 { "verify", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) verify_config },
1233 #ifdef HAVE_OPENSSL_OCSP_H
1234 { "ocsp", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) ocsp_config },
1236 CONF_PARSER_TERMINATOR
1240 static CONF_PARSER tls_client_config[] = {
1241 { "verify_depth", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, verify_depth), "0" },
1242 { "ca_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_path), NULL },
1243 { "pem_file_type", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, file_type), "yes" },
1244 { "private_key_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, private_key_file), NULL },
1245 { "certificate_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, certificate_file), NULL },
1246 { "ca_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_file), NULL },
1247 { "private_key_password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, private_key_password), NULL },
1248 { "dh_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, dh_file), NULL },
1249 { "random_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, random_file), NULL },
1250 { "fragment_size", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, fragment_size), "1024" },
1251 { "include_length", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, include_length), "yes" },
1252 { "check_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, check_crl), "no" },
1253 { "check_cert_cn", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_cn), NULL },
1254 { "cipher_list", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, cipher_list), NULL },
1255 { "check_cert_issuer", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_issuer), NULL },
1257 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
1258 #ifndef OPENSSL_NO_ECDH
1259 { "ecdh_curve", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ecdh_curve), "prime256v1" },
1263 #ifdef SSL_OP_NO_TLSv1
1264 { "disable_tlsv1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1), NULL },
1267 #ifdef SSL_OP_NO_TLSv1_1
1268 { "disable_tlsv1_1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_1), NULL },
1271 #ifdef SSL_OP_NO_TLSv1_2
1272 { "disable_tlsv1_2", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_2), NULL },
1274 CONF_PARSER_TERMINATOR
1279 * TODO: Check for the type of key exchange * like conf->dh_key
1281 static int load_dh_params(SSL_CTX *ctx, char *file)
1286 if (!file) return 0;
1288 if ((bio = BIO_new_file(file, "r")) == NULL) {
1289 ERROR(LOG_PREFIX ": Unable to open DH file - %s", file);
1293 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
1296 WARN(LOG_PREFIX ": Unable to set DH parameters. DH cipher suites may not work!");
1297 WARN(LOG_PREFIX ": Fix this by running the OpenSSL command listed in eap.conf");
1301 if (SSL_CTX_set_tmp_dh(ctx, dh) < 0) {
1302 ERROR(LOG_PREFIX ": Unable to set DH parameters");
1313 * Print debugging messages, and free data.
1315 static void cbtls_remove_session(SSL_CTX *ctx, SSL_SESSION *sess)
1317 char buffer[2 * MAX_SESSION_SIZE + 1];
1318 fr_tls_server_conf_t *conf;
1320 tls_session_id(sess, buffer, MAX_SESSION_SIZE);
1322 conf = (fr_tls_server_conf_t *)SSL_CTX_get_app_data(ctx);
1324 DEBUG(LOG_PREFIX ": Failed to find TLS configuration in session");
1332 DEBUG2(LOG_PREFIX ": Removing session %s from the cache", buffer);
1334 /* remove session and any cached VPs */
1335 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1336 conf->session_cache_path, FR_DIR_SEP, buffer);
1337 rv = unlink(filename);
1339 DEBUG2(LOG_PREFIX ": Could not remove persisted session file %s: %s",
1340 filename, fr_syserror(errno));
1342 /* VPs might be absent; might not have been written to disk yet */
1343 snprintf(filename, sizeof(filename), "%s%c%s.vps",
1344 conf->session_cache_path, FR_DIR_SEP, buffer);
1351 static int cbtls_new_session(SSL *ssl, SSL_SESSION *sess)
1353 char buffer[2 * MAX_SESSION_SIZE + 1];
1354 fr_tls_server_conf_t *conf;
1355 unsigned char *sess_blob = NULL;
1357 REQUEST *request = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_REQUEST);
1359 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1361 RWDEBUG("Failed to find TLS configuration in session");
1365 tls_session_id(sess, buffer, MAX_SESSION_SIZE);
1368 int fd, rv, todo, blob_len;
1372 RDEBUG2("Serialising session %s, and storing in cache", buffer);
1374 /* find out what length data we need */
1375 blob_len = i2d_SSL_SESSION(sess, NULL);
1377 /* something went wrong */
1378 if (request) RWDEBUG("Session serialisation failed, couldn't determine required buffer length");
1382 /* Do not convert to TALLOC - Thread safety */
1383 /* alloc and convert to ASN.1 */
1384 sess_blob = malloc(blob_len);
1386 RWDEBUG("Session serialisation failed, couldn't allocate buffer (%d bytes)", blob_len);
1389 /* openssl mutates &p */
1391 rv = i2d_SSL_SESSION(sess, &p);
1392 if (rv != blob_len) {
1393 if (request) RWDEBUG("Session serialisation failed");
1397 /* open output file */
1398 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1399 conf->session_cache_path, FR_DIR_SEP, buffer);
1400 fd = open(filename, O_RDWR|O_CREAT|O_EXCL, S_IWUSR);
1402 if (request) RERROR("Session serialisation failed, failed opening session file %s: %s",
1403 filename, fr_syserror(errno));
1408 * Set the filename to be temporarily write-only.
1413 vp = fr_pair_afrom_num(request->state_ctx, PW_TLS_CACHE_FILENAME, 0);
1415 fr_pair_value_strcpy(vp, filename);
1416 fr_pair_add(&request->state, vp);
1423 rv = write(fd, p, todo);
1425 if (request) RWDEBUG("Failed writing session: %s", fr_syserror(errno));
1433 if (request) RWDEBUG("Wrote session %s to %s (%d bytes)", buffer, filename, blob_len);
1442 /** Convert OpenSSL's ASN1_TIME to an epoch time
1444 * @param[out] out Where to write the time_t.
1445 * @param[in] asn1 The ASN1_TIME to convert.
1450 static int ocsp_asn1time_to_epoch(time_t *out, char const *asn1)
1453 char const *p = asn1, *end = p + strlen(p);
1455 memset(&t, 0, sizeof(t));
1457 if ((end - p) <= 12) {
1458 if ((end - p) < 2) {
1459 fr_strerror_printf("ASN1 date string too short, expected 2 additional bytes, got %zu bytes",
1464 t.tm_year = (*(p++) - '0') * 10;
1465 t.tm_year += (*(p++) - '0');
1466 if (t.tm_year < 70) t.tm_year += 100;
1468 t.tm_year = (*(p++) - '0') * 1000;
1469 t.tm_year += (*(p++) - '0') * 100;
1470 t.tm_year += (*(p++) - '0') * 10;
1471 t.tm_year += (*(p++) - '0');
1475 if ((end - p) < 10) {
1476 fr_strerror_printf("ASN1 string too short, expected 10 additional bytes, got %zu bytes",
1481 t.tm_mon = (*(p++) - '0') * 10;
1482 t.tm_mon += (*(p++) - '0') - 1; // -1 since January is 0 not 1.
1483 t.tm_mday = (*(p++) - '0') * 10;
1484 t.tm_mday += (*(p++) - '0');
1485 t.tm_hour = (*(p++) - '0') * 10;
1486 t.tm_hour += (*(p++) - '0');
1487 t.tm_min = (*(p++) - '0') * 10;
1488 t.tm_min += (*(p++) - '0');
1489 t.tm_sec = (*(p++) - '0') * 10;
1490 t.tm_sec += (*(p++) - '0');
1492 /* Apparently OpenSSL converts all timestamps to UTC? Maybe? */
1497 #if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
1498 static SSL_SESSION *cbtls_get_session(SSL *ssl, unsigned char *data, int len, int *copy)
1500 static SSL_SESSION *cbtls_get_session(SSL *ssl, const unsigned char *data, int len, int *copy)
1504 char buffer[2 * MAX_SESSION_SIZE + 1];
1505 fr_tls_server_conf_t *conf;
1506 TALLOC_CTX *talloc_ctx;
1508 SSL_SESSION *sess = NULL;
1509 unsigned char *sess_data = NULL;
1510 PAIR_LIST *pairlist = NULL;
1512 REQUEST *request = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_REQUEST);
1514 rad_assert(request != NULL);
1517 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1519 fr_bin2hex(buffer, data, size);
1521 RDEBUG2("Peer requested cached session: %s", buffer);
1525 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1527 RWDEBUG("Failed to find TLS configuration in session");
1531 talloc_ctx = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_TALLOC);
1537 unsigned char const **o;
1542 VALUE_PAIR *vps = NULL;
1545 /* load the actual SSL session */
1546 snprintf(filename, sizeof(filename), "%s%c%s.asn1", conf->session_cache_path, FR_DIR_SEP, buffer);
1547 fd = open(filename, O_RDONLY);
1549 RWDEBUG("No persisted session file %s: %s", filename, fr_syserror(errno));
1553 rv = fstat(fd, &st);
1555 RWDEBUG("Failed stating persisted session file %s: %s", filename, fr_syserror(errno));
1560 sess_data = talloc_array(NULL, unsigned char, st.st_size);
1562 RWDEBUG("Failed allocating buffer for persisted session (%d bytes)", (int) st.st_size);
1570 rv = read(fd, q, todo);
1572 RWDEBUG("Failed reading persisted session: %s", fr_syserror(errno));
1582 * OpenSSL mutates what's passed in, so we assign sess_data to q,
1583 * so the value of q gets mutated, and not the value of sess_data.
1585 * We then need a pointer to hold &q, but it can't be const, because
1586 * clang complains about lack of consting in nested pointer types.
1588 * So we memcpy the value of that pointer, to one that
1589 * does have a const, which we then pass into d2i_SSL_SESSION *sigh*.
1593 memcpy(&o, &p, sizeof(o));
1594 sess = d2i_SSL_SESSION(NULL, o, st.st_size);
1596 RWDEBUG("Failed loading persisted session: %s", ERR_error_string(ERR_get_error(), NULL));
1600 /* read in the cached VPs from the .vps file */
1601 snprintf(filename, sizeof(filename), "%s%c%s.vps",
1602 conf->session_cache_path, FR_DIR_SEP, buffer);
1603 rv = pairlist_read(talloc_ctx, filename, &pairlist, 1);
1605 /* not safe to un-persist a session w/o VPs */
1606 RWDEBUG("Failed loading persisted VPs for session %s", buffer);
1607 SSL_SESSION_free(sess);
1613 * Enforce client certificate expiration.
1615 vp = fr_pair_find_by_num(pairlist->reply, PW_TLS_CLIENT_CERT_EXPIRATION, 0, TAG_ANY);
1619 if (ocsp_asn1time_to_epoch(&expires, vp->vp_strvalue) < 0) {
1620 RDEBUG2("Failed getting certificate expiration, removing cache entry for session %s", buffer);
1621 SSL_SESSION_free(sess);
1626 if (expires <= request->timestamp) {
1627 RDEBUG2("Certificate has expired, removing cache entry for session %s", buffer);
1628 SSL_SESSION_free(sess);
1634 * Account for Session-Timeout, if it's available.
1636 vp = fr_pair_find_by_num(request->reply->vps, PW_SESSION_TIMEOUT, 0, TAG_ANY);
1638 if ((request->timestamp + vp->vp_integer) > expires) {
1639 vp->vp_integer = expires - request->timestamp;
1640 RWDEBUG2("Updating Session-Timeout to %u, due to impending certificate expiration",
1646 /* move the cached VPs into the session */
1647 fr_pair_list_mcopy_by_num(talloc_ctx, &vps, &pairlist->reply, 0, 0, TAG_ANY);
1649 SSL_SESSION_set_ex_data(sess, fr_tls_ex_index_vps, vps);
1650 RWDEBUG("Successfully restored session %s", buffer);
1651 rdebug_pair_list(L_DBG_LVL_2, request, vps, "reply:");
1654 if (sess_data) talloc_free(sess_data);
1655 if (pairlist) pairlist_free(&pairlist);
1660 #ifdef HAVE_OPENSSL_OCSP_H
1662 /** Extract components of OCSP responser URL from a certificate
1664 * @param[in] cert to extract URL from.
1665 * @param[out] host_out Portion of the URL (must be freed with free()).
1666 * @param[out] port_out Port portion of the URL (must be freed with free()).
1667 * @param[out] path_out Path portion of the URL (must be freed with free()).
1668 * @param[out] is_https Whether the responder should be contacted using https.
1670 * - 0 if no valid URL is contained in the certificate.
1671 * - 1 if a URL was found and parsed.
1672 * - -1 if at least one URL was found, but none could be parsed.
1674 static int ocsp_parse_cert_url(X509 *cert, char **host_out, char **port_out,
1675 char **path_out, int *is_https)
1678 bool found_uri = false;
1680 AUTHORITY_INFO_ACCESS *aia;
1681 ACCESS_DESCRIPTION *ad;
1683 aia = X509_get_ext_d2i(cert, NID_info_access, NULL, NULL);
1685 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(aia); i++) {
1686 ad = sk_ACCESS_DESCRIPTION_value(aia, i);
1687 if (OBJ_obj2nid(ad->method) != NID_ad_OCSP) continue;
1688 if (ad->location->type != GEN_URI) continue;
1691 if (OCSP_parse_url((char *) ad->location->d.ia5->data, host_out,
1692 port_out, path_out, is_https)) return 1;
1694 return found_uri ? -1 : 0;
1698 * This function sends a OCSP request to a defined OCSP responder
1699 * and checks the OCSP response for correctness.
1702 /* Maximum leeway in validity period: default 5 minutes */
1703 #define MAX_VALIDITY_PERIOD (5 * 60)
1706 OCSP_STATUS_FAILED = 0,
1708 OCSP_STATUS_SKIPPED = 2,
1711 static ocsp_status_t ocsp_check(REQUEST *request, X509_STORE *store, X509 *issuer_cert, X509 *client_cert,
1712 fr_tls_server_conf_t *conf)
1714 OCSP_CERTID *certid;
1716 OCSP_RESPONSE *resp = NULL;
1717 OCSP_BASICRESP *bresp = NULL;
1721 char hostheader[1024];
1723 long nsec = MAX_VALIDITY_PERIOD, maxage = -1;
1724 BIO *cbio, *bio_out;
1725 ocsp_status_t ocsp_status = OCSP_STATUS_FAILED;
1727 ASN1_GENERALIZEDTIME *rev, *thisupd, *nextupd;
1729 #if OPENSSL_VERSION_NUMBER >= 0x1000003f
1733 struct timeval when;
1738 * Create OCSP Request
1740 certid = OCSP_cert_to_id(NULL, client_cert, issuer_cert);
1741 req = OCSP_REQUEST_new();
1742 OCSP_request_add0_id(req, certid);
1743 if (conf->ocsp_use_nonce) OCSP_request_add1_nonce(req, NULL, 8);
1746 * Send OCSP Request and get OCSP Response
1749 /* Get OCSP responder URL */
1750 if (conf->ocsp_override_url) {
1754 memcpy(&url, &conf->ocsp_url, sizeof(url));
1755 /* Reading the libssl src, they do a strdup on the URL, so it could of been const *sigh* */
1756 OCSP_parse_url(url, &host, &port, &path, &use_ssl);
1757 if (!host || !port || !path) {
1758 RWDEBUG("ocsp: Host or port or path missing from configured URL \"%s\". Not doing OCSP", url);
1764 ret = ocsp_parse_cert_url(client_cert, &host, &port, &path, &use_ssl);
1767 RWDEBUG("ocsp: Invalid URL in certificate. Not doing OCSP");
1771 if (conf->ocsp_url) {
1772 RWDEBUG("ocsp: No OCSP URL in certificate, falling back to configured URL");
1775 RWDEBUG("ocsp: No OCSP URL in certificate. Not doing OCSP");
1783 RDEBUG2("ocsp: Using responder URL \"http://%s:%s%s\"", host, port, path);
1785 /* Check host and port length are sane, then create Host: HTTP header */
1786 if ((strlen(host) + strlen(port) + 2) > sizeof(hostheader)) {
1787 RWDEBUG("ocsp: Host and port too long");
1790 snprintf(hostheader, sizeof(hostheader), "%s:%s", host, port);
1792 /* Setup BIO socket to OCSP responder */
1793 cbio = BIO_new_connect(host);
1796 if (rad_debug_lvl) {
1797 if (default_log.dst == L_DST_STDOUT) {
1798 bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
1799 } else if (default_log.dst == L_DST_STDERR) {
1800 bio_out = BIO_new_fp(stderr, BIO_NOCLOSE);
1804 BIO_set_conn_port(cbio, port);
1805 #if OPENSSL_VERSION_NUMBER < 0x1000003f
1806 BIO_do_connect(cbio);
1808 /* Send OCSP request and wait for response */
1809 resp = OCSP_sendreq_bio(cbio, path, req);
1811 REDEBUG("ocsp: Couldn't get OCSP response");
1812 ocsp_status = OCSP_STATUS_SKIPPED;
1816 if (conf->ocsp_timeout)
1817 BIO_set_nbio(cbio, 1);
1819 rc = BIO_do_connect(cbio);
1820 if ((rc <= 0) && ((!conf->ocsp_timeout) || !BIO_should_retry(cbio))) {
1821 REDEBUG("ocsp: Couldn't connect to OCSP responder");
1822 ocsp_status = OCSP_STATUS_SKIPPED;
1826 ctx = OCSP_sendreq_new(cbio, path, NULL, -1);
1828 REDEBUG("ocsp: Couldn't create OCSP request");
1829 ocsp_status = OCSP_STATUS_SKIPPED;
1833 if (!OCSP_REQ_CTX_add1_header(ctx, "Host", hostheader)) {
1834 REDEBUG("ocsp: Couldn't set Host header");
1835 ocsp_status = OCSP_STATUS_SKIPPED;
1839 if (!OCSP_REQ_CTX_set1_req(ctx, req)) {
1840 REDEBUG("ocsp: Couldn't add data to OCSP request");
1841 ocsp_status = OCSP_STATUS_SKIPPED;
1845 gettimeofday(&when, NULL);
1846 when.tv_sec += conf->ocsp_timeout;
1849 rc = OCSP_sendreq_nbio(&resp, ctx);
1850 if (conf->ocsp_timeout) {
1851 gettimeofday(&now, NULL);
1852 if (!timercmp(&now, &when, <))
1855 } while ((rc == -1) && BIO_should_retry(cbio));
1857 if (conf->ocsp_timeout && (rc == -1) && BIO_should_retry(cbio)) {
1858 REDEBUG("ocsp: Response timed out");
1859 ocsp_status = OCSP_STATUS_SKIPPED;
1863 OCSP_REQ_CTX_free(ctx);
1866 REDEBUG("ocsp: Couldn't get OCSP response");
1867 ocsp_status = OCSP_STATUS_SKIPPED;
1872 /* Verify OCSP response status */
1873 status = OCSP_response_status(resp);
1874 if (status != OCSP_RESPONSE_STATUS_SUCCESSFUL) {
1875 REDEBUG("ocsp: Response status: %s", OCSP_response_status_str(status));
1878 bresp = OCSP_response_get1_basic(resp);
1879 if (conf->ocsp_use_nonce && OCSP_check_nonce(req, bresp)!=1) {
1880 REDEBUG("ocsp: Response has wrong nonce value");
1883 if (OCSP_basic_verify(bresp, NULL, store, 0)!=1){
1884 REDEBUG("ocsp: Couldn't verify OCSP basic response");
1888 /* Verify OCSP cert status */
1889 if (!OCSP_resp_find_status(bresp, certid, &status, &reason, &rev, &thisupd, &nextupd)) {
1890 REDEBUG("ocsp: No Status found");
1894 if (!OCSP_check_validity(thisupd, nextupd, nsec, maxage)) {
1896 BIO_puts(bio_out, "WARNING: Status times invalid.\n");
1897 ERR_print_errors(bio_out);
1903 BIO_puts(bio_out, "\tThis Update: ");
1904 ASN1_GENERALIZEDTIME_print(bio_out, thisupd);
1905 BIO_puts(bio_out, "\n");
1907 BIO_puts(bio_out, "\tNext Update: ");
1908 ASN1_GENERALIZEDTIME_print(bio_out, nextupd);
1909 BIO_puts(bio_out, "\n");
1914 case V_OCSP_CERTSTATUS_GOOD:
1915 RDEBUG2("ocsp: Cert status: good");
1916 vp = pair_make_request("TLS-OCSP-Cert-Valid", NULL, T_OP_SET);
1917 vp->vp_integer = 1; /* yes */
1918 ocsp_status = OCSP_STATUS_OK;
1922 /* REVOKED / UNKNOWN */
1923 REDEBUG("ocsp: Cert status: %s", OCSP_cert_status_str(status));
1924 if (reason != -1) REDEBUG("ocsp: Reason: %s", OCSP_crl_reason_str(reason));
1927 BIO_puts(bio_out, "\tRevocation Time: ");
1928 ASN1_GENERALIZEDTIME_print(bio_out, rev);
1929 BIO_puts(bio_out, "\n");
1935 /* Free OCSP Stuff */
1936 OCSP_REQUEST_free(req);
1937 OCSP_RESPONSE_free(resp);
1942 if (bio_out) BIO_free(bio_out);
1943 OCSP_BASICRESP_free(bresp);
1945 switch (ocsp_status) {
1946 case OCSP_STATUS_OK:
1947 RDEBUG2("ocsp: Certificate is valid");
1950 case OCSP_STATUS_SKIPPED:
1952 vp = pair_make_request("TLS-OCSP-Cert-Valid", NULL, T_OP_SET);
1953 vp->vp_integer = 2; /* skipped */
1954 if (conf->ocsp_softfail) {
1955 RWDEBUG("ocsp: Unable to check certificate, assuming it's valid");
1956 RWDEBUG("ocsp: This may be insecure");
1958 /* Remove OpenSSL errors from queue or handshake will fail */
1959 while (ERR_get_error());
1961 ocsp_status = OCSP_STATUS_SKIPPED;
1963 REDEBUG("ocsp: Unable to check certificate, failing");
1964 ocsp_status = OCSP_STATUS_FAILED;
1969 vp = pair_make_request("TLS-OCSP-Cert-Valid", NULL, T_OP_SET);
1970 vp->vp_integer = 0; /* no */
1971 REDEBUG("ocsp: Certificate has been expired/revoked");
1977 #endif /* HAVE_OPENSSL_OCSP_H */
1980 * For creating certificate attributes.
1982 static char const *cert_attr_names[8][2] = {
1983 { "TLS-Client-Cert-Serial", "TLS-Cert-Serial" },
1984 { "TLS-Client-Cert-Expiration", "TLS-Cert-Expiration" },
1985 { "TLS-Client-Cert-Subject", "TLS-Cert-Subject" },
1986 { "TLS-Client-Cert-Issuer", "TLS-Cert-Issuer" },
1987 { "TLS-Client-Cert-Common-Name", "TLS-Cert-Common-Name" },
1988 { "TLS-Client-Cert-Subject-Alt-Name-Email", "TLS-Cert-Subject-Alt-Name-Email" },
1989 { "TLS-Client-Cert-Subject-Alt-Name-Dns", "TLS-Cert-Subject-Alt-Name-Dns" },
1990 { "TLS-Client-Cert-Subject-Alt-Name-Upn", "TLS-Cert-Subject-Alt-Name-Upn" }
1993 #define FR_TLS_SERIAL (0)
1994 #define FR_TLS_EXPIRATION (1)
1995 #define FR_TLS_SUBJECT (2)
1996 #define FR_TLS_ISSUER (3)
1997 #define FR_TLS_CN (4)
1998 #define FR_TLS_SAN_EMAIL (5)
1999 #define FR_TLS_SAN_DNS (6)
2000 #define FR_TLS_SAN_UPN (7)
2003 * Before trusting a certificate, you must make sure that the
2004 * certificate is 'valid'. There are several steps that your
2005 * application can take in determining if a certificate is
2006 * valid. Commonly used steps are:
2008 * 1.Verifying the certificate's signature, and verifying that
2009 * the certificate has been issued by a trusted Certificate
2012 * 2.Verifying that the certificate is valid for the present date
2013 * (i.e. it is being presented within its validity dates).
2015 * 3.Verifying that the certificate has not been revoked by its
2016 * issuing Certificate Authority, by checking with respect to a
2017 * Certificate Revocation List (CRL).
2019 * 4.Verifying that the credentials presented by the certificate
2020 * fulfill additional requirements specific to the application,
2021 * such as with respect to access control lists or with respect
2022 * to OCSP (Online Certificate Status Processing).
2024 * NOTE: This callback will be called multiple times based on the
2025 * depth of the root certificate chain
2027 int cbtls_verify(int ok, X509_STORE_CTX *ctx)
2029 char subject[1024]; /* Used for the subject name */
2030 char issuer[1024]; /* Used for the issuer name */
2031 char attribute[1024];
2033 char common_name[1024];
2037 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
2038 const STACK_OF(X509_EXTENSION) *ext_list;
2040 STACK_OF(X509_EXTENSION) *ext_list;
2043 int err, depth, lookup, loc;
2044 fr_tls_server_conf_t *conf;
2047 ASN1_INTEGER *sn = NULL;
2048 ASN1_TIME *asn_time = NULL;
2051 #ifdef HAVE_OPENSSL_OCSP_H
2052 X509_STORE *ocsp_store = NULL;
2054 bool do_verify = false;
2057 TALLOC_CTX *talloc_ctx;
2061 client_cert = X509_STORE_CTX_get_current_cert(ctx);
2062 err = X509_STORE_CTX_get_error(ctx);
2063 depth = X509_STORE_CTX_get_error_depth(ctx);
2068 * Log client/issuing cert. If there's an error, log
2071 if ((lookup > 1) && !my_ok) lookup = 1;
2074 * Retrieve the pointer to the SSL of the connection currently treated
2075 * and the application specific data stored into the SSL object.
2077 ssl = X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
2078 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
2079 if (!conf) return 1;
2081 request = (REQUEST *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_REQUEST);
2082 rad_assert(request != NULL);
2083 certs = (VALUE_PAIR **)SSL_get_ex_data(ssl, fr_tls_ex_index_certs);
2085 identity = (char **)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_IDENTITY);
2086 #ifdef HAVE_OPENSSL_OCSP_H
2087 ocsp_store = conf->ocsp_store;
2090 talloc_ctx = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_TALLOC);
2093 * Get the Serial Number
2096 sn = X509_get_serialNumber(client_cert);
2098 RDEBUG2("Creating attributes from certificate OIDs");
2102 * For this next bit, we create the attributes *only* if
2103 * we're at the client or issuing certificate, AND we
2104 * have a user identity. i.e. we don't create the
2105 * attributes for RadSec connections.
2107 if (certs && identity &&
2108 (lookup <= 1) && sn && ((size_t) sn->length < (sizeof(buf) / 2))) {
2112 for (i = 0; i < sn->length; i++) {
2113 sprintf(p, "%02x", (unsigned int)sn->data[i]);
2116 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_SERIAL][lookup], buf, T_OP_SET);
2117 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2122 * Get the Expiration Date
2125 asn_time = X509_get_notAfter(client_cert);
2126 if (certs && identity && (lookup <= 1) && asn_time &&
2127 (asn_time->length < (int) sizeof(buf))) {
2128 memcpy(buf, (char*) asn_time->data, asn_time->length);
2129 buf[asn_time->length] = '\0';
2130 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_EXPIRATION][lookup], buf, T_OP_SET);
2131 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2135 * Get the Subject & Issuer
2137 subject[0] = issuer[0] = '\0';
2138 X509_NAME_oneline(X509_get_subject_name(client_cert), subject,
2140 subject[sizeof(subject) - 1] = '\0';
2141 if (certs && identity && (lookup <= 1) && subject[0]) {
2142 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_SUBJECT][lookup], subject, T_OP_SET);
2143 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2146 X509_NAME_oneline(X509_get_issuer_name(client_cert), issuer,
2148 issuer[sizeof(issuer) - 1] = '\0';
2149 if (certs && identity && (lookup <= 1) && issuer[0]) {
2150 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_ISSUER][lookup], issuer, T_OP_SET);
2151 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2155 * Get the Common Name, if there is a subject.
2157 X509_NAME_get_text_by_NID(X509_get_subject_name(client_cert),
2158 NID_commonName, common_name, sizeof(common_name));
2159 common_name[sizeof(common_name) - 1] = '\0';
2160 if (certs && identity && (lookup <= 1) && common_name[0] && subject[0]) {
2161 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_CN][lookup], common_name, T_OP_SET);
2162 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2166 * Get the RFC822 Subject Alternative Name
2168 loc = X509_get_ext_by_NID(client_cert, NID_subject_alt_name, -1);
2169 if (certs && (lookup <= 1) && (loc >= 0)) {
2170 X509_EXTENSION *ext = NULL;
2171 GENERAL_NAMES *names = NULL;
2174 if ((ext = X509_get_ext(client_cert, loc)) &&
2175 (names = X509V3_EXT_d2i(ext))) {
2176 for (i = 0; i < sk_GENERAL_NAME_num(names); i++) {
2177 GENERAL_NAME *name = sk_GENERAL_NAME_value(names, i);
2179 switch (name->type) {
2182 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_EMAIL][lookup],
2183 (char const *) ASN1_STRING_get0_data(name->d.rfc822Name), T_OP_SET);
2184 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2186 #endif /* GEN_EMAIL */
2189 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_DNS][lookup],
2190 (char const *) ASN1_STRING_get0_data(name->d.dNSName), T_OP_SET);
2191 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2193 #endif /* GEN_DNS */
2194 #ifdef GEN_OTHERNAME
2196 /* look for a MS UPN */
2197 if (NID_ms_upn == OBJ_obj2nid(name->d.otherName->type_id)) {
2198 /* we've got a UPN - Must be ASN1-encoded UTF8 string */
2199 if (name->d.otherName->value->type == V_ASN1_UTF8STRING) {
2200 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_UPN][lookup],
2201 (char const *) ASN1_STRING_get0_data(name->d.otherName->value->value.utf8string), T_OP_SET);
2202 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2205 RWARN("Invalid UPN in Subject Alt Name (should be UTF-8)");
2210 #endif /* GEN_OTHERNAME */
2212 /* XXX TODO handle other SAN types */
2218 GENERAL_NAMES_free(names);
2222 * If the CRL has expired, that might still be OK.
2225 (conf->allow_expired_crl) &&
2226 (err == X509_V_ERR_CRL_HAS_EXPIRED)) {
2228 X509_STORE_CTX_set_error( ctx, 0 );
2232 char const *p = X509_verify_cert_error_string(err);
2233 RERROR("SSL says error %d : %s", err, p);
2239 #if OPENSSL_VERSION_NUMBER >= 0x10100000L && !defined(LIBRESSL_VERSION_NUMBER)
2240 ext_list = X509_get0_extensions(client_cert);
2242 X509_CINF *client_inf;
2243 client_inf = client_cert->cert_info;
2244 ext_list = client_inf->extensions;
2251 * Grab the X509 extensions, and create attributes out of them.
2252 * For laziness, we re-use the OpenSSL names
2254 if (certs && (sk_X509_EXTENSION_num(ext_list) > 0)) {
2259 out = BIO_new(BIO_s_mem());
2260 strlcpy(attribute, "TLS-Client-Cert-", sizeof(attribute));
2262 for (i = 0; i < sk_X509_EXTENSION_num(ext_list); i++) {
2264 X509_EXTENSION *ext;
2266 ext = sk_X509_EXTENSION_value(ext_list, i);
2268 obj = X509_EXTENSION_get_object(ext);
2269 i2a_ASN1_OBJECT(out, obj);
2270 len = BIO_read(out, attribute + 16 , sizeof(attribute) - 16 - 1);
2271 if (len <= 0) continue;
2273 attribute[16 + len] = '\0';
2275 for (p = attribute + 16; *p != '\0'; p++) {
2276 if (*p == ' ') *p = '-';
2279 X509V3_EXT_print(out, ext, 0, 0);
2280 len = BIO_read(out, value , sizeof(value) - 1);
2281 if (len <= 0) continue;
2285 vp = fr_pair_make(talloc_ctx, certs, attribute, value, T_OP_ADD);
2287 RDEBUG3("Skipping %s += '%s'. Please check that both the "
2288 "attribute and value are defined in the dictionaries",
2292 * rdebug_pair_list indents (so pre REXDENT())
2295 rdebug_pair_list(L_DBG_LVL_2, request, vp, NULL);
2305 switch (X509_STORE_CTX_get_error(ctx)) {
2306 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
2307 RERROR("issuer=%s", issuer);
2310 case X509_V_ERR_CERT_NOT_YET_VALID:
2311 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
2312 RERROR("notBefore=");
2314 ASN1_TIME_print(bio_err, X509_get_notBefore(ctx->current_cert));
2318 case X509_V_ERR_CERT_HAS_EXPIRED:
2319 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
2320 RERROR("notAfter=");
2322 ASN1_TIME_print(bio_err, X509_get_notAfter(ctx->current_cert));
2328 * If we're at the actual client cert, apply additional
2333 * If the conf tells us to, check cert issuer
2334 * against the specified value and fail
2335 * verification if they don't match.
2337 if (conf->check_cert_issuer &&
2338 (strcmp(issuer, conf->check_cert_issuer) != 0)) {
2339 AUTH(LOG_PREFIX ": Certificate issuer (%s) does not match specified value (%s)!",
2340 issuer, conf->check_cert_issuer);
2345 * If the conf tells us to, check the CN in the
2346 * cert against xlat'ed value, but only if the
2347 * previous checks passed.
2349 if (my_ok && conf->check_cert_cn) {
2350 if (radius_xlat(cn_str, sizeof(cn_str), request, conf->check_cert_cn, NULL, NULL) < 0) {
2351 /* if this fails, fail the verification */
2354 RDEBUG2("checking certificate CN (%s) with xlat'ed value (%s)", common_name, cn_str);
2355 if (strcmp(cn_str, common_name) != 0) {
2356 AUTH(LOG_PREFIX ": Certificate CN (%s) does not match specified value (%s)!",
2357 common_name, cn_str);
2361 } /* check_cert_cn */
2363 #ifdef HAVE_OPENSSL_OCSP_H
2366 * No OCSP, allow external verification.
2368 if (!conf->ocsp_enable) {
2372 RDEBUG2("Starting OCSP Request");
2373 if ((X509_STORE_CTX_get1_issuer(&issuer_cert, ctx, client_cert) != 1) ||
2376 * Allow for external verify.
2378 RERROR("Couldn't get issuer_cert for %s", common_name);
2383 * Do the full OCSP checks.
2385 * If they fail, don't run the external verify. We don't want
2386 * to allow admins to force authentication success for bad
2389 * If the OCSP checks succeed, check whether we still want to
2390 * run the external verification routine. If it's marked as
2391 * "skip verify on OK", then we don't do verify.
2393 my_ok = ocsp_check(request, ocsp_store, issuer_cert, client_cert, conf);
2394 if (my_ok != OCSP_STATUS_FAILED) {
2395 do_verify = !conf->verify_skip_if_ocsp_ok;
2402 if ((my_ok != OCSP_STATUS_FAILED)
2403 #ifdef HAVE_OPENSSL_OCSP_H
2406 ) while (conf->verify_client_cert_cmd) {
2411 snprintf(filename, sizeof(filename), "%s/%s.client.XXXXXXXX",
2412 conf->verify_tmp_dir, main_config.name);
2413 fd = mkstemp(filename);
2415 RDEBUG("Failed creating file in %s: %s",
2416 conf->verify_tmp_dir, fr_syserror(errno));
2420 fp = fdopen(fd, "w");
2423 RDEBUG("Failed opening file %s: %s",
2424 filename, fr_syserror(errno));
2428 if (!PEM_write_X509(fp, client_cert)) {
2430 RDEBUG("Failed writing certificate to file");
2435 if (!pair_make_request("TLS-Client-Cert-Filename",
2436 filename, T_OP_SET)) {
2437 RDEBUG("Failed creating TLS-Client-Cert-Filename");
2442 RDEBUG("Verifying client certificate: %s", conf->verify_client_cert_cmd);
2443 if (radius_exec_program(request, NULL, 0, NULL, request, conf->verify_client_cert_cmd,
2444 request->packet->vps,
2445 true, true, EXEC_TIMEOUT) != 0) {
2446 AUTH(LOG_PREFIX ": Certificate CN (%s) fails external verification!", common_name);
2449 } else if (request) {
2450 RDEBUG("Client certificate CN %s passed external validation", common_name);
2459 if (certs && request && !my_ok) {
2460 fr_pair_add(&request->packet->vps, fr_pair_list_copy(request->packet, *certs));
2463 if (RDEBUG_ENABLED3) {
2464 RDEBUG3("chain-depth : %d", depth);
2465 RDEBUG3("error : %d", err);
2467 if (identity) RDEBUG3("identity : %s", *identity);
2468 RDEBUG3("common name : %s", common_name);
2469 RDEBUG3("subject : %s", subject);
2470 RDEBUG3("issuer : %s", issuer);
2471 RDEBUG3("verify return : %d", my_ok);
2474 return (my_ok != 0);
2478 #ifdef HAVE_OPENSSL_OCSP_H
2480 * Create Global X509 revocation store and use it to verify
2483 * - Load the trusted CAs
2484 * - Load the trusted issuer certificates
2486 static X509_STORE *init_revocation_store(fr_tls_server_conf_t *conf)
2488 X509_STORE *store = NULL;
2490 store = X509_STORE_new();
2492 /* Load the CAs we trust */
2493 if (conf->ca_file || conf->ca_path)
2494 if (!X509_STORE_load_locations(store, conf->ca_file, conf->ca_path)) {
2495 tls_error_log(NULL, "Error reading Trusted root CA list \"%s\"", conf->ca_file);
2499 #ifdef X509_V_FLAG_CRL_CHECK
2500 if (conf->check_crl)
2501 X509_STORE_set_flags(store, X509_V_FLAG_CRL_CHECK);
2503 #ifdef X509_V_FLAG_CRL_CHECK_ALL
2504 if (conf->check_all_crl)
2505 X509_STORE_set_flags(store, X509_V_FLAG_CRL_CHECK_ALL);
2509 #endif /* HAVE_OPENSSL_OCSP_H */
2511 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
2512 #ifndef OPENSSL_NO_ECDH
2513 static int set_ecdh_curve(SSL_CTX *ctx, char const *ecdh_curve, bool disable_single_dh_use)
2518 if (!ecdh_curve || !*ecdh_curve) return 0;
2520 nid = OBJ_sn2nid(ecdh_curve);
2522 ERROR(LOG_PREFIX ": Unknown ecdh_curve \"%s\"", ecdh_curve);
2526 ecdh = EC_KEY_new_by_curve_name(nid);
2528 ERROR(LOG_PREFIX ": Unable to create new curve \"%s\"", ecdh_curve);
2532 SSL_CTX_set_tmp_ecdh(ctx, ecdh);
2534 if (!disable_single_dh_use) {
2535 SSL_CTX_set_options(ctx, SSL_OP_SINGLE_ECDH_USE);
2546 * DIE OPENSSL DIE DIE DIE
2548 * What a palaver, just to free some data attached the
2549 * session. We need to do this because the "remove" callback
2550 * is called when refcount > 0 sometimes, if another thread
2551 * is using the session
2553 static void sess_free_vps(UNUSED void *parent, void *data_ptr,
2554 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
2555 UNUSED long argl, UNUSED void *argp)
2557 VALUE_PAIR *vp = data_ptr;
2560 DEBUG2(LOG_PREFIX ": Freeing cached session VPs");
2562 fr_pair_list_free(&vp);
2565 static void sess_free_certs(UNUSED void *parent, void *data_ptr,
2566 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
2567 UNUSED long argl, UNUSED void *argp)
2569 VALUE_PAIR **certs = data_ptr;
2572 DEBUG2(LOG_PREFIX ": Freeing cached session Certificates");
2574 fr_pair_list_free(certs);
2577 /** Add all the default ciphers and message digests reate our context.
2579 * This should be called exactly once from main, before reading the main config
2580 * or initialising any modules.
2582 void tls_global_init(void)
2584 SSL_load_error_strings(); /* readable error messages (examples show call before library_init) */
2585 SSL_library_init(); /* initialize library */
2586 OpenSSL_add_all_algorithms(); /* required for SHA2 in OpenSSL < 0.9.8o and 1.0.0.a */
2587 CONF_modules_load_file(NULL, NULL, 0);
2590 * Initialize the index for the certificates.
2592 fr_tls_ex_index_certs = SSL_SESSION_get_ex_new_index(0, NULL, NULL, NULL, sess_free_certs);
2595 #ifdef ENABLE_OPENSSL_VERSION_CHECK
2596 /** Check for vulnerable versions of libssl
2598 * @param acknowledged The highest CVE number a user has confirmed is not present in the system's libssl.
2599 * @return 0 if the CVE specified by the user matches the most recent CVE we have, else -1.
2601 int tls_global_version_check(char const *acknowledged)
2607 if (strcmp(acknowledged, "yes") == 0) return 0;
2609 /* Check for bad versions */
2610 v = (uint64_t) SSLeay();
2612 for (i = 0; i < (sizeof(libssl_defects) / sizeof(*libssl_defects)); i++) {
2613 libssl_defect_t *defect = &libssl_defects[i];
2615 if ((v >= defect->low) && (v <= defect->high)) {
2617 * If the CVE is acknowledged, allow it.
2619 if (!bad && (strcmp(acknowledged, defect->id) == 0)) return 0;
2621 ERROR("Refusing to start with libssl version %s (in range %s)",
2622 ssl_version(), ssl_version_range(defect->low, defect->high));
2623 ERROR("Security advisory %s (%s)", defect->id, defect->name);
2624 ERROR("%s", defect->comment);
2627 * Only warn about the first one...
2630 INFO("Once you have verified libssl has been correctly patched, "
2631 "set security.allow_vulnerable_openssl = '%s'", defect->id);
2644 /** Free any memory alloced by libssl
2647 void tls_global_cleanup(void)
2649 #if OPENSSL_VERSION_NUMBER < 0x10000000L
2650 ERR_remove_state(0);
2651 #elif OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
2652 ERR_remove_thread_state(NULL);
2655 CONF_modules_unload(1);
2658 CRYPTO_cleanup_all_ex_data();
2661 /** Create SSL context
2663 * - Load the trusted CAs
2664 * - Load the Private key & the certificate
2665 * - Set the Context options & Verify options
2667 SSL_CTX *tls_init_ctx(fr_tls_server_conf_t *conf, int client)
2670 X509_STORE *certstore;
2671 int verify_mode = SSL_VERIFY_NONE;
2672 int ctx_options = 0;
2673 int ctx_tls_versions = 0;
2677 * SHA256 is in all versions of OpenSSL, but isn't
2678 * initialized by default. It's needed for WiMAX
2681 #ifdef HAVE_OPENSSL_EVP_SHA256
2682 EVP_add_digest(EVP_sha256());
2685 ctx = SSL_CTX_new(SSLv23_method()); /* which is really "all known SSL / TLS methods". Idiots. */
2687 tls_error_log(NULL, "Failed creating TLS context");
2692 * Save the config on the context so that callbacks which
2693 * only get SSL_CTX* e.g. session persistence, can get it
2695 SSL_CTX_set_app_data(ctx, conf);
2698 * Identify the type of certificates that needs to be loaded
2700 if (conf->file_type) {
2701 type = SSL_FILETYPE_PEM;
2703 type = SSL_FILETYPE_ASN1;
2707 * Set the password to load private key
2709 if (conf->private_key_password) {
2712 * We don't want to put the private key password in eap.conf, so check
2713 * for our special string which indicates we should get the password
2716 char const* special_string = "Apple:UseCertAdmin";
2717 if (strncmp(conf->private_key_password, special_string, strlen(special_string)) == 0) {
2720 long const max_password_len = 128;
2721 snprintf(cmd, sizeof(cmd) - 1, "/usr/sbin/certadmin --get-private-key-passphrase \"%s\"",
2722 conf->private_key_file);
2724 DEBUG2(LOG_PREFIX ": Getting private key passphrase using command \"%s\"", cmd);
2726 FILE* cmd_pipe = popen(cmd, "r");
2728 ERROR(LOG_PREFIX ": %s command failed: Unable to get private_key_password", cmd);
2729 ERROR(LOG_PREFIX ": Error reading private_key_file %s", conf->private_key_file);
2733 rad_const_free(conf->private_key_password);
2734 password = talloc_array(conf, char, max_password_len);
2736 ERROR(LOG_PREFIX ": Can't allocate space for private_key_password");
2737 ERROR(LOG_PREFIX ": Error reading private_key_file %s", conf->private_key_file);
2742 fgets(password, max_password_len, cmd_pipe);
2745 /* Get rid of newline at end of password. */
2746 password[strlen(password) - 1] = '\0';
2748 DEBUG3(LOG_PREFIX ": Password from command = \"%s\"", password);
2749 conf->private_key_password = password;
2756 memcpy(&password, &conf->private_key_password, sizeof(password));
2757 SSL_CTX_set_default_passwd_cb_userdata(ctx, password);
2758 SSL_CTX_set_default_passwd_cb(ctx, cbtls_password);
2762 #ifdef PSK_MAX_IDENTITY_LEN
2765 * No dynamic query exists. There MUST be a
2766 * statically configured identity and password.
2768 if (conf->psk_query && !*conf->psk_query) {
2769 ERROR(LOG_PREFIX ": Invalid PSK Configuration: psk_query cannot be empty");
2774 * Set the callback only if we can check things.
2776 if (conf->psk_identity || conf->psk_query) {
2777 SSL_CTX_set_psk_server_callback(ctx, psk_server_callback);
2780 } else if (conf->psk_query) {
2781 ERROR(LOG_PREFIX ": Invalid PSK Configuration: psk_query cannot be used for outgoing connections");
2786 * Now check that if PSK is being used, the config is valid.
2788 if ((conf->psk_identity && !conf->psk_password) ||
2789 (!conf->psk_identity && conf->psk_password) ||
2790 (conf->psk_identity && !*conf->psk_identity) ||
2791 (conf->psk_password && !*conf->psk_password)) {
2792 ERROR(LOG_PREFIX ": Invalid PSK Configuration: psk_identity or psk_password are empty");
2796 if (conf->psk_identity) {
2797 size_t psk_len, hex_len;
2798 uint8_t buffer[PSK_MAX_PSK_LEN];
2800 if (conf->certificate_file ||
2801 conf->private_key_password || conf->private_key_file ||
2802 conf->ca_file || conf->ca_path) {
2803 ERROR(LOG_PREFIX ": When PSKs are used, No certificate configuration is permitted");
2808 SSL_CTX_set_psk_client_callback(ctx,
2809 psk_client_callback);
2812 psk_len = strlen(conf->psk_password);
2813 if (strlen(conf->psk_password) > (2 * PSK_MAX_PSK_LEN)) {
2814 ERROR(LOG_PREFIX ": psk_hexphrase is too long (max %d)", PSK_MAX_PSK_LEN);
2819 * Check the password now, so that we don't have
2820 * errors at run-time.
2822 hex_len = fr_hex2bin(buffer, sizeof(buffer), conf->psk_password, psk_len);
2823 if (psk_len != (2 * hex_len)) {
2824 ERROR(LOG_PREFIX ": psk_hexphrase is not all hex");
2831 (void) client; /* -Wunused */
2835 * Load our keys and certificates
2837 * If certificates are of type PEM then we can make use
2838 * of cert chain authentication using openssl api call
2839 * SSL_CTX_use_certificate_chain_file. Please see how
2840 * the cert chain needs to be given in PEM from
2843 if (!conf->certificate_file) goto load_ca;
2845 if (type == SSL_FILETYPE_PEM) {
2846 if (!(SSL_CTX_use_certificate_chain_file(ctx, conf->certificate_file))) {
2847 tls_error_log(NULL, "Failed reading certificate file \"%s\"",
2848 conf->certificate_file);
2852 } else if (!(SSL_CTX_use_certificate_file(ctx, conf->certificate_file, type))) {
2853 tls_error_log(NULL, "Failed reading certificate file \"%s\"",
2854 conf->certificate_file);
2858 /* Load the CAs we trust */
2860 if (conf->ca_file || conf->ca_path) {
2861 if (!SSL_CTX_load_verify_locations(ctx, conf->ca_file, conf->ca_path)) {
2862 tls_error_log(NULL, "Failed reading Trusted root CA list \"%s\"",
2867 if (conf->ca_file && *conf->ca_file) SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(conf->ca_file));
2869 if (conf->private_key_file) {
2870 if (!(SSL_CTX_use_PrivateKey_file(ctx, conf->private_key_file, type))) {
2871 tls_error_log(NULL, "Failed reading private key file \"%s\"",
2872 conf->private_key_file);
2877 * Check if the loaded private key is the right one
2879 if (!SSL_CTX_check_private_key(ctx)) {
2880 ERROR(LOG_PREFIX ": Private key does not match the certificate public key");
2885 #ifdef PSK_MAX_IDENTITY_LEN
2890 * We never want SSLv2 or SSLv3.
2892 ctx_options |= SSL_OP_NO_SSLv2;
2893 ctx_options |= SSL_OP_NO_SSLv3;
2896 * As of 3.0.5, we always allow TLSv1.1 and TLSv1.2.
2897 * Though they can be *globally* disabled if necessary.x
2899 #ifdef SSL_OP_NO_TLSv1
2900 if (conf->disable_tlsv1) ctx_options |= SSL_OP_NO_TLSv1;
2902 ctx_tls_versions |= SSL_OP_NO_TLSv1;
2904 #ifdef SSL_OP_NO_TLSv1_1
2905 if (conf->disable_tlsv1_1) ctx_options |= SSL_OP_NO_TLSv1_1;
2907 ctx_tls_versions |= SSL_OP_NO_TLSv1_1;
2909 #ifdef SSL_OP_NO_TLSv1_2
2911 if (conf->disable_tlsv1_2) ctx_options |= SSL_OP_NO_TLSv1_2;
2913 ctx_tls_versions |= SSL_OP_NO_TLSv1_2;
2917 if ((ctx_options & ctx_tls_versions) == ctx_tls_versions) {
2918 ERROR(LOG_PREFIX ": You have disabled all available TLS versions. EAP will not work");
2922 #ifdef SSL_OP_NO_TICKET
2923 ctx_options |= SSL_OP_NO_TICKET;
2926 if (!conf->disable_single_dh_use) {
2928 * SSL_OP_SINGLE_DH_USE must be used in order to prevent
2929 * small subgroup attacks and forward secrecy. Always
2930 * using SSL_OP_SINGLE_DH_USE has an impact on the
2931 * computer time needed during negotiation, but it is not
2934 ctx_options |= SSL_OP_SINGLE_DH_USE;
2938 * SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS to work around issues
2939 * in Windows Vista client.
2940 * http://www.openssl.org/~bodo/tls-cbc.txt
2941 * http://www.nabble.com/(RADIATOR)-Radiator-Version-3.16-released-t2600070.html
2943 ctx_options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
2945 if (conf->cipher_server_preference) {
2947 * SSL_OP_CIPHER_SERVER_PREFERENCE to follow best practice
2948 * of nowday's TLS: do not allow poorly-selected ciphers from
2949 * client to take preference
2951 ctx_options |= SSL_OP_CIPHER_SERVER_PREFERENCE;
2954 SSL_CTX_set_options(ctx, ctx_options);
2957 * TODO: Set the RSA & DH
2958 * SSL_CTX_set_tmp_rsa_callback(ctx, cbtls_rsa);
2959 * SSL_CTX_set_tmp_dh_callback(ctx, cbtls_dh);
2963 * set the message callback to identify the type of
2964 * message. For every new session, there can be a
2965 * different callback argument.
2967 * SSL_CTX_set_msg_callback(ctx, cbtls_msg);
2971 * Set eliptical curve crypto configuration.
2973 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
2974 #ifndef OPENSSL_NO_ECDH
2975 if (set_ecdh_curve(ctx, conf->ecdh_curve, conf->disable_single_dh_use) < 0) {
2982 * OpenSSL will automatically create certificate chains,
2983 * unless we tell it to not do that. The problem is that
2984 * it sometimes gets the chains right from a certificate
2985 * signature view, but wrong from the clients view.
2987 if (!conf->auto_chain) {
2988 SSL_CTX_set_mode(ctx, SSL_MODE_NO_AUTO_CHAIN);
2991 /* Set Info callback */
2992 SSL_CTX_set_info_callback(ctx, cbtls_info);
2995 * Callbacks, etc. for session resumption.
2997 if (conf->session_cache_enable) {
2999 * Cache sessions on disk if requested.
3001 if (conf->session_cache_path) {
3002 SSL_CTX_sess_set_new_cb(ctx, cbtls_new_session);
3003 SSL_CTX_sess_set_get_cb(ctx, cbtls_get_session);
3004 SSL_CTX_sess_set_remove_cb(ctx, cbtls_remove_session);
3007 SSL_CTX_set_quiet_shutdown(ctx, 1);
3008 if (fr_tls_ex_index_vps < 0)
3009 fr_tls_ex_index_vps = SSL_SESSION_get_ex_new_index(0, NULL, NULL, NULL, sess_free_vps);
3013 * Check the certificates for revocation.
3015 #ifdef X509_V_FLAG_CRL_CHECK
3016 if (conf->check_crl) {
3017 certstore = SSL_CTX_get_cert_store(ctx);
3018 if (certstore == NULL) {
3019 tls_error_log(NULL, "Error reading Certificate Store");
3022 X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK);
3024 #ifdef X509_V_FLAG_CRL_CHECK_ALL
3025 if (conf->check_all_crl)
3026 X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK_ALL);
3033 * Always verify the peer certificate
3035 verify_mode |= SSL_VERIFY_PEER;
3036 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
3037 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
3038 SSL_CTX_set_verify(ctx, verify_mode, cbtls_verify);
3040 if (conf->verify_depth) {
3041 SSL_CTX_set_verify_depth(ctx, conf->verify_depth);
3044 /* Load randomness */
3045 if (conf->random_file) {
3046 if (!(RAND_load_file(conf->random_file, 1024*10))) {
3047 tls_error_log(NULL, "Failed loading randomness");
3053 * Set the cipher list if we were told to
3055 if (conf->cipher_list) {
3056 if (!SSL_CTX_set_cipher_list(ctx, conf->cipher_list)) {
3057 tls_error_log(NULL, "Failed setting cipher list");
3063 * Setup session caching
3065 if (conf->session_cache_enable) {
3067 * Create a unique context Id per EAP-TLS configuration.
3069 if (conf->session_id_name) {
3070 snprintf(conf->session_context_id, sizeof(conf->session_context_id),
3071 "FR eap %s", conf->session_id_name);
3073 snprintf(conf->session_context_id, sizeof(conf->session_context_id),
3078 * Cache it, DON'T auto-clear it, and disable the internal OpenSSL session cache.
3080 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_SERVER | SSL_SESS_CACHE_NO_AUTO_CLEAR | SSL_SESS_CACHE_NO_INTERNAL);
3082 SSL_CTX_set_session_id_context(ctx,
3083 (unsigned char *) conf->session_context_id,
3084 (unsigned int) strlen(conf->session_context_id));
3087 * Our timeout is in hours, this is in seconds.
3089 SSL_CTX_set_timeout(ctx, conf->session_timeout * 3600);
3092 * Set the maximum number of entries in the
3095 SSL_CTX_sess_set_cache_size(ctx, conf->session_cache_size);
3098 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
3106 * Free TLS client/server config
3107 * Should not be called outside this code, as a callback is
3108 * added to automatically free the data when the CONF_SECTION
3111 static int _tls_server_conf_free(fr_tls_server_conf_t *conf)
3113 if (conf->ctx) SSL_CTX_free(conf->ctx);
3115 #ifdef HAVE_OPENSSL_OCSP_H
3116 if (conf->ocsp_store) X509_STORE_free(conf->ocsp_store);
3117 conf->ocsp_store = NULL;
3121 memset(conf, 0, sizeof(*conf));
3126 fr_tls_server_conf_t *tls_server_conf_alloc(TALLOC_CTX *ctx)
3128 fr_tls_server_conf_t *conf;
3130 conf = talloc_zero(ctx, fr_tls_server_conf_t);
3132 ERROR(LOG_PREFIX ": Out of memory");
3136 talloc_set_destructor(conf, _tls_server_conf_free);
3141 fr_tls_server_conf_t *tls_server_conf_parse(CONF_SECTION *cs)
3143 fr_tls_server_conf_t *conf;
3146 * If cs has already been parsed there should be a cached copy
3147 * of conf already stored, so just return that.
3149 conf = cf_data_find(cs, "tls-conf");
3151 DEBUG(LOG_PREFIX ": Using cached TLS configuration from previous invocation");
3155 conf = tls_server_conf_alloc(cs);
3157 if (cf_section_parse(cs, conf, tls_server_config) < 0) {
3164 * Save people from their own stupidity.
3166 if (conf->fragment_size < 100) conf->fragment_size = 100;
3169 * Only check for certificate things if we don't have a
3172 if (conf->psk_identity) {
3173 if (conf->private_key_file) {
3174 WARN(LOG_PREFIX ": Ignoring private key file due to psk_identity being used");
3177 if (conf->certificate_file) {
3178 WARN(LOG_PREFIX ": Ignoring certificate file due to psk_identity being used");
3182 if (!conf->private_key_file) {
3183 ERROR(LOG_PREFIX ": TLS Server requires a private key file");
3187 if (!conf->certificate_file) {
3188 ERROR(LOG_PREFIX ": TLS Server requires a certificate file");
3196 conf->ctx = tls_init_ctx(conf, 0);
3197 if (conf->ctx == NULL) {
3201 #ifdef HAVE_OPENSSL_OCSP_H
3203 * Initialize OCSP Revocation Store
3205 if (conf->ocsp_enable) {
3206 conf->ocsp_store = init_revocation_store(conf);
3207 if (conf->ocsp_store == NULL) goto error;
3209 #endif /*HAVE_OPENSSL_OCSP_H*/
3213 memcpy(&dh_file, &conf->dh_file, sizeof(dh_file));
3214 if (load_dh_params(conf->ctx, dh_file) < 0) {
3219 if (conf->verify_tmp_dir) {
3220 if (chmod(conf->verify_tmp_dir, S_IRWXU) < 0) {
3221 ERROR(LOG_PREFIX ": Failed changing permissions on %s: %s",
3222 conf->verify_tmp_dir, fr_syserror(errno));
3227 if (conf->verify_client_cert_cmd && !conf->verify_tmp_dir) {
3228 ERROR(LOG_PREFIX ": You MUST set the verify directory in order to use verify_client_cmd");
3232 #ifdef SSL_OP_NO_TLSv1_2
3234 * OpenSSL 1.0.1f and 1.0.1g get the MS-MPPE keys wrong.
3236 #if (OPENSSL_VERSION_NUMBER >= 0x10010060L) && (OPENSSL_VERSION_NUMBER < 0x10010060L)
3237 conf->disable_tlsv1_2 = true;
3238 WARN(LOG_PREFIX ": Disabling TLSv1.2 due to OpenSSL bugs");
3243 * Cache conf in cs in case we're asked to parse this again.
3245 cf_data_add(cs, "tls-conf", conf, NULL);
3250 fr_tls_server_conf_t *tls_client_conf_parse(CONF_SECTION *cs)
3252 fr_tls_server_conf_t *conf;
3254 conf = cf_data_find(cs, "tls-conf");
3256 DEBUG2(LOG_PREFIX ": Using cached TLS configuration from previous invocation");
3260 conf = tls_server_conf_alloc(cs);
3262 if (cf_section_parse(cs, conf, tls_client_config) < 0) {
3269 * Save people from their own stupidity.
3271 if (conf->fragment_size < 100) conf->fragment_size = 100;
3276 conf->ctx = tls_init_ctx(conf, 1);
3277 if (conf->ctx == NULL) {
3284 memcpy(&dh_file, &conf->dh_file, sizeof(dh_file));
3285 if (load_dh_params(conf->ctx, dh_file) < 0) {
3290 cf_data_add(cs, "tls-conf", conf, NULL);
3296 int tls_success(tls_session_t *ssn, REQUEST *request)
3298 VALUE_PAIR *vp, *vps = NULL;
3299 fr_tls_server_conf_t *conf;
3300 TALLOC_CTX *talloc_ctx;
3302 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF);
3303 rad_assert(conf != NULL);
3305 talloc_ctx = SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_TALLOC);
3308 * If there's no session resumption, delete the entry
3309 * from the cache. This means either it's disabled
3310 * globally for this SSL context, OR we were told to
3311 * disable it for this user.
3313 * This also means you can't turn it on just for one
3316 if ((!ssn->allow_session_resumption) ||
3317 (((vp = fr_pair_find_by_num(request->config, PW_ALLOW_SESSION_RESUMPTION, 0, TAG_ANY)) != NULL) &&
3318 (vp->vp_integer == 0))) {
3319 SSL_CTX_remove_session(ssn->ctx,
3321 ssn->allow_session_resumption = false;
3324 * If we're in a resumed session and it's
3327 if (SSL_session_reused(ssn->ssl)) {
3328 RDEBUG("Forcibly stopping session resumption as it is not allowed");
3333 * Else resumption IS allowed, so we store the
3334 * user data in the cache.
3336 } else if (!SSL_session_reused(ssn->ssl)) {
3338 char buffer[2 * MAX_SESSION_SIZE + 1];
3340 tls_session_id(ssn->ssl_session, buffer, MAX_SESSION_SIZE);
3342 vp = fr_pair_list_copy_by_num(talloc_ctx, request->reply->vps, PW_USER_NAME, 0, TAG_ANY);
3343 if (vp) fr_pair_add(&vps, vp);
3345 vp = fr_pair_list_copy_by_num(talloc_ctx, request->packet->vps, PW_STRIPPED_USER_NAME, 0, TAG_ANY);
3346 if (vp) fr_pair_add(&vps, vp);
3348 vp = fr_pair_list_copy_by_num(talloc_ctx, request->packet->vps, PW_STRIPPED_USER_DOMAIN, 0, TAG_ANY);
3349 if (vp) fr_pair_add(&vps, vp);
3351 vp = fr_pair_list_copy_by_num(talloc_ctx, request->reply->vps, PW_CHARGEABLE_USER_IDENTITY, 0, TAG_ANY);
3352 if (vp) fr_pair_add(&vps, vp);
3354 vp = fr_pair_list_copy_by_num(talloc_ctx, request->reply->vps, PW_CACHED_SESSION_POLICY, 0, TAG_ANY);
3355 if (vp) fr_pair_add(&vps, vp);
3357 certs = (VALUE_PAIR **)SSL_get_ex_data(ssn->ssl, fr_tls_ex_index_certs);
3360 * Hmm... the certs should probably be session data.
3364 * @todo: some go into reply, others into
3367 fr_pair_add(&vps, fr_pair_list_copy(talloc_ctx, *certs));
3370 * Save the certs in the packet, so that we can see them.
3372 fr_pair_add(&request->packet->vps, fr_pair_list_copy(request->packet, *certs));
3374 vp = fr_pair_find_by_num(request->packet->vps, PW_TLS_CLIENT_CERT_EXPIRATION, 0, TAG_ANY);
3378 if (ocsp_asn1time_to_epoch(&expires, vp->vp_strvalue) < 0) {
3379 RDEBUG2("Failed getting certificate expiration, removing cache entry for session %s", buffer);
3380 SSL_CTX_remove_session(ssn->ctx, ssn->ssl_session);
3384 if (expires <= request->timestamp) {
3385 RDEBUG2("Certificate has expired, removing cache entry for session %s", buffer);
3386 SSL_CTX_remove_session(ssn->ctx, ssn->ssl_session);
3391 * Account for Session-Timeout, if it's available.
3393 vp = fr_pair_find_by_num(request->reply->vps, PW_SESSION_TIMEOUT, 0, TAG_ANY);
3395 if ((request->timestamp + vp->vp_integer) > expires) {
3396 vp->vp_integer = expires - request->timestamp;
3397 RWDEBUG2("Updating Session-Timeout to %u, due to impending certificate expiration",
3405 SSL_SESSION_set_ex_data(ssn->ssl_session, fr_tls_ex_index_vps, vps);
3406 rdebug_pair_list(L_DBG_LVL_2, request, vps, " caching ");
3408 if (conf->session_cache_path) {
3409 /* write the VPs to the cache file */
3410 char filename[256], buf[1024];
3413 RDEBUG2("Saving session %s in the disk cache", buffer);
3415 snprintf(filename, sizeof(filename), "%s%c%s.vps", conf->session_cache_path,
3416 FR_DIR_SEP, buffer);
3417 vp_file = fopen(filename, "w");
3418 if (vp_file == NULL) {
3419 RWDEBUG("Could not write session VPs to persistent cache: %s",
3420 fr_syserror(errno));
3422 VALUE_PAIR *prev = NULL;
3424 /* generate a dummy user-style entry which is easy to read back */
3425 fprintf(vp_file, "# SSL cached session\n");
3426 fprintf(vp_file, "%s\n\t", buffer);
3428 for (vp = fr_cursor_init(&cursor, &vps);
3430 vp = fr_cursor_next(&cursor)) {
3432 * Terminate the previous line.
3434 if (prev) fprintf(vp_file, ",\n\t");
3439 vp_prints(buf, sizeof(buf), vp);
3440 fputs(buf, vp_file);
3445 * Terminate the final line.
3447 fprintf(vp_file, "\n");
3451 RDEBUG("Failed to find 'persist_dir' in TLS configuration. Session will not be cached on disk.");
3454 RDEBUG2("No information to cache: session caching will be disabled for session %s", buffer);
3455 SSL_CTX_remove_session(ssn->ctx, ssn->ssl_session);
3459 * Else the session WAS allowed. Copy the cached reply.
3462 char buffer[2 * MAX_SESSION_SIZE + 1];
3464 tls_session_id(ssn->ssl_session, buffer, MAX_SESSION_SIZE);
3467 * The "restore VPs from OpenSSL cache" code is
3468 * now in eaptls_process()
3471 if (conf->session_cache_path) {
3472 /* "touch" the cached session/vp file */
3475 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
3476 conf->session_cache_path, FR_DIR_SEP, buffer);
3477 utime(filename, NULL);
3478 snprintf(filename, sizeof(filename), "%s%c%s.vps",
3479 conf->session_cache_path, FR_DIR_SEP, buffer);
3480 utime(filename, NULL);
3484 * Mark the request as resumed.
3486 pair_make_request("EAP-Session-Resumed", "1", T_OP_SET);
3493 void tls_fail(tls_session_t *ssn)
3496 * Force the session to NOT be cached.
3498 SSL_CTX_remove_session(ssn->ctx, ssn->ssl_session);
3501 fr_tls_status_t tls_application_data(tls_session_t *ssn, REQUEST *request)
3508 * Decrypt the complete record.
3510 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data,
3511 ssn->dirty_in.used);
3512 if (err != (int) ssn->dirty_in.used) {
3513 record_init(&ssn->dirty_in);
3514 RDEBUG("Failed writing %zd bytes to SSL BIO: %d", ssn->dirty_in.used, err);
3519 * Clear the dirty buffer now that we are done with it
3520 * and init the clean_out buffer to store decrypted data
3522 record_init(&ssn->dirty_in);
3523 record_init(&ssn->clean_out);
3526 * Read (and decrypt) the tunneled data from the
3527 * SSL session, and put it into the decrypted
3530 err = SSL_read(ssn->ssl, ssn->clean_out.data, sizeof(ssn->clean_out.data));
3534 RDEBUG("SSL_read Error");
3536 code = SSL_get_error(ssn->ssl, err);
3538 case SSL_ERROR_WANT_READ:
3539 DEBUG("Error in fragmentation logic: SSL_WANT_READ");
3540 return FR_TLS_MORE_FRAGMENTS;
3542 case SSL_ERROR_WANT_WRITE:
3543 DEBUG("Error in fragmentation logic: SSL_WANT_WRITE");
3547 REDEBUG("Error in fragmentation logic");
3548 tls_error_io_log(request, ssn, err,
3549 "Failed in " STRINGIFY(__FUNCTION__) " (SSL_read)");
3555 if (err == 0) RWDEBUG("No data inside of the tunnel");
3558 * Passed all checks, successfully decrypted data
3560 ssn->clean_out.used = err;
3563 * Add the certificates to intermediate packets, so that
3564 * the inner tunnel policies can use them.
3566 certs = (VALUE_PAIR **)SSL_get_ex_data(ssn->ssl, fr_tls_ex_index_certs);
3568 if (certs) fr_pair_add(&request->packet->vps, fr_pair_list_copy(request->packet, *certs));
3575 * Acknowledge received is for one of the following messages sent earlier
3576 * 1. Handshake completed Message, so now send, EAP-Success
3577 * 2. Alert Message, now send, EAP-Failure
3578 * 3. Fragment Message, now send, next Fragment
3580 fr_tls_status_t tls_ack_handler(tls_session_t *ssn, REQUEST *request)
3583 REDEBUG("Unexpected ACK received: No ongoing SSL session");
3584 return FR_TLS_INVALID;
3586 if (!ssn->info.initialized) {
3587 RDEBUG("No SSL info available. Waiting for more SSL data");
3588 return FR_TLS_REQUEST;
3591 if ((ssn->info.content_type == handshake) && (ssn->info.origin == 0)) {
3592 REDEBUG("Unexpected ACK received: We sent no previous messages");
3593 return FR_TLS_INVALID;
3596 switch (ssn->info.content_type) {
3598 RDEBUG2("Peer ACKed our alert");
3602 if ((ssn->info.handshake_type == handshake_finished) && (ssn->dirty_out.used == 0)) {
3603 RDEBUG2("Peer ACKed our handshake fragment. handshake is finished");
3606 * From now on all the content is
3607 * application data set it here as nobody else
3610 ssn->info.content_type = application_data;
3611 return FR_TLS_SUCCESS;
3612 } /* else more data to send */
3614 RDEBUG2("Peer ACKed our handshake fragment");
3615 /* Fragmentation handler, send next fragment */
3616 return FR_TLS_REQUEST;
3618 case application_data:
3619 RDEBUG2("Peer ACKed our application data fragment");
3620 return FR_TLS_REQUEST;
3623 * For the rest of the conditions, switch over
3624 * to the default section below.
3627 REDEBUG("Invalid ACK received: %d", ssn->info.content_type);
3628 return FR_TLS_INVALID;
3631 #endif /* WITH_TLS */