Kev Mann / mbed-dev-OS5_10_4

features/mbedtls/src/ssl_cache.c@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kevman 0:38ceb79fef03 1 /*
kevman 0:38ceb79fef03 2 * SSL session cache implementation
kevman 0:38ceb79fef03 3 *
kevman 0:38ceb79fef03 4 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
kevman 0:38ceb79fef03 5 * SPDX-License-Identifier: Apache-2.0
kevman 0:38ceb79fef03 6 *
kevman 0:38ceb79fef03 7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
kevman 0:38ceb79fef03 8 * not use this file except in compliance with the License.
kevman 0:38ceb79fef03 9 * You may obtain a copy of the License at
kevman 0:38ceb79fef03 10 *
kevman 0:38ceb79fef03 11 * http://www.apache.org/licenses/LICENSE-2.0
kevman 0:38ceb79fef03 12 *
kevman 0:38ceb79fef03 13 * Unless required by applicable law or agreed to in writing, software
kevman 0:38ceb79fef03 14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
kevman 0:38ceb79fef03 15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kevman 0:38ceb79fef03 16 * See the License for the specific language governing permissions and
kevman 0:38ceb79fef03 17 * limitations under the License.
kevman 0:38ceb79fef03 18 *
kevman 0:38ceb79fef03 19 * This file is part of mbed TLS (https://tls.mbed.org)
kevman 0:38ceb79fef03 20 */
kevman 0:38ceb79fef03 21 /*
kevman 0:38ceb79fef03 22 * These session callbacks use a simple chained list
kevman 0:38ceb79fef03 23 * to store and retrieve the session information.
kevman 0:38ceb79fef03 24 */
kevman 0:38ceb79fef03 25
kevman 0:38ceb79fef03 26 #if !defined(MBEDTLS_CONFIG_FILE)
kevman 0:38ceb79fef03 27 #include "mbedtls/config.h"
kevman 0:38ceb79fef03 28 #else
kevman 0:38ceb79fef03 29 #include MBEDTLS_CONFIG_FILE
kevman 0:38ceb79fef03 30 #endif
kevman 0:38ceb79fef03 31
kevman 0:38ceb79fef03 32 #if defined(MBEDTLS_SSL_CACHE_C)
kevman 0:38ceb79fef03 33
kevman 0:38ceb79fef03 34 #if defined(MBEDTLS_PLATFORM_C)
kevman 0:38ceb79fef03 35 #include "mbedtls/platform.h"
kevman 0:38ceb79fef03 36 #else
kevman 0:38ceb79fef03 37 #include <stdlib.h>
kevman 0:38ceb79fef03 38 #define mbedtls_calloc calloc
kevman 0:38ceb79fef03 39 #define mbedtls_free free
kevman 0:38ceb79fef03 40 #endif
kevman 0:38ceb79fef03 41
kevman 0:38ceb79fef03 42 #include "mbedtls/ssl_cache.h"
kevman 0:38ceb79fef03 43
kevman 0:38ceb79fef03 44 #include <string.h>
kevman 0:38ceb79fef03 45
kevman 0:38ceb79fef03 46 void mbedtls_ssl_cache_init( mbedtls_ssl_cache_context *cache )
kevman 0:38ceb79fef03 47 {
kevman 0:38ceb79fef03 48 memset( cache, 0, sizeof( mbedtls_ssl_cache_context ) );
kevman 0:38ceb79fef03 49
kevman 0:38ceb79fef03 50 cache->timeout = MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT;
kevman 0:38ceb79fef03 51 cache->max_entries = MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES;
kevman 0:38ceb79fef03 52
kevman 0:38ceb79fef03 53 #if defined(MBEDTLS_THREADING_C)
kevman 0:38ceb79fef03 54 mbedtls_mutex_init( &cache->mutex );
kevman 0:38ceb79fef03 55 #endif
kevman 0:38ceb79fef03 56 }
kevman 0:38ceb79fef03 57
kevman 0:38ceb79fef03 58 int mbedtls_ssl_cache_get( void *data, mbedtls_ssl_session *session )
kevman 0:38ceb79fef03 59 {
kevman 0:38ceb79fef03 60 int ret = 1;
kevman 0:38ceb79fef03 61 #if defined(MBEDTLS_HAVE_TIME)
kevman 0:38ceb79fef03 62 mbedtls_time_t t = mbedtls_time( NULL );
kevman 0:38ceb79fef03 63 #endif
kevman 0:38ceb79fef03 64 mbedtls_ssl_cache_context *cache = (mbedtls_ssl_cache_context *) data;
kevman 0:38ceb79fef03 65 mbedtls_ssl_cache_entry *cur, *entry;
kevman 0:38ceb79fef03 66
kevman 0:38ceb79fef03 67 #if defined(MBEDTLS_THREADING_C)
kevman 0:38ceb79fef03 68 if( mbedtls_mutex_lock( &cache->mutex ) != 0 )
kevman 0:38ceb79fef03 69 return( 1 );
kevman 0:38ceb79fef03 70 #endif
kevman 0:38ceb79fef03 71
kevman 0:38ceb79fef03 72 cur = cache->chain;
kevman 0:38ceb79fef03 73 entry = NULL;
kevman 0:38ceb79fef03 74
kevman 0:38ceb79fef03 75 while( cur != NULL )
kevman 0:38ceb79fef03 76 {
kevman 0:38ceb79fef03 77 entry = cur;
kevman 0:38ceb79fef03 78 cur = cur->next;
kevman 0:38ceb79fef03 79
kevman 0:38ceb79fef03 80 #if defined(MBEDTLS_HAVE_TIME)
kevman 0:38ceb79fef03 81 if( cache->timeout != 0 &&
kevman 0:38ceb79fef03 82 (int) ( t - entry->timestamp ) > cache->timeout )
kevman 0:38ceb79fef03 83 continue;
kevman 0:38ceb79fef03 84 #endif
kevman 0:38ceb79fef03 85
kevman 0:38ceb79fef03 86 if( session->ciphersuite != entry->session.ciphersuite ||
kevman 0:38ceb79fef03 87 session->compression != entry->session.compression ||
kevman 0:38ceb79fef03 88 session->id_len != entry->session.id_len )
kevman 0:38ceb79fef03 89 continue;
kevman 0:38ceb79fef03 90
kevman 0:38ceb79fef03 91 if( memcmp( session->id, entry->session.id,
kevman 0:38ceb79fef03 92 entry->session.id_len ) != 0 )
kevman 0:38ceb79fef03 93 continue;
kevman 0:38ceb79fef03 94
kevman 0:38ceb79fef03 95 memcpy( session->master, entry->session.master, 48 );
kevman 0:38ceb79fef03 96
kevman 0:38ceb79fef03 97 session->verify_result = entry->session.verify_result;
kevman 0:38ceb79fef03 98
kevman 0:38ceb79fef03 99 #if defined(MBEDTLS_X509_CRT_PARSE_C)
kevman 0:38ceb79fef03 100 /*
kevman 0:38ceb79fef03 101 * Restore peer certificate (without rest of the original chain)
kevman 0:38ceb79fef03 102 */
kevman 0:38ceb79fef03 103 if( entry->peer_cert.p != NULL )
kevman 0:38ceb79fef03 104 {
kevman 0:38ceb79fef03 105 if( ( session->peer_cert = mbedtls_calloc( 1,
kevman 0:38ceb79fef03 106 sizeof(mbedtls_x509_crt) ) ) == NULL )
kevman 0:38ceb79fef03 107 {
kevman 0:38ceb79fef03 108 ret = 1;
kevman 0:38ceb79fef03 109 goto exit;
kevman 0:38ceb79fef03 110 }
kevman 0:38ceb79fef03 111
kevman 0:38ceb79fef03 112 mbedtls_x509_crt_init( session->peer_cert );
kevman 0:38ceb79fef03 113 if( mbedtls_x509_crt_parse( session->peer_cert, entry->peer_cert.p,
kevman 0:38ceb79fef03 114 entry->peer_cert.len ) != 0 )
kevman 0:38ceb79fef03 115 {
kevman 0:38ceb79fef03 116 mbedtls_free( session->peer_cert );
kevman 0:38ceb79fef03 117 session->peer_cert = NULL;
kevman 0:38ceb79fef03 118 ret = 1;
kevman 0:38ceb79fef03 119 goto exit;
kevman 0:38ceb79fef03 120 }
kevman 0:38ceb79fef03 121 }
kevman 0:38ceb79fef03 122 #endif /* MBEDTLS_X509_CRT_PARSE_C */
kevman 0:38ceb79fef03 123
kevman 0:38ceb79fef03 124 ret = 0;
kevman 0:38ceb79fef03 125 goto exit;
kevman 0:38ceb79fef03 126 }
kevman 0:38ceb79fef03 127
kevman 0:38ceb79fef03 128 exit:
kevman 0:38ceb79fef03 129 #if defined(MBEDTLS_THREADING_C)
kevman 0:38ceb79fef03 130 if( mbedtls_mutex_unlock( &cache->mutex ) != 0 )
kevman 0:38ceb79fef03 131 ret = 1;
kevman 0:38ceb79fef03 132 #endif
kevman 0:38ceb79fef03 133
kevman 0:38ceb79fef03 134 return( ret );
kevman 0:38ceb79fef03 135 }
kevman 0:38ceb79fef03 136
kevman 0:38ceb79fef03 137 int mbedtls_ssl_cache_set( void *data, const mbedtls_ssl_session *session )
kevman 0:38ceb79fef03 138 {
kevman 0:38ceb79fef03 139 int ret = 1;
kevman 0:38ceb79fef03 140 #if defined(MBEDTLS_HAVE_TIME)
kevman 0:38ceb79fef03 141 mbedtls_time_t t = mbedtls_time( NULL ), oldest = 0;
kevman 0:38ceb79fef03 142 mbedtls_ssl_cache_entry *old = NULL;
kevman 0:38ceb79fef03 143 #endif
kevman 0:38ceb79fef03 144 mbedtls_ssl_cache_context *cache = (mbedtls_ssl_cache_context *) data;
kevman 0:38ceb79fef03 145 mbedtls_ssl_cache_entry *cur, *prv;
kevman 0:38ceb79fef03 146 int count = 0;
kevman 0:38ceb79fef03 147
kevman 0:38ceb79fef03 148 #if defined(MBEDTLS_THREADING_C)
kevman 0:38ceb79fef03 149 if( ( ret = mbedtls_mutex_lock( &cache->mutex ) ) != 0 )
kevman 0:38ceb79fef03 150 return( ret );
kevman 0:38ceb79fef03 151 #endif
kevman 0:38ceb79fef03 152
kevman 0:38ceb79fef03 153 cur = cache->chain;
kevman 0:38ceb79fef03 154 prv = NULL;
kevman 0:38ceb79fef03 155
kevman 0:38ceb79fef03 156 while( cur != NULL )
kevman 0:38ceb79fef03 157 {
kevman 0:38ceb79fef03 158 count++;
kevman 0:38ceb79fef03 159
kevman 0:38ceb79fef03 160 #if defined(MBEDTLS_HAVE_TIME)
kevman 0:38ceb79fef03 161 if( cache->timeout != 0 &&
kevman 0:38ceb79fef03 162 (int) ( t - cur->timestamp ) > cache->timeout )
kevman 0:38ceb79fef03 163 {
kevman 0:38ceb79fef03 164 cur->timestamp = t;
kevman 0:38ceb79fef03 165 break; /* expired, reuse this slot, update timestamp */
kevman 0:38ceb79fef03 166 }
kevman 0:38ceb79fef03 167 #endif
kevman 0:38ceb79fef03 168
kevman 0:38ceb79fef03 169 if( memcmp( session->id, cur->session.id, cur->session.id_len ) == 0 )
kevman 0:38ceb79fef03 170 break; /* client reconnected, keep timestamp for session id */
kevman 0:38ceb79fef03 171
kevman 0:38ceb79fef03 172 #if defined(MBEDTLS_HAVE_TIME)
kevman 0:38ceb79fef03 173 if( oldest == 0 || cur->timestamp < oldest )
kevman 0:38ceb79fef03 174 {
kevman 0:38ceb79fef03 175 oldest = cur->timestamp;
kevman 0:38ceb79fef03 176 old = cur;
kevman 0:38ceb79fef03 177 }
kevman 0:38ceb79fef03 178 #endif
kevman 0:38ceb79fef03 179
kevman 0:38ceb79fef03 180 prv = cur;
kevman 0:38ceb79fef03 181 cur = cur->next;
kevman 0:38ceb79fef03 182 }
kevman 0:38ceb79fef03 183
kevman 0:38ceb79fef03 184 if( cur == NULL )
kevman 0:38ceb79fef03 185 {
kevman 0:38ceb79fef03 186 #if defined(MBEDTLS_HAVE_TIME)
kevman 0:38ceb79fef03 187 /*
kevman 0:38ceb79fef03 188 * Reuse oldest entry if max_entries reached
kevman 0:38ceb79fef03 189 */
kevman 0:38ceb79fef03 190 if( count >= cache->max_entries )
kevman 0:38ceb79fef03 191 {
kevman 0:38ceb79fef03 192 if( old == NULL )
kevman 0:38ceb79fef03 193 {
kevman 0:38ceb79fef03 194 ret = 1;
kevman 0:38ceb79fef03 195 goto exit;
kevman 0:38ceb79fef03 196 }
kevman 0:38ceb79fef03 197
kevman 0:38ceb79fef03 198 cur = old;
kevman 0:38ceb79fef03 199 }
kevman 0:38ceb79fef03 200 #else /* MBEDTLS_HAVE_TIME */
kevman 0:38ceb79fef03 201 /*
kevman 0:38ceb79fef03 202 * Reuse first entry in chain if max_entries reached,
kevman 0:38ceb79fef03 203 * but move to last place
kevman 0:38ceb79fef03 204 */
kevman 0:38ceb79fef03 205 if( count >= cache->max_entries )
kevman 0:38ceb79fef03 206 {
kevman 0:38ceb79fef03 207 if( cache->chain == NULL )
kevman 0:38ceb79fef03 208 {
kevman 0:38ceb79fef03 209 ret = 1;
kevman 0:38ceb79fef03 210 goto exit;
kevman 0:38ceb79fef03 211 }
kevman 0:38ceb79fef03 212
kevman 0:38ceb79fef03 213 cur = cache->chain;
kevman 0:38ceb79fef03 214 cache->chain = cur->next;
kevman 0:38ceb79fef03 215 cur->next = NULL;
kevman 0:38ceb79fef03 216 prv->next = cur;
kevman 0:38ceb79fef03 217 }
kevman 0:38ceb79fef03 218 #endif /* MBEDTLS_HAVE_TIME */
kevman 0:38ceb79fef03 219 else
kevman 0:38ceb79fef03 220 {
kevman 0:38ceb79fef03 221 /*
kevman 0:38ceb79fef03 222 * max_entries not reached, create new entry
kevman 0:38ceb79fef03 223 */
kevman 0:38ceb79fef03 224 cur = mbedtls_calloc( 1, sizeof(mbedtls_ssl_cache_entry) );
kevman 0:38ceb79fef03 225 if( cur == NULL )
kevman 0:38ceb79fef03 226 {
kevman 0:38ceb79fef03 227 ret = 1;
kevman 0:38ceb79fef03 228 goto exit;
kevman 0:38ceb79fef03 229 }
kevman 0:38ceb79fef03 230
kevman 0:38ceb79fef03 231 if( prv == NULL )
kevman 0:38ceb79fef03 232 cache->chain = cur;
kevman 0:38ceb79fef03 233 else
kevman 0:38ceb79fef03 234 prv->next = cur;
kevman 0:38ceb79fef03 235 }
kevman 0:38ceb79fef03 236
kevman 0:38ceb79fef03 237 #if defined(MBEDTLS_HAVE_TIME)
kevman 0:38ceb79fef03 238 cur->timestamp = t;
kevman 0:38ceb79fef03 239 #endif
kevman 0:38ceb79fef03 240 }
kevman 0:38ceb79fef03 241
kevman 0:38ceb79fef03 242 memcpy( &cur->session, session, sizeof( mbedtls_ssl_session ) );
kevman 0:38ceb79fef03 243
kevman 0:38ceb79fef03 244 #if defined(MBEDTLS_X509_CRT_PARSE_C)
kevman 0:38ceb79fef03 245 /*
kevman 0:38ceb79fef03 246 * If we're reusing an entry, free its certificate first
kevman 0:38ceb79fef03 247 */
kevman 0:38ceb79fef03 248 if( cur->peer_cert.p != NULL )
kevman 0:38ceb79fef03 249 {
kevman 0:38ceb79fef03 250 mbedtls_free( cur->peer_cert.p );
kevman 0:38ceb79fef03 251 memset( &cur->peer_cert, 0, sizeof(mbedtls_x509_buf) );
kevman 0:38ceb79fef03 252 }
kevman 0:38ceb79fef03 253
kevman 0:38ceb79fef03 254 /*
kevman 0:38ceb79fef03 255 * Store peer certificate
kevman 0:38ceb79fef03 256 */
kevman 0:38ceb79fef03 257 if( session->peer_cert != NULL )
kevman 0:38ceb79fef03 258 {
kevman 0:38ceb79fef03 259 cur->peer_cert.p = mbedtls_calloc( 1, session->peer_cert->raw.len );
kevman 0:38ceb79fef03 260 if( cur->peer_cert.p == NULL )
kevman 0:38ceb79fef03 261 {
kevman 0:38ceb79fef03 262 ret = 1;
kevman 0:38ceb79fef03 263 goto exit;
kevman 0:38ceb79fef03 264 }
kevman 0:38ceb79fef03 265
kevman 0:38ceb79fef03 266 memcpy( cur->peer_cert.p, session->peer_cert->raw.p,
kevman 0:38ceb79fef03 267 session->peer_cert->raw.len );
kevman 0:38ceb79fef03 268 cur->peer_cert.len = session->peer_cert->raw.len;
kevman 0:38ceb79fef03 269
kevman 0:38ceb79fef03 270 cur->session.peer_cert = NULL;
kevman 0:38ceb79fef03 271 }
kevman 0:38ceb79fef03 272 #endif /* MBEDTLS_X509_CRT_PARSE_C */
kevman 0:38ceb79fef03 273
kevman 0:38ceb79fef03 274 ret = 0;
kevman 0:38ceb79fef03 275
kevman 0:38ceb79fef03 276 exit:
kevman 0:38ceb79fef03 277 #if defined(MBEDTLS_THREADING_C)
kevman 0:38ceb79fef03 278 if( mbedtls_mutex_unlock( &cache->mutex ) != 0 )
kevman 0:38ceb79fef03 279 ret = 1;
kevman 0:38ceb79fef03 280 #endif
kevman 0:38ceb79fef03 281
kevman 0:38ceb79fef03 282 return( ret );
kevman 0:38ceb79fef03 283 }
kevman 0:38ceb79fef03 284
kevman 0:38ceb79fef03 285 #if defined(MBEDTLS_HAVE_TIME)
kevman 0:38ceb79fef03 286 void mbedtls_ssl_cache_set_timeout( mbedtls_ssl_cache_context *cache, int timeout )
kevman 0:38ceb79fef03 287 {
kevman 0:38ceb79fef03 288 if( timeout < 0 ) timeout = 0;
kevman 0:38ceb79fef03 289
kevman 0:38ceb79fef03 290 cache->timeout = timeout;
kevman 0:38ceb79fef03 291 }
kevman 0:38ceb79fef03 292 #endif /* MBEDTLS_HAVE_TIME */
kevman 0:38ceb79fef03 293
kevman 0:38ceb79fef03 294 void mbedtls_ssl_cache_set_max_entries( mbedtls_ssl_cache_context *cache, int max )
kevman 0:38ceb79fef03 295 {
kevman 0:38ceb79fef03 296 if( max < 0 ) max = 0;
kevman 0:38ceb79fef03 297
kevman 0:38ceb79fef03 298 cache->max_entries = max;
kevman 0:38ceb79fef03 299 }
kevman 0:38ceb79fef03 300
kevman 0:38ceb79fef03 301 void mbedtls_ssl_cache_free( mbedtls_ssl_cache_context *cache )
kevman 0:38ceb79fef03 302 {
kevman 0:38ceb79fef03 303 mbedtls_ssl_cache_entry *cur, *prv;
kevman 0:38ceb79fef03 304
kevman 0:38ceb79fef03 305 cur = cache->chain;
kevman 0:38ceb79fef03 306
kevman 0:38ceb79fef03 307 while( cur != NULL )
kevman 0:38ceb79fef03 308 {
kevman 0:38ceb79fef03 309 prv = cur;
kevman 0:38ceb79fef03 310 cur = cur->next;
kevman 0:38ceb79fef03 311
kevman 0:38ceb79fef03 312 mbedtls_ssl_session_free( &prv->session );
kevman 0:38ceb79fef03 313
kevman 0:38ceb79fef03 314 #if defined(MBEDTLS_X509_CRT_PARSE_C)
kevman 0:38ceb79fef03 315 mbedtls_free( prv->peer_cert.p );
kevman 0:38ceb79fef03 316 #endif /* MBEDTLS_X509_CRT_PARSE_C */
kevman 0:38ceb79fef03 317
kevman 0:38ceb79fef03 318 mbedtls_free( prv );
kevman 0:38ceb79fef03 319 }
kevman 0:38ceb79fef03 320
kevman 0:38ceb79fef03 321 #if defined(MBEDTLS_THREADING_C)
kevman 0:38ceb79fef03 322 mbedtls_mutex_free( &cache->mutex );
kevman 0:38ceb79fef03 323 #endif
kevman 0:38ceb79fef03 324 cache->chain = NULL;
kevman 0:38ceb79fef03 325 }
kevman 0:38ceb79fef03 326
kevman 0:38ceb79fef03 327 #endif /* MBEDTLS_SSL_CACHE_C */