ssl_ticket.h 4.3 KB

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