forgetIt/Untracked/Doxygen/html/classHASHCrypt.html
2015-03-21 06:55:46 +01:00

212 lines
9.9 KiB
HTML

<!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"/>
<title>forgetIt: HASHCrypt Class 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">forgetIt
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classHASHCrypt-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">HASHCrypt Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Hashing class.
<a href="classHASHCrypt.html#details">More...</a></p>
<p><code>#include &quot;<a class="el" href="HASHCrypt_8hpp_source.html">/CryptClass/HASHCrypt.hpp</a>&quot;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1eeb2543bd9b49e5dd9d6f4d5939eca1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1eeb2543bd9b49e5dd9d6f4d5939eca1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHASHCrypt.html#a1eeb2543bd9b49e5dd9d6f4d5939eca1">HASHCrypt</a> ()</td></tr>
<tr class="memdesc:a1eeb2543bd9b49e5dd9d6f4d5939eca1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contructor. <br/></td></tr>
<tr class="memitem:a55205da17c4c8a9c00c408bbe3b054dd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55205da17c4c8a9c00c408bbe3b054dd"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHASHCrypt.html#a55205da17c4c8a9c00c408bbe3b054dd">~HASHCrypt</a> ()</td></tr>
<tr class="memdesc:a55205da17c4c8a9c00c408bbe3b054dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br/></td></tr>
<tr class="memitem:aa44ba778865df0025793506eff45e8f0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHASHCrypt.html#aa44ba778865df0025793506eff45e8f0">getMD5_128</a> (std::string chain, byte *digest, int size)</td></tr>
<tr class="memdesc:aa44ba778865df0025793506eff45e8f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an MD5 over 128 bits on a digest array of bytes. <a href="#aa44ba778865df0025793506eff45e8f0"></a><br/></td></tr>
<tr class="memitem:aae74b6215ff20533b421e3bb61f561dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHASHCrypt.html#aae74b6215ff20533b421e3bb61f561dc">getSHA_256</a> (std::string chain, byte *digest, int size)</td></tr>
<tr class="memdesc:aae74b6215ff20533b421e3bb61f561dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an SHA over 256 bits on a digest array of bytes. <a href="#aae74b6215ff20533b421e3bb61f561dc"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Hashing class. </p>
<dl class="section author"><dt>Author</dt><dd>manzerbredes</dd></dl>
<p>Class who handle hashing functions to a byte* parameter. <a class="el" href="classHASHCrypt.html" title="Hashing class.">HASHCrypt</a> try to detect errors and throw exceptions. <a class="el" href="classHASHCrypt.html" title="Hashing class.">HASHCrypt</a> use crypto++ library. </p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="aa44ba778865df0025793506eff45e8f0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HASHCrypt::getMD5_128 </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>chain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte *&#160;</td>
<td class="paramname"><em>digest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an MD5 over 128 bits on a digest array of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chain</td><td>: Chain to hash </td></tr>
<tr><td class="paramname">digest</td><td>: An array of bytes (8 bits) </td></tr>
<tr><td class="paramname">size</td><td>: Length of the array digest</td></tr>
</table>
</dd>
</dl>
<p><b>Warning</b> digest will be modified. </p>
</div>
</div>
<a class="anchor" id="aae74b6215ff20533b421e3bb61f561dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HASHCrypt::getSHA_256 </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>chain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte *&#160;</td>
<td class="paramname"><em>digest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an SHA over 256 bits on a digest array of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chain</td><td>: Chain to hash </td></tr>
<tr><td class="paramname">digest</td><td>: An array of bytes (8 bits) </td></tr>
<tr><td class="paramname">size</td><td>: Length of the array digest</td></tr>
</table>
</dd>
</dl>
<p><b>Warning</b> digest will be modified. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>CryptClass/<a class="el" href="HASHCrypt_8hpp_source.html">HASHCrypt.hpp</a></li>
<li>CryptClass/<a class="el" href="HASHCrypt_8cpp.html">HASHCrypt.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Mar 8 2015 08:56:48 for forgetIt by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>