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

137
classBLAKE2s.html
View File

@@ -136,6 +136,12 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
<tr class="memitem:a0848885f52df51dc53949d32a206e72d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a0848885f52df51dc53949d32a206e72d">clear</a> ()</td></tr>
<tr class="memdesc:a0848885f52df51dc53949d32a206e72d"><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="#a0848885f52df51dc53949d32a206e72d">More...</a><br/></td></tr>
<tr class="separator:a0848885f52df51dc53949d32a206e72d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f9745854704b34a508497105ca5e2fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd">resetHMAC</a> (const void *key, size_t keyLen)</td></tr>
<tr class="memdesc:a7f9745854704b34a508497105ca5e2fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the hash ready for a new HMAC hashing process. <a href="#a7f9745854704b34a508497105ca5e2fd">More...</a><br/></td></tr>
<tr class="separator:a7f9745854704b34a508497105ca5e2fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f910f3bd48cc4a9c5330c31bcda31fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc">finalizeHMAC</a> (const void *key, size_t keyLen, void *hash, size_t hashLen)</td></tr>
<tr class="memdesc:a3f910f3bd48cc4a9c5330c31bcda31fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finalizes the HMAC hashing process and returns the hash. <a href="#a3f910f3bd48cc4a9c5330c31bcda31fc">More...</a><br/></td></tr>
<tr class="separator:a3f910f3bd48cc4a9c5330c31bcda31fc"><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>
@@ -144,6 +150,13 @@ 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><a class="el" href="classBLAKE2s.html" title="BLAKE2s hash algorithm. ">BLAKE2s</a> hash algorithm. </p>
@@ -255,12 +268,74 @@ 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="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52" 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="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52" title="Size of the hash result from finalize(). ">hashSize()</a>, then the remaining bytes will left unchanged.</p>
<p>If <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" 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="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02" 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="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911" title="Updates the hash with more data. ">update()</a> </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc" 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="BLAKE2s_8cpp_source.html#l00138">138</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3f910f3bd48cc4a9c5330c31bcda31fc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BLAKE2s::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="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd" 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="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52" 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="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a>, <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" 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="BLAKE2s_8cpp_source.html#l00167">167</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af9f50aac096f92ba27b1b2dd48df4c52"></a>
@@ -315,7 +390,7 @@ 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="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" 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="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" title="Finalizes the hashing process and returns the hash. ">finalize()</a>, <a class="el" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd" 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>
@@ -347,6 +422,62 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00102">102</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7f9745854704b34a508497105ca5e2fd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BLAKE2s::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="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> and <a class="el" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc" 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="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a>, <a class="el" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02" 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="BLAKE2s_8cpp_source.html#l00160">160</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa192da2fa044b03cccaf11e87fdf9911"></a>
@@ -405,7 +536,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:07 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>