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