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
2018-04-26 08:02:15 +10:00
parent 93bbc1af6f
commit d095aa79fc
291 changed files with 885 additions and 534 deletions

View File

@@ -180,22 +180,22 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="classAcorn128_html_af13cffd088e6ec25f9f781bea22fba12"><div class="ttname"><a href="classAcorn128.html#af13cffd088e6ec25f9f781bea22fba12">Acorn128::keySize</a></div><div class="ttdeci">size_t keySize() const </div><div class="ttdoc">Gets the size of the Acorn128 key in bytes. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00064">Acorn128.cpp:64</a></div></div>
<div class="ttc" id="classAcorn128_html_a4273a0b1eb880d98e34f2f9123fa167b"><div class="ttname"><a href="classAcorn128.html#a4273a0b1eb880d98e34f2f9123fa167b">Acorn128::encrypt</a></div><div class="ttdeci">void encrypt(uint8_t *output, const uint8_t *input, size_t len)</div><div class="ttdoc">Encrypts an input buffer and writes the ciphertext to an output buffer. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00554">Acorn128.cpp:554</a></div></div>
<div class="ttc" id="classAuthenticatedCipher_html"><div class="ttname"><a href="classAuthenticatedCipher.html">AuthenticatedCipher</a></div><div class="ttdoc">Abstract base class for authenticated ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="AuthenticatedCipher_8h_source.html#l00028">AuthenticatedCipher.h:28</a></div></div>
<div class="ttc" id="classAcorn128_html_ac98fa6f3ad9f12b090d678d94ffff56f"><div class="ttname"><a href="classAcorn128.html#ac98fa6f3ad9f12b090d678d94ffff56f">Acorn128::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears all security-sensitive state from this cipher object. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00679">Acorn128.cpp:679</a></div></div>
<div class="ttc" id="classAcorn128_html_a333c98509f0ba55dff684d54781c0242"><div class="ttname"><a href="classAcorn128.html#a333c98509f0ba55dff684d54781c0242">Acorn128::computeTag</a></div><div class="ttdeci">void computeTag(void *tag, size_t len)</div><div class="ttdoc">Finalizes the encryption process and computes the authentication tag. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00633">Acorn128.cpp:633</a></div></div>
<div class="ttc" id="classAcorn128_html_a7eacfc496f19b691207f64ba58b4c14a"><div class="ttname"><a href="classAcorn128.html#a7eacfc496f19b691207f64ba58b4c14a">Acorn128::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="Acorn128_8cpp_source.html#l00581">Acorn128.cpp:581</a></div></div>
<div class="ttc" id="classAcorn128_html_ac98fa6f3ad9f12b090d678d94ffff56f"><div class="ttname"><a href="classAcorn128.html#ac98fa6f3ad9f12b090d678d94ffff56f">Acorn128::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clears all security-sensitive state from this cipher object. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00677">Acorn128.cpp:677</a></div></div>
<div class="ttc" id="classAcorn128_html_a333c98509f0ba55dff684d54781c0242"><div class="ttname"><a href="classAcorn128.html#a333c98509f0ba55dff684d54781c0242">Acorn128::computeTag</a></div><div class="ttdeci">void computeTag(void *tag, size_t len)</div><div class="ttdoc">Finalizes the encryption process and computes the authentication tag. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00631">Acorn128.cpp:631</a></div></div>
<div class="ttc" id="classAcorn128_html_a7eacfc496f19b691207f64ba58b4c14a"><div class="ttname"><a href="classAcorn128.html#a7eacfc496f19b691207f64ba58b4c14a">Acorn128::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="Acorn128_8cpp_source.html#l00580">Acorn128.cpp:580</a></div></div>
<div class="ttc" id="classAcorn128_html_a170c189599a1cf332db5496dd6bc1df4"><div class="ttname"><a href="classAcorn128.html#a170c189599a1cf332db5496dd6bc1df4">Acorn128::~Acorn128</a></div><div class="ttdeci">virtual ~Acorn128()</div><div class="ttdoc">Destroys this Acorn128 authenticated cipher. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00054">Acorn128.cpp:54</a></div></div>
<div class="ttc" id="classAcorn128_html_a2a2b2285ffc4d0ed57d661d739d22302"><div class="ttname"><a href="classAcorn128.html#a2a2b2285ffc4d0ed57d661d739d22302">Acorn128::setKey</a></div><div class="ttdeci">bool setKey(const uint8_t *key, size_t len)</div><div class="ttdoc">Sets the key to use for future encryption and decryption operations. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00477">Acorn128.cpp:477</a></div></div>
<div class="ttc" id="classAcorn128_html"><div class="ttname"><a href="classAcorn128.html">Acorn128</a></div><div class="ttdoc">ACORN-128 authenticated cipher. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8h_source.html#l00067">Acorn128.h:67</a></div></div>
<div class="ttc" id="classAcorn128_html_a4141564021e8233727beb5b9f645dc4e"><div class="ttname"><a href="classAcorn128.html#a4141564021e8233727beb5b9f645dc4e">Acorn128::ivSize</a></div><div class="ttdeci">size_t ivSize() const </div><div class="ttdoc">Gets the size of the Acorn128 initialization vector in bytes. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00077">Acorn128.cpp:77</a></div></div>
<div class="ttc" id="classAcorn128_html_a0a1c914c76d15af00bbb348f160bbacb"><div class="ttname"><a href="classAcorn128.html#a0a1c914c76d15af00bbb348f160bbacb">Acorn128::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="Acorn128_8cpp_source.html#l00662">Acorn128.cpp:662</a></div></div>
<div class="ttc" id="classAcorn128_html_a0a1c914c76d15af00bbb348f160bbacb"><div class="ttname"><a href="classAcorn128.html#a0a1c914c76d15af00bbb348f160bbacb">Acorn128::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="Acorn128_8cpp_source.html#l00660">Acorn128.cpp:660</a></div></div>
<div class="ttc" id="classAcorn128_html_ae4e9ecf2030c4d2e3f32a19f937de845"><div class="ttname"><a href="classAcorn128.html#ae4e9ecf2030c4d2e3f32a19f937de845">Acorn128::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="Acorn128_8cpp_source.html#l00495">Acorn128.cpp:495</a></div></div>
<div class="ttc" id="classAcorn128_html_af42823fb01dcbdeb8a93fa4103edebf2"><div class="ttname"><a href="classAcorn128.html#af42823fb01dcbdeb8a93fa4103edebf2">Acorn128::Acorn128</a></div><div class="ttdeci">Acorn128()</div><div class="ttdoc">Constructs a new Acorn128 authenticated cipher. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00046">Acorn128.cpp:46</a></div></div>
<div class="ttc" id="classAcorn128_html_a75c8953cea6b9cd59aa5034dfe739889"><div class="ttname"><a href="classAcorn128.html#a75c8953cea6b9cd59aa5034dfe739889">Acorn128::tagSize</a></div><div class="ttdeci">size_t tagSize() const </div><div class="ttdoc">Gets the size of the Acorn128 authentication tag in bytes. </div><div class="ttdef"><b>Definition:</b> <a href="Acorn128_8cpp_source.html#l00087">Acorn128.cpp:87</a></div></div>
<div class="ttc" id="classAcorn128_html_a9a893539010c729c7d93a7acfd76ae67"><div class="ttname"><a href="classAcorn128.html#a9a893539010c729c7d93a7acfd76ae67">Acorn128::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="Acorn128_8cpp_source.html#l00608">Acorn128.cpp:608</a></div></div>
<div class="ttc" id="classAcorn128_html_a9a893539010c729c7d93a7acfd76ae67"><div class="ttname"><a href="classAcorn128.html#a9a893539010c729c7d93a7acfd76ae67">Acorn128::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="Acorn128_8cpp_source.html#l00606">Acorn128.cpp:606</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Apr 26 2018 06:55:48 for Arduino Cryptography Library by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Apr 26 2018 08:02:03 for Arduino Cryptography Library by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>