ssl_cache.h 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  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. #if !defined(MBEDTLS_CONFIG_FILE)
  27. #include "config.h"
  28. #else
  29. #include MBEDTLS_CONFIG_FILE
  30. #endif
  31. #include "ssl.h"
  32. #if defined(MBEDTLS_THREADING_C)
  33. #include "threading.h"
  34. #endif
  35. /**
  36. * \name SECTION: Module settings
  37. *
  38. * The configuration options you can set for this module are in this section.
  39. * Either change them in config.h or define them on the compiler command line.
  40. * \{
  41. */
  42. #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT)
  43. #define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /*!< 1 day */
  44. #endif
  45. #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES)
  46. #define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /*!< Maximum entries in cache */
  47. #endif
  48. /* \} name SECTION: Module settings */
  49. #ifdef __cplusplus
  50. extern "C" {
  51. #endif
  52. typedef struct mbedtls_ssl_cache_context mbedtls_ssl_cache_context;
  53. typedef struct mbedtls_ssl_cache_entry mbedtls_ssl_cache_entry;
  54. /**
  55. * \brief This structure is used for storing cache entries
  56. */
  57. struct mbedtls_ssl_cache_entry
  58. {
  59. #if defined(MBEDTLS_HAVE_TIME)
  60. mbedtls_time_t timestamp; /*!< entry timestamp */
  61. #endif
  62. mbedtls_ssl_session session; /*!< entry session */
  63. #if defined(MBEDTLS_X509_CRT_PARSE_C)
  64. mbedtls_x509_buf peer_cert; /*!< entry peer_cert */
  65. #endif
  66. mbedtls_ssl_cache_entry *next; /*!< chain pointer */
  67. };
  68. /**
  69. * \brief Cache context
  70. */
  71. struct mbedtls_ssl_cache_context
  72. {
  73. mbedtls_ssl_cache_entry *chain; /*!< start of the chain */
  74. int timeout; /*!< cache entry timeout */
  75. int max_entries; /*!< maximum entries */
  76. #if defined(MBEDTLS_THREADING_C)
  77. mbedtls_threading_mutex_t mutex; /*!< mutex */
  78. #endif
  79. };
  80. /**
  81. * \brief Initialize an SSL cache context
  82. *
  83. * \param cache SSL cache context
  84. */
  85. void mbedtls_ssl_cache_init( mbedtls_ssl_cache_context *cache );
  86. /**
  87. * \brief Cache get callback implementation
  88. * (Thread-safe if MBEDTLS_THREADING_C is enabled)
  89. *
  90. * \param data SSL cache context
  91. * \param session session to retrieve entry for
  92. */
  93. int mbedtls_ssl_cache_get( void *data, mbedtls_ssl_session *session );
  94. /**
  95. * \brief Cache set callback implementation
  96. * (Thread-safe if MBEDTLS_THREADING_C is enabled)
  97. *
  98. * \param data SSL cache context
  99. * \param session session to store entry for
  100. */
  101. int mbedtls_ssl_cache_set( void *data, const mbedtls_ssl_session *session );
  102. #if defined(MBEDTLS_HAVE_TIME)
  103. /**
  104. * \brief Set the cache timeout
  105. * (Default: MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT (1 day))
  106. *
  107. * A timeout of 0 indicates no timeout.
  108. *
  109. * \param cache SSL cache context
  110. * \param timeout cache entry timeout in seconds
  111. */
  112. void mbedtls_ssl_cache_set_timeout( mbedtls_ssl_cache_context *cache, int timeout );
  113. #endif /* MBEDTLS_HAVE_TIME */
  114. /**
  115. * \brief Set the maximum number of cache entries
  116. * (Default: MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES (50))
  117. *
  118. * \param cache SSL cache context
  119. * \param max cache entry maximum
  120. */
  121. void mbedtls_ssl_cache_set_max_entries( mbedtls_ssl_cache_context *cache, int max );
  122. /**
  123. * \brief Free referenced items in a cache context and clear memory
  124. *
  125. * \param cache SSL cache context
  126. */
  127. void mbedtls_ssl_cache_free( mbedtls_ssl_cache_context *cache );
  128. #ifdef __cplusplus
  129. }
  130. #endif
  131. #endif /* ssl_cache.h */