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 (newest first)*/
72 static libssl_defect_t libssl_defects[] =
75 .low = 0x010001000, /* 1.0.1 */
76 .high = 0x01000106f, /* 1.0.1f */
77 .id = "CVE-2014-0160",
79 .comment = "For more information see http://heartbleed.com"
82 .low = 0x01000100f, /* 1.0.1 */
83 .high = 0x01000114f, /* 1.0.1t */
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 = 0x01000200f, /* 1.0.2 */
90 .high = 0x01000208f, /* 1.0.2h */
91 .id = "CVE-2016-6304",
92 .name = "OCSP status request extension",
93 .comment = "For more information see https://www.openssl.org/news/secadv/20160922.txt"
96 .low = 0x01000209f, /* 1.0.2i */
97 .high = 0x01000209f, /* 1.0.2i */
98 .id = "CVE-2016-7052",
99 .name = "OCSP status request extension",
100 .comment = "For more information see https://www.openssl.org/news/secadv/20160926.txt"
103 .low = 0x01010100f, /* 1.1.0 */
104 .high = 0x01010100f, /* 1.1.0 */
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 = 0x01010101f, /* 1.1.0a */
111 .high = 0x01010101f, /* 1.1.0a */
112 .id = "CVE-2016-6309",
113 .name = "OCSP status request extension",
114 .comment = "For more information see https://www.openssl.org/news/secadv/20160926.txt"
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;
509 SSL_CTX_set_mode(ssn->ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_AUTO_RETRY);
511 ssn->ssl = SSL_new(ssn->ctx);
517 request = request_alloc(ssn);
518 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_REQUEST, (void *)request);
521 * Add the message callback to identify what type of
522 * message/handshake is passed
524 SSL_set_msg_callback(ssn->ssl, cbtls_msg);
525 SSL_set_msg_callback_arg(ssn->ssl, ssn);
526 SSL_set_info_callback(ssn->ssl, cbtls_info);
529 * Always verify the peer certificate.
531 DEBUG2("Requiring Server certificate");
532 verify_mode = SSL_VERIFY_PEER;
533 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
534 SSL_set_verify(ssn->ssl, verify_mode, cbtls_verify);
536 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
537 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_SSN, (void *)ssn);
538 SSL_set_fd(ssn->ssl, fd);
539 ret = SSL_connect(ssn->ssl);
541 tls_error_io_log(NULL, ssn, ret, "Failed in " STRINGIFY(__FUNCTION__) " (SSL_connect)");
547 ssn->mtu = conf->fragment_size;
553 /** Create a new TLS session
555 * Configures a new TLS session, configuring options, setting callbacks etc...
557 * @param ctx to alloc session data in. Should usually be NULL unless the lifetime of the
558 * session is tied to another talloc'd object.
559 * @param conf to use to configure the tls session.
560 * @param request The current #REQUEST.
561 * @param client_cert Whether to require a client_cert.
562 * @return a new session on success, or NULL on error.
564 tls_session_t *tls_new_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, REQUEST *request, bool client_cert)
566 tls_session_t *state = NULL;
571 rad_assert(request != NULL);
573 RDEBUG2("Initiating new EAP-TLS session");
576 * Manually flush the sessions every so often. If HALF
577 * of the session lifetime has passed since we last
578 * flushed, then flush it again.
580 * FIXME: Also do it every N sessions?
582 if (conf->session_cache_enable &&
583 ((conf->session_last_flushed + ((int)conf->session_timeout * 1800)) <= request->timestamp)){
584 RDEBUG2("Flushing SSL sessions (of #%ld)", SSL_CTX_sess_number(conf->ctx));
586 SSL_CTX_flush_sessions(conf->ctx, request->timestamp);
587 conf->session_last_flushed = request->timestamp;
590 new_tls = SSL_new(conf->ctx);
591 if (new_tls == NULL) {
592 tls_error_log(request, "Error creating new TLS session");
596 /* We use the SSL's "app_data" to indicate a call-back */
597 SSL_set_app_data(new_tls, NULL);
599 if ((state = talloc_zero(ctx, tls_session_t)) == NULL) {
600 RERROR("Error allocating memory for SSL state");
604 talloc_set_destructor(state, _tls_session_free);
606 state->ctx = conf->ctx;
607 state->ssl = new_tls;
610 * Initialize callbacks
612 state->record_init = record_init;
613 state->record_close = record_close;
614 state->record_plus = record_plus;
615 state->record_minus = record_minus;
618 * Create & hook the BIOs to handle the dirty side of the
619 * SSL. This is *very important* as we want to handle
620 * the transmission part. Now the only IO interface
621 * that SSL is aware of, is our defined BIO buffers.
623 * This means that all SSL IO is done to/from memory,
624 * and we can update those BIOs from the packets we've
627 state->into_ssl = BIO_new(BIO_s_mem());
628 state->from_ssl = BIO_new(BIO_s_mem());
629 SSL_set_bio(state->ssl, state->into_ssl, state->from_ssl);
632 * Add the message callback to identify what type of
633 * message/handshake is passed
635 SSL_set_msg_callback(new_tls, cbtls_msg);
636 SSL_set_msg_callback_arg(new_tls, state);
637 SSL_set_info_callback(new_tls, cbtls_info);
640 * In Server mode we only accept.
642 SSL_set_accept_state(state->ssl);
645 * Verify the peer certificate, if asked.
648 RDEBUG2("Setting verify mode to require certificate from client");
649 verify_mode = SSL_VERIFY_PEER;
650 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
651 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
653 SSL_set_verify(state->ssl, verify_mode, cbtls_verify);
655 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
656 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_SSN, (void *)state);
657 state->length_flag = conf->include_length;
660 * We use default fragment size, unless the Framed-MTU
661 * tells us it's too big. Note that we do NOT account
662 * for the EAP-TLS headers if conf->fragment_size is
663 * large, because that config item looks to be confusing.
665 * i.e. it should REALLY be called MTU, and the code here
666 * should figure out what that means for TLS fragment size.
667 * asking the administrator to know the internal details
668 * of EAP-TLS in order to calculate fragment sizes is
671 state->mtu = conf->fragment_size;
672 vp = fr_pair_find_by_num(request->packet->vps, PW_FRAMED_MTU, 0, TAG_ANY);
673 if (vp && (vp->vp_integer > 100) && (vp->vp_integer < state->mtu)) {
674 state->mtu = vp->vp_integer;
677 if (conf->session_cache_enable) state->allow_session_resumption = true; /* otherwise it's false */
683 * We are the server, we always get the dirty data
684 * (Handshake data is also considered as dirty data)
685 * During handshake, since SSL API handles itself,
686 * After clean-up, dirty_out will be filled with
687 * the data required for handshaking. So we check
688 * if dirty_out is empty then we simply send it back.
689 * As of now, if handshake is successful, then we keep going,
692 * Fill the Bio with the dirty data to clean it
693 * Get the cleaned data from SSL, if it is not Handshake data
695 int tls_handshake_recv(REQUEST *request, tls_session_t *ssn)
699 if (ssn->invalid_hb_used) return 0;
701 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data, ssn->dirty_in.used);
702 if (err != (int) ssn->dirty_in.used) {
703 REDEBUG("Failed writing %zd bytes to SSL BIO: %d", ssn->dirty_in.used, err);
704 record_init(&ssn->dirty_in);
707 record_init(&ssn->dirty_in);
709 err = SSL_read(ssn->ssl, ssn->clean_out.data + ssn->clean_out.used,
710 sizeof(ssn->clean_out.data) - ssn->clean_out.used);
712 ssn->clean_out.used += err;
716 if (!tls_error_io_log(request, ssn, err, "Failed in " STRINGIFY(__FUNCTION__) " (SSL_read)")) return 0;
718 /* Some Extra STATE information for easy debugging */
719 if (SSL_is_init_finished(ssn->ssl)) RDEBUG2("SSL Connection Established");
720 if (SSL_in_init(ssn->ssl)) RDEBUG2("In SSL Handshake Phase");
721 if (SSL_in_before(ssn->ssl)) RDEBUG2("Before SSL Handshake Phase");
722 if (SSL_in_accept_init(ssn->ssl)) RDEBUG2("In SSL Accept mode");
723 if (SSL_in_connect_init(ssn->ssl)) RDEBUG2("In SSL Connect mode");
725 #if OPENSSL_VERSION_NUMBER >= 0x10001000L
727 * Cache the SSL_SESSION pointer.
729 if (!ssn->ssl_session && SSL_is_init_finished(ssn->ssl)) {
730 ssn->ssl_session = SSL_get_session(ssn->ssl);
731 if (!ssn->ssl_session) {
732 RDEBUG("Failed getting SSL session");
738 err = BIO_ctrl_pending(ssn->from_ssl);
740 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
741 sizeof(ssn->dirty_out.data));
743 ssn->dirty_out.used = err;
745 } else if (BIO_should_retry(ssn->from_ssl)) {
746 record_init(&ssn->dirty_in);
747 RDEBUG2("Asking for more data in tunnel");
751 tls_error_log(NULL, NULL);
752 record_init(&ssn->dirty_in);
756 RDEBUG2("SSL Application Data");
757 /* Its clean application data, do whatever we want */
758 record_init(&ssn->clean_out);
761 /* We are done with dirty_in, reinitialize it */
762 record_init(&ssn->dirty_in);
767 * Take cleartext user data, and encrypt it into the output buffer,
768 * to send to the client at the other end of the SSL connection.
770 int tls_handshake_send(REQUEST *request, tls_session_t *ssn)
775 * If there's un-encrypted data in 'clean_in', then write
776 * that data to the SSL session, and then call the BIO function
777 * to get that encrypted data from the SSL session, into
778 * a buffer which we can then package into an EAP packet.
780 * Based on Server's logic this clean_in is expected to
781 * contain the data to send to the client.
783 if (ssn->clean_in.used > 0) {
786 written = SSL_write(ssn->ssl, ssn->clean_in.data, ssn->clean_in.used);
787 record_minus(&ssn->clean_in, NULL, written);
789 /* Get the dirty data from Bio to send it */
790 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
791 sizeof(ssn->dirty_out.data));
793 ssn->dirty_out.used = err;
795 if (!tls_error_io_log(request, ssn, err,
796 "Failed in " STRINGIFY(__FUNCTION__) " (SSL_write)")) {
805 static void session_init(tls_session_t *ssn)
808 ssn->into_ssl = ssn->from_ssl = NULL;
809 record_init(&ssn->clean_in);
810 record_init(&ssn->clean_out);
811 record_init(&ssn->dirty_in);
812 record_init(&ssn->dirty_out);
814 memset(&ssn->info, 0, sizeof(ssn->info));
817 ssn->fragment = false;
818 ssn->tls_msg_len = 0;
819 ssn->length_flag = false;
821 ssn->free_opaque = NULL;
824 static void session_close(tls_session_t *ssn)
826 SSL_set_quiet_shutdown(ssn->ssl, 1);
827 SSL_shutdown(ssn->ssl);
834 record_close(&ssn->clean_in);
835 record_close(&ssn->clean_out);
836 record_close(&ssn->dirty_in);
837 record_close(&ssn->dirty_out);
841 static void record_init(record_t *rec)
846 static void record_close(record_t *rec)
853 * Copy data to the intermediate buffer, before we send
856 static unsigned int record_plus(record_t *rec, void const *ptr,
859 unsigned int added = MAX_RECORD_SIZE - rec->used;
865 memcpy(rec->data + rec->used, ptr, added);
871 * Take data from the buffer, and give it to the caller.
873 static unsigned int record_minus(record_t *rec, void *ptr,
876 unsigned int taken = rec->used;
883 memcpy(ptr, rec->data, taken);
887 * This is pretty bad...
889 if (rec->used > 0) memmove(rec->data, rec->data + taken, rec->used);
894 void tls_session_information(tls_session_t *tls_session)
896 char const *str_write_p, *str_version, *str_content_type = "";
897 char const *str_details1 = "", *str_details2= "";
902 * Don't print this out in the normal course of
905 if (rad_debug_lvl == 0) return;
907 str_write_p = tls_session->info.origin ? ">>> send" : "<<< recv";
909 switch (tls_session->info.version) {
911 str_version = "SSL 2.0 ";
914 str_version = "SSL 3.0 ";
917 str_version = "TLS 1.0 ";
919 #ifdef TLS1_1_VERSION
921 str_version = "TLS 1.1 ";
924 #ifdef TLS1_2_VERSION
926 str_version = "TLS 1.2 ";
931 str_version = "TLS 1.3 ";
936 sprintf(buffer, "UNKNOWN TLS VERSION ?%04X?", tls_session->info.version);
937 str_version = buffer;
941 if (tls_session->info.version == SSL3_VERSION ||
942 tls_session->info.version == TLS1_VERSION) {
943 switch (tls_session->info.content_type) {
944 case SSL3_RT_CHANGE_CIPHER_SPEC:
945 str_content_type = "ChangeCipherSpec";
949 str_content_type = "Alert";
952 case SSL3_RT_HANDSHAKE:
953 str_content_type = "Handshake";
956 case SSL3_RT_APPLICATION_DATA:
957 str_content_type = "ApplicationData";
961 str_content_type = "UnknownContentType";
965 if (tls_session->info.content_type == SSL3_RT_ALERT) {
966 str_details1 = ", ???";
968 if (tls_session->info.record_len == 2) {
970 switch (tls_session->info.alert_level) {
971 case SSL3_AL_WARNING:
972 str_details1 = ", warning";
975 str_details1 = ", fatal";
979 str_details2 = " ???";
980 switch (tls_session->info.alert_description) {
981 case SSL3_AD_CLOSE_NOTIFY:
982 str_details2 = " close_notify";
985 case SSL3_AD_UNEXPECTED_MESSAGE:
986 str_details2 = " unexpected_message";
989 case SSL3_AD_BAD_RECORD_MAC:
990 str_details2 = " bad_record_mac";
993 case TLS1_AD_DECRYPTION_FAILED:
994 str_details2 = " decryption_failed";
997 case TLS1_AD_RECORD_OVERFLOW:
998 str_details2 = " record_overflow";
1001 case SSL3_AD_DECOMPRESSION_FAILURE:
1002 str_details2 = " decompression_failure";
1005 case SSL3_AD_HANDSHAKE_FAILURE:
1006 str_details2 = " handshake_failure";
1009 case SSL3_AD_BAD_CERTIFICATE:
1010 str_details2 = " bad_certificate";
1013 case SSL3_AD_UNSUPPORTED_CERTIFICATE:
1014 str_details2 = " unsupported_certificate";
1017 case SSL3_AD_CERTIFICATE_REVOKED:
1018 str_details2 = " certificate_revoked";
1021 case SSL3_AD_CERTIFICATE_EXPIRED:
1022 str_details2 = " certificate_expired";
1025 case SSL3_AD_CERTIFICATE_UNKNOWN:
1026 str_details2 = " certificate_unknown";
1029 case SSL3_AD_ILLEGAL_PARAMETER:
1030 str_details2 = " illegal_parameter";
1033 case TLS1_AD_UNKNOWN_CA:
1034 str_details2 = " unknown_ca";
1037 case TLS1_AD_ACCESS_DENIED:
1038 str_details2 = " access_denied";
1041 case TLS1_AD_DECODE_ERROR:
1042 str_details2 = " decode_error";
1045 case TLS1_AD_DECRYPT_ERROR:
1046 str_details2 = " decrypt_error";
1049 case TLS1_AD_EXPORT_RESTRICTION:
1050 str_details2 = " export_restriction";
1053 case TLS1_AD_PROTOCOL_VERSION:
1054 str_details2 = " protocol_version";
1057 case TLS1_AD_INSUFFICIENT_SECURITY:
1058 str_details2 = " insufficient_security";
1061 case TLS1_AD_INTERNAL_ERROR:
1062 str_details2 = " internal_error";
1065 case TLS1_AD_USER_CANCELLED:
1066 str_details2 = " user_canceled";
1069 case TLS1_AD_NO_RENEGOTIATION:
1070 str_details2 = " no_renegotiation";
1076 if (tls_session->info.content_type == SSL3_RT_HANDSHAKE) {
1077 str_details1 = "???";
1079 if (tls_session->info.record_len > 0) switch (tls_session->info.handshake_type) {
1080 case SSL3_MT_HELLO_REQUEST:
1081 str_details1 = ", HelloRequest";
1084 case SSL3_MT_CLIENT_HELLO:
1085 str_details1 = ", ClientHello";
1088 case SSL3_MT_SERVER_HELLO:
1089 str_details1 = ", ServerHello";
1092 case SSL3_MT_CERTIFICATE:
1093 str_details1 = ", Certificate";
1096 case SSL3_MT_SERVER_KEY_EXCHANGE:
1097 str_details1 = ", ServerKeyExchange";
1100 case SSL3_MT_CERTIFICATE_REQUEST:
1101 str_details1 = ", CertificateRequest";
1104 case SSL3_MT_SERVER_DONE:
1105 str_details1 = ", ServerHelloDone";
1108 case SSL3_MT_CERTIFICATE_VERIFY:
1109 str_details1 = ", CertificateVerify";
1112 case SSL3_MT_CLIENT_KEY_EXCHANGE:
1113 str_details1 = ", ClientKeyExchange";
1116 case SSL3_MT_FINISHED:
1117 str_details1 = ", Finished";
1123 snprintf(tls_session->info.info_description,
1124 sizeof(tls_session->info.info_description),
1125 "%s %s%s [length %04lx]%s%s\n",
1126 str_write_p, str_version, str_content_type,
1127 (unsigned long)tls_session->info.record_len,
1128 str_details1, str_details2);
1130 request = SSL_get_ex_data(tls_session->ssl, FR_TLS_EX_INDEX_REQUEST);
1131 ROPTIONAL(RDEBUG2, DEBUG2, "%s", tls_session->info.info_description);
1134 static CONF_PARSER cache_config[] = {
1135 { "enable", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, session_cache_enable), "no" },
1137 { "lifetime", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, session_timeout), "24" },
1138 { "name", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, session_id_name), NULL },
1140 { "max_entries", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, session_cache_size), "255" },
1141 { "persist_dir", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, session_cache_path), NULL },
1142 CONF_PARSER_TERMINATOR
1145 static CONF_PARSER verify_config[] = {
1146 { "skip_if_ocsp_ok", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, verify_skip_if_ocsp_ok), "no" },
1147 { "tmpdir", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, verify_tmp_dir), NULL },
1148 { "client", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, verify_client_cert_cmd), NULL },
1149 CONF_PARSER_TERMINATOR
1152 #ifdef HAVE_OPENSSL_OCSP_H
1153 static CONF_PARSER ocsp_config[] = {
1154 { "enable", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_enable), "no" },
1155 { "override_cert_url", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_override_url), "no" },
1156 { "url", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ocsp_url), NULL },
1157 { "use_nonce", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_use_nonce), "yes" },
1158 { "timeout", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, ocsp_timeout), "yes" },
1159 { "softfail", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_softfail), "no" },
1160 CONF_PARSER_TERMINATOR
1164 static CONF_PARSER tls_server_config[] = {
1165 { "verify_depth", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, verify_depth), "0" },
1166 { "CA_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED, fr_tls_server_conf_t, ca_path), NULL },
1167 { "ca_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_path), NULL },
1168 { "pem_file_type", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, file_type), "yes" },
1169 { "private_key_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, private_key_file), NULL },
1170 { "certificate_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, certificate_file), NULL },
1171 { "CA_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED, fr_tls_server_conf_t, ca_file), NULL },
1172 { "ca_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_file), NULL },
1173 { "private_key_password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, private_key_password), NULL },
1174 #ifdef PSK_MAX_IDENTITY_LEN
1175 { "psk_identity", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, psk_identity), NULL },
1176 { "psk_hexphrase", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, psk_password), NULL },
1177 { "psk_query", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, psk_query), NULL },
1179 { "dh_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, dh_file), NULL },
1180 { "random_file", FR_CONF_OFFSET(PW_TYPE_FILE_EXISTS, fr_tls_server_conf_t, random_file), NULL },
1181 { "fragment_size", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, fragment_size), "1024" },
1182 { "include_length", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, include_length), "yes" },
1183 { "auto_chain", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, auto_chain), "yes" },
1184 { "disable_single_dh_use", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_single_dh_use), NULL },
1185 { "check_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, check_crl), "no" },
1186 #ifdef X509_V_FLAG_CRL_CHECK_ALL
1187 { "check_all_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, check_all_crl), "no" },
1189 { "allow_expired_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, allow_expired_crl), NULL },
1190 { "check_cert_cn", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_cn), NULL },
1191 { "cipher_list", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, cipher_list), NULL },
1192 { "check_cert_issuer", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_issuer), NULL },
1193 { "require_client_cert", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, require_client_cert), NULL },
1195 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
1196 #ifndef OPENSSL_NO_ECDH
1197 { "ecdh_curve", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ecdh_curve), "prime256v1" },
1201 #ifdef SSL_OP_NO_TLSv1
1202 { "disable_tlsv1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1), NULL },
1205 #ifdef SSL_OP_NO_TLSv1_1
1206 { "disable_tlsv1_1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_1), NULL },
1209 #ifdef SSL_OP_NO_TLSv1_2
1210 { "disable_tlsv1_2", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_2), NULL },
1213 { "cache", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) cache_config },
1215 { "verify", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) verify_config },
1217 #ifdef HAVE_OPENSSL_OCSP_H
1218 { "ocsp", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) ocsp_config },
1220 CONF_PARSER_TERMINATOR
1224 static CONF_PARSER tls_client_config[] = {
1225 { "verify_depth", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, verify_depth), "0" },
1226 { "ca_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_path), NULL },
1227 { "pem_file_type", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, file_type), "yes" },
1228 { "private_key_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, private_key_file), NULL },
1229 { "certificate_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, certificate_file), NULL },
1230 { "ca_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_file), NULL },
1231 { "private_key_password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, private_key_password), NULL },
1232 { "dh_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, dh_file), NULL },
1233 { "random_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, random_file), NULL },
1234 { "fragment_size", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, fragment_size), "1024" },
1235 { "include_length", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, include_length), "yes" },
1236 { "check_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, check_crl), "no" },
1237 { "check_cert_cn", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_cn), NULL },
1238 { "cipher_list", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, cipher_list), NULL },
1239 { "check_cert_issuer", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_issuer), NULL },
1241 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
1242 #ifndef OPENSSL_NO_ECDH
1243 { "ecdh_curve", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ecdh_curve), "prime256v1" },
1247 #ifdef SSL_OP_NO_TLSv1
1248 { "disable_tlsv1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1), NULL },
1251 #ifdef SSL_OP_NO_TLSv1_1
1252 { "disable_tlsv1_1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_1), NULL },
1255 #ifdef SSL_OP_NO_TLSv1_2
1256 { "disable_tlsv1_2", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_2), NULL },
1258 CONF_PARSER_TERMINATOR
1263 * TODO: Check for the type of key exchange * like conf->dh_key
1265 static int load_dh_params(SSL_CTX *ctx, char *file)
1270 if (!file) return 0;
1272 if ((bio = BIO_new_file(file, "r")) == NULL) {
1273 ERROR(LOG_PREFIX ": Unable to open DH file - %s", file);
1277 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
1280 WARN(LOG_PREFIX ": Unable to set DH parameters. DH cipher suites may not work!");
1281 WARN(LOG_PREFIX ": Fix this by running the OpenSSL command listed in eap.conf");
1285 if (SSL_CTX_set_tmp_dh(ctx, dh) < 0) {
1286 ERROR(LOG_PREFIX ": Unable to set DH parameters");
1297 * Print debugging messages, and free data.
1299 static void cbtls_remove_session(SSL_CTX *ctx, SSL_SESSION *sess)
1301 char buffer[2 * MAX_SESSION_SIZE + 1];
1302 fr_tls_server_conf_t *conf;
1304 tls_session_id(sess, buffer, MAX_SESSION_SIZE);
1306 conf = (fr_tls_server_conf_t *)SSL_CTX_get_app_data(ctx);
1308 DEBUG(LOG_PREFIX ": Failed to find TLS configuration in session");
1316 DEBUG2(LOG_PREFIX ": Removing session %s from the cache", buffer);
1318 /* remove session and any cached VPs */
1319 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1320 conf->session_cache_path, FR_DIR_SEP, buffer);
1321 rv = unlink(filename);
1323 DEBUG2(LOG_PREFIX ": Could not remove persisted session file %s: %s",
1324 filename, fr_syserror(errno));
1326 /* VPs might be absent; might not have been written to disk yet */
1327 snprintf(filename, sizeof(filename), "%s%c%s.vps",
1328 conf->session_cache_path, FR_DIR_SEP, buffer);
1335 static int cbtls_new_session(SSL *ssl, SSL_SESSION *sess)
1337 char buffer[2 * MAX_SESSION_SIZE + 1];
1338 fr_tls_server_conf_t *conf;
1339 unsigned char *sess_blob = NULL;
1341 REQUEST *request = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_REQUEST);
1343 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1345 RWDEBUG("Failed to find TLS configuration in session");
1349 tls_session_id(sess, buffer, MAX_SESSION_SIZE);
1352 int fd, rv, todo, blob_len;
1356 RDEBUG2("Serialising session %s, and storing in cache", buffer);
1358 /* find out what length data we need */
1359 blob_len = i2d_SSL_SESSION(sess, NULL);
1361 /* something went wrong */
1362 RWDEBUG("Session serialisation failed, couldn't determine required buffer length");
1367 /* Do not convert to TALLOC - Thread safety */
1368 /* alloc and convert to ASN.1 */
1369 sess_blob = malloc(blob_len);
1371 RWDEBUG("Session serialisation failed, couldn't allocate buffer (%d bytes)", blob_len);
1374 /* openssl mutates &p */
1376 rv = i2d_SSL_SESSION(sess, &p);
1377 if (rv != blob_len) {
1378 RWDEBUG("Session serialisation failed");
1382 /* open output file */
1383 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1384 conf->session_cache_path, FR_DIR_SEP, buffer);
1385 fd = open(filename, O_RDWR|O_CREAT|O_EXCL, 0600);
1387 RERROR("Session serialisation failed, failed opening session file %s: %s",
1388 filename, fr_syserror(errno));
1395 rv = write(fd, p, todo);
1397 RWDEBUG("Failed writing session: %s", fr_syserror(errno));
1405 RWDEBUG("Wrote session %s to %s (%d bytes)", buffer, filename, blob_len);
1414 static SSL_SESSION *cbtls_get_session(SSL *ssl, unsigned char *data, int len, int *copy)
1417 char buffer[2 * MAX_SESSION_SIZE + 1];
1418 fr_tls_server_conf_t *conf;
1419 TALLOC_CTX *talloc_ctx;
1421 SSL_SESSION *sess = NULL;
1422 unsigned char *sess_data = NULL;
1423 PAIR_LIST *pairlist = NULL;
1425 REQUEST *request = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_REQUEST);
1427 rad_assert(request != NULL);
1430 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1432 fr_bin2hex(buffer, data, size);
1434 RDEBUG2("Peer requested cached session: %s", buffer);
1438 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1440 RWDEBUG("Failed to find TLS configuration in session");
1444 talloc_ctx = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_TALLOC);
1450 unsigned char const **o;
1455 VALUE_PAIR *vps = NULL;
1457 /* read in the cached VPs from the .vps file */
1458 snprintf(filename, sizeof(filename), "%s%c%s.vps",
1459 conf->session_cache_path, FR_DIR_SEP, buffer);
1460 rv = pairlist_read(talloc_ctx, filename, &pairlist, 1);
1462 /* not safe to un-persist a session w/o VPs */
1463 RWDEBUG("Failed loading persisted VPs for session %s", buffer);
1467 /* load the actual SSL session */
1468 snprintf(filename, sizeof(filename), "%s%c%s.asn1", conf->session_cache_path, FR_DIR_SEP, buffer);
1469 fd = open(filename, O_RDONLY);
1471 RWDEBUG("No persisted session file %s: %s", filename, fr_syserror(errno));
1475 rv = fstat(fd, &st);
1477 RWDEBUG("Failed stating persisted session file %s: %s", filename, fr_syserror(errno));
1482 sess_data = talloc_array(NULL, unsigned char, st.st_size);
1484 RWDEBUG("Failed allocating buffer for persisted session (%d bytes)", (int) st.st_size);
1492 rv = read(fd, q, todo);
1494 RWDEBUG("Failed reading persisted session: %s", fr_syserror(errno));
1504 * OpenSSL mutates what's passed in, so we assign sess_data to q,
1505 * so the value of q gets mutated, and not the value of sess_data.
1507 * We then need a pointer to hold &q, but it can't be const, because
1508 * clang complains about lack of consting in nested pointer types.
1510 * So we memcpy the value of that pointer, to one that
1511 * does have a const, which we then pass into d2i_SSL_SESSION *sigh*.
1515 memcpy(&o, &p, sizeof(o));
1516 sess = d2i_SSL_SESSION(NULL, o, st.st_size);
1518 RWDEBUG("Failed loading persisted session: %s", ERR_error_string(ERR_get_error(), NULL));
1522 /* move the cached VPs into the session */
1523 fr_pair_list_mcopy_by_num(talloc_ctx, &vps, &pairlist->reply, 0, 0, TAG_ANY);
1525 SSL_SESSION_set_ex_data(sess, fr_tls_ex_index_vps, vps);
1526 RWDEBUG("Successfully restored session %s", buffer);
1527 rdebug_pair_list(L_DBG_LVL_2, request, vps, "reply:");
1530 if (sess_data) talloc_free(sess_data);
1531 if (pairlist) pairlist_free(&pairlist);
1536 #ifdef HAVE_OPENSSL_OCSP_H
1538 /** Extract components of OCSP responser URL from a certificate
1540 * @param[in] cert to extract URL from.
1541 * @param[out] host_out Portion of the URL (must be freed with free()).
1542 * @param[out] port_out Port portion of the URL (must be freed with free()).
1543 * @param[out] path_out Path portion of the URL (must be freed with free()).
1544 * @param[out] is_https Whether the responder should be contacted using https.
1546 * - 0 if no valid URL is contained in the certificate.
1547 * - 1 if a URL was found and parsed.
1548 * - -1 if at least one URL was found, but none could be parsed.
1550 static int ocsp_parse_cert_url(X509 *cert, char **host_out, char **port_out,
1551 char **path_out, int *is_https)
1554 bool found_uri = false;
1556 AUTHORITY_INFO_ACCESS *aia;
1557 ACCESS_DESCRIPTION *ad;
1559 aia = X509_get_ext_d2i(cert, NID_info_access, NULL, NULL);
1561 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(aia); i++) {
1562 ad = sk_ACCESS_DESCRIPTION_value(aia, i);
1563 if (OBJ_obj2nid(ad->method) != NID_ad_OCSP) continue;
1564 if (ad->location->type != GEN_URI) continue;
1567 if (OCSP_parse_url((char *) ad->location->d.ia5->data, host_out,
1568 port_out, path_out, is_https)) return 1;
1570 return found_uri ? -1 : 0;
1574 * This function sends a OCSP request to a defined OCSP responder
1575 * and checks the OCSP response for correctness.
1578 /* Maximum leeway in validity period: default 5 minutes */
1579 #define MAX_VALIDITY_PERIOD (5 * 60)
1582 OCSP_STATUS_FAILED = 0,
1584 OCSP_STATUS_SKIPPED = 2,
1587 static ocsp_status_t ocsp_check(REQUEST *request, X509_STORE *store, X509 *issuer_cert, X509 *client_cert,
1588 fr_tls_server_conf_t *conf)
1590 OCSP_CERTID *certid;
1592 OCSP_RESPONSE *resp = NULL;
1593 OCSP_BASICRESP *bresp = NULL;
1597 char hostheader[1024];
1599 long nsec = MAX_VALIDITY_PERIOD, maxage = -1;
1600 BIO *cbio, *bio_out;
1601 ocsp_status_t ocsp_status = OCSP_STATUS_FAILED;
1603 ASN1_GENERALIZEDTIME *rev, *thisupd, *nextupd;
1605 #if OPENSSL_VERSION_NUMBER >= 0x1000003f
1609 struct timeval when;
1614 * Create OCSP Request
1616 certid = OCSP_cert_to_id(NULL, client_cert, issuer_cert);
1617 req = OCSP_REQUEST_new();
1618 OCSP_request_add0_id(req, certid);
1619 if (conf->ocsp_use_nonce) OCSP_request_add1_nonce(req, NULL, 8);
1622 * Send OCSP Request and get OCSP Response
1625 /* Get OCSP responder URL */
1626 if (conf->ocsp_override_url) {
1630 memcpy(&url, &conf->ocsp_url, sizeof(url));
1631 /* Reading the libssl src, they do a strdup on the URL, so it could of been const *sigh* */
1632 OCSP_parse_url(url, &host, &port, &path, &use_ssl);
1633 if (!host || !port || !path) {
1634 RWDEBUG("ocsp: Host or port or path missing from configured URL \"%s\". Not doing OCSP", url);
1640 ret = ocsp_parse_cert_url(client_cert, &host, &port, &path, &use_ssl);
1643 RWDEBUG("ocsp: Invalid URL in certificate. Not doing OCSP");
1647 if (conf->ocsp_url) {
1648 RWDEBUG("ocsp: No OCSP URL in certificate, falling back to configured URL");
1651 RWDEBUG("ocsp: No OCSP URL in certificate. Not doing OCSP");
1659 RDEBUG2("ocsp: Using responder URL \"http://%s:%s%s\"", host, port, path);
1661 /* Check host and port length are sane, then create Host: HTTP header */
1662 if ((strlen(host) + strlen(port) + 2) > sizeof(hostheader)) {
1663 RWDEBUG("ocsp: Host and port too long");
1666 snprintf(hostheader, sizeof(hostheader), "%s:%s", host, port);
1668 /* Setup BIO socket to OCSP responder */
1669 cbio = BIO_new_connect(host);
1672 if (rad_debug_lvl) {
1673 if (default_log.dst == L_DST_STDOUT) {
1674 bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
1675 } else if (default_log.dst == L_DST_STDERR) {
1676 bio_out = BIO_new_fp(stderr, BIO_NOCLOSE);
1680 BIO_set_conn_port(cbio, port);
1681 #if OPENSSL_VERSION_NUMBER < 0x1000003f
1682 BIO_do_connect(cbio);
1684 /* Send OCSP request and wait for response */
1685 resp = OCSP_sendreq_bio(cbio, path, req);
1687 REDEBUG("ocsp: Couldn't get OCSP response");
1688 ocsp_status = OCSP_STATUS_SKIPPED;
1692 if (conf->ocsp_timeout)
1693 BIO_set_nbio(cbio, 1);
1695 rc = BIO_do_connect(cbio);
1696 if ((rc <= 0) && ((!conf->ocsp_timeout) || !BIO_should_retry(cbio))) {
1697 REDEBUG("ocsp: Couldn't connect to OCSP responder");
1698 ocsp_status = OCSP_STATUS_SKIPPED;
1702 ctx = OCSP_sendreq_new(cbio, path, NULL, -1);
1704 REDEBUG("ocsp: Couldn't create OCSP request");
1705 ocsp_status = OCSP_STATUS_SKIPPED;
1709 if (!OCSP_REQ_CTX_add1_header(ctx, "Host", hostheader)) {
1710 REDEBUG("ocsp: Couldn't set Host header");
1711 ocsp_status = OCSP_STATUS_SKIPPED;
1715 if (!OCSP_REQ_CTX_set1_req(ctx, req)) {
1716 REDEBUG("ocsp: Couldn't add data to OCSP request");
1717 ocsp_status = OCSP_STATUS_SKIPPED;
1721 gettimeofday(&when, NULL);
1722 when.tv_sec += conf->ocsp_timeout;
1725 rc = OCSP_sendreq_nbio(&resp, ctx);
1726 if (conf->ocsp_timeout) {
1727 gettimeofday(&now, NULL);
1728 if (!timercmp(&now, &when, <))
1731 } while ((rc == -1) && BIO_should_retry(cbio));
1733 if (conf->ocsp_timeout && (rc == -1) && BIO_should_retry(cbio)) {
1734 REDEBUG("ocsp: Response timed out");
1735 ocsp_status = OCSP_STATUS_SKIPPED;
1739 OCSP_REQ_CTX_free(ctx);
1742 REDEBUG("ocsp: Couldn't get OCSP response");
1743 ocsp_status = OCSP_STATUS_SKIPPED;
1748 /* Verify OCSP response status */
1749 status = OCSP_response_status(resp);
1750 if (status != OCSP_RESPONSE_STATUS_SUCCESSFUL) {
1751 REDEBUG("ocsp: Response status: %s", OCSP_response_status_str(status));
1754 bresp = OCSP_response_get1_basic(resp);
1755 if (conf->ocsp_use_nonce && OCSP_check_nonce(req, bresp)!=1) {
1756 REDEBUG("ocsp: Response has wrong nonce value");
1759 if (OCSP_basic_verify(bresp, NULL, store, 0)!=1){
1760 REDEBUG("ocsp: Couldn't verify OCSP basic response");
1764 /* Verify OCSP cert status */
1765 if (!OCSP_resp_find_status(bresp, certid, &status, &reason, &rev, &thisupd, &nextupd)) {
1766 REDEBUG("ocsp: No Status found");
1770 if (!OCSP_check_validity(thisupd, nextupd, nsec, maxage)) {
1772 BIO_puts(bio_out, "WARNING: Status times invalid.\n");
1773 ERR_print_errors(bio_out);
1779 BIO_puts(bio_out, "\tThis Update: ");
1780 ASN1_GENERALIZEDTIME_print(bio_out, thisupd);
1781 BIO_puts(bio_out, "\n");
1783 BIO_puts(bio_out, "\tNext Update: ");
1784 ASN1_GENERALIZEDTIME_print(bio_out, nextupd);
1785 BIO_puts(bio_out, "\n");
1790 case V_OCSP_CERTSTATUS_GOOD:
1791 RDEBUG2("ocsp: Cert status: good");
1792 vp = pair_make_request("TLS-OCSP-Cert-Valid", NULL, T_OP_SET);
1793 vp->vp_integer = 1; /* yes */
1794 ocsp_status = OCSP_STATUS_OK;
1798 /* REVOKED / UNKNOWN */
1799 REDEBUG("ocsp: Cert status: %s", OCSP_cert_status_str(status));
1800 if (reason != -1) REDEBUG("ocsp: Reason: %s", OCSP_crl_reason_str(reason));
1803 BIO_puts(bio_out, "\tRevocation Time: ");
1804 ASN1_GENERALIZEDTIME_print(bio_out, rev);
1805 BIO_puts(bio_out, "\n");
1811 /* Free OCSP Stuff */
1812 OCSP_REQUEST_free(req);
1813 OCSP_RESPONSE_free(resp);
1818 if (bio_out) BIO_free(bio_out);
1819 OCSP_BASICRESP_free(bresp);
1821 switch (ocsp_status) {
1822 case OCSP_STATUS_OK:
1823 RDEBUG2("ocsp: Certificate is valid");
1826 case OCSP_STATUS_SKIPPED:
1828 vp = pair_make_request("TLS-OCSP-Cert-Valid", NULL, T_OP_SET);
1829 vp->vp_integer = 2; /* skipped */
1830 if (conf->ocsp_softfail) {
1831 RWDEBUG("ocsp: Unable to check certificate, assuming it's valid");
1832 RWDEBUG("ocsp: This may be insecure");
1834 /* Remove OpenSSL errors from queue or handshake will fail */
1835 while (ERR_get_error());
1837 ocsp_status = OCSP_STATUS_SKIPPED;
1839 REDEBUG("ocsp: Unable to check certificate, failing");
1840 ocsp_status = OCSP_STATUS_FAILED;
1845 vp = pair_make_request("TLS-OCSP-Cert-Valid", NULL, T_OP_SET);
1846 vp->vp_integer = 0; /* no */
1847 REDEBUG("ocsp: Certificate has been expired/revoked");
1853 #endif /* HAVE_OPENSSL_OCSP_H */
1856 * For creating certificate attributes.
1858 static char const *cert_attr_names[8][2] = {
1859 { "TLS-Client-Cert-Serial", "TLS-Cert-Serial" },
1860 { "TLS-Client-Cert-Expiration", "TLS-Cert-Expiration" },
1861 { "TLS-Client-Cert-Subject", "TLS-Cert-Subject" },
1862 { "TLS-Client-Cert-Issuer", "TLS-Cert-Issuer" },
1863 { "TLS-Client-Cert-Common-Name", "TLS-Cert-Common-Name" },
1864 { "TLS-Client-Cert-Subject-Alt-Name-Email", "TLS-Cert-Subject-Alt-Name-Email" },
1865 { "TLS-Client-Cert-Subject-Alt-Name-Dns", "TLS-Cert-Subject-Alt-Name-Dns" },
1866 { "TLS-Client-Cert-Subject-Alt-Name-Upn", "TLS-Cert-Subject-Alt-Name-Upn" }
1869 #define FR_TLS_SERIAL (0)
1870 #define FR_TLS_EXPIRATION (1)
1871 #define FR_TLS_SUBJECT (2)
1872 #define FR_TLS_ISSUER (3)
1873 #define FR_TLS_CN (4)
1874 #define FR_TLS_SAN_EMAIL (5)
1875 #define FR_TLS_SAN_DNS (6)
1876 #define FR_TLS_SAN_UPN (7)
1879 * Before trusting a certificate, you must make sure that the
1880 * certificate is 'valid'. There are several steps that your
1881 * application can take in determining if a certificate is
1882 * valid. Commonly used steps are:
1884 * 1.Verifying the certificate's signature, and verifying that
1885 * the certificate has been issued by a trusted Certificate
1888 * 2.Verifying that the certificate is valid for the present date
1889 * (i.e. it is being presented within its validity dates).
1891 * 3.Verifying that the certificate has not been revoked by its
1892 * issuing Certificate Authority, by checking with respect to a
1893 * Certificate Revocation List (CRL).
1895 * 4.Verifying that the credentials presented by the certificate
1896 * fulfill additional requirements specific to the application,
1897 * such as with respect to access control lists or with respect
1898 * to OCSP (Online Certificate Status Processing).
1900 * NOTE: This callback will be called multiple times based on the
1901 * depth of the root certificate chain
1903 int cbtls_verify(int ok, X509_STORE_CTX *ctx)
1905 char subject[1024]; /* Used for the subject name */
1906 char issuer[1024]; /* Used for the issuer name */
1907 char attribute[1024];
1909 char common_name[1024];
1913 X509_CINF *client_inf;
1914 STACK_OF(X509_EXTENSION) *ext_list;
1916 int err, depth, lookup, loc;
1917 fr_tls_server_conf_t *conf;
1920 ASN1_INTEGER *sn = NULL;
1921 ASN1_TIME *asn_time = NULL;
1924 #ifdef HAVE_OPENSSL_OCSP_H
1925 X509_STORE *ocsp_store = NULL;
1927 bool do_verify = false;
1930 TALLOC_CTX *talloc_ctx;
1934 client_cert = X509_STORE_CTX_get_current_cert(ctx);
1935 err = X509_STORE_CTX_get_error(ctx);
1936 depth = X509_STORE_CTX_get_error_depth(ctx);
1941 * Log client/issuing cert. If there's an error, log
1944 if ((lookup > 1) && !my_ok) lookup = 1;
1947 * Retrieve the pointer to the SSL of the connection currently treated
1948 * and the application specific data stored into the SSL object.
1950 ssl = X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
1951 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1952 if (!conf) return 1;
1954 request = (REQUEST *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_REQUEST);
1955 rad_assert(request != NULL);
1956 certs = (VALUE_PAIR **)SSL_get_ex_data(ssl, fr_tls_ex_index_certs);
1958 identity = (char **)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_IDENTITY);
1959 #ifdef HAVE_OPENSSL_OCSP_H
1960 ocsp_store = conf->ocsp_store;
1963 talloc_ctx = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_TALLOC);
1966 * Get the Serial Number
1969 sn = X509_get_serialNumber(client_cert);
1971 RDEBUG2("Creating attributes from certificate OIDs");
1975 * For this next bit, we create the attributes *only* if
1976 * we're at the client or issuing certificate, AND we
1977 * have a user identity. i.e. we don't create the
1978 * attributes for RadSec connections.
1980 if (certs && identity &&
1981 (lookup <= 1) && sn && ((size_t) sn->length < (sizeof(buf) / 2))) {
1985 for (i = 0; i < sn->length; i++) {
1986 sprintf(p, "%02x", (unsigned int)sn->data[i]);
1989 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_SERIAL][lookup], buf, T_OP_SET);
1990 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
1995 * Get the Expiration Date
1998 asn_time = X509_get_notAfter(client_cert);
1999 if (certs && identity && (lookup <= 1) && asn_time &&
2000 (asn_time->length < (int) sizeof(buf))) {
2001 memcpy(buf, (char*) asn_time->data, asn_time->length);
2002 buf[asn_time->length] = '\0';
2003 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_EXPIRATION][lookup], buf, T_OP_SET);
2004 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2008 * Get the Subject & Issuer
2010 subject[0] = issuer[0] = '\0';
2011 X509_NAME_oneline(X509_get_subject_name(client_cert), subject,
2013 subject[sizeof(subject) - 1] = '\0';
2014 if (certs && identity && (lookup <= 1) && subject[0]) {
2015 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_SUBJECT][lookup], subject, T_OP_SET);
2016 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2019 X509_NAME_oneline(X509_get_issuer_name(ctx->current_cert), issuer,
2021 issuer[sizeof(issuer) - 1] = '\0';
2022 if (certs && identity && (lookup <= 1) && issuer[0]) {
2023 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_ISSUER][lookup], issuer, T_OP_SET);
2024 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2028 * Get the Common Name, if there is a subject.
2030 X509_NAME_get_text_by_NID(X509_get_subject_name(client_cert),
2031 NID_commonName, common_name, sizeof(common_name));
2032 common_name[sizeof(common_name) - 1] = '\0';
2033 if (certs && identity && (lookup <= 1) && common_name[0] && subject[0]) {
2034 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_CN][lookup], common_name, T_OP_SET);
2035 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2039 * Get the RFC822 Subject Alternative Name
2041 loc = X509_get_ext_by_NID(client_cert, NID_subject_alt_name, 0);
2042 if (certs && (lookup <= 1) && (loc >= 0)) {
2043 X509_EXTENSION *ext = NULL;
2044 GENERAL_NAMES *names = NULL;
2047 if ((ext = X509_get_ext(client_cert, loc)) &&
2048 (names = X509V3_EXT_d2i(ext))) {
2049 for (i = 0; i < sk_GENERAL_NAME_num(names); i++) {
2050 GENERAL_NAME *name = sk_GENERAL_NAME_value(names, i);
2052 switch (name->type) {
2055 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_EMAIL][lookup],
2056 (char *) ASN1_STRING_data(name->d.rfc822Name), T_OP_SET);
2057 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2059 #endif /* GEN_EMAIL */
2062 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_DNS][lookup],
2063 (char *) ASN1_STRING_data(name->d.dNSName), T_OP_SET);
2064 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2066 #endif /* GEN_DNS */
2067 #ifdef GEN_OTHERNAME
2069 /* look for a MS UPN */
2070 if (NID_ms_upn == OBJ_obj2nid(name->d.otherName->type_id)) {
2071 /* we've got a UPN - Must be ASN1-encoded UTF8 string */
2072 if (name->d.otherName->value->type == V_ASN1_UTF8STRING) {
2073 vp = fr_pair_make(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_UPN][lookup],
2074 (char *) ASN1_STRING_data(name->d.otherName->value->value.utf8string), T_OP_SET);
2075 rdebug_pair(L_DBG_LVL_2, request, vp, NULL);
2078 RWARN("Invalid UPN in Subject Alt Name (should be UTF-8)");
2083 #endif /* GEN_OTHERNAME */
2085 /* XXX TODO handle other SAN types */
2091 sk_GENERAL_NAME_free(names);
2095 * If the CRL has expired, that might still be OK.
2098 (conf->allow_expired_crl) &&
2099 (err == X509_V_ERR_CRL_HAS_EXPIRED)) {
2101 X509_STORE_CTX_set_error( ctx, 0 );
2105 char const *p = X509_verify_cert_error_string(err);
2106 RERROR("SSL says error %d : %s", err, p);
2112 client_inf = client_cert->cert_info;
2113 ext_list = client_inf->extensions;
2119 * Grab the X509 extensions, and create attributes out of them.
2120 * For laziness, we re-use the OpenSSL names
2122 if (certs && (sk_X509_EXTENSION_num(ext_list) > 0)) {
2127 out = BIO_new(BIO_s_mem());
2128 strlcpy(attribute, "TLS-Client-Cert-", sizeof(attribute));
2130 for (i = 0; i < sk_X509_EXTENSION_num(ext_list); i++) {
2132 X509_EXTENSION *ext;
2134 ext = sk_X509_EXTENSION_value(ext_list, i);
2136 obj = X509_EXTENSION_get_object(ext);
2137 i2a_ASN1_OBJECT(out, obj);
2138 len = BIO_read(out, attribute + 16 , sizeof(attribute) - 16 - 1);
2139 if (len <= 0) continue;
2141 attribute[16 + len] = '\0';
2143 for (p = attribute + 16; *p != '\0'; p++) {
2144 if (*p == ' ') *p = '-';
2147 X509V3_EXT_print(out, ext, 0, 0);
2148 len = BIO_read(out, value , sizeof(value) - 1);
2149 if (len <= 0) continue;
2153 vp = fr_pair_make(talloc_ctx, certs, attribute, value, T_OP_ADD);
2155 RDEBUG3("Skipping %s += '%s'. Please check that both the "
2156 "attribute and value are defined in the dictionaries",
2160 * rdebug_pair_list indents (so pre REXDENT())
2163 rdebug_pair_list(L_DBG_LVL_2, request, vp, NULL);
2173 switch (ctx->error) {
2174 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
2175 RERROR("issuer=%s", issuer);
2178 case X509_V_ERR_CERT_NOT_YET_VALID:
2179 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
2180 RERROR("notBefore=");
2182 ASN1_TIME_print(bio_err, X509_get_notBefore(ctx->current_cert));
2186 case X509_V_ERR_CERT_HAS_EXPIRED:
2187 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
2188 RERROR("notAfter=");
2190 ASN1_TIME_print(bio_err, X509_get_notAfter(ctx->current_cert));
2196 * If we're at the actual client cert, apply additional
2201 * If the conf tells us to, check cert issuer
2202 * against the specified value and fail
2203 * verification if they don't match.
2205 if (conf->check_cert_issuer &&
2206 (strcmp(issuer, conf->check_cert_issuer) != 0)) {
2207 AUTH(LOG_PREFIX ": Certificate issuer (%s) does not match specified value (%s)!",
2208 issuer, conf->check_cert_issuer);
2213 * If the conf tells us to, check the CN in the
2214 * cert against xlat'ed value, but only if the
2215 * previous checks passed.
2217 if (my_ok && conf->check_cert_cn) {
2218 if (radius_xlat(cn_str, sizeof(cn_str), request, conf->check_cert_cn, NULL, NULL) < 0) {
2219 /* if this fails, fail the verification */
2222 RDEBUG2("checking certificate CN (%s) with xlat'ed value (%s)", common_name, cn_str);
2223 if (strcmp(cn_str, common_name) != 0) {
2224 AUTH(LOG_PREFIX ": Certificate CN (%s) does not match specified value (%s)!",
2225 common_name, cn_str);
2229 } /* check_cert_cn */
2231 #ifdef HAVE_OPENSSL_OCSP_H
2234 * No OCSP, allow external verification.
2236 if (!conf->ocsp_enable) {
2240 RDEBUG2("Starting OCSP Request");
2241 if ((X509_STORE_CTX_get1_issuer(&issuer_cert, ctx, client_cert) != 1) ||
2244 * Allow for external verify.
2246 RERROR("Couldn't get issuer_cert for %s", common_name);
2251 * Do the full OCSP checks.
2253 * If they fail, don't run the external verify. We don't want
2254 * to allow admins to force authentication success for bad
2257 * If the OCSP checks succeed, check whether we still want to
2258 * run the external verification routine. If it's marked as
2259 * "skip verify on OK", then we don't do verify.
2261 my_ok = ocsp_check(request, ocsp_store, issuer_cert, client_cert, conf);
2262 if (my_ok != OCSP_STATUS_FAILED) {
2263 do_verify = !conf->verify_skip_if_ocsp_ok;
2270 if ((my_ok != OCSP_STATUS_FAILED)
2271 #ifdef HAVE_OPENSSL_OCSP_H
2274 ) while (conf->verify_client_cert_cmd) {
2279 snprintf(filename, sizeof(filename), "%s/%s.client.XXXXXXXX",
2280 conf->verify_tmp_dir, main_config.name);
2281 fd = mkstemp(filename);
2283 RDEBUG("Failed creating file in %s: %s",
2284 conf->verify_tmp_dir, fr_syserror(errno));
2288 fp = fdopen(fd, "w");
2291 RDEBUG("Failed opening file %s: %s",
2292 filename, fr_syserror(errno));
2296 if (!PEM_write_X509(fp, client_cert)) {
2298 RDEBUG("Failed writing certificate to file");
2303 if (!pair_make_request("TLS-Client-Cert-Filename",
2304 filename, T_OP_SET)) {
2305 RDEBUG("Failed creating TLS-Client-Cert-Filename");
2310 RDEBUG("Verifying client certificate: %s", conf->verify_client_cert_cmd);
2311 if (radius_exec_program(request, NULL, 0, NULL, request, conf->verify_client_cert_cmd,
2312 request->packet->vps,
2313 true, true, EXEC_TIMEOUT) != 0) {
2314 AUTH(LOG_PREFIX ": Certificate CN (%s) fails external verification!", common_name);
2317 RDEBUG("Client certificate CN %s passed external validation", common_name);
2326 if (certs && request && !my_ok) {
2327 fr_pair_add(&request->packet->vps, fr_pair_list_copy(request->packet, *certs));
2330 if (RDEBUG_ENABLED3) {
2331 RDEBUG3("chain-depth : %d", depth);
2332 RDEBUG3("error : %d", err);
2334 if (identity) RDEBUG3("identity : %s", *identity);
2335 RDEBUG3("common name : %s", common_name);
2336 RDEBUG3("subject : %s", subject);
2337 RDEBUG3("issuer : %s", issuer);
2338 RDEBUG3("verify return : %d", my_ok);
2341 return (my_ok != 0);
2345 #ifdef HAVE_OPENSSL_OCSP_H
2347 * Create Global X509 revocation store and use it to verify
2350 * - Load the trusted CAs
2351 * - Load the trusted issuer certificates
2353 static X509_STORE *init_revocation_store(fr_tls_server_conf_t *conf)
2355 X509_STORE *store = NULL;
2357 store = X509_STORE_new();
2359 /* Load the CAs we trust */
2360 if (conf->ca_file || conf->ca_path)
2361 if (!X509_STORE_load_locations(store, conf->ca_file, conf->ca_path)) {
2362 tls_error_log(NULL, "Error reading Trusted root CA list \"%s\"", conf->ca_file);
2366 #ifdef X509_V_FLAG_CRL_CHECK
2367 if (conf->check_crl)
2368 X509_STORE_set_flags(store, X509_V_FLAG_CRL_CHECK);
2370 #ifdef X509_V_FLAG_CRL_CHECK_ALL
2371 if (conf->check_all_crl)
2372 X509_STORE_set_flags(store, X509_V_FLAG_CRL_CHECK_ALL);
2376 #endif /* HAVE_OPENSSL_OCSP_H */
2378 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
2379 #ifndef OPENSSL_NO_ECDH
2380 static int set_ecdh_curve(SSL_CTX *ctx, char const *ecdh_curve, bool disable_single_dh_use)
2385 if (!ecdh_curve || !*ecdh_curve) return 0;
2387 nid = OBJ_sn2nid(ecdh_curve);
2389 ERROR(LOG_PREFIX ": Unknown ecdh_curve \"%s\"", ecdh_curve);
2393 ecdh = EC_KEY_new_by_curve_name(nid);
2395 ERROR(LOG_PREFIX ": Unable to create new curve \"%s\"", ecdh_curve);
2399 SSL_CTX_set_tmp_ecdh(ctx, ecdh);
2401 if (!disable_single_dh_use) {
2402 SSL_CTX_set_options(ctx, SSL_OP_SINGLE_ECDH_USE);
2413 * DIE OPENSSL DIE DIE DIE
2415 * What a palaver, just to free some data attached the
2416 * session. We need to do this because the "remove" callback
2417 * is called when refcount > 0 sometimes, if another thread
2418 * is using the session
2420 static void sess_free_vps(UNUSED void *parent, void *data_ptr,
2421 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
2422 UNUSED long argl, UNUSED void *argp)
2424 VALUE_PAIR *vp = data_ptr;
2427 DEBUG2(LOG_PREFIX ": Freeing cached session VPs");
2429 fr_pair_list_free(&vp);
2432 static void sess_free_certs(UNUSED void *parent, void *data_ptr,
2433 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
2434 UNUSED long argl, UNUSED void *argp)
2436 VALUE_PAIR **certs = data_ptr;
2439 DEBUG2(LOG_PREFIX ": Freeing cached session Certificates");
2441 fr_pair_list_free(certs);
2444 /** Add all the default ciphers and message digests reate our context.
2446 * This should be called exactly once from main, before reading the main config
2447 * or initialising any modules.
2449 void tls_global_init(void)
2451 SSL_load_error_strings(); /* readable error messages (examples show call before library_init) */
2452 SSL_library_init(); /* initialize library */
2453 OpenSSL_add_all_algorithms(); /* required for SHA2 in OpenSSL < 0.9.8o and 1.0.0.a */
2454 OPENSSL_config(NULL);
2457 * Initialize the index for the certificates.
2459 fr_tls_ex_index_certs = SSL_SESSION_get_ex_new_index(0, NULL, NULL, NULL, sess_free_certs);
2462 #ifdef ENABLE_OPENSSL_VERSION_CHECK
2463 /** Check for vulnerable versions of libssl
2465 * @param acknowledged The highest CVE number a user has confirmed is not present in the system's libssl.
2466 * @return 0 if the CVE specified by the user matches the most recent CVE we have, else -1.
2468 int tls_global_version_check(char const *acknowledged)
2474 if (strcmp(acknowledged, "yes") == 0) return 0;
2476 /* Check for bad versions */
2477 v = (uint64_t) SSLeay();
2479 for (i = 0; i < (sizeof(libssl_defects) / sizeof(*libssl_defects)); i++) {
2480 libssl_defect_t *defect = &libssl_defects[i];
2482 if ((v >= defect->low) && (v <= defect->high)) {
2484 * If the CVE is acknowledged, allow it.
2486 if (strcmp(acknowledged, defect->name) == 0) return 0;
2488 ERROR("Refusing to start with libssl version %s (in range %s)",
2489 ssl_version(), ssl_version_range(defect->low, defect->high));
2490 ERROR("Security advisory %s (%s)", defect->id, defect->name);
2491 ERROR("%s", defect->comment);
2493 INFO("Once you have verified libssl has been correctly patched, "
2494 "set security.allow_vulnerable_openssl = '%s'", defect->id);
2506 /** Free any memory alloced by libssl
2509 void tls_global_cleanup(void)
2511 ERR_remove_state(0);
2513 CONF_modules_unload(1);
2516 CRYPTO_cleanup_all_ex_data();
2519 /** Create SSL context
2521 * - Load the trusted CAs
2522 * - Load the Private key & the certificate
2523 * - Set the Context options & Verify options
2525 SSL_CTX *tls_init_ctx(fr_tls_server_conf_t *conf, int client)
2528 X509_STORE *certstore;
2529 int verify_mode = SSL_VERIFY_NONE;
2530 int ctx_options = 0;
2531 int ctx_tls_versions = 0;
2535 * SHA256 is in all versions of OpenSSL, but isn't
2536 * initialized by default. It's needed for WiMAX
2539 #ifdef HAVE_OPENSSL_EVP_SHA256
2540 EVP_add_digest(EVP_sha256());
2543 ctx = SSL_CTX_new(SSLv23_method()); /* which is really "all known SSL / TLS methods". Idiots. */
2545 tls_error_log(NULL, "Failed creating TLS context");
2550 * Save the config on the context so that callbacks which
2551 * only get SSL_CTX* e.g. session persistence, can get it
2553 SSL_CTX_set_app_data(ctx, conf);
2556 * Identify the type of certificates that needs to be loaded
2558 if (conf->file_type) {
2559 type = SSL_FILETYPE_PEM;
2561 type = SSL_FILETYPE_ASN1;
2565 * Set the password to load private key
2567 if (conf->private_key_password) {
2570 * We don't want to put the private key password in eap.conf, so check
2571 * for our special string which indicates we should get the password
2574 char const* special_string = "Apple:UseCertAdmin";
2575 if (strncmp(conf->private_key_password, special_string, strlen(special_string)) == 0) {
2578 long const max_password_len = 128;
2579 snprintf(cmd, sizeof(cmd) - 1, "/usr/sbin/certadmin --get-private-key-passphrase \"%s\"",
2580 conf->private_key_file);
2582 DEBUG2(LOG_PREFIX ": Getting private key passphrase using command \"%s\"", cmd);
2584 FILE* cmd_pipe = popen(cmd, "r");
2586 ERROR(LOG_PREFIX ": %s command failed: Unable to get private_key_password", cmd);
2587 ERROR(LOG_PREFIX ": Error reading private_key_file %s", conf->private_key_file);
2591 rad_const_free(conf->private_key_password);
2592 password = talloc_array(conf, char, max_password_len);
2594 ERROR(LOG_PREFIX ": Can't allocate space for private_key_password");
2595 ERROR(LOG_PREFIX ": Error reading private_key_file %s", conf->private_key_file);
2600 fgets(password, max_password_len, cmd_pipe);
2603 /* Get rid of newline at end of password. */
2604 password[strlen(password) - 1] = '\0';
2606 DEBUG3(LOG_PREFIX ": Password from command = \"%s\"", password);
2607 conf->private_key_password = password;
2614 memcpy(&password, &conf->private_key_password, sizeof(password));
2615 SSL_CTX_set_default_passwd_cb_userdata(ctx, password);
2616 SSL_CTX_set_default_passwd_cb(ctx, cbtls_password);
2620 #ifdef PSK_MAX_IDENTITY_LEN
2623 * No dynamic query exists. There MUST be a
2624 * statically configured identity and password.
2626 if (conf->psk_query && !*conf->psk_query) {
2627 ERROR(LOG_PREFIX ": Invalid PSK Configuration: psk_query cannot be empty");
2632 * Set the callback only if we can check things.
2634 if (conf->psk_identity || conf->psk_query) {
2635 SSL_CTX_set_psk_server_callback(ctx, psk_server_callback);
2638 } else if (conf->psk_query) {
2639 ERROR(LOG_PREFIX ": Invalid PSK Configuration: psk_query cannot be used for outgoing connections");
2644 * Now check that if PSK is being used, the config is valid.
2646 if ((conf->psk_identity && !conf->psk_password) ||
2647 (!conf->psk_identity && conf->psk_password) ||
2648 (conf->psk_identity && !*conf->psk_identity) ||
2649 (conf->psk_password && !*conf->psk_password)) {
2650 ERROR(LOG_PREFIX ": Invalid PSK Configuration: psk_identity or psk_password are empty");
2654 if (conf->psk_identity) {
2655 size_t psk_len, hex_len;
2656 uint8_t buffer[PSK_MAX_PSK_LEN];
2658 if (conf->certificate_file ||
2659 conf->private_key_password || conf->private_key_file ||
2660 conf->ca_file || conf->ca_path) {
2661 ERROR(LOG_PREFIX ": When PSKs are used, No certificate configuration is permitted");
2666 SSL_CTX_set_psk_client_callback(ctx,
2667 psk_client_callback);
2670 psk_len = strlen(conf->psk_password);
2671 if (strlen(conf->psk_password) > (2 * PSK_MAX_PSK_LEN)) {
2672 ERROR(LOG_PREFIX ": psk_hexphrase is too long (max %d)", PSK_MAX_PSK_LEN);
2677 * Check the password now, so that we don't have
2678 * errors at run-time.
2680 hex_len = fr_hex2bin(buffer, sizeof(buffer), conf->psk_password, psk_len);
2681 if (psk_len != (2 * hex_len)) {
2682 ERROR(LOG_PREFIX ": psk_hexphrase is not all hex");
2689 (void) client; /* -Wunused */
2693 * Load our keys and certificates
2695 * If certificates are of type PEM then we can make use
2696 * of cert chain authentication using openssl api call
2697 * SSL_CTX_use_certificate_chain_file. Please see how
2698 * the cert chain needs to be given in PEM from
2701 if (!conf->certificate_file) goto load_ca;
2703 if (type == SSL_FILETYPE_PEM) {
2704 if (!(SSL_CTX_use_certificate_chain_file(ctx, conf->certificate_file))) {
2705 tls_error_log(NULL, "Failed reading certificate file \"%s\"",
2706 conf->certificate_file);
2710 } else if (!(SSL_CTX_use_certificate_file(ctx, conf->certificate_file, type))) {
2711 tls_error_log(NULL, "Failed reading certificate file \"%s\"",
2712 conf->certificate_file);
2716 /* Load the CAs we trust */
2718 if (conf->ca_file || conf->ca_path) {
2719 if (!SSL_CTX_load_verify_locations(ctx, conf->ca_file, conf->ca_path)) {
2720 tls_error_log(NULL, "Failed reading Trusted root CA list \"%s\"",
2725 if (conf->ca_file && *conf->ca_file) SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(conf->ca_file));
2727 if (conf->private_key_file) {
2728 if (!(SSL_CTX_use_PrivateKey_file(ctx, conf->private_key_file, type))) {
2729 tls_error_log(NULL, "Failed reading private key file \"%s\"",
2730 conf->private_key_file);
2735 * Check if the loaded private key is the right one
2737 if (!SSL_CTX_check_private_key(ctx)) {
2738 ERROR(LOG_PREFIX ": Private key does not match the certificate public key");
2743 #ifdef PSK_MAX_IDENTITY_LEN
2748 * We never want SSLv2 or SSLv3.
2750 ctx_options |= SSL_OP_NO_SSLv2;
2751 ctx_options |= SSL_OP_NO_SSLv3;
2754 * As of 3.0.5, we always allow TLSv1.1 and TLSv1.2.
2755 * Though they can be *globally* disabled if necessary.x
2757 #ifdef SSL_OP_NO_TLSv1
2758 if (conf->disable_tlsv1) ctx_options |= SSL_OP_NO_TLSv1;
2760 ctx_tls_versions |= SSL_OP_NO_TLSv1;
2762 #ifdef SSL_OP_NO_TLSv1_1
2763 if (conf->disable_tlsv1_1) ctx_options |= SSL_OP_NO_TLSv1_1;
2765 ctx_tls_versions |= SSL_OP_NO_TLSv1_1;
2767 #ifdef SSL_OP_NO_TLSv1_2
2769 if (conf->disable_tlsv1_2) ctx_options |= SSL_OP_NO_TLSv1_2;
2771 ctx_tls_versions |= SSL_OP_NO_TLSv1_2;
2775 if ((ctx_options & ctx_tls_versions) == ctx_tls_versions) {
2776 ERROR(LOG_PREFIX ": You have disabled all available TLS versions. EAP will not work");
2780 #ifdef SSL_OP_NO_TICKET
2781 ctx_options |= SSL_OP_NO_TICKET;
2784 if (!conf->disable_single_dh_use) {
2786 * SSL_OP_SINGLE_DH_USE must be used in order to prevent
2787 * small subgroup attacks and forward secrecy. Always
2788 * using SSL_OP_SINGLE_DH_USE has an impact on the
2789 * computer time needed during negotiation, but it is not
2792 ctx_options |= SSL_OP_SINGLE_DH_USE;
2796 * SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS to work around issues
2797 * in Windows Vista client.
2798 * http://www.openssl.org/~bodo/tls-cbc.txt
2799 * http://www.nabble.com/(RADIATOR)-Radiator-Version-3.16-released-t2600070.html
2801 ctx_options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
2803 SSL_CTX_set_options(ctx, ctx_options);
2806 * TODO: Set the RSA & DH
2807 * SSL_CTX_set_tmp_rsa_callback(ctx, cbtls_rsa);
2808 * SSL_CTX_set_tmp_dh_callback(ctx, cbtls_dh);
2812 * set the message callback to identify the type of
2813 * message. For every new session, there can be a
2814 * different callback argument.
2816 * SSL_CTX_set_msg_callback(ctx, cbtls_msg);
2820 * Set eliptical curve crypto configuration.
2822 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
2823 #ifndef OPENSSL_NO_ECDH
2824 if (set_ecdh_curve(ctx, conf->ecdh_curve, conf->disable_single_dh_use) < 0) {
2831 * OpenSSL will automatically create certificate chains,
2832 * unless we tell it to not do that. The problem is that
2833 * it sometimes gets the chains right from a certificate
2834 * signature view, but wrong from the clients view.
2836 if (!conf->auto_chain) {
2837 SSL_CTX_set_mode(ctx, SSL_MODE_NO_AUTO_CHAIN);
2840 /* Set Info callback */
2841 SSL_CTX_set_info_callback(ctx, cbtls_info);
2844 * Callbacks, etc. for session resumption.
2846 if (conf->session_cache_enable) {
2848 * Cache sessions on disk if requested.
2850 if (conf->session_cache_path) {
2851 SSL_CTX_sess_set_new_cb(ctx, cbtls_new_session);
2852 SSL_CTX_sess_set_get_cb(ctx, cbtls_get_session);
2853 SSL_CTX_sess_set_remove_cb(ctx, cbtls_remove_session);
2856 SSL_CTX_set_quiet_shutdown(ctx, 1);
2857 if (fr_tls_ex_index_vps < 0)
2858 fr_tls_ex_index_vps = SSL_SESSION_get_ex_new_index(0, NULL, NULL, NULL, sess_free_vps);
2862 * Check the certificates for revocation.
2864 #ifdef X509_V_FLAG_CRL_CHECK
2865 if (conf->check_crl) {
2866 certstore = SSL_CTX_get_cert_store(ctx);
2867 if (certstore == NULL) {
2868 tls_error_log(NULL, "Error reading Certificate Store");
2871 X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK);
2873 #ifdef X509_V_FLAG_CRL_CHECK_ALL
2874 if (conf->check_all_crl)
2875 X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK_ALL);
2882 * Always verify the peer certificate
2884 verify_mode |= SSL_VERIFY_PEER;
2885 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
2886 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
2887 SSL_CTX_set_verify(ctx, verify_mode, cbtls_verify);
2889 if (conf->verify_depth) {
2890 SSL_CTX_set_verify_depth(ctx, conf->verify_depth);
2893 /* Load randomness */
2894 if (conf->random_file) {
2895 if (!(RAND_load_file(conf->random_file, 1024*10))) {
2896 tls_error_log(NULL, "Failed loading randomness");
2902 * Set the cipher list if we were told to
2904 if (conf->cipher_list) {
2905 if (!SSL_CTX_set_cipher_list(ctx, conf->cipher_list)) {
2906 tls_error_log(NULL, "Failed setting cipher list");
2912 * Setup session caching
2914 if (conf->session_cache_enable) {
2916 * Create a unique context Id per EAP-TLS configuration.
2918 if (conf->session_id_name) {
2919 snprintf(conf->session_context_id, sizeof(conf->session_context_id),
2920 "FR eap %s", conf->session_id_name);
2922 snprintf(conf->session_context_id, sizeof(conf->session_context_id),
2927 * Cache it, and DON'T auto-clear it.
2929 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_SERVER | SSL_SESS_CACHE_NO_AUTO_CLEAR);
2931 SSL_CTX_set_session_id_context(ctx,
2932 (unsigned char *) conf->session_context_id,
2933 (unsigned int) strlen(conf->session_context_id));
2936 * Our timeout is in hours, this is in seconds.
2938 SSL_CTX_set_timeout(ctx, conf->session_timeout * 3600);
2941 * Set the maximum number of entries in the
2944 SSL_CTX_sess_set_cache_size(ctx, conf->session_cache_size);
2947 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
2955 * Free TLS client/server config
2956 * Should not be called outside this code, as a callback is
2957 * added to automatically free the data when the CONF_SECTION
2960 static int _tls_server_conf_free(fr_tls_server_conf_t *conf)
2962 if (conf->ctx) SSL_CTX_free(conf->ctx);
2964 #ifdef HAVE_OPENSSL_OCSP_H
2965 if (conf->ocsp_store) X509_STORE_free(conf->ocsp_store);
2966 conf->ocsp_store = NULL;
2970 memset(conf, 0, sizeof(*conf));
2975 static fr_tls_server_conf_t *tls_server_conf_alloc(TALLOC_CTX *ctx)
2977 fr_tls_server_conf_t *conf;
2979 conf = talloc_zero(ctx, fr_tls_server_conf_t);
2981 ERROR(LOG_PREFIX ": Out of memory");
2985 talloc_set_destructor(conf, _tls_server_conf_free);
2990 fr_tls_server_conf_t *tls_server_conf_parse(CONF_SECTION *cs)
2992 fr_tls_server_conf_t *conf;
2995 * If cs has already been parsed there should be a cached copy
2996 * of conf already stored, so just return that.
2998 conf = cf_data_find(cs, "tls-conf");
3000 DEBUG(LOG_PREFIX ": Using cached TLS configuration from previous invocation");
3004 conf = tls_server_conf_alloc(cs);
3006 if (cf_section_parse(cs, conf, tls_server_config) < 0) {
3013 * Save people from their own stupidity.
3015 if (conf->fragment_size < 100) conf->fragment_size = 100;
3017 if (!conf->private_key_file) {
3018 ERROR(LOG_PREFIX ": TLS Server requires a private key file");
3022 if (!conf->certificate_file) {
3023 ERROR(LOG_PREFIX ": TLS Server requires a certificate file");
3030 conf->ctx = tls_init_ctx(conf, 0);
3031 if (conf->ctx == NULL) {
3035 #ifdef HAVE_OPENSSL_OCSP_H
3037 * Initialize OCSP Revocation Store
3039 if (conf->ocsp_enable) {
3040 conf->ocsp_store = init_revocation_store(conf);
3041 if (conf->ocsp_store == NULL) goto error;
3043 #endif /*HAVE_OPENSSL_OCSP_H*/
3047 memcpy(&dh_file, &conf->dh_file, sizeof(dh_file));
3048 if (load_dh_params(conf->ctx, dh_file) < 0) {
3053 if (conf->verify_tmp_dir) {
3054 if (chmod(conf->verify_tmp_dir, S_IRWXU) < 0) {
3055 ERROR(LOG_PREFIX ": Failed changing permissions on %s: %s",
3056 conf->verify_tmp_dir, fr_syserror(errno));
3061 if (conf->verify_client_cert_cmd && !conf->verify_tmp_dir) {
3062 ERROR(LOG_PREFIX ": You MUST set the verify directory in order to use verify_client_cmd");
3066 #ifdef SSL_OP_NO_TLSv1_2
3068 * OpenSSL 1.0.1f and 1.0.1g get the MS-MPPE keys wrong.
3070 #if (OPENSSL_VERSION_NUMBER >= 0x10010060L) && (OPENSSL_VERSION_NUMBER < 0x10010060L)
3071 conf->disable_tlsv1_2 = true;
3072 WARN(LOG_PREFIX ": Disabling TLSv1.2 due to OpenSSL bugs");
3077 * Cache conf in cs in case we're asked to parse this again.
3079 cf_data_add(cs, "tls-conf", conf, NULL);
3084 fr_tls_server_conf_t *tls_client_conf_parse(CONF_SECTION *cs)
3086 fr_tls_server_conf_t *conf;
3088 conf = cf_data_find(cs, "tls-conf");
3090 DEBUG2(LOG_PREFIX ": Using cached TLS configuration from previous invocation");
3094 conf = tls_server_conf_alloc(cs);
3096 if (cf_section_parse(cs, conf, tls_client_config) < 0) {
3103 * Save people from their own stupidity.
3105 if (conf->fragment_size < 100) conf->fragment_size = 100;
3110 conf->ctx = tls_init_ctx(conf, 1);
3111 if (conf->ctx == NULL) {
3118 memcpy(&dh_file, &conf->dh_file, sizeof(dh_file));
3119 if (load_dh_params(conf->ctx, dh_file) < 0) {
3124 cf_data_add(cs, "tls-conf", conf, NULL);
3129 int tls_success(tls_session_t *ssn, REQUEST *request)
3131 VALUE_PAIR *vp, *vps = NULL;
3132 fr_tls_server_conf_t *conf;
3133 TALLOC_CTX *talloc_ctx;
3135 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF);
3136 rad_assert(conf != NULL);
3138 talloc_ctx = SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_TALLOC);
3141 * If there's no session resumption, delete the entry
3142 * from the cache. This means either it's disabled
3143 * globally for this SSL context, OR we were told to
3144 * disable it for this user.
3146 * This also means you can't turn it on just for one
3149 if ((!ssn->allow_session_resumption) ||
3150 (((vp = fr_pair_find_by_num(request->config, PW_ALLOW_SESSION_RESUMPTION, 0, TAG_ANY)) != NULL) &&
3151 (vp->vp_integer == 0))) {
3152 SSL_CTX_remove_session(ssn->ctx,
3154 ssn->allow_session_resumption = false;
3157 * If we're in a resumed session and it's
3160 if (SSL_session_reused(ssn->ssl)) {
3161 RDEBUG("Forcibly stopping session resumption as it is not allowed");
3166 * Else resumption IS allowed, so we store the
3167 * user data in the cache.
3169 } else if (!SSL_session_reused(ssn->ssl)) {
3171 char buffer[2 * MAX_SESSION_SIZE + 1];
3173 tls_session_id(ssn->ssl_session, buffer, MAX_SESSION_SIZE);
3175 vp = fr_pair_list_copy_by_num(talloc_ctx, request->reply->vps, PW_USER_NAME, 0, TAG_ANY);
3176 if (vp) fr_pair_add(&vps, vp);
3178 vp = fr_pair_list_copy_by_num(talloc_ctx, request->packet->vps, PW_STRIPPED_USER_NAME, 0, TAG_ANY);
3179 if (vp) fr_pair_add(&vps, vp);
3181 vp = fr_pair_list_copy_by_num(talloc_ctx, request->packet->vps, PW_STRIPPED_USER_DOMAIN, 0, TAG_ANY);
3182 if (vp) fr_pair_add(&vps, vp);
3184 vp = fr_pair_list_copy_by_num(talloc_ctx, request->reply->vps, PW_CHARGEABLE_USER_IDENTITY, 0, TAG_ANY);
3185 if (vp) fr_pair_add(&vps, vp);
3187 vp = fr_pair_list_copy_by_num(talloc_ctx, request->reply->vps, PW_CACHED_SESSION_POLICY, 0, TAG_ANY);
3188 if (vp) fr_pair_add(&vps, vp);
3190 certs = (VALUE_PAIR **)SSL_get_ex_data(ssn->ssl, fr_tls_ex_index_certs);
3193 * Hmm... the certs should probably be session data.
3197 * @todo: some go into reply, others into
3200 fr_pair_add(&vps, fr_pair_list_copy(talloc_ctx, *certs));
3203 * Save the certs in the packet, so that we can see them.
3205 fr_pair_add(&request->packet->vps, fr_pair_list_copy(request->packet, *certs));
3209 SSL_SESSION_set_ex_data(ssn->ssl_session, fr_tls_ex_index_vps, vps);
3210 rdebug_pair_list(L_DBG_LVL_2, request, vps, " caching ");
3212 if (conf->session_cache_path) {
3213 /* write the VPs to the cache file */
3214 char filename[256], buf[1024];
3217 RDEBUG2("Saving session %s in the disk cache", buffer);
3219 snprintf(filename, sizeof(filename), "%s%c%s.vps", conf->session_cache_path,
3220 FR_DIR_SEP, buffer);
3221 vp_file = fopen(filename, "w");
3222 if (vp_file == NULL) {
3223 RWDEBUG("Could not write session VPs to persistent cache: %s",
3224 fr_syserror(errno));
3226 VALUE_PAIR *prev = NULL;
3228 /* generate a dummy user-style entry which is easy to read back */
3229 fprintf(vp_file, "# SSL cached session\n");
3230 fprintf(vp_file, "%s\n\t", buffer);
3232 for (vp = fr_cursor_init(&cursor, &vps);
3234 vp = fr_cursor_next(&cursor)) {
3236 * Terminate the previous line.
3238 if (prev) fprintf(vp_file, ",\n\t");
3243 vp_prints(buf, sizeof(buf), vp);
3244 fputs(buf, vp_file);
3249 * Terminate the final line.
3251 fprintf(vp_file, "\n");
3255 RDEBUG("Failed to find 'persist_dir' in TLS configuration. Session will not be cached on disk.");
3258 RDEBUG2("No information to cache: session caching will be disabled for session %s", buffer);
3259 SSL_CTX_remove_session(ssn->ctx, ssn->ssl_session);
3263 * Else the session WAS allowed. Copy the cached reply.
3266 char buffer[2 * MAX_SESSION_SIZE + 1];
3268 tls_session_id(ssn->ssl_session, buffer, MAX_SESSION_SIZE);
3271 * The "restore VPs from OpenSSL cache" code is
3272 * now in eaptls_process()
3275 if (conf->session_cache_path) {
3276 /* "touch" the cached session/vp file */
3279 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
3280 conf->session_cache_path, FR_DIR_SEP, buffer);
3281 utime(filename, NULL);
3282 snprintf(filename, sizeof(filename), "%s%c%s.vps",
3283 conf->session_cache_path, FR_DIR_SEP, buffer);
3284 utime(filename, NULL);
3288 * Mark the request as resumed.
3290 pair_make_request("EAP-Session-Resumed", "1", T_OP_SET);
3297 void tls_fail(tls_session_t *ssn)
3300 * Force the session to NOT be cached.
3302 SSL_CTX_remove_session(ssn->ctx, ssn->ssl_session);
3305 fr_tls_status_t tls_application_data(tls_session_t *ssn, REQUEST *request)
3312 * Decrypt the complete record.
3314 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data,
3315 ssn->dirty_in.used);
3316 if (err != (int) ssn->dirty_in.used) {
3317 record_init(&ssn->dirty_in);
3318 RDEBUG("Failed writing %zd bytes to SSL BIO: %d", ssn->dirty_in.used, err);
3323 * Clear the dirty buffer now that we are done with it
3324 * and init the clean_out buffer to store decrypted data
3326 record_init(&ssn->dirty_in);
3327 record_init(&ssn->clean_out);
3330 * Read (and decrypt) the tunneled data from the
3331 * SSL session, and put it into the decrypted
3334 err = SSL_read(ssn->ssl, ssn->clean_out.data, sizeof(ssn->clean_out.data));
3338 RDEBUG("SSL_read Error");
3340 code = SSL_get_error(ssn->ssl, err);
3342 case SSL_ERROR_WANT_READ:
3343 DEBUG("Error in fragmentation logic: SSL_WANT_READ");
3344 return FR_TLS_MORE_FRAGMENTS;
3346 case SSL_ERROR_WANT_WRITE:
3347 DEBUG("Error in fragmentation logic: SSL_WANT_WRITE");
3351 REDEBUG("Error in fragmentation logic");
3352 tls_error_io_log(request, ssn, err,
3353 "Failed in " STRINGIFY(__FUNCTION__) " (SSL_read)");
3359 if (err == 0) RWDEBUG("No data inside of the tunnel");
3362 * Passed all checks, successfully decrypted data
3364 ssn->clean_out.used = err;
3367 * Add the certificates to intermediate packets, so that
3368 * the inner tunnel policies can use them.
3370 certs = (VALUE_PAIR **)SSL_get_ex_data(ssn->ssl, fr_tls_ex_index_certs);
3372 if (certs) fr_pair_add(&request->packet->vps, fr_pair_list_copy(request->packet, *certs));
3379 * Acknowledge received is for one of the following messages sent earlier
3380 * 1. Handshake completed Message, so now send, EAP-Success
3381 * 2. Alert Message, now send, EAP-Failure
3382 * 3. Fragment Message, now send, next Fragment
3384 fr_tls_status_t tls_ack_handler(tls_session_t *ssn, REQUEST *request)
3387 REDEBUG("Unexpected ACK received: No ongoing SSL session");
3388 return FR_TLS_INVALID;
3390 if (!ssn->info.initialized) {
3391 RDEBUG("No SSL info available. Waiting for more SSL data");
3392 return FR_TLS_REQUEST;
3395 if ((ssn->info.content_type == handshake) && (ssn->info.origin == 0)) {
3396 REDEBUG("Unexpected ACK received: We sent no previous messages");
3397 return FR_TLS_INVALID;
3400 switch (ssn->info.content_type) {
3402 RDEBUG2("Peer ACKed our alert");
3406 if ((ssn->info.handshake_type == handshake_finished) && (ssn->dirty_out.used == 0)) {
3407 RDEBUG2("Peer ACKed our handshake fragment. handshake is finished");
3410 * From now on all the content is
3411 * application data set it here as nobody else
3414 ssn->info.content_type = application_data;
3415 return FR_TLS_SUCCESS;
3416 } /* else more data to send */
3418 RDEBUG2("Peer ACKed our handshake fragment");
3419 /* Fragmentation handler, send next fragment */
3420 return FR_TLS_REQUEST;
3422 case application_data:
3423 RDEBUG2("Peer ACKed our application data fragment");
3424 return FR_TLS_REQUEST;
3427 * For the rest of the conditions, switch over
3428 * to the default section below.
3431 REDEBUG("Invalid ACK received: %d", ssn->info.content_type);
3432 return FR_TLS_INVALID;
3435 #endif /* WITH_TLS */