mbed TLS v2.16.12
ssl_ticket.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9  *
10  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  */
49 #ifndef MBEDTLS_SSL_TICKET_H
50 #define MBEDTLS_SSL_TICKET_H
51 
52 #if !defined(MBEDTLS_CONFIG_FILE)
53 #include "config.h"
54 #else
55 #include MBEDTLS_CONFIG_FILE
56 #endif
57 
58 /*
59  * This implementation of the session ticket callbacks includes key
60  * management, rotating the keys periodically in order to preserve forward
61  * secrecy, when MBEDTLS_HAVE_TIME is defined.
62  */
63 
64 #include "ssl.h"
65 #include "cipher.h"
66 
67 #if defined(MBEDTLS_THREADING_C)
68 #include "threading.h"
69 #endif
70 
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74 
78 typedef struct mbedtls_ssl_ticket_key
79 {
80  unsigned char name[4];
81  uint32_t generation_time;
83 }
85 
90 {
92  unsigned char active;
94  uint32_t ticket_lifetime;
97  int (*f_rng)(void *, unsigned char *, size_t);
98  void *p_rng;
100 #if defined(MBEDTLS_THREADING_C)
102 #endif
103 }
105 
114 
138  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
139  mbedtls_cipher_type_t cipher,
140  uint32_t lifetime );
141 
148 
155 
162 
163 #ifdef __cplusplus
164 }
165 #endif
166 
167 #endif /* ssl_ticket.h */
int mbedtls_ssl_ticket_parse_t(void *p_ticket, mbedtls_ssl_session *session, unsigned char *buf, size_t len)
Callback type: parse and load session ticket.
Definition: ssl.h:1651
struct mbedtls_ssl_ticket_key mbedtls_ssl_ticket_key
Information for session ticket protection.
int mbedtls_ssl_ticket_setup(mbedtls_ssl_ticket_context *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, mbedtls_cipher_type_t cipher, uint32_t lifetime)
Prepare context to be actually used.
int(* f_rng)(void *, unsigned char *, size_t)
Definition: ssl_ticket.h:97
mbedtls_ssl_ticket_key keys[2]
Definition: ssl_ticket.h:91
Configuration options (set of defines)
uint32_t generation_time
Definition: ssl_ticket.h:81
void mbedtls_ssl_ticket_init(mbedtls_ssl_ticket_context *ctx)
Initialize a ticket context. (Just make it ready for mbedtls_ssl_ticket_setup() or mbedtls_ssl_ticket...
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:137
Threading abstraction layer.
mbedtls_ssl_ticket_parse_t mbedtls_ssl_ticket_parse
Implementation of the ticket parse callback.
Definition: ssl_ticket.h:154
mbedtls_threading_mutex_t mutex
Definition: ssl_ticket.h:101
mbedtls_ssl_ticket_write_t mbedtls_ssl_ticket_write
Implementation of the ticket write callback.
Definition: ssl_ticket.h:147
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
struct mbedtls_ssl_ticket_context mbedtls_ssl_ticket_context
Context for session ticket handling functions.
Information for session ticket protection.
Definition: ssl_ticket.h:78
SSL/TLS functions.
int mbedtls_ssl_ticket_write_t(void *p_ticket, const mbedtls_ssl_session *session, unsigned char *start, const unsigned char *end, size_t *tlen, uint32_t *lifetime)
Callback type: generate and write session ticket.
Definition: ssl.h:1592
mbedtls_cipher_context_t ctx
Definition: ssl_ticket.h:82
void mbedtls_ssl_ticket_free(mbedtls_ssl_ticket_context *ctx)
Free a context's content and zeroize it.
Context for session ticket handling functions.
Definition: ssl_ticket.h:89
unsigned char name[4]
Definition: ssl_ticket.h:80