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
@@ -101,10 +101,12 @@ Inheritance diagram for AuthenticatedCipher:</div>
|
||||
<div class="center">
|
||||
<img src="classAuthenticatedCipher.png" usemap="#AuthenticatedCipher_map" alt=""/>
|
||||
<map id="AuthenticatedCipher_map" name="AuthenticatedCipher_map">
|
||||
<area href="classCipher.html" title="Abstract base class for stream ciphers. " alt="Cipher" shape="rect" coords="68,0,195,24"/>
|
||||
<area href="classCipher.html" title="Abstract base class for stream ciphers. " alt="Cipher" shape="rect" coords="137,0,264,24"/>
|
||||
<area href="classChaChaPoly.html" title="Authenticated cipher based on ChaCha and Poly1305. " alt="ChaChaPoly" shape="rect" coords="0,112,127,136"/>
|
||||
<area href="classGCMCommon.html" title="Concrete base class to assist with implementing GCM for 128-bit block ciphers. " alt="GCMCommon" shape="rect" coords="137,112,264,136"/>
|
||||
<area href="classGCM.html" title="Implementation of the Galois Counter Mode (GCM). " alt="GCM< T >" shape="rect" coords="137,168,264,192"/>
|
||||
<area href="classEAXCommon.html" title="Concrete base class to assist with implementing EAX for 128-bit block ciphers. " alt="EAXCommon" shape="rect" coords="137,112,264,136"/>
|
||||
<area href="classGCMCommon.html" title="Concrete base class to assist with implementing GCM for 128-bit block ciphers. " alt="GCMCommon" shape="rect" coords="274,112,401,136"/>
|
||||
<area href="classEAX.html" title="Implementation of the EAX authenticated cipher. " alt="EAX< T >" shape="rect" coords="137,168,264,192"/>
|
||||
<area href="classGCM.html" title="Implementation of the Galois Counter Mode (GCM). " alt="GCM< T >" shape="rect" coords="274,168,401,192"/>
|
||||
</map>
|
||||
</div></div>
|
||||
<table class="memberdecls">
|
||||
@@ -213,7 +215,7 @@ virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="c
|
||||
<p>This function must be called before the first call to <a class="el" href="classCipher.html#ad2832bd61039d61560e34ea3382ca562" title="Encrypts an input buffer and writes the ciphertext to an output buffer. ">encrypt()</a> or <a class="el" href="classCipher.html#ac6099d1a0d7f2ff67b0e4ccb4a17eb08" title="Decrypts an input buffer and writes the plaintext to an output buffer. ">decrypt()</a>. That is, it is assumed that all extra data for authentication is available before the first payload data block and that it will be prepended to the payload for authentication. If the subclass needs to process the extra data after the payload, then it is responsible for saving <em>data</em> away until it is needed during <a class="el" href="classAuthenticatedCipher.html#a73fa4306053ed457e5c533b3127391c9" title="Finalizes the encryption process and computes the authentication tag. ">computeTag()</a> or <a class="el" href="classAuthenticatedCipher.html#a4bb33d194e2c7d30c4e5a713e59786ff" title="Finalizes the decryption process and checks the authentication tag. ">checkTag()</a>.</p>
|
||||
<p>This function can be called multiple times with separate extra data blocks for authentication. All such data will be concatenated into a single block for authentication purposes. </p>
|
||||
|
||||
<p>Implemented in <a class="el" href="classChaChaPoly.html#a4aa3514d1fb6272da977a7467ae6734b">ChaChaPoly</a>, and <a class="el" href="classGCMCommon.html#ad926e980ae2d61c10c9bf82813154a25">GCMCommon</a>.</p>
|
||||
<p>Implemented in <a class="el" href="classChaChaPoly.html#a4aa3514d1fb6272da977a7467ae6734b">ChaChaPoly</a>, <a class="el" href="classGCMCommon.html#ad926e980ae2d61c10c9bf82813154a25">GCMCommon</a>, and <a class="el" href="classEAXCommon.html#acdf2c51fb11c068202311b5c95767db8">EAXCommon</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -262,7 +264,7 @@ virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="c
|
||||
<dl class="section note"><dt>Note</dt><dd>Authenticated cipher modes usually require that if the tag could not be verified, then all of the data that was previously decrypted <em>must</em> be discarded. It is unwise to use the decrypted data for any purpose before it can be verified. Callers are responsible for ensuring that any data returned via previous calls to <a class="el" href="classCipher.html#ac6099d1a0d7f2ff67b0e4ccb4a17eb08" title="Decrypts an input buffer and writes the plaintext to an output buffer. ">decrypt()</a> is discarded if <a class="el" href="classAuthenticatedCipher.html#a4bb33d194e2c7d30c4e5a713e59786ff" title="Finalizes the decryption process and checks the authentication tag. ">checkTag()</a> returns false.</dd></dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAuthenticatedCipher.html#a73fa4306053ed457e5c533b3127391c9" title="Finalizes the encryption process and computes the authentication tag. ">computeTag()</a> </dd></dl>
|
||||
|
||||
<p>Implemented in <a class="el" href="classChaChaPoly.html#aeffb3e0df0b4da03f72f30251243d953">ChaChaPoly</a>, and <a class="el" href="classGCMCommon.html#a70229be2fe2274c4109fe7511481075a">GCMCommon</a>.</p>
|
||||
<p>Implemented in <a class="el" href="classChaChaPoly.html#aeffb3e0df0b4da03f72f30251243d953">ChaChaPoly</a>, <a class="el" href="classGCMCommon.html#a70229be2fe2274c4109fe7511481075a">GCMCommon</a>, and <a class="el" href="classEAXCommon.html#a72c403f52cefab57566bc5f634c1b963">EAXCommon</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -308,7 +310,7 @@ virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="c
|
||||
</dl>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAuthenticatedCipher.html#a4bb33d194e2c7d30c4e5a713e59786ff" title="Finalizes the decryption process and checks the authentication tag. ">checkTag()</a> </dd></dl>
|
||||
|
||||
<p>Implemented in <a class="el" href="classChaChaPoly.html#a92d850ad7027829e4072c43bd5028f95">ChaChaPoly</a>, and <a class="el" href="classGCMCommon.html#a444634bd4469bb5d404ac882d1d8fdf4">GCMCommon</a>.</p>
|
||||
<p>Implemented in <a class="el" href="classChaChaPoly.html#a92d850ad7027829e4072c43bd5028f95">ChaChaPoly</a>, <a class="el" href="classGCMCommon.html#a444634bd4469bb5d404ac882d1d8fdf4">GCMCommon</a>, and <a class="el" href="classEAXCommon.html#ab5a61bba48561d6e7e6b8bafc51d91e3">EAXCommon</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -338,7 +340,7 @@ virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="c
|
||||
<p>By default this function should return the largest tag size supported by the authenticated cipher.</p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAuthenticatedCipher.html#a73fa4306053ed457e5c533b3127391c9" title="Finalizes the encryption process and computes the authentication tag. ">computeTag()</a> </dd></dl>
|
||||
|
||||
<p>Implemented in <a class="el" href="classChaChaPoly.html#a086c2aea395ab31136ebe7805591fd0a">ChaChaPoly</a>, and <a class="el" href="classGCMCommon.html#a935f343858e98ee331706daf43e34805">GCMCommon</a>.</p>
|
||||
<p>Implemented in <a class="el" href="classChaChaPoly.html#a086c2aea395ab31136ebe7805591fd0a">ChaChaPoly</a>, <a class="el" href="classGCMCommon.html#a935f343858e98ee331706daf43e34805">GCMCommon</a>, and <a class="el" href="classEAXCommon.html#a8804341b21f752a5b8178a3bdb123fd9">EAXCommon</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -349,7 +351,7 @@ virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="c
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Fri Dec 18 2015 05:39:07 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Sat Jan 16 2016 09:47: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