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
@@ -115,53 +115,65 @@ 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 "BigNumberUtil.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="classCurve25519.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classCurve25519.html">Curve25519</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>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classCurve25519.html#a2e4b7dd83a019b32c76584c99bfda21a">eval</a>(uint8_t result[32], <span class="keyword">const</span> uint8_t s[32], <span class="keyword">const</span> uint8_t x[32]);</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classCurve25519.html#a2b6911583d17ea9a36bbbb40d58b3d89">dh1</a>(uint8_t k[32], uint8_t f[32]);</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classCurve25519.html#a14022d6ac68ec691ffb0247275078ab9">dh2</a>(uint8_t k[32], uint8_t f[32]);</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="preprocessor">#if defined(TEST_CURVE25519_FIELD_OPS)</span></div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#else</span></div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"></span><span class="keyword">private</span>:</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span> <span class="keyword">static</span> uint8_t isWeakPoint(<span class="keyword">const</span> uint8_t k[32]);</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="keyword">static</span> <span class="keywordtype">void</span> reduce(limb_t *result, limb_t *x, uint8_t size);</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">static</span> limb_t reduceQuick(limb_t *x);</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">static</span> <span class="keywordtype">void</span> mul(limb_t *result, <span class="keyword">const</span> limb_t *x, <span class="keyword">const</span> limb_t *y);</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> square(limb_t *result, <span class="keyword">const</span> limb_t *x)</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  {</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  mul(result, x, x);</div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> mulA24(limb_t *result, <span class="keyword">const</span> limb_t *x);</div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
|
||||
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> add(limb_t *result, <span class="keyword">const</span> limb_t *x, <span class="keyword">const</span> limb_t *y);</div>
|
||||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> sub(limb_t *result, <span class="keyword">const</span> limb_t *x, <span class="keyword">const</span> limb_t *y);</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="keyword">static</span> <span class="keywordtype">void</span> cswap(uint8_t select, limb_t *x, limb_t *y);</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">static</span> <span class="keywordtype">void</span> recip(limb_t *result, <span class="keyword">const</span> limb_t *x);</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>  <span class="comment">// Constructor and destructor are private - cannot instantiate this class.</span></div>
|
||||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classCurve25519.html">Curve25519</a>() {}</div>
|
||||
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  ~<a class="code" href="classCurve25519.html">Curve25519</a>() {}</div>
|
||||
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> };</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="classCurve25519.html"> 30</a></span> <span class="keyword">class </span><a class="code" href="classCurve25519.html">Curve25519</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>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classCurve25519.html#a2e4b7dd83a019b32c76584c99bfda21a">eval</a>(uint8_t result[32], <span class="keyword">const</span> uint8_t s[32], <span class="keyword">const</span> uint8_t x[32]);</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classCurve25519.html#a2b6911583d17ea9a36bbbb40d58b3d89">dh1</a>(uint8_t k[32], uint8_t f[32]);</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classCurve25519.html#a14022d6ac68ec691ffb0247275078ab9">dh2</a>(uint8_t k[32], uint8_t f[32]);</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#if defined(TEST_CURVE25519_FIELD_OPS)</span></div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"></span><span class="keyword">public</span>:</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#else</span></div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span><span class="keyword">private</span>:</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span> <span class="keyword">static</span> uint8_t isWeakPoint(<span class="keyword">const</span> uint8_t k[32]);</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="keyword">static</span> <span class="keywordtype">void</span> reduce(limb_t *result, limb_t *x, uint8_t size);</div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">static</span> limb_t reduceQuick(limb_t *x);</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">static</span> <span class="keywordtype">void</span> mulNoReduce(limb_t *result, <span class="keyword">const</span> limb_t *x, <span class="keyword">const</span> limb_t *y);</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> mul(limb_t *result, <span class="keyword">const</span> limb_t *x, <span class="keyword">const</span> limb_t *y);</div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> square(limb_t *result, <span class="keyword">const</span> limb_t *x)</div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  {</div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  mul(result, x, x);</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> </div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> mulA24(limb_t *result, <span class="keyword">const</span> limb_t *x);</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="keyword">static</span> <span class="keywordtype">void</span> mul_P(limb_t *result, <span class="keyword">const</span> limb_t *x, <span class="keyword">const</span> limb_t *y);</div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> add(limb_t *result, <span class="keyword">const</span> limb_t *x, <span class="keyword">const</span> limb_t *y);</div>
|
||||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> sub(limb_t *result, <span class="keyword">const</span> limb_t *x, <span class="keyword">const</span> limb_t *y);</div>
|
||||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
|
||||
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> cswap(limb_t select, limb_t *x, limb_t *y);</div>
|
||||
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> cmove(limb_t select, limb_t *x, <span class="keyword">const</span> limb_t *y);</div>
|
||||
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
|
||||
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="ttc" id="classCurve25519_html"><div class="ttname"><a href="classCurve25519.html">Curve25519</a></div><div class="ttdoc">Diffie-Hellman key agreement based on the elliptic curve modulo 2^255 - 19. </div><div class="ttdef"><b>Definition:</b> <a href="Curve25519_8h_source.html#l00028">Curve25519.h:28</a></div></div>
|
||||
<div class="ttc" id="classCurve25519_html_a2e4b7dd83a019b32c76584c99bfda21a"><div class="ttname"><a href="classCurve25519.html#a2e4b7dd83a019b32c76584c99bfda21a">Curve25519::eval</a></div><div class="ttdeci">static bool eval(uint8_t result[32], const uint8_t s[32], const uint8_t x[32])</div><div class="ttdoc">Evaluates the raw Curve25519 function. </div><div class="ttdef"><b>Definition:</b> <a href="Curve25519_8cpp_source.html#l00079">Curve25519.cpp:79</a></div></div>
|
||||
<div class="ttc" id="classCurve25519_html_a2b6911583d17ea9a36bbbb40d58b3d89"><div class="ttname"><a href="classCurve25519.html#a2b6911583d17ea9a36bbbb40d58b3d89">Curve25519::dh1</a></div><div class="ttdeci">static void dh1(uint8_t k[32], uint8_t f[32])</div><div class="ttdoc">Performs phase 1 of a Diffie-Hellman key exchange using Curve25519. </div><div class="ttdef"><b>Definition:</b> <a href="Curve25519_8cpp_source.html#l00244">Curve25519.cpp:244</a></div></div>
|
||||
<div class="ttc" id="classCurve25519_html_a14022d6ac68ec691ffb0247275078ab9"><div class="ttname"><a href="classCurve25519.html#a14022d6ac68ec691ffb0247275078ab9">Curve25519::dh2</a></div><div class="ttdeci">static bool dh2(uint8_t k[32], uint8_t f[32])</div><div class="ttdoc">Performs phase 2 of a Diffie-Hellman key exchange using Curve25519. </div><div class="ttdef"><b>Definition:</b> <a href="Curve25519_8cpp_source.html#l00282">Curve25519.cpp:282</a></div></div>
|
||||
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> pow250(limb_t *result, <span class="keyword">const</span> limb_t *x);</div>
|
||||
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> recip(limb_t *result, <span class="keyword">const</span> limb_t *x);</div>
|
||||
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> sqrt(limb_t *result, <span class="keyword">const</span> limb_t *x);</div>
|
||||
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
|
||||
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// Constructor and destructor are private - cannot instantiate this class.</span></div>
|
||||
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="classCurve25519.html">Curve25519</a>() {}</div>
|
||||
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  ~<a class="code" href="classCurve25519.html">Curve25519</a>() {}</div>
|
||||
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
|
||||
<div class="line"><a name="l00074"></a><span class="lineno"> 74</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="l00075"></a><span class="lineno"> 75</span> };</div>
|
||||
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
|
||||
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="ttc" id="classCurve25519_html"><div class="ttname"><a href="classCurve25519.html">Curve25519</a></div><div class="ttdoc">Diffie-Hellman key agreement based on the elliptic curve modulo 2^255 - 19. </div><div class="ttdef"><b>Definition:</b> <a href="Curve25519_8h_source.html#l00030">Curve25519.h:30</a></div></div>
|
||||
<div class="ttc" id="classCurve25519_html_a2e4b7dd83a019b32c76584c99bfda21a"><div class="ttname"><a href="classCurve25519.html#a2e4b7dd83a019b32c76584c99bfda21a">Curve25519::eval</a></div><div class="ttdeci">static bool eval(uint8_t result[32], const uint8_t s[32], const uint8_t x[32])</div><div class="ttdoc">Evaluates the raw Curve25519 function. </div><div class="ttdef"><b>Definition:</b> <a href="Curve25519_8cpp_source.html#l00074">Curve25519.cpp:74</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="classCurve25519_html_a2b6911583d17ea9a36bbbb40d58b3d89"><div class="ttname"><a href="classCurve25519.html#a2b6911583d17ea9a36bbbb40d58b3d89">Curve25519::dh1</a></div><div class="ttdeci">static void dh1(uint8_t k[32], uint8_t f[32])</div><div class="ttdoc">Performs phase 1 of a Diffie-Hellman key exchange using Curve25519. </div><div class="ttdef"><b>Definition:</b> <a href="Curve25519_8cpp_source.html#l00239">Curve25519.cpp:239</a></div></div>
|
||||
<div class="ttc" id="classCurve25519_html_a14022d6ac68ec691ffb0247275078ab9"><div class="ttname"><a href="classCurve25519.html#a14022d6ac68ec691ffb0247275078ab9">Curve25519::dh2</a></div><div class="ttdeci">static bool dh2(uint8_t k[32], uint8_t f[32])</div><div class="ttdoc">Performs phase 2 of a Diffie-Hellman key exchange using Curve25519. </div><div class="ttdef"><b>Definition:</b> <a href="Curve25519_8cpp_source.html#l00277">Curve25519.cpp:277</a></div></div>
|
||||
</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