<!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++: StreamTransformation 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.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="class_stream_transformation-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">StreamTransformation Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for the data processing portion of stream ciphers.
<a href="class_stream_transformation.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 StreamTransformation:</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_stream_transformation.png" usemap="#StreamTransformation_map" alt=""/>
<map id="StreamTransformation_map" name="StreamTransformation_map">
<area href="class_algorithm.html" title="Interface for all crypto algorithms. " alt="Algorithm" shape="rect" coords="377,56,744,80"/>
<area href="class_clonable.html" title="Interface for cloning objects. " alt="Clonable" shape="rect" coords="377,0,744,24"/>
<area href="class_authenticated_symmetric_cipher.html" title="Interface for authenticated encryption modes of operation. " alt="AuthenticatedSymmetricCipher" shape="rect" coords="0,168,367,192"/>
<area href="class_public_blum_blum_shub.html" title="BlumBlumShub without factorization of the modulus. " alt="PublicBlumBlumShub" shape="rect" coords="377,168,744,192"/>
<area href="class_symmetric_cipher.html" title="Interface for one direction (encryption or decryption) of a stream cipher or cipher mode..." alt="SymmetricCipher" shape="rect" coords="1131,168,1498,192"/>
<area href="class_authenticated_symmetric_cipher_base.html" title="Base class for authenticated encryption modes of operation. " alt="AuthenticatedSymmetricCipherBase" shape="rect" coords="0,224,367,248"/>
<area href="class_blum_blum_shub.html" title="BlumBlumShub with factorization of the modulus. " alt="BlumBlumShub" shape="rect" coords="377,224,744,248"/>
<area href="class_cipher_mode_base.html" title="Block cipher mode of operation information. " alt="CipherModeBase" shape="rect" coords="754,224,1121,248"/>
<area href="class_weak_1_1_a_r_c4___base.html" title="ARC4 base class. " alt="Weak::ARC4_Base" shape="rect" coords="1508,224,1875,248"/>
<area href="class_c_c_m___base.html" title="CCM block cipher base implementation. " alt="CCM_Base" shape="rect" coords="377,280,744,304"/>
<area href="class_e_a_x___base.html" title="EAX block cipher base implementation. " alt="EAX_Base" shape="rect" coords="377,336,744,360"/>
<area href="class_g_c_m___base.html" title="GCM block cipher base implementation. " alt="GCM_Base" shape="rect" coords="377,392,744,416"/>
<area href="class_block_oriented_cipher_mode_base.html" title="Block cipher mode of operation default implementation. " alt="BlockOrientedCipherModeBase" shape="rect" coords="1131,280,1498,304"/>
<area href="class_mode_policy_common_template.html" title="Block cipher mode of operation common operations. " 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_weak_1_1_m_a_r_c4___base.html" title="MARC4 base class. " alt="Weak::MARC4_Base" shape="rect" coords="1508,280,1875,304"/>
</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:a8c9304fff5af593ee68d3cf0d33c06e9"><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 class="memdesc:a8c9304fff5af593ee68d3cf0d33c06e9"><td class="mdescLeft"> </td><td class="mdescRight">Provides a reference to this object. <a href="#a8c9304fff5af593ee68d3cf0d33c06e9">More...</a><br /></td></tr>
<tr class="separator:a8c9304fff5af593ee68d3cf0d33c06e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae224d250f716e82c54bc4e4c8930d188"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188">MandatoryBlockSize</a> () const</td></tr>
<tr class="memdesc:ae224d250f716e82c54bc4e4c8930d188"><td class="mdescLeft"> </td><td class="mdescRight">Provides the mandatory block size of the cipher. <a href="#ae224d250f716e82c54bc4e4c8930d188">More...</a><br /></td></tr>
<tr class="separator:ae224d250f716e82c54bc4e4c8930d188"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af66ef64545279c01310718af3d627534"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#af66ef64545279c01310718af3d627534">OptimalBlockSize</a> () const</td></tr>
<tr class="memdesc:af66ef64545279c01310718af3d627534"><td class="mdescLeft"> </td><td class="mdescRight">Provides the input block size most efficient for this cipher. <a href="#af66ef64545279c01310718af3d627534">More...</a><br /></td></tr>
<tr class="separator:af66ef64545279c01310718af3d627534"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8422f6eee08fbc70069e222186e90de"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#ab8422f6eee08fbc70069e222186e90de">GetOptimalBlockSizeUsed</a> () const</td></tr>
<tr class="memdesc:ab8422f6eee08fbc70069e222186e90de"><td class="mdescLeft"> </td><td class="mdescRight">Provides the number of bytes used in the current block when processing at optimal block size. <a href="#ab8422f6eee08fbc70069e222186e90de">More...</a><br /></td></tr>
<tr class="separator:ab8422f6eee08fbc70069e222186e90de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a447cfac11f97012dff9662fb5e5d208b"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a447cfac11f97012dff9662fb5e5d208b">OptimalDataAlignment</a> () const</td></tr>
<tr class="memdesc:a447cfac11f97012dff9662fb5e5d208b"><td class="mdescLeft"> </td><td class="mdescRight">Provides input and output data alignment for optimal performance. <a href="#a447cfac11f97012dff9662fb5e5d208b">More...</a><br /></td></tr>
<tr class="separator:a447cfac11f97012dff9662fb5e5d208b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26feabde21bc4d1783195969733e3bb0"><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 class="memdesc:a26feabde21bc4d1783195969733e3bb0"><td class="mdescLeft"> </td><td class="mdescRight">Encrypt or decrypt an array of bytes. <a href="#a26feabde21bc4d1783195969733e3bb0">More...</a><br /></td></tr>
<tr class="separator:a26feabde21bc4d1783195969733e3bb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af48589443f77f4ed9ff185f9c1a26cbf"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#af48589443f77f4ed9ff185f9c1a26cbf">ProcessLastBlock</a> (byte *outString, size_t outLength, const byte *inString, size_t inLength)</td></tr>
<tr class="memdesc:af48589443f77f4ed9ff185f9c1a26cbf"><td class="mdescLeft"> </td><td class="mdescRight">Encrypt or decrypt the last block of data. <a href="#af48589443f77f4ed9ff185f9c1a26cbf">More...</a><br /></td></tr>
<tr class="separator:af48589443f77f4ed9ff185f9c1a26cbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b7c5bc41b9b5f6443ee32d65ebc044c"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a0b7c5bc41b9b5f6443ee32d65ebc044c">MinLastBlockSize</a> () const</td></tr>
<tr class="memdesc:a0b7c5bc41b9b5f6443ee32d65ebc044c"><td class="mdescLeft"> </td><td class="mdescRight">Provides the size of the last block. <a href="#a0b7c5bc41b9b5f6443ee32d65ebc044c">More...</a><br /></td></tr>
<tr class="separator:a0b7c5bc41b9b5f6443ee32d65ebc044c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62db1393d64069b282e3d455b38cd0e5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5">IsLastBlockSpecial</a> () const</td></tr>
<tr class="memdesc:a62db1393d64069b282e3d455b38cd0e5"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the last block receives special processing. <a href="#a62db1393d64069b282e3d455b38cd0e5">More...</a><br /></td></tr>
<tr class="separator:a62db1393d64069b282e3d455b38cd0e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac00f3fcc21f33f11c8efa4de67ff7774"><td class="memItemLeft" align="right" valign="top">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 class="memdesc:ac00f3fcc21f33f11c8efa4de67ff7774"><td class="mdescLeft"> </td><td class="mdescRight">Encrypt or decrypt a string of bytes. <a href="#ac00f3fcc21f33f11c8efa4de67ff7774">More...</a><br /></td></tr>
<tr class="separator:ac00f3fcc21f33f11c8efa4de67ff7774"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17951cb36412763e0d6bd9696177175d"><td class="memItemLeft" align="right" valign="top">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 class="memdesc:a17951cb36412763e0d6bd9696177175d"><td class="mdescLeft"> </td><td class="mdescRight">Encrypt or decrypt a string of bytes. <a href="#a17951cb36412763e0d6bd9696177175d">More...</a><br /></td></tr>
<tr class="separator:a17951cb36412763e0d6bd9696177175d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71a9bd33526fc7f227050075e7a78106"><td class="memItemLeft" align="right" valign="top">byte </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a71a9bd33526fc7f227050075e7a78106">ProcessByte</a> (byte input)</td></tr>
<tr class="memdesc:a71a9bd33526fc7f227050075e7a78106"><td class="mdescLeft"> </td><td class="mdescRight">Encrypt or decrypt a byte. <a href="#a71a9bd33526fc7f227050075e7a78106">More...</a><br /></td></tr>
<tr class="separator:a71a9bd33526fc7f227050075e7a78106"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7286fd9a993de0a147b0c20f660bfa5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#ad7286fd9a993de0a147b0c20f660bfa5">IsRandomAccess</a> () const =0</td></tr>
<tr class="memdesc:ad7286fd9a993de0a147b0c20f660bfa5"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether the cipher supports random access. <a href="#ad7286fd9a993de0a147b0c20f660bfa5">More...</a><br /></td></tr>
<tr class="separator:ad7286fd9a993de0a147b0c20f660bfa5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa60971c40c6cbcfb703ebe3d6495b6fc"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#aa60971c40c6cbcfb703ebe3d6495b6fc">Seek</a> (lword pos)</td></tr>
<tr class="memdesc:aa60971c40c6cbcfb703ebe3d6495b6fc"><td class="mdescLeft"> </td><td class="mdescRight">Seek to an absolute position. <a href="#aa60971c40c6cbcfb703ebe3d6495b6fc">More...</a><br /></td></tr>
<tr class="separator:aa60971c40c6cbcfb703ebe3d6495b6fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a583bc0edbd8a11c91da53395298c50de"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a583bc0edbd8a11c91da53395298c50de">IsSelfInverting</a> () const =0</td></tr>
<tr class="memdesc:a583bc0edbd8a11c91da53395298c50de"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether the cipher is self-inverting. <a href="#a583bc0edbd8a11c91da53395298c50de">More...</a><br /></td></tr>
<tr class="separator:a583bc0edbd8a11c91da53395298c50de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3244f76963a12a5ab6112326c7af9724"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_transformation.html#a3244f76963a12a5ab6112326c7af9724">IsForwardTransformation</a> () const =0</td></tr>
<tr class="memdesc:a3244f76963a12a5ab6112326c7af9724"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the cipher is being operated in its forward direction. <a href="#a3244f76963a12a5ab6112326c7af9724">More...</a><br /></td></tr>
<tr class="separator:a3244f76963a12a5ab6112326c7af9724"><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"><p>Interface for the data processing portion of stream ciphers. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_stream_transformation_filter.html" title="Filter wrapper for StreamTransformation. ">StreamTransformationFilter()</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00898">898</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a8c9304fff5af593ee68d3cf0d33c06e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c9304fff5af593ee68d3cf0d33c06e9">◆ </a></span>Ref()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></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 a reference to this object. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to this object</dd></dl>
<p>Useful for passing a temporary object to a function that takes a non-const reference </p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00906">906</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="ae224d250f716e82c54bc4e4c8930d188"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae224d250f716e82c54bc4e4c8930d188">◆ </a></span>MandatoryBlockSize()</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 StreamTransformation::MandatoryBlockSize </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 the mandatory block size of the cipher. </p>
<dl class="section return"><dt>Returns</dt><dd>The block size of the cipher if input must be processed in blocks, 1 otherwise</dd></dl>
<p>Stream ciphers and some block ciphers modes of operation return 1. Modes that return 1 must be able to process a single byte at a time, like counter mode. If a mode of operation or block cipher cannot stream then it must not return 1.</p>
<p>When filters operate the mode or cipher, ProcessData will be called with a string of bytes that is determined by MandatoryBlockSize and OptimalBlockSize. When a policy is set, like 16-byte strings for a 16-byte block cipher, the filter will buffer bytes until the specified number of bytes is available to the object. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0" title="Encrypt or decrypt an array of bytes. ">ProcessData</a>, <a class="el" href="class_stream_transformation.html#af48589443f77f4ed9ff185f9c1a26cbf" title="Encrypt or decrypt the last block of data. ">ProcessLastBlock</a>, <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize</a>, <a class="el" href="class_stream_transformation.html#a0b7c5bc41b9b5f6443ee32d65ebc044c" title="Provides the size of the last block. ">MinLastBlockSize</a>, <a class="el" href="struct_block_padding_scheme_def.html" title="Padding schemes used for block ciphers. ">BlockPaddingSchemeDef</a>, <a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5" title="Determines if the last block receives special processing. ">IsLastBlockSpecial</a> </dd></dl>
<p>Reimplemented in <a class="el" href="class_block_oriented_cipher_mode_base.html#ade6a00d82e063bcee5d1db3cd294751c">BlockOrientedCipherModeBase</a>.</p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00918">918</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="af66ef64545279c01310718af3d627534"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af66ef64545279c01310718af3d627534">◆ </a></span>OptimalBlockSize()</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 StreamTransformation::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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the input block size most efficient for this cipher. </p>
<dl class="section return"><dt>Returns</dt><dd>The input block size that is most efficient for the cipher</dd></dl>
<p>The base class implementation returns <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize()</a>. </p><dl class="section note"><dt>Note</dt><dd>Optimal input length is <code>n * <a class="el" href="class_stream_transformation.html#af66ef64545279c01310718af3d627534" title="Provides the input block size most efficient for this cipher. ">OptimalBlockSize()</a> - <a class="el" href="class_stream_transformation.html#ab8422f6eee08fbc70069e222186e90de" title="Provides the number of bytes used in the current block when processing at optimal block size...">GetOptimalBlockSizeUsed()</a></code> for any <code>n > 0</code>. </dd></dl>
<p>Reimplemented in <a class="el" href="class_additive_cipher_template.html#a0004338eef2392895a4dae77465aa64a">AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > ></a>, and <a class="el" href="class_e_c_b___one_way.html#a697d02a4fbec48b4accec6ce4226e083">ECB_OneWay</a>.</p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00925">925</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="ab8422f6eee08fbc70069e222186e90de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8422f6eee08fbc70069e222186e90de">◆ </a></span>GetOptimalBlockSizeUsed()</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 StreamTransformation::GetOptimalBlockSizeUsed </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 the number of bytes used in the current block when processing at optimal block size. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes used in the current block when processing at the optimal block size </dd></dl>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00929">929</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="a447cfac11f97012dff9662fb5e5d208b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a447cfac11f97012dff9662fb5e5d208b">◆ </a></span>OptimalDataAlignment()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int StreamTransformation::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides input and output data alignment for optimal performance. </p>
<dl class="section return"><dt>Returns</dt><dd>the input data alignment that provides optimal performance </dd></dl>
<dl class="section see"><dt>See also</dt><dd>GetAlignment() and <a class="el" href="class_stream_transformation.html#af66ef64545279c01310718af3d627534" title="Provides the input block size most efficient for this cipher. ">OptimalBlockSize()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="class_additive_cipher_template.html#ad4330a5797c37ffca92f34b532624b3c">AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > ></a>, <a class="el" href="class_cipher_mode_base.html#ac534eff2d4e72b61cc848af0f94805de">CipherModeBase</a>, <a class="el" href="class_g_c_m___base.html#a03138f0888c33eeca40a5ddd9a19898f">GCM_Base</a>, <a class="el" href="class_c_c_m___base.html#a65b06bba7c504edb6fec3cef38e577c8">CCM_Base</a>, and <a class="el" href="class_e_a_x___base.html#a6485bcdaa74651a8d162c9f7d5f3caa5">EAX_Base</a>.</p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00201">201</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p>
</div>
</div>
<a id="a26feabde21bc4d1783195969733e3bb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26feabde21bc4d1783195969733e3bb0">◆ </a></span>ProcessData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</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>Encrypt or decrypt an array of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outString</td><td>the output byte buffer </td></tr>
<tr><td class="paramname">inString</td><td>the input byte buffer </td></tr>
<tr><td class="paramname">length</td><td>the size of the input and output byte buffers, in bytes</td></tr>
</table>
</dd>
</dl>
<p>ProcessData is called with a string of bytes whose size depends on MandatoryBlockSize. Either <code>inString == outString</code>, or they must not overlap. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0" title="Encrypt or decrypt an array of bytes. ">ProcessData</a>, <a class="el" href="class_stream_transformation.html#af48589443f77f4ed9ff185f9c1a26cbf" title="Encrypt or decrypt the last block of data. ">ProcessLastBlock</a>, <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize</a>, <a class="el" href="class_stream_transformation.html#a0b7c5bc41b9b5f6443ee32d65ebc044c" title="Provides the size of the last block. ">MinLastBlockSize</a>, <a class="el" href="struct_block_padding_scheme_def.html" title="Padding schemes used for block ciphers. ">BlockPaddingSchemeDef</a>, <a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5" title="Determines if the last block receives special processing. ">IsLastBlockSpecial</a> </dd></dl>
<p>Implemented in <a class="el" href="class_additive_cipher_template.html#a5903c41f2e4e2aa6df44715244f2f3f3">AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > ></a>, <a class="el" href="class_c_b_c___decryption.html#ad3dfde8d73d036dc144e8750a6a3b1d1">CBC_Decryption</a>, <a class="el" href="class_c_b_c___encryption.html#ad4efdd9fd6d832b234771754cd51d20a">CBC_Encryption</a>, <a class="el" href="class_e_c_b___one_way.html#a4d8c291d821d86f7f4caa3cf95d1834c">ECB_OneWay</a>, <a class="el" href="class_authenticated_symmetric_cipher_base.html#a2887c0e4c7e303bdb51dfd869b16189f">AuthenticatedSymmetricCipherBase</a>, <a class="el" href="class_weak_1_1_a_r_c4___base.html#aa20124dfc1bac5050b1cd922e552ba95">Weak::ARC4_Base</a>, and <a class="el" href="class_public_blum_blum_shub.html#afb03a58653cb83c9a9013f3a57105bfc">PublicBlumBlumShub</a>.</p>
</div>
</div>
<a id="af48589443f77f4ed9ff185f9c1a26cbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af48589443f77f4ed9ff185f9c1a26cbf">◆ </a></span>ProcessLastBlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t 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">size_t </td>
<td class="paramname"><em>outLength</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>inLength</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>Encrypt or decrypt the last block of data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outString</td><td>the output byte buffer </td></tr>
<tr><td class="paramname">outLength</td><td>the size of the output byte buffer, in bytes </td></tr>
<tr><td class="paramname">inString</td><td>the input byte buffer </td></tr>
<tr><td class="paramname">inLength</td><td>the size of the input byte buffer, in bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes used in outString</dd></dl>
<p>ProcessLastBlock is used when the last block of data is special and requires handling by the cipher. The current implementation provides an output buffer with a size <code>inLength+2*MandatoryBlockSize()</code>. The return value allows the cipher to expand cipher text during encryption or shrink plain text during decryption.</p>
<p>This member function is used by CBC-CTS and OCB modes. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0" title="Encrypt or decrypt an array of bytes. ">ProcessData</a>, <a class="el" href="class_stream_transformation.html#af48589443f77f4ed9ff185f9c1a26cbf" title="Encrypt or decrypt the last block of data. ">ProcessLastBlock</a>, <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize</a>, <a class="el" href="class_stream_transformation.html#a0b7c5bc41b9b5f6443ee32d65ebc044c" title="Provides the size of the last block. ">MinLastBlockSize</a>, <a class="el" href="struct_block_padding_scheme_def.html" title="Padding schemes used for block ciphers. ">BlockPaddingSchemeDef</a>, <a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5" title="Determines if the last block receives special processing. ">IsLastBlockSpecial</a> </dd></dl>
<p>Reimplemented in <a class="el" href="class_c_b_c___c_t_s___decryption.html#acde5f7846361f888d0ad275e0e78c67a">CBC_CTS_Decryption</a>, and <a class="el" href="class_c_b_c___c_t_s___encryption.html#a8c1cd02b169591b06956b15347a588c6">CBC_CTS_Encryption</a>.</p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00223">223</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p>
</div>
</div>
<a id="a0b7c5bc41b9b5f6443ee32d65ebc044c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b7c5bc41b9b5f6443ee32d65ebc044c">◆ </a></span>MinLastBlockSize()</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 StreamTransformation::MinLastBlockSize </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 the size of the last block. </p>
<dl class="section return"><dt>Returns</dt><dd>the minimum size of the last block</dd></dl>
<p><a class="el" href="class_stream_transformation.html#a0b7c5bc41b9b5f6443ee32d65ebc044c" title="Provides the size of the last block. ">MinLastBlockSize()</a> returns the minimum size of the last block. 0 indicates the last block is not special.</p>
<p><a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize()</a> enlists one of two behaviors. First, if <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize()</a> returns 1, then the cipher can be streamed and <a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0" title="Encrypt or decrypt an array of bytes. ">ProcessData()</a> is called with the tail bytes. Second, if <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize()</a> returns non-0, then the string of bytes is padded to <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize()</a> according to the padding mode. Then, <a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0" title="Encrypt or decrypt an array of bytes. ">ProcessData()</a> is called with the padded string of bytes.</p>
<p>Some authenticated encryption modes are not expressed well with <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize()</a> and <a class="el" href="class_stream_transformation.html#a0b7c5bc41b9b5f6443ee32d65ebc044c" title="Provides the size of the last block. ">MinLastBlockSize()</a>. For example, AES/OCB uses 16-byte blocks (MandatoryBlockSize = 16) and the last block requires special processing (MinLastBlockSize = 0). However, 0 is a valid last block size for OCB and the special processing is custom padding, and not standard PKCS padding. In response an unambiguous <a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5" title="Determines if the last block receives special processing. ">IsLastBlockSpecial()</a> was added. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0" title="Encrypt or decrypt an array of bytes. ">ProcessData</a>, <a class="el" href="class_stream_transformation.html#af48589443f77f4ed9ff185f9c1a26cbf" title="Encrypt or decrypt the last block of data. ">ProcessLastBlock</a>, <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize</a>, <a class="el" href="class_stream_transformation.html#a0b7c5bc41b9b5f6443ee32d65ebc044c" title="Provides the size of the last block. ">MinLastBlockSize</a>, <a class="el" href="struct_block_padding_scheme_def.html" title="Padding schemes used for block ciphers. ">BlockPaddingSchemeDef</a>, <a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5" title="Determines if the last block receives special processing. ">IsLastBlockSpecial</a> </dd></dl>
<p>Reimplemented in <a class="el" href="class_c_b_c___c_t_s___decryption.html#af00303e9a4d770c22b5f5a7553f51c3f">CBC_CTS_Decryption</a>, <a class="el" href="class_c_b_c___c_t_s___encryption.html#a6f5fb8fb6c49bcaa75c923c38bd0ccbd">CBC_CTS_Encryption</a>, and <a class="el" href="class_c_b_c___mode_base.html#a43530a8977b63abdf11d35f971b29f30">CBC_ModeBase</a>.</p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00974">974</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="a62db1393d64069b282e3d455b38cd0e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62db1393d64069b282e3d455b38cd0e5">◆ </a></span>IsLastBlockSpecial()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool StreamTransformation::IsLastBlockSpecial </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>Determines if the last block receives special processing. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the last block reveives special processing, false otherwise.</dd></dl>
<p>Some authenticated encryption modes are not expressed well with <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize()</a> and <a class="el" href="class_stream_transformation.html#a0b7c5bc41b9b5f6443ee32d65ebc044c" title="Provides the size of the last block. ">MinLastBlockSize()</a>. For example, AES/OCB uses 16-byte blocks (MandatoryBlockSize = 16) and the last block requires special processing (MinLastBlockSize = 0). However, 0 is a valid last block size for OCB and the special processing is custom padding, and not standard PKCS padding. In response an unambiguous <a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5" title="Determines if the last block receives special processing. ">IsLastBlockSpecial()</a> was added.</p>
<p>When <a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5" title="Determines if the last block receives special processing. ">IsLastBlockSpecial()</a> returns false nothing special happens. All the former rules and behaviors apply. This is the default behavior of <a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5" title="Determines if the last block receives special processing. ">IsLastBlockSpecial()</a>.</p>
<p>When <a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5" title="Determines if the last block receives special processing. ">IsLastBlockSpecial()</a> returns true four things happen. First, MinLastBlockSize = 0 means 0 is a valid block size that should be processed. Second, standard block cipher padding is <em>not</em> <em>applied</em>. Third, the caller supplies an outString is larger than inString by <code>2*MandatoryBlockSize()</code>. That is, there's a reserve available when processing the last block. Fourth, the cipher is responsible for finalization like custom padding. The cipher will tell the library how many bytes were processed or used by returning the appropriate value from <a class="el" href="class_stream_transformation.html#af48589443f77f4ed9ff185f9c1a26cbf" title="Encrypt or decrypt the last block of data. ">ProcessLastBlock()</a>.</p>
<p>The return value of <a class="el" href="class_stream_transformation.html#af48589443f77f4ed9ff185f9c1a26cbf" title="Encrypt or decrypt the last block of data. ">ProcessLastBlock()</a> indicates how many bytes were written to <code>outString</code>. A filter pipelining data will send <code>outString</code> and up to <code>outLength</code> to an <code>AttachedTransformation()</code> for additional processing. Below is an example of the code used in <code>StreamTransformationFilter::LastPut</code>. </p><pre> if (m_cipher.IsLastBlockSpecial())
{
size_t reserve = 2*m_cipher.<a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize()</a>;
space = HelpCreatePutSpace(*AttachedTransformation(), DEFAULT_CHANNEL, length+reserve);
length = m_cipher.ProcessLastBlock(space, length+reserve, inString, length);
AttachedTransformation()->Put(space, length);
return;
}</pre> <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0" title="Encrypt or decrypt an array of bytes. ">ProcessData</a>, <a class="el" href="class_stream_transformation.html#af48589443f77f4ed9ff185f9c1a26cbf" title="Encrypt or decrypt the last block of data. ">ProcessLastBlock</a>, <a class="el" href="class_stream_transformation.html#ae224d250f716e82c54bc4e4c8930d188" title="Provides the mandatory block size of the cipher. ">MandatoryBlockSize</a>, <a class="el" href="class_stream_transformation.html#a0b7c5bc41b9b5f6443ee32d65ebc044c" title="Provides the size of the last block. ">MinLastBlockSize</a>, <a class="el" href="struct_block_padding_scheme_def.html" title="Padding schemes used for block ciphers. ">BlockPaddingSchemeDef</a>, <a class="el" href="class_stream_transformation.html#a62db1393d64069b282e3d455b38cd0e5" title="Determines if the last block receives special processing. ">IsLastBlockSpecial</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 6.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l01007">1007</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="ac00f3fcc21f33f11c8efa4de67ff7774"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac00f3fcc21f33f11c8efa4de67ff7774">◆ </a></span>ProcessString() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void StreamTransformation::ProcessString </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>inoutString</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Encrypt or decrypt a string of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inoutString</td><td>the string to process </td></tr>
<tr><td class="paramname">length</td><td>the size of the inoutString, in bytes</td></tr>
</table>
</dd>
</dl>
<p>Internally, the base class implementation calls <a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0" title="Encrypt or decrypt an array of bytes. ">ProcessData()</a>. </p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l01013">1013</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="a17951cb36412763e0d6bd9696177175d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17951cb36412763e0d6bd9696177175d">◆ </a></span>ProcessString() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void StreamTransformation::ProcessString </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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Encrypt or decrypt a string of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outString</td><td>the output string to process </td></tr>
<tr><td class="paramname">inString</td><td>the input string to process </td></tr>
<tr><td class="paramname">length</td><td>the size of the input and output strings, in bytes</td></tr>
</table>
</dd>
</dl>
<p>Internally, the base class implementation calls <a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0" title="Encrypt or decrypt an array of bytes. ">ProcessData()</a>. </p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l01021">1021</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="a71a9bd33526fc7f227050075e7a78106"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71a9bd33526fc7f227050075e7a78106">◆ </a></span>ProcessByte()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">byte StreamTransformation::ProcessByte </td>
<td>(</td>
<td class="paramtype">byte </td>
<td class="paramname"><em>input</em></td><td>)</td>
<td></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>Encrypt or decrypt a byte. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>the input byte to process</td></tr>
</table>
</dd>
</dl>
<p>Internally, the base class implementation calls <a class="el" href="class_stream_transformation.html#a26feabde21bc4d1783195969733e3bb0" title="Encrypt or decrypt an array of bytes. ">ProcessData()</a> with a size of 1. </p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l01027">1027</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="ad7286fd9a993de0a147b0c20f660bfa5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7286fd9a993de0a147b0c20f660bfa5">◆ </a></span>IsRandomAccess()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool StreamTransformation::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether the cipher supports random access. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the cipher supports random access, false otherwise </dd></dl>
<p>Implemented in <a class="el" href="class_additive_cipher_template.html#a348e17f577eee091fa06029123944467">AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > ></a>, <a class="el" href="class_block_oriented_cipher_mode_base.html#a7721eef9f8c5c0c4ca16048c41feed8f">BlockOrientedCipherModeBase</a>, <a class="el" href="class_blum_blum_shub.html#adca1fd77ec8f237fa8eeaf6fb22a6412">BlumBlumShub</a>, <a class="el" href="class_authenticated_symmetric_cipher_base.html#a007ee52a51a397cc48840e21488e82a0">AuthenticatedSymmetricCipherBase</a>, and <a class="el" href="class_weak_1_1_a_r_c4___base.html#a398fc19cea2a9a9446bb43743ed019f7">Weak::ARC4_Base</a>.</p>
</div>
</div>
<a id="aa60971c40c6cbcfb703ebe3d6495b6fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa60971c40c6cbcfb703ebe3d6495b6fc">◆ </a></span>Seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void StreamTransformation::Seek </td>
<td>(</td>
<td class="paramtype">lword </td>
<td class="paramname"><em>pos</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>Seek to an absolute position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pos</td><td>position to seek </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="class_not_implemented.html" title="A method was called which was not implemented. ">NotImplemented</a></td><td></td></tr>
</table>
</dd>
</dl>
<p>The base class implementation throws <a class="el" href="class_not_implemented.html" title="A method was called which was not implemented. ">NotImplemented</a>. The function <a class="el" href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">asserts</a> <a class="el" href="class_stream_transformation.html#ad7286fd9a993de0a147b0c20f660bfa5" title="Determines whether the cipher supports random access. ">IsRandomAccess()</a> in debug builds. </p>
<p>Reimplemented in <a class="el" href="class_additive_cipher_template.html#a68d4dc2904da4df5a7ead785ad7bc67e">AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > ></a>, and <a class="el" href="class_blum_blum_shub.html#ae29af38d625e72bc5e503db157a84c5f">BlumBlumShub</a>.</p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l01039">1039</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="a583bc0edbd8a11c91da53395298c50de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a583bc0edbd8a11c91da53395298c50de">◆ </a></span>IsSelfInverting()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool StreamTransformation::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether the cipher is self-inverting. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the cipher is self-inverting, false otherwise</dd></dl>
<p>IsSelfInverting determines whether this transformation is self-inverting (e.g. xor with a keystream). </p>
<p>Implemented in <a class="el" href="class_additive_cipher_template.html#aa5381b39bce5e7041fcbe2c8e53d85a7">AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > ></a>, <a class="el" href="class_block_oriented_cipher_mode_base.html#a503746952c074403bf2d72374f3d6672">BlockOrientedCipherModeBase</a>, <a class="el" href="class_authenticated_symmetric_cipher_base.html#a5c57dc0ee98bf5684b1be5cd18e34017">AuthenticatedSymmetricCipherBase</a>, <a class="el" href="class_weak_1_1_a_r_c4___base.html#a44b0a2bf3ee9bdf10fb1c517dcc3f09c">Weak::ARC4_Base</a>, and <a class="el" href="class_public_blum_blum_shub.html#ac322c5980509bc4e8075f28c4425ac3f">PublicBlumBlumShub</a>.</p>
</div>
</div>
<a id="a3244f76963a12a5ab6112326c7af9724"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3244f76963a12a5ab6112326c7af9724">◆ </a></span>IsForwardTransformation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool StreamTransformation::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the cipher is being operated in its forward direction. </p>
<dl class="section return"><dt>Returns</dt><dd>true if DIR is ENCRYPTION, false otherwise </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_stream_transformation.html#a3244f76963a12a5ab6112326c7af9724" title="Determines if the cipher is being operated in its forward direction. ">IsForwardTransformation()</a>, IsPermutation(), GetCipherDirection() </dd></dl>
<p>Implemented in <a class="el" href="class_additive_cipher_template.html#acabcddee5c7f5ccb5149c232741a2b1d">AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > ></a>, <a class="el" href="class_block_oriented_cipher_mode_base.html#a3f08ba1e5fe34ab0cd379a54da828938">BlockOrientedCipherModeBase</a>, <a class="el" href="class_g_c_m___final.html#ab3b487ec8ef88547e47d184eb2c4aaf4">GCM_Final< T_BlockCipher, T_TablesOption, T_IsEncryption ></a>, <a class="el" href="class_c_c_m___final.html#ab98c22a43090a40e5f29504ee90fdfd0">CCM_Final< T_BlockCipher, T_DefaultDigestSize, T_IsEncryption ></a>, <a class="el" href="class_e_a_x___final.html#a709cc142f1de5d5c2b4878c20affd7d3">EAX_Final< T_BlockCipher, T_IsEncryption ></a>, <a class="el" href="class_weak_1_1_a_r_c4___base.html#a516513034fcdcc17f33d7ad029b9b81e">Weak::ARC4_Base</a>, and <a class="el" href="class_public_blum_blum_shub.html#a0ad21fce7f3113ab25ea05e47773a786">PublicBlumBlumShub</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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:59:01 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
>
1867
