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>
53 static void tls_server_conf_free(fr_tls_server_conf_t *conf);
56 static void record_init(record_t *buf);
57 static void record_close(record_t *buf);
58 static unsigned int record_plus(record_t *buf, void const *ptr,
60 static unsigned int record_minus(record_t *buf, void *ptr,
63 #ifdef PSK_MAX_IDENTITY_LEN
64 static unsigned int psk_server_callback(SSL *ssl, char const *identity,
66 unsigned int max_psk_len)
69 fr_tls_server_conf_t *conf;
71 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl,
72 FR_TLS_EX_INDEX_CONF);
76 * FIXME: Look up the PSK password based on the identity!
78 if (strcmp(identity, conf->psk_identity) != 0) {
82 psk_len = strlen(conf->psk_password);
83 if (psk_len > (2 * max_psk_len)) return 0;
85 return fr_hex2bin(conf->psk_password, psk, psk_len);
88 static unsigned int psk_client_callback(SSL *ssl, UNUSED char const *hint,
89 char *identity, unsigned int max_identity_len,
90 unsigned char *psk, unsigned int max_psk_len)
93 fr_tls_server_conf_t *conf;
95 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl,
96 FR_TLS_EX_INDEX_CONF);
99 psk_len = strlen(conf->psk_password);
100 if (psk_len > (2 * max_psk_len)) return 0;
102 strlcpy(identity, conf->psk_identity, max_identity_len);
104 return fr_hex2bin(conf->psk_password, psk, psk_len);
109 tls_session_t *tls_new_client_session(fr_tls_server_conf_t *conf, int fd)
112 tls_session_t *ssn = NULL;
114 ssn = talloc_zero(conf, tls_session_t);
115 if (!ssn) return NULL;
117 ssn->ctx = conf->ctx;
118 ssn->ssl = SSL_new(ssn->ctx);
119 rad_assert(ssn->ssl != NULL);
122 * Add the message callback to identify what type of
123 * message/handshake is passed
125 SSL_set_msg_callback(ssn->ssl, cbtls_msg);
126 SSL_set_msg_callback_arg(ssn->ssl, ssn);
127 SSL_set_info_callback(ssn->ssl, cbtls_info);
130 * Always verify the peer certificate.
132 DEBUG2("Requiring Server certificate");
133 verify_mode = SSL_VERIFY_PEER;
134 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
135 SSL_set_verify(ssn->ssl, verify_mode, cbtls_verify);
137 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
138 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_SSN, (void *)ssn);
139 SSL_set_fd(ssn->ssl, fd);
140 if (SSL_connect(ssn->ssl) <= 0) {
142 while ((err = ERR_get_error())) {
143 DEBUG("OpenSSL Err says %s",
144 ERR_error_string(err, NULL));
150 ssn->offset = conf->fragment_size;
155 tls_session_t *tls_new_session(fr_tls_server_conf_t *conf, REQUEST *request,
158 tls_session_t *state = NULL;
164 * Manually flush the sessions every so often. If HALF
165 * of the session lifetime has passed since we last
166 * flushed, then flush it again.
168 * FIXME: Also do it every N sessions?
170 if (conf->session_cache_enable &&
171 ((conf->session_last_flushed + (conf->session_timeout * 1800)) <= request->timestamp)){
172 RDEBUG2("Flushing SSL sessions (of #%ld)",
173 SSL_CTX_sess_number(conf->ctx));
175 SSL_CTX_flush_sessions(conf->ctx, request->timestamp);
176 conf->session_last_flushed = request->timestamp;
179 if ((new_tls = SSL_new(conf->ctx)) == NULL) {
180 ERROR("SSL: Error creating new SSL: %s",
181 ERR_error_string(ERR_get_error(), NULL));
185 /* We use the SSL's "app_data" to indicate a call-back */
186 SSL_set_app_data(new_tls, NULL);
188 state = talloc_zero(conf, tls_session_t);
191 state->ctx = conf->ctx;
192 state->ssl = new_tls;
195 * Initialize callbacks
197 state->record_init = record_init;
198 state->record_close = record_close;
199 state->record_plus = record_plus;
200 state->record_minus = record_minus;
203 * Create & hook the BIOs to handle the dirty side of the
204 * SSL. This is *very important* as we want to handle
205 * the transmission part. Now the only IO interface
206 * that SSL is aware of, is our defined BIO buffers.
208 * This means that all SSL IO is done to/from memory,
209 * and we can update those BIOs from the packets we've
212 state->into_ssl = BIO_new(BIO_s_mem());
213 state->from_ssl = BIO_new(BIO_s_mem());
214 SSL_set_bio(state->ssl, state->into_ssl, state->from_ssl);
217 * Add the message callback to identify what type of
218 * message/handshake is passed
220 SSL_set_msg_callback(new_tls, cbtls_msg);
221 SSL_set_msg_callback_arg(new_tls, state);
222 SSL_set_info_callback(new_tls, cbtls_info);
225 * In Server mode we only accept.
227 SSL_set_accept_state(state->ssl);
230 * Verify the peer certificate, if asked.
233 RDEBUG2("Requiring client certificate");
234 verify_mode = SSL_VERIFY_PEER;
235 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
236 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
238 SSL_set_verify(state->ssl, verify_mode, cbtls_verify);
240 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
241 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_SSN, (void *)state);
242 state->length_flag = conf->include_length;
245 * We use default fragment size, unless the Framed-MTU
246 * tells us it's too big. Note that we do NOT account
247 * for the EAP-TLS headers if conf->fragment_size is
248 * large, because that config item looks to be confusing.
250 * i.e. it should REALLY be called MTU, and the code here
251 * should figure out what that means for TLS fragment size.
252 * asking the administrator to know the internal details
253 * of EAP-TLS in order to calculate fragment sizes is
256 state->offset = conf->fragment_size;
257 vp = pairfind(request->packet->vps, PW_FRAMED_MTU, 0, TAG_ANY);
258 if (vp && (vp->vp_integer > 100) && (vp->vp_integer < state->offset)) {
259 state->offset = vp->vp_integer;
262 if (conf->session_cache_enable) {
263 state->allow_session_resumption = 1; /* otherwise it's zero */
272 * Print out some text describing the error.
274 static int int_ssl_check(REQUEST *request, SSL *s, int ret, char const *text)
279 if ((l = ERR_get_error()) != 0) {
280 char const *p = ERR_error_string(l, NULL);
282 if (request && p) RDEBUGE("SSL says: %s", p);
284 e = SSL_get_error(s, 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 ERROR("SSL: %s failed in a system call (%d), TLS session fails.",
317 ERROR("SSL: %s failed inside of TLS (%d), TLS session fails.",
323 * For any other errors that (a) exist, and (b)
324 * crop up - we need to interpret what to do with
325 * them - so "politely inform" the caller that
326 * the code needs updating here.
328 ERROR("SSL: FATAL SSL error ..... %d\n", e);
336 * We are the server, we always get the dirty data
337 * (Handshake data is also considered as dirty data)
338 * During handshake, since SSL API handles itself,
339 * After clean-up, dirty_out will be filled with
340 * the data required for handshaking. So we check
341 * if dirty_out is empty then we simply send it back.
342 * As of now, if handshake is successful, then we keep going,
345 * Fill the Bio with the dirty data to clean it
346 * Get the cleaned data from SSL, if it is not Handshake data
348 int tls_handshake_recv(REQUEST *request, tls_session_t *ssn)
352 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data, ssn->dirty_in.used);
353 if (err != (int) ssn->dirty_in.used) {
354 RDEBUG("Failed writing %d to SSL BIO: %d", ssn->dirty_in.used,
356 record_init(&ssn->dirty_in);
359 record_init(&ssn->dirty_in);
361 err = SSL_read(ssn->ssl, ssn->clean_out.data + ssn->clean_out.used,
362 sizeof(ssn->clean_out.data) - ssn->clean_out.used);
364 ssn->clean_out.used += err;
368 if (!int_ssl_check(request, ssn->ssl, err, "SSL_read")) {
372 /* Some Extra STATE information for easy debugging */
373 if (SSL_is_init_finished(ssn->ssl)) {
374 DEBUG2("SSL Connection Established\n");
376 if (SSL_in_init(ssn->ssl)) {
377 DEBUG2("In SSL Handshake Phase\n");
379 if (SSL_in_before(ssn->ssl)) {
380 DEBUG2("Before SSL Handshake Phase\n");
382 if (SSL_in_accept_init(ssn->ssl)) {
383 DEBUG2("In SSL Accept mode \n");
385 if (SSL_in_connect_init(ssn->ssl)) {
386 DEBUG2("In SSL Connect mode \n");
389 err = BIO_ctrl_pending(ssn->from_ssl);
391 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
392 sizeof(ssn->dirty_out.data));
394 ssn->dirty_out.used = err;
396 } else if (BIO_should_retry(ssn->from_ssl)) {
397 record_init(&ssn->dirty_in);
398 DEBUG2(" tls: Asking for more data in tunnel");
402 int_ssl_check(request, ssn->ssl, err, "BIO_read");
403 record_init(&ssn->dirty_in);
407 DEBUG2("SSL Application Data");
408 /* Its clean application data, do whatever we want */
409 record_init(&ssn->clean_out);
412 /* We are done with dirty_in, reinitialize it */
413 record_init(&ssn->dirty_in);
418 * Take clear-text user data, and encrypt it into the output buffer,
419 * to send to the client at the other end of the SSL connection.
421 int tls_handshake_send(REQUEST *request, tls_session_t *ssn)
426 * If there's un-encrypted data in 'clean_in', then write
427 * that data to the SSL session, and then call the BIO function
428 * to get that encrypted data from the SSL session, into
429 * a buffer which we can then package into an EAP packet.
431 * Based on Server's logic this clean_in is expected to
432 * contain the data to send to the client.
434 if (ssn->clean_in.used > 0) {
437 written = SSL_write(ssn->ssl, ssn->clean_in.data, ssn->clean_in.used);
438 record_minus(&ssn->clean_in, NULL, written);
440 /* Get the dirty data from Bio to send it */
441 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
442 sizeof(ssn->dirty_out.data));
444 ssn->dirty_out.used = err;
446 int_ssl_check(request, ssn->ssl, err, "handshake_send");
453 void session_init(tls_session_t *ssn)
456 ssn->into_ssl = ssn->from_ssl = NULL;
457 record_init(&ssn->clean_in);
458 record_init(&ssn->clean_out);
459 record_init(&ssn->dirty_in);
460 record_init(&ssn->dirty_out);
462 memset(&ssn->info, 0, sizeof(ssn->info));
466 ssn->tls_msg_len = 0;
467 ssn->length_flag = 0;
469 ssn->free_opaque = NULL;
472 void session_close(tls_session_t *ssn)
474 SSL_set_quiet_shutdown(ssn->ssl, 1);
475 SSL_shutdown(ssn->ssl);
480 record_close(&ssn->clean_in);
481 record_close(&ssn->clean_out);
482 record_close(&ssn->dirty_in);
483 record_close(&ssn->dirty_out);
487 void session_free(void *ssn)
489 tls_session_t *sess = (tls_session_t *)ssn;
494 * Free any opaque TTLS or PEAP data.
496 if ((sess->opaque) && (sess->free_opaque)) {
497 sess->free_opaque(sess->opaque);
506 static void record_init(record_t *rec)
511 static void record_close(record_t *rec)
518 * Copy data to the intermediate buffer, before we send
521 static unsigned int record_plus(record_t *rec, void const *ptr,
524 unsigned int added = MAX_RECORD_SIZE - rec->used;
530 memcpy(rec->data + rec->used, ptr, added);
536 * Take data from the buffer, and give it to the caller.
538 static unsigned int record_minus(record_t *rec, void *ptr,
541 unsigned int taken = rec->used;
548 memcpy(ptr, rec->data, taken);
552 * This is pretty bad...
555 memmove(rec->data, rec->data + taken, rec->used);
559 void tls_session_information(tls_session_t *tls_session)
561 char const *str_write_p, *str_version, *str_content_type = "";
562 char const *str_details1 = "", *str_details2= "";
566 * Don't print this out in the normal course of
569 if (debug_flag == 0) {
573 str_write_p = tls_session->info.origin ? ">>>" : "<<<";
575 switch (tls_session->info.version)
578 str_version = "SSL 2.0";
581 str_version = "SSL 3.0 ";
584 str_version = "TLS 1.0 ";
587 str_version = "Unknown TLS version";
591 if (tls_session->info.version == SSL3_VERSION ||
592 tls_session->info.version == TLS1_VERSION) {
593 switch (tls_session->info.content_type) {
594 case SSL3_RT_CHANGE_CIPHER_SPEC:
595 str_content_type = "ChangeCipherSpec";
598 str_content_type = "Alert";
600 case SSL3_RT_HANDSHAKE:
601 str_content_type = "Handshake";
603 case SSL3_RT_APPLICATION_DATA:
604 str_content_type = "ApplicationData";
607 str_content_type = "UnknownContentType";
611 if (tls_session->info.content_type == SSL3_RT_ALERT) {
612 str_details1 = ", ???";
614 if (tls_session->info.record_len == 2) {
616 switch (tls_session->info.alert_level) {
617 case SSL3_AL_WARNING:
618 str_details1 = ", warning";
621 str_details1 = ", fatal";
625 str_details2 = " ???";
626 switch (tls_session->info.alert_description) {
627 case SSL3_AD_CLOSE_NOTIFY:
628 str_details2 = " close_notify";
630 case SSL3_AD_UNEXPECTED_MESSAGE:
631 str_details2 = " unexpected_message";
633 case SSL3_AD_BAD_RECORD_MAC:
634 str_details2 = " bad_record_mac";
636 case TLS1_AD_DECRYPTION_FAILED:
637 str_details2 = " decryption_failed";
639 case TLS1_AD_RECORD_OVERFLOW:
640 str_details2 = " record_overflow";
642 case SSL3_AD_DECOMPRESSION_FAILURE:
643 str_details2 = " decompression_failure";
645 case SSL3_AD_HANDSHAKE_FAILURE:
646 str_details2 = " handshake_failure";
648 case SSL3_AD_BAD_CERTIFICATE:
649 str_details2 = " bad_certificate";
651 case SSL3_AD_UNSUPPORTED_CERTIFICATE:
652 str_details2 = " unsupported_certificate";
654 case SSL3_AD_CERTIFICATE_REVOKED:
655 str_details2 = " certificate_revoked";
657 case SSL3_AD_CERTIFICATE_EXPIRED:
658 str_details2 = " certificate_expired";
660 case SSL3_AD_CERTIFICATE_UNKNOWN:
661 str_details2 = " certificate_unknown";
663 case SSL3_AD_ILLEGAL_PARAMETER:
664 str_details2 = " illegal_parameter";
666 case TLS1_AD_UNKNOWN_CA:
667 str_details2 = " unknown_ca";
669 case TLS1_AD_ACCESS_DENIED:
670 str_details2 = " access_denied";
672 case TLS1_AD_DECODE_ERROR:
673 str_details2 = " decode_error";
675 case TLS1_AD_DECRYPT_ERROR:
676 str_details2 = " decrypt_error";
678 case TLS1_AD_EXPORT_RESTRICTION:
679 str_details2 = " export_restriction";
681 case TLS1_AD_PROTOCOL_VERSION:
682 str_details2 = " protocol_version";
684 case TLS1_AD_INSUFFICIENT_SECURITY:
685 str_details2 = " insufficient_security";
687 case TLS1_AD_INTERNAL_ERROR:
688 str_details2 = " internal_error";
690 case TLS1_AD_USER_CANCELLED:
691 str_details2 = " user_canceled";
693 case TLS1_AD_NO_RENEGOTIATION:
694 str_details2 = " no_renegotiation";
700 if (tls_session->info.content_type == SSL3_RT_HANDSHAKE) {
701 str_details1 = "???";
703 if (tls_session->info.record_len > 0)
704 switch (tls_session->info.handshake_type)
706 case SSL3_MT_HELLO_REQUEST:
707 str_details1 = ", HelloRequest";
709 case SSL3_MT_CLIENT_HELLO:
710 str_details1 = ", ClientHello";
712 case SSL3_MT_SERVER_HELLO:
713 str_details1 = ", ServerHello";
715 case SSL3_MT_CERTIFICATE:
716 str_details1 = ", Certificate";
718 case SSL3_MT_SERVER_KEY_EXCHANGE:
719 str_details1 = ", ServerKeyExchange";
721 case SSL3_MT_CERTIFICATE_REQUEST:
722 str_details1 = ", CertificateRequest";
724 case SSL3_MT_SERVER_DONE:
725 str_details1 = ", ServerHelloDone";
727 case SSL3_MT_CERTIFICATE_VERIFY:
728 str_details1 = ", CertificateVerify";
730 case SSL3_MT_CLIENT_KEY_EXCHANGE:
731 str_details1 = ", ClientKeyExchange";
733 case SSL3_MT_FINISHED:
734 str_details1 = ", Finished";
740 snprintf(tls_session->info.info_description,
741 sizeof(tls_session->info.info_description),
742 "%s %s%s [length %04lx]%s%s\n",
743 str_write_p, str_version, str_content_type,
744 (unsigned long)tls_session->info.record_len,
745 str_details1, str_details2);
747 request = SSL_get_ex_data(tls_session->ssl, FR_TLS_EX_INDEX_REQUEST);
749 RDEBUG2("%s\n", tls_session->info.info_description);
752 static CONF_PARSER cache_config[] = {
753 { "enable", PW_TYPE_BOOLEAN,
754 offsetof(fr_tls_server_conf_t, session_cache_enable), NULL, "no" },
755 { "lifetime", PW_TYPE_INTEGER,
756 offsetof(fr_tls_server_conf_t, session_timeout), NULL, "24" },
757 { "max_entries", PW_TYPE_INTEGER,
758 offsetof(fr_tls_server_conf_t, session_cache_size), NULL, "255" },
759 { "name", PW_TYPE_STRING_PTR,
760 offsetof(fr_tls_server_conf_t, session_id_name), NULL, NULL},
761 { "persist_dir", PW_TYPE_STRING_PTR,
762 offsetof(fr_tls_server_conf_t, session_cache_path), NULL, NULL},
763 { NULL, -1, 0, NULL, NULL } /* end the list */
766 static CONF_PARSER verify_config[] = {
767 { "tmpdir", PW_TYPE_STRING_PTR,
768 offsetof(fr_tls_server_conf_t, verify_tmp_dir), NULL, NULL},
769 { "client", PW_TYPE_STRING_PTR,
770 offsetof(fr_tls_server_conf_t, verify_client_cert_cmd), NULL, NULL},
771 { NULL, -1, 0, NULL, NULL } /* end the list */
774 #ifdef HAVE_OPENSSL_OCSP_H
775 static CONF_PARSER ocsp_config[] = {
776 { "enable", PW_TYPE_BOOLEAN,
777 offsetof(fr_tls_server_conf_t, ocsp_enable), NULL, "no"},
778 { "override_cert_url", PW_TYPE_BOOLEAN,
779 offsetof(fr_tls_server_conf_t, ocsp_override_url), NULL, "no"},
780 { "url", PW_TYPE_STRING_PTR,
781 offsetof(fr_tls_server_conf_t, ocsp_url), NULL, NULL },
782 { "use_nonce", PW_TYPE_BOOLEAN,
783 offsetof(fr_tls_server_conf_t, ocsp_use_nonce), NULL, "yes"},
784 { "timeout", PW_TYPE_INTEGER,
785 offsetof(fr_tls_server_conf_t, ocsp_timeout), NULL, "yes"},
786 { "softfail", PW_TYPE_BOOLEAN,
787 offsetof(fr_tls_server_conf_t, ocsp_softfail), NULL, "yes"},
788 { NULL, -1, 0, NULL, NULL } /* end the list */
792 static CONF_PARSER tls_server_config[] = {
793 { "rsa_key_exchange", PW_TYPE_BOOLEAN,
794 offsetof(fr_tls_server_conf_t, rsa_key), NULL, "no" },
795 { "dh_key_exchange", PW_TYPE_BOOLEAN,
796 offsetof(fr_tls_server_conf_t, dh_key), NULL, "yes" },
797 { "rsa_key_length", PW_TYPE_INTEGER,
798 offsetof(fr_tls_server_conf_t, rsa_key_length), NULL, "512" },
799 { "dh_key_length", PW_TYPE_INTEGER,
800 offsetof(fr_tls_server_conf_t, dh_key_length), NULL, "512" },
801 { "verify_depth", PW_TYPE_INTEGER,
802 offsetof(fr_tls_server_conf_t, verify_depth), NULL, "0" },
803 { "CA_path", PW_TYPE_FILENAME,
804 offsetof(fr_tls_server_conf_t, ca_path), NULL, NULL },
805 { "pem_file_type", PW_TYPE_BOOLEAN,
806 offsetof(fr_tls_server_conf_t, file_type), NULL, "yes" },
807 { "private_key_file", PW_TYPE_FILENAME,
808 offsetof(fr_tls_server_conf_t, private_key_file), NULL, NULL },
809 { "certificate_file", PW_TYPE_FILENAME,
810 offsetof(fr_tls_server_conf_t, certificate_file), NULL, NULL },
811 { "CA_file", PW_TYPE_FILENAME,
812 offsetof(fr_tls_server_conf_t, ca_file), NULL, NULL },
813 { "private_key_password", PW_TYPE_STRING_PTR,
814 offsetof(fr_tls_server_conf_t, private_key_password), NULL, NULL },
815 #ifdef PSK_MAX_IDENTITY_LEN
816 { "psk_identity", PW_TYPE_STRING_PTR,
817 offsetof(fr_tls_server_conf_t, psk_identity), NULL, NULL },
818 { "psk_hexphrase", PW_TYPE_STRING_PTR,
819 offsetof(fr_tls_server_conf_t, psk_password), NULL, NULL },
821 { "dh_file", PW_TYPE_STRING_PTR,
822 offsetof(fr_tls_server_conf_t, dh_file), NULL, NULL },
823 { "random_file", PW_TYPE_STRING_PTR,
824 offsetof(fr_tls_server_conf_t, random_file), NULL, NULL },
825 { "fragment_size", PW_TYPE_INTEGER,
826 offsetof(fr_tls_server_conf_t, fragment_size), NULL, "1024" },
827 { "include_length", PW_TYPE_BOOLEAN,
828 offsetof(fr_tls_server_conf_t, include_length), NULL, "yes" },
829 { "check_crl", PW_TYPE_BOOLEAN,
830 offsetof(fr_tls_server_conf_t, check_crl), NULL, "no"},
831 { "allow_expired_crl", PW_TYPE_BOOLEAN,
832 offsetof(fr_tls_server_conf_t, allow_expired_crl), NULL, NULL},
833 { "check_cert_cn", PW_TYPE_STRING_PTR,
834 offsetof(fr_tls_server_conf_t, check_cert_cn), NULL, NULL},
835 { "cipher_list", PW_TYPE_STRING_PTR,
836 offsetof(fr_tls_server_conf_t, cipher_list), NULL, NULL},
837 { "check_cert_issuer", PW_TYPE_STRING_PTR,
838 offsetof(fr_tls_server_conf_t, check_cert_issuer), NULL, NULL},
839 { "make_cert_command", PW_TYPE_STRING_PTR,
840 offsetof(fr_tls_server_conf_t, make_cert_command), NULL, NULL},
841 { "require_client_cert", PW_TYPE_BOOLEAN,
842 offsetof(fr_tls_server_conf_t, require_client_cert), NULL, NULL },
844 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
845 #ifndef OPENSSL_NO_ECDH
846 { "ecdh_curve", PW_TYPE_STRING_PTR,
847 offsetof(fr_tls_server_conf_t, ecdh_curve), NULL, "prime256v1"},
851 { "cache", PW_TYPE_SUBSECTION, 0, NULL, (void const *) cache_config },
853 { "verify", PW_TYPE_SUBSECTION, 0, NULL, (void const *) verify_config },
855 #ifdef HAVE_OPENSSL_OCSP_H
856 { "ocsp", PW_TYPE_SUBSECTION, 0, NULL, (void const *) ocsp_config },
859 { NULL, -1, 0, NULL, NULL } /* end the list */
863 static CONF_PARSER tls_client_config[] = {
864 { "rsa_key_exchange", PW_TYPE_BOOLEAN,
865 offsetof(fr_tls_server_conf_t, rsa_key), NULL, "no" },
866 { "dh_key_exchange", PW_TYPE_BOOLEAN,
867 offsetof(fr_tls_server_conf_t, dh_key), NULL, "yes" },
868 { "rsa_key_length", PW_TYPE_INTEGER,
869 offsetof(fr_tls_server_conf_t, rsa_key_length), NULL, "512" },
870 { "dh_key_length", PW_TYPE_INTEGER,
871 offsetof(fr_tls_server_conf_t, dh_key_length), NULL, "512" },
872 { "verify_depth", PW_TYPE_INTEGER,
873 offsetof(fr_tls_server_conf_t, verify_depth), NULL, "0" },
874 { "CA_path", PW_TYPE_FILENAME,
875 offsetof(fr_tls_server_conf_t, ca_path), NULL, NULL },
876 { "pem_file_type", PW_TYPE_BOOLEAN,
877 offsetof(fr_tls_server_conf_t, file_type), NULL, "yes" },
878 { "private_key_file", PW_TYPE_FILENAME,
879 offsetof(fr_tls_server_conf_t, private_key_file), NULL, NULL },
880 { "certificate_file", PW_TYPE_FILENAME,
881 offsetof(fr_tls_server_conf_t, certificate_file), NULL, NULL },
882 { "CA_file", PW_TYPE_FILENAME,
883 offsetof(fr_tls_server_conf_t, ca_file), NULL, NULL },
884 { "private_key_password", PW_TYPE_STRING_PTR,
885 offsetof(fr_tls_server_conf_t, private_key_password), NULL, NULL },
886 { "dh_file", PW_TYPE_STRING_PTR,
887 offsetof(fr_tls_server_conf_t, dh_file), NULL, NULL },
888 { "random_file", PW_TYPE_STRING_PTR,
889 offsetof(fr_tls_server_conf_t, random_file), NULL, NULL },
890 { "fragment_size", PW_TYPE_INTEGER,
891 offsetof(fr_tls_server_conf_t, fragment_size), NULL, "1024" },
892 { "include_length", PW_TYPE_BOOLEAN,
893 offsetof(fr_tls_server_conf_t, include_length), NULL, "yes" },
894 { "check_crl", PW_TYPE_BOOLEAN,
895 offsetof(fr_tls_server_conf_t, check_crl), NULL, "no"},
896 { "check_cert_cn", PW_TYPE_STRING_PTR,
897 offsetof(fr_tls_server_conf_t, check_cert_cn), NULL, NULL},
898 { "cipher_list", PW_TYPE_STRING_PTR,
899 offsetof(fr_tls_server_conf_t, cipher_list), NULL, NULL},
900 { "check_cert_issuer", PW_TYPE_STRING_PTR,
901 offsetof(fr_tls_server_conf_t, check_cert_issuer), NULL, NULL},
903 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
904 #ifndef OPENSSL_NO_ECDH
905 { "ecdh_curve", PW_TYPE_STRING_PTR,
906 offsetof(fr_tls_server_conf_t, ecdh_curve), NULL, "prime256v1"},
910 { NULL, -1, 0, NULL, NULL } /* end the list */
915 * TODO: Check for the type of key exchange * like conf->dh_key
917 static int load_dh_params(SSL_CTX *ctx, char *file)
922 if ((bio = BIO_new_file(file, "r")) == NULL) {
923 ERROR("rlm_eap_tls: Unable to open DH file - %s", file);
927 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
930 DEBUG2W("rlm_eap_tls: Unable to set DH parameters. DH cipher suites may not work!");
931 DEBUG2W("Fix this by running the OpenSSL command listed in eap.conf");
935 if (SSL_CTX_set_tmp_dh(ctx, dh) < 0) {
936 ERROR("rlm_eap_tls: Unable to set DH parameters");
947 * Generate ephemeral RSA keys.
949 static int generate_eph_rsa_key(SSL_CTX *ctx)
953 rsa = RSA_generate_key(512, RSA_F4, NULL, NULL);
955 if (!SSL_CTX_set_tmp_rsa(ctx, rsa)) {
956 ERROR("rlm_eap_tls: Couldn't set ephemeral RSA key");
964 /* index we use to store cached session VPs
965 * needs to be dynamic so we can supply a "free" function
967 static int FR_TLS_EX_INDEX_VPS = -1;
970 * Print debugging messages, and free data.
972 * FIXME: Write sessions to some long-term storage, so that
973 * session resumption can still occur after the server
976 #define MAX_SESSION_SIZE (256)
978 static void cbtls_remove_session(SSL_CTX *ctx, SSL_SESSION *sess)
981 char buffer[2 * MAX_SESSION_SIZE + 1];
982 fr_tls_server_conf_t *conf;
984 size = sess->session_id_length;
985 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
987 fr_bin2hex(sess->session_id, buffer, size);
989 DEBUG2(" SSL: Removing session %s from the cache", buffer);
990 conf = (fr_tls_server_conf_t *)SSL_CTX_get_app_data(ctx);
991 if (conf && conf->session_cache_path) {
995 /* remove session and any cached VPs */
996 rv = snprintf(filename, sizeof(filename), "%s%c%s.asn1",
997 conf->session_cache_path, FR_DIR_SEP, buffer
999 rv = unlink(filename);
1001 DEBUG2(" SSL: could not remove persisted session file %s: %s", filename, strerror(errno));
1003 /* VPs might be absent; might not have been written to disk yet */
1004 rv = snprintf(filename, sizeof(filename), "%s%c%s.vps",
1005 conf->session_cache_path, FR_DIR_SEP, buffer
1007 rv = unlink(filename);
1013 static int cbtls_new_session(SSL *ssl, SSL_SESSION *sess)
1016 char buffer[2 * MAX_SESSION_SIZE + 1];
1017 fr_tls_server_conf_t *conf;
1018 unsigned char *sess_blob = NULL;
1020 size = sess->session_id_length;
1021 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1023 fr_bin2hex(sess->session_id, buffer, size);
1025 DEBUG2(" SSL: adding session %s to cache", buffer);
1027 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1028 if (conf && conf->session_cache_path) {
1029 int fd, rv, todo, blob_len;
1033 /* find out what length data we need */
1034 blob_len = i2d_SSL_SESSION(sess, NULL);
1036 /* something went wrong */
1037 DEBUG2(" SSL: could not find buffer length to persist session");
1041 /* alloc and convert to ASN.1 */
1042 sess_blob = talloc_array(conf, unsigned char, blob_len);
1044 DEBUG2(" SSL: could not allocate buffer len=%d to persist session", blob_len);
1047 /* openssl mutates &p */
1049 rv = i2d_SSL_SESSION(sess, &p);
1050 if (rv != blob_len) {
1051 DEBUG2(" SSL: could not persist session");
1055 /* open output file */
1056 rv = snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1057 conf->session_cache_path, FR_DIR_SEP, buffer);
1058 fd = open(filename, O_RDWR|O_CREAT|O_EXCL, 0600);
1060 DEBUG2(" SSL: could not open session file %s: %s", filename, strerror(errno));
1067 rv = write(fd, p, todo);
1069 DEBUG2(" SSL: failed writing session: %s", strerror(errno));
1077 DEBUG2(" SSL: wrote session %s to %s len=%d", buffer, filename, blob_len);
1081 if (sess_blob) talloc_free(sess_blob);
1086 static SSL_SESSION *cbtls_get_session(SSL *ssl,
1087 unsigned char *data, int len,
1091 char buffer[2 * MAX_SESSION_SIZE + 1];
1092 fr_tls_server_conf_t *conf;
1094 SSL_SESSION *sess = NULL;
1095 unsigned char *sess_data = NULL;
1096 PAIR_LIST *pairlist = NULL;
1099 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1101 fr_bin2hex(data, buffer, size);
1103 DEBUG2(" SSL: Client requested cached session %s", buffer);
1105 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1106 if (conf && conf->session_cache_path) {
1113 /* read in the cached VPs from the .vps file */
1114 rv = snprintf(filename, sizeof(filename), "%s%c%s.vps",
1115 conf->session_cache_path, FR_DIR_SEP, buffer
1117 rv = pairlist_read(NULL, filename, &pairlist, 1);
1119 /* not safe to un-persist a session w/o VPs */
1120 DEBUG2(" SSL: could not load persisted VPs for session %s", buffer);
1124 /* load the actual SSL session */
1125 rv = snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1126 conf->session_cache_path, FR_DIR_SEP, buffer
1128 fd = open(filename, O_RDONLY);
1130 DEBUG2(" SSL: could not find persisted session file %s: %s", filename, strerror(errno));
1134 rv = fstat(fd, &st);
1136 DEBUG2(" SSL: could not stat persisted session file %s: %s", filename, strerror(errno));
1141 sess_data = talloc_array(NULL, unsigned char, st.st_size);
1143 DEBUG2(" SSL: could not alloc buffer for persisted session len=%d", (int) st.st_size);
1151 rv = read(fd, p, todo);
1153 DEBUG2(" SSL: could not read from persisted session: %s", strerror(errno));
1162 /* openssl mutates &p */
1164 sess = d2i_SSL_SESSION(NULL, (unsigned char const **)(void **) &p, st.st_size);
1167 DEBUG2(" SSL: OpenSSL failed to load persisted session: %s", ERR_error_string(ERR_get_error(), NULL));
1171 /* cache the VPs into the session */
1172 vp = paircopy(NULL, pairlist->reply);
1173 SSL_SESSION_set_ex_data(sess, FR_TLS_EX_INDEX_VPS, vp);
1174 DEBUG2(" SSL: Successfully restored session %s", buffer);
1177 if (sess_data) talloc_free(sess_data);
1178 if (pairlist) pairlist_free(&pairlist);
1184 #ifdef HAVE_OPENSSL_OCSP_H
1186 * This function extracts the OCSP Responder URL
1187 * from an existing x509 certificate.
1189 static int ocsp_parse_cert_url(X509 *cert, char **phost, char **pport,
1190 char **ppath, int *pssl)
1194 AUTHORITY_INFO_ACCESS *aia;
1195 ACCESS_DESCRIPTION *ad;
1197 aia = X509_get_ext_d2i(cert, NID_info_access, NULL, NULL);
1199 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(aia); i++) {
1200 ad = sk_ACCESS_DESCRIPTION_value(aia, 0);
1201 if (OBJ_obj2nid(ad->method) == NID_ad_OCSP) {
1202 if (ad->location->type == GEN_URI) {
1203 if(OCSP_parse_url((char *) ad->location->d.ia5->data,
1204 phost, pport, ppath, pssl))
1213 * This function sends a OCSP request to a defined OCSP responder
1214 * and checks the OCSP response for correctness.
1217 /* Maximum leeway in validity period: default 5 minutes */
1218 #define MAX_VALIDITY_PERIOD (5 * 60)
1220 static int ocsp_check(X509_STORE *store, X509 *issuer_cert, X509 *client_cert,
1221 fr_tls_server_conf_t *conf)
1223 OCSP_CERTID *certid;
1225 OCSP_RESPONSE *resp = NULL;
1226 OCSP_BASICRESP *bresp = NULL;
1231 long nsec = MAX_VALIDITY_PERIOD, maxage = -1;
1232 BIO *cbio, *bio_out;
1235 ASN1_GENERALIZEDTIME *rev, *thisupd, *nextupd;
1237 #if OPENSSL_VERSION_NUMBER >= 0x1000003f
1241 struct timeval when;
1245 * Create OCSP Request
1247 certid = OCSP_cert_to_id(NULL, client_cert, issuer_cert);
1248 req = OCSP_REQUEST_new();
1249 OCSP_request_add0_id(req, certid);
1250 if(conf->ocsp_use_nonce) {
1251 OCSP_request_add1_nonce(req, NULL, 8);
1255 * Send OCSP Request and get OCSP Response
1258 /* Get OCSP responder URL */
1259 if(conf->ocsp_override_url) {
1260 OCSP_parse_url(conf->ocsp_url, &host, &port, &path, &use_ssl);
1263 ocsp_parse_cert_url(client_cert, &host, &port, &path, &use_ssl);
1266 if (!host || !port || !path) {
1267 DEBUG2("[ocsp] - Host / port / path missing. Not doing OCSP.");
1272 DEBUG2("[ocsp] --> Responder URL = http://%s:%s%s", host, port, path);
1274 /* Setup BIO socket to OCSP responder */
1275 cbio = BIO_new_connect(host);
1277 bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
1279 BIO_set_conn_port(cbio, port);
1280 #if OPENSSL_VERSION_NUMBER < 0x1000003f
1281 BIO_do_connect(cbio);
1283 /* Send OCSP request and wait for response */
1284 resp = OCSP_sendreq_bio(cbio, path, req);
1286 ERROR("Error: Couldn't get OCSP response");
1291 if (conf->ocsp_timeout)
1292 BIO_set_nbio(cbio, 1);
1294 rc = BIO_do_connect(cbio);
1295 if ((rc <= 0) && ((!conf->ocsp_timeout) || !BIO_should_retry(cbio))) {
1296 ERROR("Error: Couldn't connect to OCSP responder");
1301 ctx = OCSP_sendreq_new(cbio, path, req, -1);
1303 ERROR("Error: Couldn't send OCSP request");
1308 gettimeofday(&when, NULL);
1309 when.tv_sec += conf->ocsp_timeout;
1312 rc = OCSP_sendreq_nbio(&resp, ctx);
1313 if (conf->ocsp_timeout) {
1314 gettimeofday(&now, NULL);
1315 if (!timercmp(&now, &when, <))
1318 } while ((rc == -1) && BIO_should_retry(cbio));
1320 if (conf->ocsp_timeout && (rc == -1) && BIO_should_retry(cbio)) {
1321 ERROR("Error: OCSP response timed out");
1326 OCSP_REQ_CTX_free(ctx);
1329 ERROR("Error: Couldn't get OCSP response");
1335 /* Verify OCSP response status */
1336 status = OCSP_response_status(resp);
1337 DEBUG2("[ocsp] --> Response status: %s",OCSP_response_status_str(status));
1338 if(status != OCSP_RESPONSE_STATUS_SUCCESSFUL) {
1339 ERROR("Error: OCSP response status: %s", OCSP_response_status_str(status));
1342 bresp = OCSP_response_get1_basic(resp);
1343 if(conf->ocsp_use_nonce && OCSP_check_nonce(req, bresp)!=1) {
1344 ERROR("Error: OCSP response has wrong nonce value");
1347 if(OCSP_basic_verify(bresp, NULL, store, 0)!=1){
1348 ERROR("Error: Couldn't verify OCSP basic response");
1352 /* Verify OCSP cert status */
1353 if(!OCSP_resp_find_status(bresp, certid, &status, &reason,
1354 &rev, &thisupd, &nextupd)) {
1355 ERROR("ERROR: No Status found.\n");
1359 if (!OCSP_check_validity(thisupd, nextupd, nsec, maxage)) {
1360 BIO_puts(bio_out, "WARNING: Status times invalid.\n");
1361 ERR_print_errors(bio_out);
1364 BIO_puts(bio_out, "\tThis Update: ");
1365 ASN1_GENERALIZEDTIME_print(bio_out, thisupd);
1366 BIO_puts(bio_out, "\n");
1368 BIO_puts(bio_out, "\tNext Update: ");
1369 ASN1_GENERALIZEDTIME_print(bio_out, nextupd);
1370 BIO_puts(bio_out, "\n");
1374 case V_OCSP_CERTSTATUS_GOOD:
1375 DEBUG2("[oscp] --> Cert status: good");
1380 /* REVOKED / UNKNOWN */
1381 DEBUG2("[ocsp] --> Cert status: %s",OCSP_cert_status_str(status));
1383 DEBUG2("[ocsp] --> Reason: %s", OCSP_crl_reason_str(reason));
1384 BIO_puts(bio_out, "\tRevocation Time: ");
1385 ASN1_GENERALIZEDTIME_print(bio_out, rev);
1386 BIO_puts(bio_out, "\n");
1391 /* Free OCSP Stuff */
1392 OCSP_REQUEST_free(req);
1393 OCSP_RESPONSE_free(resp);
1398 OCSP_BASICRESP_free(bresp);
1403 DEBUG2("[ocsp] --> Certificate is valid!");
1406 if (conf->ocsp_softfail) {
1407 DEBUG2("[ocsp] --> Unable to check certificate; assuming valid.");
1408 DEBUG2("[ocsp] --> Warning! This may be insecure.");
1411 DEBUG2("[ocsp] --> Unable to check certificate; failing!");
1416 DEBUG2("[ocsp] --> Certificate has been expired/revoked!");
1422 #endif /* HAVE_OPENSSL_OCSP_H */
1425 * For creating certificate attributes.
1427 static char const *cert_attr_names[6][2] = {
1428 { "TLS-Client-Cert-Serial", "TLS-Cert-Serial" },
1429 { "TLS-Client-Cert-Expiration", "TLS-Cert-Expiration" },
1430 { "TLS-Client-Cert-Subject", "TLS-Cert-Subject" },
1431 { "TLS-Client-Cert-Issuer", "TLS-Cert-Issuer" },
1432 { "TLS-Client-Cert-Common-Name", "TLS-Cert-Common-Name" },
1433 { "TLS-Client-Cert-Subject-Alt-Name-Email", "TLS-Cert-Subject-Alt-Name-Email" }
1436 #define FR_TLS_SERIAL (0)
1437 #define FR_TLS_EXPIRATION (1)
1438 #define FR_TLS_SUBJECT (2)
1439 #define FR_TLS_ISSUER (3)
1440 #define FR_TLS_CN (4)
1441 #define FR_TLS_SAN_EMAIL (5)
1444 * Before trusting a certificate, you must make sure that the
1445 * certificate is 'valid'. There are several steps that your
1446 * application can take in determining if a certificate is
1447 * valid. Commonly used steps are:
1449 * 1.Verifying the certificate's signature, and verifying that
1450 * the certificate has been issued by a trusted Certificate
1453 * 2.Verifying that the certificate is valid for the present date
1454 * (i.e. it is being presented within its validity dates).
1456 * 3.Verifying that the certificate has not been revoked by its
1457 * issuing Certificate Authority, by checking with respect to a
1458 * Certificate Revocation List (CRL).
1460 * 4.Verifying that the credentials presented by the certificate
1461 * fulfill additional requirements specific to the application,
1462 * such as with respect to access control lists or with respect
1463 * to OCSP (Online Certificate Status Processing).
1465 * NOTE: This callback will be called multiple times based on the
1466 * depth of the root certificate chain
1468 int cbtls_verify(int ok, X509_STORE_CTX *ctx)
1470 char subject[1024]; /* Used for the subject name */
1471 char issuer[1024]; /* Used for the issuer name */
1472 char common_name[1024];
1477 int err, depth, lookup, loc;
1478 fr_tls_server_conf_t *conf;
1481 ASN1_INTEGER *sn = NULL;
1482 ASN1_TIME *asn_time = NULL;
1485 #ifdef HAVE_OPENSSL_OCSP_H
1486 X509_STORE *ocsp_store = NULL;
1490 client_cert = X509_STORE_CTX_get_current_cert(ctx);
1491 err = X509_STORE_CTX_get_error(ctx);
1492 depth = X509_STORE_CTX_get_error_depth(ctx);
1497 * Log client/issuing cert. If there's an error, log
1500 if ((lookup > 1) && !my_ok) lookup = 1;
1503 * Retrieve the pointer to the SSL of the connection currently treated
1504 * and the application specific data stored into the SSL object.
1506 ssl = X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
1507 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1508 if (!conf) return 1;
1510 request = (REQUEST *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_REQUEST);
1512 if (!request) return 1; /* FIXME: outbound TLS */
1514 rad_assert(request != NULL);
1515 certs = (VALUE_PAIR **)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CERTS);
1516 rad_assert(certs != NULL);
1517 identity = (char **)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_IDENTITY);
1518 #ifdef HAVE_OPENSSL_OCSP_H
1519 ocsp_store = (X509_STORE *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_STORE);
1523 * Get the Serial Number
1526 sn = X509_get_serialNumber(client_cert);
1529 * For this next bit, we create the attributes *only* if
1530 * we're at the client or issuing certificate, AND we
1531 * have a user identity. i.e. we don't create the
1532 * attributes for RadSec connections.
1535 (lookup <= 1) && sn && ((size_t) sn->length < (sizeof(buf) / 2))) {
1539 for (i = 0; i < sn->length; i++) {
1540 sprintf(p, "%02x", (unsigned int)sn->data[i]);
1543 pairmake(NULL, certs, cert_attr_names[FR_TLS_SERIAL][lookup], buf, T_OP_SET);
1548 * Get the Expiration Date
1551 asn_time = X509_get_notAfter(client_cert);
1552 if (identity && (lookup <= 1) && asn_time &&
1553 (asn_time->length < (int) sizeof(buf))) {
1554 memcpy(buf, (char*) asn_time->data, asn_time->length);
1555 buf[asn_time->length] = '\0';
1556 pairmake(NULL, certs, cert_attr_names[FR_TLS_EXPIRATION][lookup], buf, T_OP_SET);
1560 * Get the Subject & Issuer
1562 subject[0] = issuer[0] = '\0';
1563 X509_NAME_oneline(X509_get_subject_name(client_cert), subject,
1565 subject[sizeof(subject) - 1] = '\0';
1566 if (identity && (lookup <= 1) && subject[0] &&
1567 (strlen(subject) < MAX_STRING_LEN)) {
1568 pairmake(NULL, certs, cert_attr_names[FR_TLS_SUBJECT][lookup], subject, T_OP_SET);
1571 X509_NAME_oneline(X509_get_issuer_name(ctx->current_cert), issuer,
1573 issuer[sizeof(issuer) - 1] = '\0';
1574 if (identity && (lookup <= 1) && issuer[0] &&
1575 (strlen(issuer) < MAX_STRING_LEN)) {
1576 pairmake(NULL, certs, cert_attr_names[FR_TLS_ISSUER][lookup], issuer, T_OP_SET);
1580 * Get the Common Name, if there is a subject.
1582 X509_NAME_get_text_by_NID(X509_get_subject_name(client_cert),
1583 NID_commonName, common_name, sizeof(common_name));
1584 common_name[sizeof(common_name) - 1] = '\0';
1585 if (identity && (lookup <= 1) && common_name[0] && subject[0] &&
1586 (strlen(common_name) < MAX_STRING_LEN)) {
1587 pairmake(NULL, certs, cert_attr_names[FR_TLS_CN][lookup], common_name, T_OP_SET);
1592 * Get the RFC822 Subject Alternative Name
1594 loc = X509_get_ext_by_NID(client_cert, NID_subject_alt_name, 0);
1595 if (lookup <= 1 && loc >= 0) {
1596 X509_EXTENSION *ext = NULL;
1597 GENERAL_NAMES *names = NULL;
1600 if ((ext = X509_get_ext(client_cert, loc)) &&
1601 (names = X509V3_EXT_d2i(ext))) {
1602 for (i = 0; i < sk_GENERAL_NAME_num(names); i++) {
1603 GENERAL_NAME *name = sk_GENERAL_NAME_value(names, i);
1605 switch (name->type) {
1607 if (ASN1_STRING_length(name->d.rfc822Name) >= MAX_STRING_LEN)
1610 pairmake(NULL, certs, cert_attr_names[FR_TLS_SAN_EMAIL][lookup],
1611 (char *) ASN1_STRING_data(name->d.rfc822Name), T_OP_SET);
1614 /* XXX TODO handle other SAN types */
1620 sk_GENERAL_NAME_free(names);
1622 #endif /* GEN_EMAIL */
1625 * If the CRL has expired, that might still be OK.
1628 (conf->allow_expired_crl) &&
1629 (err == X509_V_ERR_CRL_HAS_EXPIRED)) {
1631 X509_STORE_CTX_set_error( ctx, 0 );
1635 char const *p = X509_verify_cert_error_string(err);
1636 ERROR("--> verify error:num=%d:%s\n",err, p);
1637 RDEBUGE("SSL says error %d : %s", err, p);
1641 switch (ctx->error) {
1643 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
1644 ERROR("issuer= %s\n", issuer);
1646 case X509_V_ERR_CERT_NOT_YET_VALID:
1647 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
1648 ERROR("notBefore=");
1650 ASN1_TIME_print(bio_err, X509_get_notBefore(ctx->current_cert));
1653 case X509_V_ERR_CERT_HAS_EXPIRED:
1654 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
1657 ASN1_TIME_print(bio_err, X509_get_notAfter(ctx->current_cert));
1663 * If we're at the actual client cert, apply additional
1668 * If the conf tells us to, check cert issuer
1669 * against the specified value and fail
1670 * verification if they don't match.
1672 if (conf->check_cert_issuer &&
1673 (strcmp(issuer, conf->check_cert_issuer) != 0)) {
1674 radlog(L_AUTH, "rlm_eap_tls: Certificate issuer (%s) does not match specified value (%s)!", issuer, conf->check_cert_issuer);
1679 * If the conf tells us to, check the CN in the
1680 * cert against xlat'ed value, but only if the
1681 * previous checks passed.
1683 if (my_ok && conf->check_cert_cn) {
1684 if (radius_xlat(cn_str, sizeof(cn_str), request, conf->check_cert_cn, NULL, NULL) < 0) {
1685 /* if this fails, fail the verification */
1688 RDEBUG2("checking certificate CN (%s) with xlat'ed value (%s)", common_name, cn_str);
1689 if (strcmp(cn_str, common_name) != 0) {
1690 radlog(L_AUTH, "rlm_eap_tls: Certificate CN (%s) does not match specified value (%s)!", common_name, cn_str);
1694 } /* check_cert_cn */
1696 #ifdef HAVE_OPENSSL_OCSP_H
1697 if (my_ok && conf->ocsp_enable){
1698 RDEBUG2("--> Starting OCSP Request");
1699 if(X509_STORE_CTX_get1_issuer(&issuer_cert, ctx, client_cert)!=1) {
1700 ERROR("Error: Couldn't get issuer_cert for %s", common_name);
1702 my_ok = ocsp_check(ocsp_store, issuer_cert, client_cert, conf);
1706 while (conf->verify_client_cert_cmd) {
1711 snprintf(filename, sizeof(filename), "%s/%s.client.XXXXXXXX",
1712 conf->verify_tmp_dir, progname);
1713 fd = mkstemp(filename);
1715 RDEBUG("Failed creating file in %s: %s",
1716 conf->verify_tmp_dir, strerror(errno));
1720 fp = fdopen(fd, "w");
1722 RDEBUG("Failed opening file %s: %s",
1723 filename, strerror(errno));
1727 if (!PEM_write_X509(fp, client_cert)) {
1729 RDEBUG("Failed writing certificate to file");
1734 if (!pairmake_packet("TLS-Client-Cert-Filename",
1735 filename, T_OP_SET)) {
1736 RDEBUG("Failed creating TLS-Client-Cert-Filename");
1741 RDEBUG("Verifying client certificate: %s",
1742 conf->verify_client_cert_cmd);
1743 if (radius_exec_program(conf->verify_client_cert_cmd,
1744 request, 1, NULL, 0,
1745 request->packet->vps,
1747 radlog(L_AUTH, "rlm_eap_tls: Certificate CN (%s) fails external verification!", common_name);
1750 RDEBUG("Client certificate CN %s passed external validation", common_name);
1761 if (debug_flag > 0) {
1762 RDEBUG2("chain-depth=%d, ", depth);
1763 RDEBUG2("error=%d", err);
1765 if (identity) RDEBUG2("--> User-Name = %s", *identity);
1766 RDEBUG2("--> BUF-Name = %s", common_name);
1767 RDEBUG2("--> subject = %s", subject);
1768 RDEBUG2("--> issuer = %s", issuer);
1769 RDEBUG2("--> verify return:%d", my_ok);
1775 #ifdef HAVE_OPENSSL_OCSP_H
1777 * Create Global X509 revocation store and use it to verify
1780 * - Load the trusted CAs
1781 * - Load the trusted issuer certificates
1783 static X509_STORE *init_revocation_store(fr_tls_server_conf_t *conf)
1785 X509_STORE *store = NULL;
1787 store = X509_STORE_new();
1789 /* Load the CAs we trust */
1790 if (conf->ca_file || conf->ca_path)
1791 if(!X509_STORE_load_locations(store, conf->ca_file, conf->ca_path)) {
1792 ERROR("rlm_eap: X509_STORE error %s", ERR_error_string(ERR_get_error(), NULL));
1793 ERROR("rlm_eap_tls: Error reading Trusted root CA list %s",conf->ca_file );
1797 #ifdef X509_V_FLAG_CRL_CHECK
1798 if (conf->check_crl)
1799 X509_STORE_set_flags(store, X509_V_FLAG_CRL_CHECK);
1803 #endif /* HAVE_OPENSSL_OCSP_H */
1805 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
1806 #ifndef OPENSSL_NO_ECDH
1807 static int set_ecdh_curve(SSL_CTX *ctx, char const *ecdh_curve)
1812 if (!ecdh_curve || !*ecdh_curve) return 0;
1814 nid = OBJ_sn2nid(ecdh_curve);
1816 ERROR("Unknown ecdh_curve \"%s\"", ecdh_curve);
1820 ecdh = EC_KEY_new_by_curve_name(nid);
1822 ERROR("Unable to create new curve \"%s\"", ecdh_curve);
1826 SSL_CTX_set_tmp_ecdh(ctx, ecdh);
1828 SSL_CTX_set_options(ctx, SSL_OP_SINGLE_ECDH_USE);
1838 * DIE OPENSSL DIE DIE DIE
1840 * What a palaver, just to free some data attached the
1841 * session. We need to do this because the "remove" callback
1842 * is called when refcount > 0 sometimes, if another thread
1843 * is using the session
1845 static void sess_free_vps(UNUSED void *parent, void *data_ptr,
1846 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
1847 UNUSED long argl, UNUSED void *argp)
1849 VALUE_PAIR *vp = data_ptr;
1852 DEBUG2(" Freeing cached session VPs %p", vp);
1859 * Create Global context SSL and use it in every new session
1861 * - Load the trusted CAs
1862 * - Load the Private key & the certificate
1863 * - Set the Context options & Verify options
1865 static SSL_CTX *init_tls_ctx(fr_tls_server_conf_t *conf, int client)
1868 X509_STORE *certstore;
1869 int verify_mode = SSL_VERIFY_NONE;
1870 int ctx_options = 0;
1874 * Add all the default ciphers and message digests
1875 * Create our context.
1878 SSL_load_error_strings();
1881 * SHA256 is in all versions of OpenSSL, but isn't
1882 * initialized by default. It's needed for WiMAX
1885 #ifdef HAVE_OPENSSL_EVP_SHA256
1886 EVP_add_digest(EVP_sha256());
1889 ctx = SSL_CTX_new(TLSv1_method());
1892 * Save the config on the context so that callbacks which
1893 * only get SSL_CTX* e.g. session persistence, can get it
1895 SSL_CTX_set_app_data(ctx, conf);
1898 * Identify the type of certificates that needs to be loaded
1900 if (conf->file_type) {
1901 type = SSL_FILETYPE_PEM;
1903 type = SSL_FILETYPE_ASN1;
1907 * Set the password to load private key
1909 if (conf->private_key_password) {
1912 * We don't want to put the private key password in eap.conf, so check
1913 * for our special string which indicates we should get the password
1916 char const* special_string = "Apple:UseCertAdmin";
1917 if (strncmp(conf->private_key_password,
1919 strlen(special_string)) == 0)
1922 const long max_password_len = 128;
1923 snprintf(cmd, sizeof(cmd) - 1,
1924 "/usr/sbin/certadmin --get-private-key-passphrase \"%s\"",
1925 conf->private_key_file);
1927 DEBUG2("rlm_eap: Getting private key passphrase using command \"%s\"", cmd);
1929 FILE* cmd_pipe = popen(cmd, "r");
1931 ERROR("TLS: %s command failed. Unable to get private_key_password", cmd);
1932 ERROR("Error reading private_key_file %s", conf->private_key_file);
1936 talloc_free(conf->private_key_password);
1937 conf->private_key_password = talloc_array(conf, char, max_password_len);
1938 if (!conf->private_key_password) {
1939 ERROR("TLS: Can't allocate space for private_key_password");
1940 ERROR("TLS: Error reading private_key_file %s", conf->private_key_file);
1945 fgets(conf->private_key_password, max_password_len, cmd_pipe);
1948 /* Get rid of newline at end of password. */
1949 conf->private_key_password[strlen(conf->private_key_password) - 1] = '\0';
1950 DEBUG2("rlm_eap: Password from command = \"%s\"", conf->private_key_password);
1953 SSL_CTX_set_default_passwd_cb_userdata(ctx, conf->private_key_password);
1954 SSL_CTX_set_default_passwd_cb(ctx, cbtls_password);
1957 #ifdef PSK_MAX_IDENTITY_LEN
1958 if ((conf->psk_identity && !conf->psk_password) ||
1959 (!conf->psk_identity && conf->psk_password) ||
1960 (conf->psk_identity && !*conf->psk_identity) ||
1961 (conf->psk_password && !*conf->psk_password)) {
1962 ERROR("Invalid PSK Configuration: psk_identity or psk_password are empty");
1966 if (conf->psk_identity) {
1967 size_t psk_len, hex_len;
1968 char buffer[PSK_MAX_PSK_LEN];
1970 if (conf->certificate_file ||
1971 conf->private_key_password || conf->private_key_file ||
1972 conf->ca_file || conf->ca_path) {
1973 ERROR("When PSKs are used, No certificate configuration is permitted");
1978 SSL_CTX_set_psk_client_callback(ctx,
1979 psk_client_callback);
1981 SSL_CTX_set_psk_server_callback(ctx,
1982 psk_server_callback);
1985 psk_len = strlen(conf->psk_password);
1986 if (strlen(conf->psk_password) > (2 * PSK_MAX_PSK_LEN)) {
1987 ERROR("psk_hexphrase is too long (max %d)",
1992 hex_len = fr_hex2bin(conf->psk_password,
1993 (uint8_t *) buffer, psk_len);
1994 if (psk_len != (2 * hex_len)) {
1995 ERROR("psk_hexphrase is not all hex");
2002 (void) client; /* -Wunused */
2006 * Load our keys and certificates
2008 * If certificates are of type PEM then we can make use
2009 * of cert chain authentication using openssl api call
2010 * SSL_CTX_use_certificate_chain_file. Please see how
2011 * the cert chain needs to be given in PEM from
2014 if (!conf->certificate_file) goto load_ca;
2016 if (type == SSL_FILETYPE_PEM) {
2017 if (!(SSL_CTX_use_certificate_chain_file(ctx, conf->certificate_file))) {
2018 ERROR("Error reading certificate file %s:%s",
2019 conf->certificate_file,
2020 ERR_error_string(ERR_get_error(), NULL));
2024 } else if (!(SSL_CTX_use_certificate_file(ctx, conf->certificate_file, type))) {
2025 ERROR("Error reading certificate file %s:%s",
2026 conf->certificate_file,
2027 ERR_error_string(ERR_get_error(), NULL));
2031 /* Load the CAs we trust */
2033 if (conf->ca_file || conf->ca_path) {
2034 if (!SSL_CTX_load_verify_locations(ctx, conf->ca_file, conf->ca_path)) {
2035 ERROR("rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2036 ERROR("rlm_eap_tls: Error reading Trusted root CA list %s",conf->ca_file );
2040 if (conf->ca_file && *conf->ca_file) SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(conf->ca_file));
2042 if (conf->private_key_file) {
2043 if (!(SSL_CTX_use_PrivateKey_file(ctx, conf->private_key_file, type))) {
2044 ERROR("Failed reading private key file %s:%s",
2045 conf->private_key_file,
2046 ERR_error_string(ERR_get_error(), NULL));
2051 * Check if the loaded private key is the right one
2053 if (!SSL_CTX_check_private_key(ctx)) {
2054 ERROR("Private key does not match the certificate public key");
2059 #ifdef PSK_MAX_IDENTITY_LEN
2066 ctx_options |= SSL_OP_NO_SSLv2;
2067 ctx_options |= SSL_OP_NO_SSLv3;
2068 #ifdef SSL_OP_NO_TICKET
2069 ctx_options |= SSL_OP_NO_TICKET ;
2073 * SSL_OP_SINGLE_DH_USE must be used in order to prevent
2074 * small subgroup attacks and forward secrecy. Always
2077 * SSL_OP_SINGLE_DH_USE has an impact on the computer
2078 * time needed during negotiation, but it is not very
2081 ctx_options |= SSL_OP_SINGLE_DH_USE;
2084 * SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS to work around issues
2085 * in Windows Vista client.
2086 * http://www.openssl.org/~bodo/tls-cbc.txt
2087 * http://www.nabble.com/(RADIATOR)-Radiator-Version-3.16-released-t2600070.html
2089 ctx_options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
2091 SSL_CTX_set_options(ctx, ctx_options);
2094 * TODO: Set the RSA & DH
2095 * SSL_CTX_set_tmp_rsa_callback(ctx, cbtls_rsa);
2096 * SSL_CTX_set_tmp_dh_callback(ctx, cbtls_dh);
2100 * set the message callback to identify the type of
2101 * message. For every new session, there can be a
2102 * different callback argument.
2104 * SSL_CTX_set_msg_callback(ctx, cbtls_msg);
2108 * Set eliptical curve crypto configuration.
2110 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
2111 #ifndef OPENSSL_NO_ECDH
2112 if (set_ecdh_curve(ctx, conf->ecdh_curve) < 0) {
2118 /* Set Info callback */
2119 SSL_CTX_set_info_callback(ctx, cbtls_info);
2122 * Callbacks, etc. for session resumption.
2124 if (conf->session_cache_enable) {
2125 SSL_CTX_sess_set_new_cb(ctx, cbtls_new_session);
2126 SSL_CTX_sess_set_get_cb(ctx, cbtls_get_session);
2127 SSL_CTX_sess_set_remove_cb(ctx, cbtls_remove_session);
2129 SSL_CTX_set_quiet_shutdown(ctx, 1);
2130 if (FR_TLS_EX_INDEX_VPS < 0)
2131 FR_TLS_EX_INDEX_VPS = SSL_SESSION_get_ex_new_index(0, NULL, NULL, NULL, sess_free_vps);
2135 * Check the certificates for revocation.
2137 #ifdef X509_V_FLAG_CRL_CHECK
2138 if (conf->check_crl) {
2139 certstore = SSL_CTX_get_cert_store(ctx);
2140 if (certstore == NULL) {
2141 ERROR("rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2142 ERROR("rlm_eap_tls: Error reading Certificate Store");
2145 X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK);
2151 * Always verify the peer certificate
2153 verify_mode |= SSL_VERIFY_PEER;
2154 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
2155 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
2156 SSL_CTX_set_verify(ctx, verify_mode, cbtls_verify);
2158 if (conf->verify_depth) {
2159 SSL_CTX_set_verify_depth(ctx, conf->verify_depth);
2162 /* Load randomness */
2163 if (conf->random_file) {
2164 if (!(RAND_load_file(conf->random_file, 1024*1024))) {
2165 ERROR("rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2166 ERROR("rlm_eap_tls: Error loading randomness");
2172 * Set the cipher list if we were told to
2174 if (conf->cipher_list) {
2175 if (!SSL_CTX_set_cipher_list(ctx, conf->cipher_list)) {
2176 ERROR("rlm_eap_tls: Error setting cipher list");
2182 * Setup session caching
2184 if (conf->session_cache_enable) {
2186 * Create a unique context Id per EAP-TLS configuration.
2188 if (conf->session_id_name) {
2189 snprintf(conf->session_context_id,
2190 sizeof(conf->session_context_id),
2192 conf->session_id_name);
2194 snprintf(conf->session_context_id,
2195 sizeof(conf->session_context_id),
2200 * Cache it, and DON'T auto-clear it.
2202 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_SERVER | SSL_SESS_CACHE_NO_AUTO_CLEAR);
2204 SSL_CTX_set_session_id_context(ctx,
2205 (unsigned char *) conf->session_context_id,
2206 (unsigned int) strlen(conf->session_context_id));
2209 * Our timeout is in hours, this is in seconds.
2211 SSL_CTX_set_timeout(ctx, conf->session_timeout * 3600);
2214 * Set the maximum number of entries in the
2217 SSL_CTX_sess_set_cache_size(ctx, conf->session_cache_size);
2220 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
2228 * Free TLS client/server config
2229 * Should not be called outside this code, as a callback is
2230 * added to automatically free the data when the CONF_SECTION
2233 static void tls_server_conf_free(fr_tls_server_conf_t *conf)
2237 if (conf->ctx) SSL_CTX_free(conf->ctx);
2239 #ifdef HAVE_OPENSSL_OCSP_H
2240 if (conf->ocsp_store) X509_STORE_free(conf->ocsp_store);
2241 conf->ocsp_store = NULL;
2245 memset(conf, 0, sizeof(*conf));
2251 fr_tls_server_conf_t *tls_server_conf_parse(CONF_SECTION *cs)
2253 fr_tls_server_conf_t *conf;
2256 * If cs has already been parsed there should be a cached copy
2257 * of conf already stored, so just return that.
2259 conf = cf_data_find(cs, "tls-conf");
2261 DEBUG(" debug: Using cached TLS configuration from previous invocation");
2265 conf = talloc_zero(cs, fr_tls_server_conf_t);
2267 ERROR("Out of memory");
2271 if (cf_section_parse(cs, conf, tls_server_config) < 0) {
2273 tls_server_conf_free(conf);
2278 * Save people from their own stupidity.
2280 if (conf->fragment_size < 100) conf->fragment_size = 100;
2283 * This magic makes the administrators life HUGELY easier
2284 * on initial deployments.
2286 * If the server starts up in debugging mode, AND the
2287 * bootstrap command is configured, AND it exists, AND
2288 * there is no server certificate
2290 if (conf->make_cert_command && (debug_flag >= 2)) {
2293 if ((stat(conf->make_cert_command, &buf) == 0) &&
2294 (stat(conf->certificate_file, &buf) < 0) &&
2295 (errno == ENOENT) &&
2296 (radius_exec_program(conf->make_cert_command, NULL, 1,
2297 NULL, 0, NULL, NULL, 0) != 0)) {
2302 if (!conf->private_key_file) {
2303 ERROR("TLS Server requires a private key file");
2307 if (!conf->certificate_file) {
2308 ERROR("TLS Server requires a certificate file");
2315 conf->ctx = init_tls_ctx(conf, 0);
2316 if (conf->ctx == NULL) {
2320 #ifdef HAVE_OPENSSL_OCSP_H
2322 * Initialize OCSP Revocation Store
2324 if (conf->ocsp_enable) {
2325 conf->ocsp_store = init_revocation_store(conf);
2326 if (conf->ocsp_store == NULL) goto error;
2328 #endif /*HAVE_OPENSSL_OCSP_H*/
2330 if (load_dh_params(conf->ctx, conf->dh_file) < 0) {
2334 if (generate_eph_rsa_key(conf->ctx) < 0) {
2338 if (conf->verify_tmp_dir) {
2339 if (chmod(conf->verify_tmp_dir, S_IRWXU) < 0) {
2340 ERROR("Failed changing permissions on %s: %s", conf->verify_tmp_dir, strerror(errno));
2345 if (conf->verify_client_cert_cmd && !conf->verify_tmp_dir) {
2346 ERROR("You MUST set the verify directory in order to use verify_client_cmd");
2351 * Cache conf in cs in case we're asked to parse this again.
2353 cf_data_add(cs, "tls-conf", conf, (void *)(void *) tls_server_conf_free);
2358 fr_tls_server_conf_t *tls_client_conf_parse(CONF_SECTION *cs)
2360 fr_tls_server_conf_t *conf;
2362 conf = cf_data_find(cs, "tls-conf");
2364 DEBUG(" debug: Using cached TLS configuration from previous invocation");
2368 conf = talloc_zero(cs, fr_tls_server_conf_t);
2370 ERROR("Out of memory");
2374 if (cf_section_parse(cs, conf, tls_client_config) < 0) {
2376 tls_server_conf_free(conf);
2381 * Save people from their own stupidity.
2383 if (conf->fragment_size < 100) conf->fragment_size = 100;
2388 conf->ctx = init_tls_ctx(conf, 1);
2389 if (conf->ctx == NULL) {
2393 if (load_dh_params(conf->ctx, conf->dh_file) < 0) {
2397 if (generate_eph_rsa_key(conf->ctx) < 0) {
2401 cf_data_add(cs, "tls-conf", conf, (void *)(void *) tls_server_conf_free);
2406 int tls_success(tls_session_t *ssn, REQUEST *request)
2408 VALUE_PAIR *vp, *vps = NULL;
2409 fr_tls_server_conf_t *conf;
2411 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF);
2412 rad_assert(conf != NULL);
2415 * If there's no session resumption, delete the entry
2416 * from the cache. This means either it's disabled
2417 * globally for this SSL context, OR we were told to
2418 * disable it for this user.
2420 * This also means you can't turn it on just for one
2423 if ((!ssn->allow_session_resumption) ||
2424 (((vp = pairfind(request->config_items, 1127, 0, TAG_ANY)) != NULL) &&
2425 (vp->vp_integer == 0))) {
2426 SSL_CTX_remove_session(ssn->ctx,
2428 ssn->allow_session_resumption = 0;
2431 * If we're in a resumed session and it's
2434 if (SSL_session_reused(ssn->ssl)) {
2435 RDEBUG("FAIL: Forcibly stopping session resumption as it is not allowed.");
2440 * Else resumption IS allowed, so we store the
2441 * user data in the cache.
2443 } else if (!SSL_session_reused(ssn->ssl)) {
2446 char buffer[2 * MAX_SESSION_SIZE + 1];
2448 size = ssn->ssl->session->session_id_length;
2449 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
2451 fr_bin2hex(ssn->ssl->session->session_id, buffer, size);
2453 vp = paircopy2(NULL, request->reply->vps, PW_USER_NAME, 0, TAG_ANY);
2454 if (vp) pairadd(&vps, vp);
2456 vp = paircopy2(NULL, request->packet->vps, PW_STRIPPED_USER_NAME, 0, TAG_ANY);
2457 if (vp) pairadd(&vps, vp);
2459 vp = paircopy2(NULL, request->reply->vps, PW_CACHED_SESSION_POLICY, 0, TAG_ANY);
2460 if (vp) pairadd(&vps, vp);
2462 certs = (VALUE_PAIR **)SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CERTS);
2465 * Hmm... the certs should probably be session data.
2469 * @todo: some go into reply, others into
2472 pairadd(&vps, paircopy(NULL, *certs));
2476 RDEBUG2("Saving session %s vps %p in the cache", buffer, vps);
2477 SSL_SESSION_set_ex_data(ssn->ssl->session,
2478 FR_TLS_EX_INDEX_VPS, vps);
2479 if (conf->session_cache_path) {
2480 /* write the VPs to the cache file */
2481 char filename[256], buf[1024];
2484 snprintf(filename, sizeof(filename), "%s%c%s.vps",
2485 conf->session_cache_path, FR_DIR_SEP, buffer
2487 vp_file = fopen(filename, "w");
2488 if (vp_file == NULL) {
2489 RDEBUG2("Could not write session VPs to persistent cache: %s", strerror(errno));
2491 /* generate a dummy user-style entry which is easy to read back */
2492 fprintf(vp_file, "# SSL cached session\n");
2493 fprintf(vp_file, "%s\n", buffer);
2494 for (vp=vps; vp; vp = vp->next) {
2495 vp_prints(buf, sizeof(buf), vp);
2496 fprintf(vp_file, "\t%s%s\n", buf, vp->next ? "," : "");
2502 RDEBUG2W("No information to cache: session caching will be disabled for session %s", buffer);
2503 SSL_CTX_remove_session(ssn->ctx,
2508 * Else the session WAS allowed. Copy the cached
2513 char buffer[2 * MAX_SESSION_SIZE + 1];
2515 size = ssn->ssl->session->session_id_length;
2516 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
2518 fr_bin2hex(ssn->ssl->session->session_id, buffer, size);
2520 vps = SSL_SESSION_get_ex_data(ssn->ssl->session,
2521 FR_TLS_EX_INDEX_VPS);
2523 RDEBUGW("No information in cached session %s", buffer);
2527 RDEBUG("Adding cached attributes for session %s:",
2529 debug_pair_list(vps);
2531 for (vp = vps; vp != NULL; vp = vp->next) {
2533 * TLS-* attrs get added back to
2536 if ((vp->da->vendor == 0) &&
2537 (vp->da->attr >= 1910) &&
2538 (vp->da->attr < 1929)) {
2539 pairadd(&request->packet->vps,
2540 paircopyvp(request->packet, vp));
2542 pairadd(&request->reply->vps,
2543 paircopyvp(request->packet, vp));
2547 if (conf->session_cache_path) {
2548 /* "touch" the cached session/vp file */
2551 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
2552 conf->session_cache_path, FR_DIR_SEP, buffer
2554 utime(filename, NULL);
2555 snprintf(filename, sizeof(filename), "%s%c%s.vps",
2556 conf->session_cache_path, FR_DIR_SEP, buffer
2558 utime(filename, NULL);
2562 * Mark the request as resumed.
2564 pairmake_packet("EAP-Session-Resumed", "1", T_OP_SET);
2572 void tls_fail(tls_session_t *ssn)
2575 * Force the session to NOT be cached.
2577 SSL_CTX_remove_session(ssn->ctx, ssn->ssl->session);
2580 fr_tls_status_t tls_application_data(tls_session_t *ssn,
2587 * Decrypt the complete record.
2589 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data,
2590 ssn->dirty_in.used);
2591 if (err != (int) ssn->dirty_in.used) {
2592 record_init(&ssn->dirty_in);
2593 RDEBUG("Failed writing %d to SSL BIO: %d",
2594 ssn->dirty_in.used, err);
2599 * Clear the dirty buffer now that we are done with it
2600 * and init the clean_out buffer to store decrypted data
2602 record_init(&ssn->dirty_in);
2603 record_init(&ssn->clean_out);
2606 * Read (and decrypt) the tunneled data from the
2607 * SSL session, and put it into the decrypted
2610 err = SSL_read(ssn->ssl, ssn->clean_out.data,
2611 sizeof(ssn->clean_out.data));
2616 RDEBUG("SSL_read Error");
2618 code = SSL_get_error(ssn->ssl, err);
2620 case SSL_ERROR_WANT_READ:
2621 DEBUG("Error in fragmentation logic: SSL_WANT_READ");
2622 return FR_TLS_MORE_FRAGMENTS;
2624 case SSL_ERROR_WANT_WRITE:
2625 DEBUG("Error in fragmentation logic: SSL_WANT_WRITE");
2629 DEBUG("Error in fragmentation logic: ?");
2632 * FIXME: Call int_ssl_check?
2640 RDEBUGW("No data inside of the tunnel.");
2644 * Passed all checks, successfully decrypted data
2646 ssn->clean_out.used = err;
2653 * Acknowledge received is for one of the following messages sent earlier
2654 * 1. Handshake completed Message, so now send, EAP-Success
2655 * 2. Alert Message, now send, EAP-Failure
2656 * 3. Fragment Message, now send, next Fragment
2658 fr_tls_status_t tls_ack_handler(tls_session_t *ssn, REQUEST *request)
2660 RDEBUG2("Received TLS ACK");
2663 radlog_request(L_ERR, 0, request, "FAIL: Unexpected ACK received. Could not obtain session information.");
2664 return FR_TLS_INVALID;
2666 if (ssn->info.initialized == 0) {
2667 RDEBUG("No SSL info available. Waiting for more SSL data.");
2668 return FR_TLS_REQUEST;
2670 if ((ssn->info.content_type == handshake) &&
2671 (ssn->info.origin == 0)) {
2672 radlog_request(L_ERR, 0, request, "FAIL: ACK without earlier message.");
2673 return FR_TLS_INVALID;
2676 switch (ssn->info.content_type) {
2678 RDEBUG2("ACK alert");
2682 if ((ssn->info.handshake_type == finished) &&
2683 (ssn->dirty_out.used == 0)) {
2684 RDEBUG2("ACK handshake is finished");
2687 * From now on all the content is
2688 * application data set it here as nobody else
2691 ssn->info.content_type = application_data;
2692 return FR_TLS_SUCCESS;
2693 } /* else more data to send */
2695 RDEBUG2("ACK handshake fragment handler");
2696 /* Fragmentation handler, send next fragment */
2697 return FR_TLS_REQUEST;
2699 case application_data:
2700 RDEBUG2("ACK handshake fragment handler in application data");
2701 return FR_TLS_REQUEST;
2704 * For the rest of the conditions, switch over
2705 * to the default section below.
2708 RDEBUG2("ACK default");
2709 radlog_request(L_ERR, 0, request, "Invalid ACK received: %d",
2710 ssn->info.content_type);
2711 return FR_TLS_INVALID;
2715 #endif /* WITH_TLS */