<!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: entropy.h File Reference</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="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">entropy.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Entropy accumulator implementation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="config_8h_source.html">config.h</a>"</code><br />
<code>#include <stddef.h></code><br />
<code>#include "<a class="el" href="sha512_8h_source.html">sha512.h</a>"</code><br />
<code>#include "<a class="el" href="threading_8h_source.html">threading.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for entropy.h:</div>
<div class="dyncontent">
<div class="center"><img src="entropy_8h__incl.png" border="0" usemap="#entropy_8h" alt=""/></div>
<map name="entropy_8h" id="entropy_8h">
</map>
</div>
</div>
<p><a href="entropy_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__entropy__source__state.html">mbedtls_entropy_source_state</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Entropy source state. <a href="structmbedtls__entropy__source__state.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Entropy context structure. <a href="structmbedtls__entropy__context.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a77e56d52d29721c24f22a9ec01391ecb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a77e56d52d29721c24f22a9ec01391ecb">MBEDTLS_ENTROPY_SHA512_ACCUMULATOR</a></td></tr>
<tr class="separator:a77e56d52d29721c24f22a9ec01391ecb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4cd68e9098b27fed32e7d4a48a4048b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#af4cd68e9098b27fed32e7d4a48a4048b">MBEDTLS_ERR_ENTROPY_SOURCE_FAILED</a>   -0x003C</td></tr>
<tr class="separator:af4cd68e9098b27fed32e7d4a48a4048b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12a0600bd163efc21469e406a4e194ce"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a12a0600bd163efc21469e406a4e194ce">MBEDTLS_ERR_ENTROPY_MAX_SOURCES</a>   -0x003E</td></tr>
<tr class="separator:a12a0600bd163efc21469e406a4e194ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9f0a333fbef6d5ebe4fda846249f5c6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#ab9f0a333fbef6d5ebe4fda846249f5c6">MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED</a>   -0x0040</td></tr>
<tr class="separator:ab9f0a333fbef6d5ebe4fda846249f5c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8116299707c4a7fbf19cac3f30ce1e7a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a8116299707c4a7fbf19cac3f30ce1e7a">MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE</a>   -0x003D</td></tr>
<tr class="separator:a8116299707c4a7fbf19cac3f30ce1e7a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a356b20cef049a2de3e99909321894463"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a356b20cef049a2de3e99909321894463">MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR</a>   -0x003F</td></tr>
<tr class="separator:a356b20cef049a2de3e99909321894463"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc0fdb8c34a1ae04a81b4b21cb383941"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#acc0fdb8c34a1ae04a81b4b21cb383941">MBEDTLS_ENTROPY_BLOCK_SIZE</a>   64</td></tr>
<tr class="separator:acc0fdb8c34a1ae04a81b4b21cb383941"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afff6ba3d7fc6df1fedd007d3a9a4136b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#afff6ba3d7fc6df1fedd007d3a9a4136b">MBEDTLS_ENTROPY_MAX_SEED_SIZE</a>   1024</td></tr>
<tr class="separator:afff6ba3d7fc6df1fedd007d3a9a4136b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a841232804d6de404b072c57a374502c8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a841232804d6de404b072c57a374502c8">MBEDTLS_ENTROPY_SOURCE_MANUAL</a>   <a class="el" href="entropy_8h.html#a819aa4f3046aa257738f0dafe481ca1f">MBEDTLS_ENTROPY_MAX_SOURCES</a></td></tr>
<tr class="separator:a841232804d6de404b072c57a374502c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf3946666d3aa196a7a4ba7705740580"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#acf3946666d3aa196a7a4ba7705740580">MBEDTLS_ENTROPY_SOURCE_STRONG</a>   1</td></tr>
<tr class="separator:acf3946666d3aa196a7a4ba7705740580"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3aaeef22d87036afb296bfdb4d7d4c4c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a3aaeef22d87036afb296bfdb4d7d4c4c">MBEDTLS_ENTROPY_SOURCE_WEAK</a>   0</td></tr>
<tr class="separator:a3aaeef22d87036afb296bfdb4d7d4c4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">SECTION: Module settings</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The configuration options you can set for this module are in this section. Either change them in <a class="el" href="config_8h.html" title="Configuration options (set of defines) ">config.h</a> or define them on the compiler command line. </p>
</div></td></tr>
<tr class="memitem:a819aa4f3046aa257738f0dafe481ca1f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a819aa4f3046aa257738f0dafe481ca1f">MBEDTLS_ENTROPY_MAX_SOURCES</a>   20</td></tr>
<tr class="separator:a819aa4f3046aa257738f0dafe481ca1f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21637aa9a738da4fce13931a8442dc28"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a21637aa9a738da4fce13931a8442dc28">MBEDTLS_ENTROPY_MAX_GATHER</a>   128</td></tr>
<tr class="separator:a21637aa9a738da4fce13931a8442dc28"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a2168f0720e2e869e440fd7fa35c941bd"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a2168f0720e2e869e440fd7fa35c941bd">mbedtls_entropy_f_source_ptr</a>) (void *data, unsigned char *output, size_t len, size_t *olen)</td></tr>
<tr class="memdesc:a2168f0720e2e869e440fd7fa35c941bd"><td class="mdescLeft"> </td><td class="mdescRight">Entropy poll callback pointer. <a href="#a2168f0720e2e869e440fd7fa35c941bd">More...</a><br /></td></tr>
<tr class="separator:a2168f0720e2e869e440fd7fa35c941bd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa901e027093c6fe65dee5760db78aced"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#aa901e027093c6fe65dee5760db78aced">mbedtls_entropy_init</a> (<a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> *ctx)</td></tr>
<tr class="memdesc:aa901e027093c6fe65dee5760db78aced"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the context. <a href="#aa901e027093c6fe65dee5760db78aced">More...</a><br /></td></tr>
<tr class="separator:aa901e027093c6fe65dee5760db78aced"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06778439f8a0e2daa2d3b444e06ad8dd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a06778439f8a0e2daa2d3b444e06ad8dd">mbedtls_entropy_free</a> (<a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> *ctx)</td></tr>
<tr class="memdesc:a06778439f8a0e2daa2d3b444e06ad8dd"><td class="mdescLeft"> </td><td class="mdescRight">Free the data in the context. <a href="#a06778439f8a0e2daa2d3b444e06ad8dd">More...</a><br /></td></tr>
<tr class="separator:a06778439f8a0e2daa2d3b444e06ad8dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1bf424d076142e9aeec9e68207f5aaa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#ad1bf424d076142e9aeec9e68207f5aaa">mbedtls_entropy_add_source</a> (<a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> *ctx, <a class="el" href="entropy_8h.html#a2168f0720e2e869e440fd7fa35c941bd">mbedtls_entropy_f_source_ptr</a> f_source, void *p_source, size_t threshold, int strong)</td></tr>
<tr class="memdesc:ad1bf424d076142e9aeec9e68207f5aaa"><td class="mdescLeft"> </td><td class="mdescRight">Adds an entropy source to poll (Thread-safe if MBEDTLS_THREADING_C is enabled) <a href="#ad1bf424d076142e9aeec9e68207f5aaa">More...</a><br /></td></tr>
<tr class="separator:ad1bf424d076142e9aeec9e68207f5aaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac49de4b842e7d56cfcd1088286a09b7d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#ac49de4b842e7d56cfcd1088286a09b7d">mbedtls_entropy_gather</a> (<a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> *ctx)</td></tr>
<tr class="memdesc:ac49de4b842e7d56cfcd1088286a09b7d"><td class="mdescLeft"> </td><td class="mdescRight">Trigger an extra gather poll for the accumulator (Thread-safe if MBEDTLS_THREADING_C is enabled) <a href="#ac49de4b842e7d56cfcd1088286a09b7d">More...</a><br /></td></tr>
<tr class="separator:ac49de4b842e7d56cfcd1088286a09b7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81765f6cdf4e5111bcb9f4324f3234cb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a81765f6cdf4e5111bcb9f4324f3234cb">mbedtls_entropy_func</a> (void *data, unsigned char *output, size_t len)</td></tr>
<tr class="memdesc:a81765f6cdf4e5111bcb9f4324f3234cb"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve entropy from the accumulator (Maximum length: MBEDTLS_ENTROPY_BLOCK_SIZE) (Thread-safe if MBEDTLS_THREADING_C is enabled) <a href="#a81765f6cdf4e5111bcb9f4324f3234cb">More...</a><br /></td></tr>
<tr class="separator:a81765f6cdf4e5111bcb9f4324f3234cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa79492f288cc3202ea455564be855d64"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#aa79492f288cc3202ea455564be855d64">mbedtls_entropy_update_manual</a> (<a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> *ctx, const unsigned char *data, size_t len)</td></tr>
<tr class="memdesc:aa79492f288cc3202ea455564be855d64"><td class="mdescLeft"> </td><td class="mdescRight">Add data to the accumulator manually (Thread-safe if MBEDTLS_THREADING_C is enabled) <a href="#aa79492f288cc3202ea455564be855d64">More...</a><br /></td></tr>
<tr class="separator:aa79492f288cc3202ea455564be855d64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abffb5c2d08b9cc94788910d463ce3181"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#abffb5c2d08b9cc94788910d463ce3181">mbedtls_entropy_write_seed_file</a> (<a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> *ctx, const char *path)</td></tr>
<tr class="memdesc:abffb5c2d08b9cc94788910d463ce3181"><td class="mdescLeft"> </td><td class="mdescRight">Write a seed file. <a href="#abffb5c2d08b9cc94788910d463ce3181">More...</a><br /></td></tr>
<tr class="separator:abffb5c2d08b9cc94788910d463ce3181"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d72b19c00eb0cabb319d3d81599a57a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#a3d72b19c00eb0cabb319d3d81599a57a">mbedtls_entropy_update_seed_file</a> (<a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> *ctx, const char *path)</td></tr>
<tr class="memdesc:a3d72b19c00eb0cabb319d3d81599a57a"><td class="mdescLeft"> </td><td class="mdescRight">Read and update a seed file. Seed is added to this instance. No more than MBEDTLS_ENTROPY_MAX_SEED_SIZE bytes are read from the seed file. The rest is ignored. <a href="#a3d72b19c00eb0cabb319d3d81599a57a">More...</a><br /></td></tr>
<tr class="separator:a3d72b19c00eb0cabb319d3d81599a57a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad31b29e855ba719ba5282e2da4f5c338"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="entropy_8h.html#ad31b29e855ba719ba5282e2da4f5c338">mbedtls_entropy_self_test</a> (int verbose)</td></tr>
<tr class="memdesc:ad31b29e855ba719ba5282e2da4f5c338"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#ad31b29e855ba719ba5282e2da4f5c338">More...</a><br /></td></tr>
<tr class="separator:ad31b29e855ba719ba5282e2da4f5c338"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Entropy accumulator implementation. </p>
<p class="definition">Definition in file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="acc0fdb8c34a1ae04a81b4b21cb383941"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc0fdb8c34a1ae04a81b4b21cb383941">◆ </a></span>MBEDTLS_ENTROPY_BLOCK_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ENTROPY_BLOCK_SIZE   64</td>
</tr>
</table>
</div><div class="memdoc">
<p>Block size of entropy accumulator (SHA-512) </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00078">78</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="a21637aa9a738da4fce13931a8442dc28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21637aa9a738da4fce13931a8442dc28">◆ </a></span>MBEDTLS_ENTROPY_MAX_GATHER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ENTROPY_MAX_GATHER   128</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum amount requested from entropy sources </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00072">72</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="afff6ba3d7fc6df1fedd007d3a9a4136b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afff6ba3d7fc6df1fedd007d3a9a4136b">◆ </a></span>MBEDTLS_ENTROPY_MAX_SEED_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ENTROPY_MAX_SEED_SIZE   1024</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum size of seed we read from seed file </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00083">83</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="a819aa4f3046aa257738f0dafe481ca1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a819aa4f3046aa257738f0dafe481ca1f">◆ </a></span>MBEDTLS_ENTROPY_MAX_SOURCES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ENTROPY_MAX_SOURCES   20</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of sources supported </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00068">68</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="a77e56d52d29721c24f22a9ec01391ecb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77e56d52d29721c24f22a9ec01391ecb">◆ </a></span>MBEDTLS_ENTROPY_SHA512_ACCUMULATOR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ENTROPY_SHA512_ACCUMULATOR</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00037">37</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="a841232804d6de404b072c57a374502c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a841232804d6de404b072c57a374502c8">◆ </a></span>MBEDTLS_ENTROPY_SOURCE_MANUAL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ENTROPY_SOURCE_MANUAL   <a class="el" href="entropy_8h.html#a819aa4f3046aa257738f0dafe481ca1f">MBEDTLS_ENTROPY_MAX_SOURCES</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00084">84</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="acf3946666d3aa196a7a4ba7705740580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf3946666d3aa196a7a4ba7705740580">◆ </a></span>MBEDTLS_ENTROPY_SOURCE_STRONG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ENTROPY_SOURCE_STRONG   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Entropy source is strong </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00086">86</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="a3aaeef22d87036afb296bfdb4d7d4c4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aaeef22d87036afb296bfdb4d7d4c4c">◆ </a></span>MBEDTLS_ENTROPY_SOURCE_WEAK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ENTROPY_SOURCE_WEAK   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Entropy source is weak </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00087">87</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="a356b20cef049a2de3e99909321894463"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a356b20cef049a2de3e99909321894463">◆ </a></span>MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR   -0x003F</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read/write error in file. </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00057">57</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="a12a0600bd163efc21469e406a4e194ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12a0600bd163efc21469e406a4e194ce">◆ </a></span>MBEDTLS_ERR_ENTROPY_MAX_SOURCES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_ENTROPY_MAX_SOURCES   -0x003E</td>
</tr>
</table>
</div><div class="memdoc">
<p>No more sources can be added. </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00054">54</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="ab9f0a333fbef6d5ebe4fda846249f5c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9f0a333fbef6d5ebe4fda846249f5c6">◆ </a></span>MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED   -0x0040</td>
</tr>
</table>
</div><div class="memdoc">
<p>No sources have been added to poll. </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00055">55</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="a8116299707c4a7fbf19cac3f30ce1e7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8116299707c4a7fbf19cac3f30ce1e7a">◆ </a></span>MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE   -0x003D</td>
</tr>
</table>
</div><div class="memdoc">
<p>No strong sources have been added to poll. </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00056">56</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<a id="af4cd68e9098b27fed32e7d4a48a4048b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4cd68e9098b27fed32e7d4a48a4048b">◆ </a></span>MBEDTLS_ERR_ENTROPY_SOURCE_FAILED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_ENTROPY_SOURCE_FAILED   -0x003C</td>
</tr>
</table>
</div><div class="memdoc">
<p>Critical entropy source failure. </p>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00053">53</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a2168f0720e2e869e440fd7fa35c941bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2168f0720e2e869e440fd7fa35c941bd">◆ </a></span>mbedtls_entropy_f_source_ptr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* mbedtls_entropy_f_source_ptr) (void *data, unsigned char *output, size_t len, size_t *olen)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Entropy poll callback pointer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Callback-specific data pointer </td></tr>
<tr><td class="paramname">output</td><td>Data to fill </td></tr>
<tr><td class="paramname">len</td><td>Maximum size to provide </td></tr>
<tr><td class="paramname">olen</td><td>The actual amount of bytes put into the buffer (Can be 0)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if no critical failures occurred, MBEDTLS_ERR_ENTROPY_SOURCE_FAILED otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="entropy_8h_source.html#l00104">104</a> of file <a class="el" href="entropy_8h_source.html">entropy.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ad1bf424d076142e9aeec9e68207f5aaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1bf424d076142e9aeec9e68207f5aaa">◆ </a></span>mbedtls_entropy_add_source()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_entropy_add_source </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="entropy_8h.html#a2168f0720e2e869e440fd7fa35c941bd">mbedtls_entropy_f_source_ptr</a> </td>
<td class="paramname"><em>f_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>threshold</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>strong</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an entropy source to poll (Thread-safe if MBEDTLS_THREADING_C is enabled) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Entropy context </td></tr>
<tr><td class="paramname">f_source</td><td>Entropy function </td></tr>
<tr><td class="paramname">p_source</td><td>Function data </td></tr>
<tr><td class="paramname">threshold</td><td>Minimum required from source before entropy is released ( with <a class="el" href="entropy_8h.html#a81765f6cdf4e5111bcb9f4324f3234cb" title="Retrieve entropy from the accumulator (Maximum length: MBEDTLS_ENTROPY_BLOCK_SIZE) (Thread-safe if MB...">mbedtls_entropy_func()</a> ) (in bytes) </td></tr>
<tr><td class="paramname">strong</td><td>MBEDTLS_ENTROPY_SOURCE_STRONG or MBEDTSL_ENTROPY_SOURCE_WEAK. At least one strong source needs to be added. Weaker sources (such as the cycle counter) can be used as a complement.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful or MBEDTLS_ERR_ENTROPY_MAX_SOURCES </dd></dl>
</div>
</div>
<a id="a06778439f8a0e2daa2d3b444e06ad8dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06778439f8a0e2daa2d3b444e06ad8dd">◆ </a></span>mbedtls_entropy_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_entropy_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free the data in the context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Entropy context to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a81765f6cdf4e5111bcb9f4324f3234cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81765f6cdf4e5111bcb9f4324f3234cb">◆ </a></span>mbedtls_entropy_func()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_entropy_func </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve entropy from the accumulator (Maximum length: MBEDTLS_ENTROPY_BLOCK_SIZE) (Thread-safe if MBEDTLS_THREADING_C is enabled) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Entropy context </td></tr>
<tr><td class="paramname">output</td><td>Buffer to fill </td></tr>
<tr><td class="paramname">len</td><td>Number of bytes desired, must be at most MBEDTLS_ENTROPY_BLOCK_SIZE</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or MBEDTLS_ERR_ENTROPY_SOURCE_FAILED </dd></dl>
</div>
</div>
<a id="ac49de4b842e7d56cfcd1088286a09b7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac49de4b842e7d56cfcd1088286a09b7d">◆ </a></span>mbedtls_entropy_gather()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_entropy_gather </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Trigger an extra gather poll for the accumulator (Thread-safe if MBEDTLS_THREADING_C is enabled) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Entropy context</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or MBEDTLS_ERR_ENTROPY_SOURCE_FAILED </dd></dl>
</div>
</div>
<a id="aa901e027093c6fe65dee5760db78aced"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa901e027093c6fe65dee5760db78aced">◆ </a></span>mbedtls_entropy_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_entropy_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Entropy context to initialize </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad31b29e855ba719ba5282e2da4f5c338"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad31b29e855ba719ba5282e2da4f5c338">◆ </a></span>mbedtls_entropy_self_test()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_entropy_self_test </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>verbose</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checkup routine. </p>
<p>This module self-test also calls the entropy self-test, mbedtls_entropy_source_self_test();</p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or 1 if a test failed </dd></dl>
</div>
</div>
<a id="aa79492f288cc3202ea455564be855d64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa79492f288cc3202ea455564be855d64">◆ </a></span>mbedtls_entropy_update_manual()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_entropy_update_manual </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add data to the accumulator manually (Thread-safe if MBEDTLS_THREADING_C is enabled) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Entropy context </td></tr>
<tr><td class="paramname">data</td><td>Data to add </td></tr>
<tr><td class="paramname">len</td><td>Length of data</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful </dd></dl>
</div>
</div>
<a id="a3d72b19c00eb0cabb319d3d81599a57a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d72b19c00eb0cabb319d3d81599a57a">◆ </a></span>mbedtls_entropy_update_seed_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_entropy_update_seed_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read and update a seed file. Seed is added to this instance. No more than MBEDTLS_ENTROPY_MAX_SEED_SIZE bytes are read from the seed file. The rest is ignored. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Entropy context </td></tr>
<tr><td class="paramname">path</td><td>Name of the file</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR on file error, MBEDTLS_ERR_ENTROPY_SOURCE_FAILED </dd></dl>
</div>
</div>
<a id="abffb5c2d08b9cc94788910d463ce3181"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abffb5c2d08b9cc94788910d463ce3181">◆ </a></span>mbedtls_entropy_write_seed_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_entropy_write_seed_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__entropy__context.html">mbedtls_entropy_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a seed file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Entropy context </td></tr>
<tr><td class="paramname">path</td><td>Name of the file</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR on file error, or MBEDTLS_ERR_ENTROPY_SOURCE_FAILED </dd></dl>
</div>
</div>
</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>
