<!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: hmac_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 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="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">hmac_drbg.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>HMAC_DRBG (NIST SP 800-90A)
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="md_8h_source.html">md.h</a>"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for hmac_drbg.h:</div>
<div class="dyncontent">
<div class="center"><img src="hmac__drbg_8h__incl.png" border="0" usemap="#hmac__drbg_8h" alt=""/></div>
<map name="hmac__drbg_8h" id="hmac__drbg_8h">
</map>
</div>
</div>
<p><a href="hmac__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="structhmac__drbg__context.html">hmac_drbg_context</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HMAC_DRBG context. <a href="structhmac__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:a4d06fc2204001f56acb2a1eabfbbf036"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a4d06fc2204001f56acb2a1eabfbbf036">POLARSSL_ERR_HMAC_DRBG_REQUEST_TOO_BIG</a>   -0x0003</td></tr>
<tr class="memdesc:a4d06fc2204001f56acb2a1eabfbbf036"><td class="mdescLeft"> </td><td class="mdescRight">Too many random requested in single call. <a href="#a4d06fc2204001f56acb2a1eabfbbf036">More...</a><br/></td></tr>
<tr class="separator:a4d06fc2204001f56acb2a1eabfbbf036"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63ba4f9a4e98f5d1af93e33c3e1fe3b5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a63ba4f9a4e98f5d1af93e33c3e1fe3b5">POLARSSL_ERR_HMAC_DRBG_INPUT_TOO_BIG</a>   -0x0005</td></tr>
<tr class="memdesc:a63ba4f9a4e98f5d1af93e33c3e1fe3b5"><td class="mdescLeft"> </td><td class="mdescRight">Input too large (Entropy + additional). <a href="#a63ba4f9a4e98f5d1af93e33c3e1fe3b5">More...</a><br/></td></tr>
<tr class="separator:a63ba4f9a4e98f5d1af93e33c3e1fe3b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a560c35edcfca2ab71f39e2c70d50c8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a6a560c35edcfca2ab71f39e2c70d50c8">POLARSSL_ERR_HMAC_DRBG_FILE_IO_ERROR</a>   -0x0007</td></tr>
<tr class="memdesc:a6a560c35edcfca2ab71f39e2c70d50c8"><td class="mdescLeft"> </td><td class="mdescRight">Read/write error in file. <a href="#a6a560c35edcfca2ab71f39e2c70d50c8">More...</a><br/></td></tr>
<tr class="separator:a6a560c35edcfca2ab71f39e2c70d50c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d9472d39e70c4eeb3cb06177c3012f8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a0d9472d39e70c4eeb3cb06177c3012f8">POLARSSL_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED</a>   -0x0009</td></tr>
<tr class="memdesc:a0d9472d39e70c4eeb3cb06177c3012f8"><td class="mdescLeft"> </td><td class="mdescRight">The entropy source failed. <a href="#a0d9472d39e70c4eeb3cb06177c3012f8">More...</a><br/></td></tr>
<tr class="separator:a0d9472d39e70c4eeb3cb06177c3012f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1df2abd47fc8c24f9ce5c02c86337dad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a1df2abd47fc8c24f9ce5c02c86337dad">POLARSSL_HMAC_DRBG_PR_OFF</a>   0</td></tr>
<tr class="memdesc:a1df2abd47fc8c24f9ce5c02c86337dad"><td class="mdescLeft"> </td><td class="mdescRight">No prediction resistance. <a href="#a1df2abd47fc8c24f9ce5c02c86337dad">More...</a><br/></td></tr>
<tr class="separator:a1df2abd47fc8c24f9ce5c02c86337dad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48149f1fd6d91c46a1a4f1574cd65653"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a48149f1fd6d91c46a1a4f1574cd65653">POLARSSL_HMAC_DRBG_PR_ON</a>   1</td></tr>
<tr class="memdesc:a48149f1fd6d91c46a1a4f1574cd65653"><td class="mdescLeft"> </td><td class="mdescRight">Prediction resistance enabled. <a href="#a48149f1fd6d91c46a1a4f1574cd65653">More...</a><br/></td></tr>
<tr class="separator:a48149f1fd6d91c46a1a4f1574cd65653"><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.</p>
<p>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:aa3d9fee8fa351e1e9c828f39f63e89f7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#aa3d9fee8fa351e1e9c828f39f63e89f7">POLARSSL_HMAC_DRBG_RESEED_INTERVAL</a>   10000</td></tr>
<tr class="memdesc:aa3d9fee8fa351e1e9c828f39f63e89f7"><td class="mdescLeft"> </td><td class="mdescRight">Interval before reseed is performed by default. <a href="#aa3d9fee8fa351e1e9c828f39f63e89f7">More...</a><br/></td></tr>
<tr class="separator:aa3d9fee8fa351e1e9c828f39f63e89f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad42367f0fecb12f9962f0798857b86ae"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#ad42367f0fecb12f9962f0798857b86ae">POLARSSL_HMAC_DRBG_MAX_INPUT</a>   256</td></tr>
<tr class="memdesc:ad42367f0fecb12f9962f0798857b86ae"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of additional input bytes. <a href="#ad42367f0fecb12f9962f0798857b86ae">More...</a><br/></td></tr>
<tr class="separator:ad42367f0fecb12f9962f0798857b86ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a818a91c1f898a6e1ade715a0e3acd366"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a818a91c1f898a6e1ade715a0e3acd366">POLARSSL_HMAC_DRBG_MAX_REQUEST</a>   1024</td></tr>
<tr class="memdesc:a818a91c1f898a6e1ade715a0e3acd366"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of requested bytes per call. <a href="#a818a91c1f898a6e1ade715a0e3acd366">More...</a><br/></td></tr>
<tr class="separator:a818a91c1f898a6e1ade715a0e3acd366"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0118d9721a45e6c2e784d5ddb7a93dd9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a0118d9721a45e6c2e784d5ddb7a93dd9">POLARSSL_HMAC_DRBG_MAX_SEED_INPUT</a>   384</td></tr>
<tr class="memdesc:a0118d9721a45e6c2e784d5ddb7a93dd9"><td class="mdescLeft"> </td><td class="mdescRight">Maximum size of (re)seed buffer. <a href="#a0118d9721a45e6c2e784d5ddb7a93dd9">More...</a><br/></td></tr>
<tr class="separator:a0118d9721a45e6c2e784d5ddb7a93dd9"><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:a9c45dacf4f93959d2978b07df9f3231e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a9c45dacf4f93959d2978b07df9f3231e">hmac_drbg_init</a> (<a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> *ctx, const <a class="el" href="structmd__info__t.html">md_info_t</a> *md_info, int(*f_entropy)(void *, unsigned char *, size_t), void *p_entropy, const unsigned char *custom, size_t len)</td></tr>
<tr class="memdesc:a9c45dacf4f93959d2978b07df9f3231e"><td class="mdescLeft"> </td><td class="mdescRight">HMAC_DRBG initialisation. <a href="#a9c45dacf4f93959d2978b07df9f3231e">More...</a><br/></td></tr>
<tr class="separator:a9c45dacf4f93959d2978b07df9f3231e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd163a15df844543ab5b950f4d13d65f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#acd163a15df844543ab5b950f4d13d65f">hmac_drbg_init_buf</a> (<a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> *ctx, const <a class="el" href="structmd__info__t.html">md_info_t</a> *md_info, const unsigned char *data, size_t data_len)</td></tr>
<tr class="memdesc:acd163a15df844543ab5b950f4d13d65f"><td class="mdescLeft"> </td><td class="mdescRight">Initilisation of simpified HMAC_DRBG (never reseeds). <a href="#acd163a15df844543ab5b950f4d13d65f">More...</a><br/></td></tr>
<tr class="separator:acd163a15df844543ab5b950f4d13d65f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa415a1f75ea2656beb72e26c68cbe89"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#aaa415a1f75ea2656beb72e26c68cbe89">hmac_drbg_set_prediction_resistance</a> (<a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> *ctx, int resistance)</td></tr>
<tr class="memdesc:aaa415a1f75ea2656beb72e26c68cbe89"><td class="mdescLeft"> </td><td class="mdescRight">Enable / disable prediction resistance (Default: Off) <a href="#aaa415a1f75ea2656beb72e26c68cbe89">More...</a><br/></td></tr>
<tr class="separator:aaa415a1f75ea2656beb72e26c68cbe89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13a01d030a558fc0cea9fa2b5c66da8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a13a01d030a558fc0cea9fa2b5c66da8a">hmac_drbg_set_entropy_len</a> (<a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> *ctx, size_t len)</td></tr>
<tr class="memdesc:a13a01d030a558fc0cea9fa2b5c66da8a"><td class="mdescLeft"> </td><td class="mdescRight">Set the amount of entropy grabbed on each reseed (Default: given by the security strength, which depends on the hash used, see <code><a class="el" href="hmac__drbg_8h.html#a9c45dacf4f93959d2978b07df9f3231e" title="HMAC_DRBG initialisation. ">hmac_drbg_init()</a></code> ) <a href="#a13a01d030a558fc0cea9fa2b5c66da8a">More...</a><br/></td></tr>
<tr class="separator:a13a01d030a558fc0cea9fa2b5c66da8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae06ae3e9279e4e6a9023f469725c8227"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#ae06ae3e9279e4e6a9023f469725c8227">hmac_drbg_set_reseed_interval</a> (<a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> *ctx, int interval)</td></tr>
<tr class="memdesc:ae06ae3e9279e4e6a9023f469725c8227"><td class="mdescLeft"> </td><td class="mdescRight">Set the reseed interval (Default: POLARSSL_HMAC_DRBG_RESEED_INTERVAL) <a href="#ae06ae3e9279e4e6a9023f469725c8227">More...</a><br/></td></tr>
<tr class="separator:ae06ae3e9279e4e6a9023f469725c8227"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea5f53d8763e30ec7ecf053a119f4a23"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#aea5f53d8763e30ec7ecf053a119f4a23">hmac_drbg_update</a> (<a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> *ctx, const unsigned char *additional, size_t add_len)</td></tr>
<tr class="memdesc:aea5f53d8763e30ec7ecf053a119f4a23"><td class="mdescLeft"> </td><td class="mdescRight">HMAC_DRBG update state. <a href="#aea5f53d8763e30ec7ecf053a119f4a23">More...</a><br/></td></tr>
<tr class="separator:aea5f53d8763e30ec7ecf053a119f4a23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a881091e2fc00dd15f3eb44e47bafd180"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a881091e2fc00dd15f3eb44e47bafd180">hmac_drbg_reseed</a> (<a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> *ctx, const unsigned char *additional, size_t len)</td></tr>
<tr class="memdesc:a881091e2fc00dd15f3eb44e47bafd180"><td class="mdescLeft"> </td><td class="mdescRight">HMAC_DRBG reseeding (extracts data from entropy source) <a href="#a881091e2fc00dd15f3eb44e47bafd180">More...</a><br/></td></tr>
<tr class="separator:a881091e2fc00dd15f3eb44e47bafd180"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad73affb17b14ea45ee6cd3cf95187724"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#ad73affb17b14ea45ee6cd3cf95187724">hmac_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:ad73affb17b14ea45ee6cd3cf95187724"><td class="mdescLeft"> </td><td class="mdescRight">HMAC_DRBG generate random with additional update input. <a href="#ad73affb17b14ea45ee6cd3cf95187724">More...</a><br/></td></tr>
<tr class="separator:ad73affb17b14ea45ee6cd3cf95187724"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2f1d201eaba90dc66b7033fa87c1eb9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#ab2f1d201eaba90dc66b7033fa87c1eb9">hmac_drbg_random</a> (void *p_rng, unsigned char *output, size_t out_len)</td></tr>
<tr class="memdesc:ab2f1d201eaba90dc66b7033fa87c1eb9"><td class="mdescLeft"> </td><td class="mdescRight">HMAC_DRBG generate random. <a href="#ab2f1d201eaba90dc66b7033fa87c1eb9">More...</a><br/></td></tr>
<tr class="separator:ab2f1d201eaba90dc66b7033fa87c1eb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a0bf86f3afd2e39cbb3c3a08faf5e44"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hmac__drbg_8h.html#a3a0bf86f3afd2e39cbb3c3a08faf5e44">hmac_drbg_free</a> (<a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> *ctx)</td></tr>
<tr class="memdesc:a3a0bf86f3afd2e39cbb3c3a08faf5e44"><td class="mdescLeft"> </td><td class="mdescRight">Free an HMAC_DRBG context. <a href="#a3a0bf86f3afd2e39cbb3c3a08faf5e44">More...</a><br/></td></tr>
<tr class="separator:a3a0bf86f3afd2e39cbb3c3a08faf5e44"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>HMAC_DRBG (NIST SP 800-90A) </p>
<p>Copyright (C) 2014, Brainspark B.V.</p>
<p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p>
<p>All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p>
<p>Definition in file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a0d9472d39e70c4eeb3cb06177c3012f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED   -0x0009</td>
</tr>
</table>
</div><div class="memdoc">
<p>The entropy source failed. </p>
<p>Definition at line <a class="el" href="hmac__drbg_8h_source.html#l00038">38</a> of file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6a560c35edcfca2ab71f39e2c70d50c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_HMAC_DRBG_FILE_IO_ERROR   -0x0007</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read/write error in file. </p>
<p>Definition at line <a class="el" href="hmac__drbg_8h_source.html#l00037">37</a> of file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div>
</div>
<a class="anchor" id="a63ba4f9a4e98f5d1af93e33c3e1fe3b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_HMAC_DRBG_INPUT_TOO_BIG   -0x0005</td>
</tr>
</table>
</div><div class="memdoc">
<p>Input too large (Entropy + additional). </p>
<p>Definition at line <a class="el" href="hmac__drbg_8h_source.html#l00036">36</a> of file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4d06fc2204001f56acb2a1eabfbbf036"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_HMAC_DRBG_REQUEST_TOO_BIG   -0x0003</td>
</tr>
</table>
</div><div class="memdoc">
<p>Too many random requested in single call. </p>
<p>Definition at line <a class="el" href="hmac__drbg_8h_source.html#l00035">35</a> of file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad42367f0fecb12f9962f0798857b86ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_HMAC_DRBG_MAX_INPUT   256</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of additional input bytes. </p>
<p>Definition at line <a class="el" href="hmac__drbg_8h_source.html#l00053">53</a> of file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div>
</div>
<a class="anchor" id="a818a91c1f898a6e1ade715a0e3acd366"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_HMAC_DRBG_MAX_REQUEST   1024</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of requested bytes per call. </p>
<p>Definition at line <a class="el" href="hmac__drbg_8h_source.html#l00057">57</a> of file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0118d9721a45e6c2e784d5ddb7a93dd9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_HMAC_DRBG_MAX_SEED_INPUT   384</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum size of (re)seed buffer. </p>
<p>Definition at line <a class="el" href="hmac__drbg_8h_source.html#l00061">61</a> of file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1df2abd47fc8c24f9ce5c02c86337dad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_HMAC_DRBG_PR_OFF   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>No prediction resistance. </p>
<p>Definition at line <a class="el" href="hmac__drbg_8h_source.html#l00066">66</a> of file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div>
</div>
<a class="anchor" id="a48149f1fd6d91c46a1a4f1574cd65653"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_HMAC_DRBG_PR_ON   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prediction resistance enabled. </p>
<p>Definition at line <a class="el" href="hmac__drbg_8h_source.html#l00067">67</a> of file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa3d9fee8fa351e1e9c828f39f63e89f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_HMAC_DRBG_RESEED_INTERVAL   10000</td>
</tr>
</table>
</div><div class="memdoc">
<p>Interval before reseed is performed by default. </p>
<p>Definition at line <a class="el" href="hmac__drbg_8h_source.html#l00049">49</a> of file <a class="el" href="hmac__drbg_8h_source.html">hmac_drbg.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a3a0bf86f3afd2e39cbb3c3a08faf5e44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hmac_drbg_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free an HMAC_DRBG context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>HMAC_DRBG context to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9c45dacf4f93959d2978b07df9f3231e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hmac_drbg_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmd__info__t.html">md_info_t</a> * </td>
<td class="paramname"><em>md_info</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>HMAC_DRBG initialisation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>HMAC_DRBG context to be initialised </td></tr>
<tr><td class="paramname">md_info</td><td>MD algorithm to use for HMAC_DRBG </td></tr>
<tr><td class="paramname">f_entropy</td><td>Entropy callback (p_entropy, buffer to fill, buffer length) </td></tr>
<tr><td class="paramname">p_entropy</td><td>Entropy context </td></tr>
<tr><td class="paramname">custom</td><td>Personalization data (Device specific identifiers) (Can be NULL) </td></tr>
<tr><td class="paramname">len</td><td>Length of personalization data</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The "security strength" as defined by NIST is set to: 128 bits if md_alg is SHA-1, 192 bits if md_alg is SHA-224, 256 bits if md_alg is SHA-256 or higher. Note that SHA-256 is just as efficient as SHA-224.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or POLARSSL_ERR_MD_BAD_INPUT_DATA, or POLARSSL_ERR_MD_ALLOC_FAILED, or POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED. </dd></dl>
</div>
</div>
<a class="anchor" id="acd163a15df844543ab5b950f4d13d65f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hmac_drbg_init_buf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhmac__drbg__context.html">hmac_drbg_context</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmd__info__t.html">md_info_t</a> * </td>
<td class="paramname"><em>md_info</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>data_len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initilisation of simpified HMAC_DRBG (never reseeds). </p>
<pre class="fragment"> (For use with deterministic ECDSA.)
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>HMAC_DRBG context to be initialised </td></tr>
<tr><td class="paramname">md_info</td><td>MD algorithm to use for HMAC_DRBG </td></tr>
<tr><td class="paramname">data</td><td>Concatenation of entropy string and additional data </td></tr>
<tr><td class="paramname">data_len</td><td>Length of data in bytes</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or POLARSSL_ERR_MD_BAD_INPUT_DATA, or POLARSSL_ERR_MD_ALLOC_FAILED. </dd></dl>
</div>
</div>
<a class="anchor" id="ab2f1d201eaba90dc66b7033fa87c1eb9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hmac_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>out_len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>HMAC_DRBG generate random. </p>
<p>Note: Automatically reseeds if reseed_counter is reached or PR is enabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_rng</td><td>HMAC_DRBG context </td></tr>
<tr><td class="paramname">output</td><td>Buffer to fill </td></tr>
<tr><td class="paramname">out_len</td><td>Length of the buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or POLARSSL_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED, or POLARSSL_ERR_HMAC_DRBG_REQUEST_TOO_BIG </dd></dl>
</div>
</div>
<a class="anchor" id="ad73affb17b14ea45ee6cd3cf95187724"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hmac_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>HMAC_DRBG generate random with additional update input. </p>
<p>Note: Automatically reseeds if reseed_counter is reached or PR is enabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_rng</td><td>HMAC_DRBG context </td></tr>
<tr><td class="paramname">output</td><td>Buffer to fill </td></tr>
<tr><td class="paramname">output_len</td><td>Length of the buffer </td></tr>
<tr><td class="paramname">additional</td><td>Additional data to update with (can be NULL) </td></tr>
<tr><td class="paramname">add_len</td><td>Length of additional data (can be 0)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or POLARSSL_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED, or POLARSSL_ERR_HMAC_DRBG_REQUEST_TOO_BIG, or POLARSSL_ERR_HMAC_DRBG_INPUT_TOO_BIG. </dd></dl>
</div>
</div>
<a class="anchor" id="a881091e2fc00dd15f3eb44e47bafd180"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hmac_drbg_reseed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhmac__drbg__context.html">hmac_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>HMAC_DRBG reseeding (extracts data from entropy source) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>HMAC_DRBG context </td></tr>
<tr><td class="paramname">additional</td><td>Additional data to add to state (Can be NULL) </td></tr>
<tr><td class="paramname">len</td><td>Length of additional data</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or POLARSSL_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED </dd></dl>
</div>
</div>
<a class="anchor" id="a13a01d030a558fc0cea9fa2b5c66da8a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hmac_drbg_set_entropy_len </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhmac__drbg__context.html">hmac_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>Set the amount of entropy grabbed on each reseed (Default: given by the security strength, which depends on the hash used, see <code><a class="el" href="hmac__drbg_8h.html#a9c45dacf4f93959d2978b07df9f3231e" title="HMAC_DRBG initialisation. ">hmac_drbg_init()</a></code> ) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>HMAC_DRBG context </td></tr>
<tr><td class="paramname">len</td><td>Amount of entropy to grab, in bytes </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaa415a1f75ea2656beb72e26c68cbe89"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hmac_drbg_set_prediction_resistance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhmac__drbg__context.html">hmac_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>Enable / disable prediction resistance (Default: Off) </p>
<p>Note: If enabled, entropy is used for ctx->entropy_len before each call! Only use this if you have ample supply of good entropy!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>HMAC_DRBG context </td></tr>
<tr><td class="paramname">resistance</td><td>POLARSSL_HMAC_DRBG_PR_ON or POLARSSL_HMAC_DRBG_PR_OFF </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae06ae3e9279e4e6a9023f469725c8227"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hmac_drbg_set_reseed_interval </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhmac__drbg__context.html">hmac_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>Set the reseed interval (Default: POLARSSL_HMAC_DRBG_RESEED_INTERVAL) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>HMAC_DRBG context </td></tr>
<tr><td class="paramname">interval</td><td>Reseed interval </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aea5f53d8763e30ec7ecf053a119f4a23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hmac_drbg_update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhmac__drbg__context.html">hmac_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>HMAC_DRBG update state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>HMAC_DRBG context </td></tr>
<tr><td class="paramname">additional</td><td>Additional data to update state with, or NULL </td></tr>
<tr><td class="paramname">add_len</td><td>Length of additional data, or 0</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Additional data is optional, pass NULL and 0 as second third argument if no additional data is being used. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:56 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>
