git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Source/mbedtls/include/mbedtls/ssl_cookie.h

   1 /**\r
   2  * \file ssl_cookie.h\r
   3  *\r
   4  * \brief DTLS cookie callbacks implementation\r
   5  */\r
   6 /*\r
   7  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved\r
   8  *  SPDX-License-Identifier: Apache-2.0\r
   9  *\r
  10  *  Licensed under the Apache License, Version 2.0 (the "License"); you may\r
  11  *  not use this file except in compliance with the License.\r
  12  *  You may obtain a copy of the License at\r
  13  *\r
  14  *  http://www.apache.org/licenses/LICENSE-2.0\r
  15  *\r
  16  *  Unless required by applicable law or agreed to in writing, software\r
  17  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT\r
  18  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  19  *  See the License for the specific language governing permissions and\r
  20  *  limitations under the License.\r
  21  *\r
  22  *  This file is part of mbed TLS (https://tls.mbed.org)\r
  23  */\r
  24 #ifndef MBEDTLS_SSL_COOKIE_H\r
  25 #define MBEDTLS_SSL_COOKIE_H\r
  26 \r
  27 #if !defined(MBEDTLS_CONFIG_FILE)\r
  28 #include "config.h"\r
  29 #else\r
  30 #include MBEDTLS_CONFIG_FILE\r
  31 #endif\r
  32 \r
  33 #include "ssl.h"\r
  34 \r
  35 #if defined(MBEDTLS_THREADING_C)\r
  36 #include "threading.h"\r
  37 #endif\r
  38 \r
  39 /**\r
  40  * \name SECTION: Module settings\r
  41  *\r
  42  * The configuration options you can set for this module are in this section.\r
  43  * Either change them in config.h or define them on the compiler command line.\r
  44  * \{\r
  45  */\r
  46 #ifndef MBEDTLS_SSL_COOKIE_TIMEOUT\r
  47 #define MBEDTLS_SSL_COOKIE_TIMEOUT     60 /**< Default expiration delay of DTLS cookies, in seconds if HAVE_TIME, or in number of cookies issued */\r
  48 #endif\r
  49 \r
  50 /* \} name SECTION: Module settings */\r
  51 \r
  52 #ifdef __cplusplus\r
  53 extern "C" {\r
  54 #endif\r
  55 \r
  56 /**\r
  57  * \brief          Context for the default cookie functions.\r
  58  */\r
  59 typedef struct mbedtls_ssl_cookie_ctx\r
  60 {\r
  61     mbedtls_md_context_t    hmac_ctx;   /*!< context for the HMAC portion   */\r
  62 #if !defined(MBEDTLS_HAVE_TIME)\r
  63     unsigned long   serial;     /*!< serial number for expiration   */\r
  64 #endif\r
  65     unsigned long   timeout;    /*!< timeout delay, in seconds if HAVE_TIME,\r
  66                                      or in number of tickets issued */\r
  67 \r
  68 #if defined(MBEDTLS_THREADING_C)\r
  69     mbedtls_threading_mutex_t mutex;\r
  70 #endif\r
  71 } mbedtls_ssl_cookie_ctx;\r
  72 \r
  73 /**\r
  74  * \brief          Initialize cookie context\r
  75  */\r
  76 void mbedtls_ssl_cookie_init( mbedtls_ssl_cookie_ctx *ctx );\r
  77 \r
  78 /**\r
  79  * \brief          Setup cookie context (generate keys)\r
  80  */\r
  81 int mbedtls_ssl_cookie_setup( mbedtls_ssl_cookie_ctx *ctx,\r
  82                       int (*f_rng)(void *, unsigned char *, size_t),\r
  83                       void *p_rng );\r
  84 \r
  85 /**\r
  86  * \brief          Set expiration delay for cookies\r
  87  *                 (Default MBEDTLS_SSL_COOKIE_TIMEOUT)\r
  88  *\r
  89  * \param ctx      Cookie contex\r
  90  * \param delay    Delay, in seconds if HAVE_TIME, or in number of cookies\r
  91  *                 issued in the meantime.\r
  92  *                 0 to disable expiration (NOT recommended)\r
  93  */\r
  94 void mbedtls_ssl_cookie_set_timeout( mbedtls_ssl_cookie_ctx *ctx, unsigned long delay );\r
  95 \r
  96 /**\r
  97  * \brief          Free cookie context\r
  98  */\r
  99 void mbedtls_ssl_cookie_free( mbedtls_ssl_cookie_ctx *ctx );\r
 100 \r
 101 /**\r
 102  * \brief          Generate cookie, see \c mbedtls_ssl_cookie_write_t\r
 103  */\r
 104 mbedtls_ssl_cookie_write_t mbedtls_ssl_cookie_write;\r
 105 \r
 106 /**\r
 107  * \brief          Verify cookie, see \c mbedtls_ssl_cookie_write_t\r
 108  */\r
 109 mbedtls_ssl_cookie_check_t mbedtls_ssl_cookie_check;\r
 110 \r
 111 #ifdef __cplusplus\r
 112 }\r
 113 #endif\r
 114 \r
 115 #endif /* ssl_cookie.h */\r