mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
Update docs
This commit is contained in:
@@ -115,45 +115,50 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "Hash.h"</span></div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classSHA512.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classSHA512.html">SHA512</a> : <span class="keyword">public</span> <a class="code" href="classHash.html">Hash</a></div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classSHA512.html#a520d966d99c0008e3cc58bd3b77dafcd">SHA512</a>();</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">virtual</span> <a class="code" href="classSHA512.html#a777ec274fa838684b0208369c5f66391">~SHA512</a>();</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">size_t</span> <a class="code" href="classSHA512.html#a6ab3cc1e172eecf4796e4cac629e0a44">hashSize</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">size_t</span> <a class="code" href="classSHA512.html#acf8b9bcb6be91ee70acc3700a2ffa1a1">blockSize</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#a0d009e8d9157c3f14323e68631c33e97">reset</a>();</div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#a7d37a20d7ab431ab15d094f768b6a695">update</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> len);</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#afc136ad0e77de527b031db3fb8b32464">finalize</a>(<span class="keywordtype">void</span> *hash, <span class="keywordtype">size_t</span> len);</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#a0a9104dce5f099aeba216e5fbcb1ee1a">clear</a>();</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">class </span><a class="code" href="classEd25519.html">Ed25519</a>;</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classSHA512.html"> 30</a></span> <span class="keyword">class </span><a class="code" href="classSHA512.html">SHA512</a> : <span class="keyword">public</span> <a class="code" href="classHash.html">Hash</a></div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="classSHA512.html#a520d966d99c0008e3cc58bd3b77dafcd">SHA512</a>();</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">virtual</span> <a class="code" href="classSHA512.html#a777ec274fa838684b0208369c5f66391">~SHA512</a>();</div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">size_t</span> <a class="code" href="classSHA512.html#a6ab3cc1e172eecf4796e4cac629e0a44">hashSize</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">size_t</span> <a class="code" href="classSHA512.html#acf8b9bcb6be91ee70acc3700a2ffa1a1">blockSize</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#a0d009e8d9157c3f14323e68631c33e97">reset</a>();</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#a7d37a20d7ab431ab15d094f768b6a695">update</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> len);</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#afc136ad0e77de527b031db3fb8b32464">finalize</a>(<span class="keywordtype">void</span> *hash, <span class="keywordtype">size_t</span> len);</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#a2427ad8bf8b6958df91bd5806986167c">resetHMAC</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> keyLen);</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#a1fe9533f0d3dfdb426eb3dc4bdc31904">finalizeHMAC</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> keyLen, <span class="keywordtype">void</span> *hash, <span class="keywordtype">size_t</span> hashLen);</div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">struct </span>{</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  uint64_t h[8];</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  uint64_t w[16];</div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  uint64_t lengthLow;</div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  uint64_t lengthHigh;</div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  uint8_t chunkSize;</div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  } state;</div>
|
||||
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
||||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">void</span> processChunk();</div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#a0a9104dce5f099aeba216e5fbcb1ee1a">clear</a>();</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#a2427ad8bf8b6958df91bd5806986167c">resetHMAC</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> keyLen);</div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> <a class="code" href="classSHA512.html#a1fe9533f0d3dfdb426eb3dc4bdc31904">finalizeHMAC</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> keyLen, <span class="keywordtype">void</span> *hash, <span class="keywordtype">size_t</span> hashLen);</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">struct </span>{</div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  uint64_t h[8];</div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  uint64_t w[16];</div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  uint64_t lengthLow;</div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  uint64_t lengthHigh;</div>
|
||||
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  uint8_t chunkSize;</div>
|
||||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  } state;</div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span> processChunk();</div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classEd25519.html">Ed25519</a>;</div>
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> };</div>
|
||||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
|
||||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="ttc" id="classSHA512_html_a6ab3cc1e172eecf4796e4cac629e0a44"><div class="ttname"><a href="classSHA512.html#a6ab3cc1e172eecf4796e4cac629e0a44">SHA512::hashSize</a></div><div class="ttdeci">size_t hashSize() const </div><div class="ttdoc">Size of the hash result from finalize(). </div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8cpp_source.html#l00056">SHA512.cpp:56</a></div></div>
|
||||
<div class="ttc" id="classSHA512_html_acf8b9bcb6be91ee70acc3700a2ffa1a1"><div class="ttname"><a href="classSHA512.html#acf8b9bcb6be91ee70acc3700a2ffa1a1">SHA512::blockSize</a></div><div class="ttdeci">size_t blockSize() const </div><div class="ttdoc">Size of the internal block used by the hash algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8cpp_source.html#l00061">SHA512.cpp:61</a></div></div>
|
||||
<div class="ttc" id="classSHA512_html_a777ec274fa838684b0208369c5f66391"><div class="ttname"><a href="classSHA512.html#a777ec274fa838684b0208369c5f66391">SHA512::~SHA512</a></div><div class="ttdeci">virtual ~SHA512()</div><div class="ttdoc">Destroys this SHA-512 hash object after clearing sensitive information. </div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8cpp_source.html#l00051">SHA512.cpp:51</a></div></div>
|
||||
<div class="ttc" id="classHash_html"><div class="ttname"><a href="classHash.html">Hash</a></div><div class="ttdoc">Abstract base class for cryptographic hash algorithms. </div><div class="ttdef"><b>Definition:</b> <a href="Hash_8h_source.html#l00029">Hash.h:29</a></div></div>
|
||||
<div class="ttc" id="classSHA512_html_a0a9104dce5f099aeba216e5fbcb1ee1a"><div class="ttname"><a href="classSHA512.html#a0a9104dce5f099aeba216e5fbcb1ee1a">SHA512::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears the hash state, removing all sensitive data, and then resets the hash ready for a new hashing ...</div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8cpp_source.html#l00136">SHA512.cpp:136</a></div></div>
|
||||
<div class="ttc" id="classSHA512_html"><div class="ttname"><a href="classSHA512.html">SHA512</a></div><div class="ttdoc">SHA-512 hash algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8h_source.html#l00028">SHA512.h:28</a></div></div>
|
||||
<div class="ttc" id="classSHA512_html"><div class="ttname"><a href="classSHA512.html">SHA512</a></div><div class="ttdoc">SHA-512 hash algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8h_source.html#l00030">SHA512.h:30</a></div></div>
|
||||
<div class="ttc" id="classSHA512_html_a0d009e8d9157c3f14323e68631c33e97"><div class="ttname"><a href="classSHA512.html#a0d009e8d9157c3f14323e68631c33e97">SHA512::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Resets the hash ready for a new hashing process. </div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8cpp_source.html#l00066">SHA512.cpp:66</a></div></div>
|
||||
<div class="ttc" id="classSHA512_html_a7d37a20d7ab431ab15d094f768b6a695"><div class="ttname"><a href="classSHA512.html#a7d37a20d7ab431ab15d094f768b6a695">SHA512::update</a></div><div class="ttdeci">void update(const void *data, size_t len)</div><div class="ttdoc">Updates the hash with more data. </div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8cpp_source.html#l00079">SHA512.cpp:79</a></div></div>
|
||||
<div class="ttc" id="classEd25519_html"><div class="ttname"><a href="classEd25519.html">Ed25519</a></div><div class="ttdoc">Digital signatures based on the elliptic curve modulo 2^255 - 19. </div><div class="ttdef"><b>Definition:</b> <a href="Ed25519_8h_source.html#l00029">Ed25519.h:29</a></div></div>
|
||||
<div class="ttc" id="classSHA512_html_afc136ad0e77de527b031db3fb8b32464"><div class="ttname"><a href="classSHA512.html#afc136ad0e77de527b031db3fb8b32464">SHA512::finalize</a></div><div class="ttdeci">void finalize(void *hash, size_t len)</div><div class="ttdoc">Finalizes the hashing process and returns the hash. </div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8cpp_source.html#l00105">SHA512.cpp:105</a></div></div>
|
||||
<div class="ttc" id="classSHA512_html_a1fe9533f0d3dfdb426eb3dc4bdc31904"><div class="ttname"><a href="classSHA512.html#a1fe9533f0d3dfdb426eb3dc4bdc31904">SHA512::finalizeHMAC</a></div><div class="ttdeci">void finalizeHMAC(const void *key, size_t keyLen, void *hash, size_t hashLen)</div><div class="ttdoc">Finalizes the HMAC hashing process and returns the hash. </div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8cpp_source.html#l00149">SHA512.cpp:149</a></div></div>
|
||||
<div class="ttc" id="classSHA512_html_a520d966d99c0008e3cc58bd3b77dafcd"><div class="ttname"><a href="classSHA512.html#a520d966d99c0008e3cc58bd3b77dafcd">SHA512::SHA512</a></div><div class="ttdeci">SHA512()</div><div class="ttdoc">Constructs a SHA-512 hash object. </div><div class="ttdef"><b>Definition:</b> <a href="SHA512_8cpp_source.html#l00042">SHA512.cpp:42</a></div></div>
|
||||
@@ -161,7 +166,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Mon Apr 6 2015 09:30:16 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Sat Apr 18 2015 08:44:48 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