ssl_cookie.h 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. /**
  2. * \file ssl_cookie.h
  3. *
  4. * \brief DTLS cookie callbacks implementation
  5. */
  6. /*
  7. * Copyright The Mbed TLS Contributors
  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. #ifndef MBEDTLS_SSL_COOKIE_H
  23. #define MBEDTLS_SSL_COOKIE_H
  24. #if !defined(MBEDTLS_CONFIG_FILE)
  25. #include "mbedtls/config.h"
  26. #else
  27. #include MBEDTLS_CONFIG_FILE
  28. #endif
  29. #include "mbedtls/ssl.h"
  30. #if defined(MBEDTLS_THREADING_C)
  31. #include "mbedtls/threading.h"
  32. #endif
  33. /**
  34. * \name SECTION: Module settings
  35. *
  36. * The configuration options you can set for this module are in this section.
  37. * Either change them in config.h or define them on the compiler command line.
  38. * \{
  39. */
  40. #ifndef MBEDTLS_SSL_COOKIE_TIMEOUT
  41. #define MBEDTLS_SSL_COOKIE_TIMEOUT 60 /**< Default expiration delay of DTLS cookies, in seconds if HAVE_TIME, or in number of cookies issued */
  42. #endif
  43. /* \} name SECTION: Module settings */
  44. #ifdef __cplusplus
  45. extern "C" {
  46. #endif
  47. /**
  48. * \brief Context for the default cookie functions.
  49. */
  50. typedef struct mbedtls_ssl_cookie_ctx
  51. {
  52. mbedtls_md_context_t hmac_ctx; /*!< context for the HMAC portion */
  53. #if !defined(MBEDTLS_HAVE_TIME)
  54. unsigned long serial; /*!< serial number for expiration */
  55. #endif
  56. unsigned long timeout; /*!< timeout delay, in seconds if HAVE_TIME,
  57. or in number of tickets issued */
  58. #if defined(MBEDTLS_THREADING_C)
  59. mbedtls_threading_mutex_t mutex;
  60. #endif
  61. } mbedtls_ssl_cookie_ctx;
  62. /**
  63. * \brief Initialize cookie context
  64. */
  65. void mbedtls_ssl_cookie_init( mbedtls_ssl_cookie_ctx *ctx );
  66. /**
  67. * \brief Setup cookie context (generate keys)
  68. */
  69. int mbedtls_ssl_cookie_setup( mbedtls_ssl_cookie_ctx *ctx,
  70. int (*f_rng)(void *, unsigned char *, size_t),
  71. void *p_rng );
  72. /**
  73. * \brief Set expiration delay for cookies
  74. * (Default MBEDTLS_SSL_COOKIE_TIMEOUT)
  75. *
  76. * \param ctx Cookie contex
  77. * \param delay Delay, in seconds if HAVE_TIME, or in number of cookies
  78. * issued in the meantime.
  79. * 0 to disable expiration (NOT recommended)
  80. */
  81. void mbedtls_ssl_cookie_set_timeout( mbedtls_ssl_cookie_ctx *ctx, unsigned long delay );
  82. /**
  83. * \brief Free cookie context
  84. */
  85. void mbedtls_ssl_cookie_free( mbedtls_ssl_cookie_ctx *ctx );
  86. /**
  87. * \brief Generate cookie, see \c mbedtls_ssl_cookie_write_t
  88. */
  89. mbedtls_ssl_cookie_write_t mbedtls_ssl_cookie_write;
  90. /**
  91. * \brief Verify cookie, see \c mbedtls_ssl_cookie_write_t
  92. */
  93. mbedtls_ssl_cookie_check_t mbedtls_ssl_cookie_check;
  94. #ifdef __cplusplus
  95. }
  96. #endif
  97. #endif /* ssl_cookie.h */