ssl_cookie.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. /**
  2. * \file ssl_cookie.h
  3. *
  4. * \brief DTLS cookie callbacks 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_COOKIE_H
  25. #define MBEDTLS_SSL_COOKIE_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. #ifndef MBEDTLS_SSL_COOKIE_TIMEOUT
  43. #define MBEDTLS_SSL_COOKIE_TIMEOUT 60 /**< Default expiration delay of DTLS cookies, in seconds if HAVE_TIME, or in number of cookies issued */
  44. #endif
  45. /* \} name SECTION: Module settings */
  46. #ifdef __cplusplus
  47. extern "C" {
  48. #endif
  49. /**
  50. * \brief Context for the default cookie functions.
  51. */
  52. typedef struct mbedtls_ssl_cookie_ctx
  53. {
  54. mbedtls_md_context_t hmac_ctx; /*!< context for the HMAC portion */
  55. #if !defined(MBEDTLS_HAVE_TIME)
  56. unsigned long serial; /*!< serial number for expiration */
  57. #endif
  58. unsigned long timeout; /*!< timeout delay, in seconds if HAVE_TIME,
  59. or in number of tickets issued */
  60. #if defined(MBEDTLS_THREADING_C)
  61. mbedtls_threading_mutex_t mutex;
  62. #endif
  63. } mbedtls_ssl_cookie_ctx;
  64. /**
  65. * \brief Initialize cookie context
  66. */
  67. void mbedtls_ssl_cookie_init( mbedtls_ssl_cookie_ctx *ctx );
  68. /**
  69. * \brief Setup cookie context (generate keys)
  70. */
  71. int mbedtls_ssl_cookie_setup( mbedtls_ssl_cookie_ctx *ctx,
  72. int (*f_rng)(void *, unsigned char *, size_t),
  73. void *p_rng );
  74. /**
  75. * \brief Set expiration delay for cookies
  76. * (Default MBEDTLS_SSL_COOKIE_TIMEOUT)
  77. *
  78. * \param ctx Cookie contex
  79. * \param delay Delay, in seconds if HAVE_TIME, or in number of cookies
  80. * issued in the meantime.
  81. * 0 to disable expiration (NOT recommended)
  82. */
  83. void mbedtls_ssl_cookie_set_timeout( mbedtls_ssl_cookie_ctx *ctx, unsigned long delay );
  84. /**
  85. * \brief Free cookie context
  86. */
  87. void mbedtls_ssl_cookie_free( mbedtls_ssl_cookie_ctx *ctx );
  88. /**
  89. * \brief Generate cookie, see \c mbedtls_ssl_cookie_write_t
  90. */
  91. mbedtls_ssl_cookie_write_t mbedtls_ssl_cookie_write;
  92. /**
  93. * \brief Verify cookie, see \c mbedtls_ssl_cookie_write_t
  94. */
  95. mbedtls_ssl_cookie_check_t mbedtls_ssl_cookie_check;
  96. #ifdef __cplusplus
  97. }
  98. #endif
  99. #endif /* ssl_cookie.h */