6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2001 hereUare Communications, Inc. <raghud@hereuare.com>
21 * Copyright 2003 Alan DeKok <aland@freeradius.org>
22 * Copyright 2006 The FreeRADIUS server project
26 USES_APPLE_DEPRECATED_API /* OpenSSL API has been deprecated by Apple */
28 #include <freeradius-devel/radiusd.h>
29 #include <freeradius-devel/process.h>
30 #include <freeradius-devel/rad_assert.h>
32 #ifdef HAVE_SYS_STAT_H
46 #ifdef HAVE_OPENSSL_RAND_H
47 #include <openssl/rand.h>
50 #ifdef HAVE_OPENSSL_OCSP_H
51 #include <openssl/ocsp.h>
54 #ifdef ENABLE_OPENSSL_VERSION_CHECK
55 typedef struct libssl_defect {
64 /* Record critical defects in libssl here (newest first)*/
65 static libssl_defect_t libssl_defects[] =
68 .low = 0x010001000, /* 1.0.1 */
69 .high = 0x01000106f, /* 1.0.1f */
70 .id = "CVE-2014-0160",
72 .comment = "For more information see http://heartbleed.com"
77 /* index we use to store cached session VPs
78 * needs to be dynamic so we can supply a "free" function
80 static int fr_tls_ex_index_vps = -1;
81 int fr_tls_ex_index_certs = -1;
84 static void record_init(record_t *buf);
85 static void record_close(record_t *buf);
86 static unsigned int record_plus(record_t *buf, void const *ptr,
88 static unsigned int record_minus(record_t *buf, void *ptr,
91 #ifdef PSK_MAX_IDENTITY_LEN
92 static bool identity_is_safe(const char *identity)
96 if (!identity) return true;
98 while ((c = *(identity++)) != '\0') {
99 if (isalpha((int) c) || isdigit((int) c) || isspace((int) c) ||
100 (c == '@') || (c == '-') || (c == '_') || (c == '.')) {
112 * When a client uses TLS-PSK to talk to a server, this callback
113 * is used by the server to determine the PSK to use.
115 static unsigned int psk_server_callback(SSL *ssl, const char *identity,
117 unsigned int max_psk_len)
119 unsigned int psk_len = 0;
120 fr_tls_server_conf_t *conf;
123 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl,
124 FR_TLS_EX_INDEX_CONF);
127 request = (REQUEST *)SSL_get_ex_data(ssl,
128 FR_TLS_EX_INDEX_REQUEST);
129 if (request && conf->psk_query) {
132 char buffer[2 * PSK_MAX_PSK_LEN + 4]; /* allow for too-long keys */
135 * The passed identity is weird. Deny it.
137 if (!identity_is_safe(identity)) {
138 RWDEBUG("Invalid characters in PSK identity %s", identity);
142 vp = pairmake_packet("TLS-PSK-Identity", identity, T_OP_SET);
145 hex_len = radius_xlat(buffer, sizeof(buffer), request, conf->psk_query,
148 RWDEBUG("PSK expansion returned an empty string.");
153 * The returned key is truncated at MORE than
154 * OpenSSL can handle. That way we can detect
155 * the truncation, and complain about it.
157 if (hex_len > (2 * max_psk_len)) {
158 RWDEBUG("Returned PSK is too long (%u > %u)",
159 (unsigned int) hex_len, 2 * max_psk_len);
164 * Leave the TLS-PSK-Identity in the request, and
165 * convert the expansion from printable string
168 return fr_hex2bin(psk, max_psk_len, buffer, hex_len);
171 if (!conf->psk_identity) {
172 DEBUG("No static PSK identity set. Rejecting the user");
177 * No REQUEST, or no dynamic query. Just look for a
180 if (strcmp(identity, conf->psk_identity) != 0) {
181 ERROR("Supplied PSK identity %s does not match configuration. Rejecting.",
186 psk_len = strlen(conf->psk_password);
187 if (psk_len > (2 * max_psk_len)) return 0;
189 return fr_hex2bin(psk, max_psk_len, conf->psk_password, psk_len);
192 static unsigned int psk_client_callback(SSL *ssl, UNUSED char const *hint,
193 char *identity, unsigned int max_identity_len,
194 unsigned char *psk, unsigned int max_psk_len)
196 unsigned int psk_len;
197 fr_tls_server_conf_t *conf;
199 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl,
200 FR_TLS_EX_INDEX_CONF);
203 psk_len = strlen(conf->psk_password);
204 if (psk_len > (2 * max_psk_len)) return 0;
206 strlcpy(identity, conf->psk_identity, max_identity_len);
208 return fr_hex2bin(psk, max_psk_len, conf->psk_password, psk_len);
213 static int _tls_session_free(tls_session_t *ssn)
216 * Free any opaque TTLS or PEAP data.
218 if ((ssn->opaque) && (ssn->free_opaque)) {
219 ssn->free_opaque(ssn->opaque);
228 tls_session_t *tls_new_client_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, int fd)
231 tls_session_t *ssn = NULL;
234 ssn = talloc_zero(ctx, tls_session_t);
235 if (!ssn) return NULL;
237 talloc_set_destructor(ssn, _tls_session_free);
239 ssn->ctx = conf->ctx;
241 SSL_CTX_set_mode(ssn->ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_AUTO_RETRY);
243 ssn->ssl = SSL_new(ssn->ctx);
249 request = request_alloc(ssn);
250 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_REQUEST, (void *)request);
253 * Add the message callback to identify what type of
254 * message/handshake is passed
256 SSL_set_msg_callback(ssn->ssl, cbtls_msg);
257 SSL_set_msg_callback_arg(ssn->ssl, ssn);
258 SSL_set_info_callback(ssn->ssl, cbtls_info);
261 * Always verify the peer certificate.
263 DEBUG2("Requiring Server certificate");
264 verify_mode = SSL_VERIFY_PEER;
265 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
266 SSL_set_verify(ssn->ssl, verify_mode, cbtls_verify);
268 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
269 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_SSN, (void *)ssn);
270 SSL_set_fd(ssn->ssl, fd);
271 if (SSL_connect(ssn->ssl) <= 0) {
273 while ((err = ERR_get_error())) {
274 ERROR("tls: %s", ERR_error_string(err, NULL));
281 ssn->offset = conf->fragment_size;
286 tls_session_t *tls_new_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, REQUEST *request, bool client_cert)
288 tls_session_t *state = NULL;
293 rad_assert(request != NULL);
296 * Manually flush the sessions every so often. If HALF
297 * of the session lifetime has passed since we last
298 * flushed, then flush it again.
300 * FIXME: Also do it every N sessions?
302 if (conf->session_cache_enable &&
303 ((conf->session_last_flushed + ((int)conf->session_timeout * 1800)) <= request->timestamp)){
304 RDEBUG2("Flushing SSL sessions (of #%ld)",
305 SSL_CTX_sess_number(conf->ctx));
307 SSL_CTX_flush_sessions(conf->ctx, request->timestamp);
308 conf->session_last_flushed = request->timestamp;
311 if ((new_tls = SSL_new(conf->ctx)) == NULL) {
312 ERROR("SSL: Error creating new SSL: %s",
313 ERR_error_string(ERR_get_error(), NULL));
317 /* We use the SSL's "app_data" to indicate a call-back */
318 SSL_set_app_data(new_tls, NULL);
320 if ((state = talloc_zero(ctx, tls_session_t)) == NULL) {
321 ERROR("SSL: Error allocating memory for SSL state");
325 talloc_set_destructor(state, _tls_session_free);
327 state->ctx = conf->ctx;
328 state->ssl = new_tls;
331 * Initialize callbacks
333 state->record_init = record_init;
334 state->record_close = record_close;
335 state->record_plus = record_plus;
336 state->record_minus = record_minus;
339 * Create & hook the BIOs to handle the dirty side of the
340 * SSL. This is *very important* as we want to handle
341 * the transmission part. Now the only IO interface
342 * that SSL is aware of, is our defined BIO buffers.
344 * This means that all SSL IO is done to/from memory,
345 * and we can update those BIOs from the packets we've
348 state->into_ssl = BIO_new(BIO_s_mem());
349 state->from_ssl = BIO_new(BIO_s_mem());
350 SSL_set_bio(state->ssl, state->into_ssl, state->from_ssl);
353 * Add the message callback to identify what type of
354 * message/handshake is passed
356 SSL_set_msg_callback(new_tls, cbtls_msg);
357 SSL_set_msg_callback_arg(new_tls, state);
358 SSL_set_info_callback(new_tls, cbtls_info);
361 * In Server mode we only accept.
363 SSL_set_accept_state(state->ssl);
366 * Verify the peer certificate, if asked.
369 RDEBUG2("Requiring client certificate");
370 verify_mode = SSL_VERIFY_PEER;
371 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
372 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
374 SSL_set_verify(state->ssl, verify_mode, cbtls_verify);
376 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
377 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_SSN, (void *)state);
378 state->length_flag = conf->include_length;
381 * We use default fragment size, unless the Framed-MTU
382 * tells us it's too big. Note that we do NOT account
383 * for the EAP-TLS headers if conf->fragment_size is
384 * large, because that config item looks to be confusing.
386 * i.e. it should REALLY be called MTU, and the code here
387 * should figure out what that means for TLS fragment size.
388 * asking the administrator to know the internal details
389 * of EAP-TLS in order to calculate fragment sizes is
392 state->offset = conf->fragment_size;
393 vp = pairfind(request->packet->vps, PW_FRAMED_MTU, 0, TAG_ANY);
394 if (vp && (vp->vp_integer > 100) && (vp->vp_integer < state->offset)) {
395 state->offset = vp->vp_integer;
398 if (conf->session_cache_enable) state->allow_session_resumption = true; /* otherwise it's false */
406 * Print out some text describing the error.
408 static int int_ssl_check(REQUEST *request, SSL *s, int ret, char const *text)
413 if ((l = ERR_get_error()) != 0) {
414 char const *p = ERR_error_string(l, NULL);
416 if (request && p) REDEBUG("SSL says: %s", p);
418 e = SSL_get_error(s, ret);
422 * These seem to be harmless and already "dealt
423 * with" by our non-blocking environment. NB:
424 * "ZERO_RETURN" is the clean "error"
425 * indicating a successfully closed SSL
426 * tunnel. We let this happen because our IO
427 * loop should not appear to have broken on
428 * this condition - and outside the IO loop, the
429 * "shutdown" state is checked.
431 * Don't print anything if we ignore the error.
434 case SSL_ERROR_WANT_READ:
435 case SSL_ERROR_WANT_WRITE:
436 case SSL_ERROR_WANT_X509_LOOKUP:
437 case SSL_ERROR_ZERO_RETURN:
441 * These seem to be indications of a genuine
442 * error that should result in the SSL tunnel
443 * being regarded as "dead".
445 case SSL_ERROR_SYSCALL:
446 ERROR("SSL: %s failed in a system call (%d), TLS session fails.",
451 ERROR("SSL: %s failed inside of TLS (%d), TLS session fails.",
457 * For any other errors that (a) exist, and (b)
458 * crop up - we need to interpret what to do with
459 * them - so "politely inform" the caller that
460 * the code needs updating here.
462 ERROR("SSL: FATAL SSL error ..... %d\n", e);
470 * We are the server, we always get the dirty data
471 * (Handshake data is also considered as dirty data)
472 * During handshake, since SSL API handles itself,
473 * After clean-up, dirty_out will be filled with
474 * the data required for handshaking. So we check
475 * if dirty_out is empty then we simply send it back.
476 * As of now, if handshake is successful, then we keep going,
479 * Fill the Bio with the dirty data to clean it
480 * Get the cleaned data from SSL, if it is not Handshake data
482 int tls_handshake_recv(REQUEST *request, tls_session_t *ssn)
486 if (ssn->invalid_hb_used) return 0;
488 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data, ssn->dirty_in.used);
489 if (err != (int) ssn->dirty_in.used) {
490 RDEBUG("Failed writing %d to SSL BIO: %d", ssn->dirty_in.used,
492 record_init(&ssn->dirty_in);
495 record_init(&ssn->dirty_in);
497 err = SSL_read(ssn->ssl, ssn->clean_out.data + ssn->clean_out.used,
498 sizeof(ssn->clean_out.data) - ssn->clean_out.used);
500 ssn->clean_out.used += err;
504 if (!int_ssl_check(request, ssn->ssl, err, "SSL_read")) {
508 /* Some Extra STATE information for easy debugging */
509 if (SSL_is_init_finished(ssn->ssl)) {
510 DEBUG2("SSL Connection Established\n");
512 if (SSL_in_init(ssn->ssl)) {
513 DEBUG2("In SSL Handshake Phase\n");
515 if (SSL_in_before(ssn->ssl)) {
516 DEBUG2("Before SSL Handshake Phase\n");
518 if (SSL_in_accept_init(ssn->ssl)) {
519 DEBUG2("In SSL Accept mode \n");
521 if (SSL_in_connect_init(ssn->ssl)) {
522 DEBUG2("In SSL Connect mode \n");
525 err = BIO_ctrl_pending(ssn->from_ssl);
527 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
528 sizeof(ssn->dirty_out.data));
530 ssn->dirty_out.used = err;
532 } else if (BIO_should_retry(ssn->from_ssl)) {
533 record_init(&ssn->dirty_in);
534 DEBUG2(" tls: Asking for more data in tunnel");
538 int_ssl_check(request, ssn->ssl, err, "BIO_read");
539 record_init(&ssn->dirty_in);
543 DEBUG2("SSL Application Data");
544 /* Its clean application data, do whatever we want */
545 record_init(&ssn->clean_out);
548 /* We are done with dirty_in, reinitialize it */
549 record_init(&ssn->dirty_in);
554 * Take cleartext user data, and encrypt it into the output buffer,
555 * to send to the client at the other end of the SSL connection.
557 int tls_handshake_send(REQUEST *request, tls_session_t *ssn)
562 * If there's un-encrypted data in 'clean_in', then write
563 * that data to the SSL session, and then call the BIO function
564 * to get that encrypted data from the SSL session, into
565 * a buffer which we can then package into an EAP packet.
567 * Based on Server's logic this clean_in is expected to
568 * contain the data to send to the client.
570 if (ssn->clean_in.used > 0) {
573 written = SSL_write(ssn->ssl, ssn->clean_in.data, ssn->clean_in.used);
574 record_minus(&ssn->clean_in, NULL, written);
576 /* Get the dirty data from Bio to send it */
577 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
578 sizeof(ssn->dirty_out.data));
580 ssn->dirty_out.used = err;
582 int_ssl_check(request, ssn->ssl, err, "handshake_send");
589 void session_init(tls_session_t *ssn)
592 ssn->into_ssl = ssn->from_ssl = NULL;
593 record_init(&ssn->clean_in);
594 record_init(&ssn->clean_out);
595 record_init(&ssn->dirty_in);
596 record_init(&ssn->dirty_out);
598 memset(&ssn->info, 0, sizeof(ssn->info));
602 ssn->tls_msg_len = 0;
603 ssn->length_flag = 0;
605 ssn->free_opaque = NULL;
608 void session_close(tls_session_t *ssn)
610 SSL_set_quiet_shutdown(ssn->ssl, 1);
611 SSL_shutdown(ssn->ssl);
618 record_close(&ssn->clean_in);
619 record_close(&ssn->clean_out);
620 record_close(&ssn->dirty_in);
621 record_close(&ssn->dirty_out);
625 static void record_init(record_t *rec)
630 static void record_close(record_t *rec)
637 * Copy data to the intermediate buffer, before we send
640 static unsigned int record_plus(record_t *rec, void const *ptr,
643 unsigned int added = MAX_RECORD_SIZE - rec->used;
649 memcpy(rec->data + rec->used, ptr, added);
655 * Take data from the buffer, and give it to the caller.
657 static unsigned int record_minus(record_t *rec, void *ptr,
660 unsigned int taken = rec->used;
667 memcpy(ptr, rec->data, taken);
671 * This is pretty bad...
674 memmove(rec->data, rec->data + taken, rec->used);
678 void tls_session_information(tls_session_t *tls_session)
680 char const *str_write_p, *str_version, *str_content_type = "";
681 char const *str_details1 = "", *str_details2= "";
685 * Don't print this out in the normal course of
688 if (debug_flag == 0) {
692 str_write_p = tls_session->info.origin ? ">>>" : "<<<";
694 switch (tls_session->info.version) {
696 str_version = "SSL 2.0";
699 str_version = "SSL 3.0 ";
702 str_version = "TLS 1.0 ";
705 str_version = "Unknown TLS version";
709 if (tls_session->info.version == SSL3_VERSION ||
710 tls_session->info.version == TLS1_VERSION) {
711 switch (tls_session->info.content_type) {
712 case SSL3_RT_CHANGE_CIPHER_SPEC:
713 str_content_type = "ChangeCipherSpec";
717 str_content_type = "Alert";
720 case SSL3_RT_HANDSHAKE:
721 str_content_type = "Handshake";
724 case SSL3_RT_APPLICATION_DATA:
725 str_content_type = "ApplicationData";
729 str_content_type = "UnknownContentType";
733 if (tls_session->info.content_type == SSL3_RT_ALERT) {
734 str_details1 = ", ???";
736 if (tls_session->info.record_len == 2) {
738 switch (tls_session->info.alert_level) {
739 case SSL3_AL_WARNING:
740 str_details1 = ", warning";
743 str_details1 = ", fatal";
747 str_details2 = " ???";
748 switch (tls_session->info.alert_description) {
749 case SSL3_AD_CLOSE_NOTIFY:
750 str_details2 = " close_notify";
753 case SSL3_AD_UNEXPECTED_MESSAGE:
754 str_details2 = " unexpected_message";
757 case SSL3_AD_BAD_RECORD_MAC:
758 str_details2 = " bad_record_mac";
761 case TLS1_AD_DECRYPTION_FAILED:
762 str_details2 = " decryption_failed";
765 case TLS1_AD_RECORD_OVERFLOW:
766 str_details2 = " record_overflow";
769 case SSL3_AD_DECOMPRESSION_FAILURE:
770 str_details2 = " decompression_failure";
773 case SSL3_AD_HANDSHAKE_FAILURE:
774 str_details2 = " handshake_failure";
777 case SSL3_AD_BAD_CERTIFICATE:
778 str_details2 = " bad_certificate";
781 case SSL3_AD_UNSUPPORTED_CERTIFICATE:
782 str_details2 = " unsupported_certificate";
785 case SSL3_AD_CERTIFICATE_REVOKED:
786 str_details2 = " certificate_revoked";
789 case SSL3_AD_CERTIFICATE_EXPIRED:
790 str_details2 = " certificate_expired";
793 case SSL3_AD_CERTIFICATE_UNKNOWN:
794 str_details2 = " certificate_unknown";
797 case SSL3_AD_ILLEGAL_PARAMETER:
798 str_details2 = " illegal_parameter";
801 case TLS1_AD_UNKNOWN_CA:
802 str_details2 = " unknown_ca";
805 case TLS1_AD_ACCESS_DENIED:
806 str_details2 = " access_denied";
809 case TLS1_AD_DECODE_ERROR:
810 str_details2 = " decode_error";
813 case TLS1_AD_DECRYPT_ERROR:
814 str_details2 = " decrypt_error";
817 case TLS1_AD_EXPORT_RESTRICTION:
818 str_details2 = " export_restriction";
821 case TLS1_AD_PROTOCOL_VERSION:
822 str_details2 = " protocol_version";
825 case TLS1_AD_INSUFFICIENT_SECURITY:
826 str_details2 = " insufficient_security";
829 case TLS1_AD_INTERNAL_ERROR:
830 str_details2 = " internal_error";
833 case TLS1_AD_USER_CANCELLED:
834 str_details2 = " user_canceled";
837 case TLS1_AD_NO_RENEGOTIATION:
838 str_details2 = " no_renegotiation";
844 if (tls_session->info.content_type == SSL3_RT_HANDSHAKE) {
845 str_details1 = "???";
847 if (tls_session->info.record_len > 0) switch (tls_session->info.handshake_type) {
848 case SSL3_MT_HELLO_REQUEST:
849 str_details1 = ", HelloRequest";
852 case SSL3_MT_CLIENT_HELLO:
853 str_details1 = ", ClientHello";
856 case SSL3_MT_SERVER_HELLO:
857 str_details1 = ", ServerHello";
860 case SSL3_MT_CERTIFICATE:
861 str_details1 = ", Certificate";
864 case SSL3_MT_SERVER_KEY_EXCHANGE:
865 str_details1 = ", ServerKeyExchange";
868 case SSL3_MT_CERTIFICATE_REQUEST:
869 str_details1 = ", CertificateRequest";
872 case SSL3_MT_SERVER_DONE:
873 str_details1 = ", ServerHelloDone";
876 case SSL3_MT_CERTIFICATE_VERIFY:
877 str_details1 = ", CertificateVerify";
880 case SSL3_MT_CLIENT_KEY_EXCHANGE:
881 str_details1 = ", ClientKeyExchange";
884 case SSL3_MT_FINISHED:
885 str_details1 = ", Finished";
891 snprintf(tls_session->info.info_description,
892 sizeof(tls_session->info.info_description),
893 "%s %s%s [length %04lx]%s%s\n",
894 str_write_p, str_version, str_content_type,
895 (unsigned long)tls_session->info.record_len,
896 str_details1, str_details2);
898 request = SSL_get_ex_data(tls_session->ssl, FR_TLS_EX_INDEX_REQUEST);
900 RDEBUG2("%s", tls_session->info.info_description);
902 DEBUG2("%s", tls_session->info.info_description);
906 static CONF_PARSER cache_config[] = {
907 { "enable", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, session_cache_enable), "no" },
908 { "lifetime", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, session_timeout), "24" },
909 { "max_entries", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, session_cache_size), "255" },
910 { "name", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, session_id_name), NULL },
911 { "persist_dir", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, session_cache_path), NULL },
912 { NULL, -1, 0, NULL, NULL } /* end the list */
915 static CONF_PARSER verify_config[] = {
916 { "tmpdir", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, verify_tmp_dir), NULL },
917 { "client", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, verify_client_cert_cmd), NULL },
918 { NULL, -1, 0, NULL, NULL } /* end the list */
921 #ifdef HAVE_OPENSSL_OCSP_H
922 static CONF_PARSER ocsp_config[] = {
923 { "enable", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_enable), "no" },
924 { "override_cert_url", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_override_url), "no" },
925 { "url", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ocsp_url), NULL },
926 { "use_nonce", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_use_nonce), "yes" },
927 { "timeout", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, ocsp_timeout), "yes" },
928 { "softfail", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_softfail), "no" },
929 { NULL, -1, 0, NULL, NULL } /* end the list */
933 static CONF_PARSER tls_server_config[] = {
934 { "rsa_key_exchange", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, rsa_key), "no" },
935 { "dh_key_exchange", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, dh_key), "yes" },
936 { "rsa_key_length", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, rsa_key_length), "512" },
937 { "dh_key_length", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, dh_key_length), "512" },
938 { "verify_depth", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, verify_depth), "0" },
939 { "CA_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED, fr_tls_server_conf_t, ca_path), NULL },
940 { "ca_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_path), NULL },
941 { "pem_file_type", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, file_type), "yes" },
942 { "private_key_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, private_key_file), NULL },
943 { "certificate_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, certificate_file), NULL },
944 { "CA_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED, fr_tls_server_conf_t, ca_file), NULL },
945 { "ca_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_file), NULL },
946 { "private_key_password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, private_key_password), NULL },
947 #ifdef PSK_MAX_IDENTITY_LEN
948 { "psk_identity", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, psk_identity), NULL },
949 { "psk_hexphrase", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, psk_password), NULL },
950 { "psk_query", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, psk_query), NULL },
952 { "dh_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, dh_file), NULL },
953 { "random_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, random_file), NULL },
954 { "fragment_size", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, fragment_size), "1024" },
955 { "include_length", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, include_length), "yes" },
956 { "check_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, check_crl), "no" },
957 { "allow_expired_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, allow_expired_crl), NULL },
958 { "check_cert_cn", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_cn), NULL },
959 { "cipher_list", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, cipher_list), NULL },
960 { "check_cert_issuer", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_issuer), NULL },
961 { "require_client_cert", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, require_client_cert), NULL },
963 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
964 #ifndef OPENSSL_NO_ECDH
965 { "ecdh_curve", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ecdh_curve), "prime256v1" },
969 { "disable_tlsv1_1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_1), NULL },
970 { "disable_tlsv1_2", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_2), NULL },
972 { "cache", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) cache_config },
974 { "verify", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) verify_config },
976 #ifdef HAVE_OPENSSL_OCSP_H
977 { "ocsp", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) ocsp_config },
980 { NULL, -1, 0, NULL, NULL } /* end the list */
984 static CONF_PARSER tls_client_config[] = {
985 { "rsa_key_exchange", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, rsa_key), "no" },
986 { "dh_key_exchange", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, dh_key), "yes" },
987 { "rsa_key_length", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, rsa_key_length), "512" },
988 { "dh_key_length", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, dh_key_length), "512" },
989 { "verify_depth", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, verify_depth), "0" },
990 { "ca_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_path), NULL },
991 { "pem_file_type", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, file_type), "yes" },
992 { "private_key_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, private_key_file), NULL },
993 { "certificate_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, certificate_file), NULL },
994 { "ca_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_file), NULL },
995 { "private_key_password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, private_key_password), NULL },
996 { "dh_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, dh_file), NULL },
997 { "random_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, random_file), NULL },
998 { "fragment_size", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, fragment_size), "1024" },
999 { "include_length", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, include_length), "yes" },
1000 { "check_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, check_crl), "no" },
1001 { "check_cert_cn", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_cn), NULL },
1002 { "cipher_list", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, cipher_list), NULL },
1003 { "check_cert_issuer", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_issuer), NULL },
1005 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
1006 #ifndef OPENSSL_NO_ECDH
1007 { "ecdh_curve", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ecdh_curve), "prime256v1" },
1011 #ifdef SSL_OP_NO_TLSv1_1
1012 { "disable_tlsv1_1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_1), NULL },
1014 #ifdef SSL_OP_NO_TLSv1_2
1015 { "disable_tlsv1_2", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_2), NULL },
1018 { NULL, -1, 0, NULL, NULL } /* end the list */
1023 * TODO: Check for the type of key exchange * like conf->dh_key
1025 static int load_dh_params(SSL_CTX *ctx, char *file)
1030 if (!file) return 0;
1032 if ((bio = BIO_new_file(file, "r")) == NULL) {
1033 ERROR("tls: Unable to open DH file - %s", file);
1037 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
1040 WARN("tls: Unable to set DH parameters. DH cipher suites may not work!");
1041 WARN("Fix this by running the OpenSSL command listed in eap.conf");
1045 if (SSL_CTX_set_tmp_dh(ctx, dh) < 0) {
1046 ERROR("tls: Unable to set DH parameters");
1057 * Print debugging messages, and free data.
1059 * FIXME: Write sessions to some long-term storage, so that
1060 * session resumption can still occur after the server
1063 #define MAX_SESSION_SIZE (256)
1065 static void cbtls_remove_session(SSL_CTX *ctx, SSL_SESSION *sess)
1068 char buffer[2 * MAX_SESSION_SIZE + 1];
1069 fr_tls_server_conf_t *conf;
1071 size = sess->session_id_length;
1072 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1074 fr_bin2hex(buffer, sess->session_id, size);
1076 DEBUG2(" SSL: Removing session %s from the cache", buffer);
1077 conf = (fr_tls_server_conf_t *)SSL_CTX_get_app_data(ctx);
1078 if (conf && conf->session_cache_path) {
1082 /* remove session and any cached VPs */
1083 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1084 conf->session_cache_path, FR_DIR_SEP, buffer);
1085 rv = unlink(filename);
1087 DEBUG2(" SSL: could not remove persisted session file %s: %s", filename, fr_syserror(errno));
1089 /* VPs might be absent; might not have been written to disk yet */
1090 snprintf(filename, sizeof(filename), "%s%c%s.vps",
1091 conf->session_cache_path, FR_DIR_SEP, buffer);
1098 static int cbtls_new_session(SSL *ssl, SSL_SESSION *sess)
1101 char buffer[2 * MAX_SESSION_SIZE + 1];
1102 fr_tls_server_conf_t *conf;
1103 unsigned char *sess_blob = NULL;
1105 size = sess->session_id_length;
1106 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1108 fr_bin2hex(buffer, sess->session_id, size);
1110 DEBUG2(" SSL: adding session %s to cache", buffer);
1112 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1113 if (conf && conf->session_cache_path) {
1114 int fd, rv, todo, blob_len;
1118 /* find out what length data we need */
1119 blob_len = i2d_SSL_SESSION(sess, NULL);
1121 /* something went wrong */
1122 DEBUG2(" SSL: could not find buffer length to persist session");
1127 /* Do not convert to TALLOC - Thread safety */
1128 /* alloc and convert to ASN.1 */
1129 sess_blob = malloc(blob_len);
1131 DEBUG2(" SSL: could not allocate buffer len=%d to persist session", blob_len);
1134 /* openssl mutates &p */
1136 rv = i2d_SSL_SESSION(sess, &p);
1137 if (rv != blob_len) {
1138 DEBUG2(" SSL: could not persist session");
1142 /* open output file */
1143 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1144 conf->session_cache_path, FR_DIR_SEP, buffer);
1145 fd = open(filename, O_RDWR|O_CREAT|O_EXCL, 0600);
1147 DEBUG2(" SSL: could not open session file %s: %s", filename, fr_syserror(errno));
1154 rv = write(fd, p, todo);
1156 DEBUG2(" SSL: failed writing session: %s", fr_syserror(errno));
1164 DEBUG2(" SSL: wrote session %s to %s len=%d", buffer, filename, blob_len);
1173 static SSL_SESSION *cbtls_get_session(SSL *ssl,
1174 unsigned char *data, int len,
1178 char buffer[2 * MAX_SESSION_SIZE + 1];
1179 fr_tls_server_conf_t *conf;
1180 TALLOC_CTX *talloc_ctx;
1182 SSL_SESSION *sess = NULL;
1183 unsigned char *sess_data = NULL;
1184 PAIR_LIST *pairlist = NULL;
1187 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1189 fr_bin2hex(buffer, data, size);
1191 DEBUG2(" SSL: Client requested cached session %s", buffer);
1193 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1194 talloc_ctx = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_TALLOC);
1195 if (conf && conf->session_cache_path) {
1202 /* read in the cached VPs from the .vps file */
1203 snprintf(filename, sizeof(filename), "%s%c%s.vps",
1204 conf->session_cache_path, FR_DIR_SEP, buffer);
1205 rv = pairlist_read(NULL, filename, &pairlist, 1);
1207 /* not safe to un-persist a session w/o VPs */
1208 DEBUG2(" SSL: could not load persisted VPs for session %s", buffer);
1212 /* load the actual SSL session */
1213 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1214 conf->session_cache_path, FR_DIR_SEP, buffer);
1215 fd = open(filename, O_RDONLY);
1217 DEBUG2(" SSL: could not find persisted session file %s: %s", filename, fr_syserror(errno));
1221 rv = fstat(fd, &st);
1223 DEBUG2(" SSL: could not stat persisted session file %s: %s", filename, fr_syserror(errno));
1228 sess_data = talloc_array(NULL, unsigned char, st.st_size);
1230 DEBUG2(" SSL: could not alloc buffer for persisted session len=%d", (int) st.st_size);
1238 rv = read(fd, p, todo);
1240 DEBUG2(" SSL: could not read from persisted session: %s", fr_syserror(errno));
1249 /* openssl mutates &p */
1251 sess = d2i_SSL_SESSION(NULL, (unsigned char const **)(void **) &p, st.st_size);
1254 DEBUG2(" SSL: OpenSSL failed to load persisted session: %s", ERR_error_string(ERR_get_error(), NULL));
1258 /* cache the VPs into the session */
1259 vp = paircopy(talloc_ctx, pairlist->reply);
1260 SSL_SESSION_set_ex_data(sess, fr_tls_ex_index_vps, vp);
1261 DEBUG2(" SSL: Successfully restored session %s", buffer);
1264 if (sess_data) talloc_free(sess_data);
1265 if (pairlist) pairlist_free(&pairlist);
1271 #ifdef HAVE_OPENSSL_OCSP_H
1273 * This function extracts the OCSP Responder URL
1274 * from an existing x509 certificate.
1276 static int ocsp_parse_cert_url(X509 *cert, char **phost, char **pport,
1277 char **ppath, int *pssl)
1281 AUTHORITY_INFO_ACCESS *aia;
1282 ACCESS_DESCRIPTION *ad;
1284 aia = X509_get_ext_d2i(cert, NID_info_access, NULL, NULL);
1286 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(aia); i++) {
1287 ad = sk_ACCESS_DESCRIPTION_value(aia, i);
1288 if (OBJ_obj2nid(ad->method) == NID_ad_OCSP) {
1289 if (ad->location->type == GEN_URI) {
1290 if(OCSP_parse_url((char *) ad->location->d.ia5->data,
1291 phost, pport, ppath, pssl))
1300 * This function sends a OCSP request to a defined OCSP responder
1301 * and checks the OCSP response for correctness.
1304 /* Maximum leeway in validity period: default 5 minutes */
1305 #define MAX_VALIDITY_PERIOD (5 * 60)
1307 static int ocsp_check(X509_STORE *store, X509 *issuer_cert, X509 *client_cert,
1308 fr_tls_server_conf_t *conf)
1310 OCSP_CERTID *certid;
1312 OCSP_RESPONSE *resp = NULL;
1313 OCSP_BASICRESP *bresp = NULL;
1317 char hostheader[1024];
1319 long nsec = MAX_VALIDITY_PERIOD, maxage = -1;
1320 BIO *cbio, *bio_out;
1323 ASN1_GENERALIZEDTIME *rev, *thisupd, *nextupd;
1325 #if OPENSSL_VERSION_NUMBER >= 0x1000003f
1329 struct timeval when;
1333 * Create OCSP Request
1335 certid = OCSP_cert_to_id(NULL, client_cert, issuer_cert);
1336 req = OCSP_REQUEST_new();
1337 OCSP_request_add0_id(req, certid);
1338 if(conf->ocsp_use_nonce) {
1339 OCSP_request_add1_nonce(req, NULL, 8);
1343 * Send OCSP Request and get OCSP Response
1346 /* Get OCSP responder URL */
1347 if (conf->ocsp_override_url) {
1350 memcpy(&url, &conf->ocsp_url, sizeof(url));
1351 /* Reading the libssl src, they do a strdup on the URL, so it could of been const *sigh* */
1352 OCSP_parse_url(url, &host, &port, &path, &use_ssl);
1355 ocsp_parse_cert_url(client_cert, &host, &port, &path, &use_ssl);
1358 if (!host || !port || !path) {
1359 DEBUG2("[ocsp] - Host / port / path missing. Not doing OCSP");
1364 DEBUG2("[ocsp] --> Responder URL = http://%s:%s%s", host, port, path);
1366 /* Check host and port length are sane, then create Host: HTTP header */
1367 if ((strlen(host) + strlen(port) + 2) > sizeof(hostheader)) {
1368 ERROR("OCSP Host and port too long");
1371 snprintf(hostheader, sizeof(hostheader), "%s:%s", host, port);
1373 /* Setup BIO socket to OCSP responder */
1374 cbio = BIO_new_connect(host);
1378 if (default_log.dst == L_DST_STDOUT) {
1379 bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
1380 } else if (default_log.dst == L_DST_STDERR) {
1381 bio_out = BIO_new_fp(stderr, BIO_NOCLOSE);
1385 BIO_set_conn_port(cbio, port);
1386 #if OPENSSL_VERSION_NUMBER < 0x1000003f
1387 BIO_do_connect(cbio);
1389 /* Send OCSP request and wait for response */
1390 resp = OCSP_sendreq_bio(cbio, path, req);
1392 ERROR("Couldn't get OCSP response");
1397 if (conf->ocsp_timeout)
1398 BIO_set_nbio(cbio, 1);
1400 rc = BIO_do_connect(cbio);
1401 if ((rc <= 0) && ((!conf->ocsp_timeout) || !BIO_should_retry(cbio))) {
1402 ERROR("Couldn't connect to OCSP responder");
1407 ctx = OCSP_sendreq_new(cbio, path, NULL, -1);
1409 ERROR("Couldn't create OCSP request");
1414 if (!OCSP_REQ_CTX_add1_header(ctx, "Host", hostheader)) {
1415 ERROR("Couldn't set Host header");
1420 if (!OCSP_REQ_CTX_set1_req(ctx, req)) {
1421 ERROR("Couldn't add data to OCSP request");
1426 gettimeofday(&when, NULL);
1427 when.tv_sec += conf->ocsp_timeout;
1430 rc = OCSP_sendreq_nbio(&resp, ctx);
1431 if (conf->ocsp_timeout) {
1432 gettimeofday(&now, NULL);
1433 if (!timercmp(&now, &when, <))
1436 } while ((rc == -1) && BIO_should_retry(cbio));
1438 if (conf->ocsp_timeout && (rc == -1) && BIO_should_retry(cbio)) {
1439 ERROR("OCSP response timed out");
1444 OCSP_REQ_CTX_free(ctx);
1447 ERROR("Couldn't get OCSP response");
1453 /* Verify OCSP response status */
1454 status = OCSP_response_status(resp);
1455 DEBUG2("[ocsp] --> Response status: %s",OCSP_response_status_str(status));
1456 if(status != OCSP_RESPONSE_STATUS_SUCCESSFUL) {
1457 ERROR("OCSP response status: %s", OCSP_response_status_str(status));
1460 bresp = OCSP_response_get1_basic(resp);
1461 if(conf->ocsp_use_nonce && OCSP_check_nonce(req, bresp)!=1) {
1462 ERROR("OCSP response has wrong nonce value");
1465 if(OCSP_basic_verify(bresp, NULL, store, 0)!=1){
1466 ERROR("Couldn't verify OCSP basic response");
1470 /* Verify OCSP cert status */
1471 if(!OCSP_resp_find_status(bresp, certid, &status, &reason,
1472 &rev, &thisupd, &nextupd)) {
1473 ERROR("No Status found.\n");
1477 if (!OCSP_check_validity(thisupd, nextupd, nsec, maxage)) {
1479 BIO_puts(bio_out, "WARNING: Status times invalid.\n");
1480 ERR_print_errors(bio_out);
1487 BIO_puts(bio_out, "\tThis Update: ");
1488 ASN1_GENERALIZEDTIME_print(bio_out, thisupd);
1489 BIO_puts(bio_out, "\n");
1491 BIO_puts(bio_out, "\tNext Update: ");
1492 ASN1_GENERALIZEDTIME_print(bio_out, nextupd);
1493 BIO_puts(bio_out, "\n");
1498 case V_OCSP_CERTSTATUS_GOOD:
1499 DEBUG2("[oscp] --> Cert status: good");
1504 /* REVOKED / UNKNOWN */
1505 DEBUG2("[ocsp] --> Cert status: %s",OCSP_cert_status_str(status));
1507 DEBUG2("[ocsp] --> Reason: %s", OCSP_crl_reason_str(reason));
1510 BIO_puts(bio_out, "\tRevocation Time: ");
1511 ASN1_GENERALIZEDTIME_print(bio_out, rev);
1512 BIO_puts(bio_out, "\n");
1518 /* Free OCSP Stuff */
1519 OCSP_REQUEST_free(req);
1520 OCSP_RESPONSE_free(resp);
1525 if (bio_out) BIO_free(bio_out);
1526 OCSP_BASICRESP_free(bresp);
1531 DEBUG2("[ocsp] --> Certificate is valid!");
1534 if (conf->ocsp_softfail) {
1535 DEBUG2("[ocsp] --> Unable to check certificate; assuming valid");
1536 DEBUG2("[ocsp] --> Warning! This may be insecure");
1539 DEBUG2("[ocsp] --> Unable to check certificate; failing!");
1544 DEBUG2("[ocsp] --> Certificate has been expired/revoked!");
1550 #endif /* HAVE_OPENSSL_OCSP_H */
1553 * For creating certificate attributes.
1555 static char const *cert_attr_names[8][2] = {
1556 { "TLS-Client-Cert-Serial", "TLS-Cert-Serial" },
1557 { "TLS-Client-Cert-Expiration", "TLS-Cert-Expiration" },
1558 { "TLS-Client-Cert-Subject", "TLS-Cert-Subject" },
1559 { "TLS-Client-Cert-Issuer", "TLS-Cert-Issuer" },
1560 { "TLS-Client-Cert-Common-Name", "TLS-Cert-Common-Name" },
1561 { "TLS-Client-Cert-Subject-Alt-Name-Email", "TLS-Cert-Subject-Alt-Name-Email" },
1562 { "TLS-Client-Cert-Subject-Alt-Name-Dns", "TLS-Cert-Subject-Alt-Name-Dns" },
1563 { "TLS-Client-Cert-Subject-Alt-Name-Upn", "TLS-Cert-Subject-Alt-Name-Upn" }
1566 #define FR_TLS_SERIAL (0)
1567 #define FR_TLS_EXPIRATION (1)
1568 #define FR_TLS_SUBJECT (2)
1569 #define FR_TLS_ISSUER (3)
1570 #define FR_TLS_CN (4)
1571 #define FR_TLS_SAN_EMAIL (5)
1572 #define FR_TLS_SAN_DNS (6)
1573 #define FR_TLS_SAN_UPN (7)
1576 * Before trusting a certificate, you must make sure that the
1577 * certificate is 'valid'. There are several steps that your
1578 * application can take in determining if a certificate is
1579 * valid. Commonly used steps are:
1581 * 1.Verifying the certificate's signature, and verifying that
1582 * the certificate has been issued by a trusted Certificate
1585 * 2.Verifying that the certificate is valid for the present date
1586 * (i.e. it is being presented within its validity dates).
1588 * 3.Verifying that the certificate has not been revoked by its
1589 * issuing Certificate Authority, by checking with respect to a
1590 * Certificate Revocation List (CRL).
1592 * 4.Verifying that the credentials presented by the certificate
1593 * fulfill additional requirements specific to the application,
1594 * such as with respect to access control lists or with respect
1595 * to OCSP (Online Certificate Status Processing).
1597 * NOTE: This callback will be called multiple times based on the
1598 * depth of the root certificate chain
1600 int cbtls_verify(int ok, X509_STORE_CTX *ctx)
1602 char subject[1024]; /* Used for the subject name */
1603 char issuer[1024]; /* Used for the issuer name */
1604 char attribute[1024];
1606 char common_name[1024];
1610 X509_CINF *client_inf;
1611 STACK_OF(X509_EXTENSION) *ext_list;
1613 int err, depth, lookup, loc;
1614 fr_tls_server_conf_t *conf;
1617 ASN1_INTEGER *sn = NULL;
1618 ASN1_TIME *asn_time = NULL;
1621 #ifdef HAVE_OPENSSL_OCSP_H
1622 X509_STORE *ocsp_store = NULL;
1626 TALLOC_CTX *talloc_ctx;
1628 client_cert = X509_STORE_CTX_get_current_cert(ctx);
1629 err = X509_STORE_CTX_get_error(ctx);
1630 depth = X509_STORE_CTX_get_error_depth(ctx);
1635 * Log client/issuing cert. If there's an error, log
1638 if ((lookup > 1) && !my_ok) lookup = 1;
1641 * Retrieve the pointer to the SSL of the connection currently treated
1642 * and the application specific data stored into the SSL object.
1644 ssl = X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
1645 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1646 if (!conf) return 1;
1648 request = (REQUEST *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_REQUEST);
1649 rad_assert(request != NULL);
1650 certs = (VALUE_PAIR **)SSL_get_ex_data(ssl, fr_tls_ex_index_certs);
1652 identity = (char **)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_IDENTITY);
1653 #ifdef HAVE_OPENSSL_OCSP_H
1654 ocsp_store = (X509_STORE *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_STORE);
1657 talloc_ctx = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_TALLOC);
1660 * Get the Serial Number
1663 sn = X509_get_serialNumber(client_cert);
1665 RDEBUG2("TLS Verify adding attributes");
1669 * For this next bit, we create the attributes *only* if
1670 * we're at the client or issuing certificate, AND we
1671 * have a user identity. i.e. we don't create the
1672 * attributes for RadSec connections.
1674 if (certs && identity &&
1675 (lookup <= 1) && sn && ((size_t) sn->length < (sizeof(buf) / 2))) {
1679 for (i = 0; i < sn->length; i++) {
1680 sprintf(p, "%02x", (unsigned int)sn->data[i]);
1683 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_SERIAL][lookup], buf, T_OP_SET);
1684 rdebug_pair(L_DBG_LVL_2, request, vp, "&request:");
1689 * Get the Expiration Date
1692 asn_time = X509_get_notAfter(client_cert);
1693 if (certs && identity && (lookup <= 1) && asn_time &&
1694 (asn_time->length < (int) sizeof(buf))) {
1695 memcpy(buf, (char*) asn_time->data, asn_time->length);
1696 buf[asn_time->length] = '\0';
1697 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_EXPIRATION][lookup], buf, T_OP_SET);
1698 rdebug_pair(L_DBG_LVL_2, request, vp, "&request:");
1702 * Get the Subject & Issuer
1704 subject[0] = issuer[0] = '\0';
1705 X509_NAME_oneline(X509_get_subject_name(client_cert), subject,
1707 subject[sizeof(subject) - 1] = '\0';
1708 if (certs && identity && (lookup <= 1) && subject[0]) {
1709 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_SUBJECT][lookup], subject, T_OP_SET);
1710 rdebug_pair(L_DBG_LVL_2, request, vp, "&request:");
1713 X509_NAME_oneline(X509_get_issuer_name(ctx->current_cert), issuer,
1715 issuer[sizeof(issuer) - 1] = '\0';
1716 if (certs && identity && (lookup <= 1) && issuer[0]) {
1717 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_ISSUER][lookup], issuer, T_OP_SET);
1718 rdebug_pair(L_DBG_LVL_2, request, vp, "&request:");
1722 * Get the Common Name, if there is a subject.
1724 X509_NAME_get_text_by_NID(X509_get_subject_name(client_cert),
1725 NID_commonName, common_name, sizeof(common_name));
1726 common_name[sizeof(common_name) - 1] = '\0';
1727 if (certs && identity && (lookup <= 1) && common_name[0] && subject[0]) {
1728 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_CN][lookup], common_name, T_OP_SET);
1729 rdebug_pair(L_DBG_LVL_2, request, vp, "&request:");
1733 * Get the RFC822 Subject Alternative Name
1735 loc = X509_get_ext_by_NID(client_cert, NID_subject_alt_name, 0);
1736 if (certs && (lookup <= 1) && (loc >= 0)) {
1737 X509_EXTENSION *ext = NULL;
1738 GENERAL_NAMES *names = NULL;
1741 if ((ext = X509_get_ext(client_cert, loc)) &&
1742 (names = X509V3_EXT_d2i(ext))) {
1743 for (i = 0; i < sk_GENERAL_NAME_num(names); i++) {
1744 GENERAL_NAME *name = sk_GENERAL_NAME_value(names, i);
1746 switch (name->type) {
1749 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_EMAIL][lookup],
1750 (char *) ASN1_STRING_data(name->d.rfc822Name), T_OP_SET);
1751 rdebug_pair(L_DBG_LVL_2, request, vp, "&request:");
1753 #endif /* GEN_EMAIL */
1756 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_DNS][lookup],
1757 (char *) ASN1_STRING_data(name->d.dNSName), T_OP_SET);
1758 rdebug_pair(L_DBG_LVL_2, request, vp, "&request:");
1760 #endif /* GEN_DNS */
1761 #ifdef GEN_OTHERNAME
1763 /* look for a MS UPN */
1764 if (NID_ms_upn == OBJ_obj2nid(name->d.otherName->type_id)) {
1765 /* we've got a UPN - Must be ASN1-encoded UTF8 string */
1766 if (name->d.otherName->value->type == V_ASN1_UTF8STRING) {
1767 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_UPN][lookup],
1768 (char *) ASN1_STRING_data(name->d.otherName->value->value.utf8string), T_OP_SET);
1769 rdebug_pair(L_DBG_LVL_2, request, vp, "&request:");
1772 RWARN("Invalid UPN in Subject Alt Name (should be UTF-8)");
1777 #endif /* GEN_OTHERNAME */
1779 /* XXX TODO handle other SAN types */
1785 sk_GENERAL_NAME_free(names);
1789 * If the CRL has expired, that might still be OK.
1792 (conf->allow_expired_crl) &&
1793 (err == X509_V_ERR_CRL_HAS_EXPIRED)) {
1795 X509_STORE_CTX_set_error( ctx, 0 );
1799 char const *p = X509_verify_cert_error_string(err);
1800 RERROR("SSL says error %d : %s", err, p);
1806 client_inf = client_cert->cert_info;
1807 ext_list = client_inf->extensions;
1813 * Grab the X509 extensions, and create attributes out of them.
1814 * For laziness, we re-use the OpenSSL names
1816 if (sk_X509_EXTENSION_num(ext_list) > 0) {
1821 out = BIO_new(BIO_s_mem());
1822 strlcpy(attribute, "TLS-Client-Cert-", sizeof(attribute));
1824 for (i = 0; i < sk_X509_EXTENSION_num(ext_list); i++) {
1826 X509_EXTENSION *ext;
1828 ext = sk_X509_EXTENSION_value(ext_list, i);
1830 obj = X509_EXTENSION_get_object(ext);
1831 i2a_ASN1_OBJECT(out, obj);
1832 len = BIO_read(out, attribute + 16 , sizeof(attribute) - 16 - 1);
1833 if (len <= 0) continue;
1835 attribute[16 + len] = '\0';
1837 X509V3_EXT_print(out, ext, 0, 0);
1838 len = BIO_read(out, value , sizeof(value) - 1);
1839 if (len <= 0) continue;
1844 * Mash the OpenSSL name to our name, and
1845 * create the attribute.
1847 for (p = value + 16; *p != '\0'; p++) {
1848 if (*p == ' ') *p = '-';
1851 vp = pairmake(talloc_ctx, certs, attribute, value, T_OP_ADD);
1852 rdebug_pair_list(L_DBG_LVL_2, request, vp, NULL);
1860 switch (ctx->error) {
1861 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
1862 RERROR("issuer=%s", issuer);
1865 case X509_V_ERR_CERT_NOT_YET_VALID:
1866 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
1867 RERROR("notBefore=");
1869 ASN1_TIME_print(bio_err, X509_get_notBefore(ctx->current_cert));
1873 case X509_V_ERR_CERT_HAS_EXPIRED:
1874 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
1875 RERROR("notAfter=");
1877 ASN1_TIME_print(bio_err, X509_get_notAfter(ctx->current_cert));
1883 * If we're at the actual client cert, apply additional
1888 * If the conf tells us to, check cert issuer
1889 * against the specified value and fail
1890 * verification if they don't match.
1892 if (conf->check_cert_issuer &&
1893 (strcmp(issuer, conf->check_cert_issuer) != 0)) {
1894 AUTH("tls: Certificate issuer (%s) does not match specified value (%s)!", issuer, conf->check_cert_issuer);
1899 * If the conf tells us to, check the CN in the
1900 * cert against xlat'ed value, but only if the
1901 * previous checks passed.
1903 if (my_ok && conf->check_cert_cn) {
1904 if (radius_xlat(cn_str, sizeof(cn_str), request, conf->check_cert_cn, NULL, NULL) < 0) {
1905 /* if this fails, fail the verification */
1908 RDEBUG2("checking certificate CN (%s) with xlat'ed value (%s)", common_name, cn_str);
1909 if (strcmp(cn_str, common_name) != 0) {
1910 AUTH("tls: Certificate CN (%s) does not match specified value (%s)!", common_name, cn_str);
1914 } /* check_cert_cn */
1916 #ifdef HAVE_OPENSSL_OCSP_H
1917 if (my_ok && conf->ocsp_enable){
1918 RDEBUG2("--> Starting OCSP Request");
1919 if (X509_STORE_CTX_get1_issuer(&issuer_cert, ctx, client_cert) != 1) {
1920 RERROR("Couldn't get issuer_cert for %s", common_name);
1922 my_ok = ocsp_check(ocsp_store, issuer_cert, client_cert, conf);
1927 while (conf->verify_client_cert_cmd) {
1932 snprintf(filename, sizeof(filename), "%s/%s.client.XXXXXXXX",
1933 conf->verify_tmp_dir, progname);
1934 fd = mkstemp(filename);
1936 RDEBUG("Failed creating file in %s: %s",
1937 conf->verify_tmp_dir, fr_syserror(errno));
1941 fp = fdopen(fd, "w");
1944 RDEBUG("Failed opening file %s: %s",
1945 filename, fr_syserror(errno));
1949 if (!PEM_write_X509(fp, client_cert)) {
1951 RDEBUG("Failed writing certificate to file");
1956 if (!pairmake_packet("TLS-Client-Cert-Filename",
1957 filename, T_OP_SET)) {
1958 RDEBUG("Failed creating TLS-Client-Cert-Filename");
1963 RDEBUG("Verifying client certificate: %s", conf->verify_client_cert_cmd);
1964 if (radius_exec_program(NULL, 0, NULL, request, conf->verify_client_cert_cmd,
1965 request->packet->vps,
1966 true, true, EXEC_TIMEOUT) != 0) {
1967 AUTH("tls: Certificate CN (%s) fails external verification!", common_name);
1970 RDEBUG("Client certificate CN %s passed external validation", common_name);
1981 if (debug_flag > 0) {
1982 RDEBUG2("chain-depth=%d, ", depth);
1983 RDEBUG2("error=%d", err);
1985 if (identity) RDEBUG2("--> User-Name = %s", *identity);
1986 RDEBUG2("--> BUF-Name = %s", common_name);
1987 RDEBUG2("--> subject = %s", subject);
1988 RDEBUG2("--> issuer = %s", issuer);
1989 RDEBUG2("--> verify return:%d", my_ok);
1995 #ifdef HAVE_OPENSSL_OCSP_H
1997 * Create Global X509 revocation store and use it to verify
2000 * - Load the trusted CAs
2001 * - Load the trusted issuer certificates
2003 static X509_STORE *init_revocation_store(fr_tls_server_conf_t *conf)
2005 X509_STORE *store = NULL;
2007 store = X509_STORE_new();
2009 /* Load the CAs we trust */
2010 if (conf->ca_file || conf->ca_path)
2011 if(!X509_STORE_load_locations(store, conf->ca_file, conf->ca_path)) {
2012 ERROR("tls: X509_STORE error %s", ERR_error_string(ERR_get_error(), NULL));
2013 ERROR("tls: Error reading Trusted root CA list %s",conf->ca_file );
2017 #ifdef X509_V_FLAG_CRL_CHECK
2018 if (conf->check_crl)
2019 X509_STORE_set_flags(store, X509_V_FLAG_CRL_CHECK);
2023 #endif /* HAVE_OPENSSL_OCSP_H */
2025 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
2026 #ifndef OPENSSL_NO_ECDH
2027 static int set_ecdh_curve(SSL_CTX *ctx, char const *ecdh_curve)
2032 if (!ecdh_curve || !*ecdh_curve) return 0;
2034 nid = OBJ_sn2nid(ecdh_curve);
2036 ERROR("Unknown ecdh_curve \"%s\"", ecdh_curve);
2040 ecdh = EC_KEY_new_by_curve_name(nid);
2042 ERROR("Unable to create new curve \"%s\"", ecdh_curve);
2046 SSL_CTX_set_tmp_ecdh(ctx, ecdh);
2048 SSL_CTX_set_options(ctx, SSL_OP_SINGLE_ECDH_USE);
2058 * DIE OPENSSL DIE DIE DIE
2060 * What a palaver, just to free some data attached the
2061 * session. We need to do this because the "remove" callback
2062 * is called when refcount > 0 sometimes, if another thread
2063 * is using the session
2065 static void sess_free_vps(UNUSED void *parent, void *data_ptr,
2066 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
2067 UNUSED long argl, UNUSED void *argp)
2069 VALUE_PAIR *vp = data_ptr;
2072 DEBUG2(" Freeing cached session VPs");
2077 static void sess_free_certs(UNUSED void *parent, void *data_ptr,
2078 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
2079 UNUSED long argl, UNUSED void *argp)
2081 VALUE_PAIR **certs = data_ptr;
2084 DEBUG2(" Freeing cached session Certificates");
2089 /** Add all the default ciphers and message digests reate our context.
2091 * This should be called exactly once from main, before reading the main config
2092 * or initialising any modules.
2094 void tls_global_init(void)
2096 SSL_load_error_strings(); /* readable error messages (examples show call before library_init) */
2097 SSL_library_init(); /* initialize library */
2098 OpenSSL_add_all_algorithms(); /* required for SHA2 in OpenSSL < 0.9.8o and 1.0.0.a */
2099 OPENSSL_config(NULL);
2102 * Initialize the index for the certificates.
2104 fr_tls_ex_index_certs = SSL_SESSION_get_ex_new_index(0, NULL, NULL, NULL, sess_free_certs);
2107 #ifdef ENABLE_OPENSSL_VERSION_CHECK
2108 /** Check for vulnerable versions of libssl
2110 * @param acknowledged The highest CVE number a user has confirmed is not present in the system's libssl.
2111 * @return 0 if the CVE specified by the user matches the most recent CVE we have, else -1.
2113 int tls_global_version_check(char const *acknowledged)
2118 if ((strcmp(acknowledged, libssl_defects[0].id) != 0) && (strcmp(acknowledged, "yes") != 0)) {
2122 /* Check for bad versions */
2123 v = (uint64_t) SSLeay();
2125 for (i = 0; i < (sizeof(libssl_defects) / sizeof(*libssl_defects)); i++) {
2126 libssl_defect_t *defect = &libssl_defects[i];
2128 if ((v >= defect->low) && (v <= defect->high)) {
2129 ERROR("Refusing to start with libssl version %s (in range %s)",
2130 ssl_version(), ssl_version_range(defect->low, defect->high));
2131 ERROR("Security advisory %s (%s)", defect->id, defect->name);
2132 ERROR("%s", defect->comment);
2139 INFO("Once you have verified libssl has been correctly patched, "
2140 "set security.allow_vulnerable_openssl = '%s'", libssl_defects[0].id);
2149 /** Free any memory alloced by libssl
2152 void tls_global_cleanup(void)
2154 ERR_remove_state(0);
2156 CONF_modules_unload(1);
2159 CRYPTO_cleanup_all_ex_data();
2163 * Create SSL context
2165 * - Load the trusted CAs
2166 * - Load the Private key & the certificate
2167 * - Set the Context options & Verify options
2169 SSL_CTX *tls_init_ctx(fr_tls_server_conf_t *conf, int client)
2172 X509_STORE *certstore;
2173 int verify_mode = SSL_VERIFY_NONE;
2174 int ctx_options = 0;
2178 * SHA256 is in all versions of OpenSSL, but isn't
2179 * initialized by default. It's needed for WiMAX
2182 #ifdef HAVE_OPENSSL_EVP_SHA256
2183 EVP_add_digest(EVP_sha256());
2186 ctx = SSL_CTX_new(SSLv23_method()); /* which is really "all known SSL / TLS methods". Idiots. */
2189 while ((err = ERR_get_error())) {
2190 DEBUG("Failed creating SSL context: %s",
2191 ERR_error_string(err, NULL));
2197 * Save the config on the context so that callbacks which
2198 * only get SSL_CTX* e.g. session persistence, can get it
2200 SSL_CTX_set_app_data(ctx, conf);
2203 * Identify the type of certificates that needs to be loaded
2205 if (conf->file_type) {
2206 type = SSL_FILETYPE_PEM;
2208 type = SSL_FILETYPE_ASN1;
2212 * Set the password to load private key
2214 if (conf->private_key_password) {
2217 * We don't want to put the private key password in eap.conf, so check
2218 * for our special string which indicates we should get the password
2221 char const* special_string = "Apple:UseCertAdmin";
2222 if (strncmp(conf->private_key_password, special_string, strlen(special_string)) == 0) {
2225 long const max_password_len = 128;
2226 snprintf(cmd, sizeof(cmd) - 1, "/usr/sbin/certadmin --get-private-key-passphrase \"%s\"",
2227 conf->private_key_file);
2229 DEBUG2("tls: Getting private key passphrase using command \"%s\"", cmd);
2231 FILE* cmd_pipe = popen(cmd, "r");
2233 ERROR("TLS: %s command failed. Unable to get private_key_password", cmd);
2234 ERROR("Error reading private_key_file %s", conf->private_key_file);
2238 rad_const_free(conf->private_key_password);
2239 password = talloc_array(conf, char, max_password_len);
2241 ERROR("TLS: Can't allocate space for private_key_password");
2242 ERROR("TLS: Error reading private_key_file %s", conf->private_key_file);
2247 fgets(password, max_password_len, cmd_pipe);
2250 /* Get rid of newline at end of password. */
2251 password[strlen(password) - 1] = '\0';
2253 DEBUG3("tls: Password from command = \"%s\"", password);
2254 conf->private_key_password = password;
2261 memcpy(&password, &conf->private_key_password, sizeof(password));
2262 SSL_CTX_set_default_passwd_cb_userdata(ctx, password);
2263 SSL_CTX_set_default_passwd_cb(ctx, cbtls_password);
2267 #ifdef PSK_MAX_IDENTITY_LEN
2270 * No dynamic query exists. There MUST be a
2271 * statically configured identity and password.
2273 if (conf->psk_query && !*conf->psk_query) {
2274 ERROR("Invalid PSK Configuration: psk_query cannot be empty");
2279 * Set the callback only if we can check things.
2281 if (conf->psk_identity || conf->psk_query) {
2282 SSL_CTX_set_psk_server_callback(ctx, psk_server_callback);
2285 } else if (conf->psk_query) {
2286 ERROR("Invalid PSK Configuration: psk_query cannot be used for outgoing connections");
2291 * Now check that if PSK is being used, the config is valid.
2293 if ((conf->psk_identity && !conf->psk_password) ||
2294 (!conf->psk_identity && conf->psk_password) ||
2295 (conf->psk_identity && !*conf->psk_identity) ||
2296 (conf->psk_password && !*conf->psk_password)) {
2297 ERROR("Invalid PSK Configuration: psk_identity or psk_password are empty");
2301 if (conf->psk_identity) {
2302 size_t psk_len, hex_len;
2303 uint8_t buffer[PSK_MAX_PSK_LEN];
2305 if (conf->certificate_file ||
2306 conf->private_key_password || conf->private_key_file ||
2307 conf->ca_file || conf->ca_path) {
2308 ERROR("When PSKs are used, No certificate configuration is permitted");
2313 SSL_CTX_set_psk_client_callback(ctx,
2314 psk_client_callback);
2317 psk_len = strlen(conf->psk_password);
2318 if (strlen(conf->psk_password) > (2 * PSK_MAX_PSK_LEN)) {
2319 ERROR("psk_hexphrase is too long (max %d)",
2325 * Check the password now, so that we don't have
2326 * errors at run-time.
2328 hex_len = fr_hex2bin(buffer, sizeof(buffer), conf->psk_password, psk_len);
2329 if (psk_len != (2 * hex_len)) {
2330 ERROR("psk_hexphrase is not all hex");
2337 (void) client; /* -Wunused */
2341 * Load our keys and certificates
2343 * If certificates are of type PEM then we can make use
2344 * of cert chain authentication using openssl api call
2345 * SSL_CTX_use_certificate_chain_file. Please see how
2346 * the cert chain needs to be given in PEM from
2349 if (!conf->certificate_file) goto load_ca;
2351 if (type == SSL_FILETYPE_PEM) {
2352 if (!(SSL_CTX_use_certificate_chain_file(ctx, conf->certificate_file))) {
2353 ERROR("Error reading certificate file %s:%s",
2354 conf->certificate_file,
2355 ERR_error_string(ERR_get_error(), NULL));
2359 } else if (!(SSL_CTX_use_certificate_file(ctx, conf->certificate_file, type))) {
2360 ERROR("Error reading certificate file %s:%s",
2361 conf->certificate_file,
2362 ERR_error_string(ERR_get_error(), NULL));
2366 /* Load the CAs we trust */
2368 if (conf->ca_file || conf->ca_path) {
2369 if (!SSL_CTX_load_verify_locations(ctx, conf->ca_file, conf->ca_path)) {
2370 ERROR("tls: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2371 ERROR("tls: Error reading Trusted root CA list %s",conf->ca_file );
2375 if (conf->ca_file && *conf->ca_file) SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(conf->ca_file));
2377 if (conf->private_key_file) {
2378 if (!(SSL_CTX_use_PrivateKey_file(ctx, conf->private_key_file, type))) {
2379 ERROR("Failed reading private key file %s:%s",
2380 conf->private_key_file,
2381 ERR_error_string(ERR_get_error(), NULL));
2386 * Check if the loaded private key is the right one
2388 if (!SSL_CTX_check_private_key(ctx)) {
2389 ERROR("Private key does not match the certificate public key");
2394 #ifdef PSK_MAX_IDENTITY_LEN
2399 * We never want SSLv2 or SSLv3.
2401 ctx_options |= SSL_OP_NO_SSLv2;
2402 ctx_options |= SSL_OP_NO_SSLv3;
2405 * As of 3.0.5, we always allow TLSv1.1 and TLSv1.2.
2406 * Though they can be *globally* disabled if necessary.x
2408 #ifdef SSL_OP_NO_TLSv1_1
2409 if (conf->disable_tlsv1_1) ctx_options |= SSL_OP_NO_TLSv1_1;
2411 #ifdef SSL_OP_NO_TLSv1_2
2412 if (conf->disable_tlsv1_2) ctx_options |= SSL_OP_NO_TLSv1_2;
2415 #ifdef SSL_OP_NO_TICKET
2416 ctx_options |= SSL_OP_NO_TICKET ;
2420 * SSL_OP_SINGLE_DH_USE must be used in order to prevent
2421 * small subgroup attacks and forward secrecy. Always
2424 * SSL_OP_SINGLE_DH_USE has an impact on the computer
2425 * time needed during negotiation, but it is not very
2428 ctx_options |= SSL_OP_SINGLE_DH_USE;
2431 * SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS to work around issues
2432 * in Windows Vista client.
2433 * http://www.openssl.org/~bodo/tls-cbc.txt
2434 * http://www.nabble.com/(RADIATOR)-Radiator-Version-3.16-released-t2600070.html
2436 ctx_options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
2438 SSL_CTX_set_options(ctx, ctx_options);
2441 * TODO: Set the RSA & DH
2442 * SSL_CTX_set_tmp_rsa_callback(ctx, cbtls_rsa);
2443 * SSL_CTX_set_tmp_dh_callback(ctx, cbtls_dh);
2447 * set the message callback to identify the type of
2448 * message. For every new session, there can be a
2449 * different callback argument.
2451 * SSL_CTX_set_msg_callback(ctx, cbtls_msg);
2455 * Set eliptical curve crypto configuration.
2457 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
2458 #ifndef OPENSSL_NO_ECDH
2459 if (set_ecdh_curve(ctx, conf->ecdh_curve) < 0) {
2465 /* Set Info callback */
2466 SSL_CTX_set_info_callback(ctx, cbtls_info);
2469 * Callbacks, etc. for session resumption.
2471 if (conf->session_cache_enable) {
2472 SSL_CTX_sess_set_new_cb(ctx, cbtls_new_session);
2473 SSL_CTX_sess_set_get_cb(ctx, cbtls_get_session);
2474 SSL_CTX_sess_set_remove_cb(ctx, cbtls_remove_session);
2476 SSL_CTX_set_quiet_shutdown(ctx, 1);
2477 if (fr_tls_ex_index_vps < 0)
2478 fr_tls_ex_index_vps = SSL_SESSION_get_ex_new_index(0, NULL, NULL, NULL, sess_free_vps);
2482 * Check the certificates for revocation.
2484 #ifdef X509_V_FLAG_CRL_CHECK
2485 if (conf->check_crl) {
2486 certstore = SSL_CTX_get_cert_store(ctx);
2487 if (certstore == NULL) {
2488 ERROR("tls: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2489 ERROR("tls: Error reading Certificate Store");
2492 X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK);
2498 * Always verify the peer certificate
2500 verify_mode |= SSL_VERIFY_PEER;
2501 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
2502 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
2503 SSL_CTX_set_verify(ctx, verify_mode, cbtls_verify);
2505 if (conf->verify_depth) {
2506 SSL_CTX_set_verify_depth(ctx, conf->verify_depth);
2509 /* Load randomness */
2510 if (conf->random_file) {
2511 if (!(RAND_load_file(conf->random_file, 1024*10))) {
2512 ERROR("tls: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2513 ERROR("tls: Error loading randomness");
2519 * Set the cipher list if we were told to
2521 if (conf->cipher_list) {
2522 if (!SSL_CTX_set_cipher_list(ctx, conf->cipher_list)) {
2523 ERROR("tls: Error setting cipher list");
2529 * Setup session caching
2531 if (conf->session_cache_enable) {
2533 * Create a unique context Id per EAP-TLS configuration.
2535 if (conf->session_id_name) {
2536 snprintf(conf->session_context_id,
2537 sizeof(conf->session_context_id),
2539 conf->session_id_name);
2541 snprintf(conf->session_context_id,
2542 sizeof(conf->session_context_id),
2547 * Cache it, and DON'T auto-clear it.
2549 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_SERVER | SSL_SESS_CACHE_NO_AUTO_CLEAR);
2551 SSL_CTX_set_session_id_context(ctx,
2552 (unsigned char *) conf->session_context_id,
2553 (unsigned int) strlen(conf->session_context_id));
2556 * Our timeout is in hours, this is in seconds.
2558 SSL_CTX_set_timeout(ctx, conf->session_timeout * 3600);
2561 * Set the maximum number of entries in the
2564 SSL_CTX_sess_set_cache_size(ctx, conf->session_cache_size);
2567 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
2575 * Free TLS client/server config
2576 * Should not be called outside this code, as a callback is
2577 * added to automatically free the data when the CONF_SECTION
2580 static int _tls_server_conf_free(fr_tls_server_conf_t *conf)
2582 if (conf->ctx) SSL_CTX_free(conf->ctx);
2584 #ifdef HAVE_OPENSSL_OCSP_H
2585 if (conf->ocsp_store) X509_STORE_free(conf->ocsp_store);
2586 conf->ocsp_store = NULL;
2590 memset(conf, 0, sizeof(*conf));
2595 static fr_tls_server_conf_t *tls_server_conf_alloc(TALLOC_CTX *ctx)
2597 fr_tls_server_conf_t *conf;
2599 conf = talloc_zero(ctx, fr_tls_server_conf_t);
2601 ERROR("Out of memory");
2605 talloc_set_destructor(conf, _tls_server_conf_free);
2610 fr_tls_server_conf_t *tls_server_conf_parse(CONF_SECTION *cs)
2612 fr_tls_server_conf_t *conf;
2615 * If cs has already been parsed there should be a cached copy
2616 * of conf already stored, so just return that.
2618 conf = cf_data_find(cs, "tls-conf");
2620 DEBUG("Using cached TLS configuration from previous invocation");
2624 conf = tls_server_conf_alloc(cs);
2626 if (cf_section_parse(cs, conf, tls_server_config) < 0) {
2633 * Save people from their own stupidity.
2635 if (conf->fragment_size < 100) conf->fragment_size = 100;
2637 if (!conf->private_key_file) {
2638 ERROR("TLS Server requires a private key file");
2642 if (!conf->certificate_file) {
2643 ERROR("TLS Server requires a certificate file");
2650 conf->ctx = tls_init_ctx(conf, 0);
2651 if (conf->ctx == NULL) {
2655 #ifdef HAVE_OPENSSL_OCSP_H
2657 * Initialize OCSP Revocation Store
2659 if (conf->ocsp_enable) {
2660 conf->ocsp_store = init_revocation_store(conf);
2661 if (conf->ocsp_store == NULL) goto error;
2663 #endif /*HAVE_OPENSSL_OCSP_H*/
2667 memcpy(&dh_file, &conf->dh_file, sizeof(dh_file));
2668 if (load_dh_params(conf->ctx, dh_file) < 0) {
2673 if (conf->verify_tmp_dir) {
2674 if (chmod(conf->verify_tmp_dir, S_IRWXU) < 0) {
2675 ERROR("Failed changing permissions on %s: %s", conf->verify_tmp_dir, fr_syserror(errno));
2680 if (conf->verify_client_cert_cmd && !conf->verify_tmp_dir) {
2681 ERROR("You MUST set the verify directory in order to use verify_client_cmd");
2686 * Cache conf in cs in case we're asked to parse this again.
2688 cf_data_add(cs, "tls-conf", conf, NULL);
2693 fr_tls_server_conf_t *tls_client_conf_parse(CONF_SECTION *cs)
2695 fr_tls_server_conf_t *conf;
2697 conf = cf_data_find(cs, "tls-conf");
2699 DEBUG("Using cached TLS configuration from previous invocation");
2703 conf = tls_server_conf_alloc(cs);
2705 if (cf_section_parse(cs, conf, tls_client_config) < 0) {
2712 * Save people from their own stupidity.
2714 if (conf->fragment_size < 100) conf->fragment_size = 100;
2719 conf->ctx = tls_init_ctx(conf, 1);
2720 if (conf->ctx == NULL) {
2727 memcpy(&dh_file, &conf->dh_file, sizeof(dh_file));
2728 if (load_dh_params(conf->ctx, dh_file) < 0) {
2733 cf_data_add(cs, "tls-conf", conf, NULL);
2738 int tls_success(tls_session_t *ssn, REQUEST *request)
2740 VALUE_PAIR *vp, *vps = NULL;
2741 fr_tls_server_conf_t *conf;
2742 TALLOC_CTX *talloc_ctx;
2744 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF);
2745 rad_assert(conf != NULL);
2747 talloc_ctx = SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_TALLOC);
2750 * If there's no session resumption, delete the entry
2751 * from the cache. This means either it's disabled
2752 * globally for this SSL context, OR we were told to
2753 * disable it for this user.
2755 * This also means you can't turn it on just for one
2758 if ((!ssn->allow_session_resumption) ||
2759 (((vp = pairfind(request->config_items, PW_ALLOW_SESSION_RESUMPTION, 0, TAG_ANY)) != NULL) &&
2760 (vp->vp_integer == 0))) {
2761 SSL_CTX_remove_session(ssn->ctx,
2763 ssn->allow_session_resumption = false;
2766 * If we're in a resumed session and it's
2769 if (SSL_session_reused(ssn->ssl)) {
2770 RDEBUG("FAIL: Forcibly stopping session resumption as it is not allowed");
2774 * Else resumption IS allowed, so we store the
2775 * user data in the cache.
2777 } else if (!SSL_session_reused(ssn->ssl)) {
2780 char buffer[2 * MAX_SESSION_SIZE + 1];
2782 size = ssn->ssl->session->session_id_length;
2783 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
2785 fr_bin2hex(buffer, ssn->ssl->session->session_id, size);
2787 vp = paircopy_by_num(talloc_ctx, request->reply->vps, PW_USER_NAME, 0, TAG_ANY);
2788 if (vp) pairadd(&vps, vp);
2790 vp = paircopy_by_num(talloc_ctx, request->packet->vps, PW_STRIPPED_USER_NAME, 0, TAG_ANY);
2791 if (vp) pairadd(&vps, vp);
2793 vp = paircopy_by_num(talloc_ctx, request->packet->vps, PW_STRIPPED_USER_DOMAIN, 0, TAG_ANY);
2794 if (vp) pairadd(&vps, vp);
2796 vp = paircopy_by_num(talloc_ctx, request->reply->vps, PW_CHARGEABLE_USER_IDENTITY, 0, TAG_ANY);
2797 if (vp) pairadd(&vps, vp);
2799 vp = paircopy_by_num(talloc_ctx, request->reply->vps, PW_CACHED_SESSION_POLICY, 0, TAG_ANY);
2800 if (vp) pairadd(&vps, vp);
2802 certs = (VALUE_PAIR **)SSL_get_ex_data(ssn->ssl, fr_tls_ex_index_certs);
2805 * Hmm... the certs should probably be session data.
2809 * @todo: some go into reply, others into
2812 pairadd(&vps, paircopy(talloc_ctx, *certs));
2816 RDEBUG2("Saving session %s vps %p in the cache", buffer, vps);
2817 SSL_SESSION_set_ex_data(ssn->ssl->session, fr_tls_ex_index_vps, vps);
2818 if (conf->session_cache_path) {
2819 /* write the VPs to the cache file */
2820 char filename[256], buf[1024];
2823 snprintf(filename, sizeof(filename), "%s%c%s.vps", conf->session_cache_path,
2824 FR_DIR_SEP, buffer);
2825 vp_file = fopen(filename, "w");
2826 if (vp_file == NULL) {
2827 RDEBUG2("Could not write session VPs to persistent cache: %s",
2828 fr_syserror(errno));
2831 /* generate a dummy user-style entry which is easy to read back */
2832 fprintf(vp_file, "# SSL cached session\n");
2833 fprintf(vp_file, "%s\n", buffer);
2834 for (vp = fr_cursor_init(&cursor, &vps);
2836 vp = fr_cursor_next(&cursor)) {
2837 vp_prints(buf, sizeof(buf), vp);
2838 fprintf(vp_file, "\t%s,\n", buf);
2844 RDEBUG2("No information to cache: session caching will be disabled for session %s", buffer);
2845 SSL_CTX_remove_session(ssn->ctx, ssn->ssl->session);
2849 * Else the session WAS allowed. Copy the cached reply.
2853 char buffer[2 * MAX_SESSION_SIZE + 1];
2855 size = ssn->ssl->session->session_id_length;
2856 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
2858 fr_bin2hex(buffer, ssn->ssl->session->session_id, size);
2860 vps = SSL_SESSION_get_ex_data(ssn->ssl->session, fr_tls_ex_index_vps);
2862 RWDEBUG("No information in cached session %s", buffer);
2867 RDEBUG("Adding cached attributes for session %s:", buffer);
2868 rdebug_pair_list(L_DBG_LVL_1, request, vps, NULL);
2869 for (vp = fr_cursor_init(&cursor, &vps);
2871 vp = fr_cursor_next(&cursor)) {
2873 * TLS-* attrs get added back to
2876 if ((vp->da->vendor == 0) &&
2877 (vp->da->attr >= PW_TLS_CERT_SERIAL) &&
2878 (vp->da->attr <= PW_TLS_CLIENT_CERT_SUBJECT_ALT_NAME_UPN)) {
2879 pairadd(&request->packet->vps, paircopyvp(request->packet, vp));
2881 pairadd(&request->reply->vps, paircopyvp(request->reply, vp));
2885 if (conf->session_cache_path) {
2886 /* "touch" the cached session/vp file */
2889 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
2890 conf->session_cache_path, FR_DIR_SEP, buffer);
2891 utime(filename, NULL);
2892 snprintf(filename, sizeof(filename), "%s%c%s.vps",
2893 conf->session_cache_path, FR_DIR_SEP, buffer);
2894 utime(filename, NULL);
2898 * Mark the request as resumed.
2900 pairmake_packet("EAP-Session-Resumed", "1", T_OP_SET);
2908 void tls_fail(tls_session_t *ssn)
2911 * Force the session to NOT be cached.
2913 SSL_CTX_remove_session(ssn->ctx, ssn->ssl->session);
2916 fr_tls_status_t tls_application_data(tls_session_t *ssn,
2923 * Decrypt the complete record.
2925 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data,
2926 ssn->dirty_in.used);
2927 if (err != (int) ssn->dirty_in.used) {
2928 record_init(&ssn->dirty_in);
2929 RDEBUG("Failed writing %d to SSL BIO: %d", ssn->dirty_in.used, err);
2934 * Clear the dirty buffer now that we are done with it
2935 * and init the clean_out buffer to store decrypted data
2937 record_init(&ssn->dirty_in);
2938 record_init(&ssn->clean_out);
2941 * Read (and decrypt) the tunneled data from the
2942 * SSL session, and put it into the decrypted
2945 err = SSL_read(ssn->ssl, ssn->clean_out.data, sizeof(ssn->clean_out.data));
2949 RDEBUG("SSL_read Error");
2951 code = SSL_get_error(ssn->ssl, err);
2953 case SSL_ERROR_WANT_READ:
2954 DEBUG("Error in fragmentation logic: SSL_WANT_READ");
2955 return FR_TLS_MORE_FRAGMENTS;
2957 case SSL_ERROR_WANT_WRITE:
2958 DEBUG("Error in fragmentation logic: SSL_WANT_WRITE");
2962 DEBUG("Error in fragmentation logic: %s", ERR_error_string(code, NULL));
2965 * FIXME: Call int_ssl_check?
2972 if (err == 0) RWDEBUG("No data inside of the tunnel");
2975 * Passed all checks, successfully decrypted data
2977 ssn->clean_out.used = err;
2984 * Acknowledge received is for one of the following messages sent earlier
2985 * 1. Handshake completed Message, so now send, EAP-Success
2986 * 2. Alert Message, now send, EAP-Failure
2987 * 3. Fragment Message, now send, next Fragment
2989 fr_tls_status_t tls_ack_handler(tls_session_t *ssn, REQUEST *request)
2991 RDEBUG2("Received TLS ACK");
2994 RERROR("FAIL: Unexpected ACK received. Could not obtain session information");
2995 return FR_TLS_INVALID;
2997 if (ssn->info.initialized == 0) {
2998 RDEBUG("No SSL info available. Waiting for more SSL data");
2999 return FR_TLS_REQUEST;
3001 if ((ssn->info.content_type == handshake) && (ssn->info.origin == 0)) {
3002 RERROR("FAIL: ACK without earlier message");
3003 return FR_TLS_INVALID;
3006 switch (ssn->info.content_type) {
3008 RDEBUG2("ACK alert");
3012 if ((ssn->info.handshake_type == handshake_finished) && (ssn->dirty_out.used == 0)) {
3013 RDEBUG2("ACK handshake is finished");
3016 * From now on all the content is
3017 * application data set it here as nobody else
3020 ssn->info.content_type = application_data;
3021 return FR_TLS_SUCCESS;
3022 } /* else more data to send */
3024 RDEBUG2("ACK handshake fragment handler");
3025 /* Fragmentation handler, send next fragment */
3026 return FR_TLS_REQUEST;
3028 case application_data:
3029 RDEBUG2("ACK handshake fragment handler in application data");
3030 return FR_TLS_REQUEST;
3033 * For the rest of the conditions, switch over
3034 * to the default section below.
3037 RERROR("Invalid ACK received: %d", ssn->info.content_type);
3039 return FR_TLS_INVALID;
3043 #endif /* WITH_TLS */