ssl_cookie.h 3.1 KB

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