Austin Blackstone / Mbed 2 deprecated client-lwip-lightswitch-demo-expanded

mbed client lightswitch demo

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of mbed-client-classic-example-lwip by Austin Blackstone

mbedtls/mbedtls/ssl_cache.h@11:cada08fc8a70, 2016-06-09 (annotated)

Committer:
mbedAustin
Date:
Thu Jun 09 17:08:36 2016 +0000
Revision:
11:cada08fc8a70
Commit for public Consumption

Who changed what in which revision?

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