<!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/sha384.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">sha384.h File Reference<div class="ingroups"><a class="el" href="group__HASH__m.html">Hash Functions</a> | <a class="el" href="group__HASH__sha384__m.html">Hash Functions: SHA-384</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>SHA-384 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 sha384.h:</div>
<div class="dyncontent">
<div class="center"><img src="sha384_8h__incl.png" border="0" usemap="#include_2beecrypt_2sha384_8h" alt=""/></div>
<map name="include_2beecrypt_2sha384_8h" id="include_2beecrypt_2sha384_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="sha384_8h__dep__incl.png" border="0" usemap="#include_2beecrypt_2sha384_8hdep" alt=""/></div>
<map name="include_2beecrypt_2sha384_8hdep" id="include_2beecrypt_2sha384_8hdep">
<area shape="rect" id="node2" href="hmacsha384_8h.html" title="HMAC-SHA-384 message authentication code, headers. " alt="" coords="5,80,211,107"/></map>
</div>
</div>
<p><a href="sha384_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="structsha384Param.html">sha384Param</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Holds all the parameters necessary for the SHA-384 algorithm. <a href="structsha384Param.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:aaf23053c0063774f4148d7163ba7a54e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha384_8h.html#aaf23053c0063774f4148d7163ba7a54e">sha384Process</a> (<a class="el" href="structsha384Param.html">sha384Param</a> *sp)</td></tr>
<tr class="memdesc:aaf23053c0063774f4148d7163ba7a54e"><td class="mdescLeft"> </td><td class="mdescRight">This function performs the core of the SHA-384 hash algorithm; it processes a block of 128 bytes. <a href="#aaf23053c0063774f4148d7163ba7a54e">More...</a><br/></td></tr>
<tr class="separator:aaf23053c0063774f4148d7163ba7a54e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1dac6fddc17b3c1b345884a48a6eb7e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha384_8h.html#ab1dac6fddc17b3c1b345884a48a6eb7e">sha384Reset</a> (<a class="el" href="structsha384Param.html">sha384Param</a> *sp)</td></tr>
<tr class="memdesc:ab1dac6fddc17b3c1b345884a48a6eb7e"><td class="mdescLeft"> </td><td class="mdescRight">This function resets the parameter block so that it's ready for a new hash. <a href="#ab1dac6fddc17b3c1b345884a48a6eb7e">More...</a><br/></td></tr>
<tr class="separator:ab1dac6fddc17b3c1b345884a48a6eb7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60bf9f4d81bed2f72a68bc81c9940d10"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha384_8h.html#a60bf9f4d81bed2f72a68bc81c9940d10">sha384Update</a> (<a class="el" href="structsha384Param.html">sha384Param</a> *sp, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *data, size_t size)</td></tr>
<tr class="memdesc:a60bf9f4d81bed2f72a68bc81c9940d10"><td class="mdescLeft"> </td><td class="mdescRight">This function should be used to pass successive blocks of data to be hashed. <a href="#a60bf9f4d81bed2f72a68bc81c9940d10">More...</a><br/></td></tr>
<tr class="separator:a60bf9f4d81bed2f72a68bc81c9940d10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ef756fb0e270b60eb5fccecb0f7f73a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha384_8h.html#a4ef756fb0e270b60eb5fccecb0f7f73a">sha384Digest</a> (<a class="el" href="structsha384Param.html">sha384Param</a> *sp, <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *digest)</td></tr>
<tr class="memdesc:a4ef756fb0e270b60eb5fccecb0f7f73a"><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="#a4ef756fb0e270b60eb5fccecb0f7f73a">More...</a><br/></td></tr>
<tr class="separator:a4ef756fb0e270b60eb5fccecb0f7f73a"><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:a542a0f51aff8a28c67fec03c250f8367"><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="sha384_8h.html#a542a0f51aff8a28c67fec03c250f8367">sha384</a></td></tr>
<tr class="memdesc:a542a0f51aff8a28c67fec03c250f8367"><td class="mdescLeft"> </td><td class="mdescRight">Holds the full API description of the SHA-384 algorithm. <a href="#a542a0f51aff8a28c67fec03c250f8367">More...</a><br/></td></tr>
<tr class="separator:a542a0f51aff8a28c67fec03c250f8367"><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-384 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="a4ef756fb0e270b60eb5fccecb0f7f73a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sha384Digest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsha384Param.html">sha384Param</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 64-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="aaf23053c0063774f4148d7163ba7a54e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sha384Process </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsha384Param.html">sha384Param</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-384 hash algorithm; it processes a block of 128 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="ab1dac6fddc17b3c1b345884a48a6eb7e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sha384Reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsha384Param.html">sha384Param</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="a60bf9f4d81bed2f72a68bc81c9940d10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sha384Update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsha384Param.html">sha384Param</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="a542a0f51aff8a28c67fec03c250f8367"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sha384</td>
</tr>
</table>
</div><div class="memdoc">
<p>Holds the full API description of the SHA-384 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>
