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

57
classKeccakCore.html
View File

@@ -130,6 +130,9 @@ Public Member Functions</h2></td></tr>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKeccakCore.html#aeff1df56e4a3103c99c1fe4307e60c66">clear</a> ()</td></tr>
<tr class="memdesc:aeff1df56e4a3103c99c1fe4307e60c66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears all sensitive data from this object. <br/></td></tr>
<tr class="separator:aeff1df56e4a3103c99c1fe4307e60c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeff6b3357916bf426b60d3629db52628"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKeccakCore.html#aeff6b3357916bf426b60d3629db52628">setHMACKey</a> (const void *key, size_t len, uint8_t <a class="el" href="classKeccakCore.html#a97852ee4381ced17ee6d21704cf0b4d7">pad</a>, size_t hashSize)</td></tr>
<tr class="memdesc:aeff6b3357916bf426b60d3629db52628"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a HMAC key for a Keccak-based hash algorithm. <a href="#aeff6b3357916bf426b60d3629db52628">More...</a><br/></td></tr>
<tr class="separator:aeff6b3357916bf426b60d3629db52628"><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>Keccak core sponge function. </p>
@@ -322,6 +325,58 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<p>Definition at line <a class="el" href="KeccakCore_8cpp_source.html#l00089">89</a> of file <a class="el" href="KeccakCore_8cpp_source.html">KeccakCore.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aeff6b3357916bf426b60d3629db52628"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KeccakCore::setHMACKey </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>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>pad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>hashSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a HMAC key for a Keccak-based hash algorithm. </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">len</td><td>Length of the HMAC <em>key</em> in bytes. </td></tr>
<tr><td class="paramname">pad</td><td>Inner (0x36) or outer (0x5C) padding value to XOR with the formatted HMAC key. </td></tr>
<tr><td class="paramname">hashSize</td><td>The size of the output from the hash algorithm.</td></tr>
</table>
</dd>
</dl>
<p>This function is intended to help classes implement <a class="el" href="classHash.html#adf50359c1f525af884721cc9034e7945" title="Resets the hash ready for a new HMAC hashing process. ">Hash::resetHMAC()</a> and <a class="el" href="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06" title="Finalizes the HMAC hashing process and returns the hash. ">Hash::finalizeHMAC()</a> by directly formatting the HMAC key into the internal block buffer and resetting the hash. </p>
<p>Definition at line <a class="el" href="KeccakCore_8cpp_source.html#l00263">263</a> of file <a class="el" href="KeccakCore_8cpp_source.html">KeccakCore.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaaa0355ccec0f469ac8eb577bdf853ed"></a>
@@ -370,7 +425,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</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>