ssl_cache.h 4.1 KB

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