mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
190 lines
20 KiB
HTML
190 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: OFB< 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">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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><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="classOFB-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">OFB< T > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Implementation of the Output Feedback (<a class="el" href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</a>) mode for 128-bit block ciphers.
|
|
<a href="classOFB.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="OFB_8h_source.html">OFB.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for OFB< T >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classOFB.png" usemap="#OFB< T >_map" alt=""/>
|
|
<map id="OFB< T >_map" name="OFB< T >_map">
|
|
<area href="classOFBCommon.html" title="Concrete base class to assist with implementing OFB for 128-bit block ciphers. " alt="OFBCommon" 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:a0b71b5cbcf01254799cd5eb37074a8cb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b71b5cbcf01254799cd5eb37074a8cb"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFB.html#a0b71b5cbcf01254799cd5eb37074a8cb">OFB</a> ()</td></tr>
|
|
<tr class="memdesc:a0b71b5cbcf01254799cd5eb37074a8cb"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</a> object for the block cipher T. <br/></td></tr>
|
|
<tr class="separator:a0b71b5cbcf01254799cd5eb37074a8cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classOFBCommon"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classOFBCommon')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classOFBCommon.html">OFBCommon</a></td></tr>
|
|
<tr class="memitem:aae7435157e51bf977d3481e94e17ae01 inherit pub_methods_classOFBCommon"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae7435157e51bf977d3481e94e17ae01"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFBCommon.html#aae7435157e51bf977d3481e94e17ae01">~OFBCommon</a> ()</td></tr>
|
|
<tr class="memdesc:aae7435157e51bf977d3481e94e17ae01 inherit pub_methods_classOFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this cipher object after clearing sensitive information. <br/></td></tr>
|
|
<tr class="separator:aae7435157e51bf977d3481e94e17ae01 inherit pub_methods_classOFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76ea9f9ea9dd137778338813e534a8ce inherit pub_methods_classOFBCommon"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFBCommon.html#a76ea9f9ea9dd137778338813e534a8ce">keySize</a> () const </td></tr>
|
|
<tr class="memdesc:a76ea9f9ea9dd137778338813e534a8ce inherit pub_methods_classOFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Default size of the key for this cipher, in bytes. <a href="#a76ea9f9ea9dd137778338813e534a8ce">More...</a><br/></td></tr>
|
|
<tr class="separator:a76ea9f9ea9dd137778338813e534a8ce inherit pub_methods_classOFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67b4639aaece17a796fcba3a2ce8b43c inherit pub_methods_classOFBCommon"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFBCommon.html#a67b4639aaece17a796fcba3a2ce8b43c">ivSize</a> () const </td></tr>
|
|
<tr class="memdesc:a67b4639aaece17a796fcba3a2ce8b43c inherit pub_methods_classOFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Size of the initialization vector for this cipher, in bytes. <a href="#a67b4639aaece17a796fcba3a2ce8b43c">More...</a><br/></td></tr>
|
|
<tr class="separator:a67b4639aaece17a796fcba3a2ce8b43c inherit pub_methods_classOFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3a98e81d95ebc6c883baef5f4cfbefb inherit pub_methods_classOFBCommon"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFBCommon.html#ac3a98e81d95ebc6c883baef5f4cfbefb">setKey</a> (const uint8_t *key, size_t len)</td></tr>
|
|
<tr class="memdesc:ac3a98e81d95ebc6c883baef5f4cfbefb inherit pub_methods_classOFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Sets the key to use for future encryption and decryption operations. <a href="#ac3a98e81d95ebc6c883baef5f4cfbefb">More...</a><br/></td></tr>
|
|
<tr class="separator:ac3a98e81d95ebc6c883baef5f4cfbefb inherit pub_methods_classOFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a35364cf30d78f1968cc00803686caf inherit pub_methods_classOFBCommon"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFBCommon.html#a4a35364cf30d78f1968cc00803686caf">setIV</a> (const uint8_t *iv, size_t len)</td></tr>
|
|
<tr class="memdesc:a4a35364cf30d78f1968cc00803686caf inherit pub_methods_classOFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Sets the initialization vector to use for future encryption and decryption operations. <a href="#a4a35364cf30d78f1968cc00803686caf">More...</a><br/></td></tr>
|
|
<tr class="separator:a4a35364cf30d78f1968cc00803686caf inherit pub_methods_classOFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a984d81a460e0799895b19dc48c3b5cf8 inherit pub_methods_classOFBCommon"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFBCommon.html#a984d81a460e0799895b19dc48c3b5cf8">encrypt</a> (uint8_t *output, const uint8_t *input, size_t len)</td></tr>
|
|
<tr class="memdesc:a984d81a460e0799895b19dc48c3b5cf8 inherit pub_methods_classOFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Encrypts an input buffer and writes the ciphertext to an output buffer. <a href="#a984d81a460e0799895b19dc48c3b5cf8">More...</a><br/></td></tr>
|
|
<tr class="separator:a984d81a460e0799895b19dc48c3b5cf8 inherit pub_methods_classOFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb3636d7175b150e2bf16367e51c2e36 inherit pub_methods_classOFBCommon"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFBCommon.html#aeb3636d7175b150e2bf16367e51c2e36">decrypt</a> (uint8_t *output, const uint8_t *input, size_t len)</td></tr>
|
|
<tr class="memdesc:aeb3636d7175b150e2bf16367e51c2e36 inherit pub_methods_classOFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Decrypts an input buffer and writes the plaintext to an output buffer. <a href="#aeb3636d7175b150e2bf16367e51c2e36">More...</a><br/></td></tr>
|
|
<tr class="separator:aeb3636d7175b150e2bf16367e51c2e36 inherit pub_methods_classOFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55bf2396beb91c457bfc4c20ef5c8123 inherit pub_methods_classOFBCommon"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFBCommon.html#a55bf2396beb91c457bfc4c20ef5c8123">clear</a> ()</td></tr>
|
|
<tr class="memdesc:a55bf2396beb91c457bfc4c20ef5c8123 inherit pub_methods_classOFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Clears all security-sensitive state from this cipher. <a href="#a55bf2396beb91c457bfc4c20ef5c8123">More...</a><br/></td></tr>
|
|
<tr class="separator:a55bf2396beb91c457bfc4c20ef5c8123 inherit pub_methods_classOFBCommon"><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_classOFBCommon"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classOFBCommon')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classOFBCommon.html">OFBCommon</a></td></tr>
|
|
<tr class="memitem:a7f7e0cffcd7e2d7e06b7b1ae978a8f7d inherit pro_methods_classOFBCommon"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFBCommon.html#a7f7e0cffcd7e2d7e06b7b1ae978a8f7d">OFBCommon</a> ()</td></tr>
|
|
<tr class="memdesc:a7f7e0cffcd7e2d7e06b7b1ae978a8f7d inherit pro_methods_classOFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new cipher in <a class="el" href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</a> mode. <a href="#a7f7e0cffcd7e2d7e06b7b1ae978a8f7d">More...</a><br/></td></tr>
|
|
<tr class="separator:a7f7e0cffcd7e2d7e06b7b1ae978a8f7d inherit pro_methods_classOFBCommon"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0053e2566a88859effffacbf1e4ade04 inherit pro_methods_classOFBCommon"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOFBCommon.html#a0053e2566a88859effffacbf1e4ade04">setBlockCipher</a> (<a class="el" href="classBlockCipher.html">BlockCipher</a> *cipher)</td></tr>
|
|
<tr class="memdesc:a0053e2566a88859effffacbf1e4ade04 inherit pro_methods_classOFBCommon"><td class="mdescLeft"> </td><td class="mdescRight">Sets the block cipher to use for this <a class="el" href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</a> object. <a href="#a0053e2566a88859effffacbf1e4ade04">More...</a><br/></td></tr>
|
|
<tr class="separator:a0053e2566a88859effffacbf1e4ade04 inherit pro_methods_classOFBCommon"><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 OFB< T ></h3>
|
|
|
|
<p>Implementation of the Output Feedback (<a class="el" href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</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="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</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="classOFB.html">OFB<AES192></a> ofb;</div>
|
|
<div class="line">ofb.<a class="code" href="classOFBCommon.html#ac3a98e81d95ebc6c883baef5f4cfbefb">setKey</a>(key, 24);</div>
|
|
<div class="line">ofb.<a class="code" href="classOFBCommon.html#a4a35364cf30d78f1968cc00803686caf">setIV</a>(iv, 16);</div>
|
|
<div class="line">ofb.<a class="code" href="classOFBCommon.html#a984d81a460e0799895b19dc48c3b5cf8">encrypt</a>(output, input, len);</div>
|
|
</div><!-- fragment --><p>Decryption is identical to encryption for <a class="el" href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</a> mode.</p>
|
|
<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="classCFB.html" title="Implementation of the Cipher Feedback (CFB) mode for 128-bit block ciphers. ">CFB</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="OFB_8h_source.html#l00056">56</a> of file <a class="el" href="OFB_8h_source.html">OFB.h</a>.</p>
|
|
</div><hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="OFB_8h_source.html">OFB.h</a></li>
|
|
<li><a class="el" href="OFB_8cpp_source.html">OFB.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Apr 18 2015 08:44:49 for ArduinoLibs 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>
|