Mbed TLS v2.28.5
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
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 #ifndef MBEDTLS_SSL_TICKET_H
23 #define MBEDTLS_SSL_TICKET_H
24 
25 #if !defined(MBEDTLS_CONFIG_FILE)
26 #include "mbedtls/config.h"
27 #else
28 #include MBEDTLS_CONFIG_FILE
29 #endif
30 
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 
37 #include "mbedtls/ssl.h"
38 #include "mbedtls/cipher.h"
39 
40 #if defined(MBEDTLS_THREADING_C)
41 #include "mbedtls/threading.h"
42 #endif
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
51 typedef struct mbedtls_ssl_ticket_key {
52  unsigned char name[4];
53  uint32_t generation_time;
55 }
57 
63  unsigned char active;
65  uint32_t ticket_lifetime;
68  int (*f_rng)(void *, unsigned char *, size_t);
69  void *p_rng;
71 #if defined(MBEDTLS_THREADING_C)
73 #endif
74 }
76 
85 
109  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
110  mbedtls_cipher_type_t cipher,
111  uint32_t lifetime);
112 
119 
126 
133 
134 #ifdef __cplusplus
135 }
136 #endif
137 
138 #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:2125
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:68
mbedtls_ssl_ticket_key keys[2]
Definition: ssl_ticket.h:62
Configuration options (set of defines)
uint32_t generation_time
Definition: ssl_ticket.h:53
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:110
Threading abstraction layer.
mbedtls_ssl_ticket_parse_t mbedtls_ssl_ticket_parse
Implementation of the ticket parse callback.
Definition: ssl_ticket.h:125
mbedtls_threading_mutex_t mutex
Definition: ssl_ticket.h:72
mbedtls_ssl_ticket_write_t mbedtls_ssl_ticket_write
Implementation of the ticket write callback.
Definition: ssl_ticket.h:118
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:51
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:2031
mbedtls_cipher_context_t ctx
Definition: ssl_ticket.h:54
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:61
unsigned char name[4]
Definition: ssl_ticket.h:52