26RCSID(
"$Id: 410b0c3752d6eb455a8d32901adebaf85aeea9cd $")
30#define LOG_PREFIX "tls"
33#include <freeradius-devel/internal/internal.h>
34#include <freeradius-devel/server/pair.h>
35#include <freeradius-devel/unlang/function.h>
36#include <freeradius-devel/unlang/subrequest.h>
37#include <freeradius-devel/util/debug.h>
39#include <freeradius-devel/protocol/tls/freeradius.h>
48#include <openssl/ssl.h>
49#include <openssl/kdf.h>
57 fr_tls_session_t *tls_session = talloc_get_type_abort(uctx, fr_tls_session_t);
60 fr_assert((tls_session->ticket == FR_TLS_TICKET_STATELESS_ENCODE_REQUESTED) ||
61 (tls_session->ticket == FR_TLS_TICKET_STATELESS_DECODE_REQUESTED));
65 tls_session->ticket = FR_TLS_TICKET_STATELESS_FAILED;
69 tls_session->ticket = FR_TLS_TICKET_STATELESS_SUCCESS;
86 fr_tls_conf_t *
conf = tls_session->conf;
92 MEM(child = tls_subrequest_alloc(
request, packet_type, &tls_session->session_id));
94 fr_tls_session_extra_pairs_copy_to_child(child, tls_session);
96 ua = fr_tls_call_push(child, tls_ticket_stateless_resume,
conf, tls_session,
false);
98 REDEBUG(
"(TLS) Failed calling TLS virtual server");
117 switch (tls_session->ticket) {
118 case FR_TLS_TICKET_STATELESS_ENCODE_REQUESTED:
119 return tls_ticket_stateless_push(
request, tls_session,
122 case FR_TLS_TICKET_STATELESS_DECODE_REQUESTED:
123 return tls_ticket_stateless_push(
request, tls_session,
133static inline CC_HINT(always_inline)
void tls_ticket_stateless_encode_request(fr_tls_session_t *tls_session)
135 tls_session->ticket = FR_TLS_TICKET_STATELESS_ENCODE_REQUESTED;
136 TLS_PENDING_SET(tls_session, FR_TLS_PENDING_STATELESS_TICKET);
141static inline CC_HINT(always_inline)
void tls_ticket_stateless_decode_request(fr_tls_session_t *tls_session)
143 tls_session->ticket = FR_TLS_TICKET_STATELESS_DECODE_REQUESTED;
144 TLS_PENDING_SET(tls_session, FR_TLS_PENDING_STATELESS_TICKET);
163static inline CC_HINT(always_inline)
164bool tls_ticket_stateless_section_run(
request_t *
request, fr_tls_session_t *tls_session,
172 if (
unlikely(!tls_session->can_pause)) {
174 "tls_session_async_handshake_cont must be in call stack", __FUNCTION__);
175 tls_session->ticket = FR_TLS_TICKET_STATELESS_INIT;
186 tls_session->ticket = FR_TLS_TICKET_STATELESS_INIT;
190 if (tls_session->ticket != FR_TLS_TICKET_STATELESS_SUCCESS) {
191 REDEBUG(
"(TLS) `%s` did not return success",
name);
192 fr_tls_session_error_add(
request, error);
193 tls_session->ticket = FR_TLS_TICKET_STATELESS_INIT;
197 tls_session->ticket = FR_TLS_TICKET_STATELESS_INIT;
210static bool tls_ticket_stateless_encode_run(
request_t *
request, fr_tls_session_t *tls_session)
212 fr_assert(tls_session->ticket == FR_TLS_TICKET_STATELESS_INIT);
214 tls_ticket_stateless_encode_request(tls_session);
216 return tls_ticket_stateless_section_run(
request, tls_session,
"encode session",
217 FR_ERROR_VALUE_ENCODE_SESSION_FAILED);
228static bool tls_ticket_stateless_decode_run(
request_t *
request, fr_tls_session_t *tls_session)
230 fr_assert(tls_session->ticket == FR_TLS_TICKET_STATELESS_INIT);
232 tls_ticket_stateless_decode_request(tls_session);
234 return tls_ticket_stateless_section_run(
request, tls_session,
"decode session",
235 FR_ERROR_VALUE_DECODE_SESSION_FAILED);
251 tls_session->ticket = FR_TLS_TICKET_STATELESS_ENCODE_REQUESTED;
259 fr_tls_session_t *tls_session;
262} tls_ticket_stateless_issue_t;
280 tls_ticket_stateless_issue_t *issue = talloc_get_type_abort(uctx, tls_ticket_stateless_issue_t);
281 fr_tls_session_t *tls_session = issue->tls_session;
282 fr_tls_conf_t *
conf = tls_session->conf;
286 switch (tls_session->ticket) {
287 case FR_TLS_TICKET_STATELESS_INIT:
288 if (!
conf->encode_session)
break;
294 switch (tls_ticket_stateless_encode_push(
request, tls_session)) {
300 tls_session->ticket = FR_TLS_TICKET_STATELESS_INIT;
304 case FR_TLS_TICKET_STATELESS_SUCCESS:
306 tls_session->ticket = FR_TLS_TICKET_STATELESS_INIT;
311 tls_session->ticket = FR_TLS_TICKET_STATELESS_INIT;
312 REDEBUG(
"(TLS) `encode session` did not return success");
313 fr_tls_session_error_add(
request, FR_ERROR_VALUE_ENCODE_SESSION_FAILED);
319 sess = SSL_get_session(tls_session->ssl);
321 REDEBUG(
"(TLS) Failed retrieving session when creating a session ticket");
325 ret = tls_ticket_app_data_set(
request, sess, &tls_session->session_id);
327 REDEBUG(
"(TLS) Not creating a session ticket");
331 tls_session->app_data_ready =
true;
335 if (issue->resume)
return issue->resume(p_result,
request, issue->uctx);
353 tls_ticket_stateless_issue_t *issue;
355 MEM(issue = talloc_zero(
request, tls_ticket_stateless_issue_t));
356 issue->tls_session = tls_session;
357 issue->resume = resume;
369void fr_tls_ticket_stateless_disable(SSL_CTX *ctx,
bool stateful)
371 long ctx_options = SSL_CTX_get_options(ctx);
376 ctx_options |= SSL_OP_NO_TICKET;
377 SSL_CTX_set_options(ctx, ctx_options);
384 SSL_CTX_set_num_tickets(ctx, stateful ? 1 : 0);
393static int tls_ticket_stateless_app_data_set(SSL *ssl,
void *arg)
395 fr_tls_session_t *tls_session = fr_tls_session(ssl);
396 fr_tls_ticket_conf_t *tls_cache_conf = arg;
408 if (!fr_tls_session_request_bound(ssl))
return 1;
414 if (!tls_session->session_ticket_supported)
return 1;
421 if (tls_session->app_data_ready) {
422 tls_session->app_data_ready =
false;
423 tls_session->session_ticket_created =
true;
433 request = fr_tls_session_request(ssl);
445 if (!tls_session->allow_session_resumption ||
446 (!(tls_cache_conf->mode & FR_TLS_TICKET_STATELESS))) {
447 REDEBUG(
"(TLS) Generating session-tickets is not allowed");
448 fr_tls_session_error_add(
request, FR_ERROR_VALUE_SESSION_TICKET_NOT_ALLOWED);
452 sess = SSL_get_session(ssl);
454 REDEBUG(
"(TLS) Failed retrieving session in session generation callback");
463 conf = fr_tls_session_conf(ssl);
465 if (
conf->encode_session && !tls_ticket_stateless_encode_run(
request, tls_session)) {
466 REDEBUG(
"(TLS) Not generating a session-ticket");
470 ret = tls_ticket_app_data_set(
request, sess, &tls_session->session_id);
471 tls_session->session_ticket_created = (ret == 1);
480static SSL_TICKET_RETURN tls_ticket_stateless_app_data_get(SSL *ssl, SSL_SESSION *sess,
481 UNUSED unsigned char const *keyname,
482 UNUSED size_t keyname_len,
483 SSL_TICKET_STATUS status,
486 fr_tls_session_t *tls_session = fr_tls_session(ssl);
487 fr_tls_conf_t *
conf = tls_session->conf;
488 fr_tls_ticket_conf_t *tls_cache_conf = arg;
492 if (fr_tls_session_request_bound(ssl)) {
493 request = fr_tls_session_request(ssl);
497 if (!tls_session->allow_session_resumption ||
498 (!(tls_cache_conf->mode & FR_TLS_TICKET_STATELESS))) {
500 "denying session resumption via session-ticket");
501 return SSL_TICKET_RETURN_IGNORE;
505 case SSL_TICKET_EMPTY:
506 case SSL_TICKET_NO_DECRYPT:
507 case SSL_TICKET_FATAL_ERR_MALLOC:
508 case SSL_TICKET_FATAL_ERR_OTHER:
509 case SSL_TICKET_NONE:
510#ifdef STATIC_ANALYZER
513 return SSL_TICKET_RETURN_IGNORE_RENEW;
515 case SSL_TICKET_SUCCESS:
516 if (!
request)
return SSL_TICKET_RETURN_USE;
519 case SSL_TICKET_SUCCESS_RENEW:
520 if (!
request)
return SSL_TICKET_RETURN_USE_RENEW;
539 if (!tls_ticket_session_resumable(
request, &tls_session->session_id,
conf, sess)) {
540 REDEBUG(
"(TLS) Session-ticket has too little life left, denying session resumption");
541 fr_tls_session_error_add(
request, FR_ERROR_VALUE_SESSION_TICKET_EXPIRED);
542 return SSL_TICKET_RETURN_IGNORE_RENEW;
545 if (tls_ticket_app_data_get(
request, sess, &tls_session->session_id) < 0) {
546 REDEBUG(
"(TLS) Denying session resumption via session-ticket");
547 return SSL_TICKET_RETURN_IGNORE_RENEW;
555 if (
conf->decode_session && !tls_ticket_stateless_decode_run(
request, tls_session)) {
556 REDEBUG(
"(TLS) Denying session resumption via session-ticket");
557 return SSL_TICKET_RETURN_IGNORE_RENEW;
560 if (
conf->virtual_server && tls_session->verify_peer_cert) {
561 RDEBUG2(
"(TLS) Requesting certificate re-validation for session-ticket");
570 fr_tls_verify_resumed_request(tls_session);
578 if (
unlikely(!tls_session->can_pause)) {
580 "tls_session_async_handshake_cont must be in call stack", __FUNCTION__);
581 return SSL_TICKET_RETURN_IGNORE_RENEW;
598 fr_tls_verify_cert_reset(tls_session);
599 return SSL_TICKET_RETURN_ABORT;
607 if (!fr_tls_verify_cert_result(tls_session)) {
608 RDEBUG2(
"(TLS) Certificate re-validation failed, denying session resumption via session-ticket");
609 return SSL_TICKET_RETURN_IGNORE_RENEW;
617 RWDEBUG(
"(TLS) Session ID %pV - Failed adding %s attribute", &tls_session->session_id,
623 return (status == SSL_TICKET_SUCCESS_RENEW) ? SSL_TICKET_RETURN_USE_RENEW : SSL_TICKET_RETURN_USE;
639int fr_tls_ticket_stateless_ctx_init(SSL_CTX *ctx, fr_tls_ticket_conf_t
const *cache_conf)
643 EVP_PKEY_CTX *pkey_ctx = NULL;
654 key_len = SSL_CTX_set_tlsext_ticket_keys(ctx, NULL, 0);
656 if (
unlikely((pkey_ctx = EVP_PKEY_CTX_new_id(EVP_PKEY_HKDF, NULL)) == NULL)) {
657 fr_tls_strerror_printf(NULL);
658 PERROR(
"Failed initialising KDF");
660 if (pkey_ctx) EVP_PKEY_CTX_free(pkey_ctx);
663 if (
unlikely(EVP_PKEY_derive_init(pkey_ctx) != 1)) {
664 fr_tls_strerror_printf(NULL);
665 PERROR(
"Failed initialising KDF derivation ctx");
668 if (
unlikely(EVP_PKEY_CTX_set_hkdf_md(pkey_ctx,
UNCONST(
struct evp_md_st *, EVP_sha256())) != 1)) {
669 fr_tls_strerror_printf(NULL);
670 PERROR(
"Failed setting KDF MD");
673 if (
unlikely(EVP_PKEY_CTX_set1_hkdf_key(pkey_ctx,
674 UNCONST(
unsigned char *, cache_conf->session_ticket_key),
675 (
int)talloc_array_length(cache_conf->session_ticket_key)) != 1)) {
676 fr_tls_strerror_printf(NULL);
677 PERROR(
"Failed setting KDF key");
680 if (
unlikely(EVP_PKEY_CTX_add1_hkdf_info(pkey_ctx,
681 UNCONST(
unsigned char *,
"freeradius-session-ticket"),
682 sizeof(
"freeradius-session-ticket") - 1) != 1)) {
683 fr_tls_strerror_printf(NULL);
684 PERROR(
"Failed setting KDF label");
692 MEM(key_buff = talloc_array(NULL,
uint8_t, key_len));
693 if (EVP_PKEY_derive(pkey_ctx, key_buff, &key_len) != 1) {
694 fr_tls_strerror_printf(NULL);
695 PERROR(
"Failed deriving session ticket key");
701 EVP_PKEY_CTX_free(pkey_ctx);
704 fr_assert(talloc_array_length(key_buff) == key_len);
709 if (SSL_CTX_set_tlsext_ticket_keys(ctx,
710 key_buff, key_len) != 1) {
711 fr_tls_strerror_printf(NULL);
712 PERROR(
"Failed setting session ticket keys");
716 DEBUG3(
"Derived session-ticket-key:");
718 TALLOC_FREE(key_buff);
724 if (
unlikely(SSL_CTX_set_session_ticket_cb(ctx,
725 tls_ticket_stateless_app_data_set,
726 tls_ticket_stateless_app_data_get,
727 UNCONST(fr_tls_ticket_conf_t *, cache_conf)) != 1)) {
728 fr_tls_strerror_printf(NULL);
729 PERROR(
"Failed setting session ticket callbacks");
739 SSL_CTX_set_num_tickets(ctx, 1);
unlang_action_t
Returned by unlang_op_t calls, determine the next action of the interpreter.
@ UNLANG_ACTION_PUSHED_CHILD
unlang_t pushed a new child onto the stack, execute it instead of continuing.
@ UNLANG_ACTION_FAIL
Encountered an unexpected error.
@ UNLANG_ACTION_CALCULATE_RESULT
Calculate a new section rlm_rcode_t value.
static uint8_t request[4]
#define UNCONST(_type, _ptr)
Remove const qualification from a pointer.
#define USES_APPLE_DEPRECATED_API
#define IGNORE(_expr, _type)
#define fr_assert_msg(_x, _msg,...)
Calls panic_action ifndef NDEBUG, else logs error and causes the server to exit immediately with code...
int unlang_function_clear(request_t *request)
Clear pending repeat function calls, and remove the signal handler.
#define unlang_function_push_with_result(_result_p, _request, _func, _repeat, _signal, _sigmask, _top_frame, _uctx)
Push a generic function onto the unlang stack that produces a result.
#define unlang_function_repeat_set(_request, _repeat)
Set a new repeat function for an existing function frame.
unlang_action_t(* unlang_function_with_result_t)(unlang_result_t *p_result, request_t *request, void *uctx)
A generic function pushed by a module or xlat to functions deeper in the C call stack to create resum...
bool unlang_request_is_cancelled(request_t const *request)
Return whether a request has been cancelled.
#define ROPTIONAL(_l_request, _l_global, _fmt,...)
Use different logging functions depending on whether request is NULL or not.
#define HEXDUMP3(_data, _len, _fmt,...)
HIDDEN fr_dict_attr_t const * attr_tls_packet_type
fr_value_box_t const * enum_tls_packet_type_success
fr_value_box_t const * enum_tls_session_resumed_stateless
HIDDEN fr_dict_attr_t const * attr_tls_session_resume_type
fr_value_box_t const * enum_tls_packet_type_decode_session
fr_value_box_t const * enum_tls_packet_type_encode_session
fr_pair_t * fr_pair_find_by_da(fr_pair_list_t const *list, fr_pair_t const *prev, fr_dict_attr_t const *da)
Find the first pair with a matching da.
#define pair_update_session_state(_attr, _da)
Return or allocate a fr_pair_t in the session_state list.
@ FR_SIGNAL_NONE
No signals.
Stores an attribute, a value and various bits of other data.