<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: CFB_CipherTemplate< BASE > 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="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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_c_f_b___cipher_template-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CFB_CipherTemplate< BASE > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for feedback based stream ciphers with <a class="el" href="class_symmetric_cipher.html" title="Interface for one direction (encryption or decryption) of a stream cipher or cipher mode.">SymmetricCipher</a> interface.
<a href="class_c_f_b___cipher_template.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for CFB_CipherTemplate< BASE >:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="class_c_f_b___cipher_template.png" usemap="#CFB_5FCipherTemplate_3C_20BASE_20_3E_map" alt=""/>
<map id="CFB_5FCipherTemplate_3C_20BASE_20_3E_map" name="CFB_5FCipherTemplate_3C_20BASE_20_3E_map">
<area href="class_c_f_b___decryption_template.html" title="Base class for feedback based stream ciphers in the reverse direction with SymmetricCipher interface." alt="CFB_DecryptionTemplate< BASE >" shape="rect" coords="0,112,213,136"/>
<area href="class_c_f_b___encryption_template.html" title="Base class for feedback based stream ciphers in the forward direction with SymmetricCipher interface." alt="CFB_EncryptionTemplate< BASE >" shape="rect" coords="223,112,436,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9e72e3524dd351fd0e87382fe84cd306"><td class="memItemLeft" align="right" valign="top"><a id="a9e72e3524dd351fd0e87382fe84cd306"></a>
typedef BASE::PolicyInterface </td><td class="memItemRight" valign="bottom"><b>PolicyInterface</b></td></tr>
<tr class="separator:a9e72e3524dd351fd0e87382fe84cd306"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:adf14a759fd95fd687f4e257264771f89"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_template.html#adf14a759fd95fd687f4e257264771f89">ProcessData</a> (byte *outString, const byte *inString, size_t length)</td></tr>
<tr class="memdesc:adf14a759fd95fd687f4e257264771f89"><td class="mdescLeft"> </td><td class="mdescRight">Apply keystream to data. <a href="#adf14a759fd95fd687f4e257264771f89">More...</a><br /></td></tr>
<tr class="separator:adf14a759fd95fd687f4e257264771f89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8604f13ab0f11d510c8e1f28526333a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_template.html#a8604f13ab0f11d510c8e1f28526333a0">Resynchronize</a> (const byte *iv, int length=-1)</td></tr>
<tr class="memdesc:a8604f13ab0f11d510c8e1f28526333a0"><td class="mdescLeft"> </td><td class="mdescRight">Resynchronize the cipher. <a href="#a8604f13ab0f11d510c8e1f28526333a0">More...</a><br /></td></tr>
<tr class="separator:a8604f13ab0f11d510c8e1f28526333a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3055f5f53d6770aacfb4c042f75e5dab"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_template.html#a3055f5f53d6770aacfb4c042f75e5dab">OptimalBlockSize</a> () const</td></tr>
<tr class="memdesc:a3055f5f53d6770aacfb4c042f75e5dab"><td class="mdescLeft"> </td><td class="mdescRight">Provides number of ideal bytes to process. <a href="#a3055f5f53d6770aacfb4c042f75e5dab">More...</a><br /></td></tr>
<tr class="separator:a3055f5f53d6770aacfb4c042f75e5dab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adae738b3fbef96cb5ed6c0f37f6e9621"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_template.html#adae738b3fbef96cb5ed6c0f37f6e9621">GetOptimalNextBlockSize</a> () const</td></tr>
<tr class="memdesc:adae738b3fbef96cb5ed6c0f37f6e9621"><td class="mdescLeft"> </td><td class="mdescRight">Provides number of ideal bytes to process. <a href="#adae738b3fbef96cb5ed6c0f37f6e9621">More...</a><br /></td></tr>
<tr class="separator:adae738b3fbef96cb5ed6c0f37f6e9621"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3efd5acd93a2e3601d80bbbf9beaaf1d"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_template.html#a3efd5acd93a2e3601d80bbbf9beaaf1d">OptimalDataAlignment</a> () const</td></tr>
<tr class="memdesc:a3efd5acd93a2e3601d80bbbf9beaaf1d"><td class="mdescLeft"> </td><td class="mdescRight">Provides number of ideal data alignment. <a href="#a3efd5acd93a2e3601d80bbbf9beaaf1d">More...</a><br /></td></tr>
<tr class="separator:a3efd5acd93a2e3601d80bbbf9beaaf1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71489329f90306fbf7916335b9bc0ca9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_template.html#a71489329f90306fbf7916335b9bc0ca9">IsRandomAccess</a> () const</td></tr>
<tr class="memdesc:a71489329f90306fbf7916335b9bc0ca9"><td class="mdescLeft"> </td><td class="mdescRight">Flag indicating random access. <a href="#a71489329f90306fbf7916335b9bc0ca9">More...</a><br /></td></tr>
<tr class="separator:a71489329f90306fbf7916335b9bc0ca9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add3c4fa05f62c3e601faa4a469ee108d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_template.html#add3c4fa05f62c3e601faa4a469ee108d">IsSelfInverting</a> () const</td></tr>
<tr class="memdesc:add3c4fa05f62c3e601faa4a469ee108d"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the cipher is self inverting. <a href="#add3c4fa05f62c3e601faa4a469ee108d">More...</a><br /></td></tr>
<tr class="separator:add3c4fa05f62c3e601faa4a469ee108d"><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<class BASE><br />
class CFB_CipherTemplate< BASE ></h3>
<p>Base class for feedback based stream ciphers with <a class="el" href="class_symmetric_cipher.html" title="Interface for one direction (encryption or decryption) of a stream cipher or cipher mode.">SymmetricCipher</a> interface. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">BASE</td><td><a class="el" href="class_abstract_policy_holder.html" title="Access a stream cipher policy object.">AbstractPolicyHolder</a> base class </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00480">480</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="adf14a759fd95fd687f4e257264771f89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf14a759fd95fd687f4e257264771f89">◆ </a></span>ProcessData()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_c_f_b___cipher_template.html">CFB_CipherTemplate</a>< BASE >::ProcessData </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>outString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>inString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Apply keystream to data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outString</td><td>a buffer to write the transformed data </td></tr>
<tr><td class="paramname">inString</td><td>a buffer to read the data </td></tr>
<tr><td class="paramname">length</td><td>the size fo the buffers, in bytes</td></tr>
</table>
</dd>
</dl>
<p>This is the primary method to operate a stream cipher. For example: </p><pre>
size_t size = 30;
byte plain[size] = "Do or do not; there is no try";
byte cipher[size];
...
<a class="el" href="struct_cha_cha20.html" title="ChaCha20 stream cipher.">ChaCha20</a> chacha(key, keySize);
chacha.ProcessData(cipher, plain, size);
</pre>
<p class="definition">Definition at line <a class="el" href="strciphr_8cpp_source.html#l00177">177</a> of file <a class="el" href="strciphr_8cpp_source.html">strciphr.cpp</a>.</p>
</div>
</div>
<a id="a8604f13ab0f11d510c8e1f28526333a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8604f13ab0f11d510c8e1f28526333a0">◆ </a></span>Resynchronize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_c_f_b___cipher_template.html">CFB_CipherTemplate</a>< BASE >::Resynchronize </td>
<td>(</td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>iv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>length</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resynchronize the cipher. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">iv</td><td>a byte array used to resynchronize the cipher </td></tr>
<tr><td class="paramname">length</td><td>the size of the IV array </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8cpp_source.html#l00169">169</a> of file <a class="el" href="strciphr_8cpp_source.html">strciphr.cpp</a>.</p>
</div>
</div>
<a id="a3055f5f53d6770aacfb4c042f75e5dab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3055f5f53d6770aacfb4c042f75e5dab">◆ </a></span>OptimalBlockSize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="class_c_f_b___cipher_template.html">CFB_CipherTemplate</a>< BASE >::OptimalBlockSize </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides number of ideal bytes to process. </p>
<dl class="section return"><dt>Returns</dt><dd>the ideal number of bytes to process</dd></dl>
<p>Internally, the default implementation returns GetBytesPerIteration() </p><dl class="section see"><dt>See also</dt><dd>GetBytesPerIteration() and <a class="el" href="class_c_f_b___cipher_template.html#adae738b3fbef96cb5ed6c0f37f6e9621" title="Provides number of ideal bytes to process.">GetOptimalNextBlockSize()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00507">507</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="adae738b3fbef96cb5ed6c0f37f6e9621"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adae738b3fbef96cb5ed6c0f37f6e9621">◆ </a></span>GetOptimalNextBlockSize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="class_c_f_b___cipher_template.html">CFB_CipherTemplate</a>< BASE >::GetOptimalNextBlockSize </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides number of ideal bytes to process. </p>
<dl class="section return"><dt>Returns</dt><dd>the ideal number of bytes to process</dd></dl>
<p>Internally, the default implementation returns remaining unprocessed bytes </p><dl class="section see"><dt>See also</dt><dd>GetBytesPerIteration() and <a class="el" href="class_c_f_b___cipher_template.html#a3055f5f53d6770aacfb4c042f75e5dab" title="Provides number of ideal bytes to process.">OptimalBlockSize()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00513">513</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="a3efd5acd93a2e3601d80bbbf9beaaf1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3efd5acd93a2e3601d80bbbf9beaaf1d">◆ </a></span>OptimalDataAlignment()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="class_c_f_b___cipher_template.html">CFB_CipherTemplate</a>< BASE >::OptimalDataAlignment </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides number of ideal data alignment. </p>
<dl class="section return"><dt>Returns</dt><dd>the ideal data alignment, in bytes </dd></dl>
<dl class="section see"><dt>See also</dt><dd>GetAlignment() and <a class="el" href="class_c_f_b___cipher_template.html#a3055f5f53d6770aacfb4c042f75e5dab" title="Provides number of ideal bytes to process.">OptimalBlockSize()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00518">518</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="a71489329f90306fbf7916335b9bc0ca9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71489329f90306fbf7916335b9bc0ca9">◆ </a></span>IsRandomAccess()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_c_f_b___cipher_template.html">CFB_CipherTemplate</a>< BASE >::IsRandomAccess </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag indicating random access. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the cipher is seekable, false otherwise </dd></dl>
<dl class="section see"><dt>See also</dt><dd>Seek() </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00523">523</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="add3c4fa05f62c3e601faa4a469ee108d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add3c4fa05f62c3e601faa4a469ee108d">◆ </a></span>IsSelfInverting()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_c_f_b___cipher_template.html">CFB_CipherTemplate</a>< BASE >::IsSelfInverting </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the cipher is self inverting. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the stream cipher is self inverting, false otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00527">527</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="strciphr_8h_source.html">strciphr.h</a></li>
<li><a class="el" href="strciphr_8cpp_source.html">strciphr.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 27 2019 15:04:01 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
17f48c047155a7d4c992d6a672acd57f
>
files
>
484
