third_party/mbedtls/repo/include/mbedtls/ssl_cache.h

   1 /**
   2  * \file ssl_cache.h
   3  *
   4  * \brief SSL session cache implementation
   5  */
   6 /*
   7  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
   8  *  SPDX-License-Identifier: Apache-2.0
   9  *
  10  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
  11  *  not use this file except in compliance with the License.
  12  *  You may obtain a copy of the License at
  13  *
  14  *  http://www.apache.org/licenses/LICENSE-2.0
  15  *
  16  *  Unless required by applicable law or agreed to in writing, software
  17  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  18  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  *  See the License for the specific language governing permissions and
  20  *  limitations under the License.
  21  *
  22  *  This file is part of mbed TLS (https://tls.mbed.org)
  23  */
  24 #ifndef MBEDTLS_SSL_CACHE_H
  25 #define MBEDTLS_SSL_CACHE_H
  26
  27 #if !defined(MBEDTLS_CONFIG_FILE)
  28 #include "config.h"
  29 #else
  30 #include MBEDTLS_CONFIG_FILE
  31 #endif
  32
  33 #include "ssl.h"
  34
  35 #if defined(MBEDTLS_THREADING_C)
  36 #include "threading.h"
  37 #endif
  38
  39 /**
  40  * \name SECTION: Module settings
  41  *
  42  * The configuration options you can set for this module are in this section.
  43  * Either change them in config.h or define them on the compiler command line.
  44  * \{
  45  */
  46
  47 #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT)
  48 #define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT       86400   /*!< 1 day  */
  49 #endif
  50
  51 #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES)
  52 #define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES      50   /*!< Maximum entries in cache */
  53 #endif
  54
  55 /* \} name SECTION: Module settings */
  56
  57 #ifdef __cplusplus
  58 extern "C" {
  59 #endif
  60
  61 typedef struct mbedtls_ssl_cache_context mbedtls_ssl_cache_context;
  62 typedef struct mbedtls_ssl_cache_entry mbedtls_ssl_cache_entry;
  63
  64 /**
  65  * \brief   This structure is used for storing cache entries
  66  */
  67 struct mbedtls_ssl_cache_entry
  68 {
  69 #if defined(MBEDTLS_HAVE_TIME)
  70     mbedtls_time_t timestamp;           /*!< entry timestamp    */
  71 #endif
  72     mbedtls_ssl_session session;        /*!< entry session      */
  73 #if defined(MBEDTLS_X509_CRT_PARSE_C) && \
  74     defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
  75     mbedtls_x509_buf peer_cert;         /*!< entry peer_cert    */
  76 #endif
  77     mbedtls_ssl_cache_entry *next;      /*!< chain pointer      */
  78 };
  79
  80 /**
  81  * \brief Cache context
  82  */
  83 struct mbedtls_ssl_cache_context
  84 {
  85     mbedtls_ssl_cache_entry *chain;     /*!< start of the chain     */
  86     int timeout;                /*!< cache entry timeout    */
  87     int max_entries;            /*!< maximum entries        */
  88 #if defined(MBEDTLS_THREADING_C)
  89     mbedtls_threading_mutex_t mutex;    /*!< mutex                  */
  90 #endif
  91 };
  92
  93 /**
  94  * \brief          Initialize an SSL cache context
  95  *
  96  * \param cache    SSL cache context
  97  */
  98 void mbedtls_ssl_cache_init( mbedtls_ssl_cache_context *cache );
  99
 100 /**
 101  * \brief          Cache get callback implementation
 102  *                 (Thread-safe if MBEDTLS_THREADING_C is enabled)
 103  *
 104  * \param data     SSL cache context
 105  * \param session  session to retrieve entry for
 106  */
 107 int mbedtls_ssl_cache_get( void *data, mbedtls_ssl_session *session );
 108
 109 /**
 110  * \brief          Cache set callback implementation
 111  *                 (Thread-safe if MBEDTLS_THREADING_C is enabled)
 112  *
 113  * \param data     SSL cache context
 114  * \param session  session to store entry for
 115  */
 116 int mbedtls_ssl_cache_set( void *data, const mbedtls_ssl_session *session );
 117
 118 #if defined(MBEDTLS_HAVE_TIME)
 119 /**
 120  * \brief          Set the cache timeout
 121  *                 (Default: MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT (1 day))
 122  *
 123  *                 A timeout of 0 indicates no timeout.
 124  *
 125  * \param cache    SSL cache context
 126  * \param timeout  cache entry timeout in seconds
 127  */
 128 void mbedtls_ssl_cache_set_timeout( mbedtls_ssl_cache_context *cache, int timeout );
 129 #endif /* MBEDTLS_HAVE_TIME */
 130
 131 /**
 132  * \brief          Set the maximum number of cache entries
 133  *                 (Default: MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES (50))
 134  *
 135  * \param cache    SSL cache context
 136  * \param max      cache entry maximum
 137  */
 138 void mbedtls_ssl_cache_set_max_entries( mbedtls_ssl_cache_context *cache, int max );
 139
 140 /**
 141  * \brief          Free referenced items in a cache context and clear memory
 142  *
 143  * \param cache    SSL cache context
 144  */
 145 void mbedtls_ssl_cache_free( mbedtls_ssl_cache_context *cache );
 146
 147 #ifdef __cplusplus
 148 }
 149 #endif
 150
 151 #endif /* ssl_cache.h */