ssl_cookie.h 3.1 KB

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