mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
193 lines
20 KiB
HTML
193 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>Arduino Cryptography Library: CFB< T > 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">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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </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> |
|
|
<a href="classCFB-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">CFB< T > 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> Feedback (<a class="el" href="classCFB.html" title="Implementation of the Cipher Feedback (CFB) mode for 128-bit block ciphers. ">CFB</a>) mode for 128-bit block ciphers.
|
|
<a href="classCFB.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="CFB_8h_source.html">CFB.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for CFB< T >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classCFB.png" usemap="#CFB< T >_map" alt=""/>
|
|
<map id="CFB< T >_map" name="CFB< T >_map">
|
|
<area href="classCFBCommon.html" title="Concrete base class to assist with implementing CFB for 128-bit block ciphers. " alt="CFBCommon" shape="rect" coords="0,56,85,80"/>
|
|
<area href="classCipher.html" title="Abstract base class for stream ciphers. " alt="Cipher" shape="rect" coords="0,0,85,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:a26a027614d027162c67085a58b512318"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26a027614d027162c67085a58b512318"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFB.html#a26a027614d027162c67085a58b512318">CFB</a> ()</td></tr>
|
|
<tr class="memdesc:a26a027614d027162c67085a58b512318"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classCFB.html" title="Implementation of the Cipher Feedback (CFB) mode for 128-bit block ciphers. ">CFB</a> object for the block cipher T. <br/></td></tr>
|
|
<tr class="separator:a26a027614d027162c67085a58b512318"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classCFBCommon"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCFBCommon')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classCFBCommon.html">CFBCommon</a></td></tr>
|
|
<tr class="memitem:ae200d7b876a1f154bcdb1cdf33d3be54 inherit pub_methods_classCFBCommon"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae200d7b876a1f154bcdb1cdf33d3be54"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFBCommon.html#ae200d7b876a1f154bcdb1cdf33d3be54">~CFBCommon</a> ()</td></tr>
|
|
<tr class="memdesc:ae200d7b876a1f154bcdb1cdf33d3be54 inherit pub_methods_classCFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this cipher object after clearing sensitive information. <br/></td></tr>
|
|
<tr class="separator:ae200d7b876a1f154bcdb1cdf33d3be54 inherit pub_methods_classCFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82899da983bc70bc8152ee67f424552e inherit pub_methods_classCFBCommon"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFBCommon.html#a82899da983bc70bc8152ee67f424552e">keySize</a> () const </td></tr>
|
|
<tr class="memdesc:a82899da983bc70bc8152ee67f424552e inherit pub_methods_classCFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Default size of the key for this cipher, in bytes. <a href="#a82899da983bc70bc8152ee67f424552e">More...</a><br/></td></tr>
|
|
<tr class="separator:a82899da983bc70bc8152ee67f424552e inherit pub_methods_classCFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55db1be69de87aafe5601d31be918ebb inherit pub_methods_classCFBCommon"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFBCommon.html#a55db1be69de87aafe5601d31be918ebb">ivSize</a> () const </td></tr>
|
|
<tr class="memdesc:a55db1be69de87aafe5601d31be918ebb inherit pub_methods_classCFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Size of the initialization vector for this cipher, in bytes. <a href="#a55db1be69de87aafe5601d31be918ebb">More...</a><br/></td></tr>
|
|
<tr class="separator:a55db1be69de87aafe5601d31be918ebb inherit pub_methods_classCFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45b9be25fb96f0e3ca5211b064e2baea inherit pub_methods_classCFBCommon"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFBCommon.html#a45b9be25fb96f0e3ca5211b064e2baea">setKey</a> (const uint8_t *key, size_t len)</td></tr>
|
|
<tr class="memdesc:a45b9be25fb96f0e3ca5211b064e2baea inherit pub_methods_classCFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Sets the key to use for future encryption and decryption operations. <a href="#a45b9be25fb96f0e3ca5211b064e2baea">More...</a><br/></td></tr>
|
|
<tr class="separator:a45b9be25fb96f0e3ca5211b064e2baea inherit pub_methods_classCFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a597040eb7df40adbbef94b4c3975cd80 inherit pub_methods_classCFBCommon"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFBCommon.html#a597040eb7df40adbbef94b4c3975cd80">setIV</a> (const uint8_t *iv, size_t len)</td></tr>
|
|
<tr class="memdesc:a597040eb7df40adbbef94b4c3975cd80 inherit pub_methods_classCFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Sets the initialization vector to use for future encryption and decryption operations. <a href="#a597040eb7df40adbbef94b4c3975cd80">More...</a><br/></td></tr>
|
|
<tr class="separator:a597040eb7df40adbbef94b4c3975cd80 inherit pub_methods_classCFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57af3692389bed300d3cfdf351351c51 inherit pub_methods_classCFBCommon"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFBCommon.html#a57af3692389bed300d3cfdf351351c51">encrypt</a> (uint8_t *output, const uint8_t *input, size_t len)</td></tr>
|
|
<tr class="memdesc:a57af3692389bed300d3cfdf351351c51 inherit pub_methods_classCFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Encrypts an input buffer and writes the ciphertext to an output buffer. <a href="#a57af3692389bed300d3cfdf351351c51">More...</a><br/></td></tr>
|
|
<tr class="separator:a57af3692389bed300d3cfdf351351c51 inherit pub_methods_classCFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaaa3d61c5743e30e355207c193c0b0ef inherit pub_methods_classCFBCommon"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFBCommon.html#aaaa3d61c5743e30e355207c193c0b0ef">decrypt</a> (uint8_t *output, const uint8_t *input, size_t len)</td></tr>
|
|
<tr class="memdesc:aaaa3d61c5743e30e355207c193c0b0ef inherit pub_methods_classCFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Decrypts an input buffer and writes the plaintext to an output buffer. <a href="#aaaa3d61c5743e30e355207c193c0b0ef">More...</a><br/></td></tr>
|
|
<tr class="separator:aaaa3d61c5743e30e355207c193c0b0ef inherit pub_methods_classCFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a847d320b0fe7f329385f26511b42c40d inherit pub_methods_classCFBCommon"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFBCommon.html#a847d320b0fe7f329385f26511b42c40d">clear</a> ()</td></tr>
|
|
<tr class="memdesc:a847d320b0fe7f329385f26511b42c40d inherit pub_methods_classCFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Clears all security-sensitive state from this cipher. <a href="#a847d320b0fe7f329385f26511b42c40d">More...</a><br/></td></tr>
|
|
<tr class="separator:a847d320b0fe7f329385f26511b42c40d inherit pub_methods_classCFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classCipher"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCipher')"><img src="closed.png" alt="-"/> 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>
|
|
 </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"> </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"> </td></tr>
|
|
<tr class="memitem:a84bdea765f7e35aa5b5950dd2853a383 inherit pub_methods_classCipher"><td class="memItemLeft" align="right" valign="top">virtual </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"> </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"> </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_classCFBCommon"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classCFBCommon')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classCFBCommon.html">CFBCommon</a></td></tr>
|
|
<tr class="memitem:adad0210430c83817c993bdca30d562a6 inherit pro_methods_classCFBCommon"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFBCommon.html#adad0210430c83817c993bdca30d562a6">CFBCommon</a> ()</td></tr>
|
|
<tr class="memdesc:adad0210430c83817c993bdca30d562a6 inherit pro_methods_classCFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new cipher in <a class="el" href="classCFB.html" title="Implementation of the Cipher Feedback (CFB) mode for 128-bit block ciphers. ">CFB</a> mode. <a href="#adad0210430c83817c993bdca30d562a6">More...</a><br/></td></tr>
|
|
<tr class="separator:adad0210430c83817c993bdca30d562a6 inherit pro_methods_classCFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9161530f456efacb64f5008fdb1a460c inherit pro_methods_classCFBCommon"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFBCommon.html#a9161530f456efacb64f5008fdb1a460c">setBlockCipher</a> (<a class="el" href="classBlockCipher.html">BlockCipher</a> *cipher)</td></tr>
|
|
<tr class="memdesc:a9161530f456efacb64f5008fdb1a460c inherit pro_methods_classCFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Sets the block cipher to use for this <a class="el" href="classCFB.html" title="Implementation of the Cipher Feedback (CFB) mode for 128-bit block ciphers. ">CFB</a> object. <a href="#a9161530f456efacb64f5008fdb1a460c">More...</a><br/></td></tr>
|
|
<tr class="separator:a9161530f456efacb64f5008fdb1a460c inherit pro_methods_classCFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename T><br/>
|
|
class CFB< T ></h3>
|
|
|
|
<p>Implementation of the <a class="el" href="classCipher.html" title="Abstract base class for stream ciphers. ">Cipher</a> Feedback (<a class="el" href="classCFB.html" title="Implementation of the Cipher Feedback (CFB) mode for 128-bit block ciphers. ">CFB</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). The size of the <a class="el" href="classCFB.html" title="Implementation of the Cipher Feedback (CFB) mode for 128-bit block ciphers. ">CFB</a> shift register is the same as the block size.</p>
|
|
<p>For example, the following creates a <a class="el" href="classCFB.html" title="Implementation of the Cipher Feedback (CFB) mode for 128-bit block ciphers. ">CFB</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="classCFB.html">CFB<AES192></a> cfb;</div>
|
|
<div class="line">cfb.<a class="code" href="classCFBCommon.html#a45b9be25fb96f0e3ca5211b064e2baea">setKey</a>(key, 24);</div>
|
|
<div class="line">cfb.<a class="code" href="classCFBCommon.html#a597040eb7df40adbbef94b4c3975cd80">setIV</a>(iv, 16);</div>
|
|
<div class="line">cfb.<a class="code" href="classCFBCommon.html#a57af3692389bed300d3cfdf351351c51">encrypt</a>(output, input, len);</div>
|
|
</div><!-- fragment --><p>Decryption is similar:</p>
|
|
<div class="fragment"><div class="line"><a class="code" href="classCFB.html">CFB<AES192></a> cfb;</div>
|
|
<div class="line">cfb.<a class="code" href="classCFBCommon.html#a45b9be25fb96f0e3ca5211b064e2baea">setKey</a>(key, 24);</div>
|
|
<div class="line">cfb.<a class="code" href="classCFBCommon.html#a597040eb7df40adbbef94b4c3975cd80">setIV</a>(iv, 16);</div>
|
|
<div class="line">cfb.<a class="code" href="classCFBCommon.html#aaaa3d61c5743e30e355207c193c0b0ef">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.</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="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</a>, <a class="el" href="classCBC.html" title="Implementation of the Cipher Block Chaining (CBC) mode for 128-bit block ciphers. ...">CBC</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="CFB_8h_source.html#l00056">56</a> of file <a class="el" href="CFB_8h_source.html">CFB.h</a>.</p>
|
|
</div><hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="CFB_8h_source.html">CFB.h</a></li>
|
|
<li><a class="el" href="CFB_8cpp_source.html">CFB.cpp</a></li>
|
|
</ul>
|
|
</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|