<!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"/>
<title>BeeCrypt: include/beecrypt/sha1.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<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>
<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>
<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">
<h1>include/beecrypt/sha1.h File Reference<div class="ingroups"><a class="el" href="group__HASH__m.html">Hash Functions</a> | <a class="el" href="group__HASH__sha1__m.html">Hash Functions: SHA-1</a></div></h1> </div>
</div>
<div class="contents">
<p>SHA-1 hash function, headers.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include "beecrypt/beecrypt.h"</code><br/>
<code>#include "beecrypt/sha1opt.h"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for sha1.h:</div>
<div class="dyncontent">
<div class="center"><img src="sha1_8h__incl.png" border="0" usemap="#include_2beecrypt_2sha1_8h" alt=""/></div>
<map name="include_2beecrypt_2sha1_8h" id="include_2beecrypt_2sha1_8h">
</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="sha1_8h__dep__incl.png" border="0" usemap="#include_2beecrypt_2sha1_8hdep" alt=""/></div>
<map name="include_2beecrypt_2sha1_8hdep" id="include_2beecrypt_2sha1_8hdep">
<area shape="rect" id="node3" href="fips186_8h.html" title="FIPS-186 pseudo-random number generator, headers." alt="" coords="5,89,179,122"/></map>
</div>
</div>
<p><a href="sha1_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsha1Param.html">sha1Param</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds all the parameters necessary for the SHA-1 algorithm. <a href="structsha1Param.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#ae6b978435e0ca6d11cf1c1b06e8f3cf3">sha1Process</a> (<a class="el" href="structsha1Param.html">sha1Param</a> *sp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function performs the core of the SHA-1 hash algorithm; it processes a block of 64 bytes. <a href="#ae6b978435e0ca6d11cf1c1b06e8f3cf3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#a8ada986f91101abe14e2c7dddf2e6b3e">sha1Reset</a> (<a class="el" href="structsha1Param.html">sha1Param</a> *sp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function resets the parameter block so that it's ready for a new hash. <a href="#a8ada986f91101abe14e2c7dddf2e6b3e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#ac1c2099636681b34e4c84b540a69b1f4">sha1Update</a> (<a class="el" href="structsha1Param.html">sha1Param</a> *sp, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *data, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function should be used to pass successive blocks of data to be hashed. <a href="#ac1c2099636681b34e4c84b540a69b1f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#a1576a65bc76a35292b33bdd6876131d8">sha1Digest</a> (<a class="el" href="structsha1Param.html">sha1Param</a> *sp, <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *digest)</td></tr>
<tr><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="#a1576a65bc76a35292b33bdd6876131d8"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><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="sha1_8h.html#abd0cb74bfc712f826eb603be9f4f56c9">sha1</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the full API description of the SHA-1 algorithm. <a href="#abd0cb74bfc712f826eb603be9f4f56c9"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>SHA-1 hash function, headers. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Bob Deblier <<a href="mailto:bob.deblier@telenet.be">bob.deblier@telenet.be</a>> </dd></dl>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a1576a65bc76a35292b33bdd6876131d8"></a><!-- doxytag: member="sha1.h::sha1Digest" ref="a1576a65bc76a35292b33bdd6876131d8" args="(sha1Param *sp, byte *digest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sha1Digest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsha1Param.html">sha1Param</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><dt><b>Parameters:</b></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 20-byte digest. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></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="ae6b978435e0ca6d11cf1c1b06e8f3cf3"></a><!-- doxytag: member="sha1.h::sha1Process" ref="ae6b978435e0ca6d11cf1c1b06e8f3cf3" args="(sha1Param *sp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sha1Process </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsha1Param.html">sha1Param</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-1 hash algorithm; it processes a block of 64 bytes. </p>
<dl><dt><b>Parameters:</b></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="a8ada986f91101abe14e2c7dddf2e6b3e"></a><!-- doxytag: member="sha1.h::sha1Reset" ref="a8ada986f91101abe14e2c7dddf2e6b3e" args="(sha1Param *sp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sha1Reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsha1Param.html">sha1Param</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><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sp</td><td>The hash function's parameter block. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></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="ac1c2099636681b34e4c84b540a69b1f4"></a><!-- doxytag: member="sha1.h::sha1Update" ref="ac1c2099636681b34e4c84b540a69b1f4" args="(sha1Param *sp, const byte *data, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sha1Update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsha1Param.html">sha1Param</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><dt><b>Parameters:</b></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><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="abd0cb74bfc712f826eb603be9f4f56c9"></a><!-- doxytag: member="sha1.h::sha1" ref="abd0cb74bfc712f826eb603be9f4f56c9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sha1_8h.html#abd0cb74bfc712f826eb603be9f4f56c9">sha1</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Holds the full API description of the SHA-1 algorithm. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Apr 10 2011 20:49:30 for BeeCrypt by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
