<!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++: AdditiveCipherTemplate< 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.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-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_additive_cipher_template-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AdditiveCipherTemplate< BASE > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for additive 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_additive_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 AdditiveCipherTemplate< 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_additive_cipher_template.png" usemap="#AdditiveCipherTemplate_3C_20BASE_20_3E_map" alt=""/>
<map id="AdditiveCipherTemplate_3C_20BASE_20_3E_map" name="AdditiveCipherTemplate_3C_20BASE_20_3E_map">
<area href="class_random_number_generator.html" title="Interface for random number generators. " alt="RandomNumberGenerator" shape="rect" coords="213,112,416,136"/>
<area href="class_algorithm.html" title="Interface for all crypto algorithms. " alt="Algorithm" shape="rect" coords="213,56,416,80"/>
<area href="class_clonable.html" title="Interface for cloning objects. " alt="Clonable" shape="rect" coords="213,0,416,24"/>
</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:a79b269d3b9def1c573eb8b73926bbfdf"><td class="memItemLeft" align="right" valign="top"><a id="a79b269d3b9def1c573eb8b73926bbfdf"></a>
typedef BASE::PolicyInterface </td><td class="memItemRight" valign="bottom"><b>PolicyInterface</b></td></tr>
<tr class="separator:a79b269d3b9def1c573eb8b73926bbfdf"><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:aa8cfabe995c7262fc51e63d8d8269c2b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_additive_cipher_template.html#aa8cfabe995c7262fc51e63d8d8269c2b">GenerateBlock</a> (byte *output, size_t size)</td></tr>
<tr class="memdesc:aa8cfabe995c7262fc51e63d8d8269c2b"><td class="mdescLeft"> </td><td class="mdescRight">Generate random array of bytes. <a href="#aa8cfabe995c7262fc51e63d8d8269c2b">More...</a><br /></td></tr>
<tr class="separator:aa8cfabe995c7262fc51e63d8d8269c2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5903c41f2e4e2aa6df44715244f2f3f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_additive_cipher_template.html#a5903c41f2e4e2aa6df44715244f2f3f3">ProcessData</a> (byte *outString, const byte *inString, size_t length)</td></tr>
<tr class="memdesc:a5903c41f2e4e2aa6df44715244f2f3f3"><td class="mdescLeft"> </td><td class="mdescRight">Apply keystream to data. <a href="#a5903c41f2e4e2aa6df44715244f2f3f3">More...</a><br /></td></tr>
<tr class="separator:a5903c41f2e4e2aa6df44715244f2f3f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a888253a4c1eaf08d38e2e3a3a663319e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_additive_cipher_template.html#a888253a4c1eaf08d38e2e3a3a663319e">Resynchronize</a> (const byte *iv, int length=-1)</td></tr>
<tr class="memdesc:a888253a4c1eaf08d38e2e3a3a663319e"><td class="mdescLeft"> </td><td class="mdescRight">Resynchronize the cipher. <a href="#a888253a4c1eaf08d38e2e3a3a663319e">More...</a><br /></td></tr>
<tr class="separator:a888253a4c1eaf08d38e2e3a3a663319e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0004338eef2392895a4dae77465aa64a"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_additive_cipher_template.html#a0004338eef2392895a4dae77465aa64a">OptimalBlockSize</a> () const</td></tr>
<tr class="memdesc:a0004338eef2392895a4dae77465aa64a"><td class="mdescLeft"> </td><td class="mdescRight">Provides number of ideal bytes to process. <a href="#a0004338eef2392895a4dae77465aa64a">More...</a><br /></td></tr>
<tr class="separator:a0004338eef2392895a4dae77465aa64a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53950e34007c5cc84529e9199c84c7d2"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_additive_cipher_template.html#a53950e34007c5cc84529e9199c84c7d2">GetOptimalNextBlockSize</a> () const</td></tr>
<tr class="memdesc:a53950e34007c5cc84529e9199c84c7d2"><td class="mdescLeft"> </td><td class="mdescRight">Provides number of ideal bytes to process. <a href="#a53950e34007c5cc84529e9199c84c7d2">More...</a><br /></td></tr>
<tr class="separator:a53950e34007c5cc84529e9199c84c7d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4330a5797c37ffca92f34b532624b3c"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_additive_cipher_template.html#ad4330a5797c37ffca92f34b532624b3c">OptimalDataAlignment</a> () const</td></tr>
<tr class="memdesc:ad4330a5797c37ffca92f34b532624b3c"><td class="mdescLeft"> </td><td class="mdescRight">Provides number of ideal data alignment. <a href="#ad4330a5797c37ffca92f34b532624b3c">More...</a><br /></td></tr>
<tr class="separator:ad4330a5797c37ffca92f34b532624b3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5381b39bce5e7041fcbe2c8e53d85a7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_additive_cipher_template.html#aa5381b39bce5e7041fcbe2c8e53d85a7">IsSelfInverting</a> () const</td></tr>
<tr class="memdesc:aa5381b39bce5e7041fcbe2c8e53d85a7"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the cipher is self inverting. <a href="#aa5381b39bce5e7041fcbe2c8e53d85a7">More...</a><br /></td></tr>
<tr class="separator:aa5381b39bce5e7041fcbe2c8e53d85a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acabcddee5c7f5ccb5149c232741a2b1d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_additive_cipher_template.html#acabcddee5c7f5ccb5149c232741a2b1d">IsForwardTransformation</a> () const</td></tr>
<tr class="memdesc:acabcddee5c7f5ccb5149c232741a2b1d"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the cipher is a forward transformation. <a href="#acabcddee5c7f5ccb5149c232741a2b1d">More...</a><br /></td></tr>
<tr class="separator:acabcddee5c7f5ccb5149c232741a2b1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a348e17f577eee091fa06029123944467"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_additive_cipher_template.html#a348e17f577eee091fa06029123944467">IsRandomAccess</a> () const</td></tr>
<tr class="memdesc:a348e17f577eee091fa06029123944467"><td class="mdescLeft"> </td><td class="mdescRight">Flag indicating random access. <a href="#a348e17f577eee091fa06029123944467">More...</a><br /></td></tr>
<tr class="separator:a348e17f577eee091fa06029123944467"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68d4dc2904da4df5a7ead785ad7bc67e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_additive_cipher_template.html#a68d4dc2904da4df5a7ead785ad7bc67e">Seek</a> (lword position)</td></tr>
<tr class="memdesc:a68d4dc2904da4df5a7ead785ad7bc67e"><td class="mdescLeft"> </td><td class="mdescRight">Seeks to a random position in the stream. <a href="#a68d4dc2904da4df5a7ead785ad7bc67e">More...</a><br /></td></tr>
<tr class="separator:a68d4dc2904da4df5a7ead785ad7bc67e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_random_number_generator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_random_number_generator')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a></td></tr>
<tr class="memitem:a6feb4f0afedb62a495b7a9ae311fa1cb inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a6feb4f0afedb62a495b7a9ae311fa1cb">IncorporateEntropy</a> (const byte *input, size_t length)</td></tr>
<tr class="memdesc:a6feb4f0afedb62a495b7a9ae311fa1cb inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Update RNG state with additional unpredictable values. <a href="class_random_number_generator.html#a6feb4f0afedb62a495b7a9ae311fa1cb">More...</a><br /></td></tr>
<tr class="separator:a6feb4f0afedb62a495b7a9ae311fa1cb inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a859bf69f7fae074201745eadf765ae44 inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a859bf69f7fae074201745eadf765ae44">CanIncorporateEntropy</a> () const</td></tr>
<tr class="memdesc:a859bf69f7fae074201745eadf765ae44 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Determines if a generator can accept additional entropy. <a href="class_random_number_generator.html#a859bf69f7fae074201745eadf765ae44">More...</a><br /></td></tr>
<tr class="separator:a859bf69f7fae074201745eadf765ae44 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada0f7c437b0c8e6ba94ebcd75bff4bda inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual byte </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ada0f7c437b0c8e6ba94ebcd75bff4bda">GenerateByte</a> ()</td></tr>
<tr class="memdesc:ada0f7c437b0c8e6ba94ebcd75bff4bda inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate new random byte and return it. <a href="class_random_number_generator.html#ada0f7c437b0c8e6ba94ebcd75bff4bda">More...</a><br /></td></tr>
<tr class="separator:ada0f7c437b0c8e6ba94ebcd75bff4bda inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace592244cfbd6c18398ea6c75857532e inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ace592244cfbd6c18398ea6c75857532e">GenerateBit</a> ()</td></tr>
<tr class="memdesc:ace592244cfbd6c18398ea6c75857532e inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate new random bit and return it. <a href="class_random_number_generator.html#ace592244cfbd6c18398ea6c75857532e">More...</a><br /></td></tr>
<tr class="separator:ace592244cfbd6c18398ea6c75857532e inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96a3eec202b6251f5c94136ab7edbde1 inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual word32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a96a3eec202b6251f5c94136ab7edbde1">GenerateWord32</a> (word32 min=0, word32 max=0xffffffffUL)</td></tr>
<tr class="memdesc:a96a3eec202b6251f5c94136ab7edbde1 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate a random 32 bit word in the range min to max, inclusive. <a href="class_random_number_generator.html#a96a3eec202b6251f5c94136ab7edbde1">More...</a><br /></td></tr>
<tr class="separator:a96a3eec202b6251f5c94136ab7edbde1 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5cc474006e2c7383ec20cc4d0c2abbaf inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a5cc474006e2c7383ec20cc4d0c2abbaf">GenerateIntoBufferedTransformation</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, const std::string &channel, lword length)</td></tr>
<tr class="memdesc:a5cc474006e2c7383ec20cc4d0c2abbaf inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate random bytes into a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. <a href="class_random_number_generator.html#a5cc474006e2c7383ec20cc4d0c2abbaf">More...</a><br /></td></tr>
<tr class="separator:a5cc474006e2c7383ec20cc4d0c2abbaf inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44f70ad8fed869a4ee55f50ef8e6e699 inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a44f70ad8fed869a4ee55f50ef8e6e699">DiscardBytes</a> (size_t n)</td></tr>
<tr class="memdesc:a44f70ad8fed869a4ee55f50ef8e6e699 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate and discard n bytes. <a href="class_random_number_generator.html#a44f70ad8fed869a4ee55f50ef8e6e699">More...</a><br /></td></tr>
<tr class="separator:a44f70ad8fed869a4ee55f50ef8e6e699 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="memTemplParams" colspan="2">template<class IT > </td></tr>
<tr class="memitem:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#aff937f93b0b1e17e7905494ef060fce2">Shuffle</a> (IT begin, IT end)</td></tr>
<tr class="memdesc:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Randomly shuffle the specified array. <a href="class_random_number_generator.html#aff937f93b0b1e17e7905494ef060fce2">More...</a><br /></td></tr>
<tr class="separator:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_algorithm')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_algorithm.html">Algorithm</a></td></tr>
<tr class="memitem:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#a1c77f5117ca2cd881baf26a364cfc606">Algorithm</a> (bool checkSelfTestStatus=true)</td></tr>
<tr class="memdesc:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Interface for all crypto algorithms. <a href="class_algorithm.html#a1c77f5117ca2cd881baf26a364cfc606">More...</a><br /></td></tr>
<tr class="separator:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#a4f31510a192d1121856efe8ad0a9b844">AlgorithmName</a> () const</td></tr>
<tr class="memdesc:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Provides the name of this algorithm. <a href="class_algorithm.html#a4f31510a192d1121856efe8ad0a9b844">More...</a><br /></td></tr>
<tr class="separator:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_clonable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_clonable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_clonable.html">Clonable</a></td></tr>
<tr class="memitem:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#ad0016ba2d505c23aa85aad49e6c19bb7">Clone</a> () const</td></tr>
<tr class="memdesc:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="mdescLeft"> </td><td class="mdescRight">Copies this object. <a href="class_clonable.html#ad0016ba2d505c23aa85aad49e6c19bb7">More...</a><br /></td></tr>
<tr class="separator:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><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 = AbstractPolicyHolder<AdditiveCipherAbstractPolicy, SymmetricCipher>><br />
class AdditiveCipherTemplate< BASE ></h3>
<p>Base class for additive 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#l00261">261</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="aa8cfabe995c7262fc51e63d8d8269c2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8cfabe995c7262fc51e63d8d8269c2b">◆ </a></span>GenerateBlock()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class S > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_additive_cipher_template.html">AdditiveCipherTemplate</a>< S >::GenerateBlock </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">size_t </td>
<td class="paramname"><em>size</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>Generate random array of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">output</td><td>the byte buffer </td></tr>
<tr><td class="paramname">size</td><td>the length of the buffer, in bytes</td></tr>
</table>
</dd>
</dl>
<p>All generated values are uniformly distributed over the range specified within the the constraints of a particular generator. </p>
<p>Reimplemented from <a class="el" href="class_random_number_generator.html#a497145546d24e6d4abaf10b7e0f1ba17">RandomNumberGenerator</a>.</p>
<p class="definition">Definition at line <a class="el" href="strciphr_8cpp_source.html#l00029">29</a> of file <a class="el" href="strciphr_8cpp_source.html">strciphr.cpp</a>.</p>
</div>
</div>
<a id="a5903c41f2e4e2aa6df44715244f2f3f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5903c41f2e4e2aa6df44715244f2f3f3">◆ </a></span>ProcessData()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class S > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_additive_cipher_template.html">AdditiveCipherTemplate</a>< S >::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#l00067">67</a> of file <a class="el" href="strciphr_8cpp_source.html">strciphr.cpp</a>.</p>
</div>
</div>
<a id="a888253a4c1eaf08d38e2e3a3a663319e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a888253a4c1eaf08d38e2e3a3a663319e">◆ </a></span>Resynchronize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class S > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_additive_cipher_template.html">AdditiveCipherTemplate</a>< S >::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#l00126">126</a> of file <a class="el" href="strciphr_8cpp_source.html">strciphr.cpp</a>.</p>
</div>
</div>
<a id="a0004338eef2392895a4dae77465aa64a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0004338eef2392895a4dae77465aa64a">◆ </a></span>OptimalBlockSize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE = AbstractPolicyHolder<AdditiveCipherAbstractPolicy, SymmetricCipher>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="class_additive_cipher_template.html">AdditiveCipherTemplate</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_additive_cipher_template.html#a53950e34007c5cc84529e9199c84c7d2" 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#l00297">297</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="a53950e34007c5cc84529e9199c84c7d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53950e34007c5cc84529e9199c84c7d2">◆ </a></span>GetOptimalNextBlockSize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE = AbstractPolicyHolder<AdditiveCipherAbstractPolicy, SymmetricCipher>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="class_additive_cipher_template.html">AdditiveCipherTemplate</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_additive_cipher_template.html#a0004338eef2392895a4dae77465aa64a" 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#l00303">303</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="ad4330a5797c37ffca92f34b532624b3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4330a5797c37ffca92f34b532624b3c">◆ </a></span>OptimalDataAlignment()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE = AbstractPolicyHolder<AdditiveCipherAbstractPolicy, SymmetricCipher>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="class_additive_cipher_template.html">AdditiveCipherTemplate</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_additive_cipher_template.html#a0004338eef2392895a4dae77465aa64a" 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#l00308">308</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="aa5381b39bce5e7041fcbe2c8e53d85a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5381b39bce5e7041fcbe2c8e53d85a7">◆ </a></span>IsSelfInverting()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE = AbstractPolicyHolder<AdditiveCipherAbstractPolicy, SymmetricCipher>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_additive_cipher_template.html">AdditiveCipherTemplate</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#l00312">312</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="acabcddee5c7f5ccb5149c232741a2b1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acabcddee5c7f5ccb5149c232741a2b1d">◆ </a></span>IsForwardTransformation()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE = AbstractPolicyHolder<AdditiveCipherAbstractPolicy, SymmetricCipher>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_additive_cipher_template.html">AdditiveCipherTemplate</a>< BASE >::IsForwardTransformation </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 a forward transformation. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the stream cipher is a forward transformation, false otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00316">316</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="a348e17f577eee091fa06029123944467"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a348e17f577eee091fa06029123944467">◆ </a></span>IsRandomAccess()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BASE = AbstractPolicyHolder<AdditiveCipherAbstractPolicy, SymmetricCipher>> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_additive_cipher_template.html">AdditiveCipherTemplate</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><a class="el" href="class_additive_cipher_template.html#a68d4dc2904da4df5a7ead785ad7bc67e" title="Seeks to a random position in the stream. ">Seek()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8h_source.html#l00321">321</a> of file <a class="el" href="strciphr_8h_source.html">strciphr.h</a>.</p>
</div>
</div>
<a id="a68d4dc2904da4df5a7ead785ad7bc67e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68d4dc2904da4df5a7ead785ad7bc67e">◆ </a></span>Seek()</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_additive_cipher_template.html">AdditiveCipherTemplate</a>< BASE >::Seek </td>
<td>(</td>
<td class="paramtype">lword </td>
<td class="paramname"><em>position</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Seeks to a random position in the stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>the absolute position in the stream </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_additive_cipher_template.html#a348e17f577eee091fa06029123944467" title="Flag indicating random access. ">IsRandomAccess()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="strciphr_8cpp_source.html#l00135">135</a> of file <a class="el" href="strciphr_8cpp_source.html">strciphr.cpp</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 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
>
277
