<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mbed TLS v2.7.3: ssl_cookie.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mbed TLS v2.7.3
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ssl_cookie.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="ssl__cookie_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/*</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * SPDX-License-Identifier: Apache-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * not use this file except in compliance with the License.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * This file is part of mbed TLS (https://tls.mbed.org)</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef MBEDTLS_SSL_COOKIE_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define MBEDTLS_SSL_COOKIE_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="ssl_8h.html">ssl.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#if defined(MBEDTLS_THREADING_C)</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="threading_8h.html">threading.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#ifndef MBEDTLS_SSL_COOKIE_TIMEOUT</span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="ssl__cookie_8h.html#ae8066a424d7e37be9243c96dac2fc18a"> 41</a></span> <span class="preprocessor">#define MBEDTLS_SSL_COOKIE_TIMEOUT 60 </span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/* \} name SECTION: Module settings */</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structmbedtls__ssl__cookie__ctx.html"> 53</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> {</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structmbedtls__ssl__cookie__ctx.html#a3142057d5ce904db6ee134ff6d5f3b7c"> 55</a></span>  <a class="code" href="structmbedtls__md__context__t.html">mbedtls_md_context_t</a> <a class="code" href="structmbedtls__ssl__cookie__ctx.html#a3142057d5ce904db6ee134ff6d5f3b7c">hmac_ctx</a>; </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#if !defined(MBEDTLS_HAVE_TIME)</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> serial; </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structmbedtls__ssl__cookie__ctx.html#adf87598d619f8fcf161965301c423ffb"> 59</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structmbedtls__ssl__cookie__ctx.html#adf87598d619f8fcf161965301c423ffb">timeout</a>; </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#if defined(MBEDTLS_THREADING_C)</span></div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structmbedtls__ssl__cookie__ctx.html#a8bf0a90a06340538c0eebbb5eb0545fc"> 63</a></span>  <a class="code" href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a> <a class="code" href="structmbedtls__ssl__cookie__ctx.html#a8bf0a90a06340538c0eebbb5eb0545fc">mutex</a>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> } <a class="code" href="structmbedtls__ssl__cookie__ctx.html">mbedtls_ssl_cookie_ctx</a>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">void</span> <a class="code" href="ssl__cookie_8h.html#affed42a7313e08576aad621f25d5c4f3">mbedtls_ssl_cookie_init</a>( <a class="code" href="structmbedtls__ssl__cookie__ctx.html">mbedtls_ssl_cookie_ctx</a> *ctx );</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">int</span> <a class="code" href="ssl__cookie_8h.html#ac81843a6bd31b31765639b65329d6b69">mbedtls_ssl_cookie_setup</a>( <a class="code" href="structmbedtls__ssl__cookie__ctx.html">mbedtls_ssl_cookie_ctx</a> *ctx,</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">int</span> (*f_rng)(<span class="keywordtype">void</span> *, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>),</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span> *p_rng );</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">void</span> <a class="code" href="ssl__cookie_8h.html#a5ae5d375a80fbe6f6f1b219c1b1dc8bb">mbedtls_ssl_cookie_set_timeout</a>( <a class="code" href="structmbedtls__ssl__cookie__ctx.html">mbedtls_ssl_cookie_ctx</a> *ctx, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> delay );</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">void</span> <a class="code" href="ssl__cookie_8h.html#a77d57052186940783e056f5ca95bda03">mbedtls_ssl_cookie_free</a>( <a class="code" href="structmbedtls__ssl__cookie__ctx.html">mbedtls_ssl_cookie_ctx</a> *ctx );</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="ssl__cookie_8h.html#a132e60f12cd3465264d283042cabe6d2"> 98</a></span> <a class="code" href="ssl_8h.html#a536f8b89936f26732150b00639a47ff0">mbedtls_ssl_cookie_write_t</a> <a class="code" href="ssl__cookie_8h.html#a132e60f12cd3465264d283042cabe6d2">mbedtls_ssl_cookie_write</a>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="ssl__cookie_8h.html#ac83489027c04984e12f89b1b29eac27b"> 103</a></span> <a class="code" href="ssl_8h.html#a9cfda5aee70d6c2c19a8dfb5af900d80">mbedtls_ssl_cookie_check_t</a> <a class="code" href="ssl__cookie_8h.html#ac83489027c04984e12f89b1b29eac27b">mbedtls_ssl_cookie_check</a>;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#endif </span><span class="comment">/* ssl_cookie.h */</span><span class="preprocessor"></span></div><div class="ttc" id="ssl_8h_html_a536f8b89936f26732150b00639a47ff0"><div class="ttname"><a href="ssl_8h.html#a536f8b89936f26732150b00639a47ff0">mbedtls_ssl_cookie_write_t</a></div><div class="ttdeci">int mbedtls_ssl_cookie_write_t(void *ctx, unsigned char **p, unsigned char *end, const unsigned char *info, size_t ilen)</div><div class="ttdoc">Callback type: generate a cookie. </div><div class="ttdef"><b>Definition:</b> <a href="ssl_8h_source.html#l01314">ssl.h:1314</a></div></div>
<div class="ttc" id="ssl__cookie_8h_html_ac81843a6bd31b31765639b65329d6b69"><div class="ttname"><a href="ssl__cookie_8h.html#ac81843a6bd31b31765639b65329d6b69">mbedtls_ssl_cookie_setup</a></div><div class="ttdeci">int mbedtls_ssl_cookie_setup(mbedtls_ssl_cookie_ctx *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)</div><div class="ttdoc">Setup cookie context (generate keys) </div></div>
<div class="ttc" id="ssl_8h_html_a9cfda5aee70d6c2c19a8dfb5af900d80"><div class="ttname"><a href="ssl_8h.html#a9cfda5aee70d6c2c19a8dfb5af900d80">mbedtls_ssl_cookie_check_t</a></div><div class="ttdeci">int mbedtls_ssl_cookie_check_t(void *ctx, const unsigned char *cookie, size_t clen, const unsigned char *info, size_t ilen)</div><div class="ttdoc">Callback type: verify a cookie. </div><div class="ttdef"><b>Definition:</b> <a href="ssl_8h_source.html#l01331">ssl.h:1331</a></div></div>
<div class="ttc" id="ssl__cookie_8h_html_ac83489027c04984e12f89b1b29eac27b"><div class="ttname"><a href="ssl__cookie_8h.html#ac83489027c04984e12f89b1b29eac27b">mbedtls_ssl_cookie_check</a></div><div class="ttdeci">mbedtls_ssl_cookie_check_t mbedtls_ssl_cookie_check</div><div class="ttdoc">Verify cookie, see mbedtls_ssl_cookie_write_t. </div><div class="ttdef"><b>Definition:</b> <a href="ssl__cookie_8h_source.html#l00103">ssl_cookie.h:103</a></div></div>
<div class="ttc" id="structmbedtls__ssl__cookie__ctx_html_a3142057d5ce904db6ee134ff6d5f3b7c"><div class="ttname"><a href="structmbedtls__ssl__cookie__ctx.html#a3142057d5ce904db6ee134ff6d5f3b7c">mbedtls_ssl_cookie_ctx::hmac_ctx</a></div><div class="ttdeci">mbedtls_md_context_t hmac_ctx</div><div class="ttdef"><b>Definition:</b> <a href="ssl__cookie_8h_source.html#l00055">ssl_cookie.h:55</a></div></div>
<div class="ttc" id="structmbedtls__ssl__cookie__ctx_html"><div class="ttname"><a href="structmbedtls__ssl__cookie__ctx.html">mbedtls_ssl_cookie_ctx</a></div><div class="ttdoc">Context for the default cookie functions. </div><div class="ttdef"><b>Definition:</b> <a href="ssl__cookie_8h_source.html#l00053">ssl_cookie.h:53</a></div></div>
<div class="ttc" id="structmbedtls__md__context__t_html"><div class="ttname"><a href="structmbedtls__md__context__t.html">mbedtls_md_context_t</a></div><div class="ttdef"><b>Definition:</b> <a href="md_8h_source.html#l00083">md.h:83</a></div></div>
<div class="ttc" id="ssl__cookie_8h_html_a5ae5d375a80fbe6f6f1b219c1b1dc8bb"><div class="ttname"><a href="ssl__cookie_8h.html#a5ae5d375a80fbe6f6f1b219c1b1dc8bb">mbedtls_ssl_cookie_set_timeout</a></div><div class="ttdeci">void mbedtls_ssl_cookie_set_timeout(mbedtls_ssl_cookie_ctx *ctx, unsigned long delay)</div><div class="ttdoc">Set expiration delay for cookies (Default MBEDTLS_SSL_COOKIE_TIMEOUT) </div></div>
<div class="ttc" id="threading_8h_html"><div class="ttname"><a href="threading_8h.html">threading.h</a></div><div class="ttdoc">Threading abstraction layer. </div></div>
<div class="ttc" id="structmbedtls__ssl__cookie__ctx_html_a8bf0a90a06340538c0eebbb5eb0545fc"><div class="ttname"><a href="structmbedtls__ssl__cookie__ctx.html#a8bf0a90a06340538c0eebbb5eb0545fc">mbedtls_ssl_cookie_ctx::mutex</a></div><div class="ttdeci">mbedtls_threading_mutex_t mutex</div><div class="ttdef"><b>Definition:</b> <a href="ssl__cookie_8h_source.html#l00063">ssl_cookie.h:63</a></div></div>
<div class="ttc" id="structmbedtls__threading__mutex__t_html"><div class="ttname"><a href="structmbedtls__threading__mutex__t.html">mbedtls_threading_mutex_t</a></div><div class="ttdef"><b>Definition:</b> <a href="threading_8h_source.html#l00045">threading.h:45</a></div></div>
<div class="ttc" id="ssl__cookie_8h_html_a132e60f12cd3465264d283042cabe6d2"><div class="ttname"><a href="ssl__cookie_8h.html#a132e60f12cd3465264d283042cabe6d2">mbedtls_ssl_cookie_write</a></div><div class="ttdeci">mbedtls_ssl_cookie_write_t mbedtls_ssl_cookie_write</div><div class="ttdoc">Generate cookie, see mbedtls_ssl_cookie_write_t. </div><div class="ttdef"><b>Definition:</b> <a href="ssl__cookie_8h_source.html#l00098">ssl_cookie.h:98</a></div></div>
<div class="ttc" id="ssl__cookie_8h_html_a77d57052186940783e056f5ca95bda03"><div class="ttname"><a href="ssl__cookie_8h.html#a77d57052186940783e056f5ca95bda03">mbedtls_ssl_cookie_free</a></div><div class="ttdeci">void mbedtls_ssl_cookie_free(mbedtls_ssl_cookie_ctx *ctx)</div><div class="ttdoc">Free cookie context. </div></div>
<div class="ttc" id="ssl__cookie_8h_html_affed42a7313e08576aad621f25d5c4f3"><div class="ttname"><a href="ssl__cookie_8h.html#affed42a7313e08576aad621f25d5c4f3">mbedtls_ssl_cookie_init</a></div><div class="ttdeci">void mbedtls_ssl_cookie_init(mbedtls_ssl_cookie_ctx *ctx)</div><div class="ttdoc">Initialize cookie context. </div></div>
<div class="ttc" id="ssl_8h_html"><div class="ttname"><a href="ssl_8h.html">ssl.h</a></div><div class="ttdoc">SSL/TLS functions. </div></div>
<div class="ttc" id="structmbedtls__ssl__cookie__ctx_html_adf87598d619f8fcf161965301c423ffb"><div class="ttname"><a href="structmbedtls__ssl__cookie__ctx.html#adf87598d619f8fcf161965301c423ffb">mbedtls_ssl_cookie_ctx::timeout</a></div><div class="ttdeci">unsigned long timeout</div><div class="ttdef"><b>Definition:</b> <a href="ssl__cookie_8h_source.html#l00059">ssl_cookie.h:59</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 8 2018 21:08:41 for mbed TLS v2.7.3 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
f835bee5b8b7ec08e20fae17cab51e63
>
files
>
484
