mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
Update docs
This commit is contained in:
Rhys Weatherley
137
classSHA1.html
137
classSHA1.html
@@ -133,6 +133,12 @@ virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="c
|
||||
<tr class="memitem:a41a159d6565b04d3f620dcd720faaf3f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA1.html#a41a159d6565b04d3f620dcd720faaf3f">clear</a> ()</td></tr>
|
||||
<tr class="memdesc:a41a159d6565b04d3f620dcd720faaf3f"><td class="mdescLeft"> </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="#a41a159d6565b04d3f620dcd720faaf3f">More...</a><br/></td></tr>
|
||||
<tr class="separator:a41a159d6565b04d3f620dcd720faaf3f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad0a09a5100d59ff90c04ed5d4071b606"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA1.html#ad0a09a5100d59ff90c04ed5d4071b606">resetHMAC</a> (const void *key, size_t keyLen)</td></tr>
|
||||
<tr class="memdesc:ad0a09a5100d59ff90c04ed5d4071b606"><td class="mdescLeft"> </td><td class="mdescRight">Resets the hash ready for a new HMAC hashing process. <a href="#ad0a09a5100d59ff90c04ed5d4071b606">More...</a><br/></td></tr>
|
||||
<tr class="separator:ad0a09a5100d59ff90c04ed5d4071b606"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a791db53fe9d6cc0e383b25f1da0a97b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA1.html#a791db53fe9d6cc0e383b25f1da0a97b8">finalizeHMAC</a> (const void *key, size_t keyLen, void *hash, size_t hashLen)</td></tr>
|
||||
<tr class="memdesc:a791db53fe9d6cc0e383b25f1da0a97b8"><td class="mdescLeft"> </td><td class="mdescRight">Finalizes the HMAC hashing process and returns the hash. <a href="#a791db53fe9d6cc0e383b25f1da0a97b8">More...</a><br/></td></tr>
|
||||
<tr class="separator:a791db53fe9d6cc0e383b25f1da0a97b8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="inherit_header pub_methods_classHash"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classHash')"><img src="closed.png" alt="-"/> 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>
|
||||
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#af482880ad75b67a09d2dcb5e86244d80">Hash</a> ()</td></tr>
|
||||
@@ -141,6 +147,13 @@ virtual </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 </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"> </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"> </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="-"/> 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 </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"> </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"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>SHA-1 hash algorithm. </p>
|
||||
@@ -251,12 +264,74 @@ virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="c
|
||||
</dl>
|
||||
<p>If <em>len</em> is less than <a class="el" href="classSHA1.html#ab8cdb7233a8b81be07877049960ddfdd" 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="classSHA1.html#ab8cdb7233a8b81be07877049960ddfdd" title="Size of the hash result from finalize(). ">hashSize()</a>, then the remaining bytes will left unchanged.</p>
|
||||
<p>If <a class="el" href="classSHA1.html#a5a6a8a6169aa48e0bccadb22a149ab7c" 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="classSHA1.html#ab71aaf39ed956320054861a2fbfa454f" 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="classSHA1.html#ab71aaf39ed956320054861a2fbfa454f" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classSHA1.html#aec77fbc5015f82bbf7055e535085656a" title="Updates the hash with more data. ">update()</a> </dd></dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSHA1.html#ab71aaf39ed956320054861a2fbfa454f" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classSHA1.html#aec77fbc5015f82bbf7055e535085656a" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classSHA1.html#a791db53fe9d6cc0e383b25f1da0a97b8" 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="SHA1_8cpp_source.html#l00097">97</a> of file <a class="el" href="SHA1_8cpp_source.html">SHA1.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a791db53fe9d6cc0e383b25f1da0a97b8"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SHA1::finalizeHMAC </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const void * </td>
|
||||
<td class="paramname"><em>key</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">size_t </td>
|
||||
<td class="paramname"><em>keyLen</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">void * </td>
|
||||
<td class="paramname"><em>hash</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">size_t </td>
|
||||
<td class="paramname"><em>hashLen</em> </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="classSHA1.html#ad0a09a5100d59ff90c04ed5d4071b606" 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="classSHA1.html#ab8cdb7233a8b81be07877049960ddfdd" 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="classSHA1.html#ad0a09a5100d59ff90c04ed5d4071b606" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a>, <a class="el" href="classSHA1.html#a5a6a8a6169aa48e0bccadb22a149ab7c" 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="SHA1_8cpp_source.html#l00141">141</a> of file <a class="el" href="SHA1_8cpp_source.html">SHA1.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ab8cdb7233a8b81be07877049960ddfdd"></a>
|
||||
@@ -311,12 +386,68 @@ virtual </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="classSHA1.html#aec77fbc5015f82bbf7055e535085656a" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classSHA1.html#a5a6a8a6169aa48e0bccadb22a149ab7c" 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="classSHA1.html#aec77fbc5015f82bbf7055e535085656a" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classSHA1.html#a5a6a8a6169aa48e0bccadb22a149ab7c" title="Finalizes the hashing process and returns the hash. ">finalize()</a>, <a class="el" href="classSHA1.html#ad0a09a5100d59ff90c04ed5d4071b606" 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="SHA1_8cpp_source.html#l00064">64</a> of file <a class="el" href="SHA1_8cpp_source.html">SHA1.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ad0a09a5100d59ff90c04ed5d4071b606"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SHA1::resetHMAC </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const void * </td>
|
||||
<td class="paramname"><em>key</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">size_t </td>
|
||||
<td class="paramname"><em>keyLen</em> </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="classSHA1.html#ad0a09a5100d59ff90c04ed5d4071b606" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> and <a class="el" href="classSHA1.html#a791db53fe9d6cc0e383b25f1da0a97b8" 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="classSHA1.html#a791db53fe9d6cc0e383b25f1da0a97b8" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a>, <a class="el" href="classSHA1.html#ab71aaf39ed956320054861a2fbfa454f" 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="SHA1_8cpp_source.html#l00134">134</a> of file <a class="el" href="SHA1_8cpp_source.html">SHA1.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aec77fbc5015f82bbf7055e535085656a"></a>
|
||||
@@ -375,7 +506,7 @@ virtual </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  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Wed Mar 25 2015 19:36:08 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.6
|
||||
</small></address>
|
||||
|
||||
Reference in New Issue
Block a user