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"
78 static void record_init(record_t *buf);
79 static void record_close(record_t *buf);
80 static unsigned int record_plus(record_t *buf, void const *ptr,
82 static unsigned int record_minus(record_t *buf, void *ptr,
85 #ifdef PSK_MAX_IDENTITY_LEN
86 static bool identity_is_safe(const char *identity)
90 if (!identity) return true;
92 while ((c = *(identity++)) != '\0') {
93 if (isalpha((int) c) || isdigit((int) c) || isspace((int) c) ||
94 (c == '@') || (c == '-') || (c == '_') || (c == '.')) {
106 * When a client uses TLS-PSK to talk to a server, this callback
107 * is used by the server to determine the PSK to use.
109 static unsigned int psk_server_callback(SSL *ssl, const char *identity,
111 unsigned int max_psk_len)
113 unsigned int psk_len = 0;
114 fr_tls_server_conf_t *conf;
117 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl,
118 FR_TLS_EX_INDEX_CONF);
121 request = (REQUEST *)SSL_get_ex_data(ssl,
122 FR_TLS_EX_INDEX_REQUEST);
123 if (request && conf->psk_query) {
126 char buffer[2 * PSK_MAX_PSK_LEN + 4]; /* allow for too-long keys */
129 * The passed identity is weird. Deny it.
131 if (!identity_is_safe(identity)) {
132 RWDEBUG("Invalid characters in PSK identity %s", identity);
136 vp = pairmake_packet("TLS-PSK-Identity", identity, T_OP_SET);
139 hex_len = radius_xlat(buffer, sizeof(buffer), request, conf->psk_query,
142 RWDEBUG("PSK expansion returned an empty string.");
147 * The returned key is truncated at MORE than
148 * OpenSSL can handle. That way we can detect
149 * the truncation, and complain about it.
151 if (hex_len > (2 * max_psk_len)) {
152 RWDEBUG("Returned PSK is too long (%u > %u)",
153 (unsigned int) hex_len, 2 * max_psk_len);
158 * Leave the TLS-PSK-Identity in the request, and
159 * convert the expansion from printable string
162 return fr_hex2bin(psk, max_psk_len, buffer, hex_len);
165 if (!conf->psk_identity) {
166 DEBUG("No static PSK identity set. Rejecting the user");
171 * No REQUEST, or no dynamic query. Just look for a
174 if (strcmp(identity, conf->psk_identity) != 0) {
175 ERROR("Supplied PSK identity %s does not match configuration. Rejecting.",
180 psk_len = strlen(conf->psk_password);
181 if (psk_len > (2 * max_psk_len)) return 0;
183 return fr_hex2bin(psk, max_psk_len, conf->psk_password, psk_len);
186 static unsigned int psk_client_callback(SSL *ssl, UNUSED char const *hint,
187 char *identity, unsigned int max_identity_len,
188 unsigned char *psk, unsigned int max_psk_len)
190 unsigned int psk_len;
191 fr_tls_server_conf_t *conf;
193 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl,
194 FR_TLS_EX_INDEX_CONF);
197 psk_len = strlen(conf->psk_password);
198 if (psk_len > (2 * max_psk_len)) return 0;
200 strlcpy(identity, conf->psk_identity, max_identity_len);
202 return fr_hex2bin(psk, max_psk_len, conf->psk_password, psk_len);
207 tls_session_t *tls_new_client_session(fr_tls_server_conf_t *conf, int fd)
210 tls_session_t *ssn = NULL;
213 ssn = talloc_zero(conf, tls_session_t);
214 if (!ssn) return NULL;
216 ssn->ctx = conf->ctx;
218 SSL_CTX_set_mode(ssn->ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_AUTO_RETRY);
220 ssn->ssl = SSL_new(ssn->ctx);
226 request = request_alloc(ssn);
227 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_REQUEST, (void *)request);
230 * Add the message callback to identify what type of
231 * message/handshake is passed
233 SSL_set_msg_callback(ssn->ssl, cbtls_msg);
234 SSL_set_msg_callback_arg(ssn->ssl, ssn);
235 SSL_set_info_callback(ssn->ssl, cbtls_info);
238 * Always verify the peer certificate.
240 DEBUG2("Requiring Server certificate");
241 verify_mode = SSL_VERIFY_PEER;
242 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
243 SSL_set_verify(ssn->ssl, verify_mode, cbtls_verify);
245 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
246 SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_SSN, (void *)ssn);
247 SSL_set_fd(ssn->ssl, fd);
248 if (SSL_connect(ssn->ssl) <= 0) {
250 while ((err = ERR_get_error())) {
251 ERROR("tls: %s", ERR_error_string(err, NULL));
259 ssn->offset = conf->fragment_size;
264 static int _tls_session_free(tls_session_t *ssn)
267 * Free any opaque TTLS or PEAP data.
269 if ((ssn->opaque) && (ssn->free_opaque)) {
270 ssn->free_opaque(ssn->opaque);
279 tls_session_t *tls_new_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, REQUEST *request, bool client_cert)
281 tls_session_t *state = NULL;
286 rad_assert(request != NULL);
289 * Manually flush the sessions every so often. If HALF
290 * of the session lifetime has passed since we last
291 * flushed, then flush it again.
293 * FIXME: Also do it every N sessions?
295 if (conf->session_cache_enable &&
296 ((conf->session_last_flushed + ((int)conf->session_timeout * 1800)) <= request->timestamp)){
297 RDEBUG2("Flushing SSL sessions (of #%ld)",
298 SSL_CTX_sess_number(conf->ctx));
300 SSL_CTX_flush_sessions(conf->ctx, request->timestamp);
301 conf->session_last_flushed = request->timestamp;
304 if ((new_tls = SSL_new(conf->ctx)) == NULL) {
305 ERROR("SSL: Error creating new SSL: %s",
306 ERR_error_string(ERR_get_error(), NULL));
310 /* We use the SSL's "app_data" to indicate a call-back */
311 SSL_set_app_data(new_tls, NULL);
313 state = talloc_zero(ctx, tls_session_t);
315 talloc_set_destructor(state, _tls_session_free);
317 state->ctx = conf->ctx;
318 state->ssl = new_tls;
321 * Initialize callbacks
323 state->record_init = record_init;
324 state->record_close = record_close;
325 state->record_plus = record_plus;
326 state->record_minus = record_minus;
329 * Create & hook the BIOs to handle the dirty side of the
330 * SSL. This is *very important* as we want to handle
331 * the transmission part. Now the only IO interface
332 * that SSL is aware of, is our defined BIO buffers.
334 * This means that all SSL IO is done to/from memory,
335 * and we can update those BIOs from the packets we've
338 state->into_ssl = BIO_new(BIO_s_mem());
339 state->from_ssl = BIO_new(BIO_s_mem());
340 SSL_set_bio(state->ssl, state->into_ssl, state->from_ssl);
343 * Add the message callback to identify what type of
344 * message/handshake is passed
346 SSL_set_msg_callback(new_tls, cbtls_msg);
347 SSL_set_msg_callback_arg(new_tls, state);
348 SSL_set_info_callback(new_tls, cbtls_info);
351 * In Server mode we only accept.
353 SSL_set_accept_state(state->ssl);
356 * Verify the peer certificate, if asked.
359 RDEBUG2("Requiring client certificate");
360 verify_mode = SSL_VERIFY_PEER;
361 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
362 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
364 SSL_set_verify(state->ssl, verify_mode, cbtls_verify);
366 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_CONF, (void *)conf);
367 SSL_set_ex_data(state->ssl, FR_TLS_EX_INDEX_SSN, (void *)state);
368 state->length_flag = conf->include_length;
371 * We use default fragment size, unless the Framed-MTU
372 * tells us it's too big. Note that we do NOT account
373 * for the EAP-TLS headers if conf->fragment_size is
374 * large, because that config item looks to be confusing.
376 * i.e. it should REALLY be called MTU, and the code here
377 * should figure out what that means for TLS fragment size.
378 * asking the administrator to know the internal details
379 * of EAP-TLS in order to calculate fragment sizes is
382 state->offset = conf->fragment_size;
383 vp = pairfind(request->packet->vps, PW_FRAMED_MTU, 0, TAG_ANY);
384 if (vp && (vp->vp_integer > 100) && (vp->vp_integer < state->offset)) {
385 state->offset = vp->vp_integer;
388 if (conf->session_cache_enable) {
389 state->allow_session_resumption = 1; /* otherwise it's zero */
398 * Print out some text describing the error.
400 static int int_ssl_check(REQUEST *request, SSL *s, int ret, char const *text)
405 if ((l = ERR_get_error()) != 0) {
406 char const *p = ERR_error_string(l, NULL);
408 if (request && p) REDEBUG("SSL says: %s", p);
410 e = SSL_get_error(s, ret);
414 * These seem to be harmless and already "dealt
415 * with" by our non-blocking environment. NB:
416 * "ZERO_RETURN" is the clean "error"
417 * indicating a successfully closed SSL
418 * tunnel. We let this happen because our IO
419 * loop should not appear to have broken on
420 * this condition - and outside the IO loop, the
421 * "shutdown" state is checked.
423 * Don't print anything if we ignore the error.
426 case SSL_ERROR_WANT_READ:
427 case SSL_ERROR_WANT_WRITE:
428 case SSL_ERROR_WANT_X509_LOOKUP:
429 case SSL_ERROR_ZERO_RETURN:
433 * These seem to be indications of a genuine
434 * error that should result in the SSL tunnel
435 * being regarded as "dead".
437 case SSL_ERROR_SYSCALL:
438 ERROR("SSL: %s failed in a system call (%d), TLS session fails.",
443 ERROR("SSL: %s failed inside of TLS (%d), TLS session fails.",
449 * For any other errors that (a) exist, and (b)
450 * crop up - we need to interpret what to do with
451 * them - so "politely inform" the caller that
452 * the code needs updating here.
454 ERROR("SSL: FATAL SSL error ..... %d\n", e);
462 * We are the server, we always get the dirty data
463 * (Handshake data is also considered as dirty data)
464 * During handshake, since SSL API handles itself,
465 * After clean-up, dirty_out will be filled with
466 * the data required for handshaking. So we check
467 * if dirty_out is empty then we simply send it back.
468 * As of now, if handshake is successful, then we keep going,
471 * Fill the Bio with the dirty data to clean it
472 * Get the cleaned data from SSL, if it is not Handshake data
474 int tls_handshake_recv(REQUEST *request, tls_session_t *ssn)
478 if (ssn->invalid_hb_used) return 0;
480 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data, ssn->dirty_in.used);
481 if (err != (int) ssn->dirty_in.used) {
482 RDEBUG("Failed writing %d to SSL BIO: %d", ssn->dirty_in.used,
484 record_init(&ssn->dirty_in);
487 record_init(&ssn->dirty_in);
489 err = SSL_read(ssn->ssl, ssn->clean_out.data + ssn->clean_out.used,
490 sizeof(ssn->clean_out.data) - ssn->clean_out.used);
492 ssn->clean_out.used += err;
496 if (!int_ssl_check(request, ssn->ssl, err, "SSL_read")) {
500 /* Some Extra STATE information for easy debugging */
501 if (SSL_is_init_finished(ssn->ssl)) {
502 DEBUG2("SSL Connection Established\n");
504 if (SSL_in_init(ssn->ssl)) {
505 DEBUG2("In SSL Handshake Phase\n");
507 if (SSL_in_before(ssn->ssl)) {
508 DEBUG2("Before SSL Handshake Phase\n");
510 if (SSL_in_accept_init(ssn->ssl)) {
511 DEBUG2("In SSL Accept mode \n");
513 if (SSL_in_connect_init(ssn->ssl)) {
514 DEBUG2("In SSL Connect mode \n");
517 err = BIO_ctrl_pending(ssn->from_ssl);
519 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
520 sizeof(ssn->dirty_out.data));
522 ssn->dirty_out.used = err;
524 } else if (BIO_should_retry(ssn->from_ssl)) {
525 record_init(&ssn->dirty_in);
526 DEBUG2(" tls: Asking for more data in tunnel");
530 int_ssl_check(request, ssn->ssl, err, "BIO_read");
531 record_init(&ssn->dirty_in);
535 DEBUG2("SSL Application Data");
536 /* Its clean application data, do whatever we want */
537 record_init(&ssn->clean_out);
540 /* We are done with dirty_in, reinitialize it */
541 record_init(&ssn->dirty_in);
546 * Take cleartext user data, and encrypt it into the output buffer,
547 * to send to the client at the other end of the SSL connection.
549 int tls_handshake_send(REQUEST *request, tls_session_t *ssn)
554 * If there's un-encrypted data in 'clean_in', then write
555 * that data to the SSL session, and then call the BIO function
556 * to get that encrypted data from the SSL session, into
557 * a buffer which we can then package into an EAP packet.
559 * Based on Server's logic this clean_in is expected to
560 * contain the data to send to the client.
562 if (ssn->clean_in.used > 0) {
565 written = SSL_write(ssn->ssl, ssn->clean_in.data, ssn->clean_in.used);
566 record_minus(&ssn->clean_in, NULL, written);
568 /* Get the dirty data from Bio to send it */
569 err = BIO_read(ssn->from_ssl, ssn->dirty_out.data,
570 sizeof(ssn->dirty_out.data));
572 ssn->dirty_out.used = err;
574 int_ssl_check(request, ssn->ssl, err, "handshake_send");
581 void session_init(tls_session_t *ssn)
584 ssn->into_ssl = ssn->from_ssl = NULL;
585 record_init(&ssn->clean_in);
586 record_init(&ssn->clean_out);
587 record_init(&ssn->dirty_in);
588 record_init(&ssn->dirty_out);
590 memset(&ssn->info, 0, sizeof(ssn->info));
594 ssn->tls_msg_len = 0;
595 ssn->length_flag = 0;
597 ssn->free_opaque = NULL;
600 void session_close(tls_session_t *ssn)
602 SSL_set_quiet_shutdown(ssn->ssl, 1);
603 SSL_shutdown(ssn->ssl);
610 record_close(&ssn->clean_in);
611 record_close(&ssn->clean_out);
612 record_close(&ssn->dirty_in);
613 record_close(&ssn->dirty_out);
617 static void record_init(record_t *rec)
622 static void record_close(record_t *rec)
629 * Copy data to the intermediate buffer, before we send
632 static unsigned int record_plus(record_t *rec, void const *ptr,
635 unsigned int added = MAX_RECORD_SIZE - rec->used;
641 memcpy(rec->data + rec->used, ptr, added);
647 * Take data from the buffer, and give it to the caller.
649 static unsigned int record_minus(record_t *rec, void *ptr,
652 unsigned int taken = rec->used;
659 memcpy(ptr, rec->data, taken);
663 * This is pretty bad...
666 memmove(rec->data, rec->data + taken, rec->used);
670 void tls_session_information(tls_session_t *tls_session)
672 char const *str_write_p, *str_version, *str_content_type = "";
673 char const *str_details1 = "", *str_details2= "";
677 * Don't print this out in the normal course of
680 if (debug_flag == 0) {
684 str_write_p = tls_session->info.origin ? ">>>" : "<<<";
686 switch (tls_session->info.version) {
688 str_version = "SSL 2.0";
691 str_version = "SSL 3.0 ";
694 str_version = "TLS 1.0 ";
697 str_version = "Unknown TLS version";
701 if (tls_session->info.version == SSL3_VERSION ||
702 tls_session->info.version == TLS1_VERSION) {
703 switch (tls_session->info.content_type) {
704 case SSL3_RT_CHANGE_CIPHER_SPEC:
705 str_content_type = "ChangeCipherSpec";
709 str_content_type = "Alert";
712 case SSL3_RT_HANDSHAKE:
713 str_content_type = "Handshake";
716 case SSL3_RT_APPLICATION_DATA:
717 str_content_type = "ApplicationData";
721 str_content_type = "UnknownContentType";
725 if (tls_session->info.content_type == SSL3_RT_ALERT) {
726 str_details1 = ", ???";
728 if (tls_session->info.record_len == 2) {
730 switch (tls_session->info.alert_level) {
731 case SSL3_AL_WARNING:
732 str_details1 = ", warning";
735 str_details1 = ", fatal";
739 str_details2 = " ???";
740 switch (tls_session->info.alert_description) {
741 case SSL3_AD_CLOSE_NOTIFY:
742 str_details2 = " close_notify";
745 case SSL3_AD_UNEXPECTED_MESSAGE:
746 str_details2 = " unexpected_message";
749 case SSL3_AD_BAD_RECORD_MAC:
750 str_details2 = " bad_record_mac";
753 case TLS1_AD_DECRYPTION_FAILED:
754 str_details2 = " decryption_failed";
757 case TLS1_AD_RECORD_OVERFLOW:
758 str_details2 = " record_overflow";
761 case SSL3_AD_DECOMPRESSION_FAILURE:
762 str_details2 = " decompression_failure";
765 case SSL3_AD_HANDSHAKE_FAILURE:
766 str_details2 = " handshake_failure";
769 case SSL3_AD_BAD_CERTIFICATE:
770 str_details2 = " bad_certificate";
773 case SSL3_AD_UNSUPPORTED_CERTIFICATE:
774 str_details2 = " unsupported_certificate";
777 case SSL3_AD_CERTIFICATE_REVOKED:
778 str_details2 = " certificate_revoked";
781 case SSL3_AD_CERTIFICATE_EXPIRED:
782 str_details2 = " certificate_expired";
785 case SSL3_AD_CERTIFICATE_UNKNOWN:
786 str_details2 = " certificate_unknown";
789 case SSL3_AD_ILLEGAL_PARAMETER:
790 str_details2 = " illegal_parameter";
793 case TLS1_AD_UNKNOWN_CA:
794 str_details2 = " unknown_ca";
797 case TLS1_AD_ACCESS_DENIED:
798 str_details2 = " access_denied";
801 case TLS1_AD_DECODE_ERROR:
802 str_details2 = " decode_error";
805 case TLS1_AD_DECRYPT_ERROR:
806 str_details2 = " decrypt_error";
809 case TLS1_AD_EXPORT_RESTRICTION:
810 str_details2 = " export_restriction";
813 case TLS1_AD_PROTOCOL_VERSION:
814 str_details2 = " protocol_version";
817 case TLS1_AD_INSUFFICIENT_SECURITY:
818 str_details2 = " insufficient_security";
821 case TLS1_AD_INTERNAL_ERROR:
822 str_details2 = " internal_error";
825 case TLS1_AD_USER_CANCELLED:
826 str_details2 = " user_canceled";
829 case TLS1_AD_NO_RENEGOTIATION:
830 str_details2 = " no_renegotiation";
836 if (tls_session->info.content_type == SSL3_RT_HANDSHAKE) {
837 str_details1 = "???";
839 if (tls_session->info.record_len > 0) switch (tls_session->info.handshake_type) {
840 case SSL3_MT_HELLO_REQUEST:
841 str_details1 = ", HelloRequest";
844 case SSL3_MT_CLIENT_HELLO:
845 str_details1 = ", ClientHello";
848 case SSL3_MT_SERVER_HELLO:
849 str_details1 = ", ServerHello";
852 case SSL3_MT_CERTIFICATE:
853 str_details1 = ", Certificate";
856 case SSL3_MT_SERVER_KEY_EXCHANGE:
857 str_details1 = ", ServerKeyExchange";
860 case SSL3_MT_CERTIFICATE_REQUEST:
861 str_details1 = ", CertificateRequest";
864 case SSL3_MT_SERVER_DONE:
865 str_details1 = ", ServerHelloDone";
868 case SSL3_MT_CERTIFICATE_VERIFY:
869 str_details1 = ", CertificateVerify";
872 case SSL3_MT_CLIENT_KEY_EXCHANGE:
873 str_details1 = ", ClientKeyExchange";
876 case SSL3_MT_FINISHED:
877 str_details1 = ", Finished";
883 snprintf(tls_session->info.info_description,
884 sizeof(tls_session->info.info_description),
885 "%s %s%s [length %04lx]%s%s\n",
886 str_write_p, str_version, str_content_type,
887 (unsigned long)tls_session->info.record_len,
888 str_details1, str_details2);
890 request = SSL_get_ex_data(tls_session->ssl, FR_TLS_EX_INDEX_REQUEST);
892 RDEBUG2("%s", tls_session->info.info_description);
894 DEBUG2("%s", tls_session->info.info_description);
898 static CONF_PARSER cache_config[] = {
899 { "enable", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, session_cache_enable), "no" },
900 { "lifetime", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, session_timeout), "24" },
901 { "max_entries", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, session_cache_size), "255" },
902 { "name", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, session_id_name), NULL },
903 { "persist_dir", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, session_cache_path), NULL },
904 { NULL, -1, 0, NULL, NULL } /* end the list */
907 static CONF_PARSER verify_config[] = {
908 { "tmpdir", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, verify_tmp_dir), NULL },
909 { "client", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, verify_client_cert_cmd), NULL },
910 { NULL, -1, 0, NULL, NULL } /* end the list */
913 #ifdef HAVE_OPENSSL_OCSP_H
914 static CONF_PARSER ocsp_config[] = {
915 { "enable", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_enable), "no" },
916 { "override_cert_url", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_override_url), "no" },
917 { "url", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ocsp_url), NULL },
918 { "use_nonce", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_use_nonce), "yes" },
919 { "timeout", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, ocsp_timeout), "yes" },
920 { "softfail", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, ocsp_softfail), "no" },
921 { NULL, -1, 0, NULL, NULL } /* end the list */
925 static CONF_PARSER tls_server_config[] = {
926 { "rsa_key_exchange", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, rsa_key), "no" },
927 { "dh_key_exchange", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, dh_key), "yes" },
928 { "rsa_key_length", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, rsa_key_length), "512" },
929 { "dh_key_length", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, dh_key_length), "512" },
930 { "verify_depth", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, verify_depth), "0" },
931 { "CA_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED, fr_tls_server_conf_t, ca_path), NULL },
932 { "ca_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_path), NULL },
933 { "pem_file_type", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, file_type), "yes" },
934 { "private_key_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, private_key_file), NULL },
935 { "certificate_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, certificate_file), NULL },
936 { "CA_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED, fr_tls_server_conf_t, ca_file), NULL },
937 { "ca_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_file), NULL },
938 { "private_key_password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, private_key_password), NULL },
939 #ifdef PSK_MAX_IDENTITY_LEN
940 { "psk_identity", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, psk_identity), NULL },
941 { "psk_hexphrase", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, psk_password), NULL },
942 { "psk_query", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, psk_query), NULL },
944 { "dh_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, dh_file), NULL },
945 { "random_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, random_file), NULL },
946 { "fragment_size", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, fragment_size), "1024" },
947 { "include_length", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, include_length), "yes" },
948 { "check_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, check_crl), "no" },
949 { "allow_expired_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, allow_expired_crl), NULL },
950 { "check_cert_cn", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_cn), NULL },
951 { "cipher_list", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, cipher_list), NULL },
952 { "check_cert_issuer", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_issuer), NULL },
953 { "require_client_cert", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, require_client_cert), NULL },
955 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
956 #ifndef OPENSSL_NO_ECDH
957 { "ecdh_curve", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ecdh_curve), "prime256v1" },
961 { "disable_tlsv1_1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_1), NULL },
962 { "disable_tlsv1_2", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_2), NULL },
964 { "cache", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) cache_config },
966 { "verify", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) verify_config },
968 #ifdef HAVE_OPENSSL_OCSP_H
969 { "ocsp", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) ocsp_config },
972 { NULL, -1, 0, NULL, NULL } /* end the list */
976 static CONF_PARSER tls_client_config[] = {
977 { "rsa_key_exchange", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, rsa_key), "no" },
978 { "dh_key_exchange", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, dh_key), "yes" },
979 { "rsa_key_length", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, rsa_key_length), "512" },
980 { "dh_key_length", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, dh_key_length), "512" },
981 { "verify_depth", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, verify_depth), "0" },
982 { "ca_path", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_path), NULL },
983 { "pem_file_type", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, file_type), "yes" },
984 { "private_key_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, private_key_file), NULL },
985 { "certificate_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, certificate_file), NULL },
986 { "ca_file", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, fr_tls_server_conf_t, ca_file), NULL },
987 { "private_key_password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, fr_tls_server_conf_t, private_key_password), NULL },
988 { "dh_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, dh_file), NULL },
989 { "random_file", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, random_file), NULL },
990 { "fragment_size", FR_CONF_OFFSET(PW_TYPE_INTEGER, fr_tls_server_conf_t, fragment_size), "1024" },
991 { "include_length", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, include_length), "yes" },
992 { "check_crl", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, check_crl), "no" },
993 { "check_cert_cn", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_cn), NULL },
994 { "cipher_list", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, cipher_list), NULL },
995 { "check_cert_issuer", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, check_cert_issuer), NULL },
997 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
998 #ifndef OPENSSL_NO_ECDH
999 { "ecdh_curve", FR_CONF_OFFSET(PW_TYPE_STRING, fr_tls_server_conf_t, ecdh_curve), "prime256v1" },
1003 #ifdef SSL_OP_NO_TLSv1_1
1004 { "disable_tlsv1_1", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_1), NULL },
1006 #ifdef SSL_OP_NO_TLSv1_2
1007 { "disable_tlsv1_2", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, fr_tls_server_conf_t, disable_tlsv1_2), NULL },
1010 { NULL, -1, 0, NULL, NULL } /* end the list */
1015 * TODO: Check for the type of key exchange * like conf->dh_key
1017 static int load_dh_params(SSL_CTX *ctx, char *file)
1022 if (!file) return 0;
1024 if ((bio = BIO_new_file(file, "r")) == NULL) {
1025 ERROR("tls: Unable to open DH file - %s", file);
1029 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
1032 WARN("tls: Unable to set DH parameters. DH cipher suites may not work!");
1033 WARN("Fix this by running the OpenSSL command listed in eap.conf");
1037 if (SSL_CTX_set_tmp_dh(ctx, dh) < 0) {
1038 ERROR("tls: Unable to set DH parameters");
1049 * Generate ephemeral RSA keys.
1051 static int generate_eph_rsa_key(SSL_CTX *ctx)
1055 rsa = RSA_generate_key(512, RSA_F4, NULL, NULL);
1057 if (!SSL_CTX_set_tmp_rsa(ctx, rsa)) {
1058 ERROR("tls: Couldn't set ephemeral RSA key");
1066 /* index we use to store cached session VPs
1067 * needs to be dynamic so we can supply a "free" function
1069 int fr_tls_ex_index_vps = -1;
1070 int fr_tls_ex_index_certs = -1;
1073 * Print debugging messages, and free data.
1075 * FIXME: Write sessions to some long-term storage, so that
1076 * session resumption can still occur after the server
1079 #define MAX_SESSION_SIZE (256)
1081 static void cbtls_remove_session(SSL_CTX *ctx, SSL_SESSION *sess)
1084 char buffer[2 * MAX_SESSION_SIZE + 1];
1085 fr_tls_server_conf_t *conf;
1087 size = sess->session_id_length;
1088 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1090 fr_bin2hex(buffer, sess->session_id, size);
1092 DEBUG2(" SSL: Removing session %s from the cache", buffer);
1093 conf = (fr_tls_server_conf_t *)SSL_CTX_get_app_data(ctx);
1094 if (conf && conf->session_cache_path) {
1098 /* remove session and any cached VPs */
1099 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1100 conf->session_cache_path, FR_DIR_SEP, buffer);
1101 rv = unlink(filename);
1103 DEBUG2(" SSL: could not remove persisted session file %s: %s", filename, fr_syserror(errno));
1105 /* VPs might be absent; might not have been written to disk yet */
1106 snprintf(filename, sizeof(filename), "%s%c%s.vps",
1107 conf->session_cache_path, FR_DIR_SEP, buffer);
1114 static int cbtls_new_session(SSL *ssl, SSL_SESSION *sess)
1117 char buffer[2 * MAX_SESSION_SIZE + 1];
1118 fr_tls_server_conf_t *conf;
1119 unsigned char *sess_blob = NULL;
1121 size = sess->session_id_length;
1122 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1124 fr_bin2hex(buffer, sess->session_id, size);
1126 DEBUG2(" SSL: adding session %s to cache", buffer);
1128 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1129 if (conf && conf->session_cache_path) {
1130 int fd, rv, todo, blob_len;
1134 /* find out what length data we need */
1135 blob_len = i2d_SSL_SESSION(sess, NULL);
1137 /* something went wrong */
1138 DEBUG2(" SSL: could not find buffer length to persist session");
1143 /* Do not convert to TALLOC - Thread safety */
1144 /* alloc and convert to ASN.1 */
1145 sess_blob = malloc(blob_len);
1147 DEBUG2(" SSL: could not allocate buffer len=%d to persist session", blob_len);
1150 /* openssl mutates &p */
1152 rv = i2d_SSL_SESSION(sess, &p);
1153 if (rv != blob_len) {
1154 DEBUG2(" SSL: could not persist session");
1158 /* open output file */
1159 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1160 conf->session_cache_path, FR_DIR_SEP, buffer);
1161 fd = open(filename, O_RDWR|O_CREAT|O_EXCL, 0600);
1163 DEBUG2(" SSL: could not open session file %s: %s", filename, fr_syserror(errno));
1170 rv = write(fd, p, todo);
1172 DEBUG2(" SSL: failed writing session: %s", fr_syserror(errno));
1180 DEBUG2(" SSL: wrote session %s to %s len=%d", buffer, filename, blob_len);
1189 static SSL_SESSION *cbtls_get_session(SSL *ssl,
1190 unsigned char *data, int len,
1194 char buffer[2 * MAX_SESSION_SIZE + 1];
1195 fr_tls_server_conf_t *conf;
1196 TALLOC_CTX *talloc_ctx;
1198 SSL_SESSION *sess = NULL;
1199 unsigned char *sess_data = NULL;
1200 PAIR_LIST *pairlist = NULL;
1203 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
1205 fr_bin2hex(buffer, data, size);
1207 DEBUG2(" SSL: Client requested cached session %s", buffer);
1209 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1210 talloc_ctx = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_TALLOC);
1211 if (conf && conf->session_cache_path) {
1218 /* read in the cached VPs from the .vps file */
1219 snprintf(filename, sizeof(filename), "%s%c%s.vps",
1220 conf->session_cache_path, FR_DIR_SEP, buffer);
1221 rv = pairlist_read(NULL, filename, &pairlist, 1);
1223 /* not safe to un-persist a session w/o VPs */
1224 DEBUG2(" SSL: could not load persisted VPs for session %s", buffer);
1228 /* load the actual SSL session */
1229 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
1230 conf->session_cache_path, FR_DIR_SEP, buffer);
1231 fd = open(filename, O_RDONLY);
1233 DEBUG2(" SSL: could not find persisted session file %s: %s", filename, fr_syserror(errno));
1237 rv = fstat(fd, &st);
1239 DEBUG2(" SSL: could not stat persisted session file %s: %s", filename, fr_syserror(errno));
1244 sess_data = talloc_array(NULL, unsigned char, st.st_size);
1246 DEBUG2(" SSL: could not alloc buffer for persisted session len=%d", (int) st.st_size);
1254 rv = read(fd, p, todo);
1256 DEBUG2(" SSL: could not read from persisted session: %s", fr_syserror(errno));
1265 /* openssl mutates &p */
1267 sess = d2i_SSL_SESSION(NULL, (unsigned char const **)(void **) &p, st.st_size);
1270 DEBUG2(" SSL: OpenSSL failed to load persisted session: %s", ERR_error_string(ERR_get_error(), NULL));
1274 /* cache the VPs into the session */
1275 vp = paircopy(talloc_ctx, pairlist->reply);
1276 SSL_SESSION_set_ex_data(sess, fr_tls_ex_index_vps, vp);
1277 DEBUG2(" SSL: Successfully restored session %s", buffer);
1280 if (sess_data) talloc_free(sess_data);
1281 if (pairlist) pairlist_free(&pairlist);
1287 #ifdef HAVE_OPENSSL_OCSP_H
1289 * This function extracts the OCSP Responder URL
1290 * from an existing x509 certificate.
1292 static int ocsp_parse_cert_url(X509 *cert, char **phost, char **pport,
1293 char **ppath, int *pssl)
1297 AUTHORITY_INFO_ACCESS *aia;
1298 ACCESS_DESCRIPTION *ad;
1300 aia = X509_get_ext_d2i(cert, NID_info_access, NULL, NULL);
1302 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(aia); i++) {
1303 ad = sk_ACCESS_DESCRIPTION_value(aia, i);
1304 if (OBJ_obj2nid(ad->method) == NID_ad_OCSP) {
1305 if (ad->location->type == GEN_URI) {
1306 if(OCSP_parse_url((char *) ad->location->d.ia5->data,
1307 phost, pport, ppath, pssl))
1316 * This function sends a OCSP request to a defined OCSP responder
1317 * and checks the OCSP response for correctness.
1320 /* Maximum leeway in validity period: default 5 minutes */
1321 #define MAX_VALIDITY_PERIOD (5 * 60)
1323 static int ocsp_check(X509_STORE *store, X509 *issuer_cert, X509 *client_cert,
1324 fr_tls_server_conf_t *conf)
1326 OCSP_CERTID *certid;
1328 OCSP_RESPONSE *resp = NULL;
1329 OCSP_BASICRESP *bresp = NULL;
1333 char hostheader[1024];
1335 long nsec = MAX_VALIDITY_PERIOD, maxage = -1;
1336 BIO *cbio, *bio_out;
1339 ASN1_GENERALIZEDTIME *rev, *thisupd, *nextupd;
1341 #if OPENSSL_VERSION_NUMBER >= 0x1000003f
1345 struct timeval when;
1349 * Create OCSP Request
1351 certid = OCSP_cert_to_id(NULL, client_cert, issuer_cert);
1352 req = OCSP_REQUEST_new();
1353 OCSP_request_add0_id(req, certid);
1354 if(conf->ocsp_use_nonce) {
1355 OCSP_request_add1_nonce(req, NULL, 8);
1359 * Send OCSP Request and get OCSP Response
1362 /* Get OCSP responder URL */
1363 if (conf->ocsp_override_url) {
1366 memcpy(&url, &conf->ocsp_url, sizeof(url));
1367 /* Reading the libssl src, they do a strdup on the URL, so it could of been const *sigh* */
1368 OCSP_parse_url(url, &host, &port, &path, &use_ssl);
1371 ocsp_parse_cert_url(client_cert, &host, &port, &path, &use_ssl);
1374 if (!host || !port || !path) {
1375 DEBUG2("[ocsp] - Host / port / path missing. Not doing OCSP");
1380 DEBUG2("[ocsp] --> Responder URL = http://%s:%s%s", host, port, path);
1382 /* Check host and port length are sane, then create Host: HTTP header */
1383 if ((strlen(host) + strlen(port) + 2) > sizeof(hostheader)) {
1384 ERROR("OCSP Host and port too long");
1387 snprintf(hostheader, sizeof(hostheader), "%s:%s", host, port);
1389 /* Setup BIO socket to OCSP responder */
1390 cbio = BIO_new_connect(host);
1394 if (default_log.dst == L_DST_STDOUT) {
1395 bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
1396 } else if (default_log.dst == L_DST_STDERR) {
1397 bio_out = BIO_new_fp(stderr, BIO_NOCLOSE);
1401 BIO_set_conn_port(cbio, port);
1402 #if OPENSSL_VERSION_NUMBER < 0x1000003f
1403 BIO_do_connect(cbio);
1405 /* Send OCSP request and wait for response */
1406 resp = OCSP_sendreq_bio(cbio, path, req);
1408 ERROR("Couldn't get OCSP response");
1413 if (conf->ocsp_timeout)
1414 BIO_set_nbio(cbio, 1);
1416 rc = BIO_do_connect(cbio);
1417 if ((rc <= 0) && ((!conf->ocsp_timeout) || !BIO_should_retry(cbio))) {
1418 ERROR("Couldn't connect to OCSP responder");
1423 ctx = OCSP_sendreq_new(cbio, path, NULL, -1);
1425 ERROR("Couldn't create OCSP request");
1430 if (!OCSP_REQ_CTX_add1_header(ctx, "Host", hostheader)) {
1431 ERROR("Couldn't set Host header");
1436 if (!OCSP_REQ_CTX_set1_req(ctx, req)) {
1437 ERROR("Couldn't add data to OCSP request");
1442 gettimeofday(&when, NULL);
1443 when.tv_sec += conf->ocsp_timeout;
1446 rc = OCSP_sendreq_nbio(&resp, ctx);
1447 if (conf->ocsp_timeout) {
1448 gettimeofday(&now, NULL);
1449 if (!timercmp(&now, &when, <))
1452 } while ((rc == -1) && BIO_should_retry(cbio));
1454 if (conf->ocsp_timeout && (rc == -1) && BIO_should_retry(cbio)) {
1455 ERROR("OCSP response timed out");
1460 OCSP_REQ_CTX_free(ctx);
1463 ERROR("Couldn't get OCSP response");
1469 /* Verify OCSP response status */
1470 status = OCSP_response_status(resp);
1471 DEBUG2("[ocsp] --> Response status: %s",OCSP_response_status_str(status));
1472 if(status != OCSP_RESPONSE_STATUS_SUCCESSFUL) {
1473 ERROR("OCSP response status: %s", OCSP_response_status_str(status));
1476 bresp = OCSP_response_get1_basic(resp);
1477 if(conf->ocsp_use_nonce && OCSP_check_nonce(req, bresp)!=1) {
1478 ERROR("OCSP response has wrong nonce value");
1481 if(OCSP_basic_verify(bresp, NULL, store, 0)!=1){
1482 ERROR("Couldn't verify OCSP basic response");
1486 /* Verify OCSP cert status */
1487 if(!OCSP_resp_find_status(bresp, certid, &status, &reason,
1488 &rev, &thisupd, &nextupd)) {
1489 ERROR("No Status found.\n");
1493 if (!OCSP_check_validity(thisupd, nextupd, nsec, maxage)) {
1495 BIO_puts(bio_out, "WARNING: Status times invalid.\n");
1496 ERR_print_errors(bio_out);
1503 BIO_puts(bio_out, "\tThis Update: ");
1504 ASN1_GENERALIZEDTIME_print(bio_out, thisupd);
1505 BIO_puts(bio_out, "\n");
1507 BIO_puts(bio_out, "\tNext Update: ");
1508 ASN1_GENERALIZEDTIME_print(bio_out, nextupd);
1509 BIO_puts(bio_out, "\n");
1514 case V_OCSP_CERTSTATUS_GOOD:
1515 DEBUG2("[oscp] --> Cert status: good");
1520 /* REVOKED / UNKNOWN */
1521 DEBUG2("[ocsp] --> Cert status: %s",OCSP_cert_status_str(status));
1523 DEBUG2("[ocsp] --> Reason: %s", OCSP_crl_reason_str(reason));
1526 BIO_puts(bio_out, "\tRevocation Time: ");
1527 ASN1_GENERALIZEDTIME_print(bio_out, rev);
1528 BIO_puts(bio_out, "\n");
1534 /* Free OCSP Stuff */
1535 OCSP_REQUEST_free(req);
1536 OCSP_RESPONSE_free(resp);
1541 if (bio_out) BIO_free(bio_out);
1542 OCSP_BASICRESP_free(bresp);
1547 DEBUG2("[ocsp] --> Certificate is valid!");
1550 if (conf->ocsp_softfail) {
1551 DEBUG2("[ocsp] --> Unable to check certificate; assuming valid");
1552 DEBUG2("[ocsp] --> Warning! This may be insecure");
1555 DEBUG2("[ocsp] --> Unable to check certificate; failing!");
1560 DEBUG2("[ocsp] --> Certificate has been expired/revoked!");
1566 #endif /* HAVE_OPENSSL_OCSP_H */
1569 * For creating certificate attributes.
1571 static char const *cert_attr_names[8][2] = {
1572 { "TLS-Client-Cert-Serial", "TLS-Cert-Serial" },
1573 { "TLS-Client-Cert-Expiration", "TLS-Cert-Expiration" },
1574 { "TLS-Client-Cert-Subject", "TLS-Cert-Subject" },
1575 { "TLS-Client-Cert-Issuer", "TLS-Cert-Issuer" },
1576 { "TLS-Client-Cert-Common-Name", "TLS-Cert-Common-Name" },
1577 { "TLS-Client-Cert-Subject-Alt-Name-Email", "TLS-Cert-Subject-Alt-Name-Email" },
1578 { "TLS-Client-Cert-Subject-Alt-Name-Dns", "TLS-Cert-Subject-Alt-Name-Dns" },
1579 { "TLS-Client-Cert-Subject-Alt-Name-Upn", "TLS-Cert-Subject-Alt-Name-Upn" }
1582 #define FR_TLS_SERIAL (0)
1583 #define FR_TLS_EXPIRATION (1)
1584 #define FR_TLS_SUBJECT (2)
1585 #define FR_TLS_ISSUER (3)
1586 #define FR_TLS_CN (4)
1587 #define FR_TLS_SAN_EMAIL (5)
1588 #define FR_TLS_SAN_DNS (6)
1589 #define FR_TLS_SAN_UPN (7)
1592 * Before trusting a certificate, you must make sure that the
1593 * certificate is 'valid'. There are several steps that your
1594 * application can take in determining if a certificate is
1595 * valid. Commonly used steps are:
1597 * 1.Verifying the certificate's signature, and verifying that
1598 * the certificate has been issued by a trusted Certificate
1601 * 2.Verifying that the certificate is valid for the present date
1602 * (i.e. it is being presented within its validity dates).
1604 * 3.Verifying that the certificate has not been revoked by its
1605 * issuing Certificate Authority, by checking with respect to a
1606 * Certificate Revocation List (CRL).
1608 * 4.Verifying that the credentials presented by the certificate
1609 * fulfill additional requirements specific to the application,
1610 * such as with respect to access control lists or with respect
1611 * to OCSP (Online Certificate Status Processing).
1613 * NOTE: This callback will be called multiple times based on the
1614 * depth of the root certificate chain
1616 int cbtls_verify(int ok, X509_STORE_CTX *ctx)
1618 char subject[1024]; /* Used for the subject name */
1619 char issuer[1024]; /* Used for the issuer name */
1620 char attribute[1024];
1622 char common_name[1024];
1626 X509_CINF *client_inf;
1627 STACK_OF(X509_EXTENSION) *ext_list;
1629 int err, depth, lookup, loc;
1630 fr_tls_server_conf_t *conf;
1633 ASN1_INTEGER *sn = NULL;
1634 ASN1_TIME *asn_time = NULL;
1637 #ifdef HAVE_OPENSSL_OCSP_H
1638 X509_STORE *ocsp_store = NULL;
1642 TALLOC_CTX *talloc_ctx;
1644 client_cert = X509_STORE_CTX_get_current_cert(ctx);
1645 err = X509_STORE_CTX_get_error(ctx);
1646 depth = X509_STORE_CTX_get_error_depth(ctx);
1651 * Log client/issuing cert. If there's an error, log
1654 if ((lookup > 1) && !my_ok) lookup = 1;
1657 * Retrieve the pointer to the SSL of the connection currently treated
1658 * and the application specific data stored into the SSL object.
1660 ssl = X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
1661 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_CONF);
1662 if (!conf) return 1;
1664 request = (REQUEST *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_REQUEST);
1665 rad_assert(request != NULL);
1666 certs = (VALUE_PAIR **)SSL_get_ex_data(ssl, fr_tls_ex_index_certs);
1668 identity = (char **)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_IDENTITY);
1669 #ifdef HAVE_OPENSSL_OCSP_H
1670 ocsp_store = (X509_STORE *)SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_STORE);
1673 talloc_ctx = SSL_get_ex_data(ssl, FR_TLS_EX_INDEX_TALLOC);
1676 * Get the Serial Number
1679 sn = X509_get_serialNumber(client_cert);
1681 RDEBUG2("TLS Verify adding attributes");
1685 * For this next bit, we create the attributes *only* if
1686 * we're at the client or issuing certificate, AND we
1687 * have a user identity. i.e. we don't create the
1688 * attributes for RadSec connections.
1690 if (certs && identity &&
1691 (lookup <= 1) && sn && ((size_t) sn->length < (sizeof(buf) / 2))) {
1695 for (i = 0; i < sn->length; i++) {
1696 sprintf(p, "%02x", (unsigned int)sn->data[i]);
1699 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_SERIAL][lookup], buf, T_OP_SET);
1700 rdebug_pair(L_DBG_LVL_2, request, vp);
1705 * Get the Expiration Date
1708 asn_time = X509_get_notAfter(client_cert);
1709 if (certs && identity && (lookup <= 1) && asn_time &&
1710 (asn_time->length < (int) sizeof(buf))) {
1711 memcpy(buf, (char*) asn_time->data, asn_time->length);
1712 buf[asn_time->length] = '\0';
1713 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_EXPIRATION][lookup], buf, T_OP_SET);
1714 rdebug_pair(L_DBG_LVL_2, request, vp);
1718 * Get the Subject & Issuer
1720 subject[0] = issuer[0] = '\0';
1721 X509_NAME_oneline(X509_get_subject_name(client_cert), subject,
1723 subject[sizeof(subject) - 1] = '\0';
1724 if (certs && identity && (lookup <= 1) && subject[0]) {
1725 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_SUBJECT][lookup], subject, T_OP_SET);
1726 rdebug_pair(L_DBG_LVL_2, request, vp);
1729 X509_NAME_oneline(X509_get_issuer_name(ctx->current_cert), issuer,
1731 issuer[sizeof(issuer) - 1] = '\0';
1732 if (certs && identity && (lookup <= 1) && issuer[0]) {
1733 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_ISSUER][lookup], issuer, T_OP_SET);
1734 rdebug_pair(L_DBG_LVL_2, request, vp);
1738 * Get the Common Name, if there is a subject.
1740 X509_NAME_get_text_by_NID(X509_get_subject_name(client_cert),
1741 NID_commonName, common_name, sizeof(common_name));
1742 common_name[sizeof(common_name) - 1] = '\0';
1743 if (certs && identity && (lookup <= 1) && common_name[0] && subject[0]) {
1744 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_CN][lookup], common_name, T_OP_SET);
1745 rdebug_pair(L_DBG_LVL_2, request, vp);
1749 * Get the RFC822 Subject Alternative Name
1751 loc = X509_get_ext_by_NID(client_cert, NID_subject_alt_name, 0);
1752 if (certs && (lookup <= 1) && (loc >= 0)) {
1753 X509_EXTENSION *ext = NULL;
1754 GENERAL_NAMES *names = NULL;
1757 if ((ext = X509_get_ext(client_cert, loc)) &&
1758 (names = X509V3_EXT_d2i(ext))) {
1759 for (i = 0; i < sk_GENERAL_NAME_num(names); i++) {
1760 GENERAL_NAME *name = sk_GENERAL_NAME_value(names, i);
1762 switch (name->type) {
1765 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_EMAIL][lookup],
1766 (char *) ASN1_STRING_data(name->d.rfc822Name), T_OP_SET);
1767 rdebug_pair(L_DBG_LVL_2, request, vp);
1769 #endif /* GEN_EMAIL */
1772 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_DNS][lookup],
1773 (char *) ASN1_STRING_data(name->d.dNSName), T_OP_SET);
1774 rdebug_pair(L_DBG_LVL_2, request, vp);
1776 #endif /* GEN_DNS */
1777 #ifdef GEN_OTHERNAME
1779 /* look for a MS UPN */
1780 if (NID_ms_upn == OBJ_obj2nid(name->d.otherName->type_id)) {
1781 /* we've got a UPN - Must be ASN1-encoded UTF8 string */
1782 if (name->d.otherName->value->type == V_ASN1_UTF8STRING) {
1783 vp = pairmake(talloc_ctx, certs, cert_attr_names[FR_TLS_SAN_UPN][lookup],
1784 (char *) ASN1_STRING_data(name->d.otherName->value->value.utf8string), T_OP_SET);
1785 rdebug_pair(L_DBG_LVL_2, request, vp);
1788 RWARN("Invalid UPN in Subject Alt Name (should be UTF-8)");
1793 #endif /* GEN_OTHERNAME */
1795 /* XXX TODO handle other SAN types */
1801 sk_GENERAL_NAME_free(names);
1805 * If the CRL has expired, that might still be OK.
1808 (conf->allow_expired_crl) &&
1809 (err == X509_V_ERR_CRL_HAS_EXPIRED)) {
1811 X509_STORE_CTX_set_error( ctx, 0 );
1815 char const *p = X509_verify_cert_error_string(err);
1816 RERROR("SSL says error %d : %s", err, p);
1822 client_inf = client_cert->cert_info;
1823 ext_list = client_inf->extensions;
1829 * Grab the X509 extensions, and create attributes out of them.
1830 * For laziness, we re-use the OpenSSL names
1832 if (sk_X509_EXTENSION_num(ext_list) > 0) {
1837 out = BIO_new(BIO_s_mem());
1838 strlcpy(attribute, "TLS-Client-Cert-", sizeof(attribute));
1840 for (i = 0; i < sk_X509_EXTENSION_num(ext_list); i++) {
1842 X509_EXTENSION *ext;
1844 ext = sk_X509_EXTENSION_value(ext_list, i);
1846 obj = X509_EXTENSION_get_object(ext);
1847 i2a_ASN1_OBJECT(out, obj);
1848 len = BIO_read(out, attribute + 16 , sizeof(attribute) - 16 - 1);
1849 if (len <= 0) continue;
1851 attribute[16 + len] = '\0';
1853 X509V3_EXT_print(out, ext, 0, 0);
1854 len = BIO_read(out, value , sizeof(value) - 1);
1855 if (len <= 0) continue;
1860 * Mash the OpenSSL name to our name, and
1861 * create the attribute.
1863 for (p = value + 16; *p != '\0'; p++) {
1864 if (*p == ' ') *p = '-';
1867 vp = pairmake(talloc_ctx, certs, attribute, value, T_OP_ADD);
1868 rdebug_pair_list(L_DBG_LVL_2, request, vp, NULL);
1876 switch (ctx->error) {
1877 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
1878 RERROR("issuer=%s", issuer);
1881 case X509_V_ERR_CERT_NOT_YET_VALID:
1882 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
1883 RERROR("notBefore=");
1885 ASN1_TIME_print(bio_err, X509_get_notBefore(ctx->current_cert));
1889 case X509_V_ERR_CERT_HAS_EXPIRED:
1890 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
1891 RERROR("notAfter=");
1893 ASN1_TIME_print(bio_err, X509_get_notAfter(ctx->current_cert));
1899 * If we're at the actual client cert, apply additional
1904 * If the conf tells us to, check cert issuer
1905 * against the specified value and fail
1906 * verification if they don't match.
1908 if (conf->check_cert_issuer &&
1909 (strcmp(issuer, conf->check_cert_issuer) != 0)) {
1910 AUTH("tls: Certificate issuer (%s) does not match specified value (%s)!", issuer, conf->check_cert_issuer);
1915 * If the conf tells us to, check the CN in the
1916 * cert against xlat'ed value, but only if the
1917 * previous checks passed.
1919 if (my_ok && conf->check_cert_cn) {
1920 if (radius_xlat(cn_str, sizeof(cn_str), request, conf->check_cert_cn, NULL, NULL) < 0) {
1921 /* if this fails, fail the verification */
1924 RDEBUG2("checking certificate CN (%s) with xlat'ed value (%s)", common_name, cn_str);
1925 if (strcmp(cn_str, common_name) != 0) {
1926 AUTH("tls: Certificate CN (%s) does not match specified value (%s)!", common_name, cn_str);
1930 } /* check_cert_cn */
1932 #ifdef HAVE_OPENSSL_OCSP_H
1933 if (my_ok && conf->ocsp_enable){
1934 RDEBUG2("--> Starting OCSP Request");
1935 if (X509_STORE_CTX_get1_issuer(&issuer_cert, ctx, client_cert) != 1) {
1936 RERROR("Couldn't get issuer_cert for %s", common_name);
1938 my_ok = ocsp_check(ocsp_store, issuer_cert, client_cert, conf);
1943 while (conf->verify_client_cert_cmd) {
1948 snprintf(filename, sizeof(filename), "%s/%s.client.XXXXXXXX",
1949 conf->verify_tmp_dir, progname);
1950 fd = mkstemp(filename);
1952 RDEBUG("Failed creating file in %s: %s",
1953 conf->verify_tmp_dir, fr_syserror(errno));
1957 fp = fdopen(fd, "w");
1960 RDEBUG("Failed opening file %s: %s",
1961 filename, fr_syserror(errno));
1965 if (!PEM_write_X509(fp, client_cert)) {
1967 RDEBUG("Failed writing certificate to file");
1972 if (!pairmake_packet("TLS-Client-Cert-Filename",
1973 filename, T_OP_SET)) {
1974 RDEBUG("Failed creating TLS-Client-Cert-Filename");
1979 RDEBUG("Verifying client certificate: %s", conf->verify_client_cert_cmd);
1980 if (radius_exec_program(NULL, 0, NULL, request, conf->verify_client_cert_cmd,
1981 request->packet->vps,
1982 true, true, EXEC_TIMEOUT) != 0) {
1983 AUTH("tls: Certificate CN (%s) fails external verification!", common_name);
1986 RDEBUG("Client certificate CN %s passed external validation", common_name);
1997 if (debug_flag > 0) {
1998 RDEBUG2("chain-depth=%d, ", depth);
1999 RDEBUG2("error=%d", err);
2001 if (identity) RDEBUG2("--> User-Name = %s", *identity);
2002 RDEBUG2("--> BUF-Name = %s", common_name);
2003 RDEBUG2("--> subject = %s", subject);
2004 RDEBUG2("--> issuer = %s", issuer);
2005 RDEBUG2("--> verify return:%d", my_ok);
2011 #ifdef HAVE_OPENSSL_OCSP_H
2013 * Create Global X509 revocation store and use it to verify
2016 * - Load the trusted CAs
2017 * - Load the trusted issuer certificates
2019 static X509_STORE *init_revocation_store(fr_tls_server_conf_t *conf)
2021 X509_STORE *store = NULL;
2023 store = X509_STORE_new();
2025 /* Load the CAs we trust */
2026 if (conf->ca_file || conf->ca_path)
2027 if(!X509_STORE_load_locations(store, conf->ca_file, conf->ca_path)) {
2028 ERROR("tls: X509_STORE error %s", ERR_error_string(ERR_get_error(), NULL));
2029 ERROR("tls: Error reading Trusted root CA list %s",conf->ca_file );
2033 #ifdef X509_V_FLAG_CRL_CHECK
2034 if (conf->check_crl)
2035 X509_STORE_set_flags(store, X509_V_FLAG_CRL_CHECK);
2039 #endif /* HAVE_OPENSSL_OCSP_H */
2041 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
2042 #ifndef OPENSSL_NO_ECDH
2043 static int set_ecdh_curve(SSL_CTX *ctx, char const *ecdh_curve)
2048 if (!ecdh_curve || !*ecdh_curve) return 0;
2050 nid = OBJ_sn2nid(ecdh_curve);
2052 ERROR("Unknown ecdh_curve \"%s\"", ecdh_curve);
2056 ecdh = EC_KEY_new_by_curve_name(nid);
2058 ERROR("Unable to create new curve \"%s\"", ecdh_curve);
2062 SSL_CTX_set_tmp_ecdh(ctx, ecdh);
2064 SSL_CTX_set_options(ctx, SSL_OP_SINGLE_ECDH_USE);
2074 * DIE OPENSSL DIE DIE DIE
2076 * What a palaver, just to free some data attached the
2077 * session. We need to do this because the "remove" callback
2078 * is called when refcount > 0 sometimes, if another thread
2079 * is using the session
2081 static void sess_free_vps(UNUSED void *parent, void *data_ptr,
2082 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
2083 UNUSED long argl, UNUSED void *argp)
2085 VALUE_PAIR *vp = data_ptr;
2088 DEBUG2(" Freeing cached session VPs");;
2093 static void sess_free_certs(UNUSED void *parent, void *data_ptr,
2094 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
2095 UNUSED long argl, UNUSED void *argp)
2097 VALUE_PAIR **certs = data_ptr;
2100 DEBUG2(" Freeing cached session Certificates");
2105 /** Add all the default ciphers and message digests reate our context.
2107 * This should be called exactly once from main, before reading the main config
2108 * or initialising any modules.
2110 void tls_global_init(void)
2112 SSL_load_error_strings(); /* readable error messages (examples show call before library_init) */
2113 SSL_library_init(); /* initialize library */
2114 OpenSSL_add_all_algorithms(); /* required for SHA2 in OpenSSL < 0.9.8o and 1.0.0.a */
2115 OPENSSL_config(NULL);
2118 #ifdef ENABLE_OPENSSL_VERSION_CHECK
2119 /** Check for vulnerable versions of libssl
2121 * @param acknowledged The highest CVE number a user has confirmed is not present in the system's libssl.
2122 * @return 0 if the CVE specified by the user matches the most recent CVE we have, else -1.
2124 int tls_global_version_check(char const *acknowledged)
2128 if ((strcmp(acknowledged, libssl_defects[0].id) != 0) && (strcmp(acknowledged, "yes") != 0)) {
2132 /* Check for bad versions */
2133 v = (uint64_t) SSLeay();
2135 for (i = 0; i < (sizeof(libssl_defects) / sizeof(*libssl_defects)); i++) {
2136 libssl_defect_t *defect = &libssl_defects[i];
2138 if ((v >= defect->low) && (v <= defect->high)) {
2139 ERROR("Refusing to start with libssl version %s (in range %s)",
2140 ssl_version(), ssl_version_range(defect->low, defect->high));
2141 ERROR("Security advisory %s (%s)", defect->id, defect->name);
2142 ERROR("%s", defect->comment);
2149 INFO("Once you have verified libssl has been correctly patched, "
2150 "set security.allow_vulnerable_openssl = '%s'", libssl_defects[0].id);
2159 /** Free any memory alloced by libssl
2162 void tls_global_cleanup(void)
2164 ERR_remove_state(0);
2166 CONF_modules_unload(1);
2169 CRYPTO_cleanup_all_ex_data();
2173 * Create SSL context
2175 * - Load the trusted CAs
2176 * - Load the Private key & the certificate
2177 * - Set the Context options & Verify options
2179 SSL_CTX *tls_init_ctx(fr_tls_server_conf_t *conf, int client)
2182 X509_STORE *certstore;
2183 int verify_mode = SSL_VERIFY_NONE;
2184 int ctx_options = 0;
2188 * SHA256 is in all versions of OpenSSL, but isn't
2189 * initialized by default. It's needed for WiMAX
2192 #ifdef HAVE_OPENSSL_EVP_SHA256
2193 EVP_add_digest(EVP_sha256());
2196 ctx = SSL_CTX_new(SSLv23_method()); /* which is really "all known SSL / TLS methods". Idiots. */
2199 while ((err = ERR_get_error())) {
2200 DEBUG("Failed creating SSL context: %s",
2201 ERR_error_string(err, NULL));
2207 * Save the config on the context so that callbacks which
2208 * only get SSL_CTX* e.g. session persistence, can get it
2210 SSL_CTX_set_app_data(ctx, conf);
2213 * Identify the type of certificates that needs to be loaded
2215 if (conf->file_type) {
2216 type = SSL_FILETYPE_PEM;
2218 type = SSL_FILETYPE_ASN1;
2222 * Set the password to load private key
2224 if (conf->private_key_password) {
2227 * We don't want to put the private key password in eap.conf, so check
2228 * for our special string which indicates we should get the password
2231 char const* special_string = "Apple:UseCertAdmin";
2232 if (strncmp(conf->private_key_password, special_string, strlen(special_string)) == 0) {
2235 long const max_password_len = 128;
2236 snprintf(cmd, sizeof(cmd) - 1, "/usr/sbin/certadmin --get-private-key-passphrase \"%s\"",
2237 conf->private_key_file);
2239 DEBUG2("tls: Getting private key passphrase using command \"%s\"", cmd);
2241 FILE* cmd_pipe = popen(cmd, "r");
2243 ERROR("TLS: %s command failed. Unable to get private_key_password", cmd);
2244 ERROR("Error reading private_key_file %s", conf->private_key_file);
2248 rad_const_free(conf->private_key_password);
2249 password = talloc_array(conf, char, max_password_len);
2251 ERROR("TLS: Can't allocate space for private_key_password");
2252 ERROR("TLS: Error reading private_key_file %s", conf->private_key_file);
2257 fgets(password, max_password_len, cmd_pipe);
2260 /* Get rid of newline at end of password. */
2261 password[strlen(password) - 1] = '\0';
2263 DEBUG3("tls: Password from command = \"%s\"", password);
2264 conf->private_key_password = password;
2271 memcpy(&password, &conf->private_key_password, sizeof(password));
2272 SSL_CTX_set_default_passwd_cb_userdata(ctx, password);
2273 SSL_CTX_set_default_passwd_cb(ctx, cbtls_password);
2277 #ifdef PSK_MAX_IDENTITY_LEN
2280 * No dynamic query exists. There MUST be a
2281 * statically configured identity and password.
2283 if (conf->psk_query && !*conf->psk_query) {
2284 ERROR("Invalid PSK Configuration: psk_query cannot be empty");
2289 * Set the callback only if we can check things.
2291 if (conf->psk_identity || conf->psk_query) {
2292 SSL_CTX_set_psk_server_callback(ctx, psk_server_callback);
2295 } else if (conf->psk_query) {
2296 ERROR("Invalid PSK Configuration: psk_query cannot be used for outgoing connections");
2301 * Now check that if PSK is being used, the config is valid.
2303 if ((conf->psk_identity && !conf->psk_password) ||
2304 (!conf->psk_identity && conf->psk_password) ||
2305 (conf->psk_identity && !*conf->psk_identity) ||
2306 (conf->psk_password && !*conf->psk_password)) {
2307 ERROR("Invalid PSK Configuration: psk_identity or psk_password are empty");
2311 if (conf->psk_identity) {
2312 size_t psk_len, hex_len;
2313 uint8_t buffer[PSK_MAX_PSK_LEN];
2315 if (conf->certificate_file ||
2316 conf->private_key_password || conf->private_key_file ||
2317 conf->ca_file || conf->ca_path) {
2318 ERROR("When PSKs are used, No certificate configuration is permitted");
2323 SSL_CTX_set_psk_client_callback(ctx,
2324 psk_client_callback);
2327 psk_len = strlen(conf->psk_password);
2328 if (strlen(conf->psk_password) > (2 * PSK_MAX_PSK_LEN)) {
2329 ERROR("psk_hexphrase is too long (max %d)",
2335 * Check the password now, so that we don't have
2336 * errors at run-time.
2338 hex_len = fr_hex2bin(buffer, sizeof(buffer), conf->psk_password, psk_len);
2339 if (psk_len != (2 * hex_len)) {
2340 ERROR("psk_hexphrase is not all hex");
2347 (void) client; /* -Wunused */
2351 * Load our keys and certificates
2353 * If certificates are of type PEM then we can make use
2354 * of cert chain authentication using openssl api call
2355 * SSL_CTX_use_certificate_chain_file. Please see how
2356 * the cert chain needs to be given in PEM from
2359 if (!conf->certificate_file) goto load_ca;
2361 if (type == SSL_FILETYPE_PEM) {
2362 if (!(SSL_CTX_use_certificate_chain_file(ctx, conf->certificate_file))) {
2363 ERROR("Error reading certificate file %s:%s",
2364 conf->certificate_file,
2365 ERR_error_string(ERR_get_error(), NULL));
2369 } else if (!(SSL_CTX_use_certificate_file(ctx, conf->certificate_file, type))) {
2370 ERROR("Error reading certificate file %s:%s",
2371 conf->certificate_file,
2372 ERR_error_string(ERR_get_error(), NULL));
2376 /* Load the CAs we trust */
2378 if (conf->ca_file || conf->ca_path) {
2379 if (!SSL_CTX_load_verify_locations(ctx, conf->ca_file, conf->ca_path)) {
2380 ERROR("tls: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2381 ERROR("tls: Error reading Trusted root CA list %s",conf->ca_file );
2385 if (conf->ca_file && *conf->ca_file) SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(conf->ca_file));
2387 if (conf->private_key_file) {
2388 if (!(SSL_CTX_use_PrivateKey_file(ctx, conf->private_key_file, type))) {
2389 ERROR("Failed reading private key file %s:%s",
2390 conf->private_key_file,
2391 ERR_error_string(ERR_get_error(), NULL));
2396 * Check if the loaded private key is the right one
2398 if (!SSL_CTX_check_private_key(ctx)) {
2399 ERROR("Private key does not match the certificate public key");
2404 #ifdef PSK_MAX_IDENTITY_LEN
2409 * We never want SSLv2 or SSLv3.
2411 ctx_options |= SSL_OP_NO_SSLv2;
2412 ctx_options |= SSL_OP_NO_SSLv3;
2415 * As of 3.0.5, we always allow TLSv1.1 and TLSv1.2.
2416 * Though they can be *globally* disabled if necessary.x
2418 #ifdef SSL_OP_NO_TLSv1_1
2419 if (conf->disable_tlsv1_1) ctx_options |= SSL_OP_NO_TLSv1_1;
2421 #ifdef SSL_OP_NO_TLSv1_2
2422 if (conf->disable_tlsv1_2) ctx_options |= SSL_OP_NO_TLSv1_2;
2425 #ifdef SSL_OP_NO_TICKET
2426 ctx_options |= SSL_OP_NO_TICKET ;
2430 * SSL_OP_SINGLE_DH_USE must be used in order to prevent
2431 * small subgroup attacks and forward secrecy. Always
2434 * SSL_OP_SINGLE_DH_USE has an impact on the computer
2435 * time needed during negotiation, but it is not very
2438 ctx_options |= SSL_OP_SINGLE_DH_USE;
2441 * SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS to work around issues
2442 * in Windows Vista client.
2443 * http://www.openssl.org/~bodo/tls-cbc.txt
2444 * http://www.nabble.com/(RADIATOR)-Radiator-Version-3.16-released-t2600070.html
2446 ctx_options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
2448 SSL_CTX_set_options(ctx, ctx_options);
2451 * TODO: Set the RSA & DH
2452 * SSL_CTX_set_tmp_rsa_callback(ctx, cbtls_rsa);
2453 * SSL_CTX_set_tmp_dh_callback(ctx, cbtls_dh);
2457 * set the message callback to identify the type of
2458 * message. For every new session, there can be a
2459 * different callback argument.
2461 * SSL_CTX_set_msg_callback(ctx, cbtls_msg);
2465 * Set eliptical curve crypto configuration.
2467 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
2468 #ifndef OPENSSL_NO_ECDH
2469 if (set_ecdh_curve(ctx, conf->ecdh_curve) < 0) {
2475 /* Set Info callback */
2476 SSL_CTX_set_info_callback(ctx, cbtls_info);
2479 * Callbacks, etc. for session resumption.
2481 if (conf->session_cache_enable) {
2482 SSL_CTX_sess_set_new_cb(ctx, cbtls_new_session);
2483 SSL_CTX_sess_set_get_cb(ctx, cbtls_get_session);
2484 SSL_CTX_sess_set_remove_cb(ctx, cbtls_remove_session);
2486 SSL_CTX_set_quiet_shutdown(ctx, 1);
2487 if (fr_tls_ex_index_vps < 0)
2488 fr_tls_ex_index_vps = SSL_SESSION_get_ex_new_index(0, NULL, NULL, NULL, sess_free_vps);
2489 if (fr_tls_ex_index_certs < 0)
2490 fr_tls_ex_index_certs = SSL_SESSION_get_ex_new_index(0, NULL, NULL, NULL, sess_free_certs);
2494 * Check the certificates for revocation.
2496 #ifdef X509_V_FLAG_CRL_CHECK
2497 if (conf->check_crl) {
2498 certstore = SSL_CTX_get_cert_store(ctx);
2499 if (certstore == NULL) {
2500 ERROR("tls: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2501 ERROR("tls: Error reading Certificate Store");
2504 X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK);
2510 * Always verify the peer certificate
2512 verify_mode |= SSL_VERIFY_PEER;
2513 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
2514 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
2515 SSL_CTX_set_verify(ctx, verify_mode, cbtls_verify);
2517 if (conf->verify_depth) {
2518 SSL_CTX_set_verify_depth(ctx, conf->verify_depth);
2521 /* Load randomness */
2522 if (conf->random_file) {
2523 if (!(RAND_load_file(conf->random_file, 1024*10))) {
2524 ERROR("tls: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
2525 ERROR("tls: Error loading randomness");
2531 * Set the cipher list if we were told to
2533 if (conf->cipher_list) {
2534 if (!SSL_CTX_set_cipher_list(ctx, conf->cipher_list)) {
2535 ERROR("tls: Error setting cipher list");
2541 * Setup session caching
2543 if (conf->session_cache_enable) {
2545 * Create a unique context Id per EAP-TLS configuration.
2547 if (conf->session_id_name) {
2548 snprintf(conf->session_context_id,
2549 sizeof(conf->session_context_id),
2551 conf->session_id_name);
2553 snprintf(conf->session_context_id,
2554 sizeof(conf->session_context_id),
2559 * Cache it, and DON'T auto-clear it.
2561 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_SERVER | SSL_SESS_CACHE_NO_AUTO_CLEAR);
2563 SSL_CTX_set_session_id_context(ctx,
2564 (unsigned char *) conf->session_context_id,
2565 (unsigned int) strlen(conf->session_context_id));
2568 * Our timeout is in hours, this is in seconds.
2570 SSL_CTX_set_timeout(ctx, conf->session_timeout * 3600);
2573 * Set the maximum number of entries in the
2576 SSL_CTX_sess_set_cache_size(ctx, conf->session_cache_size);
2579 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
2587 * Free TLS client/server config
2588 * Should not be called outside this code, as a callback is
2589 * added to automatically free the data when the CONF_SECTION
2592 static int _tls_server_conf_free(fr_tls_server_conf_t *conf)
2594 if (conf->ctx) SSL_CTX_free(conf->ctx);
2596 #ifdef HAVE_OPENSSL_OCSP_H
2597 if (conf->ocsp_store) X509_STORE_free(conf->ocsp_store);
2598 conf->ocsp_store = NULL;
2602 memset(conf, 0, sizeof(*conf));
2607 static fr_tls_server_conf_t *tls_server_conf_alloc(TALLOC_CTX *ctx)
2609 fr_tls_server_conf_t *conf;
2611 conf = talloc_zero(ctx, fr_tls_server_conf_t);
2613 ERROR("Out of memory");
2617 talloc_set_destructor(conf, _tls_server_conf_free);
2623 fr_tls_server_conf_t *tls_server_conf_parse(CONF_SECTION *cs)
2625 fr_tls_server_conf_t *conf;
2628 * If cs has already been parsed there should be a cached copy
2629 * of conf already stored, so just return that.
2631 conf = cf_data_find(cs, "tls-conf");
2633 DEBUG("Using cached TLS configuration from previous invocation");
2637 conf = tls_server_conf_alloc(cs);
2639 if (cf_section_parse(cs, conf, tls_server_config) < 0) {
2646 * Save people from their own stupidity.
2648 if (conf->fragment_size < 100) conf->fragment_size = 100;
2650 if (!conf->private_key_file) {
2651 ERROR("TLS Server requires a private key file");
2655 if (!conf->certificate_file) {
2656 ERROR("TLS Server requires a certificate file");
2663 conf->ctx = tls_init_ctx(conf, 0);
2664 if (conf->ctx == NULL) {
2668 #ifdef HAVE_OPENSSL_OCSP_H
2670 * Initialize OCSP Revocation Store
2672 if (conf->ocsp_enable) {
2673 conf->ocsp_store = init_revocation_store(conf);
2674 if (conf->ocsp_store == NULL) goto error;
2676 #endif /*HAVE_OPENSSL_OCSP_H*/
2680 memcpy(&dh_file, &conf->dh_file, sizeof(dh_file));
2681 if (load_dh_params(conf->ctx, dh_file) < 0) {
2686 if (generate_eph_rsa_key(conf->ctx) < 0) {
2690 if (conf->verify_tmp_dir) {
2691 if (chmod(conf->verify_tmp_dir, S_IRWXU) < 0) {
2692 ERROR("Failed changing permissions on %s: %s", conf->verify_tmp_dir, fr_syserror(errno));
2697 if (conf->verify_client_cert_cmd && !conf->verify_tmp_dir) {
2698 ERROR("You MUST set the verify directory in order to use verify_client_cmd");
2703 * Cache conf in cs in case we're asked to parse this again.
2705 cf_data_add(cs, "tls-conf", conf, NULL);
2710 fr_tls_server_conf_t *tls_client_conf_parse(CONF_SECTION *cs)
2712 fr_tls_server_conf_t *conf;
2714 conf = cf_data_find(cs, "tls-conf");
2716 DEBUG("Using cached TLS configuration from previous invocation");
2720 conf = tls_server_conf_alloc(cs);
2722 if (cf_section_parse(cs, conf, tls_client_config) < 0) {
2729 * Save people from their own stupidity.
2731 if (conf->fragment_size < 100) conf->fragment_size = 100;
2736 conf->ctx = tls_init_ctx(conf, 1);
2737 if (conf->ctx == NULL) {
2744 memcpy(&dh_file, &conf->dh_file, sizeof(dh_file));
2745 if (load_dh_params(conf->ctx, dh_file) < 0) {
2750 if (generate_eph_rsa_key(conf->ctx) < 0) {
2754 cf_data_add(cs, "tls-conf", conf, NULL);
2759 int tls_success(tls_session_t *ssn, REQUEST *request)
2761 VALUE_PAIR *vp, *vps = NULL;
2762 fr_tls_server_conf_t *conf;
2763 TALLOC_CTX *talloc_ctx;
2765 conf = (fr_tls_server_conf_t *)SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF);
2766 rad_assert(conf != NULL);
2768 talloc_ctx = SSL_get_ex_data(ssn->ssl, FR_TLS_EX_INDEX_TALLOC);
2771 * If there's no session resumption, delete the entry
2772 * from the cache. This means either it's disabled
2773 * globally for this SSL context, OR we were told to
2774 * disable it for this user.
2776 * This also means you can't turn it on just for one
2779 if ((!ssn->allow_session_resumption) ||
2780 (((vp = pairfind(request->config_items, 1127, 0, TAG_ANY)) != NULL) &&
2781 (vp->vp_integer == 0))) {
2782 SSL_CTX_remove_session(ssn->ctx,
2784 ssn->allow_session_resumption = 0;
2787 * If we're in a resumed session and it's
2790 if (SSL_session_reused(ssn->ssl)) {
2791 RDEBUG("FAIL: Forcibly stopping session resumption as it is not allowed");
2796 * Else resumption IS allowed, so we store the
2797 * user data in the cache.
2799 } else if (!SSL_session_reused(ssn->ssl)) {
2802 char buffer[2 * MAX_SESSION_SIZE + 1];
2804 size = ssn->ssl->session->session_id_length;
2805 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
2807 fr_bin2hex(buffer, ssn->ssl->session->session_id, size);
2809 vp = paircopy_by_num(talloc_ctx, request->reply->vps, PW_USER_NAME, 0, TAG_ANY);
2810 if (vp) pairadd(&vps, vp);
2812 vp = paircopy_by_num(talloc_ctx, request->packet->vps, PW_STRIPPED_USER_NAME, 0, TAG_ANY);
2813 if (vp) pairadd(&vps, vp);
2815 vp = paircopy_by_num(talloc_ctx, request->reply->vps, PW_CHARGEABLE_USER_IDENTITY, 0, TAG_ANY);
2816 if (vp) pairadd(&vps, vp);
2818 vp = paircopy_by_num(talloc_ctx, request->reply->vps, PW_CACHED_SESSION_POLICY, 0, TAG_ANY);
2819 if (vp) pairadd(&vps, vp);
2821 certs = (VALUE_PAIR **)SSL_get_ex_data(ssn->ssl, fr_tls_ex_index_certs);
2824 * Hmm... the certs should probably be session data.
2828 * @todo: some go into reply, others into
2831 pairadd(&vps, paircopy(talloc_ctx, *certs));
2835 RDEBUG2("Saving session %s vps %p in the cache", buffer, vps);
2836 SSL_SESSION_set_ex_data(ssn->ssl->session,
2837 fr_tls_ex_index_vps, vps);
2838 if (conf->session_cache_path) {
2839 /* write the VPs to the cache file */
2840 char filename[256], buf[1024];
2843 snprintf(filename, sizeof(filename), "%s%c%s.vps",
2844 conf->session_cache_path, FR_DIR_SEP, buffer
2846 vp_file = fopen(filename, "w");
2847 if (vp_file == NULL) {
2848 RDEBUG2("Could not write session VPs to persistent cache: %s", fr_syserror(errno));
2851 /* generate a dummy user-style entry which is easy to read back */
2852 fprintf(vp_file, "# SSL cached session\n");
2853 fprintf(vp_file, "%s\n", buffer);
2854 for (vp = fr_cursor_init(&cursor, &vps);
2856 vp = fr_cursor_next(&cursor)) {
2857 vp_prints(buf, sizeof(buf), vp);
2858 fprintf(vp_file, "\t%s,\n", buf);
2864 RDEBUG2("No information to cache: session caching will be disabled for session %s", buffer);
2865 SSL_CTX_remove_session(ssn->ctx,
2870 * Else the session WAS allowed. Copy the cached
2875 char buffer[2 * MAX_SESSION_SIZE + 1];
2877 size = ssn->ssl->session->session_id_length;
2878 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
2880 fr_bin2hex(buffer, ssn->ssl->session->session_id, size);
2882 vps = SSL_SESSION_get_ex_data(ssn->ssl->session,
2883 fr_tls_ex_index_vps);
2885 RWDEBUG("No information in cached session %s", buffer);
2891 RDEBUG("Adding cached attributes for session %s:", buffer);
2892 rdebug_pair_list(L_DBG_LVL_1, request, vps, NULL);
2893 for (vp = fr_cursor_init(&cursor, &vps);
2895 vp = fr_cursor_next(&cursor)) {
2897 * TLS-* attrs get added back to
2900 if ((vp->da->vendor == 0) &&
2901 (vp->da->attr >= 1910) &&
2902 (vp->da->attr < 1929)) {
2903 pairadd(&request->packet->vps,
2904 paircopyvp(request->packet, vp));
2906 pairadd(&request->reply->vps,
2907 paircopyvp(request->reply, vp));
2911 if (conf->session_cache_path) {
2912 /* "touch" the cached session/vp file */
2915 snprintf(filename, sizeof(filename), "%s%c%s.asn1",
2916 conf->session_cache_path, FR_DIR_SEP, buffer
2918 utime(filename, NULL);
2919 snprintf(filename, sizeof(filename), "%s%c%s.vps",
2920 conf->session_cache_path, FR_DIR_SEP, buffer
2922 utime(filename, NULL);
2926 * Mark the request as resumed.
2928 pairmake_packet("EAP-Session-Resumed", "1", T_OP_SET);
2936 void tls_fail(tls_session_t *ssn)
2939 * Force the session to NOT be cached.
2941 SSL_CTX_remove_session(ssn->ctx, ssn->ssl->session);
2944 fr_tls_status_t tls_application_data(tls_session_t *ssn,
2951 * Decrypt the complete record.
2953 err = BIO_write(ssn->into_ssl, ssn->dirty_in.data,
2954 ssn->dirty_in.used);
2955 if (err != (int) ssn->dirty_in.used) {
2956 record_init(&ssn->dirty_in);
2957 RDEBUG("Failed writing %d to SSL BIO: %d",
2958 ssn->dirty_in.used, err);
2963 * Clear the dirty buffer now that we are done with it
2964 * and init the clean_out buffer to store decrypted data
2966 record_init(&ssn->dirty_in);
2967 record_init(&ssn->clean_out);
2970 * Read (and decrypt) the tunneled data from the
2971 * SSL session, and put it into the decrypted
2974 err = SSL_read(ssn->ssl, ssn->clean_out.data,
2975 sizeof(ssn->clean_out.data));
2980 RDEBUG("SSL_read Error");
2982 code = SSL_get_error(ssn->ssl, err);
2984 case SSL_ERROR_WANT_READ:
2985 DEBUG("Error in fragmentation logic: SSL_WANT_READ");
2986 return FR_TLS_MORE_FRAGMENTS;
2988 case SSL_ERROR_WANT_WRITE:
2989 DEBUG("Error in fragmentation logic: SSL_WANT_WRITE");
2993 DEBUG("Error in fragmentation logic: %s",
2994 ERR_error_string(code, NULL));
2997 * FIXME: Call int_ssl_check?
3005 RWDEBUG("No data inside of the tunnel");
3009 * Passed all checks, successfully decrypted data
3011 ssn->clean_out.used = err;
3018 * Acknowledge received is for one of the following messages sent earlier
3019 * 1. Handshake completed Message, so now send, EAP-Success
3020 * 2. Alert Message, now send, EAP-Failure
3021 * 3. Fragment Message, now send, next Fragment
3023 fr_tls_status_t tls_ack_handler(tls_session_t *ssn, REQUEST *request)
3025 RDEBUG2("Received TLS ACK");
3028 RERROR("FAIL: Unexpected ACK received. Could not obtain session information");
3029 return FR_TLS_INVALID;
3031 if (ssn->info.initialized == 0) {
3032 RDEBUG("No SSL info available. Waiting for more SSL data");
3033 return FR_TLS_REQUEST;
3035 if ((ssn->info.content_type == handshake) &&
3036 (ssn->info.origin == 0)) {
3037 RERROR("FAIL: ACK without earlier message");
3038 return FR_TLS_INVALID;
3041 switch (ssn->info.content_type) {
3043 RDEBUG2("ACK alert");
3047 if ((ssn->info.handshake_type == handshake_finished) &&
3048 (ssn->dirty_out.used == 0)) {
3049 RDEBUG2("ACK handshake is finished");
3052 * From now on all the content is
3053 * application data set it here as nobody else
3056 ssn->info.content_type = application_data;
3057 return FR_TLS_SUCCESS;
3058 } /* else more data to send */
3060 RDEBUG2("ACK handshake fragment handler");
3061 /* Fragmentation handler, send next fragment */
3062 return FR_TLS_REQUEST;
3064 case application_data:
3065 RDEBUG2("ACK handshake fragment handler in application data");
3066 return FR_TLS_REQUEST;
3069 * For the rest of the conditions, switch over
3070 * to the default section below.
3073 RDEBUG2("ACK default");
3074 RERROR("Invalid ACK received: %d",
3075 ssn->info.content_type);
3076 return FR_TLS_INVALID;
3080 #endif /* WITH_TLS */