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
2018-04-02 18:37:36 +10:00
parent 25eb9d2eb6
commit c81350fcbe
425 changed files with 3719 additions and 3276 deletions

View File

@@ -163,15 +163,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classNewHope_html_a679601da301134f037c3a5786bd7085fae270e706968a8e01e5c1cb40422b22c6"><div class="ttname"><a href="classNewHope.html#a679601da301134f037c3a5786bd7085fae270e706968a8e01e5c1cb40422b22c6">NewHope::Torref</a></div><div class="ttdoc">The alternative &quot;torref&quot; version of the New Hope algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8h_source.html#l00060">NewHope.h:60</a></div></div>
<div class="ttc" id="classNewHope_html_a679601da301134f037c3a5786bd7085f"><div class="ttname"><a href="classNewHope.html#a679601da301134f037c3a5786bd7085f">NewHope::Variant</a></div><div class="ttdeci">Variant</div><div class="ttdoc">Describes the variant of the New Hope algorithm to implement. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8h_source.html#l00057">NewHope.h:57</a></div></div>
<div class="ttc" id="classNewHope_html"><div class="ttname"><a href="classNewHope.html">NewHope</a></div><div class="ttdoc">NewHope post-quantum key exchange algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8h_source.html#l00050">NewHope.h:50</a></div></div>
<div class="ttc" id="classNewHope_html_a335b17b40949f66aa579d1035384662c"><div class="ttname"><a href="classNewHope.html#a335b17b40949f66aa579d1035384662c">NewHope::keygen</a></div><div class="ttdeci">static void keygen(uint8_t send[NEWHOPE_SENDABYTES], NewHopePrivateKey &amp;sk, Variant variant=Ref, const uint8_t *random_seed=0)</div><div class="ttdoc">Generates the key pair for Alice in a New Hope key exchange. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01014">NewHope.cpp:1014</a></div></div>
<div class="ttc" id="classNewHope_html_ac8128e0799fe74a6c69c541e0d6bd66e"><div class="ttname"><a href="classNewHope.html#ac8128e0799fe74a6c69c541e0d6bd66e">NewHope::shareda</a></div><div class="ttdeci">static void shareda(uint8_t shared_key[NEWHOPE_SHAREDBYTES], const NewHopePrivateKey &amp;sk, uint8_t received[NEWHOPE_SENDBBYTES])</div><div class="ttdoc">Generates the shared secret for Alice. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01288">NewHope.cpp:1288</a></div></div>
<div class="ttc" id="classNewHope_html_a335b17b40949f66aa579d1035384662c"><div class="ttname"><a href="classNewHope.html#a335b17b40949f66aa579d1035384662c">NewHope::keygen</a></div><div class="ttdeci">static void keygen(uint8_t send[NEWHOPE_SENDABYTES], NewHopePrivateKey &amp;sk, Variant variant=Ref, const uint8_t *random_seed=0)</div><div class="ttdoc">Generates the key pair for Alice in a New Hope key exchange. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01025">NewHope.cpp:1025</a></div></div>
<div class="ttc" id="classNewHope_html_ac8128e0799fe74a6c69c541e0d6bd66e"><div class="ttname"><a href="classNewHope.html#ac8128e0799fe74a6c69c541e0d6bd66e">NewHope::shareda</a></div><div class="ttdeci">static void shareda(uint8_t shared_key[NEWHOPE_SHAREDBYTES], const NewHopePrivateKey &amp;sk, uint8_t received[NEWHOPE_SENDBBYTES])</div><div class="ttdoc">Generates the shared secret for Alice. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01319">NewHope.cpp:1319</a></div></div>
<div class="ttc" id="structNewHopePrivateKey_html"><div class="ttname"><a href="structNewHopePrivateKey.html">NewHopePrivateKey</a></div><div class="ttdoc">NewHope private key representation. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8h_source.html#l00038">NewHope.h:38</a></div></div>
<div class="ttc" id="classNewHope_html_a2f09529f5f73cf9763c28b58b13bbd14"><div class="ttname"><a href="classNewHope.html#a2f09529f5f73cf9763c28b58b13bbd14">NewHope::sharedb</a></div><div class="ttdeci">static void sharedb(uint8_t shared_key[NEWHOPE_SHAREDBYTES], uint8_t send[NEWHOPE_SENDBBYTES], uint8_t received[NEWHOPE_SENDABYTES], Variant variant=Ref, const uint8_t *random_seed=0)</div><div class="ttdoc">Generates the public key and shared secret for Bob. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01116">NewHope.cpp:1116</a></div></div>
<div class="ttc" id="classNewHope_html_a2f09529f5f73cf9763c28b58b13bbd14"><div class="ttname"><a href="classNewHope.html#a2f09529f5f73cf9763c28b58b13bbd14">NewHope::sharedb</a></div><div class="ttdeci">static void sharedb(uint8_t shared_key[NEWHOPE_SHAREDBYTES], uint8_t send[NEWHOPE_SENDBBYTES], uint8_t received[NEWHOPE_SENDABYTES], Variant variant=Ref, const uint8_t *random_seed=0)</div><div class="ttdoc">Generates the public key and shared secret for Bob. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8cpp_source.html#l01137">NewHope.cpp:1137</a></div></div>
<div class="ttc" id="classNewHope_html_a679601da301134f037c3a5786bd7085fa2326f3fd76345d5900834593a74f6596"><div class="ttname"><a href="classNewHope.html#a679601da301134f037c3a5786bd7085fa2326f3fd76345d5900834593a74f6596">NewHope::Ref</a></div><div class="ttdoc">The standard &quot;reference&quot; version of the New Hope algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="NewHope_8h_source.html#l00059">NewHope.h:59</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 18 2018 09:12:22 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Apr 2 2018 18:36:52 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>