ssl_ticket.h 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. /**
  2. * \file ssl_ticket.h
  3. *
  4. * \brief TLS server ticket 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_TICKET_H
  25. #define MBEDTLS_SSL_TICKET_H
  26. /*
  27. * This implementation of the session ticket callbacks includes key
  28. * management, rotating the keys periodically in order to preserve forward
  29. * secrecy, when MBEDTLS_HAVE_TIME is defined.
  30. */
  31. #include "ssl.h"
  32. #include "cipher.h"
  33. #if defined(MBEDTLS_THREADING_C)
  34. #include "threading.h"
  35. #endif
  36. #ifdef __cplusplus
  37. extern "C" {
  38. #endif
  39. /**
  40. * \brief Information for session ticket protection
  41. */
  42. typedef struct
  43. {
  44. unsigned char name[4]; /*!< random key identifier */
  45. uint32_t generation_time; /*!< key generation timestamp (seconds) */
  46. mbedtls_cipher_context_t ctx; /*!< context for auth enc/decryption */
  47. }
  48. mbedtls_ssl_ticket_key;
  49. /**
  50. * \brief Context for session ticket handling functions
  51. */
  52. typedef struct
  53. {
  54. mbedtls_ssl_ticket_key keys[2]; /*!< ticket protection keys */
  55. unsigned char active; /*!< index of the currently active key */
  56. uint32_t ticket_lifetime; /*!< lifetime of tickets in seconds */
  57. /** Callback for getting (pseudo-)random numbers */
  58. int (*f_rng)(void *, unsigned char *, size_t);
  59. void *p_rng; /*!< context for the RNG function */
  60. #if defined(MBEDTLS_THREADING_C)
  61. mbedtls_threading_mutex_t mutex;
  62. #endif
  63. }
  64. mbedtls_ssl_ticket_context;
  65. /**
  66. * \brief Initialize a ticket context.
  67. * (Just make it ready for mbedtls_ssl_ticket_setup()
  68. * or mbedtls_ssl_ticket_free().)
  69. *
  70. * \param ctx Context to be initialized
  71. */
  72. void mbedtls_ssl_ticket_init( mbedtls_ssl_ticket_context *ctx );
  73. /**
  74. * \brief Prepare context to be actually used
  75. *
  76. * \param ctx Context to be set up
  77. * \param f_rng RNG callback function
  78. * \param p_rng RNG callback context
  79. * \param cipher AEAD cipher to use for ticket protection.
  80. * Recommended value: MBEDTLS_CIPHER_AES_256_GCM.
  81. * \param lifetime Tickets lifetime in seconds
  82. * Recommended value: 86400 (one day).
  83. *
  84. * \note It is highly recommended to select a cipher that is at
  85. * least as strong as the the strongest ciphersuite
  86. * supported. Usually that means a 256-bit key.
  87. *
  88. * \note The lifetime of the keys is twice the lifetime of tickets.
  89. * It is recommended to pick a reasonnable lifetime so as not
  90. * to negate the benefits of forward secrecy.
  91. *
  92. * \return 0 if successful,
  93. * or a specific MBEDTLS_ERR_XXX error code
  94. */
  95. int mbedtls_ssl_ticket_setup( mbedtls_ssl_ticket_context *ctx,
  96. int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
  97. mbedtls_cipher_type_t cipher,
  98. uint32_t lifetime );
  99. /**
  100. * \brief Implementation of the ticket write callback
  101. *
  102. * \note See \c mbedlts_ssl_ticket_write_t for description
  103. */
  104. mbedtls_ssl_ticket_write_t mbedtls_ssl_ticket_write;
  105. /**
  106. * \brief Implementation of the ticket parse callback
  107. *
  108. * \note See \c mbedlts_ssl_ticket_parse_t for description
  109. */
  110. mbedtls_ssl_ticket_parse_t mbedtls_ssl_ticket_parse;
  111. /**
  112. * \brief Free a context's content and zeroize it.
  113. *
  114. * \param ctx Context to be cleaned up
  115. */
  116. void mbedtls_ssl_ticket_free( mbedtls_ssl_ticket_context *ctx );
  117. #ifdef __cplusplus
  118. }
  119. #endif
  120. #endif /* ssl_ticket.h */