ssl_ticket.h 4.2 KB

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