<!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"/>
<title>Crypto++: StreamTransformation Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>StreamTransformation Class Reference</h1><!-- doxytag: class="StreamTransformation" --><!-- doxytag: inherits="Algorithm" -->
<p>interface for the data processing part of stream ciphers
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for StreamTransformation:</div>
<div class="dynsection">
<div class="center">
<img src="class_stream_transformation.gif" usemap="#StreamTransformation_map" alt=""/>
<map id="StreamTransformation_map" name="StreamTransformation_map">
<area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="377,56,744,80"/>
<area href="class_clonable.html" alt="Clonable" shape="rect" coords="377,0,744,24"/>
<area href="class_authenticated_symmetric_cipher.html" alt="AuthenticatedSymmetricCipher" shape="rect" coords="0,168,367,192"/>
<area href="class_public_blum_blum_shub.html" alt="PublicBlumBlumShub" shape="rect" coords="377,168,744,192"/>
<area href="class_symmetric_cipher.html" alt="SymmetricCipher" shape="rect" coords="1131,168,1498,192"/>
<area href="class_authenticated_symmetric_cipher_base.html" alt="AuthenticatedSymmetricCipherBase" shape="rect" coords="0,224,367,248"/>
<area href="class_blum_blum_shub.html" alt="BlumBlumShub" shape="rect" coords="377,224,744,248"/>
<area href="class_cipher_mode_base.html" alt="CipherModeBase" shape="rect" coords="754,224,1121,248"/>
<area href="class_weak1_1_1_a_r_c4___base.html" alt="Weak1::ARC4_Base" shape="rect" coords="1508,224,1875,248"/>
<area href="class_c_c_m___base.html" alt="CCM_Base" shape="rect" coords="377,280,744,304"/>
<area href="class_e_a_x___base.html" alt="EAX_Base" shape="rect" coords="377,336,744,360"/>
<area href="class_g_c_m___base.html" alt="GCM_Base" shape="rect" coords="377,392,744,416"/>
<area href="class_block_oriented_cipher_mode_base.html" alt="BlockOrientedCipherModeBase" shape="rect" coords="1131,280,1498,304"/>
<area href="class_mode_policy_common_template.html" alt="ModePolicyCommonTemplate< POLICY_INTERFACE >" shape="rect" coords="1131,336,1498,360"/>
<area href="class_mode_policy_common_template.html" alt="ModePolicyCommonTemplate< AdditiveCipherAbstractPolicy >" shape="rect" coords="1131,392,1498,416"/>
<area href="class_mode_policy_common_template.html" alt="ModePolicyCommonTemplate< CFB_CipherAbstractPolicy >" shape="rect" coords="1131,448,1498,472"/>
<area href="class_weak1_1_1_m_a_r_c4___base.html" alt="Weak1::MARC4_Base" shape="rect" coords="1508,280,1875,304"/>
</map>
</div>
</div>
<p><a href="class_stream_transformation-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_stream_transformation.html">StreamTransformation</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a8c9304fff5af593ee68d3cf0d33c06e9">Ref</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a reference to this object, <a href="#a8c9304fff5af593ee68d3cf0d33c06e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3638ff7580edb42a5b1c367e53a7436f"></a><!-- doxytag: member="StreamTransformation::MandatoryBlockSize" ref="a3638ff7580edb42a5b1c367e53a7436f" args="() const " -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a3638ff7580edb42a5b1c367e53a7436f">MandatoryBlockSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns block size, if input must be processed in blocks, otherwise 1 <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#ae79457bcbafc980672d88ee54ed4ac66">OptimalBlockSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the input block size that is most efficient for this cipher <a href="#ae79457bcbafc980672d88ee54ed4ac66"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94b4e1d14edde1fdde38361bce9ca4c6"></a><!-- doxytag: member="StreamTransformation::GetOptimalBlockSizeUsed" ref="a94b4e1d14edde1fdde38361bce9ca4c6" args="() const " -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a94b4e1d14edde1fdde38361bce9ca4c6">GetOptimalBlockSizeUsed</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns how much of the current block is used up <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6ed3c4f1c8582f62096263e76ed98f5"></a><!-- doxytag: member="StreamTransformation::OptimalDataAlignment" ref="af6ed3c4f1c8582f62096263e76ed98f5" args="() const " -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#af6ed3c4f1c8582f62096263e76ed98f5">OptimalDataAlignment</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns how input should be aligned for optimal performance <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0">ProcessData</a> (byte *outString, const byte *inString, size_t length)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">encrypt or decrypt an array of bytes of specified length <a href="#a26feabde21bc4d1783195969733e3bb0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a0668b78edaea082f87bf3e878c4c02f7">ProcessLastBlock</a> (byte *outString, const byte *inString, size_t length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">for ciphers where the last block of data is special, encrypt or decrypt the last block of data <a href="#a0668b78edaea082f87bf3e878c4c02f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2eb96f3a8fae23cb9f85acb288e3bcbe"></a><!-- doxytag: member="StreamTransformation::MinLastBlockSize" ref="a2eb96f3a8fae23cb9f85acb288e3bcbe" args="() const " -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a2eb96f3a8fae23cb9f85acb288e3bcbe">MinLastBlockSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the minimum size of the last block, 0 indicating the last block is not special <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac00f3fcc21f33f11c8efa4de67ff7774"></a><!-- doxytag: member="StreamTransformation::ProcessString" ref="ac00f3fcc21f33f11c8efa4de67ff7774" args="(byte *inoutString, size_t length)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#ac00f3fcc21f33f11c8efa4de67ff7774">ProcessString</a> (byte *inoutString, size_t length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">same as ProcessData(inoutString, inoutString, length) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17951cb36412763e0d6bd9696177175d"></a><!-- doxytag: member="StreamTransformation::ProcessString" ref="a17951cb36412763e0d6bd9696177175d" args="(byte *outString, const byte *inString, size_t length)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a17951cb36412763e0d6bd9696177175d">ProcessString</a> (byte *outString, const byte *inString, size_t length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">same as ProcessData(outString, inString, length) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71a9bd33526fc7f227050075e7a78106"></a><!-- doxytag: member="StreamTransformation::ProcessByte" ref="a71a9bd33526fc7f227050075e7a78106" args="(byte input)" -->
byte </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a71a9bd33526fc7f227050075e7a78106">ProcessByte</a> (byte input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">implemented as {ProcessData(&input, &input, 1); return input;} <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7286fd9a993de0a147b0c20f660bfa5"></a><!-- doxytag: member="StreamTransformation::IsRandomAccess" ref="ad7286fd9a993de0a147b0c20f660bfa5" args="() const =0" -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#ad7286fd9a993de0a147b0c20f660bfa5">IsRandomAccess</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this cipher supports random access <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7bfbac3f2e43b50d1e16e6b4b2d2e48a"></a><!-- doxytag: member="StreamTransformation::Seek" ref="a7bfbac3f2e43b50d1e16e6b4b2d2e48a" args="(lword n)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a7bfbac3f2e43b50d1e16e6b4b2d2e48a">Seek</a> (lword n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">for random access ciphers, seek to an absolute position <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a583bc0edbd8a11c91da53395298c50de"></a><!-- doxytag: member="StreamTransformation::IsSelfInverting" ref="a583bc0edbd8a11c91da53395298c50de" args="() const =0" -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a583bc0edbd8a11c91da53395298c50de">IsSelfInverting</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this transformation is self-inverting (e.g. xor with a keystream) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3244f76963a12a5ab6112326c7af9724"></a><!-- doxytag: member="StreamTransformation::IsForwardTransformation" ref="a3244f76963a12a5ab6112326c7af9724" args="() const =0" -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a3244f76963a12a5ab6112326c7af9724">IsForwardTransformation</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this is an encryption object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd21c6715add4884fa043eaf51655039"></a><!-- doxytag: member="StreamTransformation::AlgorithmName" ref="acd21c6715add4884fa043eaf51655039" args="() const " -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#acd21c6715add4884fa043eaf51655039">AlgorithmName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns name of this algorithm, not universally implemented yet <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24b43349a71e1f98508eeb10b31a0a62"></a><!-- doxytag: member="StreamTransformation::Clone" ref="a24b43349a71e1f98508eeb10b31a0a62" args="() const " -->
virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#a24b43349a71e1f98508eeb10b31a0a62">Clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>interface for the data processing part of stream ciphers </p>
<p>Definition at line <a class="el" href="cryptlib_8h_source.html#l00477">477</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8c9304fff5af593ee68d3cf0d33c06e9"></a><!-- doxytag: member="StreamTransformation::Ref" ref="a8c9304fff5af593ee68d3cf0d33c06e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_stream_transformation.html">StreamTransformation</a>& StreamTransformation::Ref </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a reference to this object, </p>
<p>This function is useful for passing a temporary <a class="el" href="class_stream_transformation.html" title="interface for the data processing part of stream ciphers">StreamTransformation</a> object to a function that takes a non-const reference. </p>
<p>Definition at line <a class="el" href="cryptlib_8h_source.html#l00483">483</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae79457bcbafc980672d88ee54ed4ac66"></a><!-- doxytag: member="StreamTransformation::OptimalBlockSize" ref="ae79457bcbafc980672d88ee54ed4ac66" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int StreamTransformation::OptimalBlockSize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the input block size that is most efficient for this cipher </p>
<dl class="note"><dt><b>Note:</b></dt><dd>optimal input length is n * <a class="el" href="class_stream_transformation.html#ae79457bcbafc980672d88ee54ed4ac66" title="returns the input block size that is most efficient for this cipher">OptimalBlockSize()</a> - <a class="el" href="class_stream_transformation.html#a94b4e1d14edde1fdde38361bce9ca4c6" title="returns how much of the current block is used up">GetOptimalBlockSizeUsed()</a> for any n > 0 </dd></dl>
<p>Reimplemented in <a class="el" href="class_e_c_b___one_way.html#ae525b1874f11cd0aa85f2d93c17f9d08">ECB_OneWay</a>.</p>
<p>Definition at line <a class="el" href="cryptlib_8h_source.html#l00490">490</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a class="anchor" id="a26feabde21bc4d1783195969733e3bb0"></a><!-- doxytag: member="StreamTransformation::ProcessData" ref="a26feabde21bc4d1783195969733e3bb0" args="(byte *outString, const byte *inString, size_t length)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void StreamTransformation::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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>encrypt or decrypt an array of bytes of specified length </p>
<dl class="note"><dt><b>Note:</b></dt><dd>either inString == outString, or they don't overlap </dd></dl>
<p>Implemented in <a class="el" href="class_weak1_1_1_a_r_c4___base.html#acde17b2a24427c2275efc9c9d24e5660">Weak1::ARC4_Base</a>, <a class="el" href="class_authenticated_symmetric_cipher_base.html#a2887c0e4c7e303bdb51dfd869b16189f">AuthenticatedSymmetricCipherBase</a>, <a class="el" href="class_public_blum_blum_shub.html#afb03a58653cb83c9a9013f3a57105bfc">PublicBlumBlumShub</a>, <a class="el" href="class_e_c_b___one_way.html#a4d8c291d821d86f7f4caa3cf95d1834c">ECB_OneWay</a>, <a class="el" href="class_c_b_c___encryption.html#ad4efdd9fd6d832b234771754cd51d20a">CBC_Encryption</a>, and <a class="el" href="class_c_b_c___decryption.html#ad3dfde8d73d036dc144e8750a6a3b1d1">CBC_Decryption</a>.</p>
<p>Referenced by <a class="el" href="authenc_8cpp_source.html#l00104">AuthenticatedSymmetricCipherBase::ProcessData()</a>, and <a class="el" href="cryptlib_8cpp_source.html#l00187">ProcessLastBlock()</a>.</p>
</div>
</div>
<a class="anchor" id="a0668b78edaea082f87bf3e878c4c02f7"></a><!-- doxytag: member="StreamTransformation::ProcessLastBlock" ref="a0668b78edaea082f87bf3e878c4c02f7" args="(byte *outString, const byte *inString, size_t length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StreamTransformation::ProcessLastBlock </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>for ciphers where the last block of data is special, encrypt or decrypt the last block of data </p>
<p>For now the only use of this function is for CBC-CTS mode. </p>
<p>Reimplemented in <a class="el" href="class_c_b_c___c_t_s___encryption.html#afa5e227b89c39bff1386df7cebaa5f32">CBC_CTS_Encryption</a>, and <a class="el" href="class_c_b_c___c_t_s___decryption.html#a2f23aad280dc56920f16ea0711b39d89">CBC_CTS_Decryption</a>.</p>
<p>Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00187">187</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p>
<p>References <a class="el" href="cryptlib_8h_source.html#l00350">Algorithm::AlgorithmName()</a>, <a class="el" href="cryptlib_8h_source.html#l00486">MandatoryBlockSize()</a>, <a class="el" href="cryptlib_8h_source.html#l00505">MinLastBlockSize()</a>, and <a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0">ProcessData()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="cryptlib_8h_source.html">cryptlib.h</a></li>
<li><a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 9 Dec 2009 for Crypto++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
07dfcfe50d66c9a48a3c5e6c1693f12a
>
files
>
1412
