1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
arduinolibs/CTR_8h_source.html
Rhys Weatherley df341279d0 Update docs
2018-04-27 11:07:55 +10:00

183 lines
22 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Arduino Cryptography Library: CTR.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Arduino Cryptography Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li><li class="navelem"><a class="el" href="dir_e2ce51835550ba18edf07a8311722290.html">Crypto</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">CTR.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (C) 2015 Southern Storm Software, Pty Ltd.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * copy of this software and associated documentation files (the &quot;Software&quot;),</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * in all copies or substantial portions of the Software.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef CRYPTO_CTR_h</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define CRYPTO_CTR_h</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;Cipher.h&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;BlockCipher.h&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classCTRCommon.html"> 29</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCTRCommon.html">CTRCommon</a> : <span class="keyword">public</span> <a class="code" href="classCipher.html">Cipher</a></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classCTRCommon.html">CTRCommon</a>();</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classCTRCommon.html#a29ce8e13a302350397fc6790a686bea2">keySize</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classCTRCommon.html#a98c1717d11d8da8e1fa108607358774a">ivSize</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classCTRCommon.html#ae2bc6b33a864412598b426320d853337">setCounterSize</a>(<span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classCTRCommon.html#a79da937dc2c444a174176beab33c055a">setKey</a>(<span class="keyword">const</span> uint8_t *key, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classCTRCommon.html#aad289af3eb013cb3ffda6d7e8e8b3d04">setIV</a>(<span class="keyword">const</span> uint8_t *iv, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCTRCommon.html#a201bda584d111552ce8ec09fac759963">encrypt</a>(uint8_t *output, <span class="keyword">const</span> uint8_t *input, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCTRCommon.html#a0943387cf1124258389702e0690740fe">decrypt</a>(uint8_t *output, <span class="keyword">const</span> uint8_t *input, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCTRCommon.html#ac0d6381c02fe2a8a017ad66d006a6ef2">clear</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="classCTRCommon.html#abeb01342f17023e99776001d397c51ff">CTRCommon</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classCTRCommon.html#a6c409c4ec1f99e0cb751196d891dc228"> 49</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classCTRCommon.html#a6c409c4ec1f99e0cb751196d891dc228">setBlockCipher</a>(<a class="code" href="classBlockCipher.html">BlockCipher</a> *cipher) { blockCipher = cipher; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="classBlockCipher.html">BlockCipher</a> *blockCipher;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uint8_t counter[16];</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; uint8_t state[16];</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; uint8_t posn;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; uint8_t counterStart;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;};</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classCTR.html"> 60</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCTR.html">CTR</a> : <span class="keyword">public</span> <a class="code" href="classCTRCommon.html">CTRCommon</a></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;{</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classCTR.html#a7025ab5d79f0f0763f751aeabc425ca9"> 63</a></span>&#160; <a class="code" href="classCTR.html#a7025ab5d79f0f0763f751aeabc425ca9">CTR</a>() { <a class="code" href="classCTRCommon.html#a6c409c4ec1f99e0cb751196d891dc228">setBlockCipher</a>(&amp;cipher); }</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; T cipher;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;};</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classCipher_html"><div class="ttname"><a href="classCipher.html">Cipher</a></div><div class="ttdoc">Abstract base class for stream ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="Cipher_8h_source.html#l00029">Cipher.h:29</a></div></div>
<div class="ttc" id="classCTR_html_a7025ab5d79f0f0763f751aeabc425ca9"><div class="ttname"><a href="classCTR.html#a7025ab5d79f0f0763f751aeabc425ca9">CTR::CTR</a></div><div class="ttdeci">CTR()</div><div class="ttdoc">Constructs a new CTR object for the 128-bit block cipher T. </div><div class="ttdef"><b>Definition:</b> <a href="CTR_8h_source.html#l00063">CTR.h:63</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="classCTRCommon_html_a6c409c4ec1f99e0cb751196d891dc228"><div class="ttname"><a href="classCTRCommon.html#a6c409c4ec1f99e0cb751196d891dc228">CTRCommon::setBlockCipher</a></div><div class="ttdeci">void setBlockCipher(BlockCipher *cipher)</div><div class="ttdoc">Sets the block cipher to use for this CTR object. </div><div class="ttdef"><b>Definition:</b> <a href="CTR_8h_source.html#l00049">CTR.h:49</a></div></div>
<div class="ttc" id="classCTRCommon_html_aad289af3eb013cb3ffda6d7e8e8b3d04"><div class="ttname"><a href="classCTRCommon.html#aad289af3eb013cb3ffda6d7e8e8b3d04">CTRCommon::setIV</a></div><div class="ttdeci">bool setIV(const uint8_t *iv, size_t len)</div><div class="ttdoc">Sets the initial counter value to use for future encryption and decryption operations. </div><div class="ttdef"><b>Definition:</b> <a href="CTR_8cpp_source.html#l00119">CTR.cpp:119</a></div></div>
<div class="ttc" id="classCTRCommon_html_ae2bc6b33a864412598b426320d853337"><div class="ttname"><a href="classCTRCommon.html#ae2bc6b33a864412598b426320d853337">CTRCommon::setCounterSize</a></div><div class="ttdeci">bool setCounterSize(size_t size)</div><div class="ttdoc">Sets the counter size for the IV. </div><div class="ttdef"><b>Definition:</b> <a href="CTR_8cpp_source.html#l00086">CTR.cpp:86</a></div></div>
<div class="ttc" id="classCTRCommon_html_a201bda584d111552ce8ec09fac759963"><div class="ttname"><a href="classCTRCommon.html#a201bda584d111552ce8ec09fac759963">CTRCommon::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="CTR_8cpp_source.html#l00128">CTR.cpp:128</a></div></div>
<div class="ttc" id="classCTRCommon_html_a0943387cf1124258389702e0690740fe"><div class="ttname"><a href="classCTRCommon.html#a0943387cf1124258389702e0690740fe">CTRCommon::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="CTR_8cpp_source.html#l00160">CTR.cpp:160</a></div></div>
<div class="ttc" id="classCTRCommon_html_abeb01342f17023e99776001d397c51ff"><div class="ttname"><a href="classCTRCommon.html#abeb01342f17023e99776001d397c51ff">CTRCommon::CTRCommon</a></div><div class="ttdeci">CTRCommon()</div><div class="ttdoc">Constructs a new cipher in CTR mode. </div><div class="ttdef"><b>Definition:</b> <a href="CTR_8cpp_source.html#l00042">CTR.cpp:42</a></div></div>
<div class="ttc" id="classCTRCommon_html_a29ce8e13a302350397fc6790a686bea2"><div class="ttname"><a href="classCTRCommon.html#a29ce8e13a302350397fc6790a686bea2">CTRCommon::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="CTR_8cpp_source.html#l00057">CTR.cpp:57</a></div></div>
<div class="ttc" id="classCTRCommon_html_a98c1717d11d8da8e1fa108607358774a"><div class="ttname"><a href="classCTRCommon.html#a98c1717d11d8da8e1fa108607358774a">CTRCommon::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="CTR_8cpp_source.html#l00062">CTR.cpp:62</a></div></div>
<div class="ttc" id="classCTRCommon_html_a79da937dc2c444a174176beab33c055a"><div class="ttname"><a href="classCTRCommon.html#a79da937dc2c444a174176beab33c055a">CTRCommon::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="CTR_8cpp_source.html#l00094">CTR.cpp:94</a></div></div>
<div class="ttc" id="classCTR_html"><div class="ttname"><a href="classCTR.html">CTR</a></div><div class="ttdoc">Implementation of the Counter (CTR) mode for 128-bit block ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="CTR_8h_source.html#l00060">CTR.h:60</a></div></div>
<div class="ttc" id="classCTRCommon_html_ac0d6381c02fe2a8a017ad66d006a6ef2"><div class="ttname"><a href="classCTRCommon.html#ac0d6381c02fe2a8a017ad66d006a6ef2">CTRCommon::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="CTR_8cpp_source.html#l00165">CTR.cpp:165</a></div></div>
<div class="ttc" id="classCTRCommon_html"><div class="ttname"><a href="classCTRCommon.html">CTRCommon</a></div><div class="ttdoc">Concrete base class to assist with implementing CTR mode for 128-bit block ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="CTR_8h_source.html#l00029">CTR.h:29</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 27 2018 11:07:37 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>
</body>
</html>