1
0
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
2016-02-14 08:32:06 +10:00
parent c74770a343
commit 443fa28b67
401 changed files with 5331 additions and 2249 deletions

View File

@@ -133,25 +133,27 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classKeccakCore.html#a97852ee4381ced17ee6d21704cf0b4d7">pad</a>(uint8_t tag);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classKeccakCore.html#aad83ece853c0cc15fcab947fdcba924f">extract</a>(<span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classKeccakCore.html#aeff1df56e4a3103c99c1fe4307e60c66">clear</a>();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classKeccakCore.html#aeff6b3357916bf426b60d3629db52628">setHMACKey</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> len, uint8_t <a class="code" href="classKeccakCore.html#a97852ee4381ced17ee6d21704cf0b4d7">pad</a>, <span class="keywordtype">size_t</span> hashSize);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uint64_t A[5][5];</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; uint8_t inputSize;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; uint8_t outputSize;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; } state;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; uint8_t _blockSize;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">void</span> keccakp();</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;};</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classKeccakCore.html#acaf5c13452003e6e2e7793939f62a123">encrypt</a>(<span class="keywordtype">void</span> *output, <span class="keyword">const</span> <span class="keywordtype">void</span> *input, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classKeccakCore.html#aeff1df56e4a3103c99c1fe4307e60c66">clear</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classKeccakCore.html#aeff6b3357916bf426b60d3629db52628">setHMACKey</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> len, uint8_t <a class="code" href="classKeccakCore.html#a97852ee4381ced17ee6d21704cf0b4d7">pad</a>, <span class="keywordtype">size_t</span> hashSize);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; uint64_t A[5][5];</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; uint8_t inputSize;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; uint8_t outputSize;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; } state;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; uint8_t _blockSize;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">void</span> keccakp();</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;};</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classKeccakCore_html_a3742ed39151811b5d1c263c75ee5b20a"><div class="ttname"><a href="classKeccakCore.html#a3742ed39151811b5d1c263c75ee5b20a">KeccakCore::blockSize</a></div><div class="ttdeci">size_t blockSize() const </div><div class="ttdoc">Returns the input block size for the sponge function in bytes. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8h_source.html#l00038">KeccakCore.h:38</a></div></div>
<div class="ttc" id="classKeccakCore_html_aeff6b3357916bf426b60d3629db52628"><div class="ttname"><a href="classKeccakCore.html#aeff6b3357916bf426b60d3629db52628">KeccakCore::setHMACKey</a></div><div class="ttdeci">void setHMACKey(const void *key, size_t len, uint8_t pad, size_t hashSize)</div><div class="ttdoc">Sets a HMAC key for a Keccak-based hash algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00243">KeccakCore.cpp:243</a></div></div>
<div class="ttc" id="classKeccakCore_html_aeff6b3357916bf426b60d3629db52628"><div class="ttname"><a href="classKeccakCore.html#aeff6b3357916bf426b60d3629db52628">KeccakCore::setHMACKey</a></div><div class="ttdeci">void setHMACKey(const void *key, size_t len, uint8_t pad, size_t hashSize)</div><div class="ttdoc">Sets a HMAC key for a Keccak-based hash algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00293">KeccakCore.cpp:293</a></div></div>
<div class="ttc" id="classKeccakCore_html_acaf5c13452003e6e2e7793939f62a123"><div class="ttname"><a href="classKeccakCore.html#acaf5c13452003e6e2e7793939f62a123">KeccakCore::encrypt</a></div><div class="ttdeci">void encrypt(void *output, const void *input, size_t size)</div><div class="ttdoc">Extracts data from the Keccak sponge function and uses it to encrypt a buffer. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00240">KeccakCore.cpp:240</a></div></div>
<div class="ttc" id="classKeccakCore_html_ab3c1905f2002e49aca085d6f0b5546f7"><div class="ttname"><a href="classKeccakCore.html#ab3c1905f2002e49aca085d6f0b5546f7">KeccakCore::setCapacity</a></div><div class="ttdeci">void setCapacity(size_t capacity)</div><div class="ttdoc">Sets the capacity of the Keccak sponge function in bits. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00094">KeccakCore.cpp:94</a></div></div>
<div class="ttc" id="classKeccakCore_html_a4579e3a9b24f1d615fa8d660c23e77a4"><div class="ttname"><a href="classKeccakCore.html#a4579e3a9b24f1d615fa8d660c23e77a4">KeccakCore::~KeccakCore</a></div><div class="ttdeci">~KeccakCore()</div><div class="ttdoc">Destroys this Keccak sponge function after clearing all sensitive information. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00066">KeccakCore.cpp:66</a></div></div>
<div class="ttc" id="classKeccakCore_html_aad83ece853c0cc15fcab947fdcba924f"><div class="ttname"><a href="classKeccakCore.html#aad83ece853c0cc15fcab947fdcba924f">KeccakCore::extract</a></div><div class="ttdeci">void extract(void *data, size_t size)</div><div class="ttdoc">Extracts data from the Keccak sponge function. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00194">KeccakCore.cpp:194</a></div></div>
@@ -159,13 +161,13 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classKeccakCore_html_a804b895121a4e04bc491f41a5821a13e"><div class="ttname"><a href="classKeccakCore.html#a804b895121a4e04bc491f41a5821a13e">KeccakCore::capacity</a></div><div class="ttdeci">size_t capacity() const </div><div class="ttdoc">Returns the capacity of the sponge function in bits. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00076">KeccakCore.cpp:76</a></div></div>
<div class="ttc" id="classKeccakCore_html_a850c8e85bdb6b347411239716535d9c9"><div class="ttname"><a href="classKeccakCore.html#a850c8e85bdb6b347411239716535d9c9">KeccakCore::KeccakCore</a></div><div class="ttdeci">KeccakCore()</div><div class="ttdoc">Constructs a new Keccak sponge function. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00054">KeccakCore.cpp:54</a></div></div>
<div class="ttc" id="classKeccakCore_html_aaaa0355ccec0f469ac8eb577bdf853ed"><div class="ttname"><a href="classKeccakCore.html#aaaa0355ccec0f469ac8eb577bdf853ed">KeccakCore::update</a></div><div class="ttdeci">void update(const void *data, size_t size)</div><div class="ttdoc">Updates the Keccak sponge function with more input data. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00133">KeccakCore.cpp:133</a></div></div>
<div class="ttc" id="classKeccakCore_html_aeff1df56e4a3103c99c1fe4307e60c66"><div class="ttname"><a href="classKeccakCore.html#aeff1df56e4a3103c99c1fe4307e60c66">KeccakCore::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears all sensitive data from this object. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00225">KeccakCore.cpp:225</a></div></div>
<div class="ttc" id="classKeccakCore_html_aeff1df56e4a3103c99c1fe4307e60c66"><div class="ttname"><a href="classKeccakCore.html#aeff1df56e4a3103c99c1fe4307e60c66">KeccakCore::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears all sensitive data from this object. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00275">KeccakCore.cpp:275</a></div></div>
<div class="ttc" id="classKeccakCore_html_a5a322eb7e3b5c1eaad127c9c6e6a529b"><div class="ttname"><a href="classKeccakCore.html#a5a322eb7e3b5c1eaad127c9c6e6a529b">KeccakCore::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Resets the Keccak sponge function ready for a new session. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8cpp_source.html#l00114">KeccakCore.cpp:114</a></div></div>
<div class="ttc" id="classKeccakCore_html"><div class="ttname"><a href="classKeccakCore.html">KeccakCore</a></div><div class="ttdoc">Keccak core sponge function. </div><div class="ttdef"><b>Definition:</b> <a href="KeccakCore_8h_source.html#l00029">KeccakCore.h:29</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 14 2016 07:48:07 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Feb 14 2016 08:32:00 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>