taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-03-25 19:36:25 +10:00
parent fba6ac9417
commit efb2741e4a
306 changed files with 2931 additions and 1386 deletions
Download Patch File Download Diff File Expand all files Collapse all files

151
classSHA3__512.html
View File

@@ -133,6 +133,12 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
<tr class="memitem:acfbc5e9b4d394f011d5132a2b156d260"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA3__512.html#acfbc5e9b4d394f011d5132a2b156d260">clear</a> ()</td></tr>
<tr class="memdesc:acfbc5e9b4d394f011d5132a2b156d260"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the hash state, removing all sensitive data, and then resets the hash ready for a new hashing process. <a href="#acfbc5e9b4d394f011d5132a2b156d260">More...</a><br/></td></tr>
<tr class="separator:acfbc5e9b4d394f011d5132a2b156d260"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac7133f420f2be0288965c2e863f389b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA3__512.html#aac7133f420f2be0288965c2e863f389b">resetHMAC</a> (const void *key, size_t keyLen)</td></tr>
<tr class="memdesc:aac7133f420f2be0288965c2e863f389b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the hash ready for a new HMAC hashing process. <a href="#aac7133f420f2be0288965c2e863f389b">More...</a><br/></td></tr>
<tr class="separator:aac7133f420f2be0288965c2e863f389b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25c9d2da26d01d46ba6b72c8a7905ea0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA3__512.html#a25c9d2da26d01d46ba6b72c8a7905ea0">finalizeHMAC</a> (const void *key, size_t keyLen, void *hash, size_t hashLen)</td></tr>
<tr class="memdesc:a25c9d2da26d01d46ba6b72c8a7905ea0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finalizes the HMAC hashing process and returns the hash. <a href="#a25c9d2da26d01d46ba6b72c8a7905ea0">More...</a><br/></td></tr>
<tr class="separator:a25c9d2da26d01d46ba6b72c8a7905ea0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classHash"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classHash')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classHash.html">Hash</a></td></tr>
<tr class="memitem:af482880ad75b67a09d2dcb5e86244d80 inherit pub_methods_classHash"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af482880ad75b67a09d2dcb5e86244d80"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#af482880ad75b67a09d2dcb5e86244d80">Hash</a> ()</td></tr>
@@ -141,13 +147,20 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
<tr class="memitem:a4e4b4797dda8678aaed058bae155813e inherit pub_methods_classHash"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#a4e4b4797dda8678aaed058bae155813e">~Hash</a> ()</td></tr>
<tr class="memdesc:a4e4b4797dda8678aaed058bae155813e inherit pub_methods_classHash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this hash object. <a href="#a4e4b4797dda8678aaed058bae155813e">More...</a><br/></td></tr>
<tr class="separator:a4e4b4797dda8678aaed058bae155813e inherit pub_methods_classHash"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classHash"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classHash')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classHash.html">Hash</a></td></tr>
<tr class="memitem:ab6f40c9af91dc3d738d9fcce59af63cc inherit pro_methods_classHash"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#ab6f40c9af91dc3d738d9fcce59af63cc">formatHMACKey</a> (void *block, const void *key, size_t len, uint8_t pad)</td></tr>
<tr class="memdesc:ab6f40c9af91dc3d738d9fcce59af63cc inherit pro_methods_classHash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats a HMAC key into a block. <a href="#ab6f40c9af91dc3d738d9fcce59af63cc">More...</a><br/></td></tr>
<tr class="separator:ab6f40c9af91dc3d738d9fcce59af63cc inherit pro_methods_classHash"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SHA3-512 hash algorithm. </p>
<p>Reference: <a href="http://en.wikipedia.org/wiki/SHA-3">http://en.wikipedia.org/wiki/SHA-3</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSHA3__256.html" title="SHA3-256 hash algorithm. ">SHA3_256</a> </dd></dl>
<p>Definition at line <a class="el" href="SHA3_8h_source.html#l00048">48</a> of file <a class="el" href="SHA3_8h_source.html">SHA3.h</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8h_source.html#l00051">51</a> of file <a class="el" href="SHA3_8h_source.html">SHA3.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4493a717bad8fa5cd35fe3aa36f25ab3"></a>
<div class="memitem">
@@ -175,7 +188,7 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
<p>Implements <a class="el" href="classHash.html#a4e4297812e3483410556830fe5d47bdf">Hash</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00112">112</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00128">128</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
</div>
</div>
@@ -205,7 +218,7 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
<p>Implements <a class="el" href="classHash.html#a4a959469433cd9348ab7f3ac6228bb34">Hash</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00134">134</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00150">150</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
</div>
</div>
@@ -251,11 +264,73 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
</dl>
<p>If <em>len</em> is less than <a class="el" href="classSHA3__512.html#a9f13e4d2b99dd204e96b11142e9c1803" title="Size of the hash result from finalize(). ">hashSize()</a>, then the hash value will be truncated to the first <em>len</em> bytes. If <em>len</em> is greater than <a class="el" href="classSHA3__512.html#a9f13e4d2b99dd204e96b11142e9c1803" title="Size of the hash result from finalize(). ">hashSize()</a>, then the remaining bytes will left unchanged.</p>
<p>If <a class="el" href="classSHA3__512.html#ac0227aafb5f047bb50f0bd84df0b4b5b" title="Finalizes the hashing process and returns the hash. ">finalize()</a> is called again, then the returned <em>hash</em> value is undefined. Call <a class="el" href="classSHA3__512.html#a435746d5a8b012f7c65050337cc4a23f" title="Resets the hash ready for a new hashing process. ">reset()</a> first to start a new hashing process.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSHA3__512.html#a435746d5a8b012f7c65050337cc4a23f" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classSHA3__512.html#a0563e4c87150e6019671b4fe92fd63a4" title="Updates the hash with more data. ">update()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSHA3__512.html#a435746d5a8b012f7c65050337cc4a23f" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classSHA3__512.html#a0563e4c87150e6019671b4fe92fd63a4" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classSHA3__512.html#a25c9d2da26d01d46ba6b72c8a7905ea0" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a> </dd></dl>
<p>Implements <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c">Hash</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00127">127</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00143">143</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a25c9d2da26d01d46ba6b72c8a7905ea0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SHA3_512::finalizeHMAC </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>keyLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>hashLen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Finalizes the HMAC hashing process and returns the hash. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>Points to the HMAC key for the hashing process. The contents of this array must be identical to the value passed to <a class="el" href="classSHA3__512.html#aac7133f420f2be0288965c2e863f389b" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a>. </td></tr>
<tr><td class="paramname">keyLen</td><td>Size of the HMAC <em>key</em> in bytes. </td></tr>
<tr><td class="paramname">hash</td><td>The buffer to return the hash value in. </td></tr>
<tr><td class="paramname">hashLen</td><td>The length of the <em>hash</em> buffer, normally <a class="el" href="classSHA3__512.html#a9f13e4d2b99dd204e96b11142e9c1803" title="Size of the hash result from finalize(). ">hashSize()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSHA3__512.html#aac7133f420f2be0288965c2e863f389b" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a>, <a class="el" href="classSHA3__512.html#ac0227aafb5f047bb50f0bd84df0b4b5b" title="Finalizes the hashing process and returns the hash. ">finalize()</a> </dd></dl>
<p>Implements <a class="el" href="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06">Hash</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00160">160</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
</div>
</div>
@@ -285,7 +360,7 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
<p>Implements <a class="el" href="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8">Hash</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00107">107</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00123">123</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
</div>
</div>
@@ -311,11 +386,67 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
</div><div class="memdoc">
<p>Resets the hash ready for a new hashing process. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSHA3__512.html#a0563e4c87150e6019671b4fe92fd63a4" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classSHA3__512.html#ac0227aafb5f047bb50f0bd84df0b4b5b" title="Finalizes the hashing process and returns the hash. ">finalize()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSHA3__512.html#a0563e4c87150e6019671b4fe92fd63a4" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classSHA3__512.html#ac0227aafb5f047bb50f0bd84df0b4b5b" title="Finalizes the hashing process and returns the hash. ">finalize()</a>, <a class="el" href="classSHA3__512.html#aac7133f420f2be0288965c2e863f389b" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> </dd></dl>
<p>Implements <a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61">Hash</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00117">117</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00133">133</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aac7133f420f2be0288965c2e863f389b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SHA3_512::resetHMAC </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>keyLen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the hash ready for a new HMAC hashing process. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>Points to the HMAC key for the hashing process. </td></tr>
<tr><td class="paramname">keyLen</td><td>Size of the HMAC <em>key</em> in bytes.</td></tr>
</table>
</dd>
</dl>
<p>The following example computes a HMAC over a series of data blocks with a specific key:</p>
<div class="fragment"><div class="line">hash.resetHMAC(key, <span class="keyword">sizeof</span>(key));</div>
<div class="line">hash.update(data1, <span class="keyword">sizeof</span>(data1));</div>
<div class="line">hash.update(data2, <span class="keyword">sizeof</span>(data2));</div>
<div class="line">...</div>
<div class="line">hash.update(dataN, <span class="keyword">sizeof</span>(dataN));</div>
<div class="line">hash.finalizeHMAC(key, <span class="keyword">sizeof</span>(key), hmac, <span class="keyword">sizeof</span>(hmac));</div>
</div><!-- fragment --><p>The same key must be passed to both <a class="el" href="classSHA3__512.html#aac7133f420f2be0288965c2e863f389b" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> and <a class="el" href="classSHA3__512.html#a25c9d2da26d01d46ba6b72c8a7905ea0" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSHA3__512.html#a25c9d2da26d01d46ba6b72c8a7905ea0" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a>, <a class="el" href="classSHA3__512.html#a435746d5a8b012f7c65050337cc4a23f" title="Resets the hash ready for a new hashing process. ">reset()</a> </dd></dl>
<p>Implements <a class="el" href="classHash.html#adf50359c1f525af884721cc9034e7945">Hash</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00155">155</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
</div>
</div>
@@ -364,7 +495,7 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
<p>Implements <a class="el" href="classHash.html#aec9761ee427d122e7450de8df200265c">Hash</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00122">122</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
<p>Definition at line <a class="el" href="SHA3_8cpp_source.html#l00138">138</a> of file <a class="el" href="SHA3_8cpp_source.html">SHA3.cpp</a>.</p>
</div>
</div>
@@ -375,7 +506,7 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Mar 22 2015 15:54:26 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Mar 25 2015 19:36:08 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>