taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2018-04-26 06:56:28 +10:00
parent cb89ac731d
commit 93bbc1af6f
296 changed files with 3447 additions and 750 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
GCM_8h_source.html
View File

@@ -167,30 +167,30 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;};</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classGCMCommon_html_a444634bd4469bb5d404ac882d1d8fdf4"><div class="ttname"><a href="classGCMCommon.html#a444634bd4469bb5d404ac882d1d8fdf4">GCMCommon::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="GCM_8cpp_source.html#l00226">GCM.cpp:226</a></div></div>
<div class="ttc" id="classGCMCommon_html_a444634bd4469bb5d404ac882d1d8fdf4"><div class="ttname"><a href="classGCMCommon.html#a444634bd4469bb5d404ac882d1d8fdf4">GCMCommon::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="GCM_8cpp_source.html#l00222">GCM.cpp:222</a></div></div>
<div class="ttc" id="classGCM_html"><div class="ttname"><a href="classGCM.html">GCM</a></div><div class="ttdoc">Implementation of the Galois Counter Mode (GCM). </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8h_source.html#l00071">GCM.h:71</a></div></div>
<div class="ttc" id="classGCMCommon_html_a397c5dddde828c59eb63367385aec562"><div class="ttname"><a href="classGCMCommon.html#a397c5dddde828c59eb63367385aec562">GCMCommon::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="GCM_8cpp_source.html#l00077">GCM.cpp:77</a></div></div>
<div class="ttc" id="classGCMCommon_html_a935f343858e98ee331706daf43e34805"><div class="ttname"><a href="classGCMCommon.html#a935f343858e98ee331706daf43e34805">GCMCommon::tagSize</a></div><div class="ttdeci">size_t tagSize() const </div><div class="ttdoc">Returns the size of the authentication tag. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8cpp_source.html#l00072">GCM.cpp:72</a></div></div>
<div class="ttc" id="classGCMCommon_html_a01ac69afe3d9fc4d72b2ea5dc242e55c"><div class="ttname"><a href="classGCMCommon.html#a01ac69afe3d9fc4d72b2ea5dc242e55c">GCMCommon::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="GCM_8cpp_source.html#l00146">GCM.cpp:146</a></div></div>
<div class="ttc" id="classGCMCommon_html_a01ac69afe3d9fc4d72b2ea5dc242e55c"><div class="ttname"><a href="classGCMCommon.html#a01ac69afe3d9fc4d72b2ea5dc242e55c">GCMCommon::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="GCM_8cpp_source.html#l00142">GCM.cpp:142</a></div></div>
<div class="ttc" id="classBlockCipher_html"><div class="ttname"><a href="classBlockCipher.html">BlockCipher</a></div><div class="ttdoc">Abstract base class for block ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="BlockCipher_8h_source.html#l00029">BlockCipher.h:29</a></div></div>
<div class="ttc" id="classGCM_html_acbef04a5593177aabf19df538ad3def7"><div class="ttname"><a href="classGCM.html#acbef04a5593177aabf19df538ad3def7">GCM::GCM</a></div><div class="ttdeci">GCM()</div><div class="ttdoc">Constructs a new GCM object for the block cipher T. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8h_source.html#l00074">GCM.h:74</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="classGCMCommon_html"><div class="ttname"><a href="classGCMCommon.html">GCMCommon</a></div><div class="ttdoc">Concrete base class to assist with implementing GCM for 128-bit block ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8h_source.html#l00030">GCM.h:30</a></div></div>
<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#l00257">GCM.cpp:257</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#l00246">GCM.cpp:246</a></div></div>
<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#l00253">GCM.cpp:253</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#l00242">GCM.cpp:242</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="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#l00218">GCM.cpp:218</a></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#l00183">GCM.cpp:183</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#l00214">GCM.cpp:214</a></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#l00179">GCM.cpp:179</a></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="classGCMCommon_html_a7abd3044862f8634f3b176aafa779ba2"><div class="ttname"><a href="classGCMCommon.html#a7abd3044862f8634f3b176aafa779ba2">GCMCommon::setBlockCipher</a></div><div class="ttdeci">void setBlockCipher(BlockCipher *cipher)</div><div class="ttdoc">Sets the block cipher to use for this GCM object. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8h_source.html#l00054">GCM.h:54</a></div></div>
<div class="ttc" id="classGHASH_html"><div class="ttname"><a href="classGHASH.html">GHASH</a></div><div class="ttdoc">Implementation of the GHASH message authenticator. </div><div class="ttdef"><b>Definition:</b> <a href="GHASH_8h_source.html#l00029">GHASH.h:29</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="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#l00083">GCM.cpp:83</a></div></div>
<div class="ttc" id="classGCMCommon_html_a134ba35e740a18bee3c45502b4149eae"><div class="ttname"><a href="classGCMCommon.html#a134ba35e740a18bee3c45502b4149eae">GCMCommon::keySize</a></div><div class="ttdeci">size_t keySize() const </div><div class="ttdoc">Default size of the key for this cipher, in bytes. </div><div class="ttdef"><b>Definition:</b> <a href="GCM_8cpp_source.html#l00061">GCM.cpp:61</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Apr 7 2018 10:23:43 for Arduino Cryptography Library by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Apr 26 2018 06:55:48 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>