2012-09-25 21:55:46 +00:00
|
|
|
/*
|
|
|
|
* SSL session cache implementation
|
|
|
|
*
|
2020-08-07 11:07:28 +00:00
|
|
|
* Copyright The Mbed TLS Contributors
|
2015-09-04 12:21:07 +00:00
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
2012-09-25 21:55:46 +00:00
|
|
|
*
|
2015-09-04 12:21:07 +00:00
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
|
|
* not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
2012-09-25 21:55:46 +00:00
|
|
|
*
|
2015-09-04 12:21:07 +00:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2012-09-25 21:55:46 +00:00
|
|
|
*
|
2015-09-04 12:21:07 +00:00
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
2012-09-25 21:55:46 +00:00
|
|
|
*/
|
|
|
|
/*
|
|
|
|
* These session callbacks use a simple chained list
|
|
|
|
* to store and retrieve the session information.
|
|
|
|
*/
|
|
|
|
|
2020-06-02 23:43:33 +00:00
|
|
|
#include "common.h"
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_SSL_CACHE_C)
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_PLATFORM_C)
|
2015-03-09 17:05:11 +00:00
|
|
|
#include "mbedtls/platform.h"
|
2013-07-03 11:37:05 +00:00
|
|
|
#else
|
2015-02-06 13:43:58 +00:00
|
|
|
#include <stdlib.h>
|
2015-05-26 14:04:06 +00:00
|
|
|
#define mbedtls_calloc calloc
|
2016-04-26 06:43:27 +00:00
|
|
|
#define mbedtls_free free
|
2013-07-03 11:37:05 +00:00
|
|
|
#endif
|
|
|
|
|
2016-04-26 06:43:27 +00:00
|
|
|
#include "mbedtls/ssl_cache.h"
|
2021-03-05 18:38:47 +00:00
|
|
|
#include "ssl_misc.h"
|
2016-04-26 06:43:27 +00:00
|
|
|
|
|
|
|
#include <string.h>
|
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
void mbedtls_ssl_cache_init( mbedtls_ssl_cache_context *cache )
|
2012-09-25 21:55:46 +00:00
|
|
|
{
|
2015-04-08 10:49:31 +00:00
|
|
|
memset( cache, 0, sizeof( mbedtls_ssl_cache_context ) );
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
cache->timeout = MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT;
|
|
|
|
cache->max_entries = MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES;
|
2013-09-28 13:01:27 +00:00
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_THREADING_C)
|
|
|
|
mbedtls_mutex_init( &cache->mutex );
|
2013-09-28 13:01:27 +00:00
|
|
|
#endif
|
2012-09-25 21:55:46 +00:00
|
|
|
}
|
|
|
|
|
2021-04-15 09:17:53 +00:00
|
|
|
static int ssl_cache_find_entry( mbedtls_ssl_cache_context *cache,
|
|
|
|
unsigned char const *session_id,
|
|
|
|
size_t session_id_len,
|
|
|
|
mbedtls_ssl_cache_entry **dst )
|
2012-09-25 21:55:46 +00:00
|
|
|
{
|
2013-09-28 13:01:27 +00:00
|
|
|
int ret = 1;
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_HAVE_TIME)
|
2016-04-26 06:43:27 +00:00
|
|
|
mbedtls_time_t t = mbedtls_time( NULL );
|
2013-07-03 13:31:03 +00:00
|
|
|
#endif
|
2021-04-15 09:17:53 +00:00
|
|
|
mbedtls_ssl_cache_entry *cur;
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2021-04-15 09:17:53 +00:00
|
|
|
for( cur = cache->chain; cur != NULL; cur = cur->next )
|
2012-09-25 21:55:46 +00:00
|
|
|
{
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_HAVE_TIME)
|
2012-09-25 21:55:46 +00:00
|
|
|
if( cache->timeout != 0 &&
|
2021-04-15 09:17:53 +00:00
|
|
|
(int) ( t - cur->timestamp ) > cache->timeout )
|
2012-09-25 21:55:46 +00:00
|
|
|
continue;
|
2013-07-03 13:31:03 +00:00
|
|
|
#endif
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2021-04-15 09:26:06 +00:00
|
|
|
if( session_id_len != cur->session_id_len ||
|
|
|
|
memcmp( session_id, cur->session_id,
|
|
|
|
cur->session_id_len ) != 0 )
|
2021-04-15 07:19:40 +00:00
|
|
|
{
|
2012-09-25 21:55:46 +00:00
|
|
|
continue;
|
2021-04-15 07:19:40 +00:00
|
|
|
}
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2021-04-15 09:17:53 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
if( cur != NULL )
|
|
|
|
{
|
|
|
|
*dst = cur;
|
|
|
|
ret = 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
return( ret );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
int mbedtls_ssl_cache_get( void *data,
|
|
|
|
unsigned char const *session_id,
|
|
|
|
size_t session_id_len,
|
|
|
|
mbedtls_ssl_session *session )
|
|
|
|
{
|
|
|
|
int ret = 1;
|
|
|
|
mbedtls_ssl_cache_context *cache = (mbedtls_ssl_cache_context *) data;
|
|
|
|
mbedtls_ssl_cache_entry *entry;
|
|
|
|
|
|
|
|
#if defined(MBEDTLS_THREADING_C)
|
|
|
|
if( mbedtls_mutex_lock( &cache->mutex ) != 0 )
|
|
|
|
return( 1 );
|
|
|
|
#endif
|
|
|
|
|
|
|
|
ret = ssl_cache_find_entry( cache, session_id, session_id_len, &entry );
|
|
|
|
if( ret != 0 )
|
|
|
|
goto exit;
|
|
|
|
|
2021-04-15 09:26:06 +00:00
|
|
|
ret = mbedtls_ssl_session_load( session,
|
|
|
|
entry->session,
|
|
|
|
entry->session_len );
|
2021-04-15 09:17:53 +00:00
|
|
|
if( ret != 0 )
|
|
|
|
goto exit;
|
|
|
|
|
|
|
|
ret = 0;
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2013-09-28 13:01:27 +00:00
|
|
|
exit:
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_THREADING_C)
|
|
|
|
if( mbedtls_mutex_unlock( &cache->mutex ) != 0 )
|
2013-09-28 13:01:27 +00:00
|
|
|
ret = 1;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
return( ret );
|
2012-09-25 21:55:46 +00:00
|
|
|
}
|
|
|
|
|
2021-05-13 05:29:13 +00:00
|
|
|
static int ssl_cache_pick_writing_slot( mbedtls_ssl_cache_context *cache,
|
|
|
|
unsigned char const *session_id,
|
|
|
|
size_t session_id_len,
|
|
|
|
mbedtls_ssl_cache_entry **dst )
|
2012-09-25 21:55:46 +00:00
|
|
|
{
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_HAVE_TIME)
|
2017-07-28 22:46:43 +00:00
|
|
|
mbedtls_time_t t = mbedtls_time( NULL ), oldest = 0;
|
2021-05-14 03:55:35 +00:00
|
|
|
#endif /* MBEDTLS_HAVE_TIME */
|
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
mbedtls_ssl_cache_entry *old = NULL;
|
2012-10-23 22:18:28 +00:00
|
|
|
int count = 0;
|
2021-05-14 13:54:00 +00:00
|
|
|
mbedtls_ssl_cache_entry *cur, *last;
|
2013-09-28 13:01:27 +00:00
|
|
|
|
2021-05-13 06:05:07 +00:00
|
|
|
/* Check 1: Is there already an entry with the given session ID?
|
|
|
|
*
|
|
|
|
* If yes, overwrite it.
|
|
|
|
*
|
|
|
|
* If not, `count` will hold the size of the session cache
|
2021-05-14 13:54:00 +00:00
|
|
|
* at the end of this loop, and `last` will point to the last
|
2021-05-13 06:05:07 +00:00
|
|
|
* entry, both of which will be used later. */
|
|
|
|
|
2021-05-14 13:45:38 +00:00
|
|
|
last = NULL;
|
|
|
|
for( cur = cache->chain; cur != NULL; cur = cur->next )
|
2012-09-25 21:55:46 +00:00
|
|
|
{
|
2012-10-23 22:18:28 +00:00
|
|
|
count++;
|
2021-04-15 09:26:06 +00:00
|
|
|
if( session_id_len == cur->session_id_len &&
|
|
|
|
memcmp( session_id, cur->session_id, cur->session_id_len ) == 0 )
|
2021-04-15 08:26:17 +00:00
|
|
|
{
|
2021-05-13 06:05:07 +00:00
|
|
|
goto found;
|
2021-04-15 08:26:17 +00:00
|
|
|
}
|
2021-05-14 13:45:38 +00:00
|
|
|
last = cur;
|
2021-05-13 06:05:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Check 2: Is there an outdated entry in the cache?
|
|
|
|
*
|
|
|
|
* If so, overwrite it.
|
|
|
|
*
|
|
|
|
* If not, remember the oldest entry in `old` for later.
|
|
|
|
*/
|
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_HAVE_TIME)
|
2021-05-14 13:45:38 +00:00
|
|
|
for( cur = cache->chain; cur != NULL; cur = cur->next )
|
2021-05-13 06:05:07 +00:00
|
|
|
{
|
|
|
|
if( cache->timeout != 0 &&
|
|
|
|
(int) ( t - cur->timestamp ) > cache->timeout )
|
|
|
|
{
|
|
|
|
goto found;
|
|
|
|
}
|
|
|
|
|
2012-10-23 22:18:28 +00:00
|
|
|
if( oldest == 0 || cur->timestamp < oldest )
|
|
|
|
{
|
|
|
|
oldest = cur->timestamp;
|
|
|
|
old = cur;
|
|
|
|
}
|
2012-09-25 21:55:46 +00:00
|
|
|
}
|
2021-05-13 06:05:07 +00:00
|
|
|
#endif /* MBEDTLS_HAVE_TIME */
|
|
|
|
|
|
|
|
/* Check 3: Is there free space in the cache? */
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2021-05-13 06:05:07 +00:00
|
|
|
if( count < cache->max_entries )
|
2012-09-25 21:55:46 +00:00
|
|
|
{
|
2021-05-13 06:05:07 +00:00
|
|
|
/* Create new entry */
|
|
|
|
cur = mbedtls_calloc( 1, sizeof(mbedtls_ssl_cache_entry) );
|
|
|
|
if( cur == NULL )
|
|
|
|
return( 1 );
|
|
|
|
|
|
|
|
/* Append to the end of the linked list. */
|
2021-05-14 13:54:00 +00:00
|
|
|
if( last == NULL )
|
2021-05-13 06:05:07 +00:00
|
|
|
cache->chain = cur;
|
|
|
|
else
|
2021-05-14 13:54:00 +00:00
|
|
|
last->next = cur;
|
2014-02-20 20:32:08 +00:00
|
|
|
|
2021-05-13 06:05:07 +00:00
|
|
|
goto found;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Last resort: The cache is full and doesn't contain any outdated
|
|
|
|
* elements. In this case, we evict the oldest one, judged by timestamp
|
|
|
|
* (if present) or cache-order. */
|
|
|
|
|
|
|
|
#if defined(MBEDTLS_HAVE_TIME)
|
|
|
|
if( old == NULL )
|
|
|
|
{
|
|
|
|
/* This should only happen on an ill-configured cache
|
|
|
|
* with max_entries == 0. */
|
|
|
|
return( 1 );
|
|
|
|
}
|
2015-04-08 10:49:31 +00:00
|
|
|
#else /* MBEDTLS_HAVE_TIME */
|
2021-05-13 06:05:07 +00:00
|
|
|
/* Reuse first entry in chain, but move to last place. */
|
|
|
|
if( cache->chain == NULL )
|
|
|
|
return( 1 );
|
|
|
|
|
|
|
|
old = cache->chain;
|
|
|
|
cache->chain = old->next;
|
2021-05-14 13:45:04 +00:00
|
|
|
old->next = NULL;
|
2021-05-14 13:54:00 +00:00
|
|
|
last->next = old;
|
2015-04-08 10:49:31 +00:00
|
|
|
#endif /* MBEDTLS_HAVE_TIME */
|
2021-05-13 06:05:07 +00:00
|
|
|
|
|
|
|
/* Now `old` points to the oldest entry to be overwritten. */
|
|
|
|
cur = old;
|
|
|
|
|
|
|
|
found:
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_HAVE_TIME)
|
2021-05-13 06:05:07 +00:00
|
|
|
cur->timestamp = t;
|
2013-07-03 13:31:03 +00:00
|
|
|
#endif
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2021-05-13 06:05:07 +00:00
|
|
|
/* If we're reusing an entry, free it first. */
|
|
|
|
if( cur->session != NULL )
|
2014-02-26 16:38:55 +00:00
|
|
|
{
|
2021-05-13 06:05:07 +00:00
|
|
|
mbedtls_free( cur->session );
|
|
|
|
cur->session = NULL;
|
|
|
|
cur->session_len = 0;
|
|
|
|
memset( cur->session_id, 0, sizeof( cur->session_id ) );
|
|
|
|
cur->session_id_len = 0;
|
2014-02-26 16:38:55 +00:00
|
|
|
}
|
2021-04-15 08:57:17 +00:00
|
|
|
|
2021-05-13 06:05:07 +00:00
|
|
|
*dst = cur;
|
|
|
|
return( 0 );
|
2021-04-15 08:57:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
int mbedtls_ssl_cache_set( void *data,
|
|
|
|
unsigned char const *session_id,
|
|
|
|
size_t session_id_len,
|
|
|
|
const mbedtls_ssl_session *session )
|
|
|
|
{
|
|
|
|
int ret = 1;
|
|
|
|
mbedtls_ssl_cache_context *cache = (mbedtls_ssl_cache_context *) data;
|
|
|
|
mbedtls_ssl_cache_entry *cur;
|
|
|
|
|
2021-04-15 09:26:06 +00:00
|
|
|
size_t session_serialized_len;
|
|
|
|
unsigned char *session_serialized = NULL;
|
|
|
|
|
2021-04-15 08:57:17 +00:00
|
|
|
#if defined(MBEDTLS_THREADING_C)
|
|
|
|
if( ( ret = mbedtls_mutex_lock( &cache->mutex ) ) != 0 )
|
|
|
|
return( ret );
|
|
|
|
#endif
|
|
|
|
|
2021-05-13 05:29:13 +00:00
|
|
|
ret = ssl_cache_pick_writing_slot( cache,
|
|
|
|
session_id, session_id_len,
|
|
|
|
&cur );
|
2021-04-15 08:57:17 +00:00
|
|
|
if( ret != 0 )
|
|
|
|
goto exit;
|
2019-02-06 14:53:19 +00:00
|
|
|
|
2021-04-15 09:26:06 +00:00
|
|
|
/* Check how much space we need to serialize the session
|
|
|
|
* and allocate a sufficiently large buffer. */
|
|
|
|
ret = mbedtls_ssl_session_save( session, NULL, 0, &session_serialized_len );
|
|
|
|
if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
|
2019-02-06 14:53:19 +00:00
|
|
|
{
|
|
|
|
ret = 1;
|
|
|
|
goto exit;
|
|
|
|
}
|
2014-02-26 16:38:55 +00:00
|
|
|
|
2021-04-15 09:26:06 +00:00
|
|
|
session_serialized = mbedtls_calloc( 1, session_serialized_len );
|
|
|
|
if( session_serialized == NULL )
|
2013-03-06 16:40:46 +00:00
|
|
|
{
|
2021-04-15 09:26:06 +00:00
|
|
|
ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
|
|
|
|
goto exit;
|
|
|
|
}
|
2013-03-06 16:40:46 +00:00
|
|
|
|
2021-04-15 09:26:06 +00:00
|
|
|
/* Now serialize the session into the allocated buffer. */
|
|
|
|
ret = mbedtls_ssl_session_save( session,
|
|
|
|
session_serialized,
|
|
|
|
session_serialized_len,
|
|
|
|
&session_serialized_len );
|
|
|
|
if( ret != 0 )
|
|
|
|
goto exit;
|
2013-03-06 16:40:46 +00:00
|
|
|
|
2021-04-15 15:49:32 +00:00
|
|
|
if( session_id_len > sizeof( cur->session_id ) )
|
2021-04-15 09:26:06 +00:00
|
|
|
{
|
|
|
|
ret = 1;
|
|
|
|
goto exit;
|
2013-03-06 16:40:46 +00:00
|
|
|
}
|
2021-04-15 09:26:06 +00:00
|
|
|
cur->session_id_len = session_id_len;
|
|
|
|
memcpy( cur->session_id, session_id, session_id_len );
|
|
|
|
|
|
|
|
cur->session = session_serialized;
|
|
|
|
cur->session_len = session_serialized_len;
|
|
|
|
session_serialized = NULL;
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2013-09-28 13:01:27 +00:00
|
|
|
ret = 0;
|
|
|
|
|
|
|
|
exit:
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_THREADING_C)
|
|
|
|
if( mbedtls_mutex_unlock( &cache->mutex ) != 0 )
|
2013-09-28 13:01:27 +00:00
|
|
|
ret = 1;
|
|
|
|
#endif
|
|
|
|
|
2021-04-15 09:26:06 +00:00
|
|
|
if( session_serialized != NULL )
|
|
|
|
mbedtls_platform_zeroize( session_serialized, session_serialized_len );
|
|
|
|
|
2013-09-28 13:01:27 +00:00
|
|
|
return( ret );
|
2012-09-25 21:55:46 +00:00
|
|
|
}
|
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_HAVE_TIME)
|
|
|
|
void mbedtls_ssl_cache_set_timeout( mbedtls_ssl_cache_context *cache, int timeout )
|
2012-09-25 21:55:46 +00:00
|
|
|
{
|
|
|
|
if( timeout < 0 ) timeout = 0;
|
|
|
|
|
|
|
|
cache->timeout = timeout;
|
|
|
|
}
|
2015-04-08 10:49:31 +00:00
|
|
|
#endif /* MBEDTLS_HAVE_TIME */
|
2012-09-25 21:55:46 +00:00
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
void mbedtls_ssl_cache_set_max_entries( mbedtls_ssl_cache_context *cache, int max )
|
2012-10-23 22:18:28 +00:00
|
|
|
{
|
|
|
|
if( max < 0 ) max = 0;
|
|
|
|
|
|
|
|
cache->max_entries = max;
|
|
|
|
}
|
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
void mbedtls_ssl_cache_free( mbedtls_ssl_cache_context *cache )
|
2012-09-25 21:55:46 +00:00
|
|
|
{
|
2015-04-08 10:49:31 +00:00
|
|
|
mbedtls_ssl_cache_entry *cur, *prv;
|
2012-09-25 21:55:46 +00:00
|
|
|
|
|
|
|
cur = cache->chain;
|
|
|
|
|
|
|
|
while( cur != NULL )
|
|
|
|
{
|
|
|
|
prv = cur;
|
|
|
|
cur = cur->next;
|
|
|
|
|
2021-04-15 09:26:06 +00:00
|
|
|
mbedtls_free( prv->session );
|
2015-04-08 10:49:31 +00:00
|
|
|
mbedtls_free( prv );
|
2012-09-25 21:55:46 +00:00
|
|
|
}
|
2013-09-28 13:01:27 +00:00
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
#if defined(MBEDTLS_THREADING_C)
|
|
|
|
mbedtls_mutex_free( &cache->mutex );
|
2013-09-28 13:01:27 +00:00
|
|
|
#endif
|
2017-10-29 15:53:52 +00:00
|
|
|
cache->chain = NULL;
|
2012-09-25 21:55:46 +00:00
|
|
|
}
|
|
|
|
|
2015-04-08 10:49:31 +00:00
|
|
|
#endif /* MBEDTLS_SSL_CACHE_C */
|