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
45 #ifdef HAVE_OPENSSL_RAND_H
46 #include <openssl/rand.h>
49 #ifdef HAVE_OPENSSL_OCSP_H
50 #include <openssl/ocsp.h>
54 static void record_init(record_t *buf);
55 static void record_close(record_t *buf);
56 static unsigned int record_plus(record_t *buf, void const *ptr,
58 static unsigned int record_minus(record_t *buf, void *ptr,
61 #ifdef PSK_MAX_IDENTITY_LEN
62 static unsigned int psk_server_callback(SSL *ssl, char const *identity,
64 unsigned int max_psk_len)
67 fr_tls_server_conf_t *conf;
69 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl,
70 FR_TLS_EX_INDEX_CONF);
74 * FIXME: Look up the PSK password based on the identity!
76 if (strcmp(identity, conf->psk_identity) != 0) {
80 psk_len = strlen(conf->psk_password);
81 if (psk_len > (2 * max_psk_len)) return 0;
83 return fr_hex2bin(psk, conf->psk_password, psk_len);
86 static unsigned int psk_client_callback(SSL *ssl, UNUSED char const *hint,
87 char *identity, unsigned int max_identity_len,
88 unsigned char *psk, unsigned int max_psk_len)
91 fr_tls_server_conf_t *conf;
93 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl,
94 FR_TLS_EX_INDEX_CONF);
97 psk_len = strlen(conf->psk_password);
98 if (psk_len > (2 * max_psk_len)) return 0;
100 strlcpy(identity, conf->psk_identity, max_identity_len);
102 return fr_hex2bin(psk, conf->psk_password, psk_len);
107 tls_session_t *tls_new_client_session(fr_tls_server_conf_t *conf, int fd)
110 tls_session_t *ssn = NULL;
112 ssn = talloc_zero(conf, tls_session_t);
113 if (!ssn) return NULL;
115 ssn->ctx = conf->ctx;
117 SSL_CTX_set_mode(ssn->ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_AUTO_RETRY);
119 ssn->ssl = SSL_new(ssn->ctx);
120 rad_assert(ssn->ssl != NULL);
123 * Add the message callback to identify what type of
124 * message/handshake is passed
126 SSL_set_msg_callback(ssn->ssl, cbtls_msg);
127 SSL_set_msg_callback_arg(ssn->ssl, ssn);
128 SSL_set_info_callback(ssn->ssl, cbtls_info);
131 * Always verify the peer certificate.
133 DEBUG2("Requiring Server certificate");
134 verify_mode = SSL_VERIFY_PEER;
135 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
136 SSL_set_verify(ssn->ssl, verify_mode, cbtls_verify);
138 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
139 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_SSN, (void *)ssn);
140 SSL_set_fd(ssn->ssl, fd);
141 if (SSL_connect(ssn->ssl) <= 0) {
143 while ((err = ERR_get_error())) {
144 DEBUG("OpenSSL Err says %s",
145 ERR_error_string(err, NULL));
152 ssn->offset = conf->fragment_size;
157 tls_session_t *tls_new_session(fr_tls_server_conf_t *conf, REQUEST *request,
160 tls_session_t *state = NULL;
165 rad_assert(request != NULL);
168 * Manually flush the sessions every so often. If HALF
169 * of the session lifetime has passed since we last
170 * flushed, then flush it again.
172 * FIXME: Also do it every N sessions?
174 if (conf->session_cache_enable &&
175 ((conf->session_last_flushed + (conf->session_timeout * 1800)) <= request->timestamp)){
176 RDEBUG2("Flushing SSL sessions (of #%ld)",
177 SSL_CTX_sess_number(conf->ctx));
179 SSL_CTX_flush_sessions(conf->ctx, request->timestamp);
180 conf->session_last_flushed = request->timestamp;
183 if ((new_tls = SSL_new(conf->ctx)) == NULL) {
184 ERROR("SSL: Error creating new SSL: %s",
185 ERR_error_string(ERR_get_error(), NULL));
189 /* We use the SSL's "app_data" to indicate a call-back */
190 SSL_set_app_data(new_tls, NULL);
192 state = talloc_zero(conf, tls_session_t);
195 state->ctx = conf->ctx;
196 state->ssl = new_tls;
199 * Initialize callbacks
201 state->record_init = record_init;
202 state->record_close = record_close;
203 state->record_plus = record_plus;
204 state->record_minus = record_minus;
207 * Create & hook the BIOs to handle the dirty side of the
208 * SSL. This is *very important* as we want to handle
209 * the transmission part. Now the only IO interface
210 * that SSL is aware of, is our defined BIO buffers.
212 * This means that all SSL IO is done to/from memory,
213 * and we can update those BIOs from the packets we've
216 state->into_ssl = BIO_new(BIO_s_mem());
217 state->from_ssl = BIO_new(BIO_s_mem());
218 SSL_set_bio(state->ssl, state->into_ssl, state->from_ssl);
221 * Add the message callback to identify what type of
222 * message/handshake is passed
224 SSL_set_msg_callback(new_tls, cbtls_msg);
225 SSL_set_msg_callback_arg(new_tls, state);
226 SSL_set_info_callback(new_tls, cbtls_info);
229 * In Server mode we only accept.
231 SSL_set_accept_state(state->ssl);
234 * Verify the peer certificate, if asked.
237 RDEBUG2("Requiring client certificate");
238 verify_mode = SSL_VERIFY_PEER;
239 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
240 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
242 SSL_set_verify(state->ssl, verify_mode, cbtls_verify);
244 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
245 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_SSN, (void *)state);
246 state->length_flag = conf->include_length;
249 * We use default fragment size, unless the Framed-MTU
250 * tells us it's too big. Note that we do NOT account
251 * for the EAP-TLS headers if conf->fragment_size is
252 * large, because that config item looks to be confusing.
254 * i.e. it should REALLY be called MTU, and the code here
255 * should figure out what that means for TLS fragment size.
256 * asking the administrator to know the internal details
257 * of EAP-TLS in order to calculate fragment sizes is
260 state->offset = conf->fragment_size;
261 vp = pairfind(request->packet->vps, PW_FRAMED_MTU, 0, TAG_ANY);
262 if (vp && (vp->vp_integer > 100) && (vp->vp_integer < state->offset)) {
263 state->offset = vp->vp_integer;
266 if (conf->session_cache_enable) {
267 state->allow_session_resumption = 1; /* otherwise it's zero */
276 * Print out some text describing the error.
278 static int int_ssl_check(REQUEST *request, SSL *s, int ret, char const *text)
283 if ((l = ERR_get_error()) != 0) {
284 char const *p = ERR_error_string(l, NULL);
286 if (request && p) REDEBUG("SSL says: %s", p);
288 e = SSL_get_error(s, ret);
292 * These seem to be harmless and already "dealt
293 * with" by our non-blocking environment. NB:
294 * "ZERO_RETURN" is the clean "error"
295 * indicating a successfully closed SSL
296 * tunnel. We let this happen because our IO
297 * loop should not appear to have broken on
298 * this condition - and outside the IO loop, the
299 * "shutdown" state is checked.
301 * Don't print anything if we ignore the error.
304 case SSL_ERROR_WANT_READ:
305 case SSL_ERROR_WANT_WRITE:
306 case SSL_ERROR_WANT_X509_LOOKUP:
307 case SSL_ERROR_ZERO_RETURN:
311 * These seem to be indications of a genuine
312 * error that should result in the SSL tunnel
313 * being regarded as "dead".
315 case SSL_ERROR_SYSCALL:
316 ERROR("SSL: %s failed in a system call (%d), TLS session fails.",
321 ERROR("SSL: %s failed inside of TLS (%d), TLS session fails.",
327 * For any other errors that (a) exist, and (b)
328 * crop up - we need to interpret what to do with
329 * them - so "politely inform" the caller that
330 * the code needs updating here.
332 ERROR("SSL: FATAL SSL error ..... %d\n", e);
340 * We are the server, we always get the dirty data
341 * (Handshake data is also considered as dirty data)
342 * During handshake, since SSL API handles itself,
343 * After clean-up, dirty_out will be filled with
344 * the data required for handshaking. So we check
345 * if dirty_out is empty then we simply send it back.
346 * As of now, if handshake is successful, then we keep going,
349 * Fill the Bio with the dirty data to clean it
350 * Get the cleaned data from SSL, if it is not Handshake data
352 int tls_handshake_recv(REQUEST *request, tls_session_t *ssn)
356 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data, ssn->dirty_in.used);
357 if (err != (int) ssn->dirty_in.used) {
358 RDEBUG("Failed writing %d to SSL BIO: %d", ssn->dirty_in.used,
360 record_init(&ssn->dirty_in);
363 record_init(&ssn->dirty_in);
365 err = SSL_read(ssn->ssl, ssn->clean_out.data + ssn->clean_out.used,
366 sizeof(ssn->clean_out.data) - ssn->clean_out.used);
368 ssn->clean_out.used += err;
372 if (!int_ssl_check(request, ssn->ssl, err, "SSL_read")) {
376 /* Some Extra STATE information for easy debugging */
377 if (SSL_is_init_finished(ssn->ssl)) {
378 DEBUG2("SSL Connection Established\n");
380 if (SSL_in_init(ssn->ssl)) {
381 DEBUG2("In SSL Handshake Phase\n");
383 if (SSL_in_before(ssn->ssl)) {
384 DEBUG2("Before SSL Handshake Phase\n");
386 if (SSL_in_accept_init(ssn->ssl)) {
387 DEBUG2("In SSL Accept mode \n");
389 if (SSL_in_connect_init(ssn->ssl)) {
390 DEBUG2("In SSL Connect mode \n");
393 err = BIO_ctrl_pending(ssn->from_ssl);
395 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
396 sizeof(ssn->dirty_out.data));
398 ssn->dirty_out.used = err;
400 } else if (BIO_should_retry(ssn->from_ssl)) {
401 record_init(&ssn->dirty_in);
402 DEBUG2(" tls: Asking for more data in tunnel");
406 int_ssl_check(request, ssn->ssl, err, "BIO_read");
407 record_init(&ssn->dirty_in);
411 DEBUG2("SSL Application Data");
412 /* Its clean application data, do whatever we want */
413 record_init(&ssn->clean_out);
416 /* We are done with dirty_in, reinitialize it */
417 record_init(&ssn->dirty_in);
422 * Take cleartext user data, and encrypt it into the output buffer,
423 * to send to the client at the other end of the SSL connection.
425 int tls_handshake_send(REQUEST *request, tls_session_t *ssn)
430 * If there's un-encrypted data in 'clean_in', then write
431 * that data to the SSL session, and then call the BIO function
432 * to get that encrypted data from the SSL session, into
433 * a buffer which we can then package into an EAP packet.
435 * Based on Server's logic this clean_in is expected to
436 * contain the data to send to the client.
438 if (ssn->clean_in.used > 0) {
441 written = SSL_write(ssn->ssl, ssn->clean_in.data, ssn->clean_in.used);
442 record_minus(&ssn->clean_in, NULL, written);
444 /* Get the dirty data from Bio to send it */
445 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
446 sizeof(ssn->dirty_out.data));
448 ssn->dirty_out.used = err;
450 int_ssl_check(request, ssn->ssl, err, "handshake_send");
457 void session_init(tls_session_t *ssn)
460 ssn->into_ssl = ssn->from_ssl = NULL;
461 record_init(&ssn->clean_in);
462 record_init(&ssn->clean_out);
463 record_init(&ssn->dirty_in);
464 record_init(&ssn->dirty_out);
466 memset(&ssn->info, 0, sizeof(ssn->info));
470 ssn->tls_msg_len = 0;
471 ssn->length_flag = 0;
473 ssn->free_opaque = NULL;
476 void session_close(tls_session_t *ssn)
478 SSL_set_quiet_shutdown(ssn->ssl, 1);
479 SSL_shutdown(ssn->ssl);
486 record_close(&ssn->clean_in);
487 record_close(&ssn->clean_out);
488 record_close(&ssn->dirty_in);
489 record_close(&ssn->dirty_out);
493 void session_free(void *ssn)
495 tls_session_t *sess = (tls_session_t *)ssn;
500 * Free any opaque TTLS or PEAP data.
502 if ((sess->opaque) && (sess->free_opaque)) {
503 sess->free_opaque(sess->opaque);
512 static void record_init(record_t *rec)
517 static void record_close(record_t *rec)
524 * Copy data to the intermediate buffer, before we send
527 static unsigned int record_plus(record_t *rec, void const *ptr,
530 unsigned int added = MAX_RECORD_SIZE - rec->used;
536 memcpy(rec->data + rec->used, ptr, added);
542 * Take data from the buffer, and give it to the caller.
544 static unsigned int record_minus(record_t *rec, void *ptr,
547 unsigned int taken = rec->used;
554 memcpy(ptr, rec->data, taken);
558 * This is pretty bad...
561 memmove(rec->data, rec->data + taken, rec->used);
565 void tls_session_information(tls_session_t *tls_session)
567 char const *str_write_p, *str_version, *str_content_type = "";
568 char const *str_details1 = "", *str_details2= "";
572 * Don't print this out in the normal course of
575 if (debug_flag == 0) {
579 str_write_p = tls_session->info.origin ? ">>>" : "<<<";
581 switch (tls_session->info.version) {
583 str_version = "SSL 2.0";
586 str_version = "SSL 3.0 ";
589 str_version = "TLS 1.0 ";
592 str_version = "Unknown TLS version";
596 if (tls_session->info.version == SSL3_VERSION ||
597 tls_session->info.version == TLS1_VERSION) {
598 switch (tls_session->info.content_type) {
599 case SSL3_RT_CHANGE_CIPHER_SPEC:
600 str_content_type = "ChangeCipherSpec";
603 str_content_type = "Alert";
605 case SSL3_RT_HANDSHAKE:
606 str_content_type = "Handshake";
608 case SSL3_RT_APPLICATION_DATA:
609 str_content_type = "ApplicationData";
612 str_content_type = "UnknownContentType";
616 if (tls_session->info.content_type == SSL3_RT_ALERT) {
617 str_details1 = ", ???";
619 if (tls_session->info.record_len == 2) {
621 switch (tls_session->info.alert_level) {
622 case SSL3_AL_WARNING:
623 str_details1 = ", warning";
626 str_details1 = ", fatal";
630 str_details2 = " ???";
631 switch (tls_session->info.alert_description) {
632 case SSL3_AD_CLOSE_NOTIFY:
633 str_details2 = " close_notify";
635 case SSL3_AD_UNEXPECTED_MESSAGE:
636 str_details2 = " unexpected_message";
638 case SSL3_AD_BAD_RECORD_MAC:
639 str_details2 = " bad_record_mac";
641 case TLS1_AD_DECRYPTION_FAILED:
642 str_details2 = " decryption_failed";
644 case TLS1_AD_RECORD_OVERFLOW:
645 str_details2 = " record_overflow";
647 case SSL3_AD_DECOMPRESSION_FAILURE:
648 str_details2 = " decompression_failure";
650 case SSL3_AD_HANDSHAKE_FAILURE:
651 str_details2 = " handshake_failure";
653 case SSL3_AD_BAD_CERTIFICATE:
654 str_details2 = " bad_certificate";
656 case SSL3_AD_UNSUPPORTED_CERTIFICATE:
657 str_details2 = " unsupported_certificate";
659 case SSL3_AD_CERTIFICATE_REVOKED:
660 str_details2 = " certificate_revoked";
662 case SSL3_AD_CERTIFICATE_EXPIRED:
663 str_details2 = " certificate_expired";
665 case SSL3_AD_CERTIFICATE_UNKNOWN:
666 str_details2 = " certificate_unknown";
668 case SSL3_AD_ILLEGAL_PARAMETER:
669 str_details2 = " illegal_parameter";
671 case TLS1_AD_UNKNOWN_CA:
672 str_details2 = " unknown_ca";
674 case TLS1_AD_ACCESS_DENIED:
675 str_details2 = " access_denied";
677 case TLS1_AD_DECODE_ERROR:
678 str_details2 = " decode_error";
680 case TLS1_AD_DECRYPT_ERROR:
681 str_details2 = " decrypt_error";
683 case TLS1_AD_EXPORT_RESTRICTION:
684 str_details2 = " export_restriction";
686 case TLS1_AD_PROTOCOL_VERSION:
687 str_details2 = " protocol_version";
689 case TLS1_AD_INSUFFICIENT_SECURITY:
690 str_details2 = " insufficient_security";
692 case TLS1_AD_INTERNAL_ERROR:
693 str_details2 = " internal_error";
695 case TLS1_AD_USER_CANCELLED:
696 str_details2 = " user_canceled";
698 case TLS1_AD_NO_RENEGOTIATION:
699 str_details2 = " no_renegotiation";
705 if (tls_session->info.content_type == SSL3_RT_HANDSHAKE) {
706 str_details1 = "???";
708 if (tls_session->info.record_len > 0)
709 switch (tls_session->info.handshake_type) {
710 case SSL3_MT_HELLO_REQUEST:
711 str_details1 = ", HelloRequest";
713 case SSL3_MT_CLIENT_HELLO:
714 str_details1 = ", ClientHello";
716 case SSL3_MT_SERVER_HELLO:
717 str_details1 = ", ServerHello";
719 case SSL3_MT_CERTIFICATE:
720 str_details1 = ", Certificate";
722 case SSL3_MT_SERVER_KEY_EXCHANGE:
723 str_details1 = ", ServerKeyExchange";
725 case SSL3_MT_CERTIFICATE_REQUEST:
726 str_details1 = ", CertificateRequest";
728 case SSL3_MT_SERVER_DONE:
729 str_details1 = ", ServerHelloDone";
731 case SSL3_MT_CERTIFICATE_VERIFY:
732 str_details1 = ", CertificateVerify";
734 case SSL3_MT_CLIENT_KEY_EXCHANGE:
735 str_details1 = ", ClientKeyExchange";
737 case SSL3_MT_FINISHED:
738 str_details1 = ", Finished";
744 snprintf(tls_session->info.info_description,
745 sizeof(tls_session->info.info_description),
746 "%s %s%s [length %04lx]%s%s\n",
747 str_write_p, str_version, str_content_type,
748 (unsigned long)tls_session->info.record_len,
749 str_details1, str_details2);
751 request = SSL_get_ex_data(tls_session->ssl, FR_TLS_EX_INDEX_REQUEST);
753 RDEBUG2("%s\n", tls_session->info.info_description);
756 static CONF_PARSER cache_config[] = {
757 { "enable", PW_TYPE_BOOLEAN,
758 offsetof(fr_tls_server_conf_t, session_cache_enable), NULL, "no" },
759 { "lifetime", PW_TYPE_INTEGER,
760 offsetof(fr_tls_server_conf_t, session_timeout), NULL, "24" },
761 { "max_entries", PW_TYPE_INTEGER,
762 offsetof(fr_tls_server_conf_t, session_cache_size), NULL, "255" },
763 { "name", PW_TYPE_STRING_PTR,
764 offsetof(fr_tls_server_conf_t, session_id_name), NULL, NULL},
765 { "persist_dir", PW_TYPE_STRING_PTR,
766 offsetof(fr_tls_server_conf_t, session_cache_path), NULL, NULL},
767 { NULL, -1, 0, NULL, NULL } /* end the list */
770 static CONF_PARSER verify_config[] = {
771 { "tmpdir", PW_TYPE_STRING_PTR,
772 offsetof(fr_tls_server_conf_t, verify_tmp_dir), NULL, NULL},
773 { "client", PW_TYPE_STRING_PTR,
774 offsetof(fr_tls_server_conf_t, verify_client_cert_cmd), NULL, NULL},
775 { NULL, -1, 0, NULL, NULL } /* end the list */
778 #ifdef HAVE_OPENSSL_OCSP_H
779 static CONF_PARSER ocsp_config[] = {
780 { "enable", PW_TYPE_BOOLEAN,
781 offsetof(fr_tls_server_conf_t, ocsp_enable), NULL, "no"},
782 { "override_cert_url", PW_TYPE_BOOLEAN,
783 offsetof(fr_tls_server_conf_t, ocsp_override_url), NULL, "no"},
784 { "url", PW_TYPE_STRING_PTR,
785 offsetof(fr_tls_server_conf_t, ocsp_url), NULL, NULL },
786 { "use_nonce", PW_TYPE_BOOLEAN,
787 offsetof(fr_tls_server_conf_t, ocsp_use_nonce), NULL, "yes"},
788 { "timeout", PW_TYPE_INTEGER,
789 offsetof(fr_tls_server_conf_t, ocsp_timeout), NULL, "yes"},
790 { "softfail", PW_TYPE_BOOLEAN,
791 offsetof(fr_tls_server_conf_t, ocsp_softfail), NULL, "yes"},
792 { NULL, -1, 0, NULL, NULL } /* end the list */
796 static CONF_PARSER tls_server_config[] = {
797 { "rsa_key_exchange", PW_TYPE_BOOLEAN,
798 offsetof(fr_tls_server_conf_t, rsa_key), NULL, "no" },
799 { "dh_key_exchange", PW_TYPE_BOOLEAN,
800 offsetof(fr_tls_server_conf_t, dh_key), NULL, "yes" },
801 { "rsa_key_length", PW_TYPE_INTEGER,
802 offsetof(fr_tls_server_conf_t, rsa_key_length), NULL, "512" },
803 { "dh_key_length", PW_TYPE_INTEGER,
804 offsetof(fr_tls_server_conf_t, dh_key_length), NULL, "512" },
805 { "verify_depth", PW_TYPE_INTEGER,
806 offsetof(fr_tls_server_conf_t, verify_depth), NULL, "0" },
807 { "CA_path", PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED,
808 offsetof(fr_tls_server_conf_t, ca_path), NULL, NULL },
809 { "ca_path", PW_TYPE_FILE_INPUT,
810 offsetof(fr_tls_server_conf_t, ca_path), NULL, NULL },
811 { "pem_file_type", PW_TYPE_BOOLEAN,
812 offsetof(fr_tls_server_conf_t, file_type), NULL, "yes" },
813 { "private_key_file", PW_TYPE_FILE_INPUT,
814 offsetof(fr_tls_server_conf_t, private_key_file), NULL, NULL },
815 { "certificate_file", PW_TYPE_FILE_INPUT,
816 offsetof(fr_tls_server_conf_t, certificate_file), NULL, NULL },
817 { "CA_file", PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED,
818 offsetof(fr_tls_server_conf_t, ca_file), NULL, NULL },
819 { "ca_file", PW_TYPE_FILE_INPUT,
820 offsetof(fr_tls_server_conf_t, ca_file), NULL, NULL },
821 { "private_key_password", PW_TYPE_STRING_PTR | PW_TYPE_SECRET,
822 offsetof(fr_tls_server_conf_t, private_key_password), NULL, NULL },
823 #ifdef PSK_MAX_IDENTITY_LEN
824 { "psk_identity", PW_TYPE_STRING_PTR,
825 offsetof(fr_tls_server_conf_t, psk_identity), NULL, NULL },
826 { "psk_hexphrase", PW_TYPE_STRING_PTR | PW_TYPE_SECRET,
827 offsetof(fr_tls_server_conf_t, psk_password), NULL, NULL },
829 { "dh_file", PW_TYPE_STRING_PTR,
830 offsetof(fr_tls_server_conf_t, dh_file), NULL, NULL },
831 { "random_file", PW_TYPE_STRING_PTR,
832 offsetof(fr_tls_server_conf_t, random_file), NULL, NULL },
833 { "fragment_size", PW_TYPE_INTEGER,
834 offsetof(fr_tls_server_conf_t, fragment_size), NULL, "1024" },
835 { "include_length", PW_TYPE_BOOLEAN,
836 offsetof(fr_tls_server_conf_t, include_length), NULL, "yes" },
837 { "check_crl", PW_TYPE_BOOLEAN,
838 offsetof(fr_tls_server_conf_t, check_crl), NULL, "no"},
839 { "allow_expired_crl", PW_TYPE_BOOLEAN,
840 offsetof(fr_tls_server_conf_t, allow_expired_crl), NULL, NULL},
841 { "check_cert_cn", PW_TYPE_STRING_PTR,
842 offsetof(fr_tls_server_conf_t, check_cert_cn), NULL, NULL},
843 { "cipher_list", PW_TYPE_STRING_PTR,
844 offsetof(fr_tls_server_conf_t, cipher_list), NULL, NULL},
845 { "check_cert_issuer", PW_TYPE_STRING_PTR,
846 offsetof(fr_tls_server_conf_t, check_cert_issuer), NULL, NULL},
847 { "require_client_cert", PW_TYPE_BOOLEAN,
848 offsetof(fr_tls_server_conf_t, require_client_cert), NULL, NULL },
850 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
851 #ifndef OPENSSL_NO_ECDH
852 { "ecdh_curve", PW_TYPE_STRING_PTR,
853 offsetof(fr_tls_server_conf_t, ecdh_curve), NULL, "prime256v1"},
857 { "cache", PW_TYPE_SUBSECTION, 0, NULL, (void const *) cache_config },
859 { "verify", PW_TYPE_SUBSECTION, 0, NULL, (void const *) verify_config },
861 #ifdef HAVE_OPENSSL_OCSP_H
862 { "ocsp", PW_TYPE_SUBSECTION, 0, NULL, (void const *) ocsp_config },
865 { NULL, -1, 0, NULL, NULL } /* end the list */
869 static CONF_PARSER tls_client_config[] = {
870 { "rsa_key_exchange", PW_TYPE_BOOLEAN,
871 offsetof(fr_tls_server_conf_t, rsa_key), NULL, "no" },
872 { "dh_key_exchange", PW_TYPE_BOOLEAN,
873 offsetof(fr_tls_server_conf_t, dh_key), NULL, "yes" },
874 { "rsa_key_length", PW_TYPE_INTEGER,
875 offsetof(fr_tls_server_conf_t, rsa_key_length), NULL, "512" },
876 { "dh_key_length", PW_TYPE_INTEGER,
877 offsetof(fr_tls_server_conf_t, dh_key_length), NULL, "512" },
878 { "verify_depth", PW_TYPE_INTEGER,
879 offsetof(fr_tls_server_conf_t, verify_depth), NULL, "0" },
880 { "ca_path", PW_TYPE_FILE_INPUT,
881 offsetof(fr_tls_server_conf_t, ca_path), NULL, NULL },
882 { "pem_file_type", PW_TYPE_BOOLEAN,
883 offsetof(fr_tls_server_conf_t, file_type), NULL, "yes" },
884 { "private_key_file", PW_TYPE_FILE_INPUT,
885 offsetof(fr_tls_server_conf_t, private_key_file), NULL, NULL },
886 { "certificate_file", PW_TYPE_FILE_INPUT,
887 offsetof(fr_tls_server_conf_t, certificate_file), NULL, NULL },
888 { "ca_file", PW_TYPE_FILE_INPUT,
889 offsetof(fr_tls_server_conf_t, ca_file), NULL, NULL },
890 { "private_key_password", PW_TYPE_STRING_PTR | PW_TYPE_SECRET,
891 offsetof(fr_tls_server_conf_t, private_key_password), NULL, NULL },
892 { "dh_file", PW_TYPE_STRING_PTR,
893 offsetof(fr_tls_server_conf_t, dh_file), NULL, NULL },
894 { "random_file", PW_TYPE_STRING_PTR,
895 offsetof(fr_tls_server_conf_t, random_file), NULL, NULL },
896 { "fragment_size", PW_TYPE_INTEGER,
897 offsetof(fr_tls_server_conf_t, fragment_size), NULL, "1024" },
898 { "include_length", PW_TYPE_BOOLEAN,
899 offsetof(fr_tls_server_conf_t, include_length), NULL, "yes" },
900 { "check_crl", PW_TYPE_BOOLEAN,
901 offsetof(fr_tls_server_conf_t, check_crl), NULL, "no"},
902 { "check_cert_cn", PW_TYPE_STRING_PTR,
903 offsetof(fr_tls_server_conf_t, check_cert_cn), NULL, NULL},
904 { "cipher_list", PW_TYPE_STRING_PTR,
905 offsetof(fr_tls_server_conf_t, cipher_list), NULL, NULL},
906 { "check_cert_issuer", PW_TYPE_STRING_PTR,
907 offsetof(fr_tls_server_conf_t, check_cert_issuer), NULL, NULL},
909 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
910 #ifndef OPENSSL_NO_ECDH
911 { "ecdh_curve", PW_TYPE_STRING_PTR,
912 offsetof(fr_tls_server_conf_t, ecdh_curve), NULL, "prime256v1"},
916 { NULL, -1, 0, NULL, NULL } /* end the list */
921 * TODO: Check for the type of key exchange * like conf->dh_key
923 static int load_dh_params(SSL_CTX *ctx, char *file)
930 if ((bio = BIO_new_file(file, "r")) == NULL) {
931 ERROR("tls: Unable to open DH file - %s", file);
935 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
938 WDEBUG2("tls: Unable to set DH parameters. DH cipher suites may not work!");
939 WDEBUG2("Fix this by running the OpenSSL command listed in eap.conf");
943 if (SSL_CTX_set_tmp_dh(ctx, dh) < 0) {
944 ERROR("tls: Unable to set DH parameters");
955 * Generate ephemeral RSA keys.
957 static int generate_eph_rsa_key(SSL_CTX *ctx)
961 rsa = RSA_generate_key(512, RSA_F4, NULL, NULL);
963 if (!SSL_CTX_set_tmp_rsa(ctx, rsa)) {
964 ERROR("tls: Couldn't set ephemeral RSA key");
972 /* index we use to store cached session VPs
973 * needs to be dynamic so we can supply a "free" function
975 static int FR_TLS_EX_INDEX_VPS = -1;
978 * Print debugging messages, and free data.
980 * FIXME: Write sessions to some long-term storage, so that
981 * session resumption can still occur after the server
984 #define MAX_SESSION_SIZE (256)
986 static void cbtls_remove_session(SSL_CTX *ctx, SSL_SESSION *sess)
989 char buffer[2 * MAX_SESSION_SIZE + 1];
990 fr_tls_server_conf_t *conf;
992 size = sess->session_id_length;
993 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
995 fr_bin2hex(buffer, sess->session_id, size);
997 DEBUG2(" SSL: Removing session %s from the cache", buffer);
998 conf = (fr_tls_server_conf_t *)SSL_CTX_get_app_data(ctx);
999 if (conf && conf->session_cache_path) {
1003 /* remove session and any cached VPs */
1004 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1005 conf->session_cache_path, FR_DIR_SEP, buffer);
1006 rv = unlink(filename);
1008 DEBUG2(" SSL: could not remove persisted session file %s: %s", filename, fr_syserror(errno));
1010 /* VPs might be absent; might not have been written to disk yet */
1011 snprintf(filename, sizeof(filename), "%s%c%s.vps",
1012 conf->session_cache_path, FR_DIR_SEP, buffer);
1019 static int cbtls_new_session(SSL *ssl, SSL_SESSION *sess)
1022 char buffer[2 * MAX_SESSION_SIZE + 1];
1023 fr_tls_server_conf_t *conf;
1024 unsigned char *sess_blob = NULL;
1026 size = sess->session_id_length;
1027 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1029 fr_bin2hex(buffer, sess->session_id, size);
1031 DEBUG2(" SSL: adding session %s to cache", buffer);
1033 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1034 if (conf && conf->session_cache_path) {
1035 int fd, rv, todo, blob_len;
1039 /* find out what length data we need */
1040 blob_len = i2d_SSL_SESSION(sess, NULL);
1042 /* something went wrong */
1043 DEBUG2(" SSL: could not find buffer length to persist session");
1047 /* alloc and convert to ASN.1 */
1048 sess_blob = talloc_array(conf, unsigned char, blob_len);
1050 DEBUG2(" SSL: could not allocate buffer len=%d to persist session", blob_len);
1053 /* openssl mutates &p */
1055 rv = i2d_SSL_SESSION(sess, &p);
1056 if (rv != blob_len) {
1057 DEBUG2(" SSL: could not persist session");
1061 /* open output file */
1062 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1063 conf->session_cache_path, FR_DIR_SEP, buffer);
1064 fd = open(filename, O_RDWR|O_CREAT|O_EXCL, 0600);
1066 DEBUG2(" SSL: could not open session file %s: %s", filename, fr_syserror(errno));
1073 rv = write(fd, p, todo);
1075 DEBUG2(" SSL: failed writing session: %s", fr_syserror(errno));
1083 DEBUG2(" SSL: wrote session %s to %s len=%d", buffer, filename, blob_len);
1087 if (sess_blob) talloc_free(sess_blob);
1092 static SSL_SESSION *cbtls_get_session(SSL *ssl,
1093 unsigned char *data, int len,
1097 char buffer[2 * MAX_SESSION_SIZE + 1];
1098 fr_tls_server_conf_t *conf;
1100 SSL_SESSION *sess = NULL;
1101 unsigned char *sess_data = NULL;
1102 PAIR_LIST *pairlist = NULL;
1105 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1107 fr_bin2hex(buffer, data, size);
1109 DEBUG2(" SSL: Client requested cached session %s", buffer);
1111 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1112 if (conf && conf->session_cache_path) {
1119 /* read in the cached VPs from the .vps file */
1120 snprintf(filename, sizeof(filename), "%s%c%s.vps",
1121 conf->session_cache_path, FR_DIR_SEP, buffer);
1122 rv = pairlist_read(NULL, filename, &pairlist, 1);
1124 /* not safe to un-persist a session w/o VPs */
1125 DEBUG2(" SSL: could not load persisted VPs for session %s", buffer);
1129 /* load the actual SSL session */
1130 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1131 conf->session_cache_path, FR_DIR_SEP, buffer);
1132 fd = open(filename, O_RDONLY);
1134 DEBUG2(" SSL: could not find persisted session file %s: %s", filename, fr_syserror(errno));
1138 rv = fstat(fd, &st);
1140 DEBUG2(" SSL: could not stat persisted session file %s: %s", filename, fr_syserror(errno));
1145 sess_data = talloc_array(NULL, unsigned char, st.st_size);
1147 DEBUG2(" SSL: could not alloc buffer for persisted session len=%d", (int) st.st_size);
1155 rv = read(fd, p, todo);
1157 DEBUG2(" SSL: could not read from persisted session: %s", fr_syserror(errno));
1166 /* openssl mutates &p */
1168 sess = d2i_SSL_SESSION(NULL, (unsigned char const **)(void **) &p, st.st_size);
1171 DEBUG2(" SSL: OpenSSL failed to load persisted session: %s", ERR_error_string(ERR_get_error(), NULL));
1175 /* cache the VPs into the session */
1176 vp = paircopy(NULL, pairlist->reply);
1177 SSL_SESSION_set_ex_data(sess, FR_TLS_EX_INDEX_VPS, vp);
1178 DEBUG2(" SSL: Successfully restored session %s", buffer);
1181 if (sess_data) talloc_free(sess_data);
1182 if (pairlist) pairlist_free(&pairlist);
1188 #ifdef HAVE_OPENSSL_OCSP_H
1190 * This function extracts the OCSP Responder URL
1191 * from an existing x509 certificate.
1193 static int ocsp_parse_cert_url(X509 *cert, char **phost, char **pport,
1194 char **ppath, int *pssl)
1198 AUTHORITY_INFO_ACCESS *aia;
1199 ACCESS_DESCRIPTION *ad;
1201 aia = X509_get_ext_d2i(cert, NID_info_access, NULL, NULL);
1203 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(aia); i++) {
1204 ad = sk_ACCESS_DESCRIPTION_value(aia, 0);
1205 if (OBJ_obj2nid(ad->method) == NID_ad_OCSP) {
1206 if (ad->location->type == GEN_URI) {
1207 if(OCSP_parse_url((char *) ad->location->d.ia5->data,
1208 phost, pport, ppath, pssl))
1217 * This function sends a OCSP request to a defined OCSP responder
1218 * and checks the OCSP response for correctness.
1221 /* Maximum leeway in validity period: default 5 minutes */
1222 #define MAX_VALIDITY_PERIOD (5 * 60)
1224 static int ocsp_check(X509_STORE *store, X509 *issuer_cert, X509 *client_cert,
1225 fr_tls_server_conf_t *conf)
1227 OCSP_CERTID *certid;
1229 OCSP_RESPONSE *resp = NULL;
1230 OCSP_BASICRESP *bresp = NULL;
1235 long nsec = MAX_VALIDITY_PERIOD, maxage = -1;
1236 BIO *cbio, *bio_out;
1239 ASN1_GENERALIZEDTIME *rev, *thisupd, *nextupd;
1241 #if OPENSSL_VERSION_NUMBER >= 0x1000003f
1245 struct timeval when;
1249 * Create OCSP Request
1251 certid = OCSP_cert_to_id(NULL, client_cert, issuer_cert);
1252 req = OCSP_REQUEST_new();
1253 OCSP_request_add0_id(req, certid);
1254 if(conf->ocsp_use_nonce) {
1255 OCSP_request_add1_nonce(req, NULL, 8);
1259 * Send OCSP Request and get OCSP Response
1262 /* Get OCSP responder URL */
1263 if(conf->ocsp_override_url) {
1264 OCSP_parse_url(conf->ocsp_url, &host, &port, &path, &use_ssl);
1267 ocsp_parse_cert_url(client_cert, &host, &port, &path, &use_ssl);
1270 if (!host || !port || !path) {
1271 DEBUG2("[ocsp] - Host / port / path missing. Not doing OCSP.");
1276 DEBUG2("[ocsp] --> Responder URL = http://%s:%s%s", host, port, path);
1278 /* Setup BIO socket to OCSP responder */
1279 cbio = BIO_new_connect(host);
1281 bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
1283 BIO_set_conn_port(cbio, port);
1284 #if OPENSSL_VERSION_NUMBER < 0x1000003f
1285 BIO_do_connect(cbio);
1287 /* Send OCSP request and wait for response */
1288 resp = OCSP_sendreq_bio(cbio, path, req);
1290 ERROR("Couldn't get OCSP response");
1295 if (conf->ocsp_timeout)
1296 BIO_set_nbio(cbio, 1);
1298 rc = BIO_do_connect(cbio);
1299 if ((rc <= 0) && ((!conf->ocsp_timeout) || !BIO_should_retry(cbio))) {
1300 ERROR("Couldn't connect to OCSP responder");
1305 ctx = OCSP_sendreq_new(cbio, path, req, -1);
1307 ERROR("Couldn't send OCSP request");
1312 gettimeofday(&when, NULL);
1313 when.tv_sec += conf->ocsp_timeout;
1316 rc = OCSP_sendreq_nbio(&resp, ctx);
1317 if (conf->ocsp_timeout) {
1318 gettimeofday(&now, NULL);
1319 if (!timercmp(&now, &when, <))
1322 } while ((rc == -1) && BIO_should_retry(cbio));
1324 if (conf->ocsp_timeout && (rc == -1) && BIO_should_retry(cbio)) {
1325 ERROR("OCSP response timed out");
1330 OCSP_REQ_CTX_free(ctx);
1333 ERROR("Couldn't get OCSP response");
1339 /* Verify OCSP response status */
1340 status = OCSP_response_status(resp);
1341 DEBUG2("[ocsp] --> Response status: %s",OCSP_response_status_str(status));
1342 if(status != OCSP_RESPONSE_STATUS_SUCCESSFUL) {
1343 ERROR("OCSP response status: %s", OCSP_response_status_str(status));
1346 bresp = OCSP_response_get1_basic(resp);
1347 if(conf->ocsp_use_nonce && OCSP_check_nonce(req, bresp)!=1) {
1348 ERROR("OCSP response has wrong nonce value");
1351 if(OCSP_basic_verify(bresp, NULL, store, 0)!=1){
1352 ERROR("Couldn't verify OCSP basic response");
1356 /* Verify OCSP cert status */
1357 if(!OCSP_resp_find_status(bresp, certid, &status, &reason,
1358 &rev, &thisupd, &nextupd)) {
1359 ERROR("No Status found.\n");
1363 if (!OCSP_check_validity(thisupd, nextupd, nsec, maxage)) {
1364 BIO_puts(bio_out, "WARNING: Status times invalid.\n");
1365 ERR_print_errors(bio_out);
1368 BIO_puts(bio_out, "\tThis Update: ");
1369 ASN1_GENERALIZEDTIME_print(bio_out, thisupd);
1370 BIO_puts(bio_out, "\n");
1372 BIO_puts(bio_out, "\tNext Update: ");
1373 ASN1_GENERALIZEDTIME_print(bio_out, nextupd);
1374 BIO_puts(bio_out, "\n");
1378 case V_OCSP_CERTSTATUS_GOOD:
1379 DEBUG2("[oscp] --> Cert status: good");
1384 /* REVOKED / UNKNOWN */
1385 DEBUG2("[ocsp] --> Cert status: %s",OCSP_cert_status_str(status));
1387 DEBUG2("[ocsp] --> Reason: %s", OCSP_crl_reason_str(reason));
1388 BIO_puts(bio_out, "\tRevocation Time: ");
1389 ASN1_GENERALIZEDTIME_print(bio_out, rev);
1390 BIO_puts(bio_out, "\n");
1395 /* Free OCSP Stuff */
1396 OCSP_REQUEST_free(req);
1397 OCSP_RESPONSE_free(resp);
1402 OCSP_BASICRESP_free(bresp);
1407 DEBUG2("[ocsp] --> Certificate is valid!");
1410 if (conf->ocsp_softfail) {
1411 DEBUG2("[ocsp] --> Unable to check certificate; assuming valid.");
1412 DEBUG2("[ocsp] --> Warning! This may be insecure.");
1415 DEBUG2("[ocsp] --> Unable to check certificate; failing!");
1420 DEBUG2("[ocsp] --> Certificate has been expired/revoked!");
1426 #endif /* HAVE_OPENSSL_OCSP_H */
1429 * For creating certificate attributes.
1431 static char const *cert_attr_names[6][2] = {
1432 { "TLS-Client-Cert-Serial", "TLS-Cert-Serial" },
1433 { "TLS-Client-Cert-Expiration", "TLS-Cert-Expiration" },
1434 { "TLS-Client-Cert-Subject", "TLS-Cert-Subject" },
1435 { "TLS-Client-Cert-Issuer", "TLS-Cert-Issuer" },
1436 { "TLS-Client-Cert-Common-Name", "TLS-Cert-Common-Name" },
1437 { "TLS-Client-Cert-Subject-Alt-Name-Email", "TLS-Cert-Subject-Alt-Name-Email" }
1440 #define FR_TLS_SERIAL (0)
1441 #define FR_TLS_EXPIRATION (1)
1442 #define FR_TLS_SUBJECT (2)
1443 #define FR_TLS_ISSUER (3)
1444 #define FR_TLS_CN (4)
1445 #define FR_TLS_SAN_EMAIL (5)
1448 * Before trusting a certificate, you must make sure that the
1449 * certificate is 'valid'. There are several steps that your
1450 * application can take in determining if a certificate is
1451 * valid. Commonly used steps are:
1453 * 1.Verifying the certificate's signature, and verifying that
1454 * the certificate has been issued by a trusted Certificate
1457 * 2.Verifying that the certificate is valid for the present date
1458 * (i.e. it is being presented within its validity dates).
1460 * 3.Verifying that the certificate has not been revoked by its
1461 * issuing Certificate Authority, by checking with respect to a
1462 * Certificate Revocation List (CRL).
1464 * 4.Verifying that the credentials presented by the certificate
1465 * fulfill additional requirements specific to the application,
1466 * such as with respect to access control lists or with respect
1467 * to OCSP (Online Certificate Status Processing).
1469 * NOTE: This callback will be called multiple times based on the
1470 * depth of the root certificate chain
1472 int cbtls_verify(int ok, X509_STORE_CTX *ctx)
1474 char subject[1024]; /* Used for the subject name */
1475 char issuer[1024]; /* Used for the issuer name */
1476 char attribute[1024];
1478 char common_name[1024];
1482 X509_CINF *client_inf;
1483 STACK_OF(X509_EXTENSION) *ext_list;
1485 int err, depth, lookup, loc;
1486 fr_tls_server_conf_t *conf;
1489 ASN1_INTEGER *sn = NULL;
1490 ASN1_TIME *asn_time = NULL;
1493 #ifdef HAVE_OPENSSL_OCSP_H
1494 X509_STORE *ocsp_store = NULL;
1498 client_cert = X509_STORE_CTX_get_current_cert(ctx);
1499 err = X509_STORE_CTX_get_error(ctx);
1500 depth = X509_STORE_CTX_get_error_depth(ctx);
1505 * Log client/issuing cert. If there's an error, log
1508 if ((lookup > 1) && !my_ok) lookup = 1;
1511 * Retrieve the pointer to the SSL of the connection currently treated
1512 * and the application specific data stored into the SSL object.
1514 ssl = X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
1515 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1516 if (!conf) return 1;
1518 request = (REQUEST *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_REQUEST);
1520 if (!request) return 1; /* FIXME: outbound TLS */
1522 rad_assert(request != NULL);
1523 certs = (VALUE_PAIR **)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CERTS);
1524 rad_assert(certs != NULL);
1525 identity = (char **)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_IDENTITY);
1526 #ifdef HAVE_OPENSSL_OCSP_H
1527 ocsp_store = (X509_STORE *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_STORE);
1531 * Get the Serial Number
1534 sn = X509_get_serialNumber(client_cert);
1537 * For this next bit, we create the attributes *only* if
1538 * we're at the client or issuing certificate, AND we
1539 * have a user identity. i.e. we don't create the
1540 * attributes for RadSec connections.
1543 (lookup <= 1) && sn && ((size_t) sn->length < (sizeof(buf) / 2))) {
1547 for (i = 0; i < sn->length; i++) {
1548 sprintf(p, "%02x", (unsigned int)sn->data[i]);
1551 pairmake(NULL, certs, cert_attr_names[FR_TLS_SERIAL][lookup], buf, T_OP_SET);
1556 * Get the Expiration Date
1559 asn_time = X509_get_notAfter(client_cert);
1560 if (identity && (lookup <= 1) && asn_time &&
1561 (asn_time->length < (int) sizeof(buf))) {
1562 memcpy(buf, (char*) asn_time->data, asn_time->length);
1563 buf[asn_time->length] = '\0';
1564 pairmake(NULL, certs, cert_attr_names[FR_TLS_EXPIRATION][lookup], buf, T_OP_SET);
1568 * Get the Subject & Issuer
1570 subject[0] = issuer[0] = '\0';
1571 X509_NAME_oneline(X509_get_subject_name(client_cert), subject,
1573 subject[sizeof(subject) - 1] = '\0';
1574 if (identity && (lookup <= 1) && subject[0]) {
1575 pairmake(NULL, certs, cert_attr_names[FR_TLS_SUBJECT][lookup], subject, T_OP_SET);
1578 X509_NAME_oneline(X509_get_issuer_name(ctx->current_cert), issuer,
1580 issuer[sizeof(issuer) - 1] = '\0';
1581 if (identity && (lookup <= 1) && issuer[0]) {
1582 pairmake(NULL, certs, cert_attr_names[FR_TLS_ISSUER][lookup], issuer, T_OP_SET);
1586 * Get the Common Name, if there is a subject.
1588 X509_NAME_get_text_by_NID(X509_get_subject_name(client_cert),
1589 NID_commonName, common_name, sizeof(common_name));
1590 common_name[sizeof(common_name) - 1] = '\0';
1591 if (identity && (lookup <= 1) && common_name[0] && subject[0]) {
1592 pairmake(NULL, certs, cert_attr_names[FR_TLS_CN][lookup], common_name, T_OP_SET);
1597 * Get the RFC822 Subject Alternative Name
1599 loc = X509_get_ext_by_NID(client_cert, NID_subject_alt_name, 0);
1600 if (lookup <= 1 && loc >= 0) {
1601 X509_EXTENSION *ext = NULL;
1602 GENERAL_NAMES *names = NULL;
1605 if ((ext = X509_get_ext(client_cert, loc)) &&
1606 (names = X509V3_EXT_d2i(ext))) {
1607 for (i = 0; i < sk_GENERAL_NAME_num(names); i++) {
1608 GENERAL_NAME *name = sk_GENERAL_NAME_value(names, i);
1610 switch (name->type) {
1612 pairmake(NULL, certs, cert_attr_names[FR_TLS_SAN_EMAIL][lookup],
1613 (char *) ASN1_STRING_data(name->d.rfc822Name), T_OP_SET);
1616 /* XXX TODO handle other SAN types */
1622 sk_GENERAL_NAME_free(names);
1624 #endif /* GEN_EMAIL */
1627 * If the CRL has expired, that might still be OK.
1630 (conf->allow_expired_crl) &&
1631 (err == X509_V_ERR_CRL_HAS_EXPIRED)) {
1633 X509_STORE_CTX_set_error( ctx, 0 );
1637 char const *p = X509_verify_cert_error_string(err);
1638 ERROR("--> verify error:num=%d:%s\n",err, p);
1639 REDEBUG("SSL says error %d : %s", err, p);
1644 client_inf = client_cert->cert_info;
1645 ext_list = client_inf->extensions;
1651 * Grab the X509 extensions, and create attributes out of them.
1652 * For laziness, we re-use the OpenSSL names
1654 if (sk_X509_EXTENSION_num(ext_list) > 0) {
1659 out = BIO_new(BIO_s_mem());
1660 strlcpy(attribute, "TLS-Client-Cert-", sizeof(attribute));
1662 for (i = 0; i < sk_X509_EXTENSION_num(ext_list); i++) {
1664 X509_EXTENSION *ext;
1667 ext = sk_X509_EXTENSION_value(ext_list, i);
1669 obj = X509_EXTENSION_get_object(ext);
1670 i2a_ASN1_OBJECT(out, obj);
1671 len = BIO_read(out, attribute + 16 , sizeof(attribute) - 16 - 1);
1672 if (len <= 0) continue;
1674 attribute[16 + len] = '\0';
1676 X509V3_EXT_print(out, ext, 0, 0);
1677 len = BIO_read(out, value , sizeof(value) - 1);
1678 if (len <= 0) continue;
1683 * Mash the OpenSSL name to our name, and
1684 * create the attribute.
1686 for (p = value + 16; *p != '\0'; p++) {
1687 if (*p == ' ') *p = '-';
1690 vp = pairmake(NULL, certs, attribute, value, T_OP_ADD);
1691 if (vp) debug_pair_list(vp);
1697 switch (ctx->error) {
1699 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
1700 ERROR("issuer= %s\n", issuer);
1702 case X509_V_ERR_CERT_NOT_YET_VALID:
1703 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
1704 ERROR("notBefore=");
1706 ASN1_TIME_print(bio_err, X509_get_notBefore(ctx->current_cert));
1709 case X509_V_ERR_CERT_HAS_EXPIRED:
1710 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
1713 ASN1_TIME_print(bio_err, X509_get_notAfter(ctx->current_cert));
1719 * If we're at the actual client cert, apply additional
1724 * If the conf tells us to, check cert issuer
1725 * against the specified value and fail
1726 * verification if they don't match.
1728 if (conf->check_cert_issuer &&
1729 (strcmp(issuer, conf->check_cert_issuer) != 0)) {
1730 AUTH("tls: Certificate issuer (%s) does not match specified value (%s)!", issuer, conf->check_cert_issuer);
1735 * If the conf tells us to, check the CN in the
1736 * cert against xlat'ed value, but only if the
1737 * previous checks passed.
1739 if (my_ok && conf->check_cert_cn) {
1740 if (radius_xlat(cn_str, sizeof(cn_str), request, conf->check_cert_cn, NULL, NULL) < 0) {
1741 /* if this fails, fail the verification */
1744 RDEBUG2("checking certificate CN (%s) with xlat'ed value (%s)", common_name, cn_str);
1745 if (strcmp(cn_str, common_name) != 0) {
1746 AUTH("tls: Certificate CN (%s) does not match specified value (%s)!", common_name, cn_str);
1750 } /* check_cert_cn */
1752 #ifdef HAVE_OPENSSL_OCSP_H
1753 if (my_ok && conf->ocsp_enable){
1754 RDEBUG2("--> Starting OCSP Request");
1755 if(X509_STORE_CTX_get1_issuer(&issuer_cert, ctx, client_cert)!=1) {
1756 ERROR("Couldn't get issuer_cert for %s", common_name);
1758 my_ok = ocsp_check(ocsp_store, issuer_cert, client_cert, conf);
1762 while (conf->verify_client_cert_cmd) {
1767 snprintf(filename, sizeof(filename), "%s/%s.client.XXXXXXXX",
1768 conf->verify_tmp_dir, progname);
1769 fd = mkstemp(filename);
1771 RDEBUG("Failed creating file in %s: %s",
1772 conf->verify_tmp_dir, fr_syserror(errno));
1776 fp = fdopen(fd, "w");
1778 RDEBUG("Failed opening file %s: %s",
1779 filename, fr_syserror(errno));
1783 if (!PEM_write_X509(fp, client_cert)) {
1785 RDEBUG("Failed writing certificate to file");
1790 if (!pairmake_packet("TLS-Client-Cert-Filename",
1791 filename, T_OP_SET)) {
1792 RDEBUG("Failed creating TLS-Client-Cert-Filename");
1797 RDEBUG("Verifying client certificate: %s", conf->verify_client_cert_cmd);
1798 if (radius_exec_program(request, conf->verify_client_cert_cmd, true, true, NULL, 0,
1799 EXEC_TIMEOUT, request->packet->vps, NULL) != 0) {
1800 AUTH("tls: Certificate CN (%s) fails external verification!", common_name);
1803 RDEBUG("Client certificate CN %s passed external validation", common_name);
1814 if (debug_flag > 0) {
1815 RDEBUG2("chain-depth=%d, ", depth);
1816 RDEBUG2("error=%d", err);
1818 if (identity) RDEBUG2("--> User-Name = %s", *identity);
1819 RDEBUG2("--> BUF-Name = %s", common_name);
1820 RDEBUG2("--> subject = %s", subject);
1821 RDEBUG2("--> issuer = %s", issuer);
1822 RDEBUG2("--> verify return:%d", my_ok);
1828 #ifdef HAVE_OPENSSL_OCSP_H
1830 * Create Global X509 revocation store and use it to verify
1833 * - Load the trusted CAs
1834 * - Load the trusted issuer certificates
1836 static X509_STORE *init_revocation_store(fr_tls_server_conf_t *conf)
1838 X509_STORE *store = NULL;
1840 store = X509_STORE_new();
1842 /* Load the CAs we trust */
1843 if (conf->ca_file || conf->ca_path)
1844 if(!X509_STORE_load_locations(store, conf->ca_file, conf->ca_path)) {
1845 ERROR("tls: X509_STORE error %s", ERR_error_string(ERR_get_error(), NULL));
1846 ERROR("tls: Error reading Trusted root CA list %s",conf->ca_file );
1850 #ifdef X509_V_FLAG_CRL_CHECK
1851 if (conf->check_crl)
1852 X509_STORE_set_flags(store, X509_V_FLAG_CRL_CHECK);
1856 #endif /* HAVE_OPENSSL_OCSP_H */
1858 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
1859 #ifndef OPENSSL_NO_ECDH
1860 static int set_ecdh_curve(SSL_CTX *ctx, char const *ecdh_curve)
1865 if (!ecdh_curve || !*ecdh_curve) return 0;
1867 nid = OBJ_sn2nid(ecdh_curve);
1869 ERROR("Unknown ecdh_curve \"%s\"", ecdh_curve);
1873 ecdh = EC_KEY_new_by_curve_name(nid);
1875 ERROR("Unable to create new curve \"%s\"", ecdh_curve);
1879 SSL_CTX_set_tmp_ecdh(ctx, ecdh);
1881 SSL_CTX_set_options(ctx, SSL_OP_SINGLE_ECDH_USE);
1891 * DIE OPENSSL DIE DIE DIE
1893 * What a palaver, just to free some data attached the
1894 * session. We need to do this because the "remove" callback
1895 * is called when refcount > 0 sometimes, if another thread
1896 * is using the session
1898 static void sess_free_vps(UNUSED void *parent, void *data_ptr,
1899 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
1900 UNUSED long argl, UNUSED void *argp)
1902 VALUE_PAIR *vp = data_ptr;
1905 DEBUG2(" Freeing cached session VPs %p", vp);
1911 * Add all the default ciphers and message digests
1912 * Create our context.
1914 * This should be called exactly once from main.
1916 void tls_global_init(void)
1918 SSL_load_error_strings(); /* readable error messages (examples show call before library_init) */
1919 SSL_library_init(); /* initialize library */
1920 #ifdef HAVE_OPENSSL_EVP_H
1921 OpenSSL_add_all_algorithms(); /* required for SHA2 in OpenSSL < 0.9.8o and 1.0.0.a */
1926 * Create Global context SSL and use it in every new session
1928 * - Load the trusted CAs
1929 * - Load the Private key & the certificate
1930 * - Set the Context options & Verify options
1932 static SSL_CTX *init_tls_ctx(fr_tls_server_conf_t *conf, int client)
1935 X509_STORE *certstore;
1936 int verify_mode = SSL_VERIFY_NONE;
1937 int ctx_options = 0;
1941 * SHA256 is in all versions of OpenSSL, but isn't
1942 * initialized by default. It's needed for WiMAX
1945 #ifdef HAVE_OPENSSL_EVP_SHA256
1946 EVP_add_digest(EVP_sha256());
1949 ctx = SSL_CTX_new(TLSv1_method());
1952 * Save the config on the context so that callbacks which
1953 * only get SSL_CTX* e.g. session persistence, can get it
1955 SSL_CTX_set_app_data(ctx, conf);
1958 * Identify the type of certificates that needs to be loaded
1960 if (conf->file_type) {
1961 type = SSL_FILETYPE_PEM;
1963 type = SSL_FILETYPE_ASN1;
1967 * Set the password to load private key
1969 if (conf->private_key_password) {
1972 * We don't want to put the private key password in eap.conf, so check
1973 * for our special string which indicates we should get the password
1976 char const* special_string = "Apple:UseCertAdmin";
1977 if (strncmp(conf->private_key_password,
1979 strlen(special_string)) == 0)
1982 long const max_password_len = 128;
1983 snprintf(cmd, sizeof(cmd) - 1,
1984 "/usr/sbin/certadmin --get-private-key-passphrase \"%s\"",
1985 conf->private_key_file);
1987 DEBUG2("tls: Getting private key passphrase using command \"%s\"", cmd);
1989 FILE* cmd_pipe = popen(cmd, "r");
1991 ERROR("TLS: %s command failed. Unable to get private_key_password", cmd);
1992 ERROR("Error reading private_key_file %s", conf->private_key_file);
1996 talloc_free(conf->private_key_password);
1997 conf->private_key_password = talloc_array(conf, char, max_password_len);
1998 if (!conf->private_key_password) {
1999 ERROR("TLS: Can't allocate space for private_key_password");
2000 ERROR("TLS: Error reading private_key_file %s", conf->private_key_file);
2005 fgets(conf->private_key_password, max_password_len, cmd_pipe);
2008 /* Get rid of newline at end of password. */
2009 conf->private_key_password[strlen(conf->private_key_password) - 1] = '\0';
2011 DEBUG3("tls: Password from command = \"%s\"", conf->private_key_password);
2014 SSL_CTX_set_default_passwd_cb_userdata(ctx, conf->private_key_password);
2015 SSL_CTX_set_default_passwd_cb(ctx, cbtls_password);
2018 #ifdef PSK_MAX_IDENTITY_LEN
2019 if ((conf->psk_identity && !conf->psk_password) ||
2020 (!conf->psk_identity && conf->psk_password) ||
2021 (conf->psk_identity && !*conf->psk_identity) ||
2022 (conf->psk_password && !*conf->psk_password)) {
2023 ERROR("Invalid PSK Configuration: psk_identity or psk_password are empty");
2027 if (conf->psk_identity) {
2028 size_t psk_len, hex_len;
2029 char buffer[PSK_MAX_PSK_LEN];
2031 if (conf->certificate_file ||
2032 conf->private_key_password || conf->private_key_file ||
2033 conf->ca_file || conf->ca_path) {
2034 ERROR("When PSKs are used, No certificate configuration is permitted");
2039 SSL_CTX_set_psk_client_callback(ctx,
2040 psk_client_callback);
2042 SSL_CTX_set_psk_server_callback(ctx,
2043 psk_server_callback);
2046 psk_len = strlen(conf->psk_password);
2047 if (strlen(conf->psk_password) > (2 * PSK_MAX_PSK_LEN)) {
2048 ERROR("psk_hexphrase is too long (max %d)",
2053 hex_len = fr_hex2bin((uint8_t *) buffer, conf->psk_password, psk_len);
2054 if (psk_len != (2 * hex_len)) {
2055 ERROR("psk_hexphrase is not all hex");
2062 (void) client; /* -Wunused */
2066 * Load our keys and certificates
2068 * If certificates are of type PEM then we can make use
2069 * of cert chain authentication using openssl api call
2070 * SSL_CTX_use_certificate_chain_file. Please see how
2071 * the cert chain needs to be given in PEM from
2074 if (!conf->certificate_file) goto load_ca;
2076 if (type == SSL_FILETYPE_PEM) {
2077 if (!(SSL_CTX_use_certificate_chain_file(ctx, conf->certificate_file))) {
2078 ERROR("Error reading certificate file %s:%s",
2079 conf->certificate_file,
2080 ERR_error_string(ERR_get_error(), NULL));
2084 } else if (!(SSL_CTX_use_certificate_file(ctx, conf->certificate_file, type))) {
2085 ERROR("Error reading certificate file %s:%s",
2086 conf->certificate_file,
2087 ERR_error_string(ERR_get_error(), NULL));
2091 /* Load the CAs we trust */
2093 if (conf->ca_file || conf->ca_path) {
2094 if (!SSL_CTX_load_verify_locations(ctx, conf->ca_file, conf->ca_path)) {
2095 ERROR("tls: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2096 ERROR("tls: Error reading Trusted root CA list %s",conf->ca_file );
2100 if (conf->ca_file && *conf->ca_file) SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(conf->ca_file));
2102 if (conf->private_key_file) {
2103 if (!(SSL_CTX_use_PrivateKey_file(ctx, conf->private_key_file, type))) {
2104 ERROR("Failed reading private key file %s:%s",
2105 conf->private_key_file,
2106 ERR_error_string(ERR_get_error(), NULL));
2111 * Check if the loaded private key is the right one
2113 if (!SSL_CTX_check_private_key(ctx)) {
2114 ERROR("Private key does not match the certificate public key");
2119 #ifdef PSK_MAX_IDENTITY_LEN
2126 ctx_options |= SSL_OP_NO_SSLv2;
2127 ctx_options |= SSL_OP_NO_SSLv3;
2128 #ifdef SSL_OP_NO_TICKET
2129 ctx_options |= SSL_OP_NO_TICKET ;
2133 * SSL_OP_SINGLE_DH_USE must be used in order to prevent
2134 * small subgroup attacks and forward secrecy. Always
2137 * SSL_OP_SINGLE_DH_USE has an impact on the computer
2138 * time needed during negotiation, but it is not very
2141 ctx_options |= SSL_OP_SINGLE_DH_USE;
2144 * SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS to work around issues
2145 * in Windows Vista client.
2146 * http://www.openssl.org/~bodo/tls-cbc.txt
2147 * http://www.nabble.com/(RADIATOR)-Radiator-Version-3.16-released-t2600070.html
2149 ctx_options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
2151 SSL_CTX_set_options(ctx, ctx_options);
2154 * TODO: Set the RSA & DH
2155 * SSL_CTX_set_tmp_rsa_callback(ctx, cbtls_rsa);
2156 * SSL_CTX_set_tmp_dh_callback(ctx, cbtls_dh);
2160 * set the message callback to identify the type of
2161 * message. For every new session, there can be a
2162 * different callback argument.
2164 * SSL_CTX_set_msg_callback(ctx, cbtls_msg);
2168 * Set eliptical curve crypto configuration.
2170 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
2171 #ifndef OPENSSL_NO_ECDH
2172 if (set_ecdh_curve(ctx, conf->ecdh_curve) < 0) {
2178 /* Set Info callback */
2179 SSL_CTX_set_info_callback(ctx, cbtls_info);
2182 * Callbacks, etc. for session resumption.
2184 if (conf->session_cache_enable) {
2185 SSL_CTX_sess_set_new_cb(ctx, cbtls_new_session);
2186 SSL_CTX_sess_set_get_cb(ctx, cbtls_get_session);
2187 SSL_CTX_sess_set_remove_cb(ctx, cbtls_remove_session);
2189 SSL_CTX_set_quiet_shutdown(ctx, 1);
2190 if (FR_TLS_EX_INDEX_VPS < 0)
2191 FR_TLS_EX_INDEX_VPS = SSL_SESSION_get_ex_new_index(0, NULL, NULL, NULL, sess_free_vps);
2195 * Check the certificates for revocation.
2197 #ifdef X509_V_FLAG_CRL_CHECK
2198 if (conf->check_crl) {
2199 certstore = SSL_CTX_get_cert_store(ctx);
2200 if (certstore == NULL) {
2201 ERROR("tls: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2202 ERROR("tls: Error reading Certificate Store");
2205 X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK);
2211 * Always verify the peer certificate
2213 verify_mode |= SSL_VERIFY_PEER;
2214 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
2215 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
2216 SSL_CTX_set_verify(ctx, verify_mode, cbtls_verify);
2218 if (conf->verify_depth) {
2219 SSL_CTX_set_verify_depth(ctx, conf->verify_depth);
2222 /* Load randomness */
2223 if (conf->random_file) {
2224 if (!(RAND_load_file(conf->random_file, 1024*10))) {
2225 ERROR("tls: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2226 ERROR("tls: Error loading randomness");
2232 * Set the cipher list if we were told to
2234 if (conf->cipher_list) {
2235 if (!SSL_CTX_set_cipher_list(ctx, conf->cipher_list)) {
2236 ERROR("tls: Error setting cipher list");
2242 * Setup session caching
2244 if (conf->session_cache_enable) {
2246 * Create a unique context Id per EAP-TLS configuration.
2248 if (conf->session_id_name) {
2249 snprintf(conf->session_context_id,
2250 sizeof(conf->session_context_id),
2252 conf->session_id_name);
2254 snprintf(conf->session_context_id,
2255 sizeof(conf->session_context_id),
2260 * Cache it, and DON'T auto-clear it.
2262 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_SERVER | SSL_SESS_CACHE_NO_AUTO_CLEAR);
2264 SSL_CTX_set_session_id_context(ctx,
2265 (unsigned char *) conf->session_context_id,
2266 (unsigned int) strlen(conf->session_context_id));
2269 * Our timeout is in hours, this is in seconds.
2271 SSL_CTX_set_timeout(ctx, conf->session_timeout * 3600);
2274 * Set the maximum number of entries in the
2277 SSL_CTX_sess_set_cache_size(ctx, conf->session_cache_size);
2280 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
2288 * Free TLS client/server config
2289 * Should not be called outside this code, as a callback is
2290 * added to automatically free the data when the CONF_SECTION
2293 static int tls_server_conf_free(fr_tls_server_conf_t *conf)
2295 if (conf->ctx) SSL_CTX_free(conf->ctx);
2297 #ifdef HAVE_OPENSSL_OCSP_H
2298 if (conf->ocsp_store) X509_STORE_free(conf->ocsp_store);
2299 conf->ocsp_store = NULL;
2303 memset(conf, 0, sizeof(*conf));
2309 fr_tls_server_conf_t *tls_server_conf_parse(CONF_SECTION *cs)
2311 fr_tls_server_conf_t *conf;
2314 * If cs has already been parsed there should be a cached copy
2315 * of conf already stored, so just return that.
2317 conf = cf_data_find(cs, "tls-conf");
2319 DEBUG("Using cached TLS configuration from previous invocation");
2323 conf = talloc_zero(cs, fr_tls_server_conf_t);
2325 ERROR("Out of memory");
2329 talloc_set_destructor(conf, tls_server_conf_free);
2331 if (cf_section_parse(cs, conf, tls_server_config) < 0) {
2338 * Save people from their own stupidity.
2340 if (conf->fragment_size < 100) conf->fragment_size = 100;
2342 if (!conf->private_key_file) {
2343 ERROR("TLS Server requires a private key file");
2347 if (!conf->certificate_file) {
2348 ERROR("TLS Server requires a certificate file");
2355 conf->ctx = init_tls_ctx(conf, 0);
2356 if (conf->ctx == NULL) {
2360 #ifdef HAVE_OPENSSL_OCSP_H
2362 * Initialize OCSP Revocation Store
2364 if (conf->ocsp_enable) {
2365 conf->ocsp_store = init_revocation_store(conf);
2366 if (conf->ocsp_store == NULL) goto error;
2368 #endif /*HAVE_OPENSSL_OCSP_H*/
2370 if (load_dh_params(conf->ctx, conf->dh_file) < 0) {
2374 if (generate_eph_rsa_key(conf->ctx) < 0) {
2378 if (conf->verify_tmp_dir) {
2379 if (chmod(conf->verify_tmp_dir, S_IRWXU) < 0) {
2380 ERROR("Failed changing permissions on %s: %s", conf->verify_tmp_dir, fr_syserror(errno));
2385 if (conf->verify_client_cert_cmd && !conf->verify_tmp_dir) {
2386 ERROR("You MUST set the verify directory in order to use verify_client_cmd");
2391 * Cache conf in cs in case we're asked to parse this again.
2393 cf_data_add(cs, "tls-conf", conf, NULL);
2398 fr_tls_server_conf_t *tls_client_conf_parse(CONF_SECTION *cs)
2400 fr_tls_server_conf_t *conf;
2402 conf = cf_data_find(cs, "tls-conf");
2404 DEBUG("Using cached TLS configuration from previous invocation");
2408 conf = talloc_zero(cs, fr_tls_server_conf_t);
2410 ERROR("Out of memory");
2414 talloc_set_destructor(conf, tls_server_conf_free);
2416 if (cf_section_parse(cs, conf, tls_client_config) < 0) {
2423 * Save people from their own stupidity.
2425 if (conf->fragment_size < 100) conf->fragment_size = 100;
2430 conf->ctx = init_tls_ctx(conf, 1);
2431 if (conf->ctx == NULL) {
2435 if (load_dh_params(conf->ctx, conf->dh_file) < 0) {
2439 if (generate_eph_rsa_key(conf->ctx) < 0) {
2443 cf_data_add(cs, "tls-conf", conf, NULL);
2448 int tls_success(tls_session_t *ssn, REQUEST *request)
2450 VALUE_PAIR *vp, *vps = NULL;
2451 fr_tls_server_conf_t *conf;
2453 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF);
2454 rad_assert(conf != NULL);
2457 * If there's no session resumption, delete the entry
2458 * from the cache. This means either it's disabled
2459 * globally for this SSL context, OR we were told to
2460 * disable it for this user.
2462 * This also means you can't turn it on just for one
2465 if ((!ssn->allow_session_resumption) ||
2466 (((vp = pairfind(request->config_items, 1127, 0, TAG_ANY)) != NULL) &&
2467 (vp->vp_integer == 0))) {
2468 SSL_CTX_remove_session(ssn->ctx,
2470 ssn->allow_session_resumption = 0;
2473 * If we're in a resumed session and it's
2476 if (SSL_session_reused(ssn->ssl)) {
2477 RDEBUG("FAIL: Forcibly stopping session resumption as it is not allowed.");
2482 * Else resumption IS allowed, so we store the
2483 * user data in the cache.
2485 } else if (!SSL_session_reused(ssn->ssl)) {
2488 char buffer[2 * MAX_SESSION_SIZE + 1];
2490 size = ssn->ssl->session->session_id_length;
2491 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
2493 fr_bin2hex(buffer, ssn->ssl->session->session_id, size);
2495 vp = paircopy2(NULL, request->reply->vps, PW_USER_NAME, 0, TAG_ANY);
2496 if (vp) pairadd(&vps, vp);
2498 vp = paircopy2(NULL, request->packet->vps, PW_STRIPPED_USER_NAME, 0, TAG_ANY);
2499 if (vp) pairadd(&vps, vp);
2501 vp = paircopy2(NULL, request->reply->vps, PW_CHARGEABLE_USER_IDENTITY, 0, TAG_ANY);
2502 if (vp) pairadd(&vps, vp);
2504 vp = paircopy2(NULL, request->reply->vps, PW_CACHED_SESSION_POLICY, 0, TAG_ANY);
2505 if (vp) pairadd(&vps, vp);
2507 certs = (VALUE_PAIR **)SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CERTS);
2510 * Hmm... the certs should probably be session data.
2514 * @todo: some go into reply, others into
2517 pairadd(&vps, paircopy(NULL, *certs));
2521 RDEBUG2("Saving session %s vps %p in the cache", buffer, vps);
2522 SSL_SESSION_set_ex_data(ssn->ssl->session,
2523 FR_TLS_EX_INDEX_VPS, vps);
2524 if (conf->session_cache_path) {
2525 /* write the VPs to the cache file */
2526 char filename[256], buf[1024];
2529 snprintf(filename, sizeof(filename), "%s%c%s.vps",
2530 conf->session_cache_path, FR_DIR_SEP, buffer
2532 vp_file = fopen(filename, "w");
2533 if (vp_file == NULL) {
2534 RDEBUG2("Could not write session VPs to persistent cache: %s", fr_syserror(errno));
2537 /* generate a dummy user-style entry which is easy to read back */
2538 fprintf(vp_file, "# SSL cached session\n");
2539 fprintf(vp_file, "%s\n", buffer);
2540 for (vp = fr_cursor_init(&cursor, &vps);
2542 vp = fr_cursor_next(&cursor)) {
2543 vp_prints(buf, sizeof(buf), vp);
2544 fprintf(vp_file, "\t%s,\n", buf);
2550 RWDEBUG2("No information to cache: session caching will be disabled for session %s", buffer);
2551 SSL_CTX_remove_session(ssn->ctx,
2556 * Else the session WAS allowed. Copy the cached
2561 char buffer[2 * MAX_SESSION_SIZE + 1];
2563 size = ssn->ssl->session->session_id_length;
2564 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
2566 fr_bin2hex(buffer, ssn->ssl->session->session_id, size);
2568 vps = SSL_SESSION_get_ex_data(ssn->ssl->session,
2569 FR_TLS_EX_INDEX_VPS);
2571 RWDEBUG("No information in cached session %s", buffer);
2577 RDEBUG("Adding cached attributes for session %s:", buffer);
2578 debug_pair_list(vps);
2580 for (vp = fr_cursor_init(&cursor, &vps);
2582 vp = fr_cursor_next(&cursor)) {
2584 * TLS-* attrs get added back to
2587 if ((vp->da->vendor == 0) &&
2588 (vp->da->attr >= 1910) &&
2589 (vp->da->attr < 1929)) {
2590 pairadd(&request->packet->vps,
2591 paircopyvp(request->packet, vp));
2593 pairadd(&request->reply->vps,
2594 paircopyvp(request->packet, vp));
2598 if (conf->session_cache_path) {
2599 /* "touch" the cached session/vp file */
2602 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
2603 conf->session_cache_path, FR_DIR_SEP, buffer
2605 utime(filename, NULL);
2606 snprintf(filename, sizeof(filename), "%s%c%s.vps",
2607 conf->session_cache_path, FR_DIR_SEP, buffer
2609 utime(filename, NULL);
2613 * Mark the request as resumed.
2615 pairmake_packet("EAP-Session-Resumed", "1", T_OP_SET);
2623 void tls_fail(tls_session_t *ssn)
2626 * Force the session to NOT be cached.
2628 SSL_CTX_remove_session(ssn->ctx, ssn->ssl->session);
2631 fr_tls_status_t tls_application_data(tls_session_t *ssn,
2638 * Decrypt the complete record.
2640 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data,
2641 ssn->dirty_in.used);
2642 if (err != (int) ssn->dirty_in.used) {
2643 record_init(&ssn->dirty_in);
2644 RDEBUG("Failed writing %d to SSL BIO: %d",
2645 ssn->dirty_in.used, err);
2650 * Clear the dirty buffer now that we are done with it
2651 * and init the clean_out buffer to store decrypted data
2653 record_init(&ssn->dirty_in);
2654 record_init(&ssn->clean_out);
2657 * Read (and decrypt) the tunneled data from the
2658 * SSL session, and put it into the decrypted
2661 err = SSL_read(ssn->ssl, ssn->clean_out.data,
2662 sizeof(ssn->clean_out.data));
2667 RDEBUG("SSL_read Error");
2669 code = SSL_get_error(ssn->ssl, err);
2671 case SSL_ERROR_WANT_READ:
2672 DEBUG("Error in fragmentation logic: SSL_WANT_READ");
2673 return FR_TLS_MORE_FRAGMENTS;
2675 case SSL_ERROR_WANT_WRITE:
2676 DEBUG("Error in fragmentation logic: SSL_WANT_WRITE");
2680 DEBUG("Error in fragmentation logic: %s",
2681 ERR_error_string(code, NULL));
2684 * FIXME: Call int_ssl_check?
2692 RWDEBUG("No data inside of the tunnel.");
2696 * Passed all checks, successfully decrypted data
2698 ssn->clean_out.used = err;
2705 * Acknowledge received is for one of the following messages sent earlier
2706 * 1. Handshake completed Message, so now send, EAP-Success
2707 * 2. Alert Message, now send, EAP-Failure
2708 * 3. Fragment Message, now send, next Fragment
2710 fr_tls_status_t tls_ack_handler(tls_session_t *ssn, REQUEST *request)
2712 RDEBUG2("Received TLS ACK");
2715 RERROR("FAIL: Unexpected ACK received. Could not obtain session information.");
2716 return FR_TLS_INVALID;
2718 if (ssn->info.initialized == 0) {
2719 RDEBUG("No SSL info available. Waiting for more SSL data.");
2720 return FR_TLS_REQUEST;
2722 if ((ssn->info.content_type == handshake) &&
2723 (ssn->info.origin == 0)) {
2724 RERROR("FAIL: ACK without earlier message.");
2725 return FR_TLS_INVALID;
2728 switch (ssn->info.content_type) {
2730 RDEBUG2("ACK alert");
2734 if ((ssn->info.handshake_type == finished) &&
2735 (ssn->dirty_out.used == 0)) {
2736 RDEBUG2("ACK handshake is finished");
2739 * From now on all the content is
2740 * application data set it here as nobody else
2743 ssn->info.content_type = application_data;
2744 return FR_TLS_SUCCESS;
2745 } /* else more data to send */
2747 RDEBUG2("ACK handshake fragment handler");
2748 /* Fragmentation handler, send next fragment */
2749 return FR_TLS_REQUEST;
2751 case application_data:
2752 RDEBUG2("ACK handshake fragment handler in application data");
2753 return FR_TLS_REQUEST;
2756 * For the rest of the conditions, switch over
2757 * to the default section below.
2760 RDEBUG2("ACK default");
2761 RERROR("Invalid ACK received: %d",
2762 ssn->info.content_type);
2763 return FR_TLS_INVALID;
2767 #endif /* WITH_TLS */