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-01-16 09:47:55 +10:00
parent 9fb22bce90
commit ab1bf9b19b
386 changed files with 5395 additions and 2985 deletions

View File

@@ -271,43 +271,44 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;<span class="keywordtype">void</span> BLAKE2s::processChunk(uint32_t f0)</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;{</div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; uint8_t index;</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160;</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; <span class="comment">// Byte-swap the message buffer into little-endian if necessary.</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;<span class="preprocessor">#if !defined(CRYPTO_LITTLE_ENDIAN)</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;<span class="preprocessor"></span> <span class="keywordflow">for</span> (index = 0; index &lt; 16; ++index)</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; state.m[index] = le32toh(state.m[index]);</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; <span class="comment">// Format the block to be hashed.</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; memcpy(state.v, state.h, <span class="keyword">sizeof</span>(state.h));</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; state.v[8] = BLAKE2s_IV0;</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; state.v[9] = BLAKE2s_IV1;</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; state.v[10] = BLAKE2s_IV2;</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; state.v[11] = BLAKE2s_IV3;</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; state.v[12] = BLAKE2s_IV4 ^ (uint32_t)(state.length);</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; state.v[13] = BLAKE2s_IV5 ^ (uint32_t)(state.length &gt;&gt; 32);</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; state.v[14] = BLAKE2s_IV6 ^ f0;</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; state.v[15] = BLAKE2s_IV7;</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160;</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; <span class="comment">// Perform the 10 BLAKE2s rounds.</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; <span class="keywordflow">for</span> (index = 0; index &lt; 10; ++index) {</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; <span class="comment">// Column round.</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; quarterRound(state.v[0], state.v[4], state.v[8], state.v[12], 0);</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; quarterRound(state.v[1], state.v[5], state.v[9], state.v[13], 1);</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; quarterRound(state.v[2], state.v[6], state.v[10], state.v[14], 2);</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; quarterRound(state.v[3], state.v[7], state.v[11], state.v[15], 3);</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160;</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; <span class="comment">// Diagonal round.</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160; quarterRound(state.v[0], state.v[5], state.v[10], state.v[15], 4);</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; quarterRound(state.v[1], state.v[6], state.v[11], state.v[12], 5);</div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; quarterRound(state.v[2], state.v[7], state.v[8], state.v[13], 6);</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; quarterRound(state.v[3], state.v[4], state.v[9], state.v[14], 7);</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160; }</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160;</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; <span class="comment">// Combine the new and old hash values.</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; <span class="keywordflow">for</span> (index = 0; index &lt; 8; ++index)</div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; state.h[index] ^= (state.v[index] ^ state.v[index + 8]);</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;}</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; uint32_t v[16];</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160;</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; <span class="comment">// Byte-swap the message buffer into little-endian if necessary.</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;<span class="preprocessor">#if !defined(CRYPTO_LITTLE_ENDIAN)</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160;<span class="preprocessor"></span> <span class="keywordflow">for</span> (index = 0; index &lt; 16; ++index)</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; state.m[index] = le32toh(state.m[index]);</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; <span class="comment">// Format the block to be hashed.</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; memcpy(v, state.h, <span class="keyword">sizeof</span>(state.h));</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; v[8] = BLAKE2s_IV0;</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; v[9] = BLAKE2s_IV1;</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; v[10] = BLAKE2s_IV2;</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; v[11] = BLAKE2s_IV3;</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; v[12] = BLAKE2s_IV4 ^ (uint32_t)(state.length);</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; v[13] = BLAKE2s_IV5 ^ (uint32_t)(state.length &gt;&gt; 32);</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; v[14] = BLAKE2s_IV6 ^ f0;</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; v[15] = BLAKE2s_IV7;</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; <span class="comment">// Perform the 10 BLAKE2s rounds.</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; <span class="keywordflow">for</span> (index = 0; index &lt; 10; ++index) {</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; <span class="comment">// Column round.</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; quarterRound(v[0], v[4], v[8], v[12], 0);</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; quarterRound(v[1], v[5], v[9], v[13], 1);</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; quarterRound(v[2], v[6], v[10], v[14], 2);</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; quarterRound(v[3], v[7], v[11], v[15], 3);</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160; <span class="comment">// Diagonal round.</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; quarterRound(v[0], v[5], v[10], v[15], 4);</div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; quarterRound(v[1], v[6], v[11], v[12], 5);</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; quarterRound(v[2], v[7], v[8], v[13], 6);</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160; quarterRound(v[3], v[4], v[9], v[14], 7);</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; }</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160;</div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; <span class="comment">// Combine the new and old hash values.</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; <span class="keywordflow">for</span> (index = 0; index &lt; 8; ++index)</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; state.h[index] ^= (v[index] ^ v[index + 8]);</div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160;}</div>
<div class="ttc" id="classBLAKE2s_html_a4b3187ecaa3d3c8febfbb40c0f779aa7"><div class="ttname"><a href="classBLAKE2s.html#a4b3187ecaa3d3c8febfbb40c0f779aa7">BLAKE2s::~BLAKE2s</a></div><div class="ttdeci">virtual ~BLAKE2s()</div><div class="ttdoc">Destroys this BLAKE2s hash object after clearing sensitive information. </div><div class="ttdef"><b>Definition:</b> <a href="BLAKE2s_8cpp_source.html#l00056">BLAKE2s.cpp:56</a></div></div>
<div class="ttc" id="classBLAKE2s_html_af9f50aac096f92ba27b1b2dd48df4c52"><div class="ttname"><a href="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52">BLAKE2s::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="BLAKE2s_8cpp_source.html#l00061">BLAKE2s.cpp:61</a></div></div>
<div class="ttc" id="classBLAKE2s_html_a0848885f52df51dc53949d32a206e72d"><div class="ttname"><a href="classBLAKE2s.html#a0848885f52df51dc53949d32a206e72d">BLAKE2s::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="BLAKE2s_8cpp_source.html#l00154">BLAKE2s.cpp:154</a></div></div>
@@ -322,7 +323,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 Fri Dec 18 2015 05:39:07 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sat Jan 16 2016 09:47:01 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>