<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: TF_EncryptorBase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_t_f___encryptor_base-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TF_EncryptorBase Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Trapdoor function cryptosystems encryption base class.
<a href="class_t_f___encryptor_base.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 TF_EncryptorBase:</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_t_f___encryptor_base.png" usemap="#TF_5FEncryptorBase_map" alt=""/>
<map id="TF_5FEncryptorBase_map" name="TF_5FEncryptorBase_map">
<area href="class_t_f___crypto_system_base.html" alt="TF_CryptoSystemBase< PK_Encryptor, TF_Base< RandomizedTrapdoorFunction, PK_EncryptionMessageEncodingMethod > >" shape="rect" coords="744,336,1478,360"/>
<area href="class_p_k___fixed_length_crypto_system_impl.html" alt="PK_FixedLengthCryptoSystemImpl< PK_Encryptor >" shape="rect" coords="372,280,1106,304"/>
<area href="class_t_f___base.html" alt="TF_Base< RandomizedTrapdoorFunction, PK_EncryptionMessageEncodingMethod >" shape="rect" coords="1116,280,1850,304"/>
<area href="class_p_k___encryptor.html" title="Interface for public-key encryptors." alt="PK_Encryptor" shape="rect" coords="372,224,1106,248"/>
<area href="class_p_k___crypto_system.html" title="Interface for public-key encryptors and decryptors." alt="PK_CryptoSystem" shape="rect" coords="0,168,734,192"/>
<area href="class_public_key_algorithm.html" title="Interface for asymmetric algorithms using public keys." alt="PublicKeyAlgorithm" shape="rect" coords="744,168,1478,192"/>
<area href="class_asymmetric_algorithm.html" title="Interface for asymmetric algorithms." alt="AsymmetricAlgorithm" shape="rect" coords="744,112,1478,136"/>
<area href="class_algorithm.html" title="Interface for all crypto algorithms." alt="Algorithm" shape="rect" coords="744,56,1478,80"/>
<area href="class_clonable.html" title="Interface for cloning objects." alt="Clonable" shape="rect" coords="744,0,1478,24"/>
<area href="class_algorithm_impl.html" alt="AlgorithmImpl< TF_EncryptorBase, SCHEME_OPTIONS::AlgorithmInfo >" shape="rect" coords="744,448,1478,472"/>
<area href="class_t_f___object_impl_base.html" alt="TF_ObjectImplBase< TF_EncryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey >" shape="rect" coords="744,504,1478,528"/>
<area href="class_t_f___object_impl.html" alt="TF_ObjectImpl< TF_EncryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PublicKey >" shape="rect" coords="744,560,1478,584"/>
<area href="class_t_f___encryptor_impl.html" title="Trapdoor Function (TF) encryptor options." alt="TF_EncryptorImpl< SCHEME_OPTIONS >" shape="rect" coords="744,616,1478,640"/>
</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:afa1feef1aeea65276bba4788f5d7b0b4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_f___encryptor_base.html#afa1feef1aeea65276bba4788f5d7b0b4">Encrypt</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, const byte *plaintext, size_t plaintextLength, byte *ciphertext, const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &parameters=<a class="el" href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a>) const</td></tr>
<tr class="memdesc:afa1feef1aeea65276bba4788f5d7b0b4"><td class="mdescLeft"> </td><td class="mdescRight">Encrypt a byte string. <a href="#afa1feef1aeea65276bba4788f5d7b0b4">More...</a><br /></td></tr>
<tr class="separator:afa1feef1aeea65276bba4788f5d7b0b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_t_f___crypto_system_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_t_f___crypto_system_base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_t_f___crypto_system_base.html">TF_CryptoSystemBase< PK_Encryptor, TF_Base< RandomizedTrapdoorFunction, PK_EncryptionMessageEncodingMethod > ></a></td></tr>
<tr class="memitem:afadb2febf4b1a51ee1446fb01da2f9e8 inherit pub_methods_class_t_f___crypto_system_base"><td class="memItemLeft" align="right" valign="top"><a id="afadb2febf4b1a51ee1446fb01da2f9e8"></a>
bool </td><td class="memItemRight" valign="bottom"><b>ParameterSupported</b> (const char *name) const</td></tr>
<tr class="separator:afadb2febf4b1a51ee1446fb01da2f9e8 inherit pub_methods_class_t_f___crypto_system_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0a7da5ba5b3869059410425b9ea8fe2 inherit pub_methods_class_t_f___crypto_system_base"><td class="memItemLeft" align="right" valign="top"><a id="aa0a7da5ba5b3869059410425b9ea8fe2"></a>
size_t </td><td class="memItemRight" valign="bottom"><b>FixedMaxPlaintextLength</b> () const</td></tr>
<tr class="separator:aa0a7da5ba5b3869059410425b9ea8fe2 inherit pub_methods_class_t_f___crypto_system_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac11857dd4d28e5f6bdebd16fb8742d12 inherit pub_methods_class_t_f___crypto_system_base"><td class="memItemLeft" align="right" valign="top"><a id="ac11857dd4d28e5f6bdebd16fb8742d12"></a>
size_t </td><td class="memItemRight" valign="bottom"><b>FixedCiphertextLength</b> () const</td></tr>
<tr class="separator:ac11857dd4d28e5f6bdebd16fb8742d12 inherit pub_methods_class_t_f___crypto_system_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_p_k___fixed_length_crypto_system_impl"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_p_k___fixed_length_crypto_system_impl')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_p_k___fixed_length_crypto_system_impl.html">PK_FixedLengthCryptoSystemImpl< PK_Encryptor ></a></td></tr>
<tr class="memitem:a611f362906abdf24520dc5997ed8dbad inherit pub_methods_class_p_k___fixed_length_crypto_system_impl"><td class="memItemLeft" align="right" valign="top"><a id="a611f362906abdf24520dc5997ed8dbad"></a>
size_t </td><td class="memItemRight" valign="bottom"><b>MaxPlaintextLength</b> (size_t ciphertextLength) const</td></tr>
<tr class="separator:a611f362906abdf24520dc5997ed8dbad inherit pub_methods_class_p_k___fixed_length_crypto_system_impl"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c97d64f1d84001c1e1c2fd725204853 inherit pub_methods_class_p_k___fixed_length_crypto_system_impl"><td class="memItemLeft" align="right" valign="top"><a id="a5c97d64f1d84001c1e1c2fd725204853"></a>
size_t </td><td class="memItemRight" valign="bottom"><b>CiphertextLength</b> (size_t plaintextLength) const</td></tr>
<tr class="separator:a5c97d64f1d84001c1e1c2fd725204853 inherit pub_methods_class_p_k___fixed_length_crypto_system_impl"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_p_k___encryptor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_p_k___encryptor')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_p_k___encryptor.html">PK_Encryptor</a></td></tr>
<tr class="memitem:a558cc0f957c7e1e448a746033549964d inherit pub_methods_class_p_k___encryptor"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_k___encryptor.html#a558cc0f957c7e1e448a746033549964d">CreateEncryptionFilter</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment=NULL, const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &parameters=<a class="el" href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a>) const</td></tr>
<tr class="memdesc:a558cc0f957c7e1e448a746033549964d inherit pub_methods_class_p_k___encryptor"><td class="mdescLeft"> </td><td class="mdescRight">Create a new encryption filter. <a href="class_p_k___encryptor.html#a558cc0f957c7e1e448a746033549964d">More...</a><br /></td></tr>
<tr class="separator:a558cc0f957c7e1e448a746033549964d inherit pub_methods_class_p_k___encryptor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_public_key_algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_public_key_algorithm')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_public_key_algorithm.html">PublicKeyAlgorithm</a></td></tr>
<tr class="memitem:a74b77db3086e07caf5506fda9ec204e7 inherit pub_methods_class_public_key_algorithm"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_crypto_material.html">CryptoMaterial</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_public_key_algorithm.html#a74b77db3086e07caf5506fda9ec204e7">AccessMaterial</a> ()</td></tr>
<tr class="memdesc:a74b77db3086e07caf5506fda9ec204e7 inherit pub_methods_class_public_key_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to a Public Key. <a href="class_public_key_algorithm.html#a74b77db3086e07caf5506fda9ec204e7">More...</a><br /></td></tr>
<tr class="separator:a74b77db3086e07caf5506fda9ec204e7 inherit pub_methods_class_public_key_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c2bb02751348ff151ad9d4756cafd74 inherit pub_methods_class_public_key_algorithm"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_crypto_material.html">CryptoMaterial</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_public_key_algorithm.html#a8c2bb02751348ff151ad9d4756cafd74">GetMaterial</a> () const</td></tr>
<tr class="memdesc:a8c2bb02751348ff151ad9d4756cafd74 inherit pub_methods_class_public_key_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to a Public Key. <a href="class_public_key_algorithm.html#a8c2bb02751348ff151ad9d4756cafd74">More...</a><br /></td></tr>
<tr class="separator:a8c2bb02751348ff151ad9d4756cafd74 inherit pub_methods_class_public_key_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47cd0fed475280962ab6337c6c57c882 inherit pub_methods_class_public_key_algorithm"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_public_key.html">PublicKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_public_key_algorithm.html#a47cd0fed475280962ab6337c6c57c882">AccessPublicKey</a> ()=0</td></tr>
<tr class="memdesc:a47cd0fed475280962ab6337c6c57c882 inherit pub_methods_class_public_key_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to a Public Key. <a href="class_public_key_algorithm.html#a47cd0fed475280962ab6337c6c57c882">More...</a><br /></td></tr>
<tr class="separator:a47cd0fed475280962ab6337c6c57c882 inherit pub_methods_class_public_key_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49b6c27bffc8cc588e0db37071fde9f5 inherit pub_methods_class_public_key_algorithm"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="class_public_key.html">PublicKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_public_key_algorithm.html#a49b6c27bffc8cc588e0db37071fde9f5">GetPublicKey</a> () const</td></tr>
<tr class="memdesc:a49b6c27bffc8cc588e0db37071fde9f5 inherit pub_methods_class_public_key_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to a Public Key. <a href="class_public_key_algorithm.html#a49b6c27bffc8cc588e0db37071fde9f5">More...</a><br /></td></tr>
<tr class="separator:a49b6c27bffc8cc588e0db37071fde9f5 inherit pub_methods_class_public_key_algorithm"><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>Trapdoor function cryptosystems encryption base class. </p>
<p class="definition">Definition at line <a class="el" href="pubkey_8h_source.html#l00292">292</a> of file <a class="el" href="pubkey_8h_source.html">pubkey.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="afa1feef1aeea65276bba4788f5d7b0b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa1feef1aeea65276bba4788f5d7b0b4">◆ </a></span>Encrypt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void TF_EncryptorBase::Encrypt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> & </td>
<td class="paramname"><em>rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>plaintext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>plaintextLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>ciphertext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> & </td>
<td class="paramname"><em>parameters</em> = <code><a class="el" href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Encrypt a byte string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rng</td><td>a <a class="el" href="class_random_number_generator.html" title="Interface for random number generators.">RandomNumberGenerator</a> derived class </td></tr>
<tr><td class="paramname">plaintext</td><td>the plaintext byte buffer </td></tr>
<tr><td class="paramname">plaintextLength</td><td>the size of the plaintext byte buffer </td></tr>
<tr><td class="paramname">ciphertext</td><td>a byte buffer to hold the encrypted string </td></tr>
<tr><td class="paramname">parameters</td><td>a set of <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names.">NameValuePairs</a> to initialize this object </td></tr>
</table>
</dd>
</dl>
<dl class="section pre"><dt>Precondition</dt><dd><code>CiphertextLength(plaintextLength) != 0</code> ensures the plaintext isn't too large </dd>
<dd>
<code><a class="el" href="misc_8h.html#a2d7e4464ea73d6393ebe78f952253426" title="Counts elements in an array.">COUNTOF(ciphertext)</a> == CiphertextLength(plaintextLength)</code> ensures the output byte buffer is large enough. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_p_k___decryptor.html" title="Interface for public-key decryptors.">PK_Decryptor</a> </dd></dl>
<p>Implements <a class="el" href="class_p_k___encryptor.html#aecb519bc1cb0b261698be999bb5c8961">PK_Encryptor</a>.</p>
<p class="definition">Definition at line <a class="el" href="pubkey_8cpp_source.html#l00153">153</a> of file <a class="el" href="pubkey_8cpp_source.html">pubkey.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="pubkey_8h_source.html">pubkey.h</a></li>
<li><a class="el" href="pubkey_8cpp_source.html">pubkey.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 27 2019 15:04:45 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
17f48c047155a7d4c992d6a672acd57f
>
files
>
1908
