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

@@ -334,16 +334,16 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classGCMCommon_html_a06868ebd67a571aa68d88d5d072cece9"><div class="ttname"><a href="classGCMCommon.html#a06868ebd67a571aa68d88d5d072cece9">GCMCommon::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears all security-sensitive state from this cipher. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8cpp_source.html#l00256">GCM.cpp:256</a></div></div>
<div class="ttc" id="classGCMCommon_html_a70229be2fe2274c4109fe7511481075a"><div class="ttname"><a href="classGCMCommon.html#a70229be2fe2274c4109fe7511481075a">GCMCommon::checkTag</a></div><div class="ttdeci">bool checkTag(const void *tag, size_t len)</div><div class="ttdoc">Finalizes the decryption process and checks the authentication tag. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8cpp_source.html#l00245">GCM.cpp:245</a></div></div>
<div class="ttc" id="classGCMCommon_html_a01cff072505e861fd20f6cfee1e10fb2"><div class="ttname"><a href="classGCMCommon.html#a01cff072505e861fd20f6cfee1e10fb2">GCMCommon::ivSize</a></div><div class="ttdeci">size_t ivSize() const </div><div class="ttdoc">Size of the initialization vector for this cipher, in bytes. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8cpp_source.html#l00066">GCM.cpp:66</a></div></div>
<div class="ttc" id="classGHASH_html_ab221298ca69c9612bfbfd3dedcb28307"><div class="ttname"><a href="classGHASH.html#ab221298ca69c9612bfbfd3dedcb28307">GHASH::finalize</a></div><div class="ttdeci">void finalize(void *token, size_t len)</div><div class="ttdoc">Finalizes the authentication process and returns the token. </div><div class="ttdef"><b>Definition:</b> <a href="GHASH_8cpp_source.html#l00130">GHASH.cpp:130</a></div></div>
<div class="ttc" id="classGHASH_html_ab221298ca69c9612bfbfd3dedcb28307"><div class="ttname"><a href="classGHASH.html#ab221298ca69c9612bfbfd3dedcb28307">GHASH::finalize</a></div><div class="ttdeci">void finalize(void *token, size_t len)</div><div class="ttdoc">Finalizes the authentication process and returns the token. </div><div class="ttdef"><b>Definition:</b> <a href="GHASH_8cpp_source.html#l00121">GHASH.cpp:121</a></div></div>
<div class="ttc" id="classGCMCommon_html_ad926e980ae2d61c10c9bf82813154a25"><div class="ttname"><a href="classGCMCommon.html#ad926e980ae2d61c10c9bf82813154a25">GCMCommon::addAuthData</a></div><div class="ttdeci">void addAuthData(const void *data, size_t len)</div><div class="ttdoc">Adds extra data that will be authenticated but not encrypted. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8cpp_source.html#l00217">GCM.cpp:217</a></div></div>
<div class="ttc" id="classGHASH_html_a235edb14c6ed1ec55ddda595816ef1c7"><div class="ttname"><a href="classGHASH.html#a235edb14c6ed1ec55ddda595816ef1c7">GHASH::update</a></div><div class="ttdeci">void update(const void *data, size_t len)</div><div class="ttdoc">Updates the message authenticator with more data. </div><div class="ttdef"><b>Definition:</b> <a href="GHASH_8cpp_source.html#l00094">GHASH.cpp:94</a></div></div>
<div class="ttc" id="classGHASH_html_a235edb14c6ed1ec55ddda595816ef1c7"><div class="ttname"><a href="classGHASH.html#a235edb14c6ed1ec55ddda595816ef1c7">GHASH::update</a></div><div class="ttdeci">void update(const void *data, size_t len)</div><div class="ttdoc">Updates the message authenticator with more data. </div><div class="ttdef"><b>Definition:</b> <a href="GHASH_8cpp_source.html#l00085">GHASH.cpp:85</a></div></div>
<div class="ttc" id="classBlockCipher_html_aed0788b25f6bb2f1bd47d5a5f0c5db33"><div class="ttname"><a href="classBlockCipher.html#aed0788b25f6bb2f1bd47d5a5f0c5db33">BlockCipher::encryptBlock</a></div><div class="ttdeci">virtual void encryptBlock(uint8_t *output, const uint8_t *input)=0</div><div class="ttdoc">Encrypts a single block using this cipher. </div></div>
<div class="ttc" id="classGCMCommon_html_a60912d3ab5766aa68dc9b3111ac2c0d7"><div class="ttname"><a href="classGCMCommon.html#a60912d3ab5766aa68dc9b3111ac2c0d7">GCMCommon::decrypt</a></div><div class="ttdeci">void decrypt(uint8_t *output, const uint8_t *input, size_t len)</div><div class="ttdoc">Decrypts an input buffer and writes the plaintext to an output buffer. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8cpp_source.html#l00182">GCM.cpp:182</a></div></div>
<div class="ttc" id="classBlockCipher_html_a9a05307664469777592799c8f77397c4"><div class="ttname"><a href="classBlockCipher.html#a9a05307664469777592799c8f77397c4">BlockCipher::setKey</a></div><div class="ttdeci">virtual bool setKey(const uint8_t *key, size_t len)=0</div><div class="ttdoc">Sets the key to use for future encryption and decryption operations. </div></div>
<div class="ttc" id="classGCMCommon_html_a1b05ff393e8c20db30cb991e875aab19"><div class="ttname"><a href="classGCMCommon.html#a1b05ff393e8c20db30cb991e875aab19">GCMCommon::GCMCommon</a></div><div class="ttdeci">GCMCommon()</div><div class="ttdoc">Constructs a new cipher in GCM mode. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8cpp_source.html#l00044">GCM.cpp:44</a></div></div>
<div class="ttc" id="classGHASH_html_a8c38ee9313605f1d8b12dca7cd43e4ad"><div class="ttname"><a href="classGHASH.html#a8c38ee9313605f1d8b12dca7cd43e4ad">GHASH::pad</a></div><div class="ttdeci">void pad()</div><div class="ttdoc">Pads the input stream with zero bytes to a multiple of 16. </div><div class="ttdef"><b>Definition:</b> <a href="GHASH_8cpp_source.html#l00146">GHASH.cpp:146</a></div></div>
<div class="ttc" id="classGHASH_html_a8c38ee9313605f1d8b12dca7cd43e4ad"><div class="ttname"><a href="classGHASH.html#a8c38ee9313605f1d8b12dca7cd43e4ad">GHASH::pad</a></div><div class="ttdeci">void pad()</div><div class="ttdoc">Pads the input stream with zero bytes to a multiple of 16. </div><div class="ttdef"><b>Definition:</b> <a href="GHASH_8cpp_source.html#l00137">GHASH.cpp:137</a></div></div>
<div class="ttc" id="classBlockCipher_html_a6f27d46e9dfa7761d014d828ad5f955b"><div class="ttname"><a href="classBlockCipher.html#a6f27d46e9dfa7761d014d828ad5f955b">BlockCipher::clear</a></div><div class="ttdeci">virtual void clear()=0</div><div class="ttdoc">Clears all security-sensitive state from this block cipher. </div></div>
<div class="ttc" id="classGHASH_html_a4b1ee789debf56f7f24807960ef0556e"><div class="ttname"><a href="classGHASH.html#a4b1ee789debf56f7f24807960ef0556e">GHASH::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears the authenticator&#39;s state, removing all sensitive data. </div><div class="ttdef"><b>Definition:</b> <a href="GHASH_8cpp_source.html#l00159">GHASH.cpp:159</a></div></div>
<div class="ttc" id="classGHASH_html_a4b1ee789debf56f7f24807960ef0556e"><div class="ttname"><a href="classGHASH.html#a4b1ee789debf56f7f24807960ef0556e">GHASH::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears the authenticator&#39;s state, removing all sensitive data. </div><div class="ttdef"><b>Definition:</b> <a href="GHASH_8cpp_source.html#l00150">GHASH.cpp:150</a></div></div>
<div class="ttc" id="classGCMCommon_html_a0d3e1525d91adbbdcd5ac27793817112"><div class="ttname"><a href="classGCMCommon.html#a0d3e1525d91adbbdcd5ac27793817112">GCMCommon::~GCMCommon</a></div><div class="ttdeci">virtual ~GCMCommon()</div><div class="ttdoc">Destroys this cipher object after clearing sensitive information. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8cpp_source.html#l00056">GCM.cpp:56</a></div></div>
<div class="ttc" id="classGCMCommon_html_a2545135fe42c832e40e057b603824524"><div class="ttname"><a href="classGCMCommon.html#a2545135fe42c832e40e057b603824524">GCMCommon::setIV</a></div><div class="ttdeci">bool setIV(const uint8_t *iv, size_t len)</div><div class="ttdoc">Sets the initialization vector to use for future encryption and decryption operations. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8cpp_source.html#l00090">GCM.cpp:90</a></div></div>
<div class="ttc" id="classBlockCipher_html_afde6004a859e015d877eab3c37042a0f"><div class="ttname"><a href="classBlockCipher.html#afde6004a859e015d877eab3c37042a0f">BlockCipher::keySize</a></div><div class="ttdeci">virtual size_t keySize() const =0</div><div class="ttdoc">Default size of the key for this block cipher, in bytes. </div></div>
@@ -352,7 +352,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- fragment --></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>