mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
Update docs
This commit is contained in:
@@ -72,7 +72,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
|
||||
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
@@ -110,6 +110,9 @@ Static Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a56000a4cd7d436de42360e9d43eecde4"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGF128.html#a56000a4cd7d436de42360e9d43eecde4">dblEAX</a> (uint32_t V[4])</td></tr>
|
||||
<tr class="memdesc:a56000a4cd7d436de42360e9d43eecde4"><td class="mdescLeft"> </td><td class="mdescRight">Doubles a value in the GF(2^128) field using <a class="el" href="classEAX.html" title="Implementation of the EAX authenticated cipher. ">EAX</a> conventions. <a href="#a56000a4cd7d436de42360e9d43eecde4">More...</a><br/></td></tr>
|
||||
<tr class="separator:a56000a4cd7d436de42360e9d43eecde4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3732c9471771c36ac1b518e974d46b3e"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGF128.html#a3732c9471771c36ac1b518e974d46b3e">dblXTS</a> (uint32_t V[4])</td></tr>
|
||||
<tr class="memdesc:a3732c9471771c36ac1b518e974d46b3e"><td class="mdescLeft"> </td><td class="mdescRight">Doubles a value in the GF(2^128) field using <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> conventions. <a href="#a3732c9471771c36ac1b518e974d46b3e">More...</a><br/></td></tr>
|
||||
<tr class="separator:a3732c9471771c36ac1b518e974d46b3e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Operations in the Galois field GF(2^128). </p>
|
||||
@@ -150,7 +153,7 @@ Static Public Member Functions</h2></td></tr>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Block cipher modes such as <a href="https://en.wikipedia.org/wiki/Disk_encryption_theory#Xor-encrypt-xor_.28XEX.29">XEX</a> are similar to <a class="el" href="classCTR.html" title="Implementation of the Counter (CTR) mode for 128-bit block ciphers. ">CTR</a> mode but instead of incrementing the nonce every block, the modes multiply the nonce by 2 in the GF(2^128) field every block. This function is provided to help with implementing such modes.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGF128.html#a56000a4cd7d436de42360e9d43eecde4" title="Doubles a value in the GF(2^128) field using EAX conventions. ">dblEAX()</a>, <a class="el" href="classGF128.html#a7d9a341a1715d37d25feba21627bc3ab" title="Perform a multiplication in the GF(2^128) field. ">mul()</a> </dd></dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGF128.html#a56000a4cd7d436de42360e9d43eecde4" title="Doubles a value in the GF(2^128) field using EAX conventions. ">dblEAX()</a>, <a class="el" href="classGF128.html#a3732c9471771c36ac1b518e974d46b3e" title="Doubles a value in the GF(2^128) field using XTS conventions. ">dblXTS()</a>, <a class="el" href="classGF128.html#a7d9a341a1715d37d25feba21627bc3ab" title="Perform a multiplication in the GF(2^128) field. ">mul()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="GF128_8cpp_source.html#l00314">314</a> of file <a class="el" href="GF128_8cpp_source.html">GF128.cpp</a>.</p>
|
||||
|
||||
@@ -187,10 +190,47 @@ Static Public Member Functions</h2></td></tr>
|
||||
</dl>
|
||||
<p>This function differs from <a class="el" href="classGF128.html#aef22f6b7be5937f60ed2b7bcf831e52d" title="Doubles a value in the GF(2^128) field. ">dbl()</a> that it uses the conventions of <a class="el" href="classEAX.html" title="Implementation of the EAX authenticated cipher. ">EAX</a> mode instead of those of NIST SP 800-38D (<a class="el" href="classGCM.html" title="Implementation of the Galois Counter Mode (GCM). ">GCM</a>). The two operations have equivalent security but the bits are ordered differently with the value shifted left instead of right.</p>
|
||||
<p>References: <a href="https://en.wikipedia.org/wiki/EAX_mode,">https://en.wikipedia.org/wiki/EAX_mode,</a> <a href="http://web.cs.ucdavis.edu/~rogaway/papers/eax.html">http://web.cs.ucdavis.edu/~rogaway/papers/eax.html</a></p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGF128.html#aef22f6b7be5937f60ed2b7bcf831e52d" title="Doubles a value in the GF(2^128) field. ">dbl()</a>, <a class="el" href="classGF128.html#a7d9a341a1715d37d25feba21627bc3ab" title="Perform a multiplication in the GF(2^128) field. ">mul()</a> </dd></dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGF128.html#aef22f6b7be5937f60ed2b7bcf831e52d" title="Doubles a value in the GF(2^128) field. ">dbl()</a>, <a class="el" href="classGF128.html#a3732c9471771c36ac1b518e974d46b3e" title="Doubles a value in the GF(2^128) field using XTS conventions. ">dblXTS()</a>, <a class="el" href="classGF128.html#a7d9a341a1715d37d25feba21627bc3ab" title="Perform a multiplication in the GF(2^128) field. ">mul()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="GF128_8cpp_source.html#l00406">406</a> of file <a class="el" href="GF128_8cpp_source.html">GF128.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a3732c9471771c36ac1b518e974d46b3e"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void GF128::dblXTS </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>V</em>[4]</td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Doubles a value in the GF(2^128) field using <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> conventions. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">V</td><td>The value to double, and the result. This array is assumed to be in littlen-endian order on entry and exit.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>This function differs from <a class="el" href="classGF128.html#aef22f6b7be5937f60ed2b7bcf831e52d" title="Doubles a value in the GF(2^128) field. ">dbl()</a> that it uses the conventions of <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> mode instead of those of NIST SP 800-38D (<a class="el" href="classGCM.html" title="Implementation of the Galois Counter Mode (GCM). ">GCM</a>). The two operations have equivalent security but the bits are ordered differently with the value shifted left instead of right.</p>
|
||||
<p>References: <a href="http://libeccio.di.unisa.it/Crypto14/Lab/p1619.pdf">IEEE Std. 1619-2007, XTS-AES</a></p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGF128.html#aef22f6b7be5937f60ed2b7bcf831e52d" title="Doubles a value in the GF(2^128) field. ">dbl()</a>, <a class="el" href="classGF128.html#a56000a4cd7d436de42360e9d43eecde4" title="Doubles a value in the GF(2^128) field using EAX conventions. ">dblEAX()</a>, <a class="el" href="classGF128.html#a7d9a341a1715d37d25feba21627bc3ab" title="Perform a multiplication in the GF(2^128) field. ">mul()</a> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="GF128_8cpp_source.html#l00497">497</a> of file <a class="el" href="GF128_8cpp_source.html">GF128.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a7d9a341a1715d37d25feba21627bc3ab"></a>
|
||||
@@ -294,7 +334,7 @@ Static Public Member Functions</h2></td></tr>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Sun Feb 14 2016 08:32:00 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Sun Mar 13 2016 08:28:01 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