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
2016-03-23 19:09:06 +10:00
parent 11f16a223a
commit 328b82e3fb
404 changed files with 1666 additions and 1456 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
classBLAKE2s.html
View File

@@ -127,6 +127,9 @@ virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
<tr class="memitem:a91ba6bc39e42002ac61114ced1d0af6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a91ba6bc39e42002ac61114ced1d0af6d">reset</a> (uint8_t outputLength)</td></tr>
<tr class="memdesc:a91ba6bc39e42002ac61114ced1d0af6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the hash ready for a new hashing process with a specified output length. <a href="#a91ba6bc39e42002ac61114ced1d0af6d">More...</a><br/></td></tr>
<tr class="separator:a91ba6bc39e42002ac61114ced1d0af6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0edaf2a5d47e1e821a64421f26162f95"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a0edaf2a5d47e1e821a64421f26162f95">reset</a> (const void *key, size_t keyLen, uint8_t outputLength=32)</td></tr>
<tr class="memdesc:a0edaf2a5d47e1e821a64421f26162f95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the hash ready for a new hashing process with a specified key and output length. <a href="#a0edaf2a5d47e1e821a64421f26162f95">More...</a><br/></td></tr>
<tr class="separator:a0edaf2a5d47e1e821a64421f26162f95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa192da2fa044b03cccaf11e87fdf9911"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">update</a> (const void *data, size_t len)</td></tr>
<tr class="memdesc:aa192da2fa044b03cccaf11e87fdf9911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the hash with more data. <a href="#aa192da2fa044b03cccaf11e87fdf9911">More...</a><br/></td></tr>
<tr class="separator:aa192da2fa044b03cccaf11e87fdf9911"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -161,7 +164,23 @@ Additional Inherited Members</h2></td></tr>
<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>
<p><a class="el" href="classBLAKE2s.html" title="BLAKE2s hash algorithm. ">BLAKE2s</a> is a variation on the <a class="el" href="classChaCha.html" title="ChaCha stream cipher. ">ChaCha</a> stream cipher, designed for hashing, with a 256-bit hash output. It is intended as a high performance replacement for <a class="el" href="classSHA256.html" title="SHA-256 hash algorithm. ">SHA256</a> for when speed is critical but exact <a class="el" href="classSHA256.html" title="SHA-256 hash algorithm. ">SHA256</a> compatibility is not.</p>
<p>Reference: <a href="https://blake2.net/">https://blake2.net/</a></p>
<p>This class supports two types of keyed hash. The BLAKE2 keyed hash and traditional HMAC. The BLAKE2 keyed hash is recommended unless there is some higher-level application need to be compatible with the HMAC construction. The keyed hash is computed as follows:</p>
<div class="fragment"><div class="line"><a class="code" href="classBLAKE2s.html">BLAKE2s</a> blake;</div>
<div class="line">blake.<a class="code" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02">reset</a>(key, <span class="keyword">sizeof</span>(key), outputLength);</div>
<div class="line">blake.<a class="code" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">update</a>(data1, <span class="keyword">sizeof</span>(data1));</div>
<div class="line">blake.<a class="code" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">update</a>(data2, <span class="keyword">sizeof</span>(data2));</div>
<div class="line">...</div>
<div class="line">blake.update(dataN, <span class="keyword">sizeof</span>(dataN));</div>
<div class="line">blake.<a class="code" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b">finalize</a>(hash, outputLength);</div>
</div><!-- fragment --><p>The HMAC is computed as follows (the output length is always 32):</p>
<div class="fragment"><div class="line"><a class="code" href="classBLAKE2s.html">BLAKE2s</a> blake;</div>
<div class="line">blake.<a class="code" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd">resetHMAC</a>(key, <span class="keyword">sizeof</span>(key));</div>
<div class="line">blake.<a class="code" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">update</a>(data1, <span class="keyword">sizeof</span>(data1));</div>
<div class="line">blake.<a class="code" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">update</a>(data2, <span class="keyword">sizeof</span>(data2));</div>
<div class="line">...</div>
<div class="line">blake.update(dataN, <span class="keyword">sizeof</span>(dataN));</div>
<div class="line">blake.<a class="code" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc">finalizeHMAC</a>(key, <span class="keyword">sizeof</span>(key), hash, 32);</div>
</div><!-- fragment --><p>References: <a href="https://blake2.net/,">https://blake2.net/,</a> <a href="http://tools.ietf.org/html/rfc7693">RFC 7693</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2b.html" title="BLAKE2b hash algorithm. ">BLAKE2b</a>, <a class="el" href="classSHA256.html" title="SHA-256 hash algorithm. ">SHA256</a>, <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="BLAKE2s_8h_source.html#l00028">28</a> of file <a class="el" href="BLAKE2s_8h_source.html">BLAKE2s.h</a>.</p>
@@ -192,7 +211,7 @@ Additional Inherited Members</h2></td></tr>
<p>Implements <a class="el" href="classHash.html#a4e4297812e3483410556830fe5d47bdf">Hash</a>.</p>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00066">66</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00094">94</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
@@ -222,7 +241,7 @@ Additional Inherited Members</h2></td></tr>
<p>Implements <a class="el" href="classHash.html#a4a959469433cd9348ab7f3ac6228bb34">Hash</a>.</p>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00154">154</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00227">227</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
@@ -272,7 +291,7 @@ Additional Inherited Members</h2></td></tr>
<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>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00211">211</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
@@ -334,7 +353,7 @@ Additional Inherited Members</h2></td></tr>
<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>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00240">240</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
@@ -364,7 +383,7 @@ Additional Inherited Members</h2></td></tr>
<p>Implements <a class="el" href="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8">Hash</a>.</p>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00061">61</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00089">89</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
@@ -394,7 +413,7 @@ Additional Inherited Members</h2></td></tr>
<p>Implements <a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61">Hash</a>.</p>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00081">81</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00109">109</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
@@ -420,7 +439,52 @@ Additional Inherited Members</h2></td></tr>
</dd>
</dl>
<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>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00130">130</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0edaf2a5d47e1e821a64421f26162f95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BLAKE2s::reset </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">uint8_t&#160;</td>
<td class="paramname"><em>outputLength</em> = <code>32</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the hash ready for a new hashing process with a specified key and output length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>Points to the key. </td></tr>
<tr><td class="paramname">keyLen</td><td>The length of the key in bytes, between 0 and 32. </td></tr>
<tr><td class="paramname">outputLength</td><td>The output length to use for the final hash in bytes, between 1 and 32.</td></tr>
</table>
</dd>
</dl>
<p>If <em>keyLen</em> is greater than 32, then the <em>key</em> will be truncated to the first 32 bytes. </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>
@@ -476,7 +540,7 @@ Additional Inherited Members</h2></td></tr>
<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>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00233">233</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
@@ -525,7 +589,7 @@ Additional Inherited Members</h2></td></tr>
<p>Implements <a class="el" href="classHash.html#aec9761ee427d122e7450de8df200265c">Hash</a>.</p>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00116">116</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00189">189</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
</div>
</div>
@@ -536,7 +600,7 @@ Additional Inherited Members</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Mar 13 2016 08:28:01 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Mar 23 2016 19:08:46 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>