<!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.5"/>
<title>PolarSSL v1.3.8: ssl_cache.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 style="padding-left: 0.5em;">
<div id="projectname">PolarSSL v1.3.8
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ssl_cache.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="ssl__cache_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="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#ifndef POLARSSL_SSL_CACHE_H</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="preprocessor">#define POLARSSL_SSL_CACHE_H</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="ssl_8h.html">ssl.h</a>"</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#if defined(POLARSSL_THREADING_C)</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="threading_8h.html">threading.h</a>"</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#if !defined(SSL_CACHE_DEFAULT_TIMEOUT)</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="ssl__cache_8h.html#a77f926737350e8e702a8323fee6abc90"> 45</a></span> <span class="preprocessor"></span><span class="preprocessor">#define SSL_CACHE_DEFAULT_TIMEOUT 86400 </span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#if !defined(SSL_CACHE_DEFAULT_MAX_ENTRIES)</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="ssl__cache_8h.html#ad90e356ca9b417005065a25871b6bd07"> 49</a></span> <span class="preprocessor"></span><span class="preprocessor">#define SSL_CACHE_DEFAULT_MAX_ENTRIES 50 </span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/* \} name SECTION: Module settings */</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="ssl__cache_8h.html#a5ea4a9067ba1f6748e55ff4e24a76dc2"> 58</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__ssl__cache__context.html">_ssl_cache_context</a> <a class="code" href="struct__ssl__cache__context.html">ssl_cache_context</a>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="ssl__cache_8h.html#aef87b89b5b33356cc12e0e3c5e482407"> 59</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__ssl__cache__entry.html">_ssl_cache_entry</a> <a class="code" href="struct__ssl__cache__entry.html">ssl_cache_entry</a>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="struct__ssl__cache__entry.html"> 64</a></span> <span class="keyword">struct </span><a class="code" href="struct__ssl__cache__entry.html">_ssl_cache_entry</a></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#if defined(POLARSSL_HAVE_TIME)</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="struct__ssl__cache__entry.html#a7b48c16f1680135bafc1a6ba66943f69"> 67</a></span> <span class="preprocessor"></span> time_t <a class="code" href="struct__ssl__cache__entry.html#a7b48c16f1680135bafc1a6ba66943f69">timestamp</a>; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="struct__ssl__cache__entry.html#a34b540657823287d607d8b0f67020829"> 69</a></span> <span class="preprocessor"></span> <a class="code" href="struct__ssl__session.html">ssl_session</a> <a class="code" href="struct__ssl__cache__entry.html#a34b540657823287d607d8b0f67020829">session</a>; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#if defined(POLARSSL_X509_CRT_PARSE_C)</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="struct__ssl__cache__entry.html#a270a4639d8f1668a2be9e58677f56e3b"> 71</a></span> <span class="preprocessor"></span> <a class="code" href="struct__asn1__buf.html">x509_buf</a> <a class="code" href="struct__ssl__cache__entry.html#a270a4639d8f1668a2be9e58677f56e3b">peer_cert</a>; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="struct__ssl__cache__entry.html#a124bf0874e17d1db3930561b3d61ed21"> 73</a></span> <span class="preprocessor"></span> <a class="code" href="struct__ssl__cache__entry.html">ssl_cache_entry</a> *<a class="code" href="struct__ssl__cache__entry.html#a124bf0874e17d1db3930561b3d61ed21">next</a>; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> };</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="struct__ssl__cache__context.html"> 79</a></span> <span class="keyword">struct </span><a class="code" href="struct__ssl__cache__context.html">_ssl_cache_context</a></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> {</div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="struct__ssl__cache__context.html#a3358141c7bc4b12356782104d77f9d5e"> 81</a></span>  <a class="code" href="struct__ssl__cache__entry.html">ssl_cache_entry</a> *<a class="code" href="struct__ssl__cache__context.html#a3358141c7bc4b12356782104d77f9d5e">chain</a>; </div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="struct__ssl__cache__context.html#a5e1d681bb6e351af475ca01120ebbe42"> 82</a></span>  <span class="keywordtype">int</span> <a class="code" href="struct__ssl__cache__context.html#a5e1d681bb6e351af475ca01120ebbe42">timeout</a>; </div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="struct__ssl__cache__context.html#ae54a1d8da77ffe39dc489e54172ce4d6"> 83</a></span>  <span class="keywordtype">int</span> <a class="code" href="struct__ssl__cache__context.html#ae54a1d8da77ffe39dc489e54172ce4d6">max_entries</a>; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#if defined(POLARSSL_THREADING_C)</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor"></span> threading_mutex_t mutex; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"></span>};</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">void</span> <a class="code" href="ssl__cache_8h.html#a02ffd9b13eee9ea9ec0a65a4a8c9a03a">ssl_cache_init</a>( <a class="code" href="struct__ssl__cache__context.html">ssl_cache_context</a> *cache );</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">int</span> <a class="code" href="ssl__cache_8h.html#a697c59bc8b5fe2c6b1372f393de0698d">ssl_cache_get</a>( <span class="keywordtype">void</span> *data, <a class="code" href="struct__ssl__session.html">ssl_session</a> *session );</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keywordtype">int</span> <a class="code" href="ssl__cache_8h.html#acdb215996a89789840abdd6f86cbe49e">ssl_cache_set</a>( <span class="keywordtype">void</span> *data, <span class="keyword">const</span> <a class="code" href="struct__ssl__session.html">ssl_session</a> *session );</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#if defined(POLARSSL_HAVE_TIME)</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="keywordtype">void</span> <a class="code" href="ssl__cache_8h.html#a48bf4718c43a9a4692d4f231f2bd2d88">ssl_cache_set_timeout</a>( <a class="code" href="struct__ssl__cache__context.html">ssl_cache_context</a> *cache, <span class="keywordtype">int</span> timeout );</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor">#endif </span><span class="comment">/* POLARSSL_HAVE_TIME */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keywordtype">void</span> <a class="code" href="ssl__cache_8h.html#a0b7a0cca4095b1e058ece62c6b7d7baa">ssl_cache_set_max_entries</a>( <a class="code" href="struct__ssl__cache__context.html">ssl_cache_context</a> *cache, <span class="keywordtype">int</span> max );</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="keywordtype">void</span> <a class="code" href="ssl__cache_8h.html#a5c2df860f7c31015e6e9804d49089583">ssl_cache_free</a>( <a class="code" href="struct__ssl__cache__context.html">ssl_cache_context</a> *cache );</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor">#endif </span><span class="comment">/* ssl_cache.h */</span><span class="preprocessor"></span></div>
<div class="ttc" id="ssl__cache_8h_html_a02ffd9b13eee9ea9ec0a65a4a8c9a03a"><div class="ttname"><a href="ssl__cache_8h.html#a02ffd9b13eee9ea9ec0a65a4a8c9a03a">ssl_cache_init</a></div><div class="ttdeci">void ssl_cache_init(ssl_cache_context *cache)</div><div class="ttdoc">Initialize an SSL cache context. </div></div>
<div class="ttc" id="struct__ssl__cache__entry_html_a124bf0874e17d1db3930561b3d61ed21"><div class="ttname"><a href="struct__ssl__cache__entry.html#a124bf0874e17d1db3930561b3d61ed21">_ssl_cache_entry::next</a></div><div class="ttdeci">ssl_cache_entry * next</div><div class="ttdef"><b>Definition:</b> <a href="ssl__cache_8h_source.html#l00073">ssl_cache.h:73</a></div></div>
<div class="ttc" id="struct__ssl__cache__context_html_a3358141c7bc4b12356782104d77f9d5e"><div class="ttname"><a href="struct__ssl__cache__context.html#a3358141c7bc4b12356782104d77f9d5e">_ssl_cache_context::chain</a></div><div class="ttdeci">ssl_cache_entry * chain</div><div class="ttdef"><b>Definition:</b> <a href="ssl__cache_8h_source.html#l00081">ssl_cache.h:81</a></div></div>
<div class="ttc" id="ssl__cache_8h_html_a697c59bc8b5fe2c6b1372f393de0698d"><div class="ttname"><a href="ssl__cache_8h.html#a697c59bc8b5fe2c6b1372f393de0698d">ssl_cache_get</a></div><div class="ttdeci">int ssl_cache_get(void *data, ssl_session *session)</div><div class="ttdoc">Cache get callback implementation (Thread-safe if POLARSSL_THREADING_C is enabled) ...</div></div>
<div class="ttc" id="struct__ssl__cache__entry_html_a270a4639d8f1668a2be9e58677f56e3b"><div class="ttname"><a href="struct__ssl__cache__entry.html#a270a4639d8f1668a2be9e58677f56e3b">_ssl_cache_entry::peer_cert</a></div><div class="ttdeci">x509_buf peer_cert</div><div class="ttdef"><b>Definition:</b> <a href="ssl__cache_8h_source.html#l00071">ssl_cache.h:71</a></div></div>
<div class="ttc" id="ssl__cache_8h_html_a5c2df860f7c31015e6e9804d49089583"><div class="ttname"><a href="ssl__cache_8h.html#a5c2df860f7c31015e6e9804d49089583">ssl_cache_free</a></div><div class="ttdeci">void ssl_cache_free(ssl_cache_context *cache)</div><div class="ttdoc">Free referenced items in a cache context and clear memory. </div></div>
<div class="ttc" id="struct__ssl__cache__context_html"><div class="ttname"><a href="struct__ssl__cache__context.html">_ssl_cache_context</a></div><div class="ttdoc">Cache context. </div><div class="ttdef"><b>Definition:</b> <a href="ssl__cache_8h_source.html#l00079">ssl_cache.h:79</a></div></div>
<div class="ttc" id="struct__ssl__cache__entry_html"><div class="ttname"><a href="struct__ssl__cache__entry.html">_ssl_cache_entry</a></div><div class="ttdoc">This structure is used for storing cache entries. </div><div class="ttdef"><b>Definition:</b> <a href="ssl__cache_8h_source.html#l00064">ssl_cache.h:64</a></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="struct__ssl__cache__entry_html_a34b540657823287d607d8b0f67020829"><div class="ttname"><a href="struct__ssl__cache__entry.html#a34b540657823287d607d8b0f67020829">_ssl_cache_entry::session</a></div><div class="ttdeci">ssl_session session</div><div class="ttdef"><b>Definition:</b> <a href="ssl__cache_8h_source.html#l00069">ssl_cache.h:69</a></div></div>
<div class="ttc" id="ssl__cache_8h_html_a48bf4718c43a9a4692d4f231f2bd2d88"><div class="ttname"><a href="ssl__cache_8h.html#a48bf4718c43a9a4692d4f231f2bd2d88">ssl_cache_set_timeout</a></div><div class="ttdeci">void ssl_cache_set_timeout(ssl_cache_context *cache, int timeout)</div><div class="ttdoc">Set the cache timeout (Default: SSL_CACHE_DEFAULT_TIMEOUT (1 day)) </div></div>
<div class="ttc" id="struct__asn1__buf_html"><div class="ttname"><a href="struct__asn1__buf.html">_asn1_buf</a></div><div class="ttdoc">Type-length-value structure that allows for ASN1 using DER. </div><div class="ttdef"><b>Definition:</b> <a href="asn1_8h_source.html#l00124">asn1.h:124</a></div></div>
<div class="ttc" id="struct__ssl__cache__context_html_ae54a1d8da77ffe39dc489e54172ce4d6"><div class="ttname"><a href="struct__ssl__cache__context.html#ae54a1d8da77ffe39dc489e54172ce4d6">_ssl_cache_context::max_entries</a></div><div class="ttdeci">int max_entries</div><div class="ttdef"><b>Definition:</b> <a href="ssl__cache_8h_source.html#l00083">ssl_cache.h:83</a></div></div>
<div class="ttc" id="ssl__cache_8h_html_a0b7a0cca4095b1e058ece62c6b7d7baa"><div class="ttname"><a href="ssl__cache_8h.html#a0b7a0cca4095b1e058ece62c6b7d7baa">ssl_cache_set_max_entries</a></div><div class="ttdeci">void ssl_cache_set_max_entries(ssl_cache_context *cache, int max)</div><div class="ttdoc">Set the cache timeout (Default: SSL_CACHE_DEFAULT_MAX_ENTRIES (50)) </div></div>
<div class="ttc" id="struct__ssl__cache__context_html_a5e1d681bb6e351af475ca01120ebbe42"><div class="ttname"><a href="struct__ssl__cache__context.html#a5e1d681bb6e351af475ca01120ebbe42">_ssl_cache_context::timeout</a></div><div class="ttdeci">int timeout</div><div class="ttdef"><b>Definition:</b> <a href="ssl__cache_8h_source.html#l00082">ssl_cache.h:82</a></div></div>
<div class="ttc" id="struct__ssl__cache__entry_html_a7b48c16f1680135bafc1a6ba66943f69"><div class="ttname"><a href="struct__ssl__cache__entry.html#a7b48c16f1680135bafc1a6ba66943f69">_ssl_cache_entry::timestamp</a></div><div class="ttdeci">time_t timestamp</div><div class="ttdef"><b>Definition:</b> <a href="ssl__cache_8h_source.html#l00067">ssl_cache.h:67</a></div></div>
<div class="ttc" id="struct__ssl__session_html"><div class="ttname"><a href="struct__ssl__session.html">_ssl_session</a></div><div class="ttdef"><b>Definition:</b> <a href="ssl_8h_source.html#l00510">ssl.h:510</a></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="ssl__cache_8h_html_acdb215996a89789840abdd6f86cbe49e"><div class="ttname"><a href="ssl__cache_8h.html#acdb215996a89789840abdd6f86cbe49e">ssl_cache_set</a></div><div class="ttdeci">int ssl_cache_set(void *data, const ssl_session *session)</div><div class="ttdoc">Cache set callback implementation (Thread-safe if POLARSSL_THREADING_C is enabled) ...</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:51 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
