<!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.6: ctr_drbg.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.6 </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="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">ctr_drbg.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>CTR_DRBG is based on AES-256, as defined in <em>NIST SP 800-90A: Recommendation for Random Number Generation Using Deterministic Random Bit Generators</em>. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="aes_8h_source.html">aes.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 ctr_drbg.h:</div> <div class="dyncontent"> <div class="center"><img src="ctr__drbg_8h__incl.png" border="0" usemap="#ctr__drbg_8h" alt=""/></div> <map name="ctr__drbg_8h" id="ctr__drbg_8h"> <area shape="rect" id="node2" href="aes_8h.html" title="The Advanced Encryption Standard (AES) specifies a FIPS-approved cryptographic algorithm that can be ..." alt="" coords="147,80,219,107"/> <area shape="rect" id="node8" href="threading_8h.html" title="Threading abstraction layer. " alt="" coords="307,80,439,107"/> <area shape="rect" id="node3" href="config_8h.html" title="Configuration options (set of defines) " alt="" coords="259,155,361,181"/> <area shape="rect" id="node4" href="check__config_8h.html" title="Consistency checks for configuration options. " alt="" coords="229,229,391,256"/> </map> </div> </div> <p><a href="ctr__drbg_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__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The CTR_DRBG context structure. <a href="structmbedtls__ctr__drbg__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:a15d1931ea5d133062cd93a3374a5bcf0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a15d1931ea5d133062cd93a3374a5bcf0">MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED</a>   -0x0034</td></tr> <tr class="separator:a15d1931ea5d133062cd93a3374a5bcf0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aea1a5c82ce0f69dfdda2d3131bd1b5e1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#aea1a5c82ce0f69dfdda2d3131bd1b5e1">MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG</a>   -0x0036</td></tr> <tr class="separator:aea1a5c82ce0f69dfdda2d3131bd1b5e1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7367c2feaa7ee9f4f182ff1cb03a864e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a7367c2feaa7ee9f4f182ff1cb03a864e">MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG</a>   -0x0038</td></tr> <tr class="separator:a7367c2feaa7ee9f4f182ff1cb03a864e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab5f1b73efeca5de8e75c273d47b8274e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#ab5f1b73efeca5de8e75c273d47b8274e">MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR</a>   -0x003A</td></tr> <tr class="separator:ab5f1b73efeca5de8e75c273d47b8274e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a73f77e540752ebec67e2477f776ed8a9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a73f77e540752ebec67e2477f776ed8a9">MBEDTLS_CTR_DRBG_BLOCKSIZE</a>   16</td></tr> <tr class="separator:a73f77e540752ebec67e2477f776ed8a9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af81b83e7d7d9709f0b61c6ee34ee848e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#af81b83e7d7d9709f0b61c6ee34ee848e">MBEDTLS_CTR_DRBG_KEYSIZE</a>   32</td></tr> <tr class="separator:af81b83e7d7d9709f0b61c6ee34ee848e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7f8b48d6ce94003298bbbae9fb514e8a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a7f8b48d6ce94003298bbbae9fb514e8a">MBEDTLS_CTR_DRBG_KEYBITS</a>   ( <a class="el" href="ctr__drbg_8h.html#af81b83e7d7d9709f0b61c6ee34ee848e">MBEDTLS_CTR_DRBG_KEYSIZE</a> * 8 )</td></tr> <tr class="separator:a7f8b48d6ce94003298bbbae9fb514e8a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8e6ac8e75c3becda32d9bc7b8ac2c23a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a8e6ac8e75c3becda32d9bc7b8ac2c23a">MBEDTLS_CTR_DRBG_SEEDLEN</a>   ( <a class="el" href="ctr__drbg_8h.html#af81b83e7d7d9709f0b61c6ee34ee848e">MBEDTLS_CTR_DRBG_KEYSIZE</a> + <a class="el" href="ctr__drbg_8h.html#a73f77e540752ebec67e2477f776ed8a9">MBEDTLS_CTR_DRBG_BLOCKSIZE</a> )</td></tr> <tr class="separator:a8e6ac8e75c3becda32d9bc7b8ac2c23a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9651ed4c66749bb7f232b93681593834"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a9651ed4c66749bb7f232b93681593834">MBEDTLS_CTR_DRBG_PR_OFF</a>   0</td></tr> <tr class="separator:a9651ed4c66749bb7f232b93681593834"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae534608231e768e8cf4010e1aa74dba8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#ae534608231e768e8cf4010e1aa74dba8">MBEDTLS_CTR_DRBG_PR_ON</a>   1</td></tr> <tr class="separator:ae534608231e768e8cf4010e1aa74dba8"><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 using the compiler command line. </p> </div></td></tr> <tr class="memitem:ac71c76b50eb79055e11f86d0d796b979"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#ac71c76b50eb79055e11f86d0d796b979">MBEDTLS_CTR_DRBG_ENTROPY_LEN</a>   48</td></tr> <tr class="separator:ac71c76b50eb79055e11f86d0d796b979"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af48f34760ba188dfc8e851c66e891c19"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#af48f34760ba188dfc8e851c66e891c19">MBEDTLS_CTR_DRBG_RESEED_INTERVAL</a>   10000</td></tr> <tr class="separator:af48f34760ba188dfc8e851c66e891c19"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9eeb62804173b22977cca5a7565bbe78"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a9eeb62804173b22977cca5a7565bbe78">MBEDTLS_CTR_DRBG_MAX_INPUT</a>   256</td></tr> <tr class="separator:a9eeb62804173b22977cca5a7565bbe78"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5b787e6157d91055d7c07d40f519cf52"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a5b787e6157d91055d7c07d40f519cf52">MBEDTLS_CTR_DRBG_MAX_REQUEST</a>   1024</td></tr> <tr class="separator:a5b787e6157d91055d7c07d40f519cf52"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1b944a1ceb01e5749008fbf27a6706e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a1b944a1ceb01e5749008fbf27a6706e4">MBEDTLS_CTR_DRBG_MAX_SEED_INPUT</a>   384</td></tr> <tr class="separator:a1b944a1ceb01e5749008fbf27a6706e4"><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:a70dbec5e03601bf437ec488f2645743b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a70dbec5e03601bf437ec488f2645743b">mbedtls_ctr_drbg_init</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *ctx)</td></tr> <tr class="memdesc:a70dbec5e03601bf437ec488f2645743b"><td class="mdescLeft"> </td><td class="mdescRight">This function initializes the CTR_DRBG context, and prepares it for <a class="el" href="ctr__drbg_8h.html#ad93d675f998550b4478c1fe6f4f34ebc" title="This function seeds and sets up the CTR_DRBG entropy source for future reseeds. ">mbedtls_ctr_drbg_seed()</a> or <a class="el" href="ctr__drbg_8h.html#a1ea42b9eb6f6b33c82359f4c0a57ca43" title="This function clears CTR_CRBG context data. ">mbedtls_ctr_drbg_free()</a>. <a href="#a70dbec5e03601bf437ec488f2645743b">More...</a><br /></td></tr> <tr class="separator:a70dbec5e03601bf437ec488f2645743b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad93d675f998550b4478c1fe6f4f34ebc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#ad93d675f998550b4478c1fe6f4f34ebc">mbedtls_ctr_drbg_seed</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *ctx, int(*f_entropy)(void *, unsigned char *, size_t), void *p_entropy, const unsigned char *custom, size_t len)</td></tr> <tr class="memdesc:ad93d675f998550b4478c1fe6f4f34ebc"><td class="mdescLeft"> </td><td class="mdescRight">This function seeds and sets up the CTR_DRBG entropy source for future reseeds. <a href="#ad93d675f998550b4478c1fe6f4f34ebc">More...</a><br /></td></tr> <tr class="separator:ad93d675f998550b4478c1fe6f4f34ebc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1ea42b9eb6f6b33c82359f4c0a57ca43"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a1ea42b9eb6f6b33c82359f4c0a57ca43">mbedtls_ctr_drbg_free</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *ctx)</td></tr> <tr class="memdesc:a1ea42b9eb6f6b33c82359f4c0a57ca43"><td class="mdescLeft"> </td><td class="mdescRight">This function clears CTR_CRBG context data. <a href="#a1ea42b9eb6f6b33c82359f4c0a57ca43">More...</a><br /></td></tr> <tr class="separator:a1ea42b9eb6f6b33c82359f4c0a57ca43"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae9871c5ba6b2fa5189423ef7cbe2078b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#ae9871c5ba6b2fa5189423ef7cbe2078b">mbedtls_ctr_drbg_set_prediction_resistance</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *ctx, int resistance)</td></tr> <tr class="memdesc:ae9871c5ba6b2fa5189423ef7cbe2078b"><td class="mdescLeft"> </td><td class="mdescRight">This function turns prediction resistance on or off. The default value is off. <a href="#ae9871c5ba6b2fa5189423ef7cbe2078b">More...</a><br /></td></tr> <tr class="separator:ae9871c5ba6b2fa5189423ef7cbe2078b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af33ced4a1fc79c6abbc1cb2b17f14549"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#af33ced4a1fc79c6abbc1cb2b17f14549">mbedtls_ctr_drbg_set_entropy_len</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *ctx, size_t len)</td></tr> <tr class="memdesc:af33ced4a1fc79c6abbc1cb2b17f14549"><td class="mdescLeft"> </td><td class="mdescRight">This function sets the amount of entropy grabbed on each seed or reseed. The default value is <a class="el" href="ctr__drbg_8h.html#ac71c76b50eb79055e11f86d0d796b979">MBEDTLS_CTR_DRBG_ENTROPY_LEN</a>. <a href="#af33ced4a1fc79c6abbc1cb2b17f14549">More...</a><br /></td></tr> <tr class="separator:af33ced4a1fc79c6abbc1cb2b17f14549"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aefd5f442f96682f0cef0152866e4e46e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#aefd5f442f96682f0cef0152866e4e46e">mbedtls_ctr_drbg_set_reseed_interval</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *ctx, int interval)</td></tr> <tr class="memdesc:aefd5f442f96682f0cef0152866e4e46e"><td class="mdescLeft"> </td><td class="mdescRight">This function sets the reseed interval. The default value is <a class="el" href="ctr__drbg_8h.html#af48f34760ba188dfc8e851c66e891c19">MBEDTLS_CTR_DRBG_RESEED_INTERVAL</a>. <a href="#aefd5f442f96682f0cef0152866e4e46e">More...</a><br /></td></tr> <tr class="separator:aefd5f442f96682f0cef0152866e4e46e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a495e3c86df7fc166454d0e85262e40a6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a495e3c86df7fc166454d0e85262e40a6">mbedtls_ctr_drbg_reseed</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *ctx, const unsigned char *additional, size_t len)</td></tr> <tr class="memdesc:a495e3c86df7fc166454d0e85262e40a6"><td class="mdescLeft"> </td><td class="mdescRight">This function reseeds the CTR_DRBG context, that is extracts data from the entropy source. <a href="#a495e3c86df7fc166454d0e85262e40a6">More...</a><br /></td></tr> <tr class="separator:a495e3c86df7fc166454d0e85262e40a6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a79d4bdb84d0c13f4bb28d5c3c6de4011"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a79d4bdb84d0c13f4bb28d5c3c6de4011">mbedtls_ctr_drbg_update</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *ctx, const unsigned char *additional, size_t add_len)</td></tr> <tr class="memdesc:a79d4bdb84d0c13f4bb28d5c3c6de4011"><td class="mdescLeft"> </td><td class="mdescRight">This function updates the state of the CTR_DRBG context. <a href="#a79d4bdb84d0c13f4bb28d5c3c6de4011">More...</a><br /></td></tr> <tr class="separator:a79d4bdb84d0c13f4bb28d5c3c6de4011"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a18161010cbcf33f6930fa8fdc035e74d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a18161010cbcf33f6930fa8fdc035e74d">mbedtls_ctr_drbg_random_with_add</a> (void *p_rng, unsigned char *output, size_t output_len, const unsigned char *additional, size_t add_len)</td></tr> <tr class="memdesc:a18161010cbcf33f6930fa8fdc035e74d"><td class="mdescLeft"> </td><td class="mdescRight">This function updates a CTR_DRBG instance with additional data and uses it to generate random data. <a href="#a18161010cbcf33f6930fa8fdc035e74d">More...</a><br /></td></tr> <tr class="separator:a18161010cbcf33f6930fa8fdc035e74d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af6e4dd295ae790a33128562dd01c79ab"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#af6e4dd295ae790a33128562dd01c79ab">mbedtls_ctr_drbg_random</a> (void *p_rng, unsigned char *output, size_t output_len)</td></tr> <tr class="memdesc:af6e4dd295ae790a33128562dd01c79ab"><td class="mdescLeft"> </td><td class="mdescRight">This function uses CTR_DRBG to generate random data. <a href="#af6e4dd295ae790a33128562dd01c79ab">More...</a><br /></td></tr> <tr class="separator:af6e4dd295ae790a33128562dd01c79ab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af8411dc8a4d9b2a7a5b4adf2ff3d9586"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#af8411dc8a4d9b2a7a5b4adf2ff3d9586">mbedtls_ctr_drbg_write_seed_file</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *ctx, const char *path)</td></tr> <tr class="memdesc:af8411dc8a4d9b2a7a5b4adf2ff3d9586"><td class="mdescLeft"> </td><td class="mdescRight">This function writes a seed file. <a href="#af8411dc8a4d9b2a7a5b4adf2ff3d9586">More...</a><br /></td></tr> <tr class="separator:af8411dc8a4d9b2a7a5b4adf2ff3d9586"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2dd8fb85c308475ca743aa634d4b0b96"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a2dd8fb85c308475ca743aa634d4b0b96">mbedtls_ctr_drbg_update_seed_file</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *ctx, const char *path)</td></tr> <tr class="memdesc:a2dd8fb85c308475ca743aa634d4b0b96"><td class="mdescLeft"> </td><td class="mdescRight">This function reads and updates a seed file. The seed is added to this instance. <a href="#a2dd8fb85c308475ca743aa634d4b0b96">More...</a><br /></td></tr> <tr class="separator:a2dd8fb85c308475ca743aa634d4b0b96"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6f4c2d5ae50d4f122a6a1468480a9c3e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a6f4c2d5ae50d4f122a6a1468480a9c3e">mbedtls_ctr_drbg_self_test</a> (int verbose)</td></tr> <tr class="memdesc:a6f4c2d5ae50d4f122a6a1468480a9c3e"><td class="mdescLeft"> </td><td class="mdescRight">The CTR_DRBG checkup routine. <a href="#a6f4c2d5ae50d4f122a6a1468480a9c3e">More...</a><br /></td></tr> <tr class="separator:a6f4c2d5ae50d4f122a6a1468480a9c3e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a83d6faba281bf4b6275bbfffb3efb3de"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ctr__drbg_8h.html#a83d6faba281bf4b6275bbfffb3efb3de">mbedtls_ctr_drbg_seed_entropy_len</a> (<a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> *, int(*)(void *, unsigned char *, size_t), void *, const unsigned char *, size_t, size_t)</td></tr> <tr class="separator:a83d6faba281bf4b6275bbfffb3efb3de"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>CTR_DRBG is based on AES-256, as defined in <em>NIST SP 800-90A: Recommendation for Random Number Generation Using Deterministic Random Bit Generators</em>. </p> <p class="definition">Definition in file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a id="a73f77e540752ebec67e2477f776ed8a9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a73f77e540752ebec67e2477f776ed8a9">◆ </a></span>MBEDTLS_CTR_DRBG_BLOCKSIZE</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_BLOCKSIZE   16</td> </tr> </table> </div><div class="memdoc"> <p>The block size used by the cipher. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00042">42</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="ac71c76b50eb79055e11f86d0d796b979"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac71c76b50eb79055e11f86d0d796b979">◆ </a></span>MBEDTLS_CTR_DRBG_ENTROPY_LEN</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_ENTROPY_LEN   48</td> </tr> </table> </div><div class="memdoc"> <p>The amount of entropy used per seed by default: </p><ul> <li> 48 with SHA-512. </li> <li> 32 with SHA-256.</li> </ul> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00058">58</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="a7f8b48d6ce94003298bbbae9fb514e8a"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7f8b48d6ce94003298bbbae9fb514e8a">◆ </a></span>MBEDTLS_CTR_DRBG_KEYBITS</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_KEYBITS   ( <a class="el" href="ctr__drbg_8h.html#af81b83e7d7d9709f0b61c6ee34ee848e">MBEDTLS_CTR_DRBG_KEYSIZE</a> * 8 )</td> </tr> </table> </div><div class="memdoc"> <p>The key size for the DRBG operation, in bits. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00044">44</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="af81b83e7d7d9709f0b61c6ee34ee848e"></a> <h2 class="memtitle"><span class="permalink"><a href="#af81b83e7d7d9709f0b61c6ee34ee848e">◆ </a></span>MBEDTLS_CTR_DRBG_KEYSIZE</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_KEYSIZE   32</td> </tr> </table> </div><div class="memdoc"> <p>The key size used by the cipher. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00043">43</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="a9eeb62804173b22977cca5a7565bbe78"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9eeb62804173b22977cca5a7565bbe78">◆ </a></span>MBEDTLS_CTR_DRBG_MAX_INPUT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_MAX_INPUT   256</td> </tr> </table> </div><div class="memdoc"> <p>The maximum number of additional input Bytes. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00078">78</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="a5b787e6157d91055d7c07d40f519cf52"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5b787e6157d91055d7c07d40f519cf52">◆ </a></span>MBEDTLS_CTR_DRBG_MAX_REQUEST</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_MAX_REQUEST   1024</td> </tr> </table> </div><div class="memdoc"> <p>The maximum number of requested Bytes per call. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00083">83</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="a1b944a1ceb01e5749008fbf27a6706e4"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1b944a1ceb01e5749008fbf27a6706e4">◆ </a></span>MBEDTLS_CTR_DRBG_MAX_SEED_INPUT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT   384</td> </tr> </table> </div><div class="memdoc"> <p>The maximum size of seed or reseed buffer. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00088">88</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="a9651ed4c66749bb7f232b93681593834"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9651ed4c66749bb7f232b93681593834">◆ </a></span>MBEDTLS_CTR_DRBG_PR_OFF</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_PR_OFF   0</td> </tr> </table> </div><div class="memdoc"> <p>Prediction resistance is disabled. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00094">94</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="ae534608231e768e8cf4010e1aa74dba8"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae534608231e768e8cf4010e1aa74dba8">◆ </a></span>MBEDTLS_CTR_DRBG_PR_ON</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_PR_ON   1</td> </tr> </table> </div><div class="memdoc"> <p>Prediction resistance is enabled. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00096">96</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="af48f34760ba188dfc8e851c66e891c19"></a> <h2 class="memtitle"><span class="permalink"><a href="#af48f34760ba188dfc8e851c66e891c19">◆ </a></span>MBEDTLS_CTR_DRBG_RESEED_INTERVAL</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL   10000</td> </tr> </table> </div><div class="memdoc"> <p>The interval before reseed is performed by default. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00073">73</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="a8e6ac8e75c3becda32d9bc7b8ac2c23a"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8e6ac8e75c3becda32d9bc7b8ac2c23a">◆ </a></span>MBEDTLS_CTR_DRBG_SEEDLEN</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CTR_DRBG_SEEDLEN   ( <a class="el" href="ctr__drbg_8h.html#af81b83e7d7d9709f0b61c6ee34ee848e">MBEDTLS_CTR_DRBG_KEYSIZE</a> + <a class="el" href="ctr__drbg_8h.html#a73f77e540752ebec67e2477f776ed8a9">MBEDTLS_CTR_DRBG_BLOCKSIZE</a> )</td> </tr> </table> </div><div class="memdoc"> <p>The seed length, calculated as (counter + AES key). </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00045">45</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="a15d1931ea5d133062cd93a3374a5bcf0"></a> <h2 class="memtitle"><span class="permalink"><a href="#a15d1931ea5d133062cd93a3374a5bcf0">◆ </a></span>MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED   -0x0034</td> </tr> </table> </div><div class="memdoc"> <p>The entropy source failed. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00037">37</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="ab5f1b73efeca5de8e75c273d47b8274e"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab5f1b73efeca5de8e75c273d47b8274e">◆ </a></span>MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR   -0x003A</td> </tr> </table> </div><div class="memdoc"> <p>Read or write error in file. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00040">40</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="a7367c2feaa7ee9f4f182ff1cb03a864e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7367c2feaa7ee9f4f182ff1cb03a864e">◆ </a></span>MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG   -0x0038</td> </tr> </table> </div><div class="memdoc"> <p>The input (entropy + additional data) is too large. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00039">39</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <a id="aea1a5c82ce0f69dfdda2d3131bd1b5e1"></a> <h2 class="memtitle"><span class="permalink"><a href="#aea1a5c82ce0f69dfdda2d3131bd1b5e1">◆ </a></span>MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG   -0x0036</td> </tr> </table> </div><div class="memdoc"> <p>The requested random buffer length is too big. </p> <p class="definition">Definition at line <a class="el" href="ctr__drbg_8h_source.html#l00038">38</a> of file <a class="el" href="ctr__drbg_8h_source.html">ctr_drbg.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="a1ea42b9eb6f6b33c82359f4c0a57ca43"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1ea42b9eb6f6b33c82359f4c0a57ca43">◆ </a></span>mbedtls_ctr_drbg_free()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_ctr_drbg_free </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>This function clears CTR_CRBG context data. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CTR_DRBG context to clear. </td></tr> </table> </dd> </dl> </div> </div> <a id="a70dbec5e03601bf437ec488f2645743b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a70dbec5e03601bf437ec488f2645743b">◆ </a></span>mbedtls_ctr_drbg_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_ctr_drbg_init </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>This function initializes the CTR_DRBG context, and prepares it for <a class="el" href="ctr__drbg_8h.html#ad93d675f998550b4478c1fe6f4f34ebc" title="This function seeds and sets up the CTR_DRBG entropy source for future reseeds. ">mbedtls_ctr_drbg_seed()</a> or <a class="el" href="ctr__drbg_8h.html#a1ea42b9eb6f6b33c82359f4c0a57ca43" title="This function clears CTR_CRBG context data. ">mbedtls_ctr_drbg_free()</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CTR_DRBG context to initialize. </td></tr> </table> </dd> </dl> </div> </div> <a id="af6e4dd295ae790a33128562dd01c79ab"></a> <h2 class="memtitle"><span class="permalink"><a href="#af6e4dd295ae790a33128562dd01c79ab">◆ </a></span>mbedtls_ctr_drbg_random()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ctr_drbg_random </td> <td>(</td> <td class="paramtype">void * </td> <td class="paramname"><em>p_rng</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>output_len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function uses CTR_DRBG to generate random data. </p> <dl class="section note"><dt>Note</dt><dd>The function automatically reseeds if the reseed counter is exceeded.</dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p_rng</td><td>The CTR_DRBG context. This must be a pointer to a <a class="el" href="structmbedtls__ctr__drbg__context.html" title="The CTR_DRBG context structure. ">mbedtls_ctr_drbg_context</a> structure. </td></tr> <tr><td class="paramname">output</td><td>The buffer to fill. </td></tr> <tr><td class="paramname">output_len</td><td>The length of the buffer.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or <a class="el" href="ctr__drbg_8h.html#a15d1931ea5d133062cd93a3374a5bcf0">MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED</a> or <a class="el" href="ctr__drbg_8h.html#aea1a5c82ce0f69dfdda2d3131bd1b5e1">MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG</a> on failure. </dd></dl> </div> </div> <a id="a18161010cbcf33f6930fa8fdc035e74d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a18161010cbcf33f6930fa8fdc035e74d">◆ </a></span>mbedtls_ctr_drbg_random_with_add()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ctr_drbg_random_with_add </td> <td>(</td> <td class="paramtype">void * </td> <td class="paramname"><em>p_rng</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>output_len</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </td> <td class="paramname"><em>additional</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>add_len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function updates a CTR_DRBG instance with additional data and uses it to generate random data. </p> <dl class="section note"><dt>Note</dt><dd>The function automatically reseeds if the reseed counter is exceeded.</dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p_rng</td><td>The CTR_DRBG context. This must be a pointer to a <a class="el" href="structmbedtls__ctr__drbg__context.html" title="The CTR_DRBG context structure. ">mbedtls_ctr_drbg_context</a> structure. </td></tr> <tr><td class="paramname">output</td><td>The buffer to fill. </td></tr> <tr><td class="paramname">output_len</td><td>The length of the buffer. </td></tr> <tr><td class="paramname">additional</td><td>Additional data to update. Can be NULL. </td></tr> <tr><td class="paramname">add_len</td><td>The length of the additional data.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or <a class="el" href="ctr__drbg_8h.html#a15d1931ea5d133062cd93a3374a5bcf0">MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED</a> or <a class="el" href="ctr__drbg_8h.html#aea1a5c82ce0f69dfdda2d3131bd1b5e1">MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG</a> on failure. </dd></dl> </div> </div> <a id="a495e3c86df7fc166454d0e85262e40a6"></a> <h2 class="memtitle"><span class="permalink"><a href="#a495e3c86df7fc166454d0e85262e40a6">◆ </a></span>mbedtls_ctr_drbg_reseed()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ctr_drbg_reseed </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_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>additional</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>This function reseeds the CTR_DRBG context, that is extracts data from the entropy source. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CTR_DRBG context. </td></tr> <tr><td class="paramname">additional</td><td>Additional data to add to the state. Can be NULL. </td></tr> <tr><td class="paramname">len</td><td>The length of the additional data.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or <a class="el" href="ctr__drbg_8h.html#a15d1931ea5d133062cd93a3374a5bcf0">MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED</a> on failure. </dd></dl> </div> </div> <a id="ad93d675f998550b4478c1fe6f4f34ebc"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad93d675f998550b4478c1fe6f4f34ebc">◆ </a></span>mbedtls_ctr_drbg_seed()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ctr_drbg_seed </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int(*)(void *, unsigned char *, size_t) </td> <td class="paramname"><em>f_entropy</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>p_entropy</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </td> <td class="paramname"><em>custom</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>This function seeds and sets up the CTR_DRBG entropy source for future reseeds. </p> <dl class="section note"><dt>Note</dt><dd>Personalization data can be provided in addition to the more generic entropy source, to make this instantiation as unique as possible.</dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CTR_DRBG context to seed. </td></tr> <tr><td class="paramname">f_entropy</td><td>The entropy callback, taking as arguments the <code>p_entropy</code> context, the buffer to fill, and the length of the buffer. </td></tr> <tr><td class="paramname">p_entropy</td><td>The entropy context. </td></tr> <tr><td class="paramname">custom</td><td>Personalization data, that is device-specific identifiers. Can be NULL. </td></tr> <tr><td class="paramname">len</td><td>The length of the personalization data.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or <a class="el" href="ctr__drbg_8h.html#a15d1931ea5d133062cd93a3374a5bcf0">MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED</a> on failure. </dd></dl> </div> </div> <a id="a83d6faba281bf4b6275bbfffb3efb3de"></a> <h2 class="memtitle"><span class="permalink"><a href="#a83d6faba281bf4b6275bbfffb3efb3de">◆ </a></span>mbedtls_ctr_drbg_seed_entropy_len()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ctr_drbg_seed_entropy_len </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int(*)(void *, unsigned char *, size_t) </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a id="a6f4c2d5ae50d4f122a6a1468480a9c3e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6f4c2d5ae50d4f122a6a1468480a9c3e">◆ </a></span>mbedtls_ctr_drbg_self_test()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ctr_drbg_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>The CTR_DRBG checkup routine. </p> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or <code>1</code> on failure. </dd></dl> </div> </div> <a id="af33ced4a1fc79c6abbc1cb2b17f14549"></a> <h2 class="memtitle"><span class="permalink"><a href="#af33ced4a1fc79c6abbc1cb2b17f14549">◆ </a></span>mbedtls_ctr_drbg_set_entropy_len()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_ctr_drbg_set_entropy_len </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> * </td> <td class="paramname"><em>ctx</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>This function sets the amount of entropy grabbed on each seed or reseed. The default value is <a class="el" href="ctr__drbg_8h.html#ac71c76b50eb79055e11f86d0d796b979">MBEDTLS_CTR_DRBG_ENTROPY_LEN</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CTR_DRBG context. </td></tr> <tr><td class="paramname">len</td><td>The amount of entropy to grab. </td></tr> </table> </dd> </dl> </div> </div> <a id="ae9871c5ba6b2fa5189423ef7cbe2078b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae9871c5ba6b2fa5189423ef7cbe2078b">◆ </a></span>mbedtls_ctr_drbg_set_prediction_resistance()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_ctr_drbg_set_prediction_resistance </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>resistance</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function turns prediction resistance on or off. The default value is off. </p> <dl class="section note"><dt>Note</dt><dd>If enabled, entropy is gathered at the beginning of every call to <a class="el" href="ctr__drbg_8h.html#a18161010cbcf33f6930fa8fdc035e74d" title="This function updates a CTR_DRBG instance with additional data and uses it to generate random data...">mbedtls_ctr_drbg_random_with_add()</a>. Only use this if your entropy source has sufficient throughput.</dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CTR_DRBG context. </td></tr> <tr><td class="paramname">resistance</td><td><a class="el" href="ctr__drbg_8h.html#ae534608231e768e8cf4010e1aa74dba8">MBEDTLS_CTR_DRBG_PR_ON</a> or <a class="el" href="ctr__drbg_8h.html#a9651ed4c66749bb7f232b93681593834">MBEDTLS_CTR_DRBG_PR_OFF</a>. </td></tr> </table> </dd> </dl> </div> </div> <a id="aefd5f442f96682f0cef0152866e4e46e"></a> <h2 class="memtitle"><span class="permalink"><a href="#aefd5f442f96682f0cef0152866e4e46e">◆ </a></span>mbedtls_ctr_drbg_set_reseed_interval()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_ctr_drbg_set_reseed_interval </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>interval</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function sets the reseed interval. The default value is <a class="el" href="ctr__drbg_8h.html#af48f34760ba188dfc8e851c66e891c19">MBEDTLS_CTR_DRBG_RESEED_INTERVAL</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CTR_DRBG context. </td></tr> <tr><td class="paramname">interval</td><td>The reseed interval. </td></tr> </table> </dd> </dl> </div> </div> <a id="a79d4bdb84d0c13f4bb28d5c3c6de4011"></a> <h2 class="memtitle"><span class="permalink"><a href="#a79d4bdb84d0c13f4bb28d5c3c6de4011">◆ </a></span>mbedtls_ctr_drbg_update()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_ctr_drbg_update </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_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>additional</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>add_len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function updates the state of the CTR_DRBG context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CTR_DRBG context. </td></tr> <tr><td class="paramname">additional</td><td>The data to update the state with. </td></tr> <tr><td class="paramname">add_len</td><td>Length of <code>additional</code> data.</td></tr> </table> </dd> </dl> <dl class="section note"><dt>Note</dt><dd>If <code>add_len</code> is greater than <a class="el" href="ctr__drbg_8h.html#a1b944a1ceb01e5749008fbf27a6706e4">MBEDTLS_CTR_DRBG_MAX_SEED_INPUT</a>, only the first <a class="el" href="ctr__drbg_8h.html#a1b944a1ceb01e5749008fbf27a6706e4">MBEDTLS_CTR_DRBG_MAX_SEED_INPUT</a> Bytes are used. The remaining Bytes are silently discarded. </dd></dl> </div> </div> <a id="a2dd8fb85c308475ca743aa634d4b0b96"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2dd8fb85c308475ca743aa634d4b0b96">◆ </a></span>mbedtls_ctr_drbg_update_seed_file()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ctr_drbg_update_seed_file </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_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>This function reads and updates a seed file. The seed is added to this instance. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CTR_DRBG context. </td></tr> <tr><td class="paramname">path</td><td>The name of the file.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, <a class="el" href="ctr__drbg_8h.html#ab5f1b73efeca5de8e75c273d47b8274e">MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR</a> on file error, <a class="el" href="ctr__drbg_8h.html#a15d1931ea5d133062cd93a3374a5bcf0">MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED</a> or <a class="el" href="ctr__drbg_8h.html#a7367c2feaa7ee9f4f182ff1cb03a864e">MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG</a> on failure. </dd></dl> </div> </div> <a id="af8411dc8a4d9b2a7a5b4adf2ff3d9586"></a> <h2 class="memtitle"><span class="permalink"><a href="#af8411dc8a4d9b2a7a5b4adf2ff3d9586">◆ </a></span>mbedtls_ctr_drbg_write_seed_file()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ctr_drbg_write_seed_file </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ctr__drbg__context.html">mbedtls_ctr_drbg_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>This function writes a seed file. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CTR_DRBG context. </td></tr> <tr><td class="paramname">path</td><td>The name of the file.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, <a class="el" href="ctr__drbg_8h.html#ab5f1b73efeca5de8e75c273d47b8274e">MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR</a> on file error, or <a class="el" href="ctr__drbg_8h.html#a15d1931ea5d133062cd93a3374a5bcf0">MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED</a> on failure. </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 12 2018 20:26:59 for mbed TLS v2.7.6 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>