mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
542 lines
32 KiB
HTML
542 lines
32 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: OFBCommon Class 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="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classOFBCommon-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">OFBCommon Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Concrete base class to assist with implementing <a class="el" href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</a> for 128-bit block ciphers.
|
|
<a href="classOFBCommon.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 OFBCommon:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classOFBCommon.png" usemap="#OFBCommon_map" alt=""/>
|
|
<map id="OFBCommon_map" name="OFBCommon_map">
|
|
<area href="classCipher.html" title="Abstract base class for stream ciphers. " alt="Cipher" shape="rect" coords="0,0,86,24"/>
|
|
<area href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. " alt="OFB< T >" shape="rect" coords="0,112,86,136"/>
|
|
</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:aae7435157e51bf977d3481e94e17ae01"><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"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this cipher object after clearing sensitive information. <br/></td></tr>
|
|
<tr class="separator:aae7435157e51bf977d3481e94e17ae01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76ea9f9ea9dd137778338813e534a8ce"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67b4639aaece17a796fcba3a2ce8b43c"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3a98e81d95ebc6c883baef5f4cfbefb"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a35364cf30d78f1968cc00803686caf"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a984d81a460e0799895b19dc48c3b5cf8"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb3636d7175b150e2bf16367e51c2e36"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55bf2396beb91c457bfc4c20ef5c8123"><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"><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"><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="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7f7e0cffcd7e2d7e06b7b1ae978a8f7d"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0053e2566a88859effffacbf1e4ade04"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Concrete base class to assist with implementing <a class="el" href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</a> for 128-bit block ciphers. </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="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="OFB_8h_source.html#l00029">29</a> of file <a class="el" href="OFB_8h_source.html">OFB.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a7f7e0cffcd7e2d7e06b7b1ae978a8f7d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">OFBCommon::OFBCommon </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<p>This constructor should be followed by a call to <a class="el" href="classOFBCommon.html#a0053e2566a88859effffacbf1e4ade04" title="Sets the block cipher to use for this OFB object. ">setBlockCipher()</a>. </p>
|
|
|
|
<p>Definition at line <a class="el" href="OFB_8cpp_source.html#l00042">42</a> of file <a class="el" href="OFB_8cpp_source.html">OFB.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a55bf2396beb91c457bfc4c20ef5c8123"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OFBCommon::clear </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears all security-sensitive state from this cipher. </p>
|
|
<p>Security-sensitive information includes key schedules, initialization vectors, and any temporary state that is used by <a class="el" href="classOFBCommon.html#a984d81a460e0799895b19dc48c3b5cf8" title="Encrypts an input buffer and writes the ciphertext to an output buffer. ">encrypt()</a> or <a class="el" href="classOFBCommon.html#aeb3636d7175b150e2bf16367e51c2e36" title="Decrypts an input buffer and writes the plaintext to an output buffer. ">decrypt()</a> which is stored in the cipher itself. </p>
|
|
|
|
<p>Implements <a class="el" href="classCipher.html#a4b7c3965646441a70d9ab934a7c92ab1">Cipher</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="OFB_8cpp_source.html#l00113">113</a> of file <a class="el" href="OFB_8cpp_source.html">OFB.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aeb3636d7175b150e2bf16367e51c2e36"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OFBCommon::decrypt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>output</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>input</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Decrypts an input buffer and writes the plaintext to an output buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">output</td><td>The output buffer to write to, which may be the same buffer as <em>input</em>. The <em>output</em> buffer must have at least as many bytes as the <em>input</em> buffer. </td></tr>
|
|
<tr><td class="paramname">input</td><td>The input buffer to read from. </td></tr>
|
|
<tr><td class="paramname">len</td><td>The number of bytes to decrypt.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The <a class="el" href="classOFBCommon.html#aeb3636d7175b150e2bf16367e51c2e36" title="Decrypts an input buffer and writes the plaintext to an output buffer. ">decrypt()</a> function can be called multiple times with different regions of the ciphertext data.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classOFBCommon.html#a984d81a460e0799895b19dc48c3b5cf8" title="Encrypts an input buffer and writes the ciphertext to an output buffer. ">encrypt()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classCipher.html#ac6099d1a0d7f2ff67b0e4ccb4a17eb08">Cipher</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="OFB_8cpp_source.html#l00108">108</a> of file <a class="el" href="OFB_8cpp_source.html">OFB.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a984d81a460e0799895b19dc48c3b5cf8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OFBCommon::encrypt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>output</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>input</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encrypts an input buffer and writes the ciphertext to an output buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">output</td><td>The output buffer to write to, which may be the same buffer as <em>input</em>. The <em>output</em> buffer must have at least as many bytes as the <em>input</em> buffer. </td></tr>
|
|
<tr><td class="paramname">input</td><td>The input buffer to read from. </td></tr>
|
|
<tr><td class="paramname">len</td><td>The number of bytes to encrypt.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The <a class="el" href="classOFBCommon.html#a984d81a460e0799895b19dc48c3b5cf8" title="Encrypts an input buffer and writes the ciphertext to an output buffer. ">encrypt()</a> function can be called multiple times with different regions of the plaintext data.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classOFBCommon.html#aeb3636d7175b150e2bf16367e51c2e36" title="Decrypts an input buffer and writes the plaintext to an output buffer. ">decrypt()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classCipher.html#ad2832bd61039d61560e34ea3382ca562">Cipher</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="OFB_8cpp_source.html#l00085">85</a> of file <a class="el" href="OFB_8cpp_source.html">OFB.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a67b4639aaece17a796fcba3a2ce8b43c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t OFBCommon::ivSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Size of the initialization vector for this cipher, in bytes. </p>
|
|
<p>If the cipher does not need an initialization vector, this function will return zero. </p>
|
|
|
|
<p>Implements <a class="el" href="classCipher.html#ab8b53ddc4ce431f03c2a1903d70ace9c">Cipher</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="OFB_8cpp_source.html#l00061">61</a> of file <a class="el" href="OFB_8cpp_source.html">OFB.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a76ea9f9ea9dd137778338813e534a8ce"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t OFBCommon::keySize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default size of the key for this cipher, in bytes. </p>
|
|
<p>If the cipher supports variable-sized keys, <a class="el" href="classOFBCommon.html#a76ea9f9ea9dd137778338813e534a8ce" title="Default size of the key for this cipher, in bytes. ">keySize()</a> indicates the default or recommended key size. The cipher may support other key sizes.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classOFBCommon.html#ac3a98e81d95ebc6c883baef5f4cfbefb" title="Sets the key to use for future encryption and decryption operations. ">setKey()</a>, <a class="el" href="classOFBCommon.html#a67b4639aaece17a796fcba3a2ce8b43c" title="Size of the initialization vector for this cipher, in bytes. ">ivSize()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classCipher.html#a4cea432ea0278c865441f17cbb88b1ab">Cipher</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="OFB_8cpp_source.html#l00056">56</a> of file <a class="el" href="OFB_8cpp_source.html">OFB.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0053e2566a88859effffacbf1e4ade04"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OFBCommon::setBlockCipher </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classBlockCipher.html">BlockCipher</a> * </td>
|
|
<td class="paramname"><em>cipher</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cipher</td><td>The block cipher to use to implement <a class="el" href="classOFB.html" title="Implementation of the Output Feedback (OFB) mode for 128-bit block ciphers. ">OFB</a> mode, which must have a block size of 16 bytes (128 bits). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="OFB_8h_source.html#l00047">47</a> of file <a class="el" href="OFB_8h_source.html">OFB.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4a35364cf30d78f1968cc00803686caf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool OFBCommon::setIV </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>iv</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the initialization vector to use for future encryption and decryption operations. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">iv</td><td>The initialization vector to use. </td></tr>
|
|
<tr><td class="paramname">len</td><td>The length of the initialization vector in bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns false if the length is not supported.</dd></dl>
|
|
<p>Initialization vectors should be set before the first call to <a class="el" href="classOFBCommon.html#a984d81a460e0799895b19dc48c3b5cf8" title="Encrypts an input buffer and writes the ciphertext to an output buffer. ">encrypt()</a> or <a class="el" href="classOFBCommon.html#aeb3636d7175b150e2bf16367e51c2e36" title="Decrypts an input buffer and writes the plaintext to an output buffer. ">decrypt()</a> after a <a class="el" href="classOFBCommon.html#ac3a98e81d95ebc6c883baef5f4cfbefb" title="Sets the key to use for future encryption and decryption operations. ">setKey()</a> call. If the initialization vector is changed after encryption or decryption begins, then the behaviour is undefined.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The IV is not encoded into the output stream by <a class="el" href="classOFBCommon.html#a984d81a460e0799895b19dc48c3b5cf8" title="Encrypts an input buffer and writes the ciphertext to an output buffer. ">encrypt()</a>. The caller is responsible for communicating the IV to the other party.</dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classOFBCommon.html#a67b4639aaece17a796fcba3a2ce8b43c" title="Size of the initialization vector for this cipher, in bytes. ">ivSize()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classCipher.html#a3777acd8ff776a4e945bb7c9f2d044d9">Cipher</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="OFB_8cpp_source.html#l00076">76</a> of file <a class="el" href="OFB_8cpp_source.html">OFB.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac3a98e81d95ebc6c883baef5f4cfbefb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool OFBCommon::setKey </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the key to use for future encryption and decryption operations. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>The key to use. </td></tr>
|
|
<tr><td class="paramname">len</td><td>The length of the key in bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns false if the key length is not supported, or the key is somehow "weak" and unusable by this cipher.</dd></dl>
|
|
<p>Use <a class="el" href="classOFBCommon.html#a55bf2396beb91c457bfc4c20ef5c8123" title="Clears all security-sensitive state from this cipher. ">clear()</a> or the destructor to remove the key and any other sensitive data from the object once encryption or decryption is complete.</p>
|
|
<p>Calling <a class="el" href="classOFBCommon.html#ac3a98e81d95ebc6c883baef5f4cfbefb" title="Sets the key to use for future encryption and decryption operations. ">setKey()</a> resets the cipher. Any temporary data that was being retained for encrypting partial blocks will be abandoned.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classOFBCommon.html#a76ea9f9ea9dd137778338813e534a8ce" title="Default size of the key for this cipher, in bytes. ">keySize()</a>, <a class="el" href="classOFBCommon.html#a55bf2396beb91c457bfc4c20ef5c8123" title="Clears all security-sensitive state from this cipher. ">clear()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classCipher.html#a0dfe133bda81dfa680b668f5908ccbe5">Cipher</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="OFB_8cpp_source.html#l00066">66</a> of file <a class="el" href="OFB_8cpp_source.html">OFB.cpp</a>.</p>
|
|
|
|
</div>
|
|
</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 Fri Apr 27 2018 12:01:32 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>
|