<!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_CipherAbstractPolicy 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="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-methods">Public Member Functions</a> |
<a href="class_c_f_b___cipher_abstract_policy-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CFB_CipherAbstractPolicy Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Policy object for feeback based stream ciphers.
<a href="class_c_f_b___cipher_abstract_policy.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_CipherAbstractPolicy:</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_abstract_policy.png" usemap="#CFB_5FCipherAbstractPolicy_map" alt=""/>
<map id="CFB_5FCipherAbstractPolicy_map" name="CFB_5FCipherAbstractPolicy_map">
<area href="class_mode_policy_common_template.html" alt="ModePolicyCommonTemplate< CFB_CipherAbstractPolicy >" shape="rect" coords="0,56,353,80"/>
<area href="class_c_f_b___mode_policy.html" title="CFB block cipher mode of operation." alt="CFB_ModePolicy" shape="rect" coords="0,112,353,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:a0566346c2cf2d817567d761cbe535210"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_abstract_policy.html#a0566346c2cf2d817567d761cbe535210">GetAlignment</a> () const =0</td></tr>
<tr class="memdesc:a0566346c2cf2d817567d761cbe535210"><td class="mdescLeft"> </td><td class="mdescRight">Provides data alignment requirements. <a href="#a0566346c2cf2d817567d761cbe535210">More...</a><br /></td></tr>
<tr class="separator:a0566346c2cf2d817567d761cbe535210"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17d9940b9130e754375794f65ab96496"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_abstract_policy.html#a17d9940b9130e754375794f65ab96496">GetBytesPerIteration</a> () const =0</td></tr>
<tr class="memdesc:a17d9940b9130e754375794f65ab96496"><td class="mdescLeft"> </td><td class="mdescRight">Provides number of bytes operated upon during an iteration. <a href="#a17d9940b9130e754375794f65ab96496">More...</a><br /></td></tr>
<tr class="separator:a17d9940b9130e754375794f65ab96496"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ed5f67aa6ad1c5625e723ba968bc37b"><td class="memItemLeft" align="right" valign="top">virtual byte * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_abstract_policy.html#a6ed5f67aa6ad1c5625e723ba968bc37b">GetRegisterBegin</a> ()=0</td></tr>
<tr class="memdesc:a6ed5f67aa6ad1c5625e723ba968bc37b"><td class="mdescLeft"> </td><td class="mdescRight">Access the feedback register. <a href="#a6ed5f67aa6ad1c5625e723ba968bc37b">More...</a><br /></td></tr>
<tr class="separator:a6ed5f67aa6ad1c5625e723ba968bc37b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d7f8686375df73407e81066c0b59997"><td class="memItemLeft" align="right" valign="top"><a id="a3d7f8686375df73407e81066c0b59997"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_abstract_policy.html#a3d7f8686375df73407e81066c0b59997">TransformRegister</a> ()=0</td></tr>
<tr class="memdesc:a3d7f8686375df73407e81066c0b59997"><td class="mdescLeft"> </td><td class="mdescRight">TODO. <br /></td></tr>
<tr class="separator:a3d7f8686375df73407e81066c0b59997"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3cf5f1f95bc71115bc9cddf91821886"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_abstract_policy.html#ad3cf5f1f95bc71115bc9cddf91821886">CanIterate</a> () const</td></tr>
<tr class="memdesc:ad3cf5f1f95bc71115bc9cddf91821886"><td class="mdescLeft"> </td><td class="mdescRight">Flag indicating iteration support. <a href="#ad3cf5f1f95bc71115bc9cddf91821886">More...</a><br /></td></tr>
<tr class="separator:ad3cf5f1f95bc71115bc9cddf91821886"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a021f82d6099659217e92aabb222200d4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_abstract_policy.html#a021f82d6099659217e92aabb222200d4">Iterate</a> (byte *output, const byte *input, <a class="el" href="cryptlib_8h.html#a353ccabf5ddc119a6a33e92f7b9961c7">CipherDir</a> dir, size_t iterationCount)</td></tr>
<tr class="memdesc:a021f82d6099659217e92aabb222200d4"><td class="mdescLeft"> </td><td class="mdescRight">Iterate the cipher. <a href="#a021f82d6099659217e92aabb222200d4">More...</a><br /></td></tr>
<tr class="separator:a021f82d6099659217e92aabb222200d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52637fe1fa1cbde44246ec8fda3debc4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_abstract_policy.html#a52637fe1fa1cbde44246ec8fda3debc4">CipherSetKey</a> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &params, const byte *key, size_t length)=0</td></tr>
<tr class="memdesc:a52637fe1fa1cbde44246ec8fda3debc4"><td class="mdescLeft"> </td><td class="mdescRight">Key the cipher. <a href="#a52637fe1fa1cbde44246ec8fda3debc4">More...</a><br /></td></tr>
<tr class="separator:a52637fe1fa1cbde44246ec8fda3debc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace6ce335fb2722f5b0412064058bb2c0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_f_b___cipher_abstract_policy.html#ace6ce335fb2722f5b0412064058bb2c0">CipherResynchronize</a> (const byte *iv, size_t length)</td></tr>
<tr class="memdesc:ace6ce335fb2722f5b0412064058bb2c0"><td class="mdescLeft"> </td><td class="mdescRight">Resynchronize the cipher. <a href="#ace6ce335fb2722f5b0412064058bb2c0">More...</a><br /></td></tr>
<tr class="separator:ace6ce335fb2722f5b0412064058bb2c0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Policy object for feeback based stream ciphers. </p>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00343">343</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="a0566346c2cf2d817567d761cbe535210"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0566346c2cf2d817567d761cbe535210">◆ </a></span>GetAlignment()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int CFB_CipherAbstractPolicy::GetAlignment </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides data alignment requirements. </p>
<dl class="section return"><dt>Returns</dt><dd>data alignment requirements, in bytes</dd></dl>
<p>Internally, the default implementation returns 1. If the stream cipher is implemented using an SSE2 ASM or intrinsics, then the value returned is usually 16. </p>
</div>
</div>
<a id="a17d9940b9130e754375794f65ab96496"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17d9940b9130e754375794f65ab96496">◆ </a></span>GetBytesPerIteration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int CFB_CipherAbstractPolicy::GetBytesPerIteration </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides number of bytes operated upon during an iteration. </p>
<dl class="section return"><dt>Returns</dt><dd>bytes operated upon during an iteration, in bytes </dd></dl>
<dl class="section see"><dt>See also</dt><dd>GetOptimalBlockSize() </dd></dl>
</div>
</div>
<a id="a6ed5f67aa6ad1c5625e723ba968bc37b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ed5f67aa6ad1c5625e723ba968bc37b">◆ </a></span>GetRegisterBegin()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual byte* CFB_CipherAbstractPolicy::GetRegisterBegin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the feedback register. </p>
<dl class="section return"><dt>Returns</dt><dd>pointer to the first byte of the feedback register </dd></dl>
</div>
</div>
<a id="ad3cf5f1f95bc71115bc9cddf91821886"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3cf5f1f95bc71115bc9cddf91821886">◆ </a></span>CanIterate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool CFB_CipherAbstractPolicy::CanIterate </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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag indicating iteration support. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the cipher supports iteration, false otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00368">368</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="a021f82d6099659217e92aabb222200d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a021f82d6099659217e92aabb222200d4">◆ </a></span>Iterate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void CFB_CipherAbstractPolicy::Iterate </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cryptlib_8h.html#a353ccabf5ddc119a6a33e92f7b9961c7">CipherDir</a> </td>
<td class="paramname"><em>dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>iterationCount</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">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterate the cipher. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">output</td><td>the output buffer </td></tr>
<tr><td class="paramname">input</td><td>the input buffer </td></tr>
<tr><td class="paramname">dir</td><td>the direction of the cipher </td></tr>
<tr><td class="paramname">iterationCount</td><td>the number of iterations to perform on the input </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>IsSelfInverting() and IsForwardTransformation() </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00376">376</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="a52637fe1fa1cbde44246ec8fda3debc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52637fe1fa1cbde44246ec8fda3debc4">◆ </a></span>CipherSetKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void CFB_CipherAbstractPolicy::CipherSetKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> & </td>
<td class="paramname"><em>params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </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>length</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Key the cipher. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">params</td><td>set of <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names.">NameValuePairs</a> use to initialize this object </td></tr>
<tr><td class="paramname">key</td><td>a byte array used to key the cipher </td></tr>
<tr><td class="paramname">length</td><td>the size of the key array </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ace6ce335fb2722f5b0412064058bb2c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace6ce335fb2722f5b0412064058bb2c0">◆ </a></span>CipherResynchronize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void CFB_CipherAbstractPolicy::CipherResynchronize </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">size_t </td>
<td class="paramname"><em>length</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">inline</span><span class="mlabel">virtual</span></span> </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_8h_source.html#l00389">389</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 file:<ul>
<li><a class="el" href="strciphr_8h_source.html">strciphr.h</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
>
481
