<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: AdditiveCipherAbstractPolicy Struct 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.14 -->
<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="struct_additive_cipher_abstract_policy-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AdditiveCipherAbstractPolicy Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Policy object for additive stream ciphers.
<a href="struct_additive_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 AdditiveCipherAbstractPolicy:</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="struct_additive_cipher_abstract_policy.png" usemap="#AdditiveCipherAbstractPolicy_map" alt=""/>
<map id="AdditiveCipherAbstractPolicy_map" name="AdditiveCipherAbstractPolicy_map">
<area href="struct_additive_cipher_concrete_policy.html" alt="AdditiveCipherConcretePolicy< word32, 1, 64 >" shape="rect" coords="0,56,367,80"/>
<area href="struct_additive_cipher_concrete_policy.html" alt="AdditiveCipherConcretePolicy< word32, 16 >" shape="rect" coords="377,56,744,80"/>
<area href="struct_additive_cipher_concrete_policy.html" alt="AdditiveCipherConcretePolicy< word32, 20 >" shape="rect" coords="1131,56,1498,80"/>
<area href="struct_additive_cipher_concrete_policy.html" alt="AdditiveCipherConcretePolicy< word32, 256 >" shape="rect" coords="1508,56,1875,80"/>
<area href="struct_additive_cipher_concrete_policy.html" alt="AdditiveCipherConcretePolicy< word32, 8 >" shape="rect" coords="1885,56,2252,80"/>
<area href="class_mode_policy_common_template.html" alt="ModePolicyCommonTemplate< AdditiveCipherAbstractPolicy >" shape="rect" coords="2262,56,2629,80"/>
<area href="class_w_a_k_e___policy.html" title="WAKE stream cipher operation. " alt="WAKE_Policy< B >" shape="rect" coords="0,112,367,136"/>
<area href="class_cha_cha___policy.html" title="ChaCha stream cipher implementation. " alt="ChaCha_Policy< R >" shape="rect" coords="754,112,1121,136"/>
<area href="class_salsa20___policy.html" title="Salsa20 stream cipher operation. " alt="Salsa20_Policy" shape="rect" coords="754,168,1121,192"/>
<area href="class_sosemanuk_policy.html" title="Sosemanuk stream cipher implementation. " alt="SosemanukPolicy" shape="rect" coords="1131,112,1498,136"/>
<area href="class_s_e_a_l___policy.html" title="SEAL stream cipher operation. " alt="SEAL_Policy< B >" shape="rect" coords="1508,112,1875,136"/>
<area href="class_panama_cipher_policy.html" title="Panama stream cipher operation. " alt="PanamaCipherPolicy< B >" shape="rect" coords="1885,112,2252,136"/>
<area href="class_c_t_r___mode_policy.html" title="CTR block cipher mode of operation. " alt="CTR_ModePolicy" shape="rect" coords="2639,112,3006,136"/>
<area href="class_o_f_b___mode_policy.html" title="OFB block cipher mode of operation. " alt="OFB_ModePolicy" shape="rect" coords="2639,168,3006,192"/>
</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:a156c179304f2a5d119f74806b5b263ec"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#a156c179304f2a5d119f74806b5b263ec">GetAlignment</a> () const</td></tr>
<tr class="memdesc:a156c179304f2a5d119f74806b5b263ec"><td class="mdescLeft"> </td><td class="mdescRight">Provides data alignment requirements. <a href="#a156c179304f2a5d119f74806b5b263ec">More...</a><br /></td></tr>
<tr class="separator:a156c179304f2a5d119f74806b5b263ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a573f7abcf5929be546bddc32139bf370"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#a573f7abcf5929be546bddc32139bf370">GetBytesPerIteration</a> () const =0</td></tr>
<tr class="memdesc:a573f7abcf5929be546bddc32139bf370"><td class="mdescLeft"> </td><td class="mdescRight">Provides number of bytes operated upon during an iteration. <a href="#a573f7abcf5929be546bddc32139bf370">More...</a><br /></td></tr>
<tr class="separator:a573f7abcf5929be546bddc32139bf370"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32bbafa12b59e77d4d8bc67e9d5a4004"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#a32bbafa12b59e77d4d8bc67e9d5a4004">GetOptimalBlockSize</a> () const</td></tr>
<tr class="memdesc:a32bbafa12b59e77d4d8bc67e9d5a4004"><td class="mdescLeft"> </td><td class="mdescRight">Provides number of ideal bytes to process. <a href="#a32bbafa12b59e77d4d8bc67e9d5a4004">More...</a><br /></td></tr>
<tr class="separator:a32bbafa12b59e77d4d8bc67e9d5a4004"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2267beddbc4140e92c78206a24ead0c"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#aa2267beddbc4140e92c78206a24ead0c">GetIterationsToBuffer</a> () const =0</td></tr>
<tr class="memdesc:aa2267beddbc4140e92c78206a24ead0c"><td class="mdescLeft"> </td><td class="mdescRight">Provides buffer size based on iterations. <a href="#aa2267beddbc4140e92c78206a24ead0c">More...</a><br /></td></tr>
<tr class="separator:aa2267beddbc4140e92c78206a24ead0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea8268ee42cbc98cf9be638bf77aafef"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#aea8268ee42cbc98cf9be638bf77aafef">WriteKeystream</a> (byte *keystream, size_t iterationCount)</td></tr>
<tr class="memdesc:aea8268ee42cbc98cf9be638bf77aafef"><td class="mdescLeft"> </td><td class="mdescRight">Generate the keystream. <a href="#aea8268ee42cbc98cf9be638bf77aafef">More...</a><br /></td></tr>
<tr class="separator:aea8268ee42cbc98cf9be638bf77aafef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02d1a81c11cf52ed48a5c10357a39717"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#a02d1a81c11cf52ed48a5c10357a39717">CanOperateKeystream</a> () const</td></tr>
<tr class="memdesc:a02d1a81c11cf52ed48a5c10357a39717"><td class="mdescLeft"> </td><td class="mdescRight">Flag indicating. <a href="#a02d1a81c11cf52ed48a5c10357a39717">More...</a><br /></td></tr>
<tr class="separator:a02d1a81c11cf52ed48a5c10357a39717"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae948f2e69229ba39837e498a464606d4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#ae948f2e69229ba39837e498a464606d4">OperateKeystream</a> (<a class="el" href="strciphr_8h.html#ab4a226527d2bd01ff19bfa14d0974227">KeystreamOperation</a> operation, byte *output, const byte *input, size_t iterationCount)</td></tr>
<tr class="memdesc:ae948f2e69229ba39837e498a464606d4"><td class="mdescLeft"> </td><td class="mdescRight">Operates the keystream. <a href="#ae948f2e69229ba39837e498a464606d4">More...</a><br /></td></tr>
<tr class="separator:ae948f2e69229ba39837e498a464606d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a906b4001cc8c457d1abb4bff4fb8157a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#a906b4001cc8c457d1abb4bff4fb8157a">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:a906b4001cc8c457d1abb4bff4fb8157a"><td class="mdescLeft"> </td><td class="mdescRight">Key the cipher. <a href="#a906b4001cc8c457d1abb4bff4fb8157a">More...</a><br /></td></tr>
<tr class="separator:a906b4001cc8c457d1abb4bff4fb8157a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae00639d9aeb20b7da3ac5e3a0f877fa0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#ae00639d9aeb20b7da3ac5e3a0f877fa0">CipherResynchronize</a> (byte *keystreamBuffer, const byte *iv, size_t length)</td></tr>
<tr class="memdesc:ae00639d9aeb20b7da3ac5e3a0f877fa0"><td class="mdescLeft"> </td><td class="mdescRight">Resynchronize the cipher. <a href="#ae00639d9aeb20b7da3ac5e3a0f877fa0">More...</a><br /></td></tr>
<tr class="separator:ae00639d9aeb20b7da3ac5e3a0f877fa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdac73ff69a1b36d32871c110f28413a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#abdac73ff69a1b36d32871c110f28413a">CipherIsRandomAccess</a> () const =0</td></tr>
<tr class="memdesc:abdac73ff69a1b36d32871c110f28413a"><td class="mdescLeft"> </td><td class="mdescRight">Flag indicating random access. <a href="#abdac73ff69a1b36d32871c110f28413a">More...</a><br /></td></tr>
<tr class="separator:abdac73ff69a1b36d32871c110f28413a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fce38d2b7d84732fc3efea410b82d54"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_additive_cipher_abstract_policy.html#a8fce38d2b7d84732fc3efea410b82d54">SeekToIteration</a> (lword iterationCount)</td></tr>
<tr class="memdesc:a8fce38d2b7d84732fc3efea410b82d54"><td class="mdescLeft"> </td><td class="mdescRight">Seeks to a random position in the stream. <a href="#a8fce38d2b7d84732fc3efea410b82d54">More...</a><br /></td></tr>
<tr class="separator:a8fce38d2b7d84732fc3efea410b82d54"><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 additive stream ciphers. </p>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00103">103</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="a156c179304f2a5d119f74806b5b263ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a156c179304f2a5d119f74806b5b263ec">◆ </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 AdditiveCipherAbstractPolicy::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">inline</span><span class="mlabel">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>
<p>Reimplemented in <a class="el" href="struct_additive_cipher_concrete_policy.html#a5bdc1cb44b0ddc8df0fb6953aec93602">AdditiveCipherConcretePolicy< word32, 20 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a5bdc1cb44b0ddc8df0fb6953aec93602">AdditiveCipherConcretePolicy< word32, 8 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a5bdc1cb44b0ddc8df0fb6953aec93602">AdditiveCipherConcretePolicy< word32, 256 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a5bdc1cb44b0ddc8df0fb6953aec93602">AdditiveCipherConcretePolicy< word32, 16 ></a>, and <a class="el" href="struct_additive_cipher_concrete_policy.html#a5bdc1cb44b0ddc8df0fb6953aec93602">AdditiveCipherConcretePolicy< word32, 1, 64 ></a>.</p>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00111">111</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="a573f7abcf5929be546bddc32139bf370"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a573f7abcf5929be546bddc32139bf370">◆ </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 AdditiveCipherAbstractPolicy::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><a class="el" href="struct_additive_cipher_abstract_policy.html#a32bbafa12b59e77d4d8bc67e9d5a4004" title="Provides number of ideal bytes to process. ">GetOptimalBlockSize()</a> </dd></dl>
<p>Implemented in <a class="el" href="struct_additive_cipher_concrete_policy.html#a3518c4f5404dd2eb483599bb1109d715">AdditiveCipherConcretePolicy< word32, 20 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a3518c4f5404dd2eb483599bb1109d715">AdditiveCipherConcretePolicy< word32, 8 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a3518c4f5404dd2eb483599bb1109d715">AdditiveCipherConcretePolicy< word32, 256 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a3518c4f5404dd2eb483599bb1109d715">AdditiveCipherConcretePolicy< word32, 16 ></a>, and <a class="el" href="struct_additive_cipher_concrete_policy.html#a3518c4f5404dd2eb483599bb1109d715">AdditiveCipherConcretePolicy< word32, 1, 64 ></a>.</p>
</div>
</div>
<a id="a32bbafa12b59e77d4d8bc67e9d5a4004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32bbafa12b59e77d4d8bc67e9d5a4004">◆ </a></span>GetOptimalBlockSize()</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 AdditiveCipherAbstractPolicy::GetOptimalBlockSize </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>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 <a class="el" href="struct_additive_cipher_abstract_policy.html#a573f7abcf5929be546bddc32139bf370" title="Provides number of bytes operated upon during an iteration. ">GetBytesPerIteration()</a> </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="struct_additive_cipher_abstract_policy.html#a573f7abcf5929be546bddc32139bf370" title="Provides number of bytes operated upon during an iteration. ">GetBytesPerIteration()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00122">122</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="aa2267beddbc4140e92c78206a24ead0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2267beddbc4140e92c78206a24ead0c">◆ </a></span>GetIterationsToBuffer()</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 AdditiveCipherAbstractPolicy::GetIterationsToBuffer </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 buffer size based on iterations. </p>
<dl class="section return"><dt>Returns</dt><dd>the buffer size based on iterations, in bytes </dd></dl>
<p>Implemented in <a class="el" href="struct_additive_cipher_concrete_policy.html#ad7d421c4073891ad3522c50052d32f60">AdditiveCipherConcretePolicy< word32, 20 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#ad7d421c4073891ad3522c50052d32f60">AdditiveCipherConcretePolicy< word32, 8 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#ad7d421c4073891ad3522c50052d32f60">AdditiveCipherConcretePolicy< word32, 256 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#ad7d421c4073891ad3522c50052d32f60">AdditiveCipherConcretePolicy< word32, 16 ></a>, and <a class="el" href="struct_additive_cipher_concrete_policy.html#ad7d421c4073891ad3522c50052d32f60">AdditiveCipherConcretePolicy< word32, 1, 64 ></a>.</p>
</div>
</div>
<a id="aea8268ee42cbc98cf9be638bf77aafef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea8268ee42cbc98cf9be638bf77aafef">◆ </a></span>WriteKeystream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AdditiveCipherAbstractPolicy::WriteKeystream </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>keystream</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>Generate the keystream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keystream</td><td>the key stream </td></tr>
<tr><td class="paramname">iterationCount</td><td>the number of iterations to generate the key stream </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="struct_additive_cipher_abstract_policy.html#a02d1a81c11cf52ed48a5c10357a39717" title="Flag indicating. ">CanOperateKeystream()</a>, <a class="el" href="struct_additive_cipher_abstract_policy.html#ae948f2e69229ba39837e498a464606d4" title="Operates the keystream. ">OperateKeystream()</a>, <a class="el" href="struct_additive_cipher_abstract_policy.html#aea8268ee42cbc98cf9be638bf77aafef" title="Generate the keystream. ">WriteKeystream()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00132">132</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="a02d1a81c11cf52ed48a5c10357a39717"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02d1a81c11cf52ed48a5c10357a39717">◆ </a></span>CanOperateKeystream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool AdditiveCipherAbstractPolicy::CanOperateKeystream </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. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the stream can be generated independent of the transformation input, false otherwise </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="struct_additive_cipher_abstract_policy.html#a02d1a81c11cf52ed48a5c10357a39717" title="Flag indicating. ">CanOperateKeystream()</a>, <a class="el" href="struct_additive_cipher_abstract_policy.html#ae948f2e69229ba39837e498a464606d4" title="Operates the keystream. ">OperateKeystream()</a>, <a class="el" href="struct_additive_cipher_abstract_policy.html#aea8268ee42cbc98cf9be638bf77aafef" title="Generate the keystream. ">WriteKeystream()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="struct_additive_cipher_concrete_policy.html#a4d61dfcd462d71960fe8567e2d475f14">AdditiveCipherConcretePolicy< word32, 20 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a4d61dfcd462d71960fe8567e2d475f14">AdditiveCipherConcretePolicy< word32, 8 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a4d61dfcd462d71960fe8567e2d475f14">AdditiveCipherConcretePolicy< word32, 256 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a4d61dfcd462d71960fe8567e2d475f14">AdditiveCipherConcretePolicy< word32, 16 ></a>, and <a class="el" href="struct_additive_cipher_concrete_policy.html#a4d61dfcd462d71960fe8567e2d475f14">AdditiveCipherConcretePolicy< word32, 1, 64 ></a>.</p>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00138">138</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="ae948f2e69229ba39837e498a464606d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae948f2e69229ba39837e498a464606d4">◆ </a></span>OperateKeystream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AdditiveCipherAbstractPolicy::OperateKeystream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="strciphr_8h.html#ab4a226527d2bd01ff19bfa14d0974227">KeystreamOperation</a> </td>
<td class="paramname"><em>operation</em>, </td>
</tr>
<tr>
<td class="paramkey"></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">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>Operates the keystream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">operation</td><td>the operation with additional flags </td></tr>
<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">iterationCount</td><td>the number of iterations to perform on the input</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="struct_additive_cipher_abstract_policy.html#ae948f2e69229ba39837e498a464606d4" title="Operates the keystream. ">OperateKeystream()</a> will attempt to operate upon <a class="el" href="struct_additive_cipher_abstract_policy.html#a32bbafa12b59e77d4d8bc67e9d5a4004" title="Provides number of ideal bytes to process. ">GetOptimalBlockSize()</a> buffer, which will be derived from <a class="el" href="struct_additive_cipher_abstract_policy.html#a573f7abcf5929be546bddc32139bf370" title="Provides number of bytes operated upon during an iteration. ">GetBytesPerIteration()</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="struct_additive_cipher_abstract_policy.html#a02d1a81c11cf52ed48a5c10357a39717" title="Flag indicating. ">CanOperateKeystream()</a>, <a class="el" href="struct_additive_cipher_abstract_policy.html#ae948f2e69229ba39837e498a464606d4" title="Operates the keystream. ">OperateKeystream()</a>, <a class="el" href="struct_additive_cipher_abstract_policy.html#aea8268ee42cbc98cf9be638bf77aafef" title="Generate the keystream. ">WriteKeystream()</a>, <a class="el" href="strciphr_8h.html#ab4a226527d2bd01ff19bfa14d0974227" title="Keystream operation flags. ">KeystreamOperation()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="struct_additive_cipher_concrete_policy.html#a88ce0905757bcc373f028bfd9e0dec43">AdditiveCipherConcretePolicy< word32, 20 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a88ce0905757bcc373f028bfd9e0dec43">AdditiveCipherConcretePolicy< word32, 8 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a88ce0905757bcc373f028bfd9e0dec43">AdditiveCipherConcretePolicy< word32, 256 ></a>, <a class="el" href="struct_additive_cipher_concrete_policy.html#a88ce0905757bcc373f028bfd9e0dec43">AdditiveCipherConcretePolicy< word32, 16 ></a>, and <a class="el" href="struct_additive_cipher_concrete_policy.html#a88ce0905757bcc373f028bfd9e0dec43">AdditiveCipherConcretePolicy< word32, 1, 64 ></a>.</p>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00148">148</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="a906b4001cc8c457d1abb4bff4fb8157a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a906b4001cc8c457d1abb4bff4fb8157a">◆ </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 AdditiveCipherAbstractPolicy::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>
<p>Implemented in <a class="el" href="class_x_salsa20___policy.html#af2b6e6e0b1a943d04eceaa31f0013cad">XSalsa20_Policy</a>.</p>
</div>
</div>
<a id="ae00639d9aeb20b7da3ac5e3a0f877fa0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae00639d9aeb20b7da3ac5e3a0f877fa0">◆ </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 AdditiveCipherAbstractPolicy::CipherResynchronize </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>keystreamBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></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">keystreamBuffer</td><td>the keystream buffer </td></tr>
<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>Reimplemented in <a class="el" href="class_x_salsa20___policy.html#afcb6d5b93382842541542275d00b088d">XSalsa20_Policy</a>.</p>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00161">161</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="abdac73ff69a1b36d32871c110f28413a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdac73ff69a1b36d32871c110f28413a">◆ </a></span>CipherIsRandomAccess()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool AdditiveCipherAbstractPolicy::CipherIsRandomAccess </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>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><a class="el" href="struct_additive_cipher_abstract_policy.html#a8fce38d2b7d84732fc3efea410b82d54" title="Seeks to a random position in the stream. ">SeekToIteration()</a> </dd></dl>
<p>Implemented in <a class="el" href="class_c_t_r___mode_policy.html#a9014be8edb48664ff1aa0984478c52b6">CTR_ModePolicy</a>, and <a class="el" href="class_o_f_b___mode_policy.html#aea518f764b886278aca868fe987ede35">OFB_ModePolicy</a>.</p>
</div>
</div>
<a id="a8fce38d2b7d84732fc3efea410b82d54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fce38d2b7d84732fc3efea410b82d54">◆ </a></span>SeekToIteration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AdditiveCipherAbstractPolicy::SeekToIteration </td>
<td>(</td>
<td class="paramtype">lword </td>
<td class="paramname"><em>iterationCount</em></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>Seeks to a random position in the stream. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="struct_additive_cipher_abstract_policy.html#abdac73ff69a1b36d32871c110f28413a" title="Flag indicating random access. ">CipherIsRandomAccess()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00171">171</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct 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 Sun Sep 16 2018 07:58:12 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
0a67b807a02637f2cae68649d519a89d
>
files
>
2635
