blob: c5b80d936e639a386c0a76c4a39cbd3e2d5d9a9a [file] [log] [blame]
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +02001/**
2 * \file ssl_cookie.h
3 *
4 * \brief DTLS cookie callbacks implementation
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * 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.
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#ifndef MBEDTLS_SSL_COOKIE_H
23#define MBEDTLS_SSL_COOKIE_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020024#include "mbedtls/private_access.h"
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020025
Bence Szépkútic662b362021-05-27 11:25:03 +020026#include "mbedtls/build_info.h"
Ron Eldor8b0cf2e2018-02-14 16:02:41 +020027
Jaeden Amero6609aef2019-07-04 20:01:14 +010028#include "mbedtls/ssl.h"
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020029
Neil Armstrongc0db7622022-03-22 10:38:58 +010030#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2a84dfd2015-05-28 15:48:09 +020031#if defined(MBEDTLS_THREADING_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010032#include "mbedtls/threading.h"
Manuel Pégourié-Gonnard2a84dfd2015-05-28 15:48:09 +020033#endif
Neil Armstrongc0db7622022-03-22 10:38:58 +010034#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard2a84dfd2015-05-28 15:48:09 +020035
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020036/**
37 * \name SECTION: Module settings
38 *
39 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020040 * Either change them in mbedtls_config.h or define them on the compiler command line.
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020041 * \{
42 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#ifndef MBEDTLS_SSL_COOKIE_TIMEOUT
44#define MBEDTLS_SSL_COOKIE_TIMEOUT 60 /**< Default expiration delay of DTLS cookies, in seconds if HAVE_TIME, or in number of cookies issued */
Manuel Pégourié-Gonnardbef8f092014-07-23 23:40:29 +020045#endif
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020046
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +010047/** \} name SECTION: Module settings */
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020048
49#ifdef __cplusplus
50extern "C" {
51#endif
52
53/**
54 * \brief Context for the default cookie functions.
55 */
Dawid Drozd428cc522018-07-24 10:02:47 +020056typedef struct mbedtls_ssl_cookie_ctx
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020057{
Neil Armstrongbca99ee2022-03-04 10:20:20 +010058#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong488a40e2022-03-22 10:41:38 +010059 mbedtls_svc_key_id_t MBEDTLS_PRIVATE(psa_hmac_key); /*!< key id for the HMAC portion */
Neil Armstrongbca99ee2022-03-04 10:20:20 +010060 psa_algorithm_t MBEDTLS_PRIVATE(psa_hmac_alg); /*!< key algorithm for the HMAC portion */
Neil Armstrong77b69ab2022-03-04 14:35:13 +010061#else
Mateusz Starzyk846f0212021-05-19 19:44:07 +020062 mbedtls_md_context_t MBEDTLS_PRIVATE(hmac_ctx); /*!< context for the HMAC portion */
Neil Armstrong77b69ab2022-03-04 14:35:13 +010063#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064#if !defined(MBEDTLS_HAVE_TIME)
Mateusz Starzyk2abe51c2021-06-07 11:08:01 +020065 unsigned long MBEDTLS_PRIVATE(serial); /*!< serial number for expiration */
Manuel Pégourié-Gonnarde9030812014-07-23 21:29:11 +020066#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +020067 unsigned long MBEDTLS_PRIVATE(timeout); /*!< timeout delay, in seconds if HAVE_TIME,
Manuel Pégourié-Gonnardbef8f092014-07-23 23:40:29 +020068 or in number of tickets issued */
69
Neil Armstrong7cd02702022-03-04 15:08:43 +010070#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2a84dfd2015-05-28 15:48:09 +020071#if defined(MBEDTLS_THREADING_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +020072 mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
Manuel Pégourié-Gonnard2a84dfd2015-05-28 15:48:09 +020073#endif
Neil Armstrong7cd02702022-03-04 15:08:43 +010074#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020075} mbedtls_ssl_cookie_ctx;
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020076
77/**
78 * \brief Initialize cookie context
79 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020080void mbedtls_ssl_cookie_init( mbedtls_ssl_cookie_ctx *ctx );
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020081
82/**
83 * \brief Setup cookie context (generate keys)
84 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020085int mbedtls_ssl_cookie_setup( mbedtls_ssl_cookie_ctx *ctx,
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +020086 int (*f_rng)(void *, unsigned char *, size_t),
87 void *p_rng );
88
89/**
Manuel Pégourié-Gonnardbef8f092014-07-23 23:40:29 +020090 * \brief Set expiration delay for cookies
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020091 * (Default MBEDTLS_SSL_COOKIE_TIMEOUT)
Manuel Pégourié-Gonnardbef8f092014-07-23 23:40:29 +020092 *
93 * \param ctx Cookie contex
94 * \param delay Delay, in seconds if HAVE_TIME, or in number of cookies
95 * issued in the meantime.
96 * 0 to disable expiration (NOT recommended)
97 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020098void mbedtls_ssl_cookie_set_timeout( mbedtls_ssl_cookie_ctx *ctx, unsigned long delay );
Manuel Pégourié-Gonnardbef8f092014-07-23 23:40:29 +020099
100/**
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +0200101 * \brief Free cookie context
102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103void mbedtls_ssl_cookie_free( mbedtls_ssl_cookie_ctx *ctx );
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +0200104
105/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200106 * \brief Generate cookie, see \c mbedtls_ssl_cookie_write_t
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +0200107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200108mbedtls_ssl_cookie_write_t mbedtls_ssl_cookie_write;
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +0200109
110/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200111 * \brief Verify cookie, see \c mbedtls_ssl_cookie_write_t
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +0200112 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200113mbedtls_ssl_cookie_check_t mbedtls_ssl_cookie_check;
Manuel Pégourié-Gonnard232edd42014-07-23 16:56:27 +0200114
115#ifdef __cplusplus
116}
117#endif
118
119#endif /* ssl_cookie.h */