<!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/md5.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/md5.h File Reference<div class="ingroups"><a class="el" href="group__HASH__m.html">Hash Functions</a> | <a class="el" href="group__HASH__md5__m.html">Hash Functions: MD5</a></div></h1> </div>
</div>
<div class="contents">
<p>MD5 hash function.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include "beecrypt/beecrypt.h"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for md5.h:</div>
<div class="dyncontent">
<div class="center"><img src="md5_8h__incl.png" border="0" usemap="#include_2beecrypt_2md5_8h" alt=""/></div>
<map name="include_2beecrypt_2md5_8h" id="include_2beecrypt_2md5_8h">
</map>
</div>
</div>
<p><a href="md5_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="structmd5Param.html">md5Param</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds all the parameters necessary for the MD5 algorithm. <a href="structmd5Param.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="md5_8h.html#a18cd2d06bd4e8bbbeae3bd1e0431b4fc">md5Process</a> (<a class="el" href="structmd5Param.html">md5Param</a> *mp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="md5_8h.html#aeb03767a38c0a6dfe46e64d6967d64bb">md5Reset</a> (<a class="el" href="structmd5Param.html">md5Param</a> *mp)</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="#aeb03767a38c0a6dfe46e64d6967d64bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="md5_8h.html#ad63a2d640ca2a7e98c1775c53004bded">md5Update</a> (<a class="el" href="structmd5Param.html">md5Param</a> *mp, 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="#ad63a2d640ca2a7e98c1775c53004bded"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="md5_8h.html#a0886d3137aeecb5596383a3a30aa5ffc">md5Digest</a> (<a class="el" href="structmd5Param.html">md5Param</a> *mp, <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="#a0886d3137aeecb5596383a3a30aa5ffc"></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="md5_8h.html#a3062e1e11c64939824f4f249890f7157">md5</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the full API description of the MD5 algorithm. <a href="#a3062e1e11c64939824f4f249890f7157"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>MD5 hash function. </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="a0886d3137aeecb5596383a3a30aa5ffc"></a><!-- doxytag: member="md5.h::md5Digest" ref="a0886d3137aeecb5596383a3a30aa5ffc" args="(md5Param *mp, byte *digest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int md5Digest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmd5Param.html">md5Param</a> * </td>
<td class="paramname"><em>mp</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">mp</td><td>The hash function's parameter block. </td></tr>
<tr><td class="paramname">digest</td><td>The place to store the 16-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="a18cd2d06bd4e8bbbeae3bd1e0431b4fc"></a><!-- doxytag: member="md5.h::md5Process" ref="a18cd2d06bd4e8bbbeae3bd1e0431b4fc" args="(md5Param *mp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void md5Process </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmd5Param.html">md5Param</a> * </td>
<td class="paramname"><em>mp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aeb03767a38c0a6dfe46e64d6967d64bb"></a><!-- doxytag: member="md5.h::md5Reset" ref="aeb03767a38c0a6dfe46e64d6967d64bb" args="(md5Param *mp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int md5Reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmd5Param.html">md5Param</a> * </td>
<td class="paramname"><em>mp</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">mp</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="ad63a2d640ca2a7e98c1775c53004bded"></a><!-- doxytag: member="md5.h::md5Update" ref="ad63a2d640ca2a7e98c1775c53004bded" args="(md5Param *mp, const byte *data, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int md5Update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmd5Param.html">md5Param</a> * </td>
<td class="paramname"><em>mp</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">mp</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="a3062e1e11c64939824f4f249890f7157"></a><!-- doxytag: member="md5.h::md5" ref="a3062e1e11c64939824f4f249890f7157" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="md5_8h.html#a3062e1e11c64939824f4f249890f7157">md5</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Holds the full API description of the MD5 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>
