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-13 07:01:47 +10:00
parent ab1bf9b19b
commit 77f9295247
389 changed files with 5668 additions and 1095 deletions

View File

@@ -101,12 +101,13 @@ Inheritance diagram for BlockCipher:</div>
<div class="center">
<img src="classBlockCipher.png" usemap="#BlockCipher_map" alt=""/>
<map id="BlockCipher_map" name="BlockCipher_map">
<area href="classAESCommon.html" title="Abstract base class for AES block ciphers. " alt="AESCommon" shape="rect" coords="126,56,242,80"/>
<area href="classSpeck.html" title="Speck block cipher with a 128-bit block size. " alt="Speck" shape="rect" coords="252,56,368,80"/>
<area href="classSpeckLowMemory.html" title="Speck block cipher with a 128-bit block size (low-memory version). " alt="SpeckLowMemory" shape="rect" coords="378,56,494,80"/>
<area href="classAES128.html" title="AES block cipher with 128-bit keys. " alt="AES128" shape="rect" coords="0,112,116,136"/>
<area href="classAES192.html" title="AES block cipher with 192-bit keys. " alt="AES192" shape="rect" coords="126,112,242,136"/>
<area href="classAES256.html" title="AES block cipher with 256-bit keys. " alt="AES256" shape="rect" coords="252,112,368,136"/>
<area href="classAESCommon.html" title="Abstract base class for AES block ciphers. " alt="AESCommon" shape="rect" coords="95,56,180,80"/>
<area href="classSpeck.html" title="Speck block cipher with a 128-bit block size. " alt="Speck" shape="rect" coords="190,56,275,80"/>
<area href="classSpeckTiny.html" title="Speck block cipher with a 128-bit block size (tiny-memory version). " alt="SpeckTiny" shape="rect" coords="285,56,370,80"/>
<area href="classAES128.html" title="AES block cipher with 128-bit keys. " alt="AES128" shape="rect" coords="0,112,85,136"/>
<area href="classAES192.html" title="AES block cipher with 192-bit keys. " alt="AES192" shape="rect" coords="95,112,180,136"/>
<area href="classAES256.html" title="AES block cipher with 256-bit keys. " alt="AES256" shape="rect" coords="190,112,275,136"/>
<area href="classSpeckSmall.html" title="Speck block cipher with a 128-bit block size (small-memory version). " alt="SpeckSmall" shape="rect" coords="285,112,370,136"/>
</map>
</div></div>
<table class="memberdecls">
@@ -200,7 +201,7 @@ Public Member Functions</h2></td></tr>
<dl class="section return"><dt>Returns</dt><dd>Returns the size of a block in bytes.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBlockCipher.html#afde6004a859e015d877eab3c37042a0f" title="Default size of the key for this block cipher, in bytes. ">keySize()</a>, <a class="el" href="classBlockCipher.html#aed0788b25f6bb2f1bd47d5a5f0c5db33" title="Encrypts a single block using this cipher. ">encryptBlock()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSpeck.html#a18a3b982a2cbc48befc8d498de08f188">Speck</a>, <a class="el" href="classSpeckLowMemory.html#ae16cc24406ad4f93e499d1ed95453090">SpeckLowMemory</a>, and <a class="el" href="classAESCommon.html#ae26afdcc6d18e8888974acae16df1413">AESCommon</a>.</p>
<p>Implemented in <a class="el" href="classSpeckTiny.html#af8bbd1d1124fd1c4ef1aa167625376a9">SpeckTiny</a>, <a class="el" href="classSpeck.html#a18a3b982a2cbc48befc8d498de08f188">Speck</a>, and <a class="el" href="classAESCommon.html#ae26afdcc6d18e8888974acae16df1413">AESCommon</a>.</p>
</div>
</div>
@@ -229,7 +230,7 @@ Public Member Functions</h2></td></tr>
<p>Security-sensitive information includes key schedules and any temporary state that is used by <a class="el" href="classBlockCipher.html#aed0788b25f6bb2f1bd47d5a5f0c5db33" title="Encrypts a single block using this cipher. ">encryptBlock()</a> or <a class="el" href="classBlockCipher.html#ac3ba2450222aa1ea804ae4881ab6440c" title="Decrypts a single block using this cipher. ">decryptBlock()</a> which is stored in the object itself.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBlockCipher.html#a9a05307664469777592799c8f77397c4" title="Sets the key to use for future encryption and decryption operations. ">setKey()</a>, <a class="el" href="classBlockCipher.html#aed0788b25f6bb2f1bd47d5a5f0c5db33" title="Encrypts a single block using this cipher. ">encryptBlock()</a>, <a class="el" href="classBlockCipher.html#ac3ba2450222aa1ea804ae4881ab6440c" title="Decrypts a single block using this cipher. ">decryptBlock()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSpeck.html#aa3866273282addabb9d3703c41fdc95f">Speck</a>, <a class="el" href="classSpeckLowMemory.html#a5c4fcd9a8ac0d2cf9dd11ce678146d99">SpeckLowMemory</a>, and <a class="el" href="classAESCommon.html#a83e43f7d07e31d90fd7b768a93ecfce6">AESCommon</a>.</p>
<p>Implemented in <a class="el" href="classSpeckTiny.html#a303ecc2639459e47c6eeb21991d52ccf">SpeckTiny</a>, <a class="el" href="classSpeck.html#aa3866273282addabb9d3703c41fdc95f">Speck</a>, <a class="el" href="classAESCommon.html#a83e43f7d07e31d90fd7b768a93ecfce6">AESCommon</a>, and <a class="el" href="classSpeckSmall.html#aa93d9f0b5153425dc04e8fb8faff7513">SpeckSmall</a>.</p>
</div>
</div>
@@ -275,7 +276,7 @@ Public Member Functions</h2></td></tr>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBlockCipher.html#aed0788b25f6bb2f1bd47d5a5f0c5db33" title="Encrypts a single block using this cipher. ">encryptBlock()</a>, <a class="el" href="classBlockCipher.html#a7059a310487c128db034b0ce0ad425a0" title="Size of a single block processed by this cipher, in bytes. ">blockSize()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSpeck.html#ad8c040df1c52d2559da8fdb3963d28b4">Speck</a>, <a class="el" href="classSpeckLowMemory.html#adf789790cf8ba15eb7025eea965215e9">SpeckLowMemory</a>, and <a class="el" href="classAESCommon.html#a95a806adf42f975765ff62907efdc639">AESCommon</a>.</p>
<p>Implemented in <a class="el" href="classSpeckTiny.html#a19e54aef7d1b3ef92e8140dd9c308c3c">SpeckTiny</a>, <a class="el" href="classSpeck.html#ad8c040df1c52d2559da8fdb3963d28b4">Speck</a>, <a class="el" href="classAESCommon.html#a95a806adf42f975765ff62907efdc639">AESCommon</a>, and <a class="el" href="classSpeckSmall.html#acced022717603980ecca21b3f953bf51">SpeckSmall</a>.</p>
</div>
</div>
@@ -321,7 +322,7 @@ Public Member Functions</h2></td></tr>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBlockCipher.html#ac3ba2450222aa1ea804ae4881ab6440c" title="Decrypts a single block using this cipher. ">decryptBlock()</a>, <a class="el" href="classBlockCipher.html#a7059a310487c128db034b0ce0ad425a0" title="Size of a single block processed by this cipher, in bytes. ">blockSize()</a> </dd></dl>
<p>Implemented in <a class="el" href="classSpeck.html#af6b8b91929e4b5b2023400688c9437f9">Speck</a>, <a class="el" href="classSpeckLowMemory.html#ad74f9cec21584184511f6d731b8ad5cf">SpeckLowMemory</a>, and <a class="el" href="classAESCommon.html#a2d95f6159abfcd92b5841f9018e44296">AESCommon</a>.</p>
<p>Implemented in <a class="el" href="classSpeckTiny.html#a5dd2cf40dc48addb6a393e78a58a07c0">SpeckTiny</a>, <a class="el" href="classSpeck.html#af6b8b91929e4b5b2023400688c9437f9">Speck</a>, and <a class="el" href="classAESCommon.html#a2d95f6159abfcd92b5841f9018e44296">AESCommon</a>.</p>
</div>
</div>
@@ -350,7 +351,7 @@ Public Member Functions</h2></td></tr>
<p>This value indicates the default, or recommended, size for the key.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBlockCipher.html#a9a05307664469777592799c8f77397c4" title="Sets the key to use for future encryption and decryption operations. ">setKey()</a>, <a class="el" href="classBlockCipher.html#a7059a310487c128db034b0ce0ad425a0" title="Size of a single block processed by this cipher, in bytes. ">blockSize()</a> </dd></dl>
<p>Implemented in <a class="el" href="classAES256.html#af8ed6412bae6fc78274f60344899366a">AES256</a>, <a class="el" href="classAES192.html#ade28843e51e262b30eb55791c83fd791">AES192</a>, <a class="el" href="classAES128.html#aa871832a156f0ea61b964e489670ae9d">AES128</a>, <a class="el" href="classSpeck.html#a061e43c1363178cda088c3f46e07d87b">Speck</a>, and <a class="el" href="classSpeckLowMemory.html#ab7cd4c7d2acb5b3dfa22ce08d659f279">SpeckLowMemory</a>.</p>
<p>Implemented in <a class="el" href="classAES256.html#af8ed6412bae6fc78274f60344899366a">AES256</a>, <a class="el" href="classAES192.html#ade28843e51e262b30eb55791c83fd791">AES192</a>, <a class="el" href="classAES128.html#aa871832a156f0ea61b964e489670ae9d">AES128</a>, <a class="el" href="classSpeckTiny.html#a5587909ba48776b01bbd40b339b1262e">SpeckTiny</a>, and <a class="el" href="classSpeck.html#a061e43c1363178cda088c3f46e07d87b">Speck</a>.</p>
</div>
</div>
@@ -398,7 +399,7 @@ Public Member Functions</h2></td></tr>
<p>Use <a class="el" href="classBlockCipher.html#a6f27d46e9dfa7761d014d828ad5f955b" title="Clears all security-sensitive state from this block cipher. ">clear()</a> or the destructor to remove the key and any other sensitive data from the object once encryption or decryption is complete.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBlockCipher.html#afde6004a859e015d877eab3c37042a0f" title="Default size of the key for this block cipher, in bytes. ">keySize()</a>, <a class="el" href="classBlockCipher.html#a6f27d46e9dfa7761d014d828ad5f955b" title="Clears all security-sensitive state from this block cipher. ">clear()</a> </dd></dl>
<p>Implemented in <a class="el" href="classAES256.html#a6af085d2d6a730ff1e025f982121bbda">AES256</a>, <a class="el" href="classAES192.html#a4ab37cff19fb05ceef1533ebc5e37cde">AES192</a>, <a class="el" href="classAES128.html#a42d7548eb5084a2c3e2d5aa5f6f98ba4">AES128</a>, <a class="el" href="classSpeck.html#a7a07fc025bd25d832e9899333b5dabef">Speck</a>, and <a class="el" href="classSpeckLowMemory.html#a0fda570e117f2b7977aaee3d1e93584b">SpeckLowMemory</a>.</p>
<p>Implemented in <a class="el" href="classAES256.html#a6af085d2d6a730ff1e025f982121bbda">AES256</a>, <a class="el" href="classAES192.html#a4ab37cff19fb05ceef1533ebc5e37cde">AES192</a>, <a class="el" href="classAES128.html#a42d7548eb5084a2c3e2d5aa5f6f98ba4">AES128</a>, <a class="el" href="classSpeckTiny.html#a05180c773b9d26d3b67ff569dc86fc2d">SpeckTiny</a>, <a class="el" href="classSpeck.html#a7a07fc025bd25d832e9899333b5dabef">Speck</a>, and <a class="el" href="classSpeckSmall.html#a3345df135f6530bad475d630ef6c1038">SpeckSmall</a>.</p>
</div>
</div>
@@ -409,7 +410,7 @@ Public Member Functions</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 16 2016 09:47:01 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sat Feb 13 2016 07:01:07 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>