mbed TLS v2.16.3: ssl_cookie.h Source File

mbed TLS v2.16.3

ssl_cookie.h
Go to the documentation of this file.
1
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_COOKIE_H
25 #define MBEDTLS_SSL_COOKIE_H
26
27 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32
33 #include "ssl.h"
34
35 #if defined(MBEDTLS_THREADING_C)
36 #include "threading.h"
37 #endif
38
46 #ifndef MBEDTLS_SSL_COOKIE_TIMEOUT
47 #define MBEDTLS_SSL_COOKIE_TIMEOUT 60
48 #endif
49
50 /* \} name SECTION: Module settings */
51
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55
59 typedef struct mbedtls_ssl_cookie_ctx
60 {
61 mbedtls_md_context_t hmac_ctx;
62 #if !defined(MBEDTLS_HAVE_TIME)
63 unsigned long serial;
64 #endif
65 unsigned long timeout;
68 #if defined(MBEDTLS_THREADING_C)
69 mbedtls_threading_mutex_t mutex;
70 #endif
71 } mbedtls_ssl_cookie_ctx;
72
76 void mbedtls_ssl_cookie_init( mbedtls_ssl_cookie_ctx *ctx );
77
81 int mbedtls_ssl_cookie_setup( mbedtls_ssl_cookie_ctx *ctx,
82 int (*f_rng)(void *, unsigned char *, size_t),
83 void *p_rng );
84
94 void mbedtls_ssl_cookie_set_timeout( mbedtls_ssl_cookie_ctx *ctx, unsigned long delay );
95
99 void mbedtls_ssl_cookie_free( mbedtls_ssl_cookie_ctx *ctx );
100
104 mbedtls_ssl_cookie_write_t mbedtls_ssl_cookie_write;
105
109 mbedtls_ssl_cookie_check_t mbedtls_ssl_cookie_check;
110
111 #ifdef __cplusplus
112 }
113 #endif
114
115 #endif /* ssl_cookie.h */
mbedtls_ssl_cookie_setup
int mbedtls_ssl_cookie_setup(mbedtls_ssl_cookie_ctx *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Setup cookie context (generate keys)
mbedtls_ssl_cookie_init
void mbedtls_ssl_cookie_init(mbedtls_ssl_cookie_ctx *ctx)
Initialize cookie context.
mbedtls_ssl_cookie_set_timeout
void mbedtls_ssl_cookie_set_timeout(mbedtls_ssl_cookie_ctx *ctx, unsigned long delay)
Set expiration delay for cookies (Default MBEDTLS_SSL_COOKIE_TIMEOUT)
mbedtls_ssl_cookie_free
void mbedtls_ssl_cookie_free(mbedtls_ssl_cookie_ctx *ctx)
Free cookie context.
mbedtls_ssl_cookie_ctx::hmac_ctx
mbedtls_md_context_t hmac_ctx
Definition: ssl_cookie.h:61
mbedtls_ssl_cookie_check
mbedtls_ssl_cookie_check_t mbedtls_ssl_cookie_check
Verify cookie, see mbedtls_ssl_cookie_write_t.
Definition: ssl_cookie.h:109
mbedtls_ssl_cookie_ctx::timeout
unsigned long timeout
Definition: ssl_cookie.h:65
mbedtls_ssl_cookie_write
mbedtls_ssl_cookie_write_t mbedtls_ssl_cookie_write
Generate cookie, see mbedtls_ssl_cookie_write_t.
Definition: ssl_cookie.h:104
mbedtls_ssl_cookie_ctx
struct mbedtls_ssl_cookie_ctx mbedtls_ssl_cookie_ctx
Context for the default cookie functions.
ssl.h
SSL/TLS functions.
threading.h
Threading abstraction layer.
mbedtls_ssl_cookie_write_t
int mbedtls_ssl_cookie_write_t(void *ctx, unsigned char **p, unsigned char *end, const unsigned char *info, size_t ilen)
Callback type: generate a cookie.
Definition: ssl.h:1700
config.h
Configuration options (set of defines)
mbedtls_md_context_t
Definition: md.h:85
mbedtls_ssl_cookie_ctx
Context for the default cookie functions.
Definition: ssl_cookie.h:59
mbedtls_ssl_cookie_check_t
int mbedtls_ssl_cookie_check_t(void *ctx, const unsigned char *cookie, size_t clen, const unsigned char *info, size_t ilen)
Callback type: verify a cookie.
Definition: ssl.h:1717