<!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>BeeCrypt: include/beecrypt/sha256.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">BeeCrypt  <span id="projectnumber">4.2.1</span> </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="pages.html"><span>Related Pages</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_7519372152c32ce484a8cde0fb6b8cd0.html">beecrypt</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#func-members">Functions</a> | <a href="#var-members">Variables</a> </div> <div class="headertitle"> <div class="title">sha256.h File Reference<div class="ingroups"><a class="el" href="group__HASH__m.html">Hash Functions</a> | <a class="el" href="group__HASH__sha256__m.html">Hash Functions: SHA-256</a></div></div> </div> </div><!--header--> <div class="contents"> <p>SHA-256 hash function, headers. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="beecrypt_8h_source.html">beecrypt/beecrypt.h</a>"</code><br/> </div><div class="textblock"><div class="dynheader"> Include dependency graph for sha256.h:</div> <div class="dyncontent"> <div class="center"><img src="sha256_8h__incl.png" border="0" usemap="#include_2beecrypt_2sha256_8h" alt=""/></div> <map name="include_2beecrypt_2sha256_8h" id="include_2beecrypt_2sha256_8h"> <area shape="rect" id="node2" href="beecrypt_8h.html" title="BeeCrypt API, headers. " alt="" coords="485,80,621,107"/><area shape="rect" id="node3" href="api_8h.html" title="BeeCrypt API, portability headers. " alt="" coords="444,304,548,331"/><area shape="rect" id="node15" href="memchunk_8h.html" title="beecrypt/memchunk.h" alt="" coords="478,155,628,181"/><area shape="rect" id="node16" href="mpnumber_8h.html" title="Multi-precision numbers, headers. " alt="" coords="653,155,800,181"/><area shape="rect" id="node4" href="gnu_8h.html" title="beecrypt/gnu.h" alt="" coords="442,379,549,405"/><area shape="rect" id="node17" href="mp_8h.html" title="Multi-precision integer routines. " alt="" coords="567,229,672,256"/><area shape="rect" id="node18" href="mpopt_8h.html" title="Multi-precision integer optimization definitions. " alt="" coords="572,304,695,331"/></map> </div> </div><div class="textblock"><div class="dynheader"> This graph shows which files directly or indirectly include this file:</div> <div class="dyncontent"> <div class="center"><img src="sha256_8h__dep__incl.png" border="0" usemap="#include_2beecrypt_2sha256_8hdep" alt=""/></div> <map name="include_2beecrypt_2sha256_8hdep" id="include_2beecrypt_2sha256_8hdep"> <area shape="rect" id="node2" href="hmacsha256_8h.html" title="HMAC-SHA-256 message authentication code, headers. " alt="" coords="5,80,211,107"/></map> </div> </div> <p><a href="sha256_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="structsha256Param.html">sha256Param</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Holds all the parameters necessary for the SHA-256 algorithm. <a href="structsha256Param.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="func-members"></a> Functions</h2></td></tr> <tr class="memitem:a0e0db13a02e016e19a677057e472960f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#a0e0db13a02e016e19a677057e472960f">sha256Process</a> (<a class="el" href="structsha256Param.html">sha256Param</a> *sp)</td></tr> <tr class="memdesc:a0e0db13a02e016e19a677057e472960f"><td class="mdescLeft"> </td><td class="mdescRight">This function performs the core of the SHA-256 hash algorithm; it processes a block of 64 bytes. <a href="#a0e0db13a02e016e19a677057e472960f">More...</a><br/></td></tr> <tr class="separator:a0e0db13a02e016e19a677057e472960f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af74134022427bead53c88a7396fe09bb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#af74134022427bead53c88a7396fe09bb">sha256Reset</a> (<a class="el" href="structsha256Param.html">sha256Param</a> *sp)</td></tr> <tr class="memdesc:af74134022427bead53c88a7396fe09bb"><td class="mdescLeft"> </td><td class="mdescRight">This function resets the parameter block so that it's ready for a new hash. <a href="#af74134022427bead53c88a7396fe09bb">More...</a><br/></td></tr> <tr class="separator:af74134022427bead53c88a7396fe09bb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad319a7f3170b74c82543b0f9445716d1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#ad319a7f3170b74c82543b0f9445716d1">sha256Update</a> (<a class="el" href="structsha256Param.html">sha256Param</a> *sp, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *data, size_t size)</td></tr> <tr class="memdesc:ad319a7f3170b74c82543b0f9445716d1"><td class="mdescLeft"> </td><td class="mdescRight">This function should be used to pass successive blocks of data to be hashed. <a href="#ad319a7f3170b74c82543b0f9445716d1">More...</a><br/></td></tr> <tr class="separator:ad319a7f3170b74c82543b0f9445716d1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac0c9981d67a9dcda8e091bafa70cc944"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#ac0c9981d67a9dcda8e091bafa70cc944">sha256Digest</a> (<a class="el" href="structsha256Param.html">sha256Param</a> *sp, <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *digest)</td></tr> <tr class="memdesc:ac0c9981d67a9dcda8e091bafa70cc944"><td class="mdescLeft"> </td><td class="mdescRight">This function finishes the current hash computation and copies the digest value into <em>digest</em>. <a href="#ac0c9981d67a9dcda8e091bafa70cc944">More...</a><br/></td></tr> <tr class="separator:ac0c9981d67a9dcda8e091bafa70cc944"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> Variables</h2></td></tr> <tr class="memitem:a679979280ae9498651049fe553f9afae"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structhashFunction.html">hashFunction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#a679979280ae9498651049fe553f9afae">sha256</a></td></tr> <tr class="memdesc:a679979280ae9498651049fe553f9afae"><td class="mdescLeft"> </td><td class="mdescRight">Holds the full API description of the SHA-256 algorithm. <a href="#a679979280ae9498651049fe553f9afae">More...</a><br/></td></tr> <tr class="separator:a679979280ae9498651049fe553f9afae"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>SHA-256 hash function, headers. </p> <dl class="section author"><dt>Author</dt><dd>Bob Deblier <a href="#" onclick="location.href='mai'+'lto:'+'bob'+'.d'+'ebl'+'ie'+'r@t'+'el'+'ene'+'t.'+'be'; return false;">bob.d<span style="display: none;">.nosp@m.</span>ebli<span style="display: none;">.nosp@m.</span>er@te<span style="display: none;">.nosp@m.</span>lene<span style="display: none;">.nosp@m.</span>t.be</a> </dd></dl> </div><h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ac0c9981d67a9dcda8e091bafa70cc944"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int sha256Digest </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha256Param.html">sha256Param</a> * </td> <td class="paramname"><em>sp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> * </td> <td class="paramname"><em>digest</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function finishes the current hash computation and copies the digest value into <em>digest</em>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">sp</td><td>The hash function's parameter block. </td></tr> <tr><td class="paramname">digest</td><td>The place to store the 32-byte digest. </td></tr> </table> </dd> </dl> <dl class="retval"><dt>Return values</dt><dd> <table class="retval"> <tr><td class="paramname">0</td><td>on success. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a0e0db13a02e016e19a677057e472960f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void sha256Process </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha256Param.html">sha256Param</a> * </td> <td class="paramname"><em>sp</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>This function performs the core of the SHA-256 hash algorithm; it processes a block of 64 bytes. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">sp</td><td>The hash function's parameter block. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="af74134022427bead53c88a7396fe09bb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int sha256Reset </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha256Param.html">sha256Param</a> * </td> <td class="paramname"><em>sp</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>This function resets the parameter block so that it's ready for a new hash. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">sp</td><td>The hash function's parameter block. </td></tr> </table> </dd> </dl> <dl class="retval"><dt>Return values</dt><dd> <table class="retval"> <tr><td class="paramname">0</td><td>on success. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ad319a7f3170b74c82543b0f9445716d1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int sha256Update </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha256Param.html">sha256Param</a> * </td> <td class="paramname"><em>sp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> * </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>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function should be used to pass successive blocks of data to be hashed. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">sp</td><td>The hash function's parameter block. </td></tr> <tr><td class="paramname">data</td><td></td></tr> <tr><td class="paramname">size</td><td></td></tr> </table> </dd> </dl> <dl class="retval"><dt>Return values</dt><dd> <table class="retval"> <tr><td class="paramname">0</td><td>on success. </td></tr> </table> </dd> </dl> </div> </div> <h2 class="groupheader">Variable Documentation</h2> <a class="anchor" id="a679979280ae9498651049fe553f9afae"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">sha256</td> </tr> </table> </div><div class="memdoc"> <p>Holds the full API description of the SHA-256 algorithm. </p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Sep 27 2013 02:36:25 for BeeCrypt 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>