1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
arduinolibs/classCBC.html
Rhys Weatherley 13300f16d6 Update docs
2015-12-05 17:51:39 +10:00

194 lines
20 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>ArduinoLibs: CBC&lt; T &gt; Class Template Reference</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">ArduinoLibs
</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="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classCBC-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CBC&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implementation of the <a class="el" href="classCipher.html" title="Abstract base class for stream ciphers. ">Cipher</a> Block Chaining (<a class="el" href="classCBC.html" title="Implementation of the Cipher Block Chaining (CBC) mode for 128-bit block ciphers. ...">CBC</a>) mode for 128-bit block ciphers.
<a href="classCBC.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="CBC_8h_source.html">CBC.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CBC&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classCBC.png" usemap="#CBC&lt; T &gt;_map" alt=""/>
<map id="CBC&lt; T &gt;_map" name="CBC&lt; T &gt;_map">
<area href="classCBCCommon.html" title="Concrete base class to assist with implementing CBC for 128-bit block ciphers. " alt="CBCCommon" shape="rect" coords="0,56,86,80"/>
<area href="classCipher.html" title="Abstract base class for stream ciphers. " alt="Cipher" shape="rect" coords="0,0,86,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae22d0d9347d5f3c97328e643a9b29ecb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae22d0d9347d5f3c97328e643a9b29ecb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBC.html#ae22d0d9347d5f3c97328e643a9b29ecb">CBC</a> ()</td></tr>
<tr class="memdesc:ae22d0d9347d5f3c97328e643a9b29ecb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="classCBC.html" title="Implementation of the Cipher Block Chaining (CBC) mode for 128-bit block ciphers. ...">CBC</a> object for the block cipher T. <br/></td></tr>
<tr class="separator:ae22d0d9347d5f3c97328e643a9b29ecb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classCBCCommon"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCBCCommon')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classCBCCommon.html">CBCCommon</a></td></tr>
<tr class="memitem:a45a91367531b4692b3bb7237ab6e9015 inherit pub_methods_classCBCCommon"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45a91367531b4692b3bb7237ab6e9015"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBCCommon.html#a45a91367531b4692b3bb7237ab6e9015">~CBCCommon</a> ()</td></tr>
<tr class="memdesc:a45a91367531b4692b3bb7237ab6e9015 inherit pub_methods_classCBCCommon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this cipher object after clearing sensitive information. <br/></td></tr>
<tr class="separator:a45a91367531b4692b3bb7237ab6e9015 inherit pub_methods_classCBCCommon"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb7daacfe2a4fca3d13b62b75372fe4e inherit pub_methods_classCBCCommon"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBCCommon.html#adb7daacfe2a4fca3d13b62b75372fe4e">keySize</a> () const </td></tr>
<tr class="memdesc:adb7daacfe2a4fca3d13b62b75372fe4e inherit pub_methods_classCBCCommon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default size of the key for this cipher, in bytes. <a href="#adb7daacfe2a4fca3d13b62b75372fe4e">More...</a><br/></td></tr>
<tr class="separator:adb7daacfe2a4fca3d13b62b75372fe4e inherit pub_methods_classCBCCommon"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a016277533730284a38bb6ad8cd6f91ce inherit pub_methods_classCBCCommon"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBCCommon.html#a016277533730284a38bb6ad8cd6f91ce">ivSize</a> () const </td></tr>
<tr class="memdesc:a016277533730284a38bb6ad8cd6f91ce inherit pub_methods_classCBCCommon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the initialization vector for this cipher, in bytes. <a href="#a016277533730284a38bb6ad8cd6f91ce">More...</a><br/></td></tr>
<tr class="separator:a016277533730284a38bb6ad8cd6f91ce inherit pub_methods_classCBCCommon"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add75ea4342a190e560cee26a8e9efc37 inherit pub_methods_classCBCCommon"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBCCommon.html#add75ea4342a190e560cee26a8e9efc37">setKey</a> (const uint8_t *key, size_t len)</td></tr>
<tr class="memdesc:add75ea4342a190e560cee26a8e9efc37 inherit pub_methods_classCBCCommon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the key to use for future encryption and decryption operations. <a href="#add75ea4342a190e560cee26a8e9efc37">More...</a><br/></td></tr>
<tr class="separator:add75ea4342a190e560cee26a8e9efc37 inherit pub_methods_classCBCCommon"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7a586217835055b3a354bb932db160c inherit pub_methods_classCBCCommon"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBCCommon.html#ac7a586217835055b3a354bb932db160c">setIV</a> (const uint8_t *iv, size_t len)</td></tr>
<tr class="memdesc:ac7a586217835055b3a354bb932db160c inherit pub_methods_classCBCCommon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the initialization vector to use for future encryption and decryption operations. <a href="#ac7a586217835055b3a354bb932db160c">More...</a><br/></td></tr>
<tr class="separator:ac7a586217835055b3a354bb932db160c inherit pub_methods_classCBCCommon"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41d2f655a7df13cfcd009b2882e13147 inherit pub_methods_classCBCCommon"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBCCommon.html#a41d2f655a7df13cfcd009b2882e13147">encrypt</a> (uint8_t *output, const uint8_t *input, size_t len)</td></tr>
<tr class="memdesc:a41d2f655a7df13cfcd009b2882e13147 inherit pub_methods_classCBCCommon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encrypts an input buffer and writes the ciphertext to an output buffer. <a href="#a41d2f655a7df13cfcd009b2882e13147">More...</a><br/></td></tr>
<tr class="separator:a41d2f655a7df13cfcd009b2882e13147 inherit pub_methods_classCBCCommon"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab46a2625cae9a654c708e1f31a0e22b6 inherit pub_methods_classCBCCommon"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBCCommon.html#ab46a2625cae9a654c708e1f31a0e22b6">decrypt</a> (uint8_t *output, const uint8_t *input, size_t len)</td></tr>
<tr class="memdesc:ab46a2625cae9a654c708e1f31a0e22b6 inherit pub_methods_classCBCCommon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrypts an input buffer and writes the plaintext to an output buffer. <a href="#ab46a2625cae9a654c708e1f31a0e22b6">More...</a><br/></td></tr>
<tr class="separator:ab46a2625cae9a654c708e1f31a0e22b6 inherit pub_methods_classCBCCommon"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7befadfe7384e0e857a96a59bf3845e9 inherit pub_methods_classCBCCommon"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBCCommon.html#a7befadfe7384e0e857a96a59bf3845e9">clear</a> ()</td></tr>
<tr class="memdesc:a7befadfe7384e0e857a96a59bf3845e9 inherit pub_methods_classCBCCommon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears all security-sensitive state from this cipher. <a href="#a7befadfe7384e0e857a96a59bf3845e9">More...</a><br/></td></tr>
<tr class="separator:a7befadfe7384e0e857a96a59bf3845e9 inherit pub_methods_classCBCCommon"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classCipher"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCipher')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classCipher.html">Cipher</a></td></tr>
<tr class="memitem:a6a61077eca3ccd5900f92ceac58fb09c inherit pub_methods_classCipher"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a61077eca3ccd5900f92ceac58fb09c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCipher.html#a6a61077eca3ccd5900f92ceac58fb09c">Cipher</a> ()</td></tr>
<tr class="memdesc:a6a61077eca3ccd5900f92ceac58fb09c inherit pub_methods_classCipher"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new cipher object. <br/></td></tr>
<tr class="separator:a6a61077eca3ccd5900f92ceac58fb09c inherit pub_methods_classCipher"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84bdea765f7e35aa5b5950dd2853a383 inherit pub_methods_classCipher"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCipher.html#a84bdea765f7e35aa5b5950dd2853a383">~Cipher</a> ()</td></tr>
<tr class="memdesc:a84bdea765f7e35aa5b5950dd2853a383 inherit pub_methods_classCipher"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this cipher object. <a href="#a84bdea765f7e35aa5b5950dd2853a383">More...</a><br/></td></tr>
<tr class="separator:a84bdea765f7e35aa5b5950dd2853a383 inherit pub_methods_classCipher"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classCBCCommon"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classCBCCommon')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classCBCCommon.html">CBCCommon</a></td></tr>
<tr class="memitem:a7575b369910e05f54e76698dd04bfa05 inherit pro_methods_classCBCCommon"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBCCommon.html#a7575b369910e05f54e76698dd04bfa05">CBCCommon</a> ()</td></tr>
<tr class="memdesc:a7575b369910e05f54e76698dd04bfa05 inherit pro_methods_classCBCCommon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new cipher in <a class="el" href="classCBC.html" title="Implementation of the Cipher Block Chaining (CBC) mode for 128-bit block ciphers. ...">CBC</a> mode. <a href="#a7575b369910e05f54e76698dd04bfa05">More...</a><br/></td></tr>
<tr class="separator:a7575b369910e05f54e76698dd04bfa05 inherit pro_methods_classCBCCommon"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b7631244b0c2c954cfdb50eb32f7db1 inherit pro_methods_classCBCCommon"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCBCCommon.html#a0b7631244b0c2c954cfdb50eb32f7db1">setBlockCipher</a> (<a class="el" href="classBlockCipher.html">BlockCipher</a> *cipher)</td></tr>
<tr class="memdesc:a0b7631244b0c2c954cfdb50eb32f7db1 inherit pro_methods_classCBCCommon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the block cipher to use for this <a class="el" href="classCBC.html" title="Implementation of the Cipher Block Chaining (CBC) mode for 128-bit block ciphers. ...">CBC</a> object. <a href="#a0b7631244b0c2c954cfdb50eb32f7db1">More...</a><br/></td></tr>
<tr class="separator:a0b7631244b0c2c954cfdb50eb32f7db1 inherit pro_methods_classCBCCommon"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br/>
class CBC&lt; T &gt;</h3>
<p>Implementation of the <a class="el" href="classCipher.html" title="Abstract base class for stream ciphers. ">Cipher</a> Block Chaining (<a class="el" href="classCBC.html" title="Implementation of the Cipher Block Chaining (CBC) mode for 128-bit block ciphers. ...">CBC</a>) mode for 128-bit block ciphers. </p>
<p>The template parameter T must be a concrete subclass of <a class="el" href="classBlockCipher.html" title="Abstract base class for block ciphers. ">BlockCipher</a> indicating the specific block cipher to use. T must have a block size of 16 bytes (128 bits).</p>
<p>For example, the following creates a <a class="el" href="classCBC.html" title="Implementation of the Cipher Block Chaining (CBC) mode for 128-bit block ciphers. ...">CBC</a> object using <a class="el" href="classAES192.html" title="AES block cipher with 192-bit keys. ">AES192</a> as the underlying cipher:</p>
<div class="fragment"><div class="line"><a class="code" href="classCBC.html">CBC&lt;AES192&gt;</a> cbc;</div>
<div class="line">cbc.<a class="code" href="classCBCCommon.html#add75ea4342a190e560cee26a8e9efc37">setKey</a>(key, 24);</div>
<div class="line">cbc.<a class="code" href="classCBCCommon.html#ac7a586217835055b3a354bb932db160c">setIV</a>(iv, 16);</div>
<div class="line">cbc.<a class="code" href="classCBCCommon.html#a41d2f655a7df13cfcd009b2882e13147">encrypt</a>(output, input, len);</div>
</div><!-- fragment --><p>Decryption is similar:</p>
<div class="fragment"><div class="line"><a class="code" href="classCBC.html">CBC&lt;AES192&gt;</a> cbc;</div>
<div class="line">cbc.<a class="code" href="classCBCCommon.html#add75ea4342a190e560cee26a8e9efc37">setKey</a>(key, 24);</div>
<div class="line">cbc.<a class="code" href="classCBCCommon.html#ac7a586217835055b3a354bb932db160c">setIV</a>(iv, 16);</div>
<div class="line">cbc.<a class="code" href="classCBCCommon.html#ab46a2625cae9a654c708e1f31a0e22b6">decrypt</a>(output, input, len);</div>
</div><!-- fragment --><p>The size of the ciphertext will always be the same as the size of the plaintext. Also, the length of the plaintext/ciphertext must be a multiple of 16. Extra bytes are ignored and not encrypted. The caller is responsible for padding the underlying data to a multiple of 16 using an appropriate padding scheme for the application.</p>
<p>Reference: <a href="http://en.wikipedia.org/wiki/Block_cipher_mode_of_operation">http://en.wikipedia.org/wiki/Block_cipher_mode_of_operation</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classCTR.html" title="Implementation of the Counter (CTR) mode for 128-bit block ciphers. ">CTR</a>, <a class="el" href="classCFB.html" title="Implementation of the Cipher Feedback (CFB) mode for 128-bit block ciphers. ">CFB</a>, <a class="el" href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</a> </dd></dl>
<p>Definition at line <a class="el" href="CBC_8h_source.html#l00057">57</a> of file <a class="el" href="CBC_8h_source.html">CBC.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="CBC_8h_source.html">CBC.h</a></li>
<li><a class="el" href="CBC_8cpp_source.html">CBC.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Dec 5 2015 17:50:26 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>
</body>
</html>